Releases: marshmallow-code/flask-smorest
Releases · marshmallow-code/flask-smorest
0.10.0
- Backwards-incompatible: Don't prefix all routes in the spec with
APPLICATION_ROOT
. If using OpenAPI v2, setAPPLICATION_ROOT
as
basePath
. If using OpenAPI v3, the user should specifyservers
manually. - Backwards-incompatible: In testing and debug modes,
verify_check_etag
not
only logs a warning but also raisesCheckEtagNotCalledError
ifcheck_etag
is not called in a resource that needs it.
0.9.2
0.9.1
0.9.0
Features:
- Backwards-incompatible: When pagination parameters are out of range, the
API does not return a404
error anymore. It returns a200
code with an
empty list and pagination metadata (:pr:10
). - Backwards-incompatible: Remove dependency on python-dateutil. This is an
optional marshmallow dependency. Whether it is needed to deserialize date,
time, or datetime strings depends on the application. - Rework internal features by using mixin classes. This makes the code cleaner
and adds customization possibilities (:issue:9
). - Backwards-incompatible:
DEFAULT_PAGINATION_PARAMETERS
is a class
attribute ofBlueprint
. - Backwards-incompatible: When no
Page
class is passed topagination
,
(i.e. when doing pagination in view function), the pagination parameters are
passed as aPaginationParameters
object. The item count must be passed by
setting it asitem_count
attribute of thePaginationParameters
object. Theset_item_count
function is removed. - The pagination header name can be configured by overriding
PAGINATION_HEADER_FIELD_NAME
class attribute ofBlueprint
. If set to
None
, no pagination header is added to the response. - Backwards-incompatible: The
paginate
decorator doesn't use
NestedQueryFlaskParser
by default. It is renamed as
NestedQueryArgsParser
and it can be used by overriding
Blueprint.ARGUMENTS_PARSER
. - Backwards-incompatible: Drop Flask 0.x support. Flask>=1.0 is now required.
- Default error handler is registered for generic
HTTPException
. Other
extensions may register other handlers for specific exceptions or codes
(:pr:12
).
0.8.1
0.8.0
Features:
- Add
API_SPEC_OPTIONS
app config parameter. Thanks :user:xalioth
for the
suggestion. - Backwards-incompatible:
Api
accepts aspec_kargs
parameter, passed
as kwargs to the internalAPISpec
instance.spec_plugins
is removed,
plugins shall be passed asspec_kwargs={'plugins': [...]}
. - Backwards-incompatible: Get
summary
anddescription
from docstrings
(:pr:5
). - Add support for marshmallow 3.0.0b13. 2.x and 3b are now supported.
- Add support for apispec 1.0.0b2. 0.x and 1b are now supported.
Bug fixes:
- Document response schema correctly when using OpenAPI 3 (:issue:
8
). Thanks
:user:ffarella
for reporting.
0.7.0
0.6.1
0.6.0
Features:
- Backwards-incompatible: Use apispec 0.39.0 plugin class interface.
- Backwards-incompatible: Expose APISpec's
register_field
andregister_converter methods
fromApi
object.Api.register_converter
signature is modified to makename
parameter optional. - Pass extra apispec plugins to internal APISpec instance.
- Backwards-incompatible: Drop officiel support for Python 3.4.