tiangolo.fastapi/docs/release-notes.md

Next release

0.16.0

• Upgrade path operation doctsring parsing to support proper Markdown descriptions. New documentation at Path Operation Configuration. PR #163.

• Refactor internal usage of Pydantic to use correct data types. PR #164.

• Upgrade Pydantic to version 0.23. PR #160 by @euri10.

• Fix typo in Tutorial about Extra Models. PR #159 by @danielmichaels.

• Fix Query Parameters URL examples in docs. PR #157 by @hayata-yamamoto.

0.15.0

• Add support for multiple file uploads (as a single form field). New docs at: Multiple file uploads. PR #158.

• Add docs for: Additional Status Codes. PR #156.

0.14.0

• Improve automatically generated names of path operations in OpenAPI (in API docs). A function read_items instead of having a generated name "Read Items Get" will have "Read Items". PR #155.

• Add docs for: Testing FastAPI. PR #151.

• Update /docs Swagger UI to enable deep linking. This allows sharing the URL pointing directly to the path operation documentation in the docs. PR #148 by @wshayes.

• Update development dependencies, Pipfile.lock. PR #150.

• Include Falcon and Hug in: Alternatives, Inspiration and Comparisons.

0.13.0

• Improve/upgrade OAuth2 scopes support with SecurityScopes:
  • SecurityScopes can be declared as a parameter like Request, to get the scopes of all super-dependencies/dependants.
  • Improve Security handling, merging scopes when declaring SecurityScopes.
  • Allow using SecurityBase (like OAuth2) classes with Depends and still document them. Security now is needed only to declare scopes.
  • Updated docs about: OAuth2 with Password (and hashing), Bearer with JWT tokens.
  • New docs about: OAuth2 scopes.
  • PR #141.

0.12.1

• Fix bug: handling additional responses in APIRouter.include_router(). PR #140.

• Fix typo in SQL tutorial. PR #138 by @mostaphaRoudsari.

• Fix typos in section about nested models and OAuth2 with JWT. PR #127 by @mmcloud.

0.12.0

• Add additional responses parameter to path operation decorators to extend responses in OpenAPI (and API docs).

  • It also allows extending existing responses generated from response_model, declare other media types (like images), etc.
  • The new documentation is here: Additional Responses.
  • responses can also be added to .include_router(), the updated docs are here: Bigger Applications.
  • PR #97 originally initiated by @barsi.

• Update scripts/test-cov-html.sh to allow passing extra parameters like -vv, for development.

0.11.0

• Add auto_error parameter to security utility functions. Allowing them to be optional. Also allowing to have multiple alternative security schemes that are then checked in a single dependency instead of each one verifying and returning the error to the client automatically when not satisfied. PR #134.

• Update SQL Tutorial to close database sessions even when there are exceptions. PR #89 by @alexiri.

• Fix duplicate dependency in pyproject.toml. PR #128 by @zxalif.

0.10.3

• Add Gitter chat, badge, links, etc. https://gitter.im/tiangolo/fastapi . PR #117.

• Add docs about Extending OpenAPI. PR #126.

• Make Travis run Ubuntu Xenial (newer version) and Python 3.7 instead of Python 3.7-dev. PR #92 by @blueyed.

• Fix duplicated param variable creation. PR #123 by @yihuang.

• Add note in Response Model docs about why using a function parameter instead of a function return type annotation. PR #109 by @JHSaunders.

• Fix event docs (startup/shutdown) function name. PR #105 by @stratosgear.

0.10.2

• Fix OpenAPI (JSON Schema) for declarations of Python Union (JSON Schema additionalProperties). PR #121.

• Update Background Tasks with a note on Celery.

• Document response models using unions and lists, updated at: Extra Models. PR #108.

0.10.1

• Add docs and tests for encode/databases. New docs at: Async SQL (Relational) Databases. PR #107.

0.10.0

• Add support for Background Tasks in path operation functions and dependencies. New documentation about Background Tasks is here. PR #103.

