Skip to content

Latest commit

 

History

History
886 lines (663 loc) · 72 KB

CHANGELOG.md

File metadata and controls

886 lines (663 loc) · 72 KB
Raw

Change Log

2.1.2 (2017-03-12)

Full Changelog

Implemented enhancements:

  • Make get_swagger_view() AllowAny by default #592

Closed issues:

  • Not showing comments as function description #622
  • Authentication Error: UserView queryset attribute #621
  • Django APIView serializer not being render #620
  • Nested URLs not displaying correclty #618
  • Using Regex Flags with DRS #602
  • URL for swagger logo #601
  • 403 when trying to access an empty documentation even as a Django superuser. #589
  • Post parameters in not shown in swagger #588
  • The UI does not render once djoser URLs are added #584
  • AssertionError when no endpoints are visible because of permissions #552

Merged pull requests:

2.1.1 (2017-01-06)

Full Changelog

Implemented enhancements:

  • Anyway to set content-type for swagger docs? #529

Closed issues:

  • Authorize button #600
  • Document how to get 0.3 behaviour #596
  • Bogus Models generated in schema #595
  • Enable setting to toggle swagger UI #591
  • Export the swagger definition #590
  • It seems swagger get docs from another serializer of the same name. #587
  • instance failed to match exactly one schema (matched 0 out of 2) #586
  • OrderingFilter object has no attribute 'get_schema_fields' #585
  • TypeError: __new__() got an unexpected keyword argument 'type' #582
  • Error with custom user model #579
  • why swagger_settings in settings.py is not work? #577
  • AttributeError: 'NoneType' object has no attribute 'update' #555
  • method self.request.version error #541
  • Add block extra\_scripts to base.html template #539
  • Method docstrings not included in generated docs #537
  • Unable to generate Docs on model with ArrayField #403
  • Add support for arrays as query parameters #312

Merged pull requests:

2.1.0 (2016-10-29)

Full Changelog

Closed issues:

  • How to force a DictField to be documented as an object, not a string? #568
  • Load UI from a Swagger definition file #567
  • Endpoint grouping/sorting is broken #536
  • can't exclude urls in latest version? #530
  • Issues with Schemas Generation #525
  • URLs by router are not detected by swagger #479

Merged pull requests:

2.0.7 (2016-10-16)

Full Changelog

Closed issues:

  • All urls are not mapped by swagger #562
  • Annotation order breaks doc generation #560
  • Getting AssertionError: Expected a coreapi.Document when using format=openapi #547

Merged pull requests:

2.0.6 (2016-10-02)

Full Changelog

Implemented enhancements:

  • UI Config Settings / Theming #347

Closed issues:

  • Fail to parse urls correctly #551
  • Swagger file #546
  • Django 1.10 problem url #544
  • No module named 'rest_framework_swagger.views' #543
  • No module named 'rest_framework_swagger.views' #542
  • How to use the new version (2+) with TokenAuthentication? #535
  • OpenAPIRenderer raises AttributeError when the response object is not a Document #534
  • Only one endpoint is shown in app #533
  • run_example.sh doesn't work without tweaking #524
  • Group list_route with viewset base path #515
  • ReStructuredText - Summary breaks down when there's a class reference. #472
  • API under / is not rendered properly #446
  • GeoDjango fields declared as string when type is GeoJSON #429
  • docstring for nested JSON custom response #416
  • reStructuredText docs not rendering #407
  • displayed endpoint url list is not sorted #401
  • Not able to show array with limited length info. #400
  • custom RelatedField serializers shown as string #389
  • Unable to navigate APis #384
  • Unable to introspect fields.ListField #367
  • Nested serializers: when combining form parameters and body, only body is sent. #360
  • parameters_strategy: replace fails with paramType: body #349
  • Unable to POST on serializer fields #346
  • Nested many=True serializers? #335
  • consumes/produces mieme types #308
  • Question: Does django-rest-swagger support complex response types? #305
  • Swagger not displaying fields when using get_serializer_class() to return different serializers for different URL's #290

