Flask-smorest

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

Features:

- Add ``flask_plugin`` and ``marshmallow_plugin`` spec kwargs to allow
overriding base plugins.
- *Backwards-incompatible*: Rename ``plugins`` spec kwarg to ``extra_plugins``.
- *Backwards-incompatible*: Don't default to OpenAPI version 2.0. The version
must now be specified, either as ``OPENAPI_VERSION`` app parameter or as
``openapi_version`` spec kwarg.
- Support apispec 1.0.0.

Other changes:

- *Backwards-incompatible*: Drop support for apispec 0.x.

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

Features:

- *Backwards-incompatible*: ``Api.register_converter`` doesn't register
converter in Flask app anymore. It should be registered manually using
``app.url_map.converters['converter_name'] = Converter``.
- ``Api.definition``, ``Api.register_field`` and ``Api.register_converter`` can
be called before app initialization. The information is buffered and passed
to the internal ``APISpec`` object when it is created, in ``Api.init_app``.

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

Bug fixes:

- Fix typo in ``ErrorHandlerMixin._prepare_error_response_content``.

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

Features:

- The ``HTTP_METHODS`` list that defines the order of the methods in the spec
is now a class attribute of ``Blueprint``. It can be overridden to enforce
another order.

Bug fixes:

- Import ``Mapping`` from ``collections.abc`` rather than ``collections``. The
latter is deprecated in Python 3.7 and will be removed in 3.8.
- Merge manual doc added with ``Blueprint.doc`` with automatic documentation
after auto doc is prepared (i.e. adapted to OpenAPI version) (:issue:`19`).
Thanks :user:`fbergroth` for reporting.
- Merge automatic path parameter documentation with existing manual doc rather
than append as duplicate parameter (:issue:`23`).
Thanks :user:`congenica-andrew` for reporting.
- Fix path parameter documentation structure when using OpenAPI v3.
- Document http status codes as strings, not integers.
- Fix use of Swagger UI config parameter ``OPENAPI_SWAGGER_UI_URL``.


Other changes:

- 100% test coverage !

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

Features:

- *Backwards-incompatible*: Rework of the ETag feature. It is now accesible
using dedicated ``Blueprint.etag`` decorator. ``check_etag`` and ``set_etag``
are methods of ``Blueprint`` and ``etag.INCLUDE_HEADERS`` is replaced with
``Blueprint.ETAG_INCLUDE_HEADERS``. It is enabled by default (only on views
decorated with ``Blueprint.etag``) and disabled with ``ETAG_DISABLED``
application configuration parameter. ``is_etag_enabled`` is now private.
(:pr:`21`)
- *Backwards-incompatible*: The ``response`` decorator returns a ``Response``
object rather than a (``Response`` object, status code) tuple. The status
code is set in the ``Response`` object.
- Support apispec 1.0.0b5.

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

Features:

- *Backwards-incompatible*: Don't prefix all routes in the spec with
``APPLICATION_ROOT``. If using OpenAPI v2, set ``APPLICATION_ROOT`` as
``basePath``. If using OpenAPI v3, the user should specify ``servers``
manually.
- *Backwards-incompatible*: In testing and debug modes, ``verify_check_etag``
not only logs a warning but also raises ``CheckEtagNotCalledError`` if
``check_etag`` is not called in a resource that needs it.