Strip null from query parameter schemas #275
Open
Conversation
This file contains hidden or 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
Schemars generates null types for Option<T> fields (either
`type: ["string", "null"]` or `anyOf: [{...}, {type: "null"}]`),
but query strings cannot express null values - a parameter is
either present with a value or absent.
This change automatically strips null types from query parameter
schemas during finalization. The behavior is enabled by default
and can be disabled with `strip_query_null_types(false)`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #274.
Query strings cannot express null values - a parameter is either present with a value or absent - so null types in the schema don't make sense and cause issues for SDK generators.
The transformation handles two cases:
type: ["string", "null"], changed totype: "string"anyOf: [{$ref: ...}, {type: "null"}], changed to{$ref: ...}This is enabled by default and can be disabled if needed:
A manual method
TransformOpenApi::strip_null_from_query_params()is also available if you need to apply it at a specific point in your transform chain.