Merged pull requests:

2.0.5 (2016-08-21)

Full Changelog

Implemented enhancements:

  • Add template blocks to allow customization #526

Closed issues:

  • Should be a way to customize request serializer field type #355

Merged pull requests:

2.0.4 (2016-08-16)

Full Changelog

Implemented enhancements:

  • How to sort endpoints? #512
  • How to control doc expansion in django-rest-swagger v2? #507

Fixed bugs:

  • Django 1.10 TypeError at /api/docs/ argument of type 'NoneType' is not iterable #517

Closed issues:

  • URLs not grouping together in 2.0 #518
  • The raw json generated from django swagger fails when validated using swagger-tools #504
  • Exception rendering swagger format (2.0.3) #502
  • function based views cause get_serializer_class error #501
  • The swagger urls are not using the SCRIPT_NAME header #494
  • @list_route() no collected #488
  • Django Swagger shown HTTP Error 500 and not processed HTML code when accessing without logged in user #486
  • 'LogoutView' object has no attribute 'get_serializer_class' #483
  • Error in host #482
  • Request Object is immutable while passing parameters through Swagger UI #473
  • Invalid serializer with detail_route and serializer_class override #466

Merged pull requests:

2.0.3 (2016-07-24)

Full Changelog

Implemented enhancements:

  • Add LOGIN_URL, LOGOUT_URL to SWAGGER_SETTINGS #480

Closed issues:

  • UI does not show descriptions and response model from function based api views #496
  • yaml specifications in __pydoc__ are ignored #492
  • Whitenoise collectstatic fails due to nonexistent file #489

Merged pull requests:

2.0.2 (2016-07-20)

Full Changelog

0.3.10 (2016-07-20)

Full Changelog

