🎨(api) use Annotated instead of Query as the default value #589
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
wilbrdt
force-pushed
the
replace-query-annotated
branch
from
3152458
to
5f5a239
Compare
wilbrdt
force-pushed
the
structure/tests/pydantic-v2-and-polyfactory
branch
from
e46e3b3
to
de2d1d9
Compare
wilbrdt
force-pushed
the
structure/tests/pydantic-v2-and-polyfactory
branch
2 times, most recently
from
8ebdca5
to
2f25e8b
Compare
Base automatically changed from
structure/tests/pydantic-v2-and-polyfactory
to
main
April 19, 2024 15:29
wilbrdt
force-pushed
the
replace-query-annotated
branch
5 times, most recently
from
793416b
to
639425f
Compare
As FastAPI recommends in its documentation (https://fastapi.tiangolo.com/tutorial/query-params-str-validations/), it is preferable to use Annotated with Query instead of a Query default value.
wilbrdt
force-pushed
the
replace-query-annotated
branch
from
639425f
to
4402ff2
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.
Proposal
As FastAPI recommends in its documentation (https://fastapi.tiangolo.com/tutorial/query-params-str-validations/), it is preferable to use Annotated with Query instead of a Query default value.
On a side note, issue #556 is still open, as FastAPI does not yet allow to use custom objects as query parameters type (see fastapi/fastapi#10259).