Do not force "" for http status code #2147
Closed
Conversation
This file contains hidden or 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
In JSON the key which is a number must be wrapped into "". This is not the case of yaml format. Different formats, different requirements. It does not make sense to force json requirements into yaml.
This was referenced Feb 19, 2020
|
As a general rule, we're looking for compatibility between JSON and YAML representations of API definitions, and have added some restrictions in the spec to support it. Since in YAML keys are typed, the following is legal: responses:
"400": {...}
400: {...}and doesn't really have a JSON equivalent. Even in YAML, that can cause parsing issues and we don't want to complicate parsing. The fact that Swagger Editor does not complain about it is an issue with the tool and should be filed there. |
|
This makes it really annoying to have to use |
|
I feel your pain (seriously). Regardless, this is definitely not a change we can do in 3.0.x because it changes the behavior of the spec. |
|
Well, I didnt know how to propose it for the next version? |
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.
In JSON the key which is a number must be wrapped into "". This is not the case of yaml format. Different formats, different requirements. It does not make sense to force json requirements into yaml.
Please also note that https://editor.swagger.io does not wrap status codes into "", which is correct, but contradictory to this spec: