Skip to content

Latest commit

 

History

History
1081 lines (709 loc) · 32.4 KB

CHANGELOG.rst

File metadata and controls

1081 lines (709 loc) · 32.4 KB
Raw

Changelog

4.4.1 (2020-05-07)

Bug fixes:

4.4.0 (2020-03-31)

Features:

  • Populate additionalProperties from Meta.unknown (:pr:`635`). Thanks :user:`timsilvers` for the PR.
  • Allow to_yaml to pass kwargs to yaml.dump (:pr:`648`).
  • Resolve header references in responses (:pr:`650`).
  • Resolve example references in parameters, request bodies and responses (:pr:`#651`).

4.3.0 (2021-02-10)

Features:

  • Add apispec.core.Components.header to register header components (:pr:`637`).

4.2.0 (2021-02-06)

Features:

  • Make components public attributes of Components class (:pr:`634`).

4.1.0 (2021-01-26)

Features:

Bug fixes:

  • Fix docstrings documenting kwargs type as dict (:issue:`534`).
  • Use x-minimum and x-maximum extensions to document ranges that are not of number type (e.g. datetime) (:issue:`614`).

Other changes:

  • Test against Python 3.9.

4.0.0 (2020-09-30)

Features:

  • Backwards-incompatible: Automatically generate references for schemas passed as strings in responses and request bodies. When using MarshmallowPlugin, if a schema is passed as string, the marshmallow registry is looked up for this schema name and if none is found, the name is assumed to be a reference to a manually created schema and a reference is generated. No exception is raised anymore if the schema name can't be found in the registry. (:pr:`554`)

4.0.0b1 (2020-09-06)

Features:

  • Backwards-incompatible: Ignore location field metadata. This attribute was used in webargs but it has now been dropped. A Schema can now only have a single location. This simplifies the logic in OpenAPIConverter methods, where default_in argument now becomes location. (:pr:`526`)
  • Backwards-incompatible: Don't document int format as "int32" and float format as "float", as those are platform-dependent (:pr:`595`).

Refactoring:

  • OpenAPIConverter.field2parameters and OpenAPIConverter.property2parameter are removed. OpenAPIConverter.field2parameter becomes private. (:pr:`581`)

Other changes:

  • Drop support for marshmallow 2. Marshmallow 3.x is required. (:pr:`583`)
  • Drop support for Python 3.5. Python 3.6+ is required. (:pr:`582`)

3.3.2 (2020-08-29)

Bug fixes:

3.3.1 (2020-06-06)

Bug fixes:

  • Fix MarshmallowPlugin crash when resolve_schema_dict is passed a schema as string and schema_name_resolver returns None (:issue:`566`). Thanks :user:`black3r` for reporting and thanks :user:`Bangertm` for the PR.

3.3.0 (2020-02-14)

Features:

3.2.0 (2019-12-22)

Features:

3.1.1 (2019-12-17)

Bug fixes:

  • Don't emit a warning when passing "default" as response status code in OASv2 (:pr:`521`).

3.1.0 (2019-11-04)

Features:

Support:

3.0.0 (2019-09-17)

Features:

  • Add support for generating user-defined OpenAPI properties for custom field classes via an add_attribute_function method (:pr:`478` and :pr:`498`).
  • [apispec.ext.marshmallow]: Backwards-incompatible fields.Raw and fields.Field are now represented by OpenAPI Any Type (:pr:`495`).
  • [apispec.ext.marshmallow]: Backwards-incompatible: The schema_name_resolver function now receives a Schema class, a Schema instance or a string that resolves to a Schema class. This allows a custom resolver to generate different names depending on schema modifiers used in a Schema instance (:pr:`476`).

Bug fixes:

  • [apispec.ext.marshmallow]: With marshmallow 3, the default value of a field in the documentation is the serialized value of the missing attribute, not missing itself (:pr:`490`).

Refactoring:

  • clean_parameters and clean_operations are now APISpec methods (:pr:`489`).
  • [apispec.ext.marshmallow]: Schema resolver methods are extracted from MarshmallowPlugin into a SchemaResolver class member (:pr:`496`).
  • [apispec.ext.marshmallow]: OpenAPIConverter is now a class member of MarshmallowPlugin (:pr:`493`).
  • [apispec.ext.marshmallow]: Field to properties conversion logic is extracted from OpenAPIConverter into FieldConverterMixin (:pr:`478`).

