Added Example property to OpenApi attribute#589
Open
PaulNieuwelaar wants to merge 2 commits intoAzure:mainfrom
Open
Added Example property to OpenApi attribute#589PaulNieuwelaar wants to merge 2 commits intoAzure:mainfrom
PaulNieuwelaar wants to merge 2 commits intoAzure:mainfrom
Conversation
Author
|
@microsoft-github-policy-service agree company="Magnetism" |
|
Is this PR likely to be reviewed any time soon? |
|
Very much interested in this as well! |
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
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 new Example property to the OpenApiPropertyAttribute. Allows settings an example value at an individual property level rather than only at the class/model. This is included in the OpenApi schema for the property and displays in the swagger schema and example.
Follows the same format as the Default property, i.e. allows string, number, boolean.
Example:
Property schema includes the example:

Model/schema example value also includes the property example:
