fix: rendering of openapi parameter examples #2509
Merged
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
Parameter examples should be a mapping of example names mapped to `Example` objects. This PR builds such a mapping for parameters that have examples defined. This PR does not modify existing behavior that adds examples to the parameter's schema object. Closes #2494
peterschutt
force-pushed
the
2494-openapi-parameter-examples
branch
from
14c63dd
to
6fd9475
Compare
|
Kudos, SonarCloud Quality Gate passed! |
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2509 |
JacobCoffee
approved these changes
Oct 24, 2023
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.
Pull Request Checklist
Description
Parameter examples should be a mapping of example names mapped to
Exampleobjects.This PR builds such a mapping for parameters that have examples defined.
This PR does not modify existing behavior that adds examples to the parameter's schema object.
Before PR:
After PR:
swagger:
redoc:
elements:
Close Issue(s)
Closes #2494