fastapi/docs_src
Jordan Speicher cc9a73c3f8
Add support for `lifespan` async context managers (superseding `startup` and `shutdown` events) (#2944)
Co-authored-by: Mike Shantz <mshantz@coldstorage.com>
Co-authored-by: Jonathan Plasse <13716151+JonathanPlasse@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2023-03-07 16:46:00 +01:00
..
additional_responses 📝 Simplify example for docs for Additional Responses, remove unnecessary `else` (#4693) 2022-08-26 15:32:30 +02:00
additional_status_codes Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) 2022-05-13 18:38:22 -05:00
advanced_middleware Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
app_testing ⬆️ Bump Starlette from 0.22.0 to 0.23.0 (#5739) 2023-02-08 11:23:07 +01:00
async_sql_databases Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
async_tests Add support for Trio via AnyIO (#3372) 2021-10-06 17:32:11 +02:00
background_tasks 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
behind_a_proxy Auto-generate OpenAPI servers from root_path (#1596) 2020-07-10 19:28:18 +02:00
bigger_applications Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) 2022-05-13 18:38:22 -05:00
body 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
body_fields Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) 2022-05-13 18:38:22 -05:00
body_multiple_params 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
body_nested_models 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
body_updates 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
conditional_openapi Allow disabling docs UIs by disabling OpenAPI (#1421) 2020-05-16 17:45:12 +02:00
cookie_params Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) 2022-05-13 18:38:22 -05:00
cors Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
custom_request_and_route Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) 2022-05-13 18:38:22 -05:00
custom_response 📝 Update docs for `ORJSONResponse` with details about improving performance (#2615) 2022-09-01 09:59:05 +00:00
dataclasses 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
debugging Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
dependencies 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
dependency_testing 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
encoder 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
events Add support for `lifespan` async context managers (superseding `startup` and `shutdown` events) (#2944) 2023-03-07 16:46:00 +01:00
extending_openapi Enable configuring Swagger UI parameters (#2568) 2022-01-16 20:26:24 +01:00
extra_data_types 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
extra_models 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
first_steps Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
generate_clients Add support for custom `generate_unique_id_function` and docs for generating clients (#4650) 2022-03-04 23:02:18 +01:00
graphql 📝 Update GraphQL docs, recommend Strawberry (#3981) 2021-10-03 20:00:28 +02:00
handling_errors 🔊 Fix empty log message in docs example about raised exceptions (#1815) 2020-08-09 13:10:33 +02:00
header_params 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
metadata Add additonal OpenAPI metadata parameters to `FastAPI` class, shown on the automatic API docs UI (#1812) 2021-07-29 17:10:22 +02:00
middleware Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
nosql_databases 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
openapi_callbacks 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
path_operation_advanced_configuration 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
path_operation_configuration 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
path_params 📝 Update docs, compare enums with identity instead of equality (#4905) 2022-08-26 15:26:03 +02:00
path_params_numeric_validations Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) 2022-05-13 18:38:22 -05:00
python_types 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
query_params 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
query_params_str_validations 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
request_files 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
request_forms Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) 2022-05-13 18:38:22 -05:00
request_forms_and_files Add support for not needing `...` as default value in required Query(), Path(), Header(), etc. (#4906) 2022-05-13 18:38:22 -05: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 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
response_headers Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
response_model 📝 Update docs and examples for Response Model with Return Type Annotations, and update runtime error (#5873) 2023-01-10 16:22:47 +00:00
response_status_code Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
schema_extra_example 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
security Use Ruff for linting (#5630) 2022-11-13 19:19:04 +01:00
settings Add the `docs_src` directory to test coverage and update tests (#1904) 2021-07-29 11:26:07 +02:00
sql_databases 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05:00
sql_databases_peewee 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05: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 HTML media type to template docs (#1690) 2020-08-03 09:53:56 +02:00
using_request_directly Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
websockets Re-export Starlette's `WebSocketException` and add it to docs (#5629) 2022-11-13 17:10:54 +01:00
wsgi 🏁 Update Windows development environment and tests (#1179) 2020-03-29 17:04:04 +02:00