• Add support for .websocket_route() in APIRouter. PR #100 by @euri10.

• New docs section about Events: startup - shutdown. PR #99.

0.9.1

• Document receiving Multiple values with the same query parameter and Duplicate headers. PR #95.

0.9.0

• Upgrade compatible Pydantic version to 0.21.0. PR #90.

• Add documentation for: Application Configuration.

• Fix typo in docs. PR #76 by @matthewhegarty.

• Fix link in "Deployment" to "Bigger Applications".

0.8.0

• Make development scripts executable. PR #76 by @euri10.

• Add support for adding tags in app.include_router(). PR #55 by @euri10. Documentation updated in the section: Bigger Applications.

• Update docs related to Uvicorn to use new --reload option from version 0.5.x. PR #74.

• Update isort imports and scripts to be compatible with newer versions. PR #75.

0.7.1

• Update technical details about async def handling with respect to previous frameworks. PR #64 by @haizaar.

• Add deployment documentation for Docker in Raspberry Pi and other architectures.

• Trigger Docker images build on Travis CI automatically. PR #65.

0.7.0

• Add support for UploadFile in File parameter annotations.
  • This includes a file-like interface.
  • Here's the updated documentation for declaring File parameters with UploadFile.
  • And here's the updated documentation for using Form parameters mixed with File parameters, supporting bytes and UploadFile at the same time.
  • PR #63.

0.6.4

• Add technical details about async def handling to docs. PR #61.

• Add docs for Debugging FastAPI applications in editors.

• Clarify Bigger Applications deployed with Docker.

• Fix typos in docs.

• Add section about History, Design and Future.

• Add docs for using WebSockets with FastAPI. PR #62.

0.6.3

• Add Favicons to docs. PR #53.

0.6.2

• Introduce new project generator based on FastAPI and PostgreSQL: https://github.com/tiangolo/full-stack-fastapi-postgresql. PR #52.

• Update SQL tutorial with SQLAlchemy, using Depends to improve editor support and reduce code repetition. PR #52.

• Improve middleware naming in tutorial for SQL with SQLAlchemy https://fastapi.tiangolo.com/tutorial/sql-databases/.

0.6.1

• Add docs for GraphQL: https://fastapi.tiangolo.com/tutorial/graphql/. PR #48.

0.6.0

• Update SQL with SQLAlchemy tutorial at https://fastapi.tiangolo.com/tutorial/sql-databases/ using the new official request.state. PR #45.

• Upgrade Starlette to version 0.11.1 and add required compatibility changes. PR #44.

0.5.1

• Add section about helping and getting help with FastAPI.

• Add note about path operations order in docs.

• Update section about error handling with more information and make relation with Starlette error handling utilities more explicit. PR #41.

• Add Development - Contributing section to the docs. PR #42.

0.5.0

• Add new HTTPException with support for custom headers. With new documentation for handling errors at: https://fastapi.tiangolo.com/tutorial/handling-errors/. PR #35.

• Add documentation to use Starlette Request object directly. Check #25 by @euri10.

• Add issue templates to simplify reporting bugs, getting help, etc: #34.

• Update example for the SQLAlchemy tutorial at https://fastapi.tiangolo.com/tutorial/sql-databases/ using middleware and database session attached to request.

0.4.0

• Add openapi_prefix, support for reverse proxy and mounting sub-applications. See the docs at https://fastapi.tiangolo.com/tutorial/sub-applications-proxy/: #26 by @kabirkhan.

• Update docs/tutorial for SQLAlchemy including note about DB Browser for SQLite.

0.3.0

• Fix/add SQLAlchemy support, including ORM, and update docs for SQLAlchemy: #30.

0.2.1

• Fix jsonable_encoder for Pydantic models with Config but without json_encoders: #29.

0.2.0

• Fix typos in Security section: #24 by @kkinder.

• Add support for Pydantic custom JSON encoders: #21 by @euri10.

0.1.19

• Upgrade Starlette version to the current latest 0.10.1: #17 by @euri10.