Commit Graph

3630 Commits

Author SHA1 Message Date
github-actions 1dd2bc7675 📝 Update release notes 2020-10-18 06:03:03 +00:00
github-actions 6ab0f89858 📝 Update release notes 2020-10-18 05:57:45 +00:00
github-actions 9c00618710 📝 Update release notes 2020-10-18 05:48:25 +00:00
github-actions ae580deaea 📝 Update release notes 2020-10-18 05:38:53 +00:00
github-actions 8a1ebb38e2 📝 Update release notes 2020-10-18 05:30:50 +00:00
github-actions 7434d2bec7 📝 Update release notes 2020-10-18 05:26:55 +00:00
github-actions cb55d7cdde 📝 Update release notes 2020-10-17 18:44:24 +00:00
github-actions a5ee4d93d2 📝 Update release notes 2020-10-17 13:56:21 +00:00
github-actions d1dfc812f1 📝 Update release notes 2020-10-17 13:46:12 +00:00
github-actions 5a776fbff5 📝 Update release notes 2020-10-17 13:40:03 +00:00
github-actions 642762564d 📝 Update release notes 2020-10-17 10:43:35 +00:00
github-actions 48bf243050 📝 Update release notes 2020-10-17 06:43:16 +00:00
github-actions afac22dfd2 📝 Update release notes 2020-10-17 06:39:20 +00:00
github-actions aa62d9212f 📝 Update release notes 2020-10-17 06:32:39 +00:00
github-actions b56cf6c08f 📝 Update release notes 2020-10-17 06:24:33 +00:00
github-actions 23772f3c49 📝 Update release notes 2020-10-17 06:15:44 +00:00
github-actions 3d767008df 📝 Update release notes 2020-10-17 06:09:43 +00:00
github-actions 25e1a2602d 📝 Update release notes 2020-10-17 06:03:36 +00:00
github-actions db91255ede 📝 Update release notes 2020-10-17 05:51:31 +00:00
github-actions 4924d08e7e 📝 Update release notes 2020-10-16 20:35:50 +00:00
github-actions 030f1f2ae2 📝 Update release notes 2020-10-16 20:09:35 +00:00
github-actions a4f88f74f2 📝 Update release notes 2020-10-16 20:04:38 +00:00
Sebastián Ramírez 636f06cd6b 📝 Update release notes 2020-10-15 07:26:26 +02:00
hard_coder c8365bd339
🌐 Initialize new language Korean for translations (#2018) 2020-10-15 07:21:41 +02:00
Sebastián Ramírez df38e53723 📝 Update release notes 2020-10-11 17:04:21 +02:00
github-actions f59f85d755 📝 Update release notes 2020-10-11 10:41:42 +00:00
Sebastián Ramírez e96b002599 📝 Update release notes 2020-10-11 12:06:07 +02:00
github-actions 75b83ce3aa 📝 Update release notes 2020-10-11 10:04:35 +00:00
Sebastián Ramírez 026039cae2 📝 Update release notes 2020-10-11 11:51:49 +02:00
Sebastián Ramírez e2609dff95
👷 Add GitHub Action Latest Changes (#2160) 2020-10-11 11:50:04 +02:00
Sebastián Ramírez e77ea63577 🔖 Release version 0.61.1 2020-08-29 16:30:50 +02:00
Sebastián Ramírez 097df92c1c 📝 Update release notes 2020-08-29 16:06:32 +02:00
Brock Friedrich be669059fb
🎨 Simplify docs hl_lines ranges and standardize 2 spaces between each range (#1863) 2020-08-29 16:02:58 +02:00
Sebastián Ramírez dfdd371c52 📝 Update release notes 2020-08-29 15:38:44 +02:00
ryuckel e1e8627168
🌐 Add Japanese translation for index.md (#1571) 2020-08-29 15:34:08 +02:00
Sebastián Ramírez 0916c1c3ef 📝 Update release notes 2020-08-29 14:32:08 +02:00
Facundo Maero 11656f7bd5
✏ Fix typo in nosql-databases.md (#1980)
Co-authored-by: Facundo Maero <facundo.maero@deepvisionai.com>
2020-08-29 14:30:23 +02:00
Sebastián Ramírez 483d092af8 📝 Update release notes 2020-08-29 14:29:00 +02:00
JulianMaurin 60aa63b68a
🌐 Initialize translations for French (#1975)
Co-authored-by: JulianMaurin <julian.maurin.perso@pm.me>
2020-08-29 14:27:34 +02:00
Sebastián Ramírez eb547bd4fd 📝 Update release notes 2020-08-29 14:24:24 +02:00
Sebastián Ramírez 2d7038e03e 📝 Update release notes 2020-08-29 11:47:13 +02:00
Yağızcan Değirmenci 4f0a3a9e4d
🌐 Initialize Turkish translations (#1905) 2020-08-29 11:43:29 +02:00
Sebastián Ramírez a6897963d5 🔖 Release version 0.61.0 2020-08-09 22:36:47 +02:00
Sebastián Ramírez c14803e3fa 📝 Update release notes 2020-08-09 22:34:50 +02:00
Sebastián Ramírez 64ca596a11 📝 Update release notes 2020-08-09 22:19:46 +02:00
Sebastián Ramírez 3390182fc9 📝 Update release notes 2020-08-09 17:04:35 +02:00
Sebastián Ramírez 912a43ee3d
📝 Add link to TestDriven.io course in docs (#1860) 2020-08-09 17:02:51 +02:00
Sebastián Ramírez 4020304945 📝 Update release notes 2020-08-09 16:43:07 +02:00
Elliana May 0a2fc78fea
✏️ Update docs to remove gender-specific references (#1824)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-09 16:35:44 +02:00
Sebastián Ramírez b91acfb457 📝 Update release notes 2020-08-09 15:58:58 +02:00
Rupsi Kaushik 5ed48ccdc8
Export WebSocketDisconnect and add example handling disconnections to docs (#1822)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-09 15:52:19 +02:00
Sebastián Ramírez f32d67c8b9 📝 Update release notes 2020-08-09 13:12:09 +02:00
Sebastián Ramírez be855c696b 📝 Update release notes 2020-08-09 12:56:09 +02:00
Sebastián Ramírez 4daa6ef4e4 📝 Update release notes 2020-08-09 11:08:29 +02:00
Sebastián Ramírez 79e08a2541 🔖 Release version 0.60.2 2020-08-08 20:23:16 +02:00
Sebastián Ramírez 1c9c80ba93 📝 Update release notes 2020-08-08 20:21:03 +02:00
Yağızcan Değirmenci 25cb05c876
✏ Fix documentation typo in Query Parameters and String Validations (#1832) 2020-08-08 20:19:14 +02:00
Sebastián Ramírez 694fbab074 📝 Update release notes 2020-08-08 20:07:03 +02:00
Felix Böhm 2fd28434dd
📝 Add documentation about async tests (pytest-asyncio and httpx) (#1619)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-08 20:01:18 +02:00
Sebastián Ramírez d15556b152 📝 Update release notes 2020-08-08 09:20:37 +02:00
Sebastián Ramírez 52f0f8657e 📝 Update release notes 2020-08-03 19:28:49 +02:00
Sebastián Ramírez 117f9e4abe 📝 Update release notes 2020-08-03 18:38:27 +02:00
s2s 604fea9fc1
📝 Add link in sql-databases.md tutorial to async-sql-databases.md in advanced section. (#1813)
* Add link in sql-databases.md tutorial section to async-sql-databases.md in advanced section.

* 🎨 Update note format

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-03 18:37:02 +02:00
Sebastián Ramírez 994bfd4591 📝 Update release notes 2020-08-03 18:27:03 +02:00
Eduard Iskandarov 02722923b1
✏ Fix documentation typo in behind a proxy tutorial (#1807) 2020-08-03 18:25:01 +02:00
Sebastián Ramírez d63a93429b 📝 Update release notes 2020-08-03 18:14:15 +02:00
Sebastián Ramírez 95a29b6e67 📝 Update release notes 2020-08-03 18:05:05 +02:00
Sebastián Ramírez 272f01a153
🌐 Add Ukrainian language setup, without index translation (#1830) 2020-08-03 18:04:05 +02:00
Sebastián Ramírez 1a345ae7fc 📝 Update release notes 2020-08-03 17:41:50 +02:00
Marcelo Trylesinski c5c138b8eb
📝 Update external links (#1786)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-03 17:39:48 +02:00
Sebastián Ramírez da20e33414 📝 Update release notes 2020-08-03 17:26:12 +02:00
Sebastián Ramírez f63cec9c95 📝 Update release notes 2020-08-03 15:32:03 +02:00
Sebastián Ramírez 78680e5bee 📝 Update relase notes 2020-08-03 15:19:33 +02:00
Sebastián Ramírez 72645dfeab 📝 Update release notes 2020-08-03 14:30:25 +02:00
Sebastián Ramírez 1afa4e8e75 📝 Update release notes 2020-08-03 13:50:22 +02:00
नवुले पवन कुमार राव 6fd3736da2
📝 Add article: Deploy FastAPI on Azure App Service (#1726) 2020-08-03 13:48:30 +02:00
Sebastián Ramírez 7e043e5e6f 📝 Update release notes 2020-08-03 10:46:33 +02:00
Smart d1585c42b9
📝 Add external link to starlette docs for WebSocket testing (#1717)
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-03 10:45:22 +02:00
Sebastián Ramírez fc494e3527 📝 Update release notes 2020-08-03 10:34:05 +02:00
Sebastián Ramírez 38b71a9298 📝 Update release notes 2020-08-03 09:55:21 +02:00
Francesco Frassinelli 769ee73240
📝 Add HTML media type to template docs (#1690)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-03 09:53:56 +02:00
Sebastián Ramírez 1df2f14c64 📝 Update release notes 2020-08-03 09:28:03 +02:00
Nils Lindemann eab9a0e139
✏ Fix typos and rewording in docs for security (#1678)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-03 09:27:02 +02:00
Sebastián Ramírez b86ac6739a 📝 Update release notes 2020-08-03 09:13:17 +02:00
Nils Lindemann 9840d9e59d
✏ Fix typos in docs for dependencies (#1675)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-08-03 09:12:07 +02:00
Sebastián Ramírez 0ec52157df 📝 Update release notes 2020-08-03 08:46:50 +02:00
Sebastián Ramírez 306ec8de04 📝 Update release notes 2020-08-03 08:35:05 +02:00
Sebastián Ramírez 6264709054 📝 Update release notes 2020-08-03 08:11:00 +02:00
Sebastián Ramírez a63b1efc29 📝 Update release notes 2020-07-22 10:29:49 +02:00
Sebastián Ramírez 6fb97f44cf 📝 Update release notes 2020-07-22 08:47:48 +02:00
Sebastián Ramírez f64c448329 🔖 Release version 0.60.1 2020-07-22 08:44:44 +02:00
Sebastián Ramírez df6cbc5ec6 📝 Update release notes 2020-07-22 08:44:13 +02:00
Sebastián Ramírez 6c9dca55bc 📝 Update release notes 2020-07-22 08:32:22 +02:00
Adrien Cacciaguerra d71e807401
💄 Use OS preference theme for docs (#1760) 2020-07-22 08:30:12 +02:00
Sebastián Ramírez 7df9ddfe4e 📝 Update release notes 2020-07-22 08:28:31 +02:00
Sebastián Ramírez 2940a7fdfa 📝 Update release notes 2020-07-22 08:23:36 +02:00
Sebastián Ramírez c5a21354af 📝 Update release notes 2020-07-21 23:10:52 +02:00
Sebastián Ramírez 8bafe2a482
🚀 GitHub Actions update, use commit from PR, not pre-merge (#1761)
* 🔥 Remove deploy badge that won't show correctly until next release

after the fixes to the Gitter bot

* 🐛 Fix GitHub Action to upload docs artifacts with commit from PR, not pre-merge

* ♻️ Run zip docs and artifact upload only on PRs
2020-07-21 23:08:14 +02:00
Sebastián Ramírez 42f1716b48 📝 Update release notes 2020-07-20 18:57:01 +02:00
Sebastián Ramírez 0f54657377 🔖 Release version 0.60.0 2020-07-20 18:26:56 +02:00
Sebastián Ramírez 79e5b36551
📝 Update release notes (#1745)
* 📝 Update release notes

* 📝 Update release notes
2020-07-20 18:22:29 +02:00
Sebastián Ramírez 7032dfb4f1
Add GitHub Action to watch for missing preview docs (#1740)
* 📝 Update release notes

* 🔊 Make curl verbose when triggering docs preview

* 🔧 Update GitHub Actions circus to use commit hash

*  Add PR docs preview watcher
2020-07-20 16:33:17 +02:00
Sebastián Ramírez b268c39758
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
2020-07-19 22:11:28 +02:00
Sebastián Ramírez b7251f1654 📝 Update release notes 2020-07-19 14:25:28 +02:00
Sebastián Ramírez cc8cac200f 📝 Update release notes 2020-07-19 14:10:51 +02:00
Sebastián Ramírez e7be5c8ac5
💄 Update badges, remove Travis (#1736)
* 💄 Update badges

* 🔥 Remove Travis
2020-07-19 14:09:55 +02:00
Sebastián Ramírez 8f52864899 📝 Update release notes 2020-07-19 14:04:45 +02:00
Sebastián Ramírez 10ae6de111 📝 Update release notes 2020-07-19 12:19:39 +02:00
JAYATI SHRIVASTAVA 2b47f3e56b
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>
2020-07-19 12:17:50 +02:00
Sebastián Ramírez d60dd1b60e 🔖 Release version 0.59.0 2020-07-10 20:41:35 +02:00
Sebastián Ramírez 2822f7ca64 📝 Update release notes 2020-07-10 20:32:16 +02:00
Sebastián Ramírez 74852d406c 📝 Update release notes 2020-07-10 20:26:29 +02:00
Brian Mboya 921642dc7b
📝 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>
2020-07-10 20:24:38 +02:00
Sebastián Ramírez 5c01d44ee9 📝 Update release notes 2020-07-10 19:46:36 +02:00
Sebastián Ramírez 135704dcc8
🐛 Re-enable search bar after adding markdown-data plugin (#1703) 2020-07-10 19:45:47 +02:00
Sebastián Ramírez 88793bb6c2 📝 Update release notes 2020-07-10 19:34:22 +02:00
Rupsi Kaushik 70a51b3aff
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>
2020-07-10 19:28:18 +02:00
Sebastián Ramírez 340a582be7 📝 Update release notes 2020-07-10 14:48:42 +02:00
Sebastián Ramírez 5f66b5466f
✏️ Fix external links typo/link (#1702) 2020-07-10 14:47:56 +02:00
Sebastián Ramírez d2169ee567 📝 Update release notes 2020-07-10 14:35:28 +02:00
Sebastián Ramírez a5c03ba1b7
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
2020-07-10 14:31:44 +02:00
Sebastián Ramírez e4ea6426dc 📝 Update release notes 2020-07-10 12:24:03 +02:00
Davide Fiocco 8bf7cd1dc6
📝 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/
2020-07-10 12:21:46 +02:00
Sebastián Ramírez 92feb3ade7 📝 Update release notes 2020-07-10 11:18:28 +02:00
Katherine Bancroft d0e739d8f2
📝 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>
2020-07-10 11:16:46 +02:00
Sebastián Ramírez 4efa6bd75e 📝 Update release notes 2020-07-10 11:09:43 +02:00
Sebastián Ramírez 600f15faa0
✔ 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
2020-07-10 11:08:19 +02:00
Sebastián Ramírez 250fa519f9 📝 Update release notes 2020-07-10 00:16:35 +02:00
Sebastián Ramírez 8447000eee 📝 Update release notes 2020-07-09 20:09:38 +02:00
Brian Mboya fe453f80ed
⬆ 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>
2020-07-09 20:06:12 +02:00
Sebastián Ramírez 3ff504f03f 🔖 Release version 0.58.1 2020-06-28 23:48:30 +02:00
Sebastián Ramírez eea9ab6106 📝 Update release notes 2020-06-28 23:43:30 +02:00
Sebastián Ramírez e9e07c41bb 🎨 Add format, finishing period 2020-06-28 23:42:32 +02:00
Eyitayo Ogunbiyi 17a5e18f46
📝 Add link to all valid pydantic data types (#1612) 2020-06-28 23:40:45 +02:00
Sebastián Ramírez 9148bd8b6f 📝 Update release notes 2020-06-28 23:38:49 +02:00
Sebastián Ramírez 2d9bca56b2 📝 Update release notes 2020-06-28 23:35:21 +02:00
molto f158d95ce9
📝 Fix bad link in docs (#1603)
Co-authored-by: lookyun <lookyun0504@outlook.com>
2020-06-28 23:34:28 +02:00
Sebastián Ramírez 7a4164ef60 📝 Update release notes 2020-06-28 23:30:22 +02:00
Sebastián Ramírez 42eff23a79 📝 Update release notes 2020-06-28 23:27:40 +02:00
Andreas Schlapbach 25bc33350d
✏ Fix typo in sub-applications (#1578) 2020-06-28 23:26:35 +02:00
Sebastián Ramírez b84d082005 📝 Update release notes 2020-06-28 20:21:38 +02:00
Sebastián Ramírez 1f01ce9615
📝 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>
2020-06-28 20:13:30 +02:00
Sebastián Ramírez 352c5f5ecc 📝 Update release notes 2020-06-28 13:59:20 +02:00
Sebastián Ramírez 50926faead 📝 Update release notes 2020-06-27 20:32:34 +02:00
Sebastián Ramírez a303afc0e5 📝 Update release notes 2020-06-27 20:32:34 +02:00
Sebastián Ramírez 12607e85e3 📝 Update release notes 2020-06-27 20:32:34 +02:00
Sebastián Ramírez be472c5215 📝 Update release notes 2020-06-27 20:13:07 +02:00
Sebastián Ramírez c8b634226e 📝 Update release notes 2020-06-27 20:00:21 +02:00
Sebastián Ramírez b87072bc12 🔖 Release version 0.58.0 2020-06-15 13:18:36 +02:00
Sebastián Ramírez 04e2bfafbc 📝 Update release notes 2020-06-15 13:13:53 +02:00
Sebastián Ramírez 181a32236a
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>
2020-06-15 13:12:12 +02:00
Sebastián Ramírez 1f54a8e0a1 📝 Update release notes 2020-06-15 12:42:48 +02:00
Andrew d63475bb7d
📝 Mention in docs that subapps don't fire events (#1554)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-14 18:25:10 +02:00
Sebastián Ramírez 5a3c5f1523 📝 Update release notes 2020-06-14 18:12:51 +02:00
Andrew 12bc9285f7
🐛 Fix body validation error response, remove variable name when it is not embedded (#1553) 2020-06-14 18:07:39 +02:00
Sebastián Ramírez 31df2ea940 📝 Update release notes 2020-06-14 17:56:12 +02:00
Sebastián Ramírez 50b90dd6a4 📝 Update release notes 2020-06-14 17:55:13 +02:00
Sebastián Ramírez ef460b4d23 📝 Update release notes 2020-06-14 15:40:18 +02:00
Sebastián Ramírez 34c857b7cb 🔖 Release version 0.57.0 2020-06-13 23:13:25 +02:00
Sebastián Ramírez c78bc0c82d 📝 Update release notes 2020-06-13 23:08:20 +02:00
JAYATI SHRIVASTAVA 194446e51a
🔥 Remove broken external link (#1565) 2020-06-13 23:07:11 +02:00
Sebastián Ramírez 777e2151e6 📝 Update release notes 2020-06-13 22:55:30 +02:00
Sebastián Ramírez 5ce5bdba0b 📝 Update release notes 2020-06-13 22:52:59 +02:00
Chih Sean Hsu e4300769ac
📝 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>
2020-06-13 22:51:34 +02:00
retnikt c6dd627bdd
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>
2020-06-13 19:40:10 +02:00
Sebastián Ramírez 6576f724bb 📝 Update release notes 2020-06-13 19:22:08 +02:00
Sebastián Ramírez 91a6736d0e 📝 Update release notes 2020-06-13 19:20:48 +02:00
Yankee 748bedd37c
📝 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>
2020-06-13 19:14:23 +02:00
Sebastián Ramírez bf58788f29 📝 Update release notes 2020-06-13 18:54:47 +02:00
Yankee 5f78ba4a31
📝 Update docs for first-steps, links, rewordings (#1518)
* ✏️ Typo/readability fixes for first-steps documentation

* 📝 Update link and small rewordings

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-13 18:53:31 +02:00
Sebastián Ramírez db9f827263 📝 Update release notes 2020-06-13 18:18:27 +02:00
Sebastián Ramírez e482d74241 📝 Update release notes 2020-06-13 18:13:06 +02:00
Sebastián Ramírez f913d469a8 📝 Update release notes 2020-06-13 18:05:22 +02:00
Roman Tezikov 66cb266641
📝 Add docs for `default_response_class` (#1455)
*  Add docs to default_response_class

*  create a tip

*  fixing the tip

* 🚑 grammar

* 📝 Update docs for default response class

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-13 18:02:45 +02:00
Sebastián Ramírez 74954894c5 📝 Update release notes 2020-06-13 15:26:42 +02:00
William Hayes ceedfccde0
📝 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>
2020-06-13 15:23:29 +02:00
Sebastián Ramírez 2ee0eedf23 📝 Update release notes 2020-06-13 15:08:10 +02:00
Koudai Aono c0f3019764
📝 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>
2020-06-13 15:05:59 +02:00
Sebastián Ramírez dd6d0cb23c 📝 Update release notes 2020-06-13 14:51:21 +02:00
Sebastián Ramírez 6af857f206 📝 Update release notes 2020-06-13 14:47:03 +02:00
Sebastián Ramírez c0b1fddb31 📝 Update release notes 2020-06-13 14:39:58 +02:00
Sebastián Ramírez fddd1c12de 📝 Update release notes 2020-06-13 14:36:27 +02:00
Sebastián Ramírez 5ffa18f10f 📝 Update release notes 2020-06-13 14:06:12 +02:00
Sebastián Ramírez 828915baf5 📝 Update Tags metadata title 2020-06-13 14:02:58 +02:00
Thomas Maschler a071ddf3cd
Add support for tag metadata in OpenAPI (#1348)
* Allow to add OpenAPI tag descriptions

* fix type hint

* fix type hint 2

* refactor test to assure 100% coverage

* 📝 Update tags metadata example

* 📝 Update docs for tags metadata

*  Move tags metadata test to tutorial subdir

* 🎨 Update format in applications

* 🍱 Update docs UI image based on new example

* 🎨 Apply formatting after solving conflicts

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-13 13:58:06 +02:00
Sebastián Ramírez 3651b8a30f 📝 Update release notes 2020-06-13 12:27:00 +02:00
Sebastián Ramírez 0d73b9ff1c
🔧 Add basic setup for Russian translations (#1566) 2020-06-13 12:26:15 +02:00
Sebastián Ramírez 43235cf236 📝 Update release notes 2020-06-13 09:47:36 +02:00
Xie Wei 269a155583
🔥 Remove obsolete Chinese articles after translations (#1510) 2020-06-13 09:45:48 +02:00
Sebastián Ramírez 12433d51dd 📝 Update release notes 2020-06-13 01:25:29 +02:00
Sebastián Ramírez 8231fbede4 🔖 Release version 0.56.1 2020-06-13 01:17:06 +02:00
Sebastián Ramírez 50bc14b835 📝 Update release notes 2020-06-13 01:14:58 +02:00
Kai Chen 4310c89c83
📝 Add link to Advanced User Guide: response status code (#1512) 2020-06-13 01:12:59 +02:00
Sebastián Ramírez d39dd06a22 📝 Update release notes 2020-06-13 00:57:34 +02:00
Sebastián Ramírez 5cbcb9a965 📝 Update release notes 2020-06-13 00:55:30 +02:00
Sebastián Ramírez c7334ae9f8 📝 Update release notes 2020-06-13 00:50:22 +02:00
Sebastián Ramírez d2d72a8e4a 📝 Update release notes 2020-06-13 00:43:07 +02:00
Sebastián Ramírez 5f6a14c413 📝 Update release notes 2020-06-13 00:29:43 +02:00
Sebastián Ramírez 11723bca27 📝 Update release notes 2020-06-13 00:21:53 +02:00
Sebastián Ramírez f910e0c96c 📝 Update release notes 2020-06-13 00:18:20 +02:00
Sebastián Ramírez 28396173c7 📝 Update release notes 2020-06-13 00:09:41 +02:00
Kabir Khan 69974b792e
📝 Add cookiecutter-spacy-fastapi to docs (#1390) 2020-06-13 00:06:53 +02:00
Sebastián Ramírez 352412a3cb 📝 Update release notes 2020-06-12 23:46:05 +02:00
yaegassy 745ab48d65
📝 Add docs in Python Types for Optional (#1377)
* docs: Fix pydantic example in python-types.md

* 📝 Update Python Types Intro to include Optional

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-12 23:44:23 +02:00
Sebastián Ramírez 4a5cda0d77 📝 Update release notes 2020-06-12 23:00:09 +02:00
Sebastián Ramírez a552cbdf59 📝 Update release notes 2020-06-12 22:47:37 +02:00
Sebastián Ramírez 807522c616 📝 Update release notes 2020-06-12 22:42:40 +02:00
Sebastián Ramírez 7efc15aeef 📝 Update release notes 2020-06-12 22:37:34 +02:00
Sebastián Ramírez 5a00467951 📝 Update release notes 2020-06-12 22:01:22 +02:00
Sebastián Ramírez 535247ffc4 📝 Update release notes 2020-06-12 21:43:17 +02:00
Pankaj Giri 7e2518350a
📝 Remove *, from functions where it's not needed #1234 (#1239)
* Fix for - [FEATURE] Remove *, where it's not needed #1234

* 🔥 Remove unnecessary arg *,

* 🎨 Update docs format highlight lines

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-12 21:41:44 +02:00
Sebastián Ramírez 1b2a7546af 📝 Update release notes 2020-06-12 18:58:15 +02:00
Cesare De Cal 2d9bb64047
🌐 Generated new translation directory to support Italian docs (#1557)
* Generated new translation directory to support Italian docs

* ⬆️ Upgrade/pin pytest to >= 5.4.3

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-12 18:53:52 +02:00
Sebastián Ramírez 072c2bc7f9 🔖 Release version 0.56.0 2020-06-12 00:22:17 +02:00
Sebastián Ramírez da7826b0eb 📝 Update release notes 2020-06-12 00:05:17 +02:00
Ingmar Steen 2f478eeca6
Add support for ASGI root_path for openapi docs (#1199)
* Use ASGI root_path when it is provided and openapi_prefix is empty.

* Strip trailing slashes from root_path.

* Please mypy.

* Fix extending openapi test.

* 📝 Add docs and tutorial for using root_path behind a proxy

* ♻️ Refactor application root_path logic, use root_path, deprecate openapi_prefix

*  Add tests for Behind a Proxy with root_path

* ♻️ Refactor test

* 📝 Update/add docs for Sub-applications and Behind a Proxy

* 📝 Update Extending OpenAPI with openapi_prefix parameter

*  Add test for deprecated openapi_prefix

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-11 23:53:19 +02:00
Sebastián Ramírez 543ef7753a 📝 Update release notes 2020-06-07 22:02:36 +02:00
Sebastián Ramírez 88a887329e
📝 Update help and issue templates (#1531)
* 📝 Update help docs: Gitter, issues, links

also fix Gitter tab padding

* 📝 Update new GitHub issue templates

* 📝 Add note about extra help required for new issues
2020-06-07 22:00:15 +02:00
Sebastián Ramírez 8cfe254400 📝 Update release notes 2020-06-05 17:35:39 +02:00
Sebastián Ramírez a0e4d38bea 📝 Update release notes 2020-05-24 08:48:52 +02:00
Sebastián Ramírez b0414b9929
📝 Add new links (#1467)
* 📝 Update opinions including Netflix and add format

* 📝 Add new external links

* 📝 Update README
2020-05-24 08:48:09 +02:00
Sebastián Ramírez 3b4413f9f5 📝 Update release notes 2020-05-24 07:47:19 +02:00
Sebastián Ramírez 8d844bc5cf 🔖 Release version 0.55.1 2020-05-23 18:59:14 +02:00
Sebastián Ramírez 1092261ae1 📝 Update release notes 2020-05-23 18:59:14 +02:00
Sebastián Ramírez 98bb9f13da 🔖 Release version 0.55.0 2020-05-23 16:06:32 +02:00
Sebastián Ramírez d375dc6ebe 📝 Update release notes 2020-05-23 16:06:32 +02:00
Sebastián Ramírez 601d8eb809 📝 Update release notes 2020-05-17 16:04:35 +02:00
Sebastián Ramírez b99f350a18
📝 Add links to GitHub sponsors 💸 (#1425)
* 📝 Add links to GitHub sponsors

* ✏ Update link to sponsors
2020-05-17 16:03:53 +02:00
Sebastián Ramírez c1b0e796c6 📝 Update release notes 2020-05-17 13:51:46 +02:00
Sebastián Ramírez 6001513c4f 📝 Update release notes 2020-05-17 13:50:05 +02:00
Stavros Korokithakis 3fa033d8d5
📝 Add warning about storing user passwords (#1336) 2020-05-17 13:48:05 +02:00
Sebastián Ramírez 59f7e66ac3 📝 Update release notes 2020-05-17 13:41:12 +02:00
Chen Rotem Levy 08e8dfccbe
✏️ Fix typo in [en] tutorial: exception handeling (#1326)
* Fix typo

* ✏️ Fix typo

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-05-17 13:40:55 +02:00
Sebastián Ramírez fc70a2f36f 📝 Update release notes 2020-05-17 13:36:04 +02:00
Sebastián Ramírez ca939fabf7 📝 Update release notes 2020-05-17 12:59:17 +02:00
Xie Wei cc3d795bea
✏ Fix 2 typos in docs (#1324) 2020-05-17 12:56:57 +02:00
Sebastián Ramírez 7fc1bac54b 📝 Update release notes 2020-05-17 12:50:00 +02:00
Sebastián Ramírez 27367df90c 📝 Update release notes 2020-05-17 12:49:02 +02:00
Derek Bekoe f93861e321
📝 Update cors.md - CORS max_age 600 (#1301)
Update max_age documentation from 60 to the actual default value of 600.
https://github.com/encode/starlette/blob/master/starlette/middleware/cors.py#L23

Related PR https://github.com/encode/starlette/pull/909
2020-05-17 12:48:02 +02:00
Sebastián Ramírez 48ccef9ad2 📝 Update release notes 2020-05-17 12:38:10 +02:00
Chris Allnutt b79e002635
✏ Re-word and clarify docs for extra info in body-fields (#1299)
* Fixed Typo in [EN] tutorial: body-fields
- remove duplicate of examples text

* ✏️ Re-word and clarify extra info docs

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-05-17 12:37:15 +02:00
Sebastián Ramírez 1fa28b7cb6 📝 Update release notes 2020-05-17 12:30:00 +02:00
Sebastián Ramírez 22f7eae3f2
✏️ Make sure the * in the README is consistent in the docs (#1424) 2020-05-17 12:28:37 +02:00
Sebastián Ramírez ae93773465 📝 Update release notes 2020-05-17 12:15:58 +02:00
Sebastián Ramírez 0f387553d1 📝 Update release notes 2020-05-17 12:15:08 +02:00
Sebastián Ramírez f8f0a6e462
✏️ Fix typos in async docs (#1423) 2020-05-17 12:11:17 +02:00
Sebastián Ramírez f7eea768f6 🔖 Release 0.54.2 2020-05-16 21:00:28 +02:00
Sebastián Ramírez 53d316f706 📝 Update release notes 2020-05-16 20:56:58 +02:00
Alvaro Pernas 741de7f927
🌐 Add Spanish translation for Concurrency and async / await (#1290)
* final touches to async section ES translation

* minor fixes

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* Update docs/es/docs/async.md

Co-Authored-By: Camila Gutierrez <mariacamilagl@users.noreply.github.com>

* 📝 Update async/await docs in EN with emojis

* 📝 Update wording, format, and emojis for async/await in ES

* 🔧 Add async.md to MkDocs for Spanish

Co-authored-by: Camila Gutierrez <mariacamilagl@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-05-16 20:53:40 +02:00
Sebastián Ramírez 16b3669adf 📝 Update release notes 2020-05-16 18:03:17 +02:00
Donghui Wang c5807fdaa4
🔥 Remove vote link (#1289)
remove 'Vote to include FastAPI in awesome-python', because the PR was closed
2020-05-16 18:02:05 +02:00
Sebastián Ramírez 897b7d1b99 📝 Update release notes 2020-05-16 17:47:26 +02:00
Sebastián Ramírez 409264960e
Allow disabling docs UIs by disabling OpenAPI (#1421)
*  Allow disabling docs UIs by disabling openapi_url

* 📝 Add docs for disabling OpenAPI and docs in prod or other environments

*  Add tests for disabling OpenAPI and docs
2020-05-16 17:45:12 +02:00
Sebastián Ramírez cfb72eec5a 📝 Update release notes 2020-05-16 15:41:21 +02:00
Sebastián Ramírez cfd2c3017f 📝 Update release notes 2020-05-16 15:31:21 +02:00
Sebastián Ramírez 4c1b54e209 📝 Update release notes 2020-05-16 15:18:18 +02:00
Sebastián Ramírez 22e858f65c 📝 Update release notes 2020-05-16 15:01:10 +02:00
Sebastián Ramírez 89f36371b9 📝 Update release notes 2020-05-16 14:48:56 +02:00
Sebastián Ramírez f71ba8885e 📝 Update release notes 2020-05-16 14:39:54 +02:00
Sebastián Ramírez 2d013b8340 📝 Update release notes 2020-05-16 13:06:28 +02:00
MartinEliasQ 9812684178
🌐 Add Spanish translation for the tutorial-user-guide index page (#1244)
* Spanish translation for the tutorial-user-guide index page

* Improve some parts of the text in terms of writing

* Change the wording to keep the documentation consistent.

* 📝 Add small wording and consistency changes

* 🎨 Apply the same consistency changes to EN 🤷

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-05-16 13:02:20 +02:00
Sebastián Ramírez f7a87cd6ba 📝 Update release notes 2020-05-16 12:47:44 +02:00
Sebastián Ramírez dff644abe0 📝 Update release notes 2020-05-16 12:38:13 +02:00
Sebastián Ramírez 1d0f909ca5 📝 Update release notes 2020-05-16 12:21:06 +02:00
Sebastián Ramírez 44bd64d797 📝 Update release notes 2020-05-16 12:04:32 +02:00
Sebastián Ramírez 4e77737a3f 📝 Update release notes 2020-04-18 17:57:50 +02:00
Sebastián Ramírez d03c197c80
📝 Update project generation docs (#1287) 2020-04-18 17:56:35 +02:00
Sebastián Ramírez 06e42a4e5d 📝 Update release notes 2020-04-11 19:22:35 +02:00
Camila Gutierrez bd1e85a8d3
📝 Add Spanish translation for the Python Types Intro page (#1237)
* Spanish translation Python Types Intro page

* 📝 Fix tuple docs in Types intro

* ✏️ Fix typos and wording nitpicks

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-11 19:20:32 +02:00
Sebastián Ramírez 506d5dce39 📝 Update release notes 2020-04-11 18:49:52 +02:00
Sebastián Ramírez d4f3ca1c1b 🔖 Release 0.54.1 2020-04-08 07:51:26 +02:00
Sebastián Ramírez 471d703611 📝 Update release notes 2020-04-08 07:50:30 +02:00
Sebastián Ramírez a4405bbed2 📝 Update release notes 2020-04-08 06:39:40 +02:00
Sebastián Ramírez 483bce3ae1
⬆️ Upgrade to MkDocs Material 5 and update docs scripts (#1225)
* ⬆️ Upgrade mkdocs.yml configs for MkDocs Material 5

*  Update docs.py to always update mkdocs.yml

* 🌐 Update mkdocs.yml for translations

* 🔧 Update MkDocs config

*  Add tabs for alternative options

* ⬆️ Update termynal setup with new CSS classes

* 🔧 Sync / Update mkdocs.yml for languages
2020-04-08 06:25:01 +02:00
Sebastián Ramírez 7372f6ba11 🔖 Release version 0.54.0 2020-04-05 16:50:16 +02:00
Sebastián Ramírez 8d92557e53 📝 Update relase notes 2020-04-05 16:47:33 +02:00
Mickey Pashov c56342bf79
✏️ Fix minor grammatical mistakes in the async docs (#1188)
* Fix minor grammatical mistakes in the async docs.

* ✏️ Update wording and clarify with emojis

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-05 16:46:22 +02:00
Harsha Laxman 07e094fd50
📝 Add note about Alembic in project generator in SQL docs (#1183)
* Update sql-databases alembic docs

Was helpful to refer to the full-stack project when integrating alembic into my own project

* 📝 Update Alembic note in docs

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-05 15:15:39 +02:00
Sebastián Ramírez 1cc30de32f 📝 Update release notes 2020-04-05 15:07:00 +02:00
Sebastián Ramírez 766157bfb4 📝 Update release notes 2020-04-05 13:57:45 +02:00
duganchen d96223460b
📝 Add an example of setting up a test database (#1144)
* Add an example of setting up a test database.

* 📝 Add/update docs for testing a DB with dependency overrides

* 🔧 Update test script, remove line removing test file as it is removed during testing

*  Update testing coverage pragma

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-05 13:53:09 +02:00
Sebastián Ramírez fd99dfc95b 📝 Update release notes 2020-04-04 22:38:17 +02:00
Sebastián Ramírez 10fb7ace04
📝 Update contributing guidelines to review translation PRs (#1215) 2020-04-04 22:36:10 +02:00
Sebastián Ramírez a1a19b103c 📝 Update release notes 2020-04-04 22:16:12 +02:00
Sebastián Ramírez 5c111caf40 📝 Update release notes 2020-04-04 22:14:55 +02:00
Gao Chao 651ee5e4d2
🎨 Update log style in main page, for GitHub Markdown compatibility (#1200)
* Update README.md

fix string format

* 🎨 Update log style in main page, for GitHub Markdown compatibility

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-04 22:13:55 +02:00
Cássio Botaro 0a77c613b0
🌐 Add new language on docs: pt (#1210) 2020-04-04 22:01:19 +02:00
Sebastián Ramírez 70bc469373 📝 Update release notes 2020-04-04 21:39:52 +02:00
Sebastián Ramírez b76334f544
📝 Settings using lru_cache (#1214)
*  Update settings examples to use lru_cache

* 📝 Update docs for Settings, using @lru_cache

* 🎨 Update lru_cache colors to show difference in stored values
2020-04-04 21:39:15 +02:00
Sebastián Ramírez 14b467db06 📝 Update release notes 2020-04-02 07:03:00 +02:00
Sebastián Ramírez 3b7e4e0544 📝 Update release notes 2020-04-02 06:59:19 +02:00
alexmitelman d4d5b21b2e
📝 Add documentation about settings and env vars (#1118)
* Add doc and example for env var config

* Syntax highlight for .env file

* Add test for configuration docs

* 📝 Update settings docs, add more examples

*  Add tests for settings

* 🚚 Rename "Application Configuration" to "Metadata and Docs URLs"

to disambiguate between that and settings

* 🔥 Remove replaced example file

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-04-02 06:55:20 +02:00
Sebastián Ramírez 6e1cd45a46 🔖 Release version 0.53.2 2020-03-30 21:49:50 +02:00
Sebastián Ramírez b86d130eb6 📝 Update release notes 2020-03-30 21:47:11 +02:00
Sebastián Ramírez 042c697b6b 📝 Update release notes 2020-03-30 20:49:24 +02:00
Sebastián Ramírez 210af1fd3d 📝 Update release notes 2020-03-30 20:42:46 +02:00
Sebastián Ramírez 4f88a5fddb 📝 Update release notes 2020-03-30 20:26:07 +02:00
Ikkyu eb6be1d725
💬 Add new language of docs: zh (#1187) 2020-03-30 20:14:58 +02:00
Sebastián Ramírez 1d99681fd4 📝 Update release notes 2020-03-30 12:01:30 +02:00
Sebastián Ramírez 544afaff97
📝 Add docs for adding example to schema (#1185) 2020-03-30 11:58:48 +02:00
Sebastián Ramírez e6b3b994be 🔖 Release version 0.53.1 2020-03-29 22:08:54 +02:00
Sebastián Ramírez 67f148ff83 📝 Update release notes 2020-03-29 22:06:02 +02:00
Sebastián Ramírez 6c34600599
🐛 Fix include docs example file (#1182) 2020-03-29 22:05:24 +02:00
John Paton 016a4b7491
📝 Add documentation of example kwarg of Field (#1106)
* Add documentation of example kwarg of Field

* 📝 Update info about schema examples

* 🚚 Move example file to new directory

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-03-29 21:43:31 +02:00
Sebastián Ramírez be21b74ad5 📝 Update release notes 2020-03-29 19:28:53 +02:00
Sebastián Ramírez 0d165d1efa 📝 Update release notes 2020-03-29 18:52:33 +02:00
YangQuan 9d54215a3a
📝 Add example of Pycharm in tutorial/debugging.md (#1096)
* add example of pycharm in tutorial/debugging.md

* 📝 Update PyCharm debug instructions and screenshot

* 🚚 Move image to new location in docs

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-03-29 18:50:29 +02:00
Sebastián Ramírez 8ab916baed 📝 Update release notes 2020-03-29 17:53:49 +02:00
Paul-Louis NECH c83c50b27d
✏️ Fix typo (#1148) 2020-03-29 17:51:58 +02:00
Sebastián Ramírez c2ad214a84 📝 Update release notes 2020-03-29 17:05:03 +02:00
Sebastián Ramírez 459f0e11e5
🏁 Update Windows development environment and tests (#1179)
* 🏁 Fix ./scripts/docs.py encoding for Windows

* 🔥 Remove ujson from tests as it prevents Windows development

It's still tested by Starlette anyway

* 📝 Update development instructions for Windows

* 🎨 Update format for WSGIMiddleware example

*  Update tests to run on Windows
2020-03-29 17:04:04 +02:00
Sebastián Ramírez 56e43ba204 🔖 Release version 0.53.0 2020-03-27 17:56:41 +01:00
Sebastián Ramírez 10485cad5a 📝 Update release notes 2020-03-27 17:52:33 +01:00
Sebastián Ramírez 53a7798e58
🎨 Update badge for coverage (#1175)
from shields.io, as Codecov's one shows coverage for the last PR from a fork at master
2020-03-27 17:51:58 +01:00
Sebastián Ramírez 372ed58677 📝 Update release notes 2020-03-27 17:33:51 +01:00
Sebastián Ramírez 02a6fcad98 📝 Update release notes 2020-03-27 17:29:11 +01:00
Ari Bajo 651ced68bf
🐛 Fix GZipMiddleware code block linking to TrustedHostMiddleware in docs (#1138) 2020-03-27 17:27:57 +01:00
Sebastián Ramírez 670b64360d 📝 Update release notes 2020-03-27 17:20:01 +01:00
Sebastián Ramírez d1f067dc5b 📝 Update release notes 2020-03-27 17:16:45 +01:00
Sebastián Ramírez 38fd8a674b 📝 Update release notes 2020-03-27 17:04:25 +01:00
Ben bd37d8d04f
📝 Add new external link (#1112)
* Added new external link

I added an article in which I briefly explain how to build an Apache Kafka producer / consumer with FastAPI and aiokafka.

* 📝 Update format

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-03-27 17:02:18 +01:00
Sebastián Ramírez bc99ad0ad1 📝 Update release notes 2020-03-27 16:21:28 +01:00
Sebastián Ramírez 869c7389e2 📝 Update release notes 2020-03-27 15:34:16 +01:00
Aakash Nand 2738df3801
Add Gitter chat to docs (#1061)
* implemented chat feature using sidecar from starlette docs

* 🔥 Use external Gitter sidecar JS

*  Re-implement Gitter chat after multi-lang

* 🔥 Remove moved file

Co-authored-by: Aakash Nand <aakashnand@nttv6.jp>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-03-27 15:32:15 +01:00
Sebastián Ramírez 433d7862ea 📝 Update release notes 2020-03-27 10:21:40 +01:00
Sebastián Ramírez 7625e1e386
📝 Update and simplify translations docs (#1171) 2020-03-27 10:20:39 +01:00
Sebastián Ramírez 53e773a2e1 📝 Update release notes 2020-03-26 22:24:36 +01:00
Camila Gutierrez c13b54ad0e
🏁 Change docs address to localhost for Windows (#1169) 2020-03-26 22:22:34 +01:00
Sebastián Ramírez 71c2abb41d 📝 Update release notes 2020-03-26 20:13:03 +01:00
Sebastián Ramírez 6205935323
Add support for docs translations (#1168)
* 🌐 Refactor file structure to support internationalization

*  Update tests changed after i18n

* 🔀 Merge Typer style from master

* 🔧 Update MkConfig with Typer-styles

* 🎨 Format mkdocs.yml with cannonical form

* 🎨 Format mkdocs.yml

* 🔧 Update MkDocs config

*  Add docs translation scripts dependencies

*  Add Typer scripts to handle translations

*  Add missing translation snippet to include

*  Update contributing docs, add docs for translations

* 🙈 Add docs_build to gitignore

* 🔧 Update scripts with new locations and docs scripts

* 👷 Update docs deploy action with translations

* 📝 Add note about languages not supported in the theme

*  Add first translation, for Spanish
2020-03-26 20:09:53 +01:00