feat: removing some rules people dont like #1304
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
philsturgeon
requested review from
P0lip and
nulltoken
and removed request for
P0lip
philsturgeon
commented
Aug 18, 2020
| @@ -292,17 +288,6 @@ Use just one tag for an operation, which is helpful for some documentation syste | |||
|
|
|||
| **Recommended:** No | |||
|
|
|||
| ### operation-summary-formatted | |||
There was a problem hiding this comment.
As we're prepping for v6 we can remove notes about v5.
philsturgeon
commented
Aug 18, 2020
| @@ -253,10 +253,6 @@ Why? Well, you _can_ reference tags arbitrarily in operations, and definition is | |||
|
|
|||
| Defining tags allows you to add more information like a `description`. For more information see [tag-description](#tag-description). | |||
|
|
|||
| **Recommended:** Yes | |||
|
|
|||
| ### operation-default-response | |||
There was a problem hiding this comment.
This makes very little sense to me, as the spec only says MAY have a default response.
added 5 commits
August 19, 2020 19:09
The spec says: The default MAY be used as a default response object for all HTTP codes that are not covered individually by the specification. There's no need to suggest anyone default is any more important than optional.
lets let people run this with whatever version and the CI will confirm it works with versions we care about.
If you want to use it, switch from to fixes #1132
philsturgeon
force-pushed
the
remove-bad-rules
branch
from
d5f3b5e to
a0d5061
Compare
|
Hey @lornajane you might like this one! |
|
@P0lip ready for thumbs! |
P0lip
approved these changes
Aug 19, 2020
|
Seems like we need to update test harness cases. |
P0lip
added
breaking
P0lip
changed the title
|
@philsturgeon why did we merge this? |
|
I made a mistake, and thought it was azure being a dumbass and override it. We’ll get it working. I pushed a style fix to your test harness fixes to help get all the checks green.
…--
Phil Sturgeon
DevRel @ Stoplight.io
On Aug 20, 2020, at 15:32, Jakub Rożek ***@***.***> wrote:
@philsturgeon why did we merge this?
the tests weren't passing.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
|
Any updates on this? I'd really like to get the |
|
@dillonredding v6.0 is not yet released but if you'd like to go ahead and use this new rule you can always require the npm module via git and point it at the develop branch: https://stackoverflow.com/questions/39732397/install-specific-branch-from-github-using-npm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1273
Fixes #1132
Checklist
Does this PR introduce a breaking change?
We're preparing for v6.0, which will include some major and excellent changes, but also some breaking changes to the bundled OpenAPI ruleset. These rules come from a bunch of feedback from the community about which rules should be showing up by default, and which are useful for "strict mode" (running with
extends: [[spectral:oas, all]].If you want any of these rules to stick around, speak now or forever hold your peace!
TLDR
recommended: false(loads of people don't use tags and Studio doesn't help enough to make this easy for people who dont know what they are anyway). Unrecommend openapi-tags #1132operation-2xx-responserule should not be recommended #1273.