Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking oas rule changes #725

Closed
5 of 7 tasks
philsturgeon opened this issue Oct 31, 2019 · 1 comment
Closed
5 of 7 tasks

Breaking oas rule changes #725

philsturgeon opened this issue Oct 31, 2019 · 1 comment
Labels
breaking Pull requests that introduce a breaking change

Comments

@philsturgeon
Copy link
Contributor

philsturgeon commented Oct 31, 2019

With v5.0 coming, now is the time to make changes to the OpenAPI ruleset.

  1. example-value-or-externalValue make it recommended (spec says The value field and externalValue field are mutually exclusive.).

  2. no-eval-in-markdown we should recommend this as a safety precaution, people can turn it off if they want eval in there.

  3. openapi-tags we should make this recommended

  4. operation-summary-formatted delete it. Summary is meant to be shorter than description, so is normally used for title case not sentences. That's usually the description.

  5. model-description lets delete it, ive never written one and we currently dont elevate models to a point where this data is used anyway

  6. valid-example oops we split this into multiple rules and forgot to update the docs 😅 (while you're in there extends: "spectral: oas3" has a space in it in the oas3 description)

  7. the remaining ones in oas2 and oas3 will need to be turned into single rules which effect both formats if they share the same given, or made into two seperate rules if they do not.

Let's make sure the docs are totally up to date with the new reality of the rulesets and list this all in the migration guide.

@philsturgeon philsturgeon added the breaking Pull requests that introduce a breaking change label Oct 31, 2019
@philsturgeon
Copy link
Contributor Author

@P0lip @marbemac i think this (and #689) will make for a great v5.0 release. Cleaning up tech debt, simplifying docs, and removing some rules which people at the workshop and in general thought were a bit odd.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Pull requests that introduce a breaking change
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant