Skip to content

Latest commit

 

History

History
357 lines (268 loc) · 11.5 KB

CHANGELOG.rst

File metadata and controls

357 lines (268 loc) · 11.5 KB
Raw

Changelog

.. currentmodule:: flask_restplus

Current

  • Ensure that exceptions raised in error handler, including programming errors, are logged (:issue:`705`, :pr:`706`)
  • Import the ABCs from 'collections.abc' instead of 'collections' by default as it is deprecated since Python3.7, and in 3.8 it will stop working. Python2.7 is still supported though.
  • Fix illegal characters in JSON references to model names (:issue:`651`)
  • Support envelope parameter in Swagger documentation (:pr:`390`)

0.13.0 (2019-08-12)

  • Add new Wildcard fields (:pr:`255`)
  • Fix ABC deprecation warnings (:pr:`580`)
  • Fix @api.expect(..., validate=False) decorators for an :class:`Api` where validate=True is set on the constructor (:issue:`609`, :pr:`610`)
  • Ensure basePath is always a path
  • Hide Namespaces with all hidden Resources from Swagger documentation
  • Per route Swagger documentation for multiple routes on a Resource
  • Fix Swagger duplicate mapping key problem from conflicts between response codes given as string or integer (:issue`661`)

0.12.1 (2018-09-28)

  • Fix missing changelog inprevious release
  • Ensure definitions with both $ref and description (or other property) output is valid (using allOf)
  • Added initial specifications schemas and validation support
  • Ensure empty enums are not serialized (to have a valid specification)

0.12.0 (2018-09-27)

0.11.0 (2018-05-16)

Breaking changes

  • Drop python 2.6 support
  • Improve header handling (:issue:`119`):
    • @api.header only document response headers on all responses
    • @api.response accept an optionnal headers argument to document response specific headers
    • request header are handled by the @api.expect decorator

0.10.1 (2017-03-04)

0.10.0 (2017-02-12)

  • Allows to specify a custom mount path on namespace registration
  • Allow to express models as raw schemas
  • Upgraded to Swagger-UI 2.2.6
  • Support Swagger-UI translations
  • Fix prefix trailing slash stripping in Postman doc generation (:issue:`232`)
  • Add validation for lists in the expect decorator (:issue:`231`)

0.9.2 (2016-04-22)

  • Same version but a PyPI bug force reupload.

0.9.1 (2016-04-22)

  • Added some Swagger-UI Oauth configurations:
    • SWAGGER_UI_OAUTH_CLIENT_ID
    • SWAGGER_UI_OAUTH_REALM
    • SWAGGER_UI_OAUTH_APP_NAME
  • Expose type: object in Swagger schemas (:issue:`157`)
  • Fix an issue with error handlers (:issue:`141`)
  • Fix an issue with Postman export when using OAuth (:issue:`151`)
  • Miscellenaous code and documentation fixes
  • Remove last flask-restful references (unless needed) and add missing attributions

0.9.0 (2016-02-22)

0.8.6 (2015-12-26)

0.8.5 (2015-12-12)

0.8.4 (2015-12-07)

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
  • Added fields mask support through header (see: :doc:`Fields Masks Documentation </mask>`)
  • Expose flask_restful.inputs module on flask_restplus.inputs
  • Added support for some missing fields and attributes:
    • host root field (filed only if SERVER_NAME config is set)
    • custom tags root field
    • exclusiveMinimum and exclusiveMaximum number field attributes
    • multipleOf number field attribute
    • minLength and maxLength string field attributes
    • pattern string field attribute
    • minItems and maxItems list field attributes
    • uniqueItems 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 the SWAGGER_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 on String fields
    • Added api.inherit() method
  • 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 and allow_null for NestedField
  • 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 now description
    • nickname documentation is now id
    • new responses declaration format
  • Added missing body parameter to document body input
  • Last release before Flask-Restful 0.3+ compatibility switch

0.2.4

  • Handle description and required attributes on fields.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 and default
  • Initial support for model in RequestParser

0.1.3

  • Fix Api.marshal() shortcut

0.1.2

  • Added Api.marshal_with() and Api.marshal_list_with() decorators
  • Added Api.marshal() shortcut

0.1.1

  • Use zip_safe=False for proper packaging.

0.1

  • Initial release