Commit Graph

1868 Commits

Author SHA1 Message Date
github-actions 4ef7a40eae 📝 Update release notes 2023-10-22 10:04:16 +00:00
github-actions f9b53ae778 📝 Update release notes 2023-10-22 07:35:50 +00:00
Sebastián Ramírez e8bd645fa9
📝 Update data structure and render for external-links (#10495)
* 📝 Update data structure and render for external-links

* 📝 Update translations for external links
2023-10-22 11:35:13 +04:00
github-actions 808e3bb9d5 📝 Update release notes 2023-10-21 07:11:00 +00:00
github-actions ab65486e75 📝 Update release notes 2023-10-20 09:21:13 +00:00
worldworm 9b3e166b43
✏️ Fix link to SPDX license identifier in `docs/en/docs/tutorial/metadata.md` (#10433)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2023-10-20 13:19:31 +04:00
github-actions 07a9b240e9 📝 Update release notes 2023-10-20 09:13:35 +00:00
Giulio Davide Carparelli 89e03bad16
📝 Update example validation error from Pydantic v1 to match Pydantic v2 in `docs/en/docs/tutorial/path-params.md` (#10043) 2023-10-20 13:08:42 +04:00
github-actions f41eb5e005 📝 Update release notes 2023-10-20 09:03:34 +00:00
github-actions eb017270fc 📝 Update release notes 2023-10-20 09:00:53 +00:00
Heinz-Alexander Fuetterer ae84ff6e44
✏️ Fix typos in emoji docs and in some source examples (#10438) 2023-10-20 13:00:44 +04:00
github-actions f785a6ce90 📝 Update release notes 2023-10-20 09:00:11 +00:00
Surav Shrestha 6dac39dbca
✏️ Fix typo in `docs/en/docs/reference/dependencies.md` (#10465) 2023-10-20 12:58:51 +04:00
yogabonito 4bd1430677
✏️ Fix typos and rewordings in `docs/en/docs/tutorial/body-nested-models.md` (#10468) 2023-10-20 12:58:03 +04:00
github-actions cda5e770ab 📝 Update release notes 2023-10-20 08:56:08 +00:00
yogabonito 57a030175e
📝 Update docs, remove references to removed `pydantic.Required` in `docs/en/docs/tutorial/query-params-str-validations.md` (#10469) 2023-10-20 12:55:30 +04:00
github-actions 968afca058 📝 Update release notes 2023-10-20 08:53:37 +00:00
Tiago Silva 6eb30959bc
✏️ Fix typo in `docs/en/docs/reference/index.md` (#10467)
Fix small typo in reference/index.md
2023-10-20 12:52:59 +04:00
github-actions dcbe7f7ac0 📝 Update release notes 2023-10-20 08:39:45 +00:00
Sebastián Ramírez dc7838eec3
🔥 Drop/close Gitter chat. Questions should go to GitHub Discussions, free conversations to Discord. (#10485) 2023-10-20 12:39:03 +04:00
github-actions 7670a132b3 📝 Update release notes 2023-10-20 08:28:05 +00:00
Sebastián Ramírez 38f191dcd3 🔖 Release version 0.104.0 2023-10-18 16:51:07 +04:00
Sebastián Ramírez 76e547f254 📝 Update release notes 2023-10-18 16:50:22 +04:00
github-actions f056d001e5 📝 Update release notes 2023-10-18 12:37:29 +00:00
Sebastián Ramírez 05ca41cfd1
Add reference (code API) docs with PEP 727, add subclass with custom docstrings for `BackgroundTasks`, refactor docs structure (#10392)
*  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
2023-10-18 16:36:40 +04:00
github-actions 3fa44aabe3 📝 Update release notes 2023-10-17 07:20:59 +00:00
github-actions 912e4bb906 📝 Update release notes 2023-10-17 07:20:20 +00:00
github-actions e5fd92a7ab 📝 Update release notes 2023-10-17 07:19:26 +00:00
github-actions 4ef8c3286d 📝 Update release notes 2023-10-17 05:59:55 +00:00
Sebastián Ramírez 2ba7586ff3
⬆️ Drop support for Python 3.7, require Python 3.8 or above (#10442)
* 📝 Update docs, require Python 3.8+, drop 3.7

* 🔧 Update pyproject.toml, drop support for Python 3.7, require Python 3.8+

* 👷 Update CI GitHub Actions, drop support for Python 3.7, require 3.8+

* 📝 Update docs' references to Python 3.6 and 3.7, use Python 3.8
2023-10-17 09:59:11 +04:00
github-actions c1adce4fe9 📝 Update release notes 2023-10-04 22:52:00 +00:00
Sebastián Ramírez 89789c80ae
🔧 Update sponsors, Bump.sh images (#10381) 2023-10-04 22:51:10 +00:00
github-actions cb4f0e57ce 📝 Update release notes 2023-10-02 23:12:28 +00:00
Sebastián Ramírez 568b35f3df
👥 Update FastAPI People (#10363)
Co-authored-by: github-actions <github-actions@github.com>
2023-10-02 18:11:52 -05:00
Sebastián Ramírez 1bf5e7a10e 🔖 Release 0.103.2 2023-09-28 14:57:42 -05:00
Sebastián Ramírez fcda32d231 📝 Update release notes 2023-09-28 14:56:50 -05:00
github-actions d769da3c38 📝 Update release notes 2023-09-28 19:42:38 +00:00
Sebastián Ramírez 2f50ae8825
🔧 Update sponsors, remove Flint (#10349) 2023-09-28 14:41:17 -05:00
github-actions 831b5d5402 📝 Update release notes 2023-09-28 04:15:17 +00:00
github-actions b944b55dfc 📝 Update release notes 2023-09-27 23:02:35 +00:00
github-actions 1c4a9e91b6 📝 Update release notes 2023-09-27 20:55:18 +00:00
github-actions 99ffbcdee0 📝 Update release notes 2023-09-27 20:53:18 +00:00
github-actions 27870e20f5 📝 Update release notes 2023-09-27 20:48:01 +00:00
github-actions 073e7fc950 📝 Update release notes 2023-09-25 23:08:51 +00:00
github-actions 255e743f98 📝 Update release notes 2023-09-25 23:05:48 +00:00
github-actions 14e0914fcf 📝 Update release notes 2023-09-25 23:02:43 +00:00
github-actions c75cdc6d9a 📝 Update release notes 2023-09-25 23:00:56 +00:00
github-actions 69a7c99b44 📝 Update release notes 2023-09-22 23:39:37 +00:00
github-actions 79399e43df 📝 Update release notes 2023-09-22 23:37:34 +00:00
github-actions f4bc0d8205 📝 Update release notes 2023-09-22 23:31:21 +00:00
github-actions 46d1da08da 📝 Update release notes 2023-09-15 08:39:26 +00:00
Sebastián Ramírez 571c7a7aba
🔧 Update sponsors, enable Svix (revert #10228) (#10253)
* 🔧 Update sponsors, remove Svix (revert #10228)

This reverts commit e0a99e24b8.

* 🔧 Tweak and update sponsors data
2023-09-15 10:38:48 +02:00
github-actions c6437d555d 📝 Update release notes 2023-09-10 10:37:04 +00:00
Sebastián Ramírez e0a99e24b8
🔧 Update sponsors, remove Svix (#10228) 2023-09-10 12:36:28 +02:00
github-actions a10c35673d 📝 Update release notes 2023-09-10 10:19:02 +00:00
Sebastián Ramírez 766dfb5b38
🔧 Update sponsors, add Bump.sh (#10227) 2023-09-10 12:18:26 +02:00
Sebastián Ramírez bfde8f3ef2 🔖 Release version 0.103.1 2023-09-02 19:10:19 +02:00
Sebastián Ramírez ce8ee1410a 📝 Update release notes 2023-09-02 19:09:47 +02:00
github-actions 118010ad5e 📝 Update release notes 2023-09-02 17:06:22 +00:00
github-actions 8562cae44b 📝 Update release notes 2023-09-02 17:05:59 +00:00
Pablo Dorrío Vázquez c502197d7c
✏️ Fix validation parameter name in docs, from `regex` to `pattern` (#10085) 2023-09-02 19:02:26 +02:00
github-actions 7f1dedac2c 📝 Update release notes 2023-09-02 17:01:44 +00:00
github-actions 7802454131 📝 Update release notes 2023-09-02 16:56:04 +00:00
Yusuke Tamura caf0b688cd
✏️ Fix indent format in `docs/en/docs/deployment/server-workers.md` (#10066)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-09-02 18:55:26 +02:00
github-actions a6d893fe98 📝 Update release notes 2023-09-02 16:16:38 +00:00
Olaoluwa Afolabi 1711c1e95f
🌐 Add Yoruba translation for `docs/yo/docs/index.md` (#10033)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2023-09-02 18:12:44 +02:00
github-actions 34028290f5 📝 Update release notes 2023-09-02 16:03:22 +00:00
github-actions aa43afa4c0 📝 Update release notes 2023-09-02 16:00:21 +00:00
Hasnat Sajid 0ea23e2a8d
✏️ Fix link to Pydantic docs in `docs/en/docs/tutorial/extra-data-types.md` (#10155)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2023-09-02 17:55:41 +02:00
github-actions 7fe952f522 📝 Update release notes 2023-09-02 15:54:22 +00:00
github-actions 28bf4abf1f 📝 Update release notes 2023-09-02 15:50:11 +00:00
github-actions 1866abffc1 📝 Update release notes 2023-09-02 15:49:31 +00:00
Poupapaa 2e32957198
✏️ Fix typo in `docs/en/docs/tutorial/handling-errors.md` (#10170)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2023-09-02 17:43:16 +02:00
github-actions b2562c5c73 📝 Update release notes 2023-09-02 15:41:53 +00:00
github-actions a55f3204ef 📝 Update release notes 2023-09-02 15:37:56 +00:00
github-actions 59cbeccac0 📝 Update release notes 2023-09-02 15:36:34 +00:00
Ragul K 4e93f8e0bc
✏️ Fix typo in `docs/en/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md` (#10172)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2023-09-02 17:32:48 +02:00
github-actions 48f6ccfe7d 📝 Update release notes 2023-09-02 15:31:37 +00:00
github-actions 8cb33e9b47 📝 Update release notes 2023-09-02 15:24:05 +00:00
xzmeng d8f2f39f6d
✏️ Fix typos in `docs/en/docs/how-to/separate-openapi-schemas.md` and `docs/en/docs/tutorial/schema-extra-example.md` (#10189) 2023-09-02 17:22:24 +02:00
github-actions 82ff9a6920 📝 Update release notes 2023-09-02 15:19:08 +00:00
github-actions ee0b28a398 📝 Update release notes 2023-09-01 23:33:31 +00:00
Sebastián Ramírez 4bfe83bd27
👥 Update FastAPI People (#10186)
Co-authored-by: github-actions <github-actions@github.com>
2023-09-02 01:32:40 +02:00
github-actions 7a63d11093 📝 Update release notes 2023-09-01 21:36:46 +00:00
Sebastián Ramírez a3f1689d78 📝 Update release notes 2023-08-26 20:14:42 +02:00
Sebastián Ramírez 415eb1405a 🔖 Release version 0.103.0 2023-08-26 20:10:27 +02:00
Sebastián Ramírez bd32bca55c 📝 Update release notes 2023-08-26 20:09:59 +02:00
github-actions df16699dd8 📝 Update release notes 2023-08-26 18:03:56 +00:00
Sebastián Ramírez 1b714b3177
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
2023-08-26 20:03:13 +02:00
github-actions 5f855b1179 📝 Update release notes 2023-08-26 13:20:54 +00:00
Sebastián Ramírez 594b1ae0c3
📝 Add note to docs about Separate Input and Output Schemas with FastAPI version (#10150) 2023-08-26 15:20:04 +02:00
Sebastián Ramírez f3ab547c0c 📝 Update release notes 2023-08-25 21:23:44 +02:00
Sebastián Ramírez 9cf9e1084d 🔖 Release version 0.102.0 2023-08-25 21:18:38 +02:00
Sebastián Ramírez 859d40407c 📝 Update release notes 2023-08-25 21:18:09 +02:00
github-actions 098778e07f 📝 Update release notes 2023-08-25 19:11:02 +00:00
Sebastián Ramírez ea43f227e5
Add support for disabling the separation of input and output JSON Schemas in OpenAPI with Pydantic v2 (#10145)
* 📝 Add docs for Separate OpenAPI Schemas for Input and Output

* 🔧 Add new docs page to MkDocs config

*  Add separate_input_output_schemas parameter to FastAPI class

* 📝 Add source examples for separating OpenAPI schemas

*  Add tests for separated OpenAPI schemas

* 📝 Add source examples for Python 3.10, 3.9, and 3.7+

* 📝 Update docs for Separate OpenAPI Schemas with new multi-version examples

*  Add and update tests for different Python versions

*  Add tests for corner cases with separate_input_output_schemas

* 📝 Update tutorial to use Union instead of Optional

* 🐛 Fix type annotations

* 🐛 Fix correct import in test

* 💄 Add CSS to simulate browser windows for screenshots

*  Add playwright as a dev dependency to automate generating screenshots

* 🔨 Add Playwright scripts to generate screenshots for new docs

* 📝 Update docs, tweak text to match screenshots

* 🍱 Add screenshots for new docs
2023-08-25 21:10:22 +02:00
github-actions 10a127ea4a 📝 Update release notes 2023-08-19 19:54:40 +00:00
Sebastián Ramírez 8cd7cfc2b6
📝 Add new docs section, How To - Recipes, move docs that don't have to be read by everyone to How To (#10114)
* 📝 Start How To docs section, move Peewee, remove Peewee from dependencies

* 🚚 Move em files to new locations

* 🚚 Move and re-structure advanced docs, move relevant to How To

* 🔧 Update MkDocs config, new files in How To

* 📝 Move docs for Conditional OpenAPI for Japanese to How To

* 📝 Move example source files for Extending OpenAPI into each of the new sections

*  Update tests with new locations for source files

* 🔥 Remove init from Peewee examples
2023-08-19 21:54:04 +02:00
github-actions 3971c44a38 📝 Update release notes 2023-08-19 18:48:35 +00:00
github-actions b406dd9174 📝 Update release notes 2023-08-19 14:09:02 +00:00
Sebastián Ramírez 8e38261787
📝 Update Advanced docs, add links to sponsor courses (#10113) 2023-08-19 16:08:16 +02:00
github-actions 486cd139a9 📝 Update release notes 2023-08-19 13:51:12 +00:00
Sebastián Ramírez 08feaf0cc4
📝 Update docs for generating clients (#10112) 2023-08-19 15:49:54 +02:00
github-actions 0fe434ca68 📝 Update release notes 2023-08-19 13:34:10 +00:00
Sebastián Ramírez d1c0e5a89f
📝 Tweak MkDocs and add redirects (#10111) 2023-08-19 13:33:32 +00:00
github-actions e04953a9e0 📝 Update release notes 2023-08-19 13:12:09 +00:00
Sebastián Ramírez d4201a49bc
📝 Restructure docs for cloud providers, include links to sponsors (#10110) 2023-08-19 15:11:35 +02:00
github-actions a6ae5af7d6 📝 Update release notes 2023-08-17 08:52:40 +00:00
Sebastián Ramírez e93d15cf9a
🔧 Update sponsors, add Speakeasy (#10098) 2023-08-17 10:51:58 +02:00
Sebastián Ramírez 50b6ff7da6 📝 Update release notes 2023-08-14 12:02:43 +02:00
github-actions d46cd0b1f0 📝 Update release notes 2023-08-14 09:50:40 +00:00
github-actions dafaf6a34c 📝 Update release notes 2023-08-14 09:17:05 +00:00
github-actions 87cc40e483 📝 Update release notes 2023-08-14 09:15:26 +00:00
github-actions 014262c203 📝 Update release notes 2023-08-14 09:13:05 +00:00
github-actions 48d203a1e7 📝 Update release notes 2023-08-14 09:10:51 +00:00
github-actions 78f38c6bfd 📝 Update release notes 2023-08-10 15:59:15 +00:00
github-actions 5c2a155809 📝 Update release notes 2023-08-10 15:55:32 +00:00
github-actions 1f0d9086b3 📝 Update release notes 2023-08-10 15:53:06 +00:00
Nguyễn Khắc Thành f0ab797de4
🌐 Add Vietnamese translation for `docs/vi/docs/python-types.md` (#10047)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-08-10 17:52:25 +02:00
github-actions 82fafcc7ea 📝 Update release notes 2023-08-09 17:05:31 +00:00
Sebastián Ramírez 87398723f9
🔧 Add sponsor Porter (#10051) 2023-08-09 19:04:49 +02:00
github-actions 01383a57cb 📝 Update release notes 2023-08-09 13:27:14 +00:00
Sebastián Ramírez 14c96ef31b
🔧 Update sponsors, add Jina back as bronze sponsor (#10050) 2023-08-09 15:26:33 +02:00
github-actions 942ee69d85 📝 Update release notes 2023-08-05 08:46:58 +00:00
github-actions 6df10c9753 📝 Update release notes 2023-08-05 08:44:36 +00:00
github-actions 0f4a962c20 📝 Update release notes 2023-08-05 08:43:01 +00:00
Francis Bergin 69d5ebf34d
✏️ Fix typo in release notes (#9835) 2023-08-05 10:40:24 +02:00
github-actions bb7bbafb5f 📝 Update release notes 2023-08-05 08:38:32 +00:00
github-actions 87e126be2e 📝 Update release notes 2023-08-05 08:36:27 +00:00
Adejumo Ridwan Suleiman 33e77b6e25
📝 Add external article: Build an SMS Spam Classifier Serverless Database with FaunaDB and FastAPI (#9847) 2023-08-05 10:36:05 +02:00
github-actions 51f5497f3f 📝 Update release notes 2023-08-05 08:35:55 +00:00
Vicente Merino 0b496ea1f8
📝 Fix typo in `docs/en/docs/contributing.md` (#9878)
Co-authored-by: Vicente Merino <vmerino@rexmas.com>
2023-08-05 10:34:07 +02:00
Reza Rohani b76112f1a5
📝 Fix code highlighting in `docs/en/docs/tutorial/bigger-applications.md` (#9806)
Update bigger-applications.md
2023-08-05 10:33:08 +02:00
github-actions f2e80fae09 📝 Update release notes 2023-08-05 08:28:26 +00:00
github-actions d86a695db9 📝 Update release notes 2023-08-05 08:26:40 +00:00
github-actions abfcb59fd0 📝 Update release notes 2023-08-05 08:23:39 +00:00
github-actions 0148c9508c 📝 Update release notes 2023-08-05 08:23:14 +00:00
Sebastián Ramírez 8adbafc076 🔖 Release version 0.101.0 2023-08-04 23:00:17 +02:00
Sebastián Ramírez 4b5277744a 📝 Update release notes 2023-08-04 22:59:44 +02:00
github-actions 89a7cea561 📝 Update release notes 2023-08-04 20:58:08 +00:00
Sebastián Ramírez 944c591803 📝 Update release notes 2023-08-04 22:50:34 +02:00
github-actions 1c20514738 📝 Update release notes 2023-08-04 20:47:42 +00:00
github-actions d943e02232 📝 Update release notes 2023-08-04 18:19:22 +00:00
github-actions b3a1f91004 📝 Update release notes 2023-08-04 17:48:24 +00:00
github-actions 3af7265a43 📝 Update release notes 2023-08-03 16:00:19 +00:00
github-actions 10b4c31f06 📝 Update release notes 2023-08-03 15:47:35 +00:00
github-actions 94c48cfc8c 📝 Update release notes 2023-08-03 15:25:10 +00:00
github-actions a73cdaed35 📝 Update release notes 2023-08-03 14:25:48 +00:00
Sebastián Ramírez 3fa6cfbcc5
👥 Update FastAPI People (#9999)
Co-authored-by: github-actions <github-actions@github.com>
2023-08-03 16:25:11 +02:00
github-actions ad1d7f539e 📝 Update release notes 2023-08-03 14:13:59 +00:00