Other changes:

2.0.2 (2019-07-04)

Bug fixes:

  • Fix compatibility with marshmallow 3.0.0rc8 (:pr:`469`).

Other changes:

2.0.1 (2019-06-26)

Bug fixes:

  • Don't mutate operations and parameters in APISpec.path to avoid issues when calling it twice with the same operations or parameters (:pr:`464`).

2.0.0 (2019-06-18)

Features:

  • Add support for path level parameters (:issue:`453`). Thanks :user:`karec` for the PR.
  • Backwards-incompatible: A apispec.exceptions.DuplicateParameterError is raised when two parameters with same name and location are passed to a path or an operation (:pr:`455`).
  • Backwards-incompatible: A apispec.exceptions.InvalidParameterError is raised when a parameter is missing required name and in attributes after helpers have been executed (:pr:`455`).

Other changes:

  • Backwards-incompatible: All plugin helpers must accept extra **kwargs (:issue:`453`).
  • Backwards-incompatible: Components must be referenced by ID, not full path (:issue:`463`).

1.3.3 (2019-05-05)

Bug fixes:

  • marshmallow 3.0.0rc6 compatibility (:pr:`445`).

1.3.2 (2019-05-02)

Bug fixes:

  • Fix handling of OpenAPI v3 components content without schema in MarshmallowPlugin (:pr:`443`).

1.3.1 (2019-04-29)

Bug fixes:

1.3.0 (2019-04-24)

Features:

1.2.1 (2019-04-18)

Bug fixes:

  • Fix error in MarshmallowPlugin when passing exclude and dump_only as class Meta attributes mixing list and tuple (:pr:`431`). Thanks :user:`blagasz` for the PR.

1.2.0 (2019-04-08)

Features:

  • Strip empty sections (components, tags) from generated documentation (:pr:`421` and :pr:`425`).

1.1.2 (2019-04-07)

Bug fixes:

1.1.1 (2019-04-02)

Bug fixes:

  • Fix passing references for parameters/responses when using MarshmallowPlugin (:pr:`414`).

1.1.0 (2019-03-17)

Features:

  • Resolve Schema classes in response headers (:pr:`409`).

