Releases: axnsan12/drf-yasg
Releases · axnsan12/drf-yasg
1.16.1
1.16.0
1.15.1
1.15.0
- ADDED: added
is_list_view
andhas_list_response
extension points toSwaggerAutoSchema
(#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
- 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 ofListSerializer
(#321) - FIXED: fixed
minLength
andmaxLength
forListSerializer
andListField
- FIXED: the
items
property ofSchema
,Parameter
andItems
objects was renamed toitems_
; this is a mildly breaking change and was needed to fix the collision with theitems
method ofdict
(#308) - REMOVED: the
get_summary
andget_description
methods have been removed (previously deprecated in 1.12.0)
1.13.0
- 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
1.12.0
- ADDED:
get_security_definitions
andget_security_requirements
hooks toOpenAPISchemaGenerator
- ADDED: added
get_summary_and_description
andsplit_summary_from_description
extension points toSwaggerAutoSchema
to allow for better customisation - IMPROVED: updated
swagger-ui
to version 3.20.4 - IMPROVED: paginator
next
andprevious
fields are now marked asx-nullable
(#263) - IMPROVED: added the
tags
argument toswagger_auto_schema
(#259) - IMPROVED: type of
enum
will now be automatically detected fromChoiceField
if allchoices
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
andget_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
andsecurity
objects - DEPRECATED: the
get_summary
andget_description
extension points have been deprecated in favor of the newget_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
- IMPROVED: updated
swagger-ui
to version 3.20.1 - IMPROVED: updated
ReDoc
to version 2.0.0-alpha.41 - FIXED:
minLength
andmaxLength
will now also work forListSerializer
in addition toListField
- FIXED:
MultipleChoiceField
will now use themulti
collectionFormat
where appropriate (#257) - FIXED: the
format
,pattern
,enum
,min_length
andmax_length
attributes ofcoreschema.Schema
will now be persited into the convertedopenapi.Parameter
(#212, #233)
1.11.0
- 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 nopaths
anddefinitions
- 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 inswagger-ui-init.js
- FIXED: removed usage of
inspect.signature
on python 2.7 (#222)