Commit Graph

726 Commits

Author SHA1 Message Date
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
Xie Wei 801ceaec80
🌐 Add Chinese translation for query-params-str-validations.md (#1500)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-13 00:53:00 +02:00
Sebastián Ramírez c7334ae9f8 📝 Update release notes 2020-06-13 00:50:22 +02:00
Xie Wei d737599a2c
🌐 Add Chinese translation for body.md (#1492)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-13 00:47:50 +02:00
Sebastián Ramírez d2d72a8e4a 📝 Update release notes 2020-06-13 00:43:07 +02:00
Xie Wei 7895c12fa1
🌐 Add Chinese translation for help-fastapi.md (#1465)
* add chinese translation for help-fastapi.md

* improve translations

Co-authored-by: Waynerv <wei.xie@woqutech.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-13 00:40:05 +02:00
Sebastián Ramírez 5f6a14c413 📝 Update release notes 2020-06-13 00:29:43 +02:00
Xie Wei 2b4e88fa98
🌐 Add Chinese translation for query-params.md (#1454)
Co-authored-by: Waynerv <wei.xie@woqutech.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-13 00:26:40 +02:00
Sebastián Ramírez 11723bca27 📝 Update release notes 2020-06-13 00:21:53 +02:00
Xie Wei b49517a64f
🌐 Add Chinese translation for contributing.md (#1460)
Co-authored-by: Waynerv <wei.xie@woqutech.com>
2020-06-13 00:18:57 +02:00
Sebastián Ramírez f910e0c96c 📝 Update release notes 2020-06-13 00:18:20 +02:00
Xie Wei c1ba2a3127
🌐 Add Chinese translation for path-params.md (#1453)
* add chinese translation for path-params.md

* improve translations

* improve translations

Co-authored-by: Waynerv <wei.xie@woqutech.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2020-06-13 00:14:58 +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
Xie Wei 81a529c251
🌐 Translate doc first steps to Chinese (#1323)
* WIP:add Chinese translation for first steps doc

* add Chinese translation for first steps doc

* improve translations

Co-authored-by: Waynerv <wei.xie@woqutech.com>
2020-06-12 22:39:26 +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