1.0.0 (2019-02-08)

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`).
# <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.
# <1.0.0
spec.definition("Pet", schema=PetSchema, extra_fields={"discriminator": "name"})

# >=1.0.0
spec.components.schema("Pet", schema=PetSchema, component={"discriminator": "name"})

1.0.0rc1 (2018-01-29)

Features:

  • Automatically generate references to nested schemas with a computed name, e.g. fields.Nested(PetSchema()) -> #components/schemas/Pet.
  • Automatically generate references for requestBody using the above mechanism.
  • Ability to opt out of the above behavior by passing a schema_name_resolver function that returns None to api.ext.MarshmallowPlugin.
  • References now respect Schema modifiers, including exclude and partial.
  • Backwards-incompatible: A apispec.exceptions.DuplicateComponentNameError is raised when registering two components with the same name (:issue:`340`).

1.0.0b6 (2018-12-16)

Features:

  • Backwards-incompatible: basePath is not removed from paths anymore. Paths passed to APISpec.path should not contain the application base path (:pr:`345`).
  • Add apispec.ext.marshmallow.openapi.OpenAPIConverter.resolve_schema_class (:pr:`346`). Thanks :user:`buxx`.

1.0.0b5 (2018-11-06)

Features:

  • apispec.core.Components is added. Each APISpec instance has a Components object used to define components such as schemas, parameters or reponses. "Components" is the OpenAPI v3 terminology for those reusable top-level objects.
  • apispec.core.Components.parameter and apispec.core.Components.response are added.
  • Backwards-incompatible: apispec.APISpec.add_path and apispec.APISpec.add_tag are renamed to apispec.APISpec.path and apispec.APISpec.tag.
  • Backwards-incompatible: apispec.APISpec.definition is moved to the Components class and renamed to apispec.core.Components.schema.
# apispec<1.0.0b5
spec.add_tag({'name': 'Pet', 'description': 'Operations on pets'})
spec.add_path('/pets/', operations=...)
spec.definition('Pet', properties=...)

# apispec>=1.0.0b5
spec.tag({'name': 'Pet', 'description': 'Operations on pets'})
spec.path('/pets/', operations=...)
spec.components.schema('Pet', properties=...)
  • Plugins can define parameter_helper and response_helper to modify parameter and response components definitions.
  • MarshmallowPlugin resolves schemas in parameters and responses components.
  • Components helpers may return None as a no-op rather than an empty dict (:pr:`336`).

Bug fixes:

  • MarshmallowPlugin.schema_helper does not crash when no schema is passed (:pr:`336`).

Deprecations/Removals:

  • The legacy response_helper feature is removed. The same can be achieved from operation_helper.

1.0.0b4 (2018-10-28)

If you use these plugins, install apispec-webframeworks and update your imports like so:

# apispec<1.0.0b4
from apispec.ext.flask import FlaskPlugin

# apispec>=1.0.0b4
from apispec_webframeworks.flask import FlaskPlugin

Thanks :user:`ergo` for the suggestion and the PR.

1.0.0b3 (2018-10-08)

Features:

  • [apispec.core]: Backwards-incompatible: openapi_version parameter of APISpec class does not default to '2.0' anymore and info parameter is merged with **options kwargs.

Bug fixes:

  • [apispec.ext.marshmallow]: Exclude load_only fields when documenting responses (:issue:`119`). Thanks :user:`luisincrespo` for reporting.
  • [apispec.ext.marshmallow]: Exclude dump_only fields when documenting request body parameter schema.

1.0.0b2 (2018-09-09)

  • 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.

1.0.0b1 (2018-07-29)

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`).

0.39.0 (2018-06-28)

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.

0.38.0 (2018-06-10)

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:

Other changes:

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

0.37.1 (2018-05-28)

Features:

0.37.0 (2018-05-14)

Features:

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

0.36.0 (2018-05-07)

Features:

  • [apispec.ext.marshmallow]: Document values parameter of Dict field as additionalProperties (:issue:`201`). Thanks :user:`UrKr`.

0.35.0 (2018-04-10)

Features:

Bug fixes:

  • [apispec.ext.marshmallow]: Always use field.missing instead of field.default when introspecting fields (:issue:`32`). Thanks :user:`lafrech`.

Other changes:

  • [apispec.ext.marshmallow]: Refactor some of the internal functions in apispec.ext.marshmallow.swagger for consistent API (:issue:`199`). Thanks :user:`lafrech`.

0.34.0 (2018-04-04)

Features:

Other changes:

0.33.0 (2018-04-01)

Features:

  • [apispec.ext.marshmallow]: Respect data_key argument on fields (in marshmallow 3). Thanks :user:`lafrech`.

0.32.0 (2018-03-24)

Features:

Bug fixes:

0.31.0 (2018-01-30)

0.30.0 (2018-01-12)

Features:

0.29.0 (2018-01-04)

Features:

  • [apispec.core and apispec.ext.marshmallow]: Add limited support for OpenAPI v3. Pass openapi_version='3.0.0' to Spec to use it (:issue:`165`). Thanks :user:`Bangertm`.

0.28.0 (2017-12-09)

Features:

  • [apispec.core and apispec.ext.marshmallow]: Add schema_name_resolver param to APISpec for resolving ref names for marshmallow Schemas. This is useful when a self-referencing schema is nested within another schema (:issue:`167`). Thanks :user:`buxx` for the PR.

0.27.1 (2017-12-06)

Bug fixes:

  • [apispec.ext.flask]: Don't document view methods that aren't included in app.add_url_rule(..., methods=[...])) (:issue:`173`). Thanks :user:`ukaratay`.

0.27.0 (2017-10-30)

Features:

  • [apispec.core]: Add register_operation_helper.

Bug fixes:

Thanks :user:`yoichi` for these changes.

0.26.0 (2017-10-23)

