Browse Source

Clarify query parameter validation behavior

pull/16023/head
hos 2 days ago
committed by GitHub
parent
commit
783595aa10
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 5
      docs/en/docs/tutorial/query-params.md

5
docs/en/docs/tutorial/query-params.md

@ -20,6 +20,11 @@ http://127.0.0.1:8000/items/?skip=0&limit=10
As they are part of the URL, they are "naturally" strings.
But when you declare them with Python types (in the example above, as `int`), they are converted to that type and validated against it.
For example, if `skip` is declared as an `int`, sending a value that cannot be converted to an integer:
```
http://127.0.0.1:8000/items/?skip=abc
```
will result in a validation error because `"abc"` cannot be converted to an integer.
All the same processes that apply to path parameters also apply to query parameters:

Loading…
Cancel
Save