]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commit
projects / thirdparty / fastapi / fastapi.git / commit
? search:
summary | shortlog | log | commit | commitdiff | tree
(parent: 5f855b1) | patch
✨ Add support for `openapi_examples` in all FastAPI parameters (#10152)
authorSebastián Ramírez <tiangolo@gmail.com>
Sat, 26 Aug 2023 18:03:13 +0000 (20:03 +0200)
committerGitHub <noreply@github.com>
Sat, 26 Aug 2023 18:03:13 +0000 (20:03 +0200)
commit1b714b317732df1e08983e4a8ffe2e4e02c995e0
tree4c710775966f1f8e535a4afb44e7f3003ed874fdtree | snapshot
parent5f855b1179d06c8b82f479013e5888c48e68c716commit | diff
✨ Add support for `openapi_examples` in all FastAPI parameters (#10152)

* ♻️ Refactor model for OpenAPI Examples to use a reusable TypedDict

* ✨ Add support for openapi_examples in parameters

* 📝 Add new docs examples for new parameter openapi_examples

* 📝 Update docs for Schema Extra to include OpenAPI examples

* ✅ Add tests for new source examples, for openapi_examples

* ✅ Add tests for openapi_examples corner cases and all parameters

* 💡 Tweak and ignore type annotation checks for custom TypedDict
16 files changed:
docs/en/docs/tutorial/schema-extra-example.md diff | blob | blame | history
docs_src/schema_extra_example/tutorial005.py [new file with mode: 0644] blob
docs_src/schema_extra_example/tutorial005_an.py [new file with mode: 0644] blob
docs_src/schema_extra_example/tutorial005_an_py310.py [new file with mode: 0644] blob
docs_src/schema_extra_example/tutorial005_an_py39.py [new file with mode: 0644] blob
docs_src/schema_extra_example/tutorial005_py310.py [new file with mode: 0644] blob
fastapi/openapi/models.py diff | blob | blame | history
fastapi/openapi/utils.py diff | blob | blame | history
fastapi/param_functions.py diff | blob | blame | history
fastapi/params.py diff | blob | blame | history
tests/test_openapi_examples.py [new file with mode: 0644] blob
tests/test_tutorial/test_schema_extra_example/test_tutorial005.py [new file with mode: 0644] blob
tests/test_tutorial/test_schema_extra_example/test_tutorial005_an.py [new file with mode: 0644] blob
tests/test_tutorial/test_schema_extra_example/test_tutorial005_an_py310.py [new file with mode: 0644] blob
tests/test_tutorial/test_schema_extra_example/test_tutorial005_an_py39.py [new file with mode: 0644] blob
tests/test_tutorial/test_schema_extra_example/test_tutorial005_py310.py [new file with mode: 0644] blob
Mirror of https://github.com/fastapi/fastapi.git