Features:

  • [apispec.ext.marshmallow]: Generate "enum" property with single entry when the validate.Equal validator is used (:issue:`155`). Thanks :user:`Bangertm` for the suggestion and PR.

Bug fixes:

0.25.4 (2017-10-09)

Bug fixes:

  • [apispec.ext.marshmallow]: Fix swagger location mapping for default_in param in fields2parameters (:issue:`156`). Thanks :user:`decaz`.

0.25.3 (2017-09-27)

Bug fixes:

0.25.2 (2017-09-05)

Bug fixes:

  • [apispec.ext.marshmallow]: Avoid AttributeError when passing non-dict items to path objects (:issue:`151`). Thanks :user:`yoichi`.

0.25.1 (2017-08-23)

Bug fixes:

0.25.0 (2017-08-15)

Features:

Other changes:

0.24.0 (2017-08-15)

Features:

0.23.1 (2017-08-08)

Bug fixes:

  • [apispec.ext.marshmallow]: Fix swagger location mapping for default_in param in property2parameter (:issue:`142`). Thanks :user:`decaz`.

0.23.0 (2017-08-03)

0.22.3 (2017-07-16)

  • Release wheel distribution.

0.22.2 (2017-07-12)

Bug fixes:

0.22.1 (2017-06-25)

Bug fixes:

0.22.0 (2017-05-30)

Features:

0.21.0 (2017-04-21)

Features:

0.20.1 (2017-04-18)

Bug fixes:

  • [apispec.ext.tornado]: Fix compatibility with Tornado>=4.5.
  • [apispec.ext.tornado]: Fix adding paths for handlers with coroutine methods in Python 2 (:issue:`99`).

0.20.0 (2017-03-19)

Features:

  • [apispec.core]: Definition helper functions receive the definition keyword argument, which is the current state of the definition (:issue:`122`). Thanks :user:`martinlatrille` for the PR.

Other changes:

0.19.0 (2017-03-05)

Features:

Bug fixes:

  • [apispec.ext.marshmallow]: 'discriminator' is no longer valid as field metadata. It should be defined by passing extra_fields={'discriminator': '...'} to APISpec.definition. Thanks for reporting, :user:`lafrech`.
  • [apispec.ext.marshmallow]: Allow additional properties when translating Nested fields using allOf (:issue:`108`). Thanks :user:`lafrech` for the suggestion and the PR.
  • [apispec.ext.marshmallow]: Respect dump_only and load_only specified in class Meta (:issue:`84`). Thanks :user:`lafrech` for the fix.

Other changes:

  • Drop support for Python 3.3.

0.18.0 (2017-02-19)

Features:

0.17.4 (2017-02-16)

Bug fixes:

  • [apispec.ext.marshmallow]: Fix corruption of Schema._declared_fields when serializing an APISpec (:issue:`107`). Thanks :user:`serebrov` for the catch and patch.

0.17.3 (2017-01-21)

Bug fixes:

  • [apispec.ext.marshmallow]: Fix behavior when passing Schema instances to APISpec.definition. The Schema's class will correctly be registered as a an available ref (:issue:`84`). Thanks :user:`lafrech` for reporting and for the PR.

0.17.2 (2017-01-03)

Bug fixes:

0.17.1 (2016-11-19)

Bug fixes:

  • [apispec.ext.marshmallow]: Prevent unnecessary warning when generating specs for marshmallow Schema's with autogenerated fields (:issue:`95`). Thanks :user:`khorolets` reporting and for the PR.
  • [apispec.ext.marshmallow]: Correctly translate Length validator to minItems and maxItems for array-type fields (Nested and List) (:issue:`97`). Thanks :user:`YuriHeupa` for reporting and for the PR.

0.17.0 (2016-10-30)

Features:

  • [apispec.ext.marshmallow]: Add support for properties that start with x-. Thanks :user:`martinlatrille` for the PR.

0.16.0 (2016-10-12)

Features:

0.15.0 (2016-10-02)

Features:

Bug fixes:

0.14.0 (2016-08-14)

Features:

0.13.0 (2016-07-03)

Features:

