Add example/examples on parameters #88
Open
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
manchenkoff
requested changes
Sep 2, 2024
| # example: Optional[Any] # TODO | ||
| # examples: list[Any] = field(default_factory=list) # TODO | ||
| example: Optional[Any] = None | ||
| examples: list[Any] = field(default_factory=list) |
There was a problem hiding this comment.
After checking the docs for v3 spec, it looks like it won't work with a list type. It should work with dict-like structure, where the key is a string and the value is an Example object, here you can find more details - Parameter object.
There was a problem hiding this comment.
Oh, I see. Thanks. People are amusing on changing spec every time :)
manchenkoff
requested changes
Sep 5, 2024
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.
From #28, add example/examples sections in result