Skip to content

Releases: marshmallow-code/flask-smorest

0.24.1

09 Aug 22:07
Compare
Choose a tag to compare

Bug fixes:

  • Fix bug introduced in 0.24.0 preventing setting a status code or header when
    returning a Response object. (:pr:178).
    Thanks :user:@marksantcroos for reporting.

0.24.0

16 Jul 22:24
Compare
Choose a tag to compare

Features:

  • Backwards-incompatible: Add OPENAPI_SWAGGER_UI_CONFIG to allow passing
    a dict of Swagger UI configuration parameters. Remove
    OPENAPI_SWAGGER_UI_SUPPORTED_SUBMIT_METHODS: the same can be achieved by
    passing supportedSubmitMethods in OPENAPI_SWAGGER_UI_CONFIG. Remove
    layout and deepLinking default overrides. Those can be passed in
    OPENAPI_SWAGGER_UI_CONFIG as well. (:pr:171).
    Thanks :user:joshua-harrison-2011 for the pull-request.

0.23.0

08 Jul 10:24
Compare
Choose a tag to compare

Features:

  • Backwards-incompatible: Make API title and version mandatory parameters.
    Before this change, the version would default to "1" and the title would
    be app.name. Those two parameters can be passed at init or as application
    configuration parameters TITLE and API_VERSION. Also rename
    OpenAPIVersionNotSpecified as MissingAPIParameterError. (:pr:169).
    Thanks :user:playpauseandstop for the help on this.

  • Backwards-incompatible: Rework pagination documentation to allow more
    customization. This change will break code overriding
    PAGINATION_HEADER_DOC, _make_pagination_header or
    _prepare_pagination_doc (:pr:153).

0.22.0

19 Jun 20:30
Compare
Choose a tag to compare

Features:

  • Add flask openapi print and flask openapi write commands (:pr:154).

Other changes:

  • Backwards-incompatible: Drop support for Python 3.5.

0.21.2

08 Jun 22:58
Compare
Choose a tag to compare

Bug fixes:

  • Use HTTPStatus phrase, not name, in response description (:pr:158).

0.21.1

29 May 07:02
Compare
Choose a tag to compare

Bug fixes:

  • Deep-copy the documentation information for each method of a resource. This
    fixes a crash when a view function serves several methods, due to apispec
    mutating doc info dict. (:pr:147)
    Thanks :user:DrChrisLevy for reporting.

0.21.0

24 Mar 22:51
Compare
Choose a tag to compare

Features:

  • Support webargs 6.0.0 (:pr:132).

Other changes:

  • Backwards-incompatible: Drop support for webargs < 6.0.0 (:pr:132).

0.20.0

20 Mar 16:29
Compare
Choose a tag to compare

Bug fixes:

  • Backwards-incompatible: Use HTTPStatus name rather than phrase
    to name error components. This fixes an issue due to phrase containing
    spaces not being URL-encoded. Also change DefaultError into
    DEFAULT_ERROR for consistency. This change will break code referencing
    one of those errors. (:issue:136).
    Thanks :user:michelle-avery for reporting.

Other changes:

  • Backwards-incompatible: Remove OPENAPI_REDOC_VERSION and
    OPENAPI_SWAGGER_UI_VERSION. Remove hardcoded CDNs. Users should modify
    their code to use OPENAPI_REDOC_URL and OPENAPI_SWAGGER_UI_URL
    instead. The docs provide examples of CDN URLs. (:issue:134).

0.19.2

20 Feb 14:24
Compare
Choose a tag to compare

Bug fixes:

  • Fix utils.deepupdate for the case where the original value is a string or
    integer and the updated value is a dict (:issue:129).
    Thanks :user:maj-skymedia for reporting.

0.19.1

20 Feb 08:23
Compare
Choose a tag to compare

Bug fixes:

  • Fix a regression introduced in 0.19.0. With marshmallow 2, the response would
    contain two 'X-Pagination' headers: the correct header and an empty one.
    (:pr:128)