This repository was archived by the owner on Nov 8, 2024. It is now read-only.
Handle invalid schema object examples in OAS 2 #221
Merged
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
kylef
commented
Apr 24, 2019
| // | ||
| // The below code attemps to dereference an example, but if we can't we | ||
| // will just return the example (possibly a "reference object") to be | ||
| // the example value. |
There was a problem hiding this comment.
I want to point out, the information in this comment is not new. I think it is worth clarifying what the function does and why. In the past there are also cases where invalid reference would be treated as example value, this PR just adds one additional case.
kylef
force-pushed
the
kylef/schema-example-invalid
branch
from
07416df to
e253fba
Compare
kylef
commented
Apr 24, 2019
| version: 1.0.0 | ||
| paths: {} | ||
| definitions: | ||
| Test: |
There was a problem hiding this comment.
This 'Schema Object' declares an array type which has an sample value of an array. The array's first value is an object which has a key $ref and the value #/info, it is not a reference as per the spec and we are not treating it as one since it doesn't reference any valid component in the document.
kylef
force-pushed
the
kylef/schema-example-invalid
branch
from
3f82d7b to
09bfa6d
Compare
pksunkara
approved these changes
Apr 29, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 #217
More context can be found in the large comment I added inside the function that is altered below.