Enhance ToResponse implementation
#419
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 will add support for unit type responses. Structs without
fields will be threated as a responses without body.
```rust
#[derive(ToSchema, ToResponse)]
struct PersonSuccessResponse;
```
This commit changes `ToResponse` behaviour in named field structs and
enums without `#[content]` attribute so that the fields and variants of
those types will become inlined schema for the response. Prior to this
PR `ToSchema` ignored fields and variants of those types and created a
reference to the type having same name as response. That behaviour was
not correct and was illogical since you can use new type pattern to
create a reference response.
```rust
#[derive(ToResponse)]
struct Person {
name: String,
}
```
Add new attribute `#[to_schema]` which can be used to inline schema of
unnamed field struct or enum variant which already has `#[content]`
attribute. Without `#[to_schema]` attribute response will be created
with a reference to the field type.
```rust
#[derive(ToResponse)]
struct PersonSuccessResponse(#[to_schema] Vec<Person>);
```
juhaku
force-pushed
the
enhance-to-response-implementation
branch
from
8e2faa9 to
34820b8
Compare
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 will add support for unit type responses. Structs without fields will be threated as a responses without body.
This commit changes
ToResponsebehaviour in named field structs and enums without#[content]attribute so that the fields and variants of those types will become inlined schema for the response. Prior to this PRToSchemaignored fields and variants of those types and created a reference to the type having same name as response. That behaviour was not correct and was illogical since you can use new type pattern to create a reference response.Add new attribute
#[to_schema]which can be used to inline schema of unnamed field struct or enum variant which already has#[content]attribute. Without#[to_schema]attribute response will be created with a reference to the field type.Resolves #412