Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.
OTHER License
Bot releases are visible (Hide)
ADDED: Python 3.10 support (#818)
DEPRECATED: Python 3.6 support as it's been deprecated by swagger-spec-validator
FIXED: RecursiveField resolver (#822)
Published by JoelLefkowitz about 2 years ago
FIXED: Remove NullBooleanFields if the django-rest-framework version >= 3.14.0 (#814)
Published by JoelLefkowitz over 2 years ago
FIXED: Set generator url for swagger_settings.DEFAULT_API_URL (#682)
FIXED: Check fields for allow_null attribute (#688)
FIXED: Encode pytz object field as a string by default (#717)
FIXED: Handle errors rendering with TemplateHTMLRenderer (#742)
Published by JoelLefkowitz over 2 years ago
FIXED: Fixed code block rst syntax in README.rst
(#797)
Published by JoelLefkowitz over 2 years ago
FIXED: Refer to permission_classes as a tuple (#678)
IMPROVED: Document drf-extra-fields base64 integration (#445)
ADDED: Added many support to example code (#695)
ADDED: Allow specifying response as a reference (#757)
FIXED: Fix old spelling errors and add a cspell configuration (#796)
FIXED: Remove universal wheel, python 2 is unsupported (#782)
FIXED: Fix duration field inspector (#549)
Published by JoelLefkowitz over 2 years ago
Published by JoelLefkowitz over 2 years ago
redoc.min.js
(#778)publish.yml
(#794)Published by axnsan12 almost 4 years ago
Release date: Feb 17, 2020
USERNAME_FIELD
in generate_swagger
command (#486)Support was dropped for Python 3.5, Django 2.0, Django 2.1, DRF 3.7
Published by axnsan12 almost 4 years ago
swagger-ui
to version 3.36.0ReDoc
to version 2.0.0-rc.40django.conf.settings.LOGOUT_URL
(#646)Support was dropped for Python 2.7, DRF 3.8, DRF 3.9.
Requirements are now: Python>=3.6, Django>=2.2, DRF>=3.10
The 1.18 and 1.19 series was skipped to avoid confusion with the drf-yasg2 fork. I would also like to take this
opportunity to extend my apologies to the community at large for the large gap in the maintenance of drf-yasg
and the problems it has caused.
Published by axnsan12 about 5 years ago
JSONFieldInspector
for JSONField
support (#417)swagger-ui
to version 3.23.11ReDoc
to version 2.0.0-rc.14 (#398)Published by axnsan12 over 5 years ago
ChoiceField
s (#400)Published by axnsan12 over 5 years ago
Release date: Jun 13, 2019
reference_resolver_class
attribute hook to SwaggerAutoSchema
(#350)operation_keys
attribute to SwaggerAutoSchema
, along with __init__
parameter (#355)issubclass
check without isclass
checkPublished by axnsan12 over 5 years ago
swagger-ui
to version 3.22.3ReDoc
to version 2.0.0-rc.8-1Python 3.4 support has been dropped!
Published by axnsan12 over 5 years ago
is_list_view
and has_list_response
extension points to SwaggerAutoSchema
(#331)swagger-ui
to version 3.22.0ReDoc
to version 2.0.0-rc.4ListModelMixin
will now always be treated as a list view (#306)choices
will now be handled properly (#340)🎉 400 commits 🎉
Published by axnsan12 over 5 years ago
swagger-ui
to version 3.21.0ref_name
collisions will now throw an exceptionRecursiveField
will now also work as a child of ListSerializer
(#321)minLength
and maxLength
for ListSerializer
and ListField
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)get_summary
and get_description
methods have been removed (previously deprecated in 1.12.0)Published by axnsan12 over 5 years ago
Optional
(#272)swagger-ui
to version 3.20.5ReDoc
to version 2.0.0-rc.2flex
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)Published by axnsan12 almost 6 years ago
ReDoc
to version 2.0.0-rc.0DEFAULT_VERSION
for mock requestself
parameterPublished by axnsan12 almost 6 years ago
get_security_definitions
and get_security_requirements
hooks to OpenAPISchemaGenerator
get_summary_and_description
and split_summary_from_description
extension points to SwaggerAutoSchema
to allow for better customisationswagger-ui
to version 3.20.4next
and previous
fields are now marked as x-nullable
(#263)tags
argument to swagger_auto_schema
(#259)enum
will now be automatically detected from ChoiceField
if all choices
values are objects of the same Python class (#264)SwaggerValidationError
details will now be logged and shown in the exception messageget_queryset
, get_parsers
and get_renderers
will no longer be bypassedread_only
serializer fields will be correctly ignored when generating form parameters (#261)UIRenderer
(#268)securityDefinitions
and security
objectsget_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 releaseIMPORTANT 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
.
Published by axnsan12 almost 6 years ago
swagger-ui
to version 3.20.1ReDoc
to version 2.0.0-alpha.41minLength
and maxLength
will now also work for ListSerializer
in addition to ListField
MultipleChoiceField
will now use the multi
collectionFormat
where appropriate (#257)format
, pattern
, enum
, min_length
and max_length
attributes of coreschema.Schema
will now be persited into the converted openapi.Parameter
(#212, #233)Published by axnsan12 about 6 years ago
PERSIST_AUTH
, REFETCH_SCHEMA_WITH_AUTH
, REFETCH_SCHEMA_ON_LOGOUT
settings and related javascript implementation for persisting authentication data to swagger-ui localStorageSwagger
object with no paths
and definitions
FETCH_SCHEMA_WITH_QUERY
setting to enable fetching of the schema document using query parameters passed to the UI view (#208)x-nullable
extension (#217)swagger-ui.html
/redoc.html
and some JavaScript hooks in swagger-ui-init.js
inspect.signature
on python 2.7 (#222)