Drf Yasg Versions Save

Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.

1.16.1

4 years ago
  • FIXED: fixed DRF 3.10 compatibility (#408, #410, #411)
  • IMPROVED: better enum type detection for nested ChoiceFields (#400)

1.16.0

4 years ago

Release date: Jun 13, 2019

  • ADDED: added reference_resolver_class attribute hook to SwaggerAutoSchema (#350)
  • ADDED: added operation_keys attribute to SwaggerAutoSchema, along with __init__ parameter (#355)
  • FIXED: fixed potential crash on issubclass check without isclass check

1.15.1

4 years ago
  • IMPROVED: updated swagger-ui to version 3.22.3
  • IMPROVED: updated ReDoc to version 2.0.0-rc.8-1
  • FIXED: fixed an issue with inspection of typing hints on Python 2.7 (#363)
  • FIXED: fixed an issue with inspection of typing hints on Python 3.7 (#371)

Python 3.4 support has been dropped!

1.15.0

5 years ago
  • ADDED: added is_list_view and has_list_response extension points to SwaggerAutoSchema (#331)
  • IMPROVED: updated swagger-ui to version 3.22.0
  • IMPROVED: updated ReDoc to version 2.0.0-rc.4
  • FIXED: ListModelMixin will now always be treated as a list view (#306)
  • FIXED: non-primtive values in field choices will now be handled properly (#340)

🎉 400 commits 🎉

1.14.0

5 years ago
  • IMPROVED: updated swagger-ui to version 3.21.0
  • FIXED: implicit ref_name collisions will now throw an exception
  • FIXED: RecursiveField will now also work as a child of ListSerializer (#321)
  • FIXED: fixed minLength and maxLength for ListSerializer and ListField
  • FIXED: the items property of Schema, Parameter and Items objects was renamed to items_; this is a mildly breaking change and was needed to fix the collision with the items method of dict (#308)
  • REMOVED: the get_summary and get_description methods have been removed (previously deprecated in 1.12.0)

1.13.0

5 years ago
  • IMPROVED: type hint inspection is now supported for collections and Optional (#272)
  • IMPROVED: updated swagger-ui to version 3.20.5
  • IMPROVED: updated ReDoc to version 2.0.0-rc.2
  • DEPRECATED: quietly dropped support for the flex validator; it will still work if the library is installed, but the setup.py requirement was removed and the validator will be silently skipped if not installed (#285)

1.12.1

5 years ago
  • IMPROVED: updated ReDoc to version 2.0.0-rc.0
  • FIXED: management command will now correctly fall back to DEFAULT_VERSION for mock request
  • FIXED: fixed bad "raised exception during schema generation" warnings caused by missing self parameter

1.12.0

5 years ago
  • ADDED: get_security_definitions and get_security_requirements hooks to OpenAPISchemaGenerator
  • ADDED: added get_summary_and_description and split_summary_from_description extension points to SwaggerAutoSchema to allow for better customisation
  • IMPROVED: updated swagger-ui to version 3.20.4
  • IMPROVED: paginator next and previous fields are now marked as x-nullable (#263)
  • IMPROVED: added the tags argument to swagger_auto_schema (#259)
  • IMPROVED: type of enum will now be automatically detected from ChoiceField if all choices values are objects of the same Python class (#264)
  • IMPROVED: SwaggerValidationError details will now be logged and shown in the exception message
  • FIXED: user implementations of get_queryset, get_parsers and get_renderers will no longer be bypassed
  • FIXED: fixed handling of lazy objects in user-supplied values
  • FIXED: read_only serializer fields will be correctly ignored when generating form parameters (#261)
  • FIXED: fixed incorrect return type from UIRenderer (#268)
  • FIXED: fixed incosistent ordering of global securityDefinitions and security objects
  • DEPRECATED: the get_summary and get_description extension points have been deprecated in favor of the new get_summary_and_description, and will be removed in a future release

IMPORTANT PACKAGING NOTE

Starting with this version, the setup_requires argument was dropped from setup.py in favor of build-system.requires in pyproject.toml . This means that for correctly building or installing from sdist, you will need to use a PEP517/PEP518 compliant tool (tox>=3.3.0, setuptools>=40, pip>=10.0, pep517.build) or manually install the build requirements yourself (just setuptools and setuptools-scm, for now).

Additionally, for correct package version detection, a full git checkout is required when building (this was always the case). Building without .git or without setuptools-scm will result in a distribution with a version like drf-yasg-1!0.0.0.dev0+noscm.00000167d19bd859.

1.11.1

5 years ago
  • IMPROVED: updated swagger-ui to version 3.20.1
  • IMPROVED: updated ReDoc to version 2.0.0-alpha.41
  • FIXED: minLength and maxLength will now also work for ListSerializer in addition to ListField
  • FIXED: MultipleChoiceField will now use the multi collectionFormat where appropriate (#257)
  • FIXED: the format, pattern, enum, min_length and max_length attributes of coreschema.Schema will now be persited into the converted openapi.Parameter (#212, #233)

1.11.0

5 years ago
  • ADDED: PERSIST_AUTH, REFETCH_SCHEMA_WITH_AUTH, REFETCH_SCHEMA_ON_LOGOUT settings and related javascript implementation for persisting authentication data to swagger-ui localStorage
  • IMPROVED: UI-enabled views will now no longer generate the full specification document twice; the HTML part of the view will only generate a barebones Swagger object with no paths and definitions
  • IMPROVED: added the FETCH_SCHEMA_WITH_QUERY setting to enable fetching of the schema document using query parameters passed to the UI view (#208)
  • IMPROVED: added support for the very common x-nullable extension (#217)
  • IMPROVED: extensibility of some classes was improved by adding more extension points, together with more blocks for swagger-ui.html/redoc.html and some JavaScript hooks in swagger-ui-init.js
  • FIXED: removed usage of inspect.signature on python 2.7 (#222)