Bug fixes:

  • [apispec.ext.marshmallow]: Properly exclude nested dump-only fields from parameters (:issue:`82`). Thanks :user:`incognick` for the catch and patch.

Support:

  • Update tasks.py for compatibility with invoke>=0.13.0.

0.12.0 (2016-05-22)

Features:

Bug fixes:

0.11.1 (2016-05-02)

Bug fixes:

0.11.0 (2016-04-12)

Features:

  • Support vendor extensions on paths (:issue:`65`). Thanks :user:`lucascosta` for the PR.
  • Backwards-incompatible: Remove support for old versions (<=0.15.0) of webargs.

Bug fixes:

  • Fix error message when plugin does not have a setup() function.
  • [apispec.ext.marshmallow] Fix bug in introspecting self-referencing marshmallow fields, i.e. fields.Nested('self') (:issue:`55`). Thanks :user:`whoiswes` for reporting.
  • [apispec.ext.marshmallow] field2property no longer pops off location from a field's metadata (:issue:`67`).

Support:

  • Lots of new docs, including a User Guide and improved extension docs.

0.10.1 (2016-04-09)

Note: This version is a re-upload of 0.10.0. There is no 0.10.0 release on PyPI.

Features:

Bug fixes:

  • Compatibility fix with marshmallow>=2.7.0 (:issue:`64`).
  • Fix bug that raised error for Swagger parameters that didn't include the in key (:issue:`63`).

Big thanks :user:`lucascosta` for all these changes.

0.9.1 (2016-03-17)

Bug fixes:

0.9.0 (2016-03-13)

Features:

Bug fixes:

  • Fix bug in marshmallow extension where metadata was being lost when converting marshmallow Schemas when many=False. Thanks again :user:`martinlatrille`.

Other changes:

  • Remove duplicate SWAGGER_VERSION from api.ext.marshmallow.swagger.

Support:

  • Update docs to reflect rename of Swagger to OpenAPI.

0.8.0 (2016-03-06)

Features:

  • apispec.ext.marshmallow.swagger.schema2jsonschema properly introspects Schema instances when many=True (:issue:`53`). Thanks :user:`frol` for the PR.

Bug fixes:

  • Fix error reporting when an invalid object is passed to schema2jsonschema or schema2parameters (:issue:`52`). Thanks again :user:`frol`.

0.7.0 (2016-02-11)

Features:

  • APISpec.add_path accepts Path objects (:issue:`49`). Thanks :user:`Trii` for the suggestion and the implementation.

Bug fixes:

  • Use correct field name in "required" array when load_from and dump_to are used (:issue:`48`). Thanks :user:`benbeadle` for the catch and patch.

0.6.0 (2016-01-04)

Features:

  • Add APISpec#add_parameter for adding common Swagger parameter objects. Thanks :user:`jta`.
  • The field name in a spec will be adjusted if a Field's load_from and dump_to attributes are the same. :issue:`43`. Thanks again :user:`jta`.

Bug fixes:

0.5.0 (2015-12-13)

  • schema2jsonschema and schema2parameters can introspect a marshmallow Schema instance as well as a Schema class (:issue:`37`). Thanks :user:`frol`.
  • Backwards-incompatible: The first argument to schema2jsonschema and schema2parameters was changed from schema_cls to schema.

Bug fixes:

  • Handle conflicting signatures for plugin helpers. Thanks :user:`AndrewPashkin` for the catch and patch.

0.4.2 (2015-11-23)

  • Skip dump-only fields when dump=False is passed to schema2parameters and fields2parameters. Thanks :user:`frol`.

Bug fixes:

  • Raise SwaggerError when validate_swagger fails. Thanks :user:`frol`.

0.4.1 (2015-10-19)

  • Correctly pass dump parameter to field2parameters.

0.4.0 (2015-10-18)

0.3.0 (2015-10-02)

  • Rename and repackage as "apispec".
  • Support enum field of JSON Schema based on OneOf and ContainsOnly validators.

0.2.0 (2015-09-27)

  • Add schema2parameters, fields2parameters, and field2parameters.
  • Removed Fixed from swagger.FIELD_MAPPING for compatibility with marshmallow>=2.0.0.

0.1.0 (2015-09-13)

  • First release.