]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commit
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908)
authorSebastián Ramírez <tiangolo@gmail.com>
Sat, 14 May 2022 11:59:59 +0000 (06:59 -0500)
committerGitHub <noreply@github.com>
Sat, 14 May 2022 11:59:59 +0000 (06:59 -0500)
commitca437cdfabe7673b838cf42889ba1c653acd2228
tree538cb6e747dc2c05ee282836e5069aad6e5cacde
parentc5be1b0550f17d827721a5be1dc4344e73b1993f
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908)

* 📝 Add docs recommending Union over Optional

* 📝 Update docs recommending Union over Optional

* 📝 Update source examples for docs, recommend Union over Optional

* 📝 Update highlighted lines with updated source examples

* 📝 Update highlighted lines in Markdown with recent code changes

* 📝 Update docs, use Union instead of Optional

* ♻️ Update source examples to recommend Union over Optional

* 🎨 Update highlighted code in Markdown after moving from Optional to Union
131 files changed:
README.md
docs/de/docs/index.md
docs/en/docs/advanced/additional-status-codes.md
docs/en/docs/advanced/testing-dependencies.md
docs/en/docs/deployment/docker.md
docs/en/docs/index.md
docs/en/docs/python-types.md
docs/en/docs/tutorial/body-multiple-params.md
docs/en/docs/tutorial/body.md
docs/en/docs/tutorial/dependencies/classes-as-dependencies.md
docs/en/docs/tutorial/dependencies/index.md
docs/en/docs/tutorial/dependencies/sub-dependencies.md
docs/en/docs/tutorial/path-params-numeric-validations.md
docs/en/docs/tutorial/response-model.md
docs/en/docs/tutorial/schema-extra-example.md
docs/es/docs/advanced/additional-status-codes.md
docs/es/docs/index.md
docs/es/docs/tutorial/query-params.md
docs/fa/docs/index.md
docs/fr/docs/index.md
docs/ja/docs/advanced/additional-status-codes.md
docs/ja/docs/tutorial/query-params-str-validations.md
docs/ko/docs/index.md
docs/ko/docs/tutorial/path-params-numeric-validations.md
docs/ko/docs/tutorial/query-params.md
docs/nl/docs/index.md
docs/pl/docs/index.md
docs/pt/docs/index.md
docs/pt/docs/tutorial/body.md
docs/pt/docs/tutorial/query-params-str-validations.md
docs/ru/docs/index.md
docs/sq/docs/index.md
docs/tr/docs/index.md
docs/uk/docs/index.md
docs/zh/docs/advanced/additional-status-codes.md
docs/zh/docs/index.md
docs/zh/docs/tutorial/body-multiple-params.md
docs/zh/docs/tutorial/dependencies/index.md
docs/zh/docs/tutorial/dependencies/sub-dependencies.md
docs/zh/docs/tutorial/path-params-numeric-validations.md
docs/zh/docs/tutorial/query-params-str-validations.md
docs/zh/docs/tutorial/response-model.md
docs/zh/docs/tutorial/schema-extra-example.md
docs_src/additional_responses/tutorial002.py
docs_src/additional_responses/tutorial004.py
docs_src/background_tasks/tutorial002.py
docs_src/body/tutorial001.py
docs_src/body/tutorial002.py
docs_src/body/tutorial003.py
docs_src/body/tutorial004.py
docs_src/body_multiple_params/tutorial002.py
docs_src/body_nested_models/tutorial001.py
docs_src/body_nested_models/tutorial002.py
docs_src/body_nested_models/tutorial002_py39.py
docs_src/body_nested_models/tutorial003.py
docs_src/body_nested_models/tutorial003_py39.py
docs_src/body_nested_models/tutorial004.py
docs_src/body_nested_models/tutorial004_py39.py
docs_src/body_nested_models/tutorial005.py
docs_src/body_nested_models/tutorial005_py39.py
docs_src/body_nested_models/tutorial006.py
docs_src/body_nested_models/tutorial006_py39.py
docs_src/body_nested_models/tutorial007.py
docs_src/body_nested_models/tutorial007_py39.py
docs_src/body_updates/tutorial001.py
docs_src/body_updates/tutorial001_py39.py
docs_src/body_updates/tutorial002.py
docs_src/body_updates/tutorial002_py39.py
docs_src/dataclasses/tutorial001.py
docs_src/dataclasses/tutorial002.py
docs_src/dataclasses/tutorial003.py
docs_src/dependencies/tutorial001.py
docs_src/dependencies/tutorial002.py
docs_src/dependencies/tutorial003.py
docs_src/dependencies/tutorial004.py
docs_src/dependencies/tutorial005.py
docs_src/dependency_testing/tutorial001.py
docs_src/encoder/tutorial001.py
docs_src/extra_data_types/tutorial001.py
docs_src/extra_models/tutorial001.py
docs_src/extra_models/tutorial002.py
docs_src/header_params/tutorial001.py
docs_src/header_params/tutorial002.py
docs_src/header_params/tutorial003.py
docs_src/header_params/tutorial003_py39.py
docs_src/nosql_databases/tutorial001.py
docs_src/openapi_callbacks/tutorial001.py
docs_src/path_operation_advanced_configuration/tutorial004.py
docs_src/path_operation_configuration/tutorial001.py
docs_src/path_operation_configuration/tutorial001_py39.py
docs_src/path_operation_configuration/tutorial002.py
docs_src/path_operation_configuration/tutorial002_py39.py
docs_src/path_operation_configuration/tutorial003.py
docs_src/path_operation_configuration/tutorial003_py39.py
docs_src/path_operation_configuration/tutorial004.py
docs_src/path_operation_configuration/tutorial004_py39.py
docs_src/path_operation_configuration/tutorial005.py
docs_src/path_operation_configuration/tutorial005_py39.py
docs_src/python_types/tutorial009c.py [new file with mode: 0644]
docs_src/python_types/tutorial009c_py310.py [new file with mode: 0644]
docs_src/python_types/tutorial011.py
docs_src/python_types/tutorial011_py39.py
docs_src/python_types/tutorial012.py [new file with mode: 0644]
docs_src/query_params/tutorial002.py
docs_src/query_params/tutorial003.py
docs_src/query_params/tutorial004.py
docs_src/query_params/tutorial006.py
docs_src/query_params_str_validations/tutorial001.py
docs_src/request_files/tutorial001_02.py
docs_src/response_directly/tutorial001.py
docs_src/response_model/tutorial001.py
docs_src/response_model/tutorial001_py39.py
docs_src/response_model/tutorial002.py
docs_src/response_model/tutorial003.py
docs_src/response_model/tutorial004.py
docs_src/response_model/tutorial004_py39.py
docs_src/response_model/tutorial005.py
docs_src/response_model/tutorial006.py
docs_src/schema_extra_example/tutorial001.py
docs_src/schema_extra_example/tutorial002.py
docs_src/schema_extra_example/tutorial003.py
docs_src/schema_extra_example/tutorial004.py
docs_src/security/tutorial002.py
docs_src/security/tutorial003.py
docs_src/security/tutorial004.py
docs_src/security/tutorial005.py
docs_src/security/tutorial005_py39.py
docs_src/sql_databases/sql_app/schemas.py
docs_src/sql_databases/sql_app_py39/schemas.py
docs_src/sql_databases_peewee/sql_app/schemas.py
docs_src/websockets/tutorial002.py