fastapi/docs/en/docs/tutorial
Sebastián Ramírez 1f01ce9615
📝 Use Optional in docs (#1644)
* Updated .py files with Optional tag (up to body_nested_models)

* Update optionals

* docs_src/ all updates, few I was unsure of

* Updated markdown files with Optional param

* es: Add Optional typing to index.md

* Last of markdown files updated with Optional param

* Update highlight lines

* it: Add Optional typings

* README.md: Update with Optional typings

* Update more highlight increments

* Update highlights

* schema-extra-example.md: Update highlights

* updating highlighting on website to reflect .py changes

* Update highlighting for query-params & response-directly

* Address PR comments

* Get rid of unnecessary comment

*  Revert Optional in Chinese docs as it probably also requires changes in text

* 🎨 Apply format

*  Revert modified example

* ♻️ Simplify example in docs

* 📝 Update OpenAPI callback example to use Optional

*  Add Optional types to tests

* 📝 Update docs about query params, default to using Optional

* 🎨 Update code examples line highlighting

* 📝 Update nested models docs to use "type parameters" instead of "subtypes"

* 📝 Add notes about FastAPI usage of None

including:

= None

and

= Query(None)

and clarify relationship with Optional[str]

* 📝 Add note about response_model_by_alias

* ♻️ Simplify query param list example

* 🔥 Remove test for removed example

*  Update test for updated example

Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com>
Co-authored-by: yk396 <yk396@cornell.edu>
Co-authored-by: Kai Chen <kaichen120@gmail.com>
2020-06-28 20:13:30 +02:00
..
dependencies 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
security 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
background-tasks.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
bigger-applications.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
body-fields.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
body-multiple-params.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
body-nested-models.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
body-updates.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
body.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
cookie-params.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
cors.md 📝 Update cors.md - CORS max_age 600 (#1301) 2020-05-17 12:48:02 +02:00
debugging.md 📝 Add example of Pycharm in tutorial/debugging.md (#1096) 2020-03-29 18:50:29 +02:00
encoder.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
extra-data-types.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
extra-models.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
first-steps.md 📝 Update docs for first-steps, links, rewordings (#1518) 2020-06-13 18:53:31 +02:00
handling-errors.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
header-params.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
index.md 🌐 Add Spanish translation for the tutorial-user-guide index page (#1244) 2020-05-16 13:02:20 +02:00
metadata.md 📝 Update Tags metadata title 2020-06-13 14:02:58 +02:00
middleware.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
path-operation-configuration.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
path-params-numeric-validations.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
path-params.md 📝 Updated docs for path-params (#1521) 2020-06-13 19:14:23 +02:00
query-params-str-validations.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
query-params.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
request-files.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
request-forms-and-files.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
request-forms.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
response-model.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
response-status-code.md Add support for Python's http.HTTPStatus in status_code (#1534) 2020-06-13 19:40:10 +02:00
schema-extra-example.md 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
sql-databases.md 📝 Add note about Alembic in project generator in SQL docs (#1183) 2020-04-05 15:15:39 +02:00
static-files.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
testing.md Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00