Closed issues:

  • ImportError: cannot import name duration_string (DRF 3.4.0) #476
  • How to represent a dictionary for Swagger UI #474
  • Is django version 1.7.1 necessary? #471
  • Wrong choices for duration field #469
  • Enabling explicit swagger style model definition in yaml string #468
  • Change the name in 'Response Class' -> 'Model' #463
  • Allow to set Selialiser name in documentation #458
  • request\_serializer option doesn't work for GET queries #455
  • Separate docs for separate groups of apps. #454
  • REST framework 3.4 - Schema generation. #453
  • Empty {% static %} tag in base.html leads to errors with django-storages #447
  • How can I change the documented type of a SerializerMethodField? #445
  • pytype for array #442
  • Documentation output in markdown #441
  • File parameters hard coded to body #437
  • swagger not show when view have custom decorator #426
  • How to skip documentation for some view functions #418
  • AttributeError: 'CreateOnlyDefault' object has no attribute 'is_update' #417
  • Authorizations Object #415
  • Use ListSerializer with 'CharField' object has no attribute 'get\_fields' error #413
  • Problem with custom CSRF cookie name #412
  • YAML commands not being documented #411
  • Support for custom routers #408
  • How to show my REST APIs by rest_framework_swagger? #402
  • paramType leads to incorrect input parameters for endpoint documentation #399
  • Context (inc request) should be passed to serializer in introspection #397
  • Multiple response type: docstring tags break #396
  • Make a release for Django 1.9 full support #395
  • Read only API in documentation? #394
  • Upgrading this package breaks existing setup because of the required package definitions #391
  • 'choice' field description uses the key #388
  • Override introspection? #385
  • Should query params from filter appear in methods other than GET (list)? #377
  • Try it out creates duplicate Request URLS #376
  • Consistent ValueError in 0.3.4 when used with a HashedFilesMixin-based class as STATICFILES_STORAGE #375
  • ModelViewSet documentation #374
  • Authorization support? #372
  • API Documentation is not available for only staff users #369
  • How to look for APIs via HTTPS #363
  • Foreign key fields are represented as 'string', instead of 'field'. #361
  • cannot implements read-only baseserializer because get_fields method is required #358
  • How to add custom endpoint #354
  • Add "include_namespaces" as a setting variable #353
  • Can't get this error to go away on GenericAPIView #351
  • Google Fonts and Remote Sources #350
  • exclude_namespaces is ignored for related endpoints #348
  • Django REST Swagger shows only {version} #344
  • Wrongly recognized Django url pattern #342
  • getting error "csrf failed while making POST request with an image file" #339
  • Issue including markdown tables in docs #337
  • Adding DynamicFieldsMixin causes KeyError 'request' #328
  • Add include\_namespaces setting #327
  • is_superuser permission should be user.is_staff #315
  • [Question] Nested results/requests? #314
  • Source of the image throbber.gif is wrong #311
  • Use latest swagger-ui #309
  • Specifying method overrides in docstring is now broken #303
  • switch to pytest ? #292
  • ViewSets and @detail_route #288
  • build_form_parameters does not handle complex types #276
  • Support for Expressing Binary Return Types #275
  • _get_method_serializer should check dock_parser before calling get_response_serializer_class #274
  • Question: How to keep YAML stuff separate from docstring in django project because it makes file bulky?? #273
  • Include Css source files (less or scss)? #272
  • Django rest swagger views.py only uses first default renderer class #271
  • Model Required List not Correctly Set based on Properties #270
  • create_view should create DRF Request not Django HttpRequest #269
  • Arrays Always Treated as Primitives #268
  • Parameters Omitted if Empty List #267
  • Duplicated Code in Parsing #265
  • Unneeded basePath on Return Value for SwaggerResourcesView #264
  • More documentation around api_path #263
  • More documentation around api-key #262
  • Setting format in docstring YAML Doesn't Do Anything #259
  • type and format are switched for datetimes and wrong for enum #258
  • Add UUID type to get_data_type #256
  • Specifying Parameter Type Resets Required #254
  • Simple way of setting URL Parameter #253
  • pytype not really documented #252
  • Management Command #251
  • Move to Swagger 2.0 #250
  • Unable to display serializers.fields on swagger docs #238
  • Exception using ModelViewSet + paginate_by attribute #232
  • Using of default instead of initial to pre-populate html fields #226
  • BooleanField rendered as a select instead of a checkbox #225
  • Swagger is always expecting model or serializers #222
  • Documentation not available via HTTPS #220
  • Query parameter not accessible within the 'create' function of ModelViewSet. #216
  • Documenting a method for multiple HTTP methods. #214
  • TemplateDoesNotExist at /docs/ rest_framework_swagger/index.html #210
  • How to add array parameters type support in docstring? #204
  • support PaginationSerializer #197
  • Method description not being parsed #196
  • problem of using swagger when I use the get_serializer_class() for dynamic serializer based on the URL's charges #194
  • AttributeError when use CurrentUserDefault #193
  • api_key not being sent #173
  • Option to Allow Specification of App(s) To Generate Docs For #160
  • yaml response type format is not ideal #151
  • Hide unwanted not allowed_methods #142
  • Multiple Separate Doc Urls? #141
  • Token Auth Endpoint #120
  • Question: How to set Data Type when using custom parameters in the docstring? #114
  • Question: How could api urls be better grouped? #107
  • Troubles with api_path #102
  • Question: How to add 'header' parameters? #101
  • Question: How do I specify a 'root' api path? #92
  • Issue with reverse-proxied nginx + gunicorn + django setup #83
  • Allow parameter documentation to span more than one line in the docstring #81
  • Trying to load content from HTTP instead of HTTPS #77
  • Add support for nested resources / URLs #76
  • enabled_methods not behaving as expected #73
  • Actions with same prefix are erroneously grouped. #69
  • How to comment single mixins method in a viewset for default methods (create, destroy etc..) #67
  • How to avoid to list POST updates (have only POST inserts) #66
  • Help text doesn't appear in swagger ui #62
  • Use docstring of individual APIView methods #58
  • How to show Response Class, Response Content Type, and Error Status Codes? #37
  • Django 1.4 Compatibility #23
  • Cannot load resource documentation #13

