Skip to content

📝 Clarify "Required, can be None" query parameter docs #15496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sanskar121543 wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −1
Open

📝 Clarify "Required, can be None" query parameter docs #15496

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/en/docs/tutorial/query-params-str-validations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,9 @@ So, when you need to declare a value as required while using `Query`, you can si

### Required, can be `None` { #required-can-be-none }

You can declare that a parameter can accept `None`, but that it's still required. This would force clients to send a value, even if the value is `None`.
You can declare that a parameter can accept `None`, while still requiring clients to provide the parameter in the request.

Keep in mind that HTTP query parameters are sent as strings, so clients cannot directly send Python `None` values.

To do that, you can declare that `None` is a valid type but simply do not declare a default value:

Expand Down
Loading