Skip to content

Latest commit

 

History

History
366 lines (258 loc) · 11.6 KB

changelog.rst

File metadata and controls

366 lines (258 loc) · 11.6 KB
Raw

Changelog

1.9.0

Release date: Jun 16, 2018

  • ADDED: added DEFAULT_GENERATOR_CLASS setting and --generator-clas argument to the generate_swagger management command (:issue:`140`)
  • FIXED: fixed wrongly required 'count' response field on CursorPagination (:issue:`141`)
  • FIXED: fixed some cases where swagger_extra_fields would not be handlded (:pr:`142`)
  • FIXED: fixed crash when encountering coreapi.Fieldss without a schema (:issue:`143`)

1.8.0

Release date: Jun 01, 2018

1.7.4

Release date: May 14, 2018

  • IMPROVED: updated swagger-ui to version 3.14.2
  • IMPROVED: updated ReDoc to version 2.0.0-alpha.20
  • FIXED: ignore None return from get_operation to avoid empty Path objects in output
  • FIXED: request body is now allowed on DELETE endpoints (:issue:`118`)

1.7.3

Release date: May 12, 2018

  • FIXED: views whose __init__ methods throw exceptions will now be ignored during endpoint enumeration

1.7.2

Release date: May 12, 2018

  • FIXED: fixed generation of default SECURITY_REQUIREMENTS to match documented behaviour
  • FIXED: ordering of SECURITY_REQUIREMENTS and SECURITY_DEFINITIONS is now stable

1.7.1

Release date: May 05, 2018

  • IMPROVED: updated swagger-ui to version 3.14.1
  • IMPROVED: set swagger-ui showCommonExtensions to True by default and add SHOW_COMMON_EXTENSIONS setting key
  • IMPROVED: set min_length=1 when allow_blank=False (:pr:`112`, thanks to :ghuser:`elnappo`)
  • FIXED: made documentation ordering of SwaggerDict extra attributes stable

1.7.0

Release date: Apr 27, 2018

  • ADDED: added integration with djangorestframework-recursive (:issue:`109`, :pr:`110`, thanks to :ghuser:`rsichny`)

    NOTE: in order for this to work, you will have to add the new drf_yasg.inspectors.RecursiveFieldInspector to your DEFAULT_FIELD_INSPECTORS array if you changed it from the default value

  • FIXED: SchemaRef now supports cyclical references via the ignore_unresolved argument

1.6.2

Release date: Apr 25, 2018

  • IMPROVED: updated swagger-ui to version 3.13.6
  • IMPROVED: switched ReDoc to version 2.0.0-alpha.17 (was 1.21.2); fixes :issue:`107`
  • FIXED: made documentation ordering of parameters stable for urls with multiple parameters (:issue:`105`, :pr:`106`)
  • FIXED: fixed crash when using a model ChoiceField of unknown child type

1.6.1

Release date: Apr 01, 2018

  • ADDED: added SUPPORTED_SUBMIT_METHODS swagger-ui setting

1.6.0

Release date: Mar 24, 2018

  • IMPROVED: OAUTH2_REDIRECT_URL will now default to the built in oauth2-redirect.html file

1.5.1

Release date: Mar 18, 2018

  • IMPROVED: updated swagger-ui to version 3.13.0
  • FIXED: fixed a crash caused by serializers.OneToOneRel (:pr:`81`, thanks to :ghuser:`ko-pp`)

1.5.0

Release date: Mar 12, 2018

  • IMPROVED: serializers.HiddenField are now hidden (:issue:`78`, :pr:`79`, thanks to :ghuser:`therefromhere`)

    NOTE: in order for this to work, you will have to add the new drf_yasg.inspectors.HiddenFieldInspector to your DEFAULT_FIELD_INSPECTORS array if you changed it from the default value

  • IMPROVED: type of model field is now detected for serializers.SlugRelatedField with read_only=True (:issue:`82`, :pr:`83`, thanks to :ghuser:`therefromhere`)

1.4.7

Release date: Mar 05, 2018

  • FIXED: prevent crashes caused by attempting to delete object attributes which do not exist in the first place (:issue:`76`)

1.4.6

Release date: Mar 05, 2018

  • IMPROVED: updated swagger-ui to version 3.12.0
  • IMPROVED: updated ReDoc to version 1.21.2

1.4.5

Release date: Mar 05, 2018

  • FIXED: fixed an issue with modification of swagger_auto_schema arguments in-place during introspection, which would sometimes cause an incomplete Swagger document to be generated after the first pass (:issue:`74`, :pr:`75`)

1.4.4

Release date: Feb 26, 2018

  • IMPROVED: type for ChoiceField generated by a ModelSerializer from a model field with choices=... will now be set according to the associated model field (:issue:`69`)
  • FIXED: lookup_field and lookup_value_regex on the same ViewSet will no longer trigger an exception (:issue:`68`)

