fastapi/docs_src
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
..
additional_responses 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
additional_status_codes 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
advanced_middleware Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
app_testing 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
async_sql_databases Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
background_tasks 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
behind_a_proxy Add support for ASGI root_path for openapi docs (#1199) 2020-06-11 23:53:19 +02:00
bigger_applications Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
body 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
body_fields 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
body_multiple_params 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
body_nested_models 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
body_updates 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
conditional_openapi Allow disabling docs UIs by disabling OpenAPI (#1421) 2020-05-16 17:45:12 +02:00
cookie_params 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
cors Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
custom_request_and_route Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
custom_response 📝 Add docs for `default_response_class` (#1455) 2020-06-13 18:02:45 +02:00
debugging Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
dependencies 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
dependency_testing 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
encoder 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
events Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
extending_openapi Add support for ASGI root_path for openapi docs (#1199) 2020-06-11 23:53:19 +02:00
extra_data_types 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
extra_models 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
first_steps Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
graphql Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
handling_errors Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
header_params 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
metadata Add support for tag metadata in OpenAPI (#1348) 2020-06-13 13:58:06 +02:00
middleware Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
nosql_databases Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
openapi_callbacks 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
path_operation_advanced_configuration 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
path_operation_configuration 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
path_params 📝 Updated docs for path-params (#1521) 2020-06-13 19:14:23 +02:00
path_params_numeric_validations 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
python_types 📝 Add docs in Python Types for Optional (#1377) 2020-06-12 23:44:23 +02:00
query_params 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
query_params_str_validations 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
request_files Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
request_forms 📝 Remove *, from functions where it's not needed #1234 (#1239) 2020-06-12 21:41:44 +02:00
request_forms_and_files Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
response_change_status_code Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
response_cookies Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
response_directly 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
response_headers Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
response_model 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
response_status_code Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
schema_extra_example 📝 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
settings 📝 Settings using lru_cache (#1214) 2020-04-04 21:39:15 +02:00
sql_databases 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
sql_databases_peewee 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
static_files Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
sub_applications Add support for ASGI root_path for openapi docs (#1199) 2020-06-11 23:53:19 +02:00
templates Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
using_request_directly Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
websockets 📝 Use Optional in docs (#1644) 2020-06-28 20:13:30 +02:00
wsgi 🏁 Update Windows development environment and tests (#1179) 2020-03-29 17:04:04 +02:00