docs(oas/swagger): provide examples of the example and examples keys #3026
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.
Provide examples to users on how to set example and examples keys in the @ApiProperty annotation
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Currently the documentation does not have any indication of how to use the
example
orexamples
keys in the@ApiProperty(...)
annotation.Issue Number: N/A
What is the new behavior?
This PR adds an example for the
example
and an example for theexamples
keys to the documentation to help show how to use them.Does this PR introduce a breaking change?
Other information
N/A - This is a pretty straightforward PR.