Merged pull requests:

0.3.9 (2016-07-17)

Full Changelog

Implemented enhancements:

  • Add possibility of generating 'header' parameters #3
  • Add generic filtering parameters #2
  • Add permission classes as part of the implementation notes #1

Closed issues:

  • ImportError: cannot import name 'OpenAPIRenderer' #478
  • Swagger UI doesn't work in 2.0.0 #477
  • CSRF cookie fails on HttpOnly #432

Merged pull requests:

2.0.1 (2016-07-14)

Full Changelog

Closed issues:

  • Swagger 2.0 roadmap #443

2.0.0 (2016-07-14)

Full Changelog

Closed issues:

  • DRS docs break with CSP that blocks inline scripts #434

2.0.0a0 (2016-07-14)

Full Changelog

Closed issues:

  • #Not working on production deployed on aws. if debug is true works on localhost else fails on localhost as well. #464

Merged pull requests:

0.3.8 (2016-06-27)

Full Changelog

Closed issues:

  • AssertionError: The slug\_field argument is required. #460
  • Errors with Django 1.10 #452
  • Opening the docs makes 2 requests for each endpoint #440
  • Serializer Meta option read_only_fields is not respected #424
  • django1.9 can not work in web browser #405

Merged pull requests:

0.3.7 (2016-05-18)

Full Changelog

Merged pull requests:

  • update readthedocs url #439 (ariovistus)
  • Added support for array type responses #438 (MrTam)
  • Add support for making API paths relative to the specified api_path setting #433 (MrTam)

0.3.6 (2016-04-21)

Full Changelog

Closed issues:

  • Building a django-rest-swagger package for conda ? #410
  • Update urlpatterns to be a list of django.conf.urls.url() instances #387
  • Provide wheel package on PyPI #373
  • choice parameter type is not valid #343
  • Instructions to run the tests #235
  • No real documentation #219
  • the example and tests seems too old now. not willing to run it. #211

Merged pull requests:

0.3.5 (2016-01-24)

Full Changelog

Closed issues:

  • swagger urls endpoint crashes when placed in url with regex capture #382
  • Django 1.8+ deprecation warning for urlpatterns in urls.py:10 #380
  • Design & Implement REST API #378
  • Authorizations Object in SWAGGER_CONFIG #371
  • Get a JSON definition file #364
  • Problem while installing django-rest-swagger in virtualenv #357
  • Problem with custom CSRF cookie name #316
  • Django 1.8 Support #249
  • Incorrect yaml docs rendering. #190

Merged pull requests:

  • Respect django's CSRF_COOKIE_NAME setting #392 (teeberg)
  • Allow arbitrary arguments to get methods of swagger classes #383 (dtheodor)
  • Use the new style urlpatterns syntax to fix Django deprecation warnings #381 (edmorley)
  • Handle DRF's AcceptHeaderVersioning: send version in Accept header #379 (blueyed)
  • Ensuring fields.ListField introspects as 'array' #367 #368 (respondcreate)
  • Allow user to configure AnonymousUser class #365 (rodcarroll)
  • Fix for Assertion errors introduced in 3.0.2 #352 (martyzz1)

0.3.4 (2015-08-20)

Full Changelog

Closed issues:

  • Can one generate a pdf or html using django-rest-swagger #345
  • The comment can not be parsed when using decorator #341
  • boolean type doesn't work properly #340
  • Trying to upgrade django rest swagger upgrades Django to 1.8.3 forcefully #332
  • resource_access_handler is not documented #330
  • 0.3.3 build? #329
  • get\_default\_value\(\) raises Attribute error for a field using CurrentUserDefault #317

Merged pull requests:

0.3.3 (2015-07-24)

