fastapi/docs_src
Harsha Laxman 2cef119cd7
📝 Use in memory database for testing SQL in docs (#1223)
Co-authored-by: Harsha Laxman <harsh@Harshas-MacBook-Pro.local>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-06-22 11:20:12 +00: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 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +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 📝 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 📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) 2022-05-14 06:59:59 -05: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 Allow disabling docs UIs by disabling OpenAPI (#1421) 2020-05-16 17:45:12 +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_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 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +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 Enable configuring Swagger UI parameters (#2568) 2022-01-16 20:26:24 +01: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 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 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01: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 📝 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 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01: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 📝 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_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 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
security 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
settings 📝 Update all docs to use `Annotated` as the main recommendation, with new examples and tests (#9268) 2023-03-18 13:29:59 +01:00
sql_databases 📝 Use in memory database for testing SQL in docs (#1223) 2023-06-22 11:20:12 +00: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 📝 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