Fix Option<Query<T>> type support
#678
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
Fix `Option<Query<T>>` for primitive types. Prior to this commit
defining before mentioned type as an argument to path operation handler
caused a compile error in 3.4.0 release. This bug has been there before
but it manifested only after the changes regarding automatic query
parameter detection was made.
This commit allows optional query parameters for handler function:
```rust
async fn get_item(id: Option<Query<u32>>) {}
```
**Note!** The automatic query parameter detection does not work for
primitive types on `axum` and in `actix_web` frameworks because it has
never been implemented. They will always be expected to work with
`IntoParams` trait. This said with these frameworks the primitive query
parameters if not used with `IntoParams` must be declared manually to
the `#[utoipa::path(params(...))]` macro as input arguments.
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.
Fix
Option<Query<T>>for primitive types. Prior to this commit defining before mentioned type as an argument to path operation handler caused a compile error in 3.4.0 release. This bug has been there before but it manifested only after the changes regarding automatic query parameter detection was made.This commit allows optional query parameters for handler function:
Note! The automatic query parameter detection does not work for primitive types on
axumand inactix_webframeworks because it has never been implemented. It will always be expected to work withIntoParamstrait. This said with these frameworks the primitive query parameters if not used withIntoParamsmust be declared manually to the#[utoipa::path(params(...))]macro as input arguments.Resolves #677 Resolves #675