Skip to content

Releases: marshmallow-code/flask-smorest

0.5.1

18 Jun 11:46
Compare
Choose a tag to compare

Features:

  • ReDoc: Use unpkg CDN for 2.x version.

0.5.0

05 Jun 16:06
Compare
Choose a tag to compare

Features:

  • Backwards-incompatible: In Blueprint.route, the endpoint name defaults to the function name with the case unchanged. Before this change, the name was lowercased.
  • Backwards-incompatible: Pagination is now managed by dedicated Blueprint.paginate decorator.
  • Add etag.INCLUDE_HEADERS to specify which headers to use for ETag computation (defaults to ['X-Pagination']).
  • In verify_check_etag, endpoint name is added to the warning message.

0.4.2

27 Apr 13:41
Compare
Choose a tag to compare

Bugfixes:

  • Pagination: don't crash if item_count is not set, just log a warning and set no pagination header.
  • API spec: Fix leading/trailing slash issues in api-docs Blueprint. Fixes compatibility with Flask 1.0.

0.4.1

17 Apr 12:31
Compare
Choose a tag to compare

Features:

  • Allow multiple calls to Blueprint.arguments on a view function.
  • Enforce order of fields in PaginationParametersSchema and PaginationMetadataSchema.
  • Minor improvements in test_examples.py.

0.4.0

05 Apr 13:14
Compare
Choose a tag to compare

Features:

  • Backwards-incompatible: The case of a parameter both in URL and in arguments Schema is now unsupported.
  • Backwards-incompatible: By default, Schema parameter passed in Blueprint.arguments is documented as required.
  • Backwards-incompatible: APISpec.register_field now uses apispec API. It must be passed a (type, format) couple or an amready registered Field class (this includes base marshmallow Fields. When using (type, format), format doesn't default to None anymore.
  • Preserve order when serving the spec file:
    • Fields are printed in declaration order if Schema.Meta.ordered is True
    • Methods in a method view are printed in this order: ['OPTIONS', 'HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE']
    • Paths are added in declaration order

Bugfixes:

  • Document response as array when using paginate_with.

0.3.0

02 Mar 12:27
Compare
Choose a tag to compare

Features:

  • App leading and trailing / to OPENAPI_URL_PREFIX if missing.

Bugfixes:

  • Fix OpenAPI docs URL paths
  • Backwards-incompatible: Change default URL path for OpenAPI JSON to 'openapi.json'
  • Backwards-incompatible: Blueprint.route(self, rule, **options) matches flask's Blueprint signature

0.2.0

02 Mar 09:32
Compare
Choose a tag to compare

Features:

  • format parameter in register_converter and register_field is now optional and defaults to None.
  • APISpec inherits from original apispec.APISpec.
  • Backwards-incompatible: The internal APISpec instance is now exposed as public attribute spec of Api. register_converter and register_field are not proxied anymore by Api and must be called on spec.
  • Backwards-incompatible: Api.register_converter takes a name parameter and registers a converter in the Flask application as well as in its internal APISpec instance.
  • Backwards-incompatible: Api.register_spec_plugin is removed. api.register_spec_plugin(...) shall be replaced with api.spec.setup_plugin(...)

0.1.1

16 Feb 21:27
Compare
Choose a tag to compare
Bump version: 0.1.0 → 0.1.1

0.1.0

16 Feb 17:17
Compare
Choose a tag to compare
Rename marshal.py into response.py