Improve description support on ToSchema fields
#490
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
This commit fixes the existing implementation for field description and
deprecated status. The implementation only worked for primitive type
fields.
This PR adds correct support for following cases where the description
and deprecated status will be correctly set for vec and map fields as
well.
```rust
struct Account {
/// Database autogenerated id
#[deprecated]
id: i64,
/// Users username
#[deprecated]
username: String,
/// Role ids
#[deprecated]
role_ids: Vec<i32>,
/// Users
#[deprecated]
users: Vec<User>,
/// Map description
#[deprecated]
map: HashMap<String, String>
}
```
Note this PR does not add support for description on `$ref` types.
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.
This commit fixes the existing implementation for field description and deprecated status. The implementation only worked for primitive type fields.
This PR adds correct support for following cases where the description and deprecated status will be correctly set for vec and map fields as well.
Note this PR does not add support for description on
$reftypes.Fixes #474, Relates #137