Feat: add example to schema definition #421
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
tiagolobocastro
approved these changes
May 1, 2022
There was a problem hiding this comment.
Thanks @rlebran!
Btw, what do you think about using the Default trait as another way of specifying examples automatically?
Maybe something like #[openapi(default_examples)].
|
That's a good idea but should it be opt-in or if a Default implementation exists we can use it automatically ? |
tiagolobocastro
added a commit
that referenced
this pull request
Jul 27, 2022
- Add support for `PATCH` methods. [PR#422](#422) - Add support for header parameters through the newly introduced `Apiv2Header` derive macro. [PR#413](#413) - Add support for [RapiDoc UI](https://mrin9.github.io/RapiDoc/index.html). [PR#420](#420) - Add example support for derived `Apiv2Schema`. [PR#421](#421) - Add ability to not generate documentation for some operations through the skip attribute on api_v2_schema macro. [PR#423](#423) - Add support for deprecated operations. [PR#424](#424) - Fix missing slash between url parts [PR#416](#416) - Properly support non-BoxBody response payload types [PR#414](#414) - Fix required fields definition when using serde flatten [PR#412](#412) - Fix reference urls not being RFC3986-compliant [PR#411](#411)
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.
Add example for schema and fields through openapi attribute.
This produce valid openapi specification. I changed the example type from
Stringtoserde_json::Valuebecause the specification describe example asand examples show a json like example value.
This is link to #417