1.4.3

Release date: Feb 22, 2018

  • FIXED: added a missing assignment that would cause the default argument to openapi.Parameter.__init__ to be ignored

1.4.2

Release date: Feb 22, 2018

  • FIXED: fixed a bug that causes a ModelViewSet generated from models with nested ForeignKey to output models named Nested into the definitions section (:issue:`59`, :pr:`65`)
  • FIXED: Response objects without a schema are now properly handled when passed through swagger_auto_schema (:issue:`66`)

1.4.1

Release date: Feb 21, 2018

  • FIXED: the coerce_to_string is now respected when setting the type, default value and min/max values of DecimalField in the OpenAPI schema (:issue:`62`)
  • FIXED: error responses from web UI views are now rendered with TemplateHTMLRenderer instead of throwing confusing errors (:issue:`58`)
  • IMPROVED: updated swagger-ui to version 3.10.0
  • IMPROVED: updated ReDoc to version 1.21.0

1.4.0

Release date: Feb 04, 2018

  • ADDED: added settings for OAuth2 client configuration in swagger-ui (:issue:`53`)
  • IMPROVED: updated swagger-ui to version 3.9.3

1.3.1

Release date: Jan 24, 2018

  • FIXED: fixed a bug that would sometimes cause endpoints to wrongly be output as form operations (:issue:`50`)
  • IMPROVED: added generation of produces based on renderer classes
  • IMPROVED: added generation of top-level consumes and produces based on DEFAULT_PARSER_CLASSES and DEFAULT_RENDERER_CLASSES (:issue:`48`)

1.3.0

Release date: Jan 23, 2018

  • ADDED: security requirements are now correctly set and can be customized; this should fix problems related to authentication in swagger-ui Try it out! (:issue:`50`, :pr:`54`)
  • IMPROVED: updated swagger-ui to version 3.9.2
  • IMPROVED: updated ReDoc to version 1.20.0
  • FIXED: fixed an exception caused by a warning in get_path_from_regex (:pr:`49`, thanks to :ghuser:`blueyed`)

1.2.2

Release date: Jan 12, 2018

1.2.1

Release date: Jan 12, 2018

  • Fixed deployment issues

1.2.0

Release date: Jan 12, 2018 (missing from PyPI due to deployment issues)

  • ADDED: basePath is now generated by taking into account the SCRIPT_NAME variable and the longest common prefix of API urls (:issue:`37`, :pr:`42`)
  • IMPROVED: removed inline scripts and styles from bundled HTML templates to increase CSP compatibility
  • IMPROVED: improved validation errors and added more assertion sanity checks (:issue:`37`, :issue:`40`)
  • IMPROVED: improved handling of NamespaceVersioning by excluding endpoints of differing versions (i.e. when accesing the schema view for v1, v2 endpoints will not be included in swagger)

1.1.3

Release date: Jan 02, 2018

  • FIXED: schema view cache will now always Vary on the Cookie and Authentication (the Vary header was previously only added if public was set to True) - this fixes issues related to Django authentication in swagger-ui and CurrentUserDefault values in the schema

1.1.2

Release date: Jan 01, 2018

  • IMPROVED: updated swagger-ui to version 3.8.1
  • IMPROVED: removed some unneeded static files

1.1.1

Release date: Dec 27, 2017

1.1.0

Release date: Dec 27, 2017

1.0.6

Release date: Dec 23, 2017

  • FIXED: Swagger UI "Try it out!" should now work with Django login
  • FIXED: callable default values on serializer fields will now be properly called (:pr:`24`, :issue:`25`)
  • IMPROVED: updated swagger-ui to version 3.8.0
  • IMPROVED: PrimaryKeyRelatedField and SlugRelatedField will now have appropriate types based on the related model (:pr:`26`)
  • IMPROVED: mock views will now have a bound request even with public=False (:pr:`23`)

1.0.5

Release date: Dec 18, 2017

  • FIXED: fixed a crash caused by having read-only Serializers nested by reference
  • FIXED: removed erroneous backslashes in paths when routes are generated using Django 2 path()
  • IMPROVED: updated swagger-ui to version 3.7.0
  • IMPROVED: FileField is now generated as an URL or file name in response Schemas (:pr:`21`, thanks to :ghuser:`h-hirokawa`)

1.0.4

Release date: Dec 16, 2017

1.0.3

Release date: Dec 15, 2017

  • FIXED: fixed bug that caused schema views returned from cache to fail (:issue:`14`)
  • FIXED: disabled automatic generation of response schemas for form operations to avoid confusing errors caused by attempting to shove file parameters into Schema objects

1.0.2

Release date: Dec 13, 2017

  • First published version