Fastapi: Include breaking changes in changelog

Created on 22 Jul 2020  路  2Comments  路  Source: tiangolo/fastapi

Version 0.59.0 introduced a small breaking change where the parameter 'openapi prefix' was removed meaning code below wasn't working:

openapi_schema = get_openapi(
    version=1.0,
    title='A title',
    description='A description',
    openapi_prefix='',
    routes=app.routes,
)

I think it would be useful to have a separate section in the release notes where these types of changes are listed

Example:

Screenshot 2020-07-22 at 11 51 41

It is similar to how angular does it (https://next.angular.io/guide/updating-to-version-10)

answered enhancement

Most helpful comment

Thanks! Good idea. I started using sections like that for the latest release notes: https://fastapi.tiangolo.com/release-notes/ .

If you think some previous releases deserve separated sections, I would accept PRs updating them.

All 2 comments

Thanks! Good idea. I started using sections like that for the latest release notes: https://fastapi.tiangolo.com/release-notes/ .

If you think some previous releases deserve separated sections, I would accept PRs updating them.

Alt Text

Was this page helpful?
0 / 5 - 0 ratings