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 visible (Hide)

drf-yasg - 1.10.2

Published by axnsan12 about 6 years ago

  • 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 a RegexValidator (would previously not appear on fields with special formats such as EmailField)
  • FIXED: fixed an issue with RelatedFieldInspector handling of nested serializers
  • FIXED: fixed handling of reverse_lazy in URL settings (#209)
drf-yasg - 1.10.1

Published by axnsan12 about 6 years ago

  • ADDED: added the SPEC_URL setting for controlling the download link in swagger-ui and ReDoc
  • ADDED: updated ReDoc settings (added NATIVE_SCROLLBARS and REQUIRED_PROPS_FIRST)
  • ADDED: added extra_styles and extra_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 and deprecated (#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)
drf-yasg - 1.10.0

Published by axnsan12 about 6 years ago

  • ADDED: added EXCLUDED_MEDIA_TYPES setting for controlling produces MIME type filtering (#158)
  • ADDED: added support for SerializerMethodField, via the swagger_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 new drf_yasg.inspectors.SerializerMethodFieldInspector to your DEFAULT_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 serializer Fields (#167)
  • IMPROVED: ref_name collisions will now log a warning message (#156)
  • IMPROVED: added operation_summary and deprecated arguments to swagger_auto_schema (#149, #173)
  • FIXED: made swagger_auto_schema work with DRF 3.9 @action mappings (#177)
drf-yasg - 1.9.2

Published by axnsan12 about 6 years ago

  • 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 the generate_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)
drf-yasg - 1.9.1

Published by axnsan12 over 6 years ago

  • 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 like get_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)
drf-yasg - 1.9.0

Published by axnsan12 over 6 years ago

Release date: Jun 16, 2018

  • ADDED: added DEFAULT_GENERATOR_CLASS setting and --generator-class argument to the generate_swagger management command (#140)
  • FIXED: fixed wrongly required 'count' response field on CursorPagination (#141)
  • FIXED: fixed some cases where swagger_extra_fields would not be handlded (#142)
  • FIXED: fixed crash when encountering coreapi.Fieldss without a schema (#143)
drf-yasg - 1.8.0

Published by axnsan12 over 6 years ago

  • ADDED: added a :ref:swagger_schema_fields <swagger_schema_fields> field on serializer Meta 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 as required (#133)
drf-yasg - 1.7.4

Published by axnsan12 over 6 years ago

Release date: May 14, 2018

  • IMPROVED: updated swagger-ui to version 3.14.2
  • IMPROVED: updated ReDoc to version 2.0.0-alpha.20
  • FIXED: ignore None return from get_operation to avoid empty Path objects in output
  • FIXED: request body is now allowed on DELETE endpoints (#118)
drf-yasg - 1.7.3

Published by axnsan12 over 6 years ago

  • FIXED: views whose __init__ methods throw exceptions will now be ignored during endpoint enumeration
drf-yasg - 1.7.2

Published by axnsan12 over 6 years ago

  • FIXED: fixed generation of default SECURITY_REQUIREMENTS to match documented behaviour
  • FIXED: ordering of SECURITY_REQUIREMENTS and SECURITY_DEFINITIONS is now stable
drf-yasg - 1.7.1

Published by axnsan12 over 6 years ago

  • IMPROVED: updated swagger-ui to version 3.14.1
  • IMPROVED: set swagger-ui showCommonExtensions to True by default and add SHOW_COMMON_EXTENSIONS setting key
  • IMPROVED: set min_length=1 when allow_blank=False (#112, thanks to @elnappo)
  • FIXED: made documentation ordering of SwaggerDict extra attributes stable
drf-yasg - 1.7.0

Published by axnsan12 over 6 years ago

  • ADDED: added integration with djangorestframework-recursive (#109, #110, thanks to @rsichny)

    NOTE: in order for this to work, you will have to add the new drf_yasg.inspectors.RecursiveFieldInspector to your DEFAULT_FIELD_INSPECTORS array if you changed it from the default value

  • FIXED: SchemaRef now supports cyclical references via the ignore_unresolved argument

drf-yasg - 1.6.2

Published by axnsan12 over 6 years ago

  • IMPROVED: updated swagger-ui to version 3.13.6
  • IMPROVED: switched ReDoc to version 2.0.0-alpha.17 (was 1.21.2); fixes #107
  • FIXED: made documentation ordering of parameters stable for urls with multiple parameters (#105, #106)
  • FIXED: fixed crash when using a model ChoiceField of unknown child type
drf-yasg - 1.6.1

Published by axnsan12 over 6 years ago

  • ADDED: added SUPPORTED_SUBMIT_METHODS swagger-ui setting
drf-yasg - 1.6.0

Published by axnsan12 over 6 years ago

  • IMPROVED: OAUTH2_REDIRECT_URL will now default to the built in oauth2-redirect.html file
drf-yasg - 1.5.1

Published by axnsan12 over 6 years ago

  • IMPROVED: updated swagger-ui to version 3.13.0
  • FIXED: fixed a crash caused by serializers.OneToOneRel (#81, thanks to @ko-pp)
drf-yasg - 1.5.0

Published by axnsan12 over 6 years ago

  • IMPROVED: serializers.HiddenField are now hidden (#78, #79, thanks to @therefromhere)

    NOTE: in order for this to work, you will have to add the new drf_yasg.inspectors.HiddenFieldInspector to your DEFAULT_FIELD_INSPECTORS array if you changed it from the default value

  • IMPROVED: type of model field is now detected for serializers.SlugRelatedField with read_only=True (#82, #83, thanks to @therefromhere)

drf-yasg - 1.4.7

Published by axnsan12 over 6 years ago

  • FIXED: prevent crashes caused by attempting to delete object attributes which do not exist in the first place (#76)
drf-yasg - 1.4.6

Published by axnsan12 over 6 years ago

  • IMPROVED: updated swagger-ui to version 3.12.0
  • IMPROVED: updated ReDoc to version 1.21.2
drf-yasg - 1.4.5

Published by axnsan12 over 6 years ago

  • FIXED: fixed an issue with modification of swagger_auto_schema arguments in-place during introspection, which would sometimes cause an incomplete Swagger document to be generated after the first pass (#74, #75)
Package Rankings
Top 19.3% on Conda-forge.org
Top 0.83% on Pypi.org
Related Projects