drf-yasg

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

OTHER License

Downloads
2.2M
Stars
3.4K
Committers
66

Bot releases are hidden (Show)

drf-yasg - 1.4.4

Published by axnsan12 over 6 years ago

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

Published by axnsan12 over 6 years ago

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

Published by axnsan12 over 6 years ago

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

Published by axnsan12 over 6 years ago

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

Published by axnsan12 over 6 years ago

  • ADDED: added settings for OAuth2 client configuration in swagger-ui (#53)
  • IMPROVED: updated swagger-ui to version 3.9.3
drf-yasg - 1.3.1

Published by axnsan12 over 6 years ago

  • FIXED: fixed a bug that would sometimes cause endpoints to wrongly be output as form operations (#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 (#48)
drf-yasg - 1.3.0

Published by axnsan12 over 6 years ago

  • ADDED: security requirements are now correctly set and can be customized; this should fix
    problems related to authentication in swagger-ui Try it out! (#50, #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 (#49, thanks to @blueyed)
drf-yasg - 1.2.2

Published by axnsan12 almost 7 years ago

  • FIXED: djangorestframework>=3.7.7 is now required because of breaking changes (#44, #45, thanks to @h-hirokawa)
drf-yasg - 1.2.1

Published by axnsan12 almost 7 years ago

Fixed some deployment issues.

drf-yasg - 1.2.0

Published by axnsan12 almost 7 years ago

  • ADDED: basePath is now generated by taking into account the SCRIPT_NAME variable and the
    longest common prefix of API urls (#37, #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 (#37, #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)
drf-yasg - 1.1.3

Published by axnsan12 almost 7 years ago

  • 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
drf-yasg - 1.1.2

Published by axnsan12 almost 7 years ago

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

Published by axnsan12 almost 7 years ago

  • ADDED: generate_swagger management command (#29, #31, thanks to @beaugunderson)
  • FIXED: fixed improper generation of \Z regex tokens - will now be repalced by $
drf-yasg - 1.1.0

Published by axnsan12 almost 7 years ago

  • ADDED: added support for APIs versioned with URLPathVersioning or NamespaceVersioning
  • ADDED: added ability to recursively customize schema generation using pluggable inspector classes
  • ADDED: added operation_id parameter to @swagger_auto_schema
  • ADDED: integration with djangorestframework-camel-case (#28)
  • IMPROVED: strings, arrays and integers will now have min/max validation attributes inferred from the field-level validators
  • FIXED: fixed a bug that caused title to never be generated for Schemas; title is now correctly populated from the field's label property
drf-yasg - 1.0.6

Published by axnsan12 almost 7 years ago

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

Published by axnsan12 almost 7 years ago

  • 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
    (#21, thanks to @h-hirokawa)
drf-yasg - 1.0.2

Published by axnsan12 almost 7 years ago

First version.

drf-yasg - 1.0.3

Published by axnsan12 almost 7 years ago

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

Published by axnsan12 almost 7 years ago

  • FIX: fixed improper generation of YAML references
  • FEATURE: added query_serializer parameter to swagger_auto_schema (#16, #17)
Package Rankings
Top 19.3% on Conda-forge.org
Top 0.83% on Pypi.org
Related Projects