Don't document non-schema object examples #885
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
spaceraccoon
force-pushed
the
spaceraccoon-dont-document-non-schema-examples
branch
from
92e9ed8
to
7ac9bc9
Compare
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.
As per #884,
grape-swaggeradds theexamplevalue even for non-schema object parameters, which leads to invalid OpenAPI during validation. I.e., the example keyword should not appear in any parameters object, only in any definitions schema objects i.e. body type parameters.This error appears in Swagger editor/validators when a
parameterobject has anexamplekey.This adds a check such that example is only added then and fixes a previous spec.