Releases: axnsan12/drf-yasg
Releases · axnsan12/drf-yasg
1.10.2
- ADDED: added the
DISPLAY_OPERATION_ID
swagger-ui
setting - IMPROVED: updated
ReDoc
to version 2.0.0-alpha.38 - IMPROVED: Operation summary will now be parsed from multi-line view method docstrings (#205)
- IMPROVED:
pattern
will now work on any field with aRegexValidator
(would previously not appear on fields with special formats such asEmailField
) - FIXED: fixed an issue with
RelatedFieldInspector
handling of nested serializers - FIXED: fixed handling of
reverse_lazy
in URL settings (#209)
1.10.1
- ADDED: added the
SPEC_URL
setting for controlling the download link inswagger-ui
andReDoc
- ADDED: updated
ReDoc
settings (addedNATIVE_SCROLLBARS
andREQUIRED_PROPS_FIRST
) - ADDED: added
extra_styles
andextra_scripts
blocks to ui templates (#178) - IMPROVED: updated
swagger-ui
to version 3.18.2 - IMPROVED: updated
ReDoc
to version 2.0.0-alpha.37 - FIXED: stopped generating invalid OpenAPI by improper placement of
readOnly
Schemas - FIXED: fixed broken CSS when
USE_SESSION_AUTH=False
- FIXED: fixed implementation of
operation_summary
anddeprecated
(#194, #198) - FIXED: fixed a bug related to nested
typing
hints (#195) - FIXED: removed dependency on
future
(#196) - FIXED: removed exceptions loged for fields with
default=None
(#203) - FIXED: fixed
request_body=no_body
handling and related tests (#188, #199)
1.10.0
- ADDED: added
EXCLUDED_MEDIA_TYPES
setting for controllingproduces
MIME type filtering (#158) - ADDED: added support for
SerializerMethodField
, via theswagger_serializer_method
decorator for the method field, and support for Python 3.5 style type hinting of the method field return type (#137, #175, #179)
NOTE: in order for this to work, you will have to add the newdrf_yasg.inspectors.SerializerMethodFieldInspector
to yourDEFAULT_FIELD_INSPECTORS
array if you changed it from the default value - IMPROVED: updated
swagger-ui
to version 3.18.0 - IMPROVED: added support for Python 3.7 and Django 2.1 (#176)
- IMPROVED:
swagger_schema_fields
will now also work on serializerField
s (#167) - IMPROVED:
ref_name
collisions will now log a warning message (#156) - IMPROVED: added
operation_summary
anddeprecated
arguments toswagger_auto_schema
(#149, #173) - FIXED: made
swagger_auto_schema
work with DRF 3.9@action
mappings (#177)
1.9.2
- IMPROVED: updated
swagger-ui
to version 3.17.6 - IMPROVED: updated
ReDoc
to version 2.0.0-alpha.32 - IMPROVED: added
--api-version
argument to thegenerate_swagger
management command (#170) - FIXED: corrected various documentation typos (#160, #162, #171, #172)
- FIXED: made
generate_swagger
work for projects without authentication (#161) - FIXED: fixed
SafeText
interaction with YAML codec (#159)
1.9.1
- IMPROVED: added a
swagger_fake_view
marker to more easily detect mock views in view methods;getattr(self, 'swagger_fake_view', False)
inside a view method likeget_serializer_class
will tell you if the view instance is being used for swagger schema introspection (#154) - IMPROVED: updated
swagger-ui
to version 3.17.1 - IMPROVED: updated
ReDoc
to version 2.0.0-alpha.25 - FIXED: fixed wrong handling of duplicate urls in urlconf (#155)
- FIXED: fixed crash when passing
None
as a response override (#148)
1.9.0
Release date: Jun 16, 2018
- ADDED: added
DEFAULT_GENERATOR_CLASS
setting and--generator-class
argument to thegenerate_swagger
management command (#140) - FIXED: fixed wrongly required
'count'
response field onCursorPagination
(#141) - FIXED: fixed some cases where
swagger_extra_fields
would not be handlded (#142) - FIXED: fixed crash when encountering
coreapi.Fields
s without aschema
(#143)
1.8.0
- ADDED: added a :ref:
swagger_schema_fields <swagger_schema_fields>
field on serializerMeta
classes for
customizing schema generation (#132, #134) - FIXED: error responses from schema views are now rendered with
JSONRenderer
instead of throwing
confusing errors (#130, #58) - FIXED:
readOnly
schema fields will now no longer be marked asrequired
(#133)