Flask-rest-api

Latest version: v0.17.1

Safety actively analyzes 621436 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 6

0.17.1

+++++++++++++++++++

Other changes:

- Add a ``DeprecationWarning`` to warn about the rename to ``flask-smorest``.

0.17.0

+++++++++++++++++++

Features:

- *Backwards-incompatible*: Only return status code and short name in error
handler (:pr:`84`).
- *Backwards-incompatible*: Remove logging from error handler. Logging can be
achieved in application code by overriding ``handle_http_exception``.
Remove ``_prepare_error_response_content``. Reponse payload is computed in
``handle_http_exception``. (:pr:`85`)
- *Backwards-incompatible*: Remove ``InvalidLocationError``. The mapping from
webargs locations to OAS locations is done in apispec and no exception is
raised if an invalid location is passed. (:pr:`81`)
- Add ``content_type`` argument to ``Blueprint.arguments`` and provide
reasonable default content type for ``form`` and ``files`` (:pr:`83`).
- Add ``description`` parameter to ``Blueprint.arguments`` to pass description
for ``requestBody`` (:pr:`93`).
- Allow customization of docstring delimiter string (:issue:`49`).
- Support file uploads as `multipart/form-data` (:pr:`97`).

Bug fixes:

- Fix documentation of ``form`` and ``files`` arguments: use ``requestBody``
in OAS3, document content type (:pr:`83`).

Other changes:

- *Backwards-incompatible*: Don't republish ``NestedQueryArgsParser`` anymore.
This belongs to user code and can be copied from webargs doc (:pr:`94`).
- *Backwards-incompatible*: Bump minimum apispec version to 3.0.0.

0.16.1

+++++++++++++++++++

Bug fixes:

- Fix detection of unhandled exceptions in error handler for Flask=>1.1.0
(:pr:`82`).

Other changes:

- Bump minimum Flask version to 1.1.0. From this version on, uncaught
exceptions are passed to the error handler as ``InternalServerError`` with
the exception attached as ``original_exception`` attribute. (:pr:`82`)

0.16.0

+++++++++++++++++++

Features:

- Add ``parameters`` argument to ``Blueprint.route`` to pass documentation for
parameters that are shared by all operations of a path (:pr:`78`).

Other changes:

- *Backwards-incompatible*: Bump minimum apispec version to 2.0.0.
- *Backwards-incompatible*: Path parameters documentation passed in
``Blueprint.doc`` is no longer merged with automatic documentation. It should
be passed in ``Blueprint.route`` instead.
- *Backwards-incompatible*: Remove ``Api.schema`` and ``Api.definition``.
Those methods are useless since ``Schema`` components are automatically
registered by apispec. Manual component registration is still possible using
the internal apispec ``Components`` object. (:pr:`75`)

0.15.1

+++++++++++++++++++

Bug fixes:

- marshmallow 3.0.0rc7 compatibility (:pr:`77`).

0.15.0

+++++++++++++++++++

Features:

- Add parameters to pass examples and headers in ``Blueprint.response``
decorator (:pr:`63`).
- Add parameters to pass examples for ``requestBody`` in OpenAPI v3 in
``Blueprint.arguments`` decorator (:pr:`68`).
- Support status codes expressed as ``HTTPStatus`` in ``Blueprint.response``
decorator (:issue:`60`).
Thanks :user:`Regzand` for reporting.

Other changes:

- Bump minimum apispec version to 1.3.2.
- Bump minimum werkzeug version to 0.15. With 0.14.x versions, `412` responses
are returned with no content.
- *Backwards-incompatible*: When using ``Blueprint.doc`` decorator to provide
additional documentation to the response described in the
``Blueprint.response`` decorator, the user must use the same format (``str``,
``int`` or ``HTTPStatus``) to express the status code in both decorators.
This is a side-effect of (:issue:`60`). Now that headers and examples can
be described in ``Blueprint.response``, this should not be a common use case.

Page 1 of 6

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.