fastapi/docs_src
Ezzeddin Abdullah 0c796747a3
📝 Update template docs with more info about `url_for` (#5937)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-01-11 23:25:37 +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 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
advanced_middleware Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
app_testing 📝 Replace HTTP code returned in case of existing user error in docs for testing (#4482) 2024-01-09 18:44:08 +04: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 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
behind_a_proxy Auto-generate OpenAPI servers from root_path (#1596) 2020-07-10 19:28:18 +02:00
bigger_applications 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
body 📝 Update code examples in docs for body, replace name `create_item` with `update_item` when appropriate (#5913) 2024-01-09 18:28:58 +04:00
body_fields 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
body_multiple_params 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01: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 Add support for Pydantic v2 (#9816) 2023-07-07 19:12:13 +02:00
configure_swagger_ui 📝 Add new docs section, How To - Recipes, move docs that don't have to be read by everyone to How To (#10114) 2023-08-19 21:54:04 +02:00
cookie_params 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
cors Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
custom_docs_ui 📌 Pin Swagger UI version to 5.9.0 temporarily to handle a bug crashing it in 5.9.1 (#10529) 2023-10-30 13:58:58 +04: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 ✏️ Fix typo in dependencies with yield source examples (#10847) 2023-12-26 21:37:34 +01:00
dependency_testing 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01: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 📝 Add new docs section, How To - Recipes, move docs that don't have to be read by everyone to How To (#10114) 2023-08-19 21:54:04 +02:00
extra_data_types 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
extra_models Add support for Pydantic v2 (#9816) 2023-07-07 19:12:13 +02:00
first_steps Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
generate_clients 📝 Add docs: Node.js script alternative to update OpenAPI for generated clients (#10845) 2023-12-26 18:23:20 +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 👷 Adopt Ruff format (#10517) 2023-10-25 00:26:06 +04:00
metadata Add support for OpenAPI 3.1.0 (#9770) 2023-06-30 20:25:16 +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
openapi_webhooks ✏️ Fix typos in emoji docs and in some source examples (#10438) 2023-10-20 13:00:44 +04:00
path_operation_advanced_configuration Add support for Pydantic v2 (#9816) 2023-07-07 19:12:13 +02: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 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
python_types ✏️ Fix Pydantic examples in tutorial for Python types (#9961) 2023-09-02 17:56:35 +02: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 👷 Adopt Ruff format (#10517) 2023-10-25 00:26:06 +04:00
request_files 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
request_forms 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
request_forms_and_files 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +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 📝 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 support for `openapi_examples` in all FastAPI parameters (#10152) 2023-08-26 20:03:13 +02:00
security 📝 Update usage of Token model in security docs (#9313) 2024-01-11 16:21:35 -05:00
separate_openapi_schemas Add support for disabling the separation of input and output JSON Schemas in OpenAPI with Pydantic v2 (#10145) 2023-08-25 21:10:22 +02:00
settings 👷 Adopt Ruff format (#10517) 2023-10-25 00:26:06 +04:00
sql_databases 📝 Update example source files for SQL databases with SQLAlchemy (#9508) 2024-01-09 15:35:33 +01:00
sql_databases_peewee/sql_app 📝 Add new docs section, How To - Recipes, move docs that don't have to be read by everyone to How To (#10114) 2023-08-19 21:54:04 +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 📝 Update template docs with more info about `url_for` (#5937) 2024-01-11 23:25:37 +01:00
using_request_directly Add support for docs translations (#1168) 2020-03-26 20:09:53 +01:00
websockets 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
wsgi 🐛 Fix `flask.escape` warning for internal tests (#9468) 2023-05-09 14:32:00 +00:00