Full Changelog

Closed issues:

  • No endpoint description with Nginx + uWSGI #313
  • getting access-control-origin error #300
  • methods ['retrieve'] in class docstring are not in view methods ['list'] #297
  • Missing Comma from sample Settings configuration #295
  • ViewSets @list_route #289
  • Add hide_parameters in yaml config #279
  • date-time spelled wrong #257
  • Tests should use the swagger 1.2 JSON schema to validate JSON output #233

Merged pull requests:

0.3.2 (2015-06-06)

Full Changelog

Closed issues:

  • Remove protocol settings #286

Merged pull requests:

  • Remove 'protocol' settings #287 (ticosax)
  • Add optional support for django_filters third party package #285 (ticosax)

0.3.1 (2015-06-04)

Full Changelog

Closed issues:

  • Can't use blocks of code in notes with bash commands that have "long options" #282
  • No files on PyPI (0.3.0) #281

Merged pull requests:

0.3.0 (2015-05-15)

Full Changelog

Closed issues:

  • import error with 'smart_text' #237
  • Method "nickname" generation is a function of viewset class #230
  • Choices not displaying on documentation #229

Merged pull requests:

0.2.9 (2015-03-07)

Full Changelog

Closed issues:

  • actually requires django-rest-framework 2.4.0 #221
  • view.paginate_by is not a required attribute for ViewSet object in REST Framework #199
  • Question: Custom page for the documentation generated #195
  • Swagger POSTs with Content-Type application/x-www-form-urlencoded instead of application/json #131
  • Support for reStructuredText in docstrings #126
  • Throbber image hardcoded to /static/ #52
  • Support for sending json object in raw post data #50

Merged pull requests:

0.2.8 (2015-01-11)

Full Changelog

Implemented enhancements:

  • pagination parameter not automatically detected #182

Closed issues:

  • How can I run the project? #187
  • Unable to read api #183
  • No action provided in get_serializer_class #119
  • How to do a "real" POST #113
  • DocumentationGenerator ignores serializer field labels #105
  • Unable to read api #84

Merged pull requests:

0.2.7 (2014-12-31)

Full Changelog

Closed issues:

  • drf v3 support #152
  • Issue when get_serializer_class references "self.request.user" #86

Merged pull requests:

0.2.6 (2014-12-13)

Full Changelog

Closed issues:

  • please use tags for releases. #174
  • SWAGGER_SETTINGS permission_denied_handler #166

Merged pull requests:

  • fix smart_text import (django-rest-framework 3.x) #175 (dnozay)

0.2.5 (2014-12-11)

Full Changelog

Closed issues:

  • 'Field' object has no attribute 'default' during introspection. #171
  • AssertionError Raised When Using Nested Serializers #168
  • Nested Relationships #121
  • unable to read api #104

Merged pull requests:

0.2.4 (2014-12-10)

Full Changelog

Closed issues:

  • \_find\_field\_serializers Tries to parse drf native serializer - drf v 3 #167

Merged pull requests:

0.2.3 (2014-12-09)

Full Changelog

Closed issues:

  • rest_framework.fields.empty is not JSON serializable #163

Merged pull requests:

0.2.2 (2014-12-08)

Full Changelog

Closed issues:

  • fbv failes with Exception: methods ['serializer'] in class docstring are not in view methods [u'OPTIONS', u'GET'] #153

Merged pull requests:

0.2.1 (2014-11-16)

Full Changelog

Implemented enhancements:

  • Document upcoming YAML parser #134

Closed issues:

  • Which repo to contribute? #146
  • Use YAML to indicate a response serializer other than the default #144
  • Add support of choice fields #99
  • Custom Parameters for ModelViewSet Methods #74
  • custom json render support #36

Merged pull requests:

0.2.0 (2014-11-01)

Full Changelog

