Skip to content

Latest commit

 

History

History
332 lines (196 loc) · 10.6 KB

CHANGELOG.rst

File metadata and controls

332 lines (196 loc) · 10.6 KB
Raw

Changelog

0.23.0 (2017-08-03)

  • Pass operations constructed by plugins to downstream marshmallow plugin (138). Thanks yoichi.
  • [apispec.ext.marshmallow] Generate parameter specification from marshmallow Schemas (127). Thanks ewalker11 for the suggestion thanks yoichi for the PR.
  • [apispec.ext.flask] Add support for Flask MethodViews (85, 125). Thanks lafrech and boosh for the suggestion. Thanks djanderson and yoichi for the PRs.

0.22.3 (2017-07-16)

  • Release wheel distribution.

0.22.2 (2017-07-12)

Bug fixes:

  • [apispec.ext.marshmallow]: Properly handle callable default values in output spec (131). Thanks NightBlues.

0.22.1 (2017-06-25)

Bug fixes:

  • [apispec.ext.marshmallow]: Include default in output spec when False is the default for a Boolean field (130). Thanks nebularazer.

0.22.0 (2017-05-30)

Features:

  • [apispec.ext.bottle] Added bottle plugin (128). Thanks lucasrc.

0.21.0 (2017-04-21)

Features:

  • [apispec.ext.marshmallow] Sort list of required field names in generated spec (124). Thanks dradetsky.

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 (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 (122). Thanks martinlatrille for the PR.

Other changes:

  • [apispec.ext.marshmallow] Backwards-incompatible: Remove dump parameter from schema2parameters, fields2parameters, and field2parameter (114). Thanks lafrech and frol for the feedback and lafrech for the PR.

0.19.0 (2017-03-05)

Features:

  • [apispec.core]: Add extra_fields parameter to APISpec.definition (110). Thanks lafrech for the PR.
  • [apispec.ext.marshmallow]: Preserve the order of choices (113). Thanks frol for the PR.

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, lafrech.
  • [apispec.ext.marshmallow]: Allow additional properties when translating Nested fields using allOf (108). Thanks lafrech for the suggestion and the PR.
  • [apispec.ext.marshmallow]: Respect dump_only and load_only specified in class Meta (84). Thanks lafrech for the fix.

Other changes:

  • Drop support for Python 3.3.

0.18.0 (2017-02-19)

Features:

  • [apispec.ext.marshmallow]: Translate allow_none on Fields to x-nullable (66). Thanks lafrech.

0.17.4 (2017-02-16)

Bug fixes:

  • [apispec.ext.marshmallow]: Fix corruption of Schema._declared_fields when serializing an APISpec (107). Thanks 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 (84). Thanks lafrech for reporting and for the PR.

0.17.2 (2017-01-03)

Bug fixes:

  • [apispec.ext.tornado]: Remove usage of inspect.getargspec for Python >= 3.3 (102). Thanks matijabesednik.

0.17.1 (2016-11-19)

Bug fixes:

  • [apispec.ext.marshmallow]: Prevent unnecessary warning when generating specs for marshmallow Schema's with autogenerated fields (95). Thanks khorolets reporting and for the PR.
  • [apispec.ext.marshmallow]: Correctly translate Length validator to minItems and maxItems for array-type fields (Nested and List) (97). Thanks 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 martinlatrille for the PR.

0.16.0 (2016-10-12)

Features:

  • [apispec.core]: Allow description to be passed to APISpec.definition (93). Thanks martinlatrille.

0.15.0 (2016-10-02)

Features:

  • [apispec.ext.marshmallow]: Allow 'query' to be passed as a field location (89). Thanks lafrech.

Bug fixes:

  • [apispec.ext.flask]: Properly strip off basePath when APPLICATION_ROOT is set on a Flask app's config (78). Thanks deckar01 for reporting and asteinlein for the PR.

0.14.0 (2016-08-14)

Features:

  • [apispec.core]: Maintain order in which paths are added to a spec (87). Thanks ranjanashish for the PR.
  • [apispec.ext.marshmallow]: Maintain order of fields when ordered=True on Schema. Thanks again ranjanashish.

0.13.0 (2016-07-03)

Features:

  • [apispec.ext.marshmallow]: Add support for Dict field (80). Thanks ericb for the PR.
  • [apispec.ext.marshmallow]: dump_only fields add readOnly flag in OpenAPI spec (79). Thanks itajaja for the suggestion and PR.

Bug fixes:

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

Support:

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

0.12.0 (2016-05-22)

Features:

  • [apispec.ext.marshmallow]: Inspect validators to set additional attributes (66). Thanks deckar01 for the PR.

Bug fixes:

  • [apispec.ext.marshmallow]: Respect partial parameters on Schemas (74). Thanks incognick for reporting.

0.11.1 (2016-05-02)

Bug fixes:

  • [apispec.ext.flask]: Flask plugin respects APPLICATION_ROOT from app's config (69). Thanks deckar01 for the catch and patch.
  • [apispec.ext.marshmallow]: Fix support for plural schema instances (71). Thanks again deckar01.

0.11.0 (2016-04-12)

Features:

  • Support vendor extensions on paths (65). Thanks 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') (55). Thanks whoiswes for reporting.
  • [apispec.ext.marshmallow] field2property no longer pops off location from a field's metadata (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:

  • Add Tornado extension (62).

Bug fixes:

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

Big thanks lucascosta for all these changes.

0.9.1 (2016-03-17)

Bug fixes:

  • Fix generation of metadata for Nested fields (61). Thanks martinlatrille.

0.9.0 (2016-03-13)

Features:

  • Add APISpec.add_tags method for adding Swagger tags. Thanks martinlatrille.

Bug fixes:

  • Fix bug in marshmallow extension where metadata was being lost when converting marshmallow Schemas when many=False. Thanks again 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 (53). Thanks frol for the PR.

Bug fixes:

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

0.7.0 (2016-02-11)

Features:

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

Bug fixes:

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

0.6.0 (2016-01-04)

Features:

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

Bug fixes:

  • Fix bug that caused a stack overflow when adding nested Schemas to an APISpec (31, 41). Thanks alapshin and itajaja for reporting. Thanks itajaja for the patch.

0.5.0 (2015-12-13)

  • schema2jsonschema and schema2parameters can introspect a marshmallow Schema instance as well as a Schema class (37). Thanks 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 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 frol.

Bug fixes:

  • Raise SwaggerError when validate_swagger fails. Thanks frol.

0.4.1 (2015-10-19)

  • Correctly pass dump parameter to field2parameters.

0.4.0 (2015-10-18)

  • Add dump parameter to field2property (32).

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.