++++++++++++++++++
Features:
- Expanded support for OpenAPI Specification version 3 (:issue:`165`).
- Add ``summary`` and ``description`` parameters to ``APISpec.path``
(:issue:`227`). Thanks :user:`timakro` for the suggestion.
- Add `apispec.core.Components.security_scheme` for adding Security
Scheme Objects (:issue:`245`).
- [apispec.ext.marshmallow]: Add support for outputting field patterns
from ``Regexp`` validators (:pr:`364`).
Thanks :user:`DStape` for the PR.
Bug fixes:
- [apispec.ext.marshmallow]: Fix automatic documentation of schemas when
using ``Nested(MySchema, many==True)`` (:issue:`383`). Thanks
:user:`whoiswes` for reporting.
Other changes:
- *Backwards-incompatible*: Components properties are now passed as
dictionaries rather than keyword arguments (:pr:`381`).
.. code-block:: python
<1.0.0
spec.components.schema("Pet", properties={"name": {"type": "string"}})
spec.components.parameter("PetId", "path", format="int64", type="integer")
spec.components.response("NotFound", description="Pet not found")
>=1.0.0
spec.components.schema("Pet", {"properties": {"name": {"type": "string"}}})
spec.components.parameter("PetId", "path", {"format": "int64", "type": "integer"})
spec.components.response("NotFound", {"description": "Pet not found"})
Deprecations/Removals:
- *Backwards-incompatible*: The ``ref`` argument passed to fields is no
longer used (:issue:`354`). References for nested ``Schema`` are
stored automatically.
- *Backwards-incompatible*: The ``extra_fields`` argument of
`apispec.core.Components.schema` is removed. All properties may be
passed in the ``component`` argument.
.. code-block:: python
<1.0.0
spec.definition("Pet", schema=PetSchema, extra_fields={"discriminator": "name"})
>=1.0.0
spec.components.schema("Pet", schema=PetSchema, component={"discriminator": "name"})