Apispec

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

- Drop deprecated plugin interface. Only plugin classes are now supported. This
includes the removal of ``APISpec``'s ``register_*_helper`` methods, as well
as its ``schema_name_resolver`` parameter. Also drop deprecated
``apispec.utils.validate_swagger``. (:pr:`259`)
- Use ``yaml.safe_load`` instead of ``yaml.load`` when reading
docstrings (:issue:`278`). Thanks :user:`lbeaufort` for the suggestion
and the PR.

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

Features:

- [apispec.core]: *Backwards-incompatible*: Remove `Path` class.
Plugins' `path_helper` methods should now return a path as a string
and optionally mutate the `operations` dictionary (:pr:`238`).
- [apispec.core]: *Backwards-incompatible*: YAML support is optional. To
install with YAML support, use ``pip install 'apispec[yaml]'``. You
will need to do this if you use ``FlaskPlugin``,
``BottlePlugin``, or ``TornadoPlugin`` (:pr:`251`).
- [apispec.ext.marshmallow]: Allow overriding the documentation for
a field's default. This is especially useful for documenting
callable defaults (:issue:`196`).

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

Features:

- [apispec.core]: *Backwards-incompatible*: Change plugin interface. Plugins are
now child classes of ``apispec.BasePlugin``. Built-in plugins are still usable
with the deprecated legacy interface. However, the new class interface is
mandatory to pass parameters to plugins or to access specific methods that used to be
accessed as module level functions (typically in ``apispec.ext.marshmallow.swagger``).
Also, ``schema_name_resolver`` is now a parameter of
``apispec.ext.marshmallow.MarshmallowPlugin``. It can still be passed to ``APISpec``
while using the legacy interface. (:issue:`207`)
- [apispec.core]: *Backwards-incompatible*: ``APISpec.openapi_version`` is now an
``apispec.utils.OpenAPIVersion`` instance.

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

Features:

- [apispec.core]: *Backwards-incompatible*: Rename ``apispec.utils.validate_swagger``
to ``apispec.utils.validate_spec`` and
``apispec.exceptions.SwaggerError`` to ``apispec.exceptions.OpenAPIError``.
Using ``validate_swagger`` will raise a ``DeprecationWarning`` (:pr:`224`).
- [apispec.core]: ``apispec.utils.validate_spec`` no longer relies on
the ``check_api`` NPM module. ``prance`` and
``openapi-spec-validator`` are required for validation, and can be
installed using ``pip install 'apispec[validation]'`` (:pr:`224`).
- [apispec.core]: Deep update components instead of overwriting components
for OpenAPI 3 (:pr:`222`). Thanks :user:`Guoli-Lyu`.

Bug fixes:

- [apispec.ext.marshmallow]: Fix description for parameters in OpenAPI 3
(:pr:`223`). Thanks again :user:`Guoli-Lyu`.

Other changes:

- Drop official support for Python 3.4. Only Python 2.7 and >=3.5 are
supported.

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

Features:

- [apispec.ext.marshmallow]: Fix OpenAPI 3 conversion of schemas in
parameters (:issue:`217`). Thanks :user:`Guoli-Lyu` for the PR.

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

Features:

- [apispec.ext.marshmallow]: Resolve an array of schema objects in
parameters (:issue:`209`). Thanks :user:`cvlong` for reporting and
implementing this.