Closed issues:

  • Fork of django-rest-swagger #132
  • RuntimeError after Upgrade to Rest Framework 2.4.3 #129
  • Documenting DRF function based views parameters #124
  • ViewSetIntrospector broken with DRF 2.4.3 #123
  • IS this github repo still ACTIVE? #122
  • enabled_methods not excluding 'put' operations #108
  • DocumentationGenerator ignores serializer field order #106
  • Error with ternary operation in searching through query strings for ViewSets #91
  • Settings are not picked up by swagger (0.1.14) #78
  • cigar_example documentation - RuntimeError: Unable to use callback invalid closure/function specified. #71
  • Make Python 3 compatible #61

Merged pull requests:

0.1.14 (2014-03-07)

Full Changelog

Closed issues:

  • How to use exclude_namespaces #64

Merged pull requests:

  • Fixes #63 missing starting letters from base path in resourses. #68 (bbenko)

0.1.13 (2014-02-26)

Full Changelog

Closed issues:

  • Incomplete resource list #63
  • Django Rest Swagger broken on Python 3 due to Unipath bug #59
  • unicode SWAGGER_SETTINGS['enabled_methods'] causes javascript error in python 2 #56
  • CSRF Fails when using 'rest_framework.authentication.SessionAuthentication' #14

0.1.12 (2014-02-26)

Full Changelog

Closed issues:

Merged pull requests:

  • Use json serialization of enabled_methods #57 (davidn)
  • Reworked swagger API Key to work with django-rest-framework's token authentication #51 (DiscoStarslayer)
  • Resolve default values if callable #49 (lukaszb)
  • use JSONRendered for SwaggerResourcesView #47 (jfelectron)

0.1.11 (2013-12-01)

Full Changelog

Closed issues:

  • UnicodeDecodeError: 'ascii' codec can't decode byte 0xe7 in position 22: ordinal not in range(128) #44
  • Introspector method mapping fails on python < 2.7 #42
  • "settings" object in template is overwritten by contextprocessors that add settings to context #40
  • Method-level documentation #24

Merged pull requests:

  • Add test and fix for not excluding nested URL namespaces #41 (pzrq)

0.1.10 (2013-11-24)

Full Changelog

Closed issues:

  • Viewset support upgrade #39
  • Question: How can I specify request-params types from docstring? #38
  • Issue when get_serializer_class references "self.request" #35
  • action and link decoratated methods under a django viewset show all the viewsets HTTP OPTIONS #34
  • ImportError: No module named rest_framework_swagger #33
  • Swagger doesn't inspect all Views #31
  • Swagger Specification 1.2 Transition #30
  • Question: django-rest-swagger style guide #28
  • Unable to find apps #21

0.1.9 (2013-10-01)

Full Changelog

Closed issues:

  • View description (notes) are trimmed. #32
  • Support for APPEND_SLASH = False #29
  • django update 1.5.4 - ImportError: No module named core.management #25

0.1.8 (2013-09-16)

Full Changelog

Closed issues:

  • ImportError: name get_view_name #22

Merged pull requests:

0.1.7 (2013-09-05)

Full Changelog

Merged pull requests:

  • fix recursive prefix in __flatten_patterns_tree #12 (postfalk)
  • Added 'api_path' to settings, it fixes URLs if you don't have API on roo... #11 (whit)

0.1.6 (2013-08-03)

Full Changelog

Merged pull requests:

0.1.5 (2013-07-31)

Full Changelog

Closed issues:

  • Cannot apply DjangoModelPermissions on a view that does not have .model or .queryset property. #8

0.1.4 (2013-07-29)

Full Changelog

Closed issues:

  • Missing lib folder in static/rest_framework_swagger/ and swagger-ui.js typo? #6
  • Installation fails if the Django project root isn't in the PYTHONPATH #5

0.1.3 (2013-07-19)

Full Changelog

Closed issues:

  • Add support for Routers and ViewSets #4

0.1.2 (2013-07-09)

Full Changelog

0.1.1 (2013-06-28)

* This Change Log was automatically generated by github_changelog_generator