✨ Add internal GitHub action to deploy docs previews (#1739)

* 📝 Update release notes

* ✨ Add internal GitHub action to pull docs artifact

* 🙈 Add archive.zip to gitignore

🚀 Preview docs for external PRs (#1738)

* 🍱 Save docs zip when building docs

* 🙈 Add docs.zip artifact to .gitignore

* 🚀 Update deploy artifact name

* ♻️ Upload artifact directory

* ✨ Add WIP trigger docs preview

* ♻️ Update trigger docs preview

* 👷 Update env vars for docs preview

* 👷 Update PR extraction

* 👷 Try to show GitHub event

* 💚 Try to see if GitHub context templates is causing the problem

* 💚 Try to debug context GitHub event

* 🔊 Debug GitHub event context

* 👷 Update debugging action

* 👷 Update debug

* 👷 Update Action

* ♻️ Update script to trigger docs preview

* ⚡️ Try to use Zip again to improve speed

* 🔧 Update zip scripts

* ✨ Add preview docs on event

* 🚀 Trigger deploy preview on PRs

* 🐛 Fix trigger script env vars

📝 Update release notes

✅ Add XML coverage report for GitHub Actions (#1737)

📝 Update release notes

💄 Update badges, remove Travis (#1736)

* 💄 Update badges

* 🔥 Remove Travis

📝 Update release notes

👷 Add GitHub Actions, move from Travis (#1735)

📝 Update release notes

✨ Add support for adding OpenAPI schema for GET requests with a body (#1626)

* add test for get request body's openapi schema

* 📝 Update docs note for GET requests with body

* ✅ Update test for GET request with body, test it receives the body

* 🔇 Temporary type ignore while it's handled in Pydantic

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

🔖 Release version 0.59.0

📝 Update release notes

✏ Fix docstring typo for oauth2 utils (#1621)

📝 Update release notes

📝 Update JWT docs to use python-jose (#1610)

* 📝 Update JWT docs with python-jose

* 📝 Update format and use python-jose in docs

* ➕ Add Python-jose to dependencies

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

🐛 Re-enable search bar after adding markdown-data plugin (#1703)

📝 Update release notes

✨ Auto-generate OpenAPI servers from root_path (#1596)

* root_path included in servers object instead of path prefix

* ♻️ Refactor implementation of auto-including root_path in OpenAPI servers

* 📝 Update docs and examples for Behind a Proxy, including servers

* 📝 Update Extending OpenAPI as openapi_prefix is no longer needed

* ✅ Add extra tests for root_path in servers and root_path_in_servers=False

* 🍱 Update security docs images with relative token URL

* 📝 Update security docs with relative token URL

* 📝 Update example sources with relative token URLs

* ✅ Update tests with relative tokens

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

✏️ Fix external links typo/link (#1702)

📝 Update release notes

✨ External links in docs with data file (#1701)

* ➕ Add mkdocs-markdownextradata-plugin for docs

* 🔧 Update MkDocs config file(s) to include external data

* ✨ Add external links data file

* 📝 Use external data file in External Links

* ♻️ Update data files for langs

The cost is some duplication 😔, these files are updated by the script, but to be able to serve locally they have to be duplicated

* ✨ Update docs script to copy data files

* 🔥 Remove needed duplication of data files for live docs in translations

📝 Update release notes

📝 Fix link to edit External Links, add additional link (#1669)

Added a link to the correct link to editing the en docs, plus an additional example (of mine!) which got some buzz on social media:
https://twitter.com/monodavide/status/1276913357388382212
https://madewithml.com/projects/1649/model-serving-using-fastapi-and-streamlit/

📝 Update release notes

📝 Add note in docs on order in Pydantic Unions (#1591)

* Add note on order in Unions

* Add an example of Union order

Co-authored-by: kbanc <katherine.bancoft@gmail.com>

📝 Update release notes

✔ Improve support for tests in editor (#1699)

* ♻️ Remove required extra steps to test in editor

* 🎨 Format lint script

* 📝 Remove obsolete extra steps required to test in editor from docs

* 🐛 Fix coverage

📝 Update release notes

📌 Pin dependencies (#1697)

* 📌 Pin dependencies

* 🐛 Fix config in pyproject.toml

📝 Update release notes

⬆ Upgrade isort to version 5.x.x (#1670)

* Update isort script to match changes in the new release, isort v5.0.2

* Downgrade isort to version v4.3.21

* Add an alternative flag to --recursive in isort v5.0.2

* Add isort config file

* 🚚 Import from docs_src for tests

* 🎨 Format dependencies.utils

* 🎨 Remove isort combine_as_imports, keep black profile

* 🔧 Update isort config, use pyproject.toml, Black profile

* 🔧 Update format scripts to use explicit directories to format

otherwise it would try to format venv env directories, I have several with different Python versions

* 🎨 Format NoSQL tutorial after re-sorting imports

* 🎨 Fix format for __init__.py

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

🔖 Release version 0.58.1

📝 Update release notes

🎨 Add format, finishing period

📝 Add link to all valid pydantic data types (#1612)

📝 Update release notes

🐛 Fix link in warning logs (#1611)

Co-authored-by: Dmytro Petruk <petruk@ebu.ch>

📝 Update release notes

📝 Fix bad link in docs (#1603)

Co-authored-by: lookyun <lookyun0504@outlook.com>

📝 Update release notes

🙈 Add vim temporary files to gitignore (#1590)

Co-authored-by: asheux <brianashiundu000@gmail.com>

📝 Update release notes

✏ Fix typo in sub-applications (#1578)

📝 Update release notes

📝 Use Optional in docs (#1644)

* Updated .py files with Optional tag (up to body_nested_models)

* Update optionals

* docs_src/ all updates, few I was unsure of

* Updated markdown files with Optional param

* es: Add Optional typing to index.md

* Last of markdown files updated with Optional param

* Update highlight lines

* it: Add Optional typings

* README.md: Update with Optional typings

* Update more highlight increments

* Update highlights

* schema-extra-example.md: Update highlights

* updating highlighting on website to reflect .py changes

* Update highlighting for query-params & response-directly

* Address PR comments

* Get rid of unnecessary comment

* ⏪ Revert Optional in Chinese docs as it probably also requires changes in text

* 🎨 Apply format

* ⏪ Revert modified example

* ♻️ Simplify example in docs

* 📝 Update OpenAPI callback example to use Optional

* ✨ Add Optional types to tests

* 📝 Update docs about query params, default to using Optional

* 🎨 Update code examples line highlighting

* 📝 Update nested models docs to use "type parameters" instead of "subtypes"

* 📝 Add notes about FastAPI usage of None

including:

= None

and

= Query(None)

and clarify relationship with Optional[str]

* 📝 Add note about response_model_by_alias

* ♻️ Simplify query param list example

* 🔥 Remove test for removed example

* ✅ Update test for updated example

Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com>
Co-authored-by: yk396 <yk396@cornell.edu>
Co-authored-by: Kai Chen <kaichen120@gmail.com>

📝 Update release notes

✅ Update response_model_by_alias (#1642)

* Make openapi models honor response_model_by_alias

* Add test for response_model_by_alias working with openapi models

* ⏪ Revert changes

* ✅ Update and extend tests for response_model_by_alias

* ⏪ Revert test name change

* 📌 Pin Pytest and Pytest-Cov

Co-authored-by: Martin Zaťko <martin.zatko@kiwi.com>

📝 Update release notes

📝 Update release notes

📝 Update release notes

🌐 Add chinese translation for body-fields.md (#1569)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

🌐 Update Chinese translation for index.md (#1564)

* keep up-to-date with main version

* fix 2 ignored quotes

🌐 Add Chinese translation for body-multiple-params.md (#1532)

* add chinese translation for body-multiple-params.md

* improve translations

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

✨ Add Chinese translation for path-params-numeric-validations.md (#1506)

* add chinese translation for path-params-numeric-validations.md

* improve translations

📝 Update release notes

✨ Add GitHub action to label approved PRs (#1638)

🔖 Release version 0.58.0

📝 Update release notes

✨ Deep merge OpenAPI responses (#1577)

* override successful response

* ✨ Add deep_dict_udpate

* ✨ Merge additional responses with generated responses

* 🍱 Update docs screenshot

Co-authored-by: rkbeatss <rkaus053@uottawa.ca>

📝 Update release notes

📝 Mention in docs that subapps don't fire events (#1554)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

🐛 Fix body validation error response, remove variable name when it is not embedded  (#1553)

📝 Update release notes

📝 Update release notes

🐛 Fix testing security scopes when using dependency overrides (#1549)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

🐛 Fix JSON Schema "not" keyword (#1548)

📝 Update release notes

✨ Add support for OpenAPI servers metadata (#1547)

* feat: add servers option for OpenAPI

Closes #872

* ✨ Use dicts for OpenAPI servers

* ♻️ Update OpenAPI Server model to support relative URLs

* ✅ Add tests for OpenAPI servers

* ♻️ Re-order parameter location of servers for OpenAPI

* 🎨 Format code

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

🔖 Release version 0.57.0

📝 Update release notes

🔥 Remove broken external link (#1565)

📝 Update release notes

📝 Update release notes

📝 Update tutorial for WebSockets with dependencies (#1540)

* fix websockets/tutorial002.py

* fix tutorial002 in ws to correspond with test case

* reformat websocket tutorial002

* fix websocket tutorial002 coverage

* 📝 Update example for WebSockets with Depends

* ✅ Update and refactor tests for WebSockets with dependencies

* 👷 Trigger Travis, as it's not reporting to Codecov

* ✅ Update WebSocket tests to raise coverage

Co-authored-by: Chih Sean Hsu <Sean@Sean-Mac.local>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

✨ Add support for Python's http.HTTPStatus in status_code (#1534)

* Normalise IntEnums to ints for route status codes

Closes #1349

* add tests for status code enum support

* add docs for status code enum support

* add endpoint test for enum status code

* 📝 Update note about http.HTTPStatus

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

📝 Update release notes

✨ When using Pydantic models with __root__ use the internal value in jsonable_encoder (#1524)

📝 Updated docs for path-params (#1521)

* Added response example; URL for quick access; typo fixes

* Added line breaks for readability

* Fix typo on redoc url

* 📝 Update format, links, rewordings

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

📝 Update docs for first-steps, links, rewordings (#1518)

* :pencil2: Typo/readability fixes for first-steps documentation

* 📝 Update link and small rewordings

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

✨ Enable showCommonExtensions and showExtensions in SwaggerUI (#1466)

* Set showExtensions and showCommonExtensions to true

* Clean up comma

Co-authored-by: tiewkeehui <keehuitiew@airasia.com>

📝 Update release notes

✨ Export OAuth2PasswordRequestFormStrict from security (#1462)

* Update __init__.py

Fixes an import error:

from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestFormStrict
ImportError: cannot import name 'OAuth2PasswordRequestFormStrict'

* Simplify import of OAuth2PasswordRequestFormStrict

* Simplify import of OAuth2PasswordRequestFormStrict

📝 Update release notes

📝 Add docs for `default_response_class` (#1455)

* :heavy_plus_sign: Add docs to default_response_class

* :white_check_mark: create a tip

* ✅ fixing the tip

* :ambulance: grammar

* 📝 Update docs for default response class

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

📝 Document additional parameters for response_model (#1427)

* Documented additional parameters

These are included in a recent PR (https://github.com/tiangolo/fastapi/pull/1166) but not in the docs yet.
* response_model_exclude_none
* response_model_exclude_defaults

* 📝 Update note about response_model_exclude_defaults and response_model_exclude_none

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

📝 Add PyCharm Pydantic plugin to docs (#1420)

* add pydantic pycharm plugin in document

* 📝 Update PyCharm Pydantic plugin note

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

📝 Update release notes

🎨 Update and clarify testing function name (#1395)

test_create_existing_token -> test_create_existing_item

📝 Update release notes

🐛 Fix duplicated headers set by indirect dependencies (#1386)

* Added test for repeating cookies in response headers

* update `response` headers, status code to match `sub_response` in `solve_dependencies` only if necessary; fix formatting of scottsmith2gmail's test

* restore code coverage, remove dead code from `solve_dependencies`

Co-authored-by: Scott Smith <scott.smith.2@gmail.com>

📝 Update release notes