Fix #1067: Add basic support for examples
as well as example
#1065
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.
This PR fixes the following bug, #1067: the
examples
keyword is not supported at all in some contexts, which causes some response fields to be shown with a generic example even though a schema-supplied example is available.In cases where it wasn't supported at all, we instead now pick the first example from
examples
, which is a valuable incremental improvement and matches the behavior of https://editor-next.swagger.io/.Given the following minimal, valid spec:
Before this PR, the example response was:
Note
[ "string" ]
underlist_field
.Now the example response is:
Note
[ "Bug: missing from output" ]
underlist_field
.