added support for examples if no default. Also added support for properties when type is not an object #14
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
…erties when type is not an object
| @@ -86,6 +86,9 @@ function instantiatePrimitive (val) { | |||
| return val.default | |||
| } | |||
|
|
|||
| if (val.example) { | |||
| return val.example | |||
| } | |||
There was a problem hiding this comment.
I'd recommend checking example before default.
See "Common Mistakes" at https://swagger.io/docs/specification/describing-parameters/
There are two common mistakes ...
- Using default to specify a sample value. This is not intended use of default and can lead to unexpected behavior in some Swagger tools. Use the example or examples keyword for this purpose instead. See Adding Examples.
So while default might be a fine example if nothing else is available, I'd default to example first and then the first entry in examples and then finally default. That's what I did in #86 for parameter parsing.
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.
added support for examples if no default. Also added support for properties when type is not an object