mirror of https://github.com/tiangolo/fastapi.git
05ca41cfd1
* ➕ Add mkdocstrings and griffe-typingdoc to dependencies * 🔧 Add mkdocstrings configs to MkDocs * 📝 Add first WIP reference page * ⬆️ Upgrade typing-extensions to the minimum version including Doc() * 📝 Add docs to FastAPI parameters * 📝 Add docstrings for OpenAPI docs utils * 📝 Add docstrings for security utils * 📝 Add docstrings for UploadFile * 📝 Update docstrings in FastAPI class * 📝 Add docstrings for path operation methods * 📝 Add docstring for jsonable_encoder * 📝 Add docstrings for exceptions * 📝 Add docstsrings for parameter functions * 📝 Add docstrings for responses * 📝 Add docstrings for APIRouter * ♻️ Sub-class BackgroundTasks to document it with docstrings * 📝 Update usage of background tasks in dependencies * ✅ Update tests with new deprecation warnings * 📝 Add new reference docs * 🔧 Update MkDocs with new reference docs * ✅ Update pytest fixture, deprecation is raised only once * 🎨 Update format for types in exceptions.py * ♻️ Update annotations in BackgroundTask, `Annotated` can't take ParamSpec's P.args or P.kwargs * ✏️ Fix typos caught by @pawamoy * 🔧 Update and fix MkDocstrings configs from @pawamoy tips * 📝 Update reference docs * ✏️ Fix typos found by @pawamoy * ➕ Add HTTPX as a dependency for docs, for the TestClient * 🔧 Update MkDocs config, rename websockets reference * 🔇 Add type-ignores for Doc as the stubs haven't been released for mypy * 🔥 Remove duplicated deprecated notice * 🔇 Remove typing error for unreleased stub in openapi/docs.py * ✅ Add tests for UploadFile for coverage * ⬆️ Upgrade griffe-typingdoc==0.2.2 * 📝 Refactor docs structure * 🔨 Update README generation with new index frontmatter and style * 🔨 Update generation of languages, remove from top menu, keep in lang menu * 📝 Add OpenAPI Pydantic models * 🔨 Update docs script to not translate Reference and Release Notes * 🔧 Add reference for OpenAPI models * 🔧 Update MkDocs config for mkdocstrings insiders * 👷 Install mkdocstring insiders in CI for docs * 🐛 Fix MkDocstrings insiders install URL * ➕ Move dependencies shared by docs and tests to its own requirements file * 👷 Update cache keys for test and docs dependencies * 📝 Remove no longer needed __init__ placeholder docstrings * 📝 Move docstring for APIRouter to the class level (not __init__ level) * 🔥 Remove no longer needed dummy placeholder __init__ docstring |
||
|---|---|---|
| .. | ||
| test_additional_responses | ||
| test_additional_status_codes | ||
| test_advanced_middleware | ||
| test_async_sql_databases | ||
| test_async_tests | ||
| test_background_tasks | ||
| test_behind_a_proxy | ||
| test_bigger_applications | ||
| test_body | ||
| test_body_fields | ||
| test_body_multiple_params | ||
| test_body_nested_models | ||
| test_body_updates | ||
| test_conditional_openapi | ||
| test_configure_swagger_ui | ||
| test_cookie_params | ||
| test_cors | ||
| test_custom_docs_ui | ||
| test_custom_request_and_route | ||
| test_custom_response | ||
| test_dataclasses | ||
| test_dependencies | ||
| test_events | ||
| test_extending_openapi | ||
| test_extra_data_types | ||
| test_extra_models | ||
| test_first_steps | ||
| test_generate_clients | ||
| test_handling_errors | ||
| test_header_params | ||
| test_metadata | ||
| test_openapi_callbacks | ||
| test_openapi_webhooks | ||
| test_path_operation_advanced_configurations | ||
| test_path_operation_configurations | ||
| test_path_params | ||
| test_query_params | ||
| test_query_params_str_validations | ||
| test_request_files | ||
| test_request_forms | ||
| test_request_forms_and_files | ||
| test_response_change_status_code | ||
| test_response_cookies | ||
| test_response_headers | ||
| test_response_model | ||
| test_schema_extra_example | ||
| test_security | ||
| test_separate_openapi_schemas | ||
| test_settings | ||
| test_sql_databases | ||
| test_sub_applications | ||
| test_templates | ||
| test_testing | ||
| test_testing_dependencies | ||
| test_websockets | ||
| test_wsgi | ||
| __init__.py | ||