Releases: marshmallow-code/flask-smorest
Releases · marshmallow-code/flask-smorest
0.5.1
0.5.0
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
0.4.1
0.4.0
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 registeredField
class (this includes base marshmallowFields
. When using(type, format)
,format
doesn't default toNone
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
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)
matchesflask
'sBlueprint
signature
0.2.0
Features:
format
parameter inregister_converter
andregister_field
is now optional and defaults toNone
.- APISpec inherits from original apispec.APISpec.
- Backwards-incompatible: The internal
APISpec
instance is now exposed as public attributespec
ofApi
.register_converter
andregister_field
are not proxied anymore byApi
and must be called onspec
. - Backwards-incompatible:
Api.register_converter
takes aname
parameter and registers a converter in theFlask
application as well as in its internalAPISpec
instance. - Backwards-incompatible:
Api.register_spec_plugin
is removed.api.register_spec_plugin(...)
shall be replaced withapi.spec.setup_plugin(...)