Changelog¶
0.8.3 (2015-12-05)¶
- Drop/merge flask-restful fields
- Drop/merge flask-restplus inputs
- Update Swagger-UI to version 2.1.3
- Use minified version of Swagger-UI if
DEBUG=False
- Blueprint subdomain support (static only)
- Added support for default fields mask
0.8.2 (2015-12-01)¶
- Skip unknown fields in mask when applied on a model
- Added * token to fields mask (all remaining fields)
- Ensure generated endpoints does not collide
- Drop/merge flask-restful Api.handler_error()
0.8.1 (2015-11-27)¶
- Refactor Swagger UI handling:
- allow to register a custom view with
@api.documentation
- allow to register a custom URL with the
doc
parameter - allow to disable documentation with
doc=False
- allow to register a custom view with
Added fields mask support through header (see: Fields Masks Documentation)
Expose
flask_restful.inputs
module onflask_restplus.inputs
- Added support for some missing fields and attributes:
host
root field (filed only ifSERVER_NAME
config is set)- custom
tags
root field exclusiveMinimum
andexclusiveMaximum
number field attributesmultipleOf
number field attributeminLength
andmaxLength
string field attributespattern
string field attributeminItems
andmaxItems
list field attributesuniqueItems
list field attribute
Allow to override the default error handler
Fixes
0.8.0¶
- Added payload validation (initial implementation based on jsonschema)
- Added
@api.deprecated
to mark resources or methods as deprecated - Added
@api.header
decorator shortcut to document headers - Added Postman export
- Fix compatibility with flask-restful 0.3.4
- Allow to specify an exemple a custom fields with
__schema_example__
- Added support for
PATCH
method in Swagger UI - Upgraded to Swagger UI 2.1.2
- Handle enum as callable
- Allow to configure
docExpansion
with theSWAGGER_UI_DOC_EXPANSION
parameter
0.7.2¶
- Compatibility with flask-restful 0.3.3
- Fix action=append handling in RequestParser
- Upgraded to SwaggerUI 2.1.8-M1
- Miscellaneous fixes
0.7.1¶
- Fix
@api.marshal_with_list()
keyword arguments handling.
0.7.0¶
- Expose models and fields schema through the
__schema__
attribute - Drop support for model as class
- Added
@api.errorhandler()
to register custom error handlers - Added
@api.response''
shortcut decorator - Fix list nested models missing in definitions
0.6.0¶
Python 2.6 support
- Experimental polymorphism support (single inheritance only)
- Added
Polymorph
field - Added
discriminator
attribute support onString
fields - Added
api.inherit()
method
- Added
Added
ClassName
field
0.5.1¶
- Fix for parameter with schema (do not set type=string)
0.5.0¶
- Allow shorter syntax to set operation id:
@api.doc('my-operation')
- Added a shortcut to specify the expected input model:
@api.expect(my_fields)
- Added
title
attribute to fields - Added
@api.extend()
to extend models - Ensure coherence between
required
andallow_null
forNestedField
- Support list of primitive types and list of models as body
- Upgraded to latest version of Swagger UI
- Fixes
0.4.2¶
- Rename apidoc blueprint into restplus_doc to avoid collisions
0.4.1¶
- Added
SWAGGER_VALIDATOR_URL
config parameter - Added
readonly
field parameter - Upgraded to latest version of Swagger UI
0.4.0¶
- Port to Flask-Restful 0.3+
- Use the default Blueprint/App mecanism
- Allow to hide some ressources or methods using
@api.doc(False)
or@api.hide
- Allow to globally customize the default operationId with the
default_id
callable parameter
0.3.0¶
- Switch to Swagger 2.0 (Major breakage)
notes
documentation is nowdescription
nickname
documentation is nowid
- new responses declaration format
Added missing
body
parameter to documentbody
inputLast release before Flask-Restful 0.3+ compatibility switch
0.2.4¶
- Handle
description
andrequired
attributes onfields.List
0.2.3¶
- Fix custom fields registeration
0.2.2¶
- Fix model list in declaration
0.2.1¶
- Allow to type custom fields with
Api.model
- Handle custom fields into
fieds.List
0.2¶
- Upgraded to SwaggerUI 0.2.22
- Support additional field documentation attributes:
required
,description
,enum
,min
,max
anddefault
- Initial support for model in RequestParser
0.1.3¶
- Fix
Api.marshal()
shortcut
0.1.2¶
- Added
Api.marshal_with()
andApi.marshal_list_with()
decorators - Added
Api.marshal()
shortcut
0.1.1¶
- Use
zip_safe=False
for proper packaging.
0.1¶
- Initial release