Prepare release 1.0.6

Update swagger-ui to 3.8.0
Merge pull request #27 from axnsan12/fix/callable-default
2017-12-23 12:29:34 +01:00 · 2017-12-23 12:29:19 +01:00 · 2017-12-23 12:22:35 +01:00 · 2017-12-23 12:04:02 +01:00 · 2017-12-23 11:52:57 +01:00 · 2017-12-22 21:00:13 +01:00
42 changed files with 914 additions and 196 deletions
@@ -11,6 +11,7 @@ coverage:
      default:
        enabled: yes
        target: auto
+        threshold: 0%
        if_no_uploads: error
        if_ci_failed: error

@@ -18,7 +19,7 @@ coverage:
      default:
        enabled: yes
        target: 80%
-        threshold: 60%
+        threshold: 0%
        if_no_uploads: error
        if_ci_failed: error

@@ -0,0 +1,2 @@
+* text=auto
+*.sh text eol=lf
@@ -40,3 +40,8 @@ after_success:
 branches:
  only:
    - master
+
+notifications:
+  email:
+    on_success: always
+    on_failure: always
@@ -201,7 +201,7 @@ The possible settings and their default values are as follows:
        'DEEP_LINKING': False,
        'SHOW_EXTENSIONS': True,
        'DEFAULT_MODEL_RENDERING': 'model',
-        'DEFAULT_MODEL_DEPTH': 2,
+        'DEFAULT_MODEL_DEPTH': 3,
    }

 .. code:: python
@@ -359,7 +359,7 @@ https://drf-yasg.readthedocs.io/en/latest/
   :alt: Codecov

 .. |pypi-version| image:: https://img.shields.io/pypi/v/drf-yasg.svg
-   :target: https://pypi.org/project/drf-yasg/
+   :target: https://pypi.python.org/pypi/drf-yasg/
   :alt: PyPI

 .. |rtd-badge| image:: https://img.shields.io/readthedocs/drf-yasg.svg
@@ -3,20 +3,42 @@ Changelog
 #########


+*********
+**1.0.6**
+*********
+
+- **FIXED:** Swagger UI "Try it out!" should now work with Django login
+- **FIXED:** callable ``default`` values on serializer fields will now be properly called (:pr:`24`, :issue:`25`)
+- **IMPROVED:** updated ``swagger-ui`` to version 3.8.0
+- **IMPROVED:** ``PrimaryKeyRelatedField`` and ``SlugRelatedField`` will now have
+  appropriate types based on the related model (:pr:`26`)
+- **IMPROVED:** mock views will now have a bound request even with ``public=False`` (:pr:`23`)
+
+*********
+**1.0.5**
+*********
+
+- **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() <https://docs.djangoproject.com/en/2.0/ref/urls/#django.urls.path>`_
+- **IMPROVED:** updated ``swagger-ui`` to version 3.7.0
+- **IMPROVED:** ``FileField`` is now generated as an URL or file name in response Schemas
+  (:pr:`21`, thanks to :ghuser:`h-hirokawa`)
+
 *********
 **1.0.4**
 *********

- **FIX:** fixed improper generation of YAML references
- **FEATURE:** added ``query_serializer`` parameter to
+- **FIXED:** fixed improper generation of YAML references
+- **ADDED:** added ``query_serializer`` parameter to
  :func:`@swagger_auto_schema <.swagger_auto_schema>` (:issue:`16`, :pr:`17`)

 *********
 **1.0.3**
 *********

- **FIX:** fixed bug that caused schema views returned from cache to fail (:issue:`14`)
- **FIX:** disabled automatic generation of response schemas for form operations to avoid confusing errors caused by
+- **FIXED:** fixed bug that caused schema views returned from cache to fail (:issue:`14`)
+- **FIXED:** disabled automatic generation of response schemas for form operations to avoid confusing errors caused by
  attempting to shove file parameters into Schema objects

 *********
@@ -4,6 +4,7 @@
 # drf-yasg documentation build configuration file, created by
 # sphinx-quickstart on Sun Dec 10 15:20:34 2017.
 import os
+import re
 import sys

 import sphinx_rtd_theme
@@ -168,6 +169,7 @@ nitpick_ignore = [

    ('py:class', 'ruamel.yaml.dumper.SafeDumper'),
    ('py:class', 'rest_framework.renderers.BaseRenderer'),
+    ('py:class', 'rest_framework.schemas.generators.EndpointEnumerator'),
    ('py:class', 'rest_framework.views.APIView'),

    ('py:class', 'OpenAPICodecYaml'),
@@ -215,40 +217,59 @@ drf_yasg.views.SchemaView = drf_yasg.views.get_schema_view(None)

 # custom interpreted role for linking to GitHub issues and pull requests
 # use as :issue:`14` or :pr:`17`
-gh_issue_uri = "https://github.com/axnsan12/drf-yasg/issues/%d"
-gh_pr_uri = "https://github.com/axnsan12/drf-yasg/pull/%d"
+gh_issue_uri = "https://github.com/axnsan12/drf-yasg/issues/{}"
+gh_pr_uri = "https://github.com/axnsan12/drf-yasg/pull/{}"
+gh_user_uri = "https://github.com/{}"
+
+
+def sphinx_err(inliner, lineno, rawtext, msg):
+    msg = inliner.reporter.error(msg, line=lineno)
+    prb = inliner.problematic(rawtext, rawtext, msg)
+    return [prb], [msg]
+
+
+def sphinx_ref(options, rawtext, text, ref):
+    set_classes(options)
+    node = nodes.reference(rawtext, text, refuri=ref, **options)
+    return [node], []
+
+
+def role_github_user(name, rawtext, text, lineno, inliner, options=None, content=None):
+    options = options or {}
+    content = content or []
+
+    if not re.match(r"^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$", text):
+        return sphinx_err(inliner, lineno, rawtext, '"%s" is not a valid GitHub username.' % text)
+
+    ref = gh_user_uri.format(text)
+    text = '@' + utils.unescape(text)
+    return sphinx_ref(options, rawtext, text, ref)


 def role_github_pull_request_or_issue(name, rawtext, text, lineno, inliner, options=None, content=None):
    options = options or {}
    content = content or []
    try:
-        ghid = int(text)
-        if ghid <= 0:
+        if int(text) <= 0:
            raise ValueError
    except ValueError:
-        msg = inliner.reporter.error(
-            'GitHub pull request or issue number must be a number greater than or equal to 1; '
-            '"%s" is invalid.' % text, line=lineno
+        return sphinx_err(
+            inliner, lineno, rawtext,
+            'GitHub pull request or issue number must be a number greater than or equal to 1; "%s" is invalid.' % text
        )
-        prb = inliner.problematic(rawtext, rawtext, msg)
-        return [prb], [msg]
-        # Base URL mainly used by inliner.rfc_reference, so this is correct:

    if name == 'pr':
        ref = gh_pr_uri
    elif name == 'issue':
        ref = gh_issue_uri
    else:
-        msg = inliner.reporter.error('unknown tag name for GitHub reference - "%s"' % name, line=lineno)
-        prb = inliner.problematic(rawtext, rawtext, msg)
-        return [prb], [msg]
+        return sphinx_err(inliner, lineno, rawtext, 'unknown role name for GitHub reference - "%s"' % name)

-    ref = ref % ghid
-    set_classes(options)
-    node = nodes.reference(rawtext, '#' + utils.unescape(text), refuri=ref, **options)
-    return [node], []
+    ref = ref.format(text)
+    text = '#' + utils.unescape(text)
+    return sphinx_ref(options, rawtext, text, ref)


 roles.register_local_role('pr', role_github_pull_request_or_issue)
 roles.register_local_role('issue', role_github_pull_request_or_issue)
+roles.register_local_role('ghuser', role_github_user)
@@ -158,7 +158,9 @@ Where you can use the :func:`@swagger_auto_schema <.swagger_auto_schema>` decora
      test_param = openapi.Parameter('test', openapi.IN_QUERY, description="test manual param", type=openapi.TYPE_BOOLEAN)
      user_response = openapi.Response('response description', UserSerializer)

+      # 'method' can be used to customize a single HTTP method of a view
      @swagger_auto_schema(method='get', manual_parameters=[test_param], responses={200: user_response})
+      # 'methods' can be used to apply the same modification to multiple methods
      @swagger_auto_schema(methods=['put', 'post'], request_body=UserSerializer)
      @api_view(['GET', 'PUT', 'POST'])
      def user_detail(request, pk):
@@ -187,6 +189,7 @@ Where you can use the :func:`@swagger_auto_schema <.swagger_auto_schema>` decora
   .. code:: python

      class ArticleViewSet(viewsets.ModelViewSet):
+         # method or 'methods' can be skipped because the list_route only handles a single method (GET)
         @swagger_auto_schema(operation_description='GET /articles/today/')
         @list_route(methods=['get'])
         def today(self, request):
@@ -206,6 +209,45 @@ Where you can use the :func:`@swagger_auto_schema <.swagger_auto_schema>` decora
         def partial_update(self, request, *args, **kwargs):
            ...

+.. Tip::
+
+   If you want to customize the generation of a method you are not implementing yourself, you can use
+   ``swagger_auto_schema`` in combination with Django's ``method_decorator``:
+
+   .. code:: python
+
+      @method_decorator(name='list', decorator=swagger_auto_schema(
+          operation_description="description from swagger_auto_schema via method_decorator"
+      ))
+      class ArticleViewSet(viewsets.ModelViewSet):
+         ...
+
+   This allows you to avoid unnecessarily overriding the method.
+
+.. Tip::
+
+   You can go even further and directly decorate the result of ``as_view``, in the same manner you would
+   override an ``@api_view`` as described above:
+
+   .. code:: python
+
+      decorated_login_view = \
+         swagger_auto_schema(
+            method='post',
+            responses={status.HTTP_200_OK: LoginResponseSerializer}
+         )(LoginView.as_view())
+
+      urlpatterns = [
+         ...
+         url(r'^login/$', decorated_login_view, name='login')
+      ]
+
+   This can allow you to avoid skipping an unnecessary *subclass* altogether.
+
+.. Warning::
+
+   However, do note that both of the methods above can lead to unexpected (and maybe surprising) results by
+   replacing/decorating methods on the base class itself.

 *************************
 Subclassing and extending
@@ -161,7 +161,7 @@ DEFAULT_MODEL_DEPTH

 Controls how many levels are expaned by default when showing nested models.

-**Default**: :python:`2` |br|
+**Default**: :python:`3` |br|
 *Maps to parameter*: ``defaultModelExpandDepth``

 ******************
@@ -3,10 +3,375 @@
  "requires": true,
  "lockfileVersion": 1,
  "dependencies": {
+    "argparse": {
+      "version": "1.0.9",
+      "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.9.tgz",
+      "integrity": "sha1-c9g7wmP4bpf4zE9rrhsOkKfSLIY=",
+      "requires": {
+        "sprintf-js": "1.0.3"
+      }
+    },
+    "autolinker": {
+      "version": "0.15.3",
+      "resolved": "https://registry.npmjs.org/autolinker/-/autolinker-0.15.3.tgz",
+      "integrity": "sha1-NCQX2PLzRhsUzwkIjV7fh5HcmDI="
+    },
+    "builtin-status-codes": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/builtin-status-codes/-/builtin-status-codes-3.0.0.tgz",
+      "integrity": "sha1-hZgoeOIbmOHGZCXgPQF0eI9Wnug="
+    },
+    "call-me-maybe": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.1.tgz",
+      "integrity": "sha1-JtII6onje1y95gJQoV8DHBak1ms="
+    },
+    "clipboard": {
+      "version": "1.7.1",
+      "resolved": "https://registry.npmjs.org/clipboard/-/clipboard-1.7.1.tgz",
+      "integrity": "sha1-Ng1taUbpmnof7zleQrqStem1oWs=",
+      "optional": true,
+      "requires": {
+        "good-listener": "1.2.2",
+        "select": "1.1.2",
+        "tiny-emitter": "2.0.2"
+      }
+    },
+    "commander": {
+      "version": "2.12.2",
+      "resolved": "https://registry.npmjs.org/commander/-/commander-2.12.2.tgz",
+      "integrity": "sha512-BFnaq5ZOGcDN7FlrtBT4xxkgIToalIIxwjxLWVJ8bGTpe1LroqMiqQXdA7ygc7CRvaYS+9zfPGFnJqFSayx+AA==",
+      "optional": true
+    },
+    "core-js": {
+      "version": "2.5.3",
+      "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.5.3.tgz",
+      "integrity": "sha1-isw4NFgk8W2DZbfJtCWRaOjtYD4="
+    },
+    "core-util-is": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz",
+      "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac="
+    },
+    "debug": {
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
+      "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
+      "requires": {
+        "ms": "2.0.0"
+      }
+    },
+    "delegate": {
+      "version": "3.2.0",
+      "resolved": "https://registry.npmjs.org/delegate/-/delegate-3.2.0.tgz",
+      "integrity": "sha512-IofjkYBZaZivn0V8nnsMJGBr4jVLxHDheKSW88PyxS5QC4Vo9ZbZVvhzlSxY87fVq3STR6r+4cGepyHkcWOQSw==",
+      "optional": true
+    },
+    "dropkickjs": {
+      "version": "2.1.10",
+      "resolved": "https://registry.npmjs.org/dropkickjs/-/dropkickjs-2.1.10.tgz",
+      "integrity": "sha1-8TyUAhQdoJ50rfTmN5jXkiBEOPI="
+    },
+    "es6-promise": {
+      "version": "4.1.1",
+      "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.1.1.tgz",
+      "integrity": "sha512-OaU1hHjgJf+b0NzsxCg7NdIYERD6Hy/PEmFLTjw+b65scuisG3Kt4QoTvJ66BBkPZ581gr0kpoVzKnxniM8nng=="
+    },
+    "esprima": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.0.tgz",
+      "integrity": "sha512-oftTcaMu/EGrEIu904mWteKIv8vMuOgGYo7EhVJJN00R/EED9DCua/xxHRdYnKtcECzVg7xOWhflvJMnqcFZjw=="
+    },
+    "foreach": {
+      "version": "2.0.5",
+      "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.5.tgz",
+      "integrity": "sha1-C+4AUBiusmDQo6865ljdATbsG5k="
+    },
+    "format-util": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/format-util/-/format-util-1.0.3.tgz",
+      "integrity": "sha1-Ay3KShFiYqEsQ/TD7IVmQWxbLZU="
+    },
+    "good-listener": {
+      "version": "1.2.2",
+      "resolved": "https://registry.npmjs.org/good-listener/-/good-listener-1.2.2.tgz",
+      "integrity": "sha1-1TswzfkxPf+33JoNR3CWqm0UXFA=",
+      "optional": true,
+      "requires": {
+        "delegate": "3.2.0"
+      }
+    },
+    "hint.css": {
+      "version": "2.5.0",
+      "resolved": "https://registry.npmjs.org/hint.css/-/hint.css-2.5.0.tgz",
+      "integrity": "sha1-OMrjZn5C2R392+UDEAqzSTL2/WU="
+    },
+    "https-browserify": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/https-browserify/-/https-browserify-1.0.0.tgz",
+      "integrity": "sha1-7AbBDgo0wPL68Zn3/X/Hj//QPHM="
+    },
+    "inherits": {
+      "version": "2.0.3",
+      "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz",
+      "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4="
+    },
+    "isarray": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz",
+      "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE="
+    },
+    "js-yaml": {
+      "version": "3.10.0",
+      "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.10.0.tgz",
+      "integrity": "sha512-O2v52ffjLa9VeM43J4XocZE//WT9N0IiwDa3KSHH7Tu8CtH+1qM8SIZvnsTh6v+4yFy5KUY3BHUVwjpfAWsjIA==",
+      "requires": {
+        "argparse": "1.0.9",
+        "esprima": "4.0.0"
+      }
+    },
+    "json-pointer": {
+      "version": "0.6.0",
+      "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.0.tgz",
+      "integrity": "sha1-jlAFUKaqxUZKRzN32leqbMIoKNc=",
+      "requires": {
+        "foreach": "2.0.5"
+      }
+    },
+    "json-schema-ref-parser": {
+      "version": "3.3.1",
+      "resolved": "https://registry.npmjs.org/json-schema-ref-parser/-/json-schema-ref-parser-3.3.1.tgz",
+      "integrity": "sha512-stQTMhec2R/p2L9dH4XXRlpNCP0mY8QrLd/9Kl+8SHJQmwHtE1nDfXH4wbsSM+GkJMl8t92yZbI0OIol432CIQ==",
+      "requires": {
+        "call-me-maybe": "1.0.1",
+        "debug": "3.1.0",
+        "es6-promise": "4.1.1",
+        "js-yaml": "3.10.0",
+        "ono": "4.0.2",
+        "z-schema": "3.19.0"
+      }
+    },
+    "lodash.get": {
+      "version": "4.4.2",
+      "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz",
+      "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk="
+    },
+    "lodash.isequal": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
+      "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA="
+    },
+    "lunr": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/lunr/-/lunr-1.0.0.tgz",
+      "integrity": "sha1-XJJ2ySyRrDWpJBtQGNRnI9kuL18="
+    },
+    "ms": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+      "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+    },
+    "ono": {
+      "version": "4.0.2",
+      "resolved": "https://registry.npmjs.org/ono/-/ono-4.0.2.tgz",
+      "integrity": "sha512-EFXJFoeF+KkZW4lwmcPMKHp2ZU7o6CM+ccX2nPbEJKiJIdyqbIcS1v6pmNgeNJ6x4/vEYn0/8oz66qXSPnnmSQ==",
+      "requires": {
+        "format-util": "1.0.3"
+      }
+    },
+    "openapi-sampler": {
+      "version": "0.4.3",
+      "resolved": "https://registry.npmjs.org/openapi-sampler/-/openapi-sampler-0.4.3.tgz",
+      "integrity": "sha512-Ml6o1gt++ZQ4JKL344YRo/fX05yuM6C+l/mGVX2yjhu1BRKyrRK4Z46uBTKSVaag1xINBFwYG7dZdz/10AmPzA=="
+    },
+    "perfect-scrollbar": {
+      "version": "0.8.1",
+      "resolved": "https://registry.npmjs.org/perfect-scrollbar/-/perfect-scrollbar-0.8.1.tgz",
+      "integrity": "sha512-RNC5tX/JMRYR+qVdJTEAWnRxw0Yf9lvbO8lTuAOvgDODkiA8lveTSkvrNMhmaGKEyimJpJl+myb/syVS9YyPuw=="
+    },
+    "prismjs": {
+      "version": "1.9.0",
+      "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.9.0.tgz",
+      "integrity": "sha1-+j4tntw8OIfB8fMJXUHx+bQgDw8=",
+      "requires": {
+        "clipboard": "1.7.1"
+      }
+    },
+    "process-nextick-args": {
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-1.0.7.tgz",
+      "integrity": "sha1-FQ4gt1ZZCtP5EJPyWk8q2L/zC6M="
+    },
+    "readable-stream": {
+      "version": "2.3.3",
+      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.3.tgz",
+      "integrity": "sha512-m+qzzcn7KUxEmd1gMbchF+Y2eIUbieUaxkWtptyHywrX0rE8QEYqPC07Vuy4Wm32/xE16NcdBctb8S0Xe/5IeQ==",
+      "requires": {
+        "core-util-is": "1.0.2",
+        "inherits": "2.0.3",
+        "isarray": "1.0.0",
+        "process-nextick-args": "1.0.7",
+        "safe-buffer": "5.1.1",
+        "string_decoder": "1.0.3",
+        "util-deprecate": "1.0.2"
+      }
+    },
+    "redoc": {
+      "version": "1.19.3",
+      "resolved": "https://registry.npmjs.org/redoc/-/redoc-1.19.3.tgz",
+      "integrity": "sha1-DfPx+6S92G/+nGIAEzBxUjytVec=",
+      "requires": {
+        "core-js": "2.5.3",
+        "dropkickjs": "2.1.10",
+        "hint.css": "2.5.0",
+        "https-browserify": "1.0.0",
+        "json-pointer": "0.6.0",
+        "json-schema-ref-parser": "3.3.1",
+        "lunr": "1.0.0",
+        "mark.js": "github:julmot/mark.js#714c9523feca999267f1758da8cfd92d077105d0",
+        "openapi-sampler": "0.4.3",
+        "perfect-scrollbar": "0.8.1",
+        "prismjs": "1.9.0",
+        "remarkable": "1.7.1",
+        "scrollparent": "2.0.1",
+        "slugify": "1.2.6",
+        "stream-http": "2.7.2",
+        "ts-helpers": "1.1.2",
+        "zone.js": "0.8.18"
+      },
+      "dependencies": {
+        "mark.js": {
+          "version": "github:julmot/mark.js#714c9523feca999267f1758da8cfd92d077105d0"
+        }
+      }
+    },
+    "remarkable": {
+      "version": "1.7.1",
+      "resolved": "https://registry.npmjs.org/remarkable/-/remarkable-1.7.1.tgz",
+      "integrity": "sha1-qspJchALZqZCpjoQIcpLrBvjv/Y=",
+      "requires": {
+        "argparse": "0.1.16",
+        "autolinker": "0.15.3"
+      },
+      "dependencies": {
+        "argparse": {
+          "version": "0.1.16",
+          "resolved": "https://registry.npmjs.org/argparse/-/argparse-0.1.16.tgz",
+          "integrity": "sha1-z9AeD7uj1srtBJ+9dY1A9lGW9Xw=",
+          "requires": {
+            "underscore": "1.7.0",
+            "underscore.string": "2.4.0"
+          }
+        }
+      }
+    },
+    "safe-buffer": {
+      "version": "5.1.1",
+      "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.1.tgz",
+      "integrity": "sha512-kKvNJn6Mm93gAczWVJg7wH+wGYWNrDHdWvpUmHyEsgCtIwwo3bqPtV4tR5tuPaUhTOo/kvhVwd8XwwOllGYkbg=="
+    },
+    "scrollparent": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/scrollparent/-/scrollparent-2.0.1.tgz",
+      "integrity": "sha1-cV1bnMV3YPsivczDvvtb/gaxoxc="
+    },
+    "select": {
+      "version": "1.1.2",
+      "resolved": "https://registry.npmjs.org/select/-/select-1.1.2.tgz",
+      "integrity": "sha1-DnNQrN7ICxEIUoeG7B1EGNEbOW0=",
+      "optional": true
+    },
+    "slugify": {
+      "version": "1.2.6",
+      "resolved": "https://registry.npmjs.org/slugify/-/slugify-1.2.6.tgz",
+      "integrity": "sha512-796YAGnzEnLKQHAFf7H2q1nsjY/9qywSnF9ZkMUbs9he4aZaXO/zFUow0LZ95sBAiQjOX1EmGl23gTYaswiNaQ=="
+    },
+    "sprintf-js": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
+      "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw="
+    },
+    "stream-http": {
+      "version": "2.7.2",
+      "resolved": "https://registry.npmjs.org/stream-http/-/stream-http-2.7.2.tgz",
+      "integrity": "sha512-c0yTD2rbQzXtSsFSVhtpvY/vS6u066PcXOX9kBB3mSO76RiUQzL340uJkGBWnlBg4/HZzqiUXtaVA7wcRcJgEw==",
+      "requires": {
+        "builtin-status-codes": "3.0.0",
+        "inherits": "2.0.3",
+        "readable-stream": "2.3.3",
+        "to-arraybuffer": "1.0.1",
+        "xtend": "4.0.1"
+      }
+    },
+    "string_decoder": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz",
+      "integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==",
+      "requires": {
+        "safe-buffer": "5.1.1"
+      }
+    },
    "swagger-ui-dist": {
-      "version": "3.6.1",
-      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.6.1.tgz",
-      "integrity": "sha1-uzQgV/h2COTs2DlGMDSJxjYicgY="
+      "version": "3.8.0",
+      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.8.0.tgz",
+      "integrity": "sha1-BHfLOagE7a6Wx+COskDNWagEt3U="
+    },
+    "tiny-emitter": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/tiny-emitter/-/tiny-emitter-2.0.2.tgz",
+      "integrity": "sha512-2NM0auVBGft5tee/OxP4PI3d8WItkDM+fPnaRAVo6xTDI2knbz9eC5ArWGqtGlYqiH3RU5yMpdyTTO7MguC4ow==",
+      "optional": true
+    },
+    "to-arraybuffer": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/to-arraybuffer/-/to-arraybuffer-1.0.1.tgz",
+      "integrity": "sha1-fSKbH8xjfkZsoIEYCDanqr/4P0M="
+    },
+    "ts-helpers": {
+      "version": "1.1.2",
+      "resolved": "https://registry.npmjs.org/ts-helpers/-/ts-helpers-1.1.2.tgz",
+      "integrity": "sha1-/Gm+nx87rtAfsaDvjUz+dIgU2DU="
+    },
+    "underscore": {
+      "version": "1.7.0",
+      "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.7.0.tgz",
+      "integrity": "sha1-a7rwh3UA02vjTsqlhODbn+8DUgk="
+    },
+    "underscore.string": {
+      "version": "2.4.0",
+      "resolved": "https://registry.npmjs.org/underscore.string/-/underscore.string-2.4.0.tgz",
+      "integrity": "sha1-jN2PusTi0uoefi6Al8QvRCKA+Fs="
+    },
+    "util-deprecate": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
+      "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8="
+    },
+    "validator": {
+      "version": "9.2.0",
+      "resolved": "https://registry.npmjs.org/validator/-/validator-9.2.0.tgz",
+      "integrity": "sha512-6Ij4Eo0KM4LkR0d0IegOwluG5453uqT5QyF5SV5Ezvm8/zmkKI/L4eoraafZGlZPC9guLkwKzgypcw8VGWWnGA=="
+    },
+    "xtend": {
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz",
+      "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68="
+    },
+    "z-schema": {
+      "version": "3.19.0",
+      "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.19.0.tgz",
+      "integrity": "sha512-V94f3ODuluBS4kQLLjNhwoMek0dyIXCsvNu/A17dAyJ6sMhT5KkJQwSn07R0naByLIXJWMDk+ruMfI/3G3hS4Q==",
+      "requires": {
+        "commander": "2.12.2",
+        "lodash.get": "4.4.2",
+        "lodash.isequal": "4.5.0",
+        "validator": "9.2.0"
+      }
+    },
+    "zone.js": {
+      "version": "0.8.18",
+      "resolved": "https://registry.npmjs.org/zone.js/-/zone.js-0.8.18.tgz",
+      "integrity": "sha512-knKOBQM0oea3/x9pdyDuDi7RhxDlJhOIkeixXSiTKWLgs4LpK37iBc+1HaHwzlciHUKT172CymJFKo8Xgh+44Q=="
    }
  }
 }
@@ -1,6 +1,7 @@
 {
  "name": "drf-yasg",
  "dependencies": {
-    "swagger-ui-dist": "^3.6.1"
+    "redoc": "^1.19.3",
+    "swagger-ui-dist": "^3.8.0"
  }
 }
@@ -3,4 +3,4 @@ sphinx_rtd_theme==0.2.4
 Pillow==4.3.0
 readme_renderer==17.2

-Django==1.11.8
+Django==2.0
@@ -18,7 +18,7 @@ SWAGGER_DEFAULTS = {
    'DEEP_LINKING': False,
    'SHOW_EXTENSIONS': True,
    'DEFAULT_MODEL_RENDERING': 'model',
-    'DEFAULT_MODEL_DEPTH': 2,
+    'DEFAULT_MODEL_DEPTH': 3,
 }

 REDOC_DEFAULTS = {
@@ -1,14 +1,52 @@
+import re
 from collections import defaultdict, OrderedDict

-import django.db.models
 import uritemplate
-from coreapi.compat import force_text
-from rest_framework.schemas.generators import SchemaGenerator
-from rest_framework.schemas.inspectors import get_pk_description
+from rest_framework.schemas.generators import SchemaGenerator, EndpointEnumerator as _EndpointEnumerator

 from . import openapi
 from .inspectors import SwaggerAutoSchema
 from .openapi import ReferenceResolver
+from .utils import inspect_model_field, get_model_field
+
+PATH_PARAMETER_RE = re.compile(r'{(?P<parameter>\w+)}')
+
+
+class EndpointEnumerator(_EndpointEnumerator):
+    def get_path_from_regex(self, path_regex):
+        return self.unescape_path(super(EndpointEnumerator, self).get_path_from_regex(path_regex))
+
+    def unescape(self, s):
+        """Unescape all backslash escapes from `s`.
+
+        :param str s: string with backslash escapes
+        :rtype: str
+        """
+        # unlike .replace('\\', ''), this corectly transforms a double backslash into a single backslash
+        return re.sub(r'\\(.)', r'\1', s)
+
+    def unescape_path(self, path):
+        """Remove backslashes from all path components outside {parameters}. This is needed because
+        Django>=2.0 ``path()``/``RoutePattern`` aggresively escapes all non-parameter path components.
+
+        **NOTE:** this might destructively affect some url regex patterns that contain metacharacters (e.g. \w, \d)
+        outside path parameter groups; if you are in this category, God help you
+
+        :param str path: path possibly containing
+        :return: the unescaped path
+        :rtype: str
+        """
+        clean_path = ''
+        while path:
+            match = PATH_PARAMETER_RE.search(path)
+            if not match:
+                clean_path += self.unescape(path)
+                break
+            clean_path += self.unescape(path[:match.start()])
+            clean_path += match.group()
+            path = path[match.end():]
+
+        return clean_path


 class OpenAPISchemaGenerator(object):
@@ -16,6 +54,7 @@ class OpenAPISchemaGenerator(object):
    This class iterates over all registered API endpoints and returns an appropriate OpenAPI 2.0 compliant schema.
    Method implementations shamelessly stolen and adapted from rest_framework SchemaGenerator.
    """
+    endpoint_enumerator_class = EndpointEnumerator

    def __init__(self, info, version, url=None, patterns=None, urlconf=None):
        """
@@ -41,9 +80,9 @@ class OpenAPISchemaGenerator(object):
        :return: the generated Swagger specification
        :rtype: openapi.Swagger
        """
-        endpoints = self.get_endpoints(None if public else request)
+        endpoints = self.get_endpoints(request)
        components = ReferenceResolver(openapi.SCHEMA_DEFINITIONS)
-        paths = self.get_paths(endpoints, components)
+        paths = self.get_paths(endpoints, components, public)

        url = self._gen.url
        if not url and request is not None:
@@ -73,14 +112,14 @@ class OpenAPISchemaGenerator(object):
        return view

    def get_endpoints(self, request=None):
-        """Iterate over all the registered endpoints in the API.
+        """Iterate over all the registered endpoints in the API and return a fake view with the right parameters.

-        :param rest_framework.request.Request request: used for returning only endpoints available to the given request
+        :param rest_framework.request.Request request: request to bind to the endpoint views
        :return: {path: (view_class, list[(http_method, view_instance)])
        :rtype: dict
        """
-        inspector = self._gen.endpoint_inspector_cls(self._gen.patterns, self._gen.urlconf)
-        endpoints = inspector.get_api_endpoints()
+        enumerator = self.endpoint_enumerator_class(self._gen.patterns, self._gen.urlconf)
+        endpoints = enumerator.get_api_endpoints()

        view_paths = defaultdict(list)
        view_cls = {}
@@ -110,11 +149,12 @@ class OpenAPISchemaGenerator(object):
        """
        return self._gen.get_keys(subpath, method, view)

-    def get_paths(self, endpoints, components):
+    def get_paths(self, endpoints, components, public):
        """Generate the Swagger Paths for the API from the given endpoints.

        :param dict endpoints: endpoints as returned by get_endpoints
        :param ReferenceResolver components: resolver/container for Swagger References
+        :param bool public: if True, all endpoints are included regardless of access through `request`
        :rtype: openapi.Paths
        """
        if not endpoints:
@@ -128,7 +168,7 @@ class OpenAPISchemaGenerator(object):
            path_parameters = self.get_path_parameters(path, view_cls)
            operations = {}
            for method, view in methods:
-                if not self._gen.has_view_permissions(path, method, view):
+                if not public and not self._gen.has_view_permissions(path, method, view):
                    continue

                operation_keys = self.get_operation_keys(path[len(prefix):], method, view)
@@ -168,36 +208,20 @@ class OpenAPISchemaGenerator(object):
        :rtype: list[openapi.Parameter]
        """
        parameters = []
+        queryset = getattr(view_cls, 'queryset', None)
        model = getattr(getattr(view_cls, 'queryset', None), 'model', None)

        for variable in uritemplate.variables(path):
-            pattern = None
-            type = openapi.TYPE_STRING
-            description = None
-            if model is not None:
-                # Attempt to infer a field description if possible.
-                try:
-                    model_field = model._meta.get_field(variable)
-                except Exception:  # pragma: no cover
-                    model_field = None
-
-                if model_field is not None and model_field.help_text:
-                    description = force_text(model_field.help_text)
-                elif model_field is not None and model_field.primary_key:
-                    description = get_pk_description(model, model_field)
-
-                if hasattr(view_cls, 'lookup_value_regex') and getattr(view_cls, 'lookup_field', None) == variable:
-                    pattern = view_cls.lookup_value_regex
-                elif isinstance(model_field, django.db.models.AutoField):
-                    type = openapi.TYPE_INTEGER
+            model, model_field = get_model_field(queryset, variable)
+            attrs = inspect_model_field(model, model_field)
+            if hasattr(view_cls, 'lookup_value_regex') and getattr(view_cls, 'lookup_field', None) == variable:
+                attrs['pattern'] = view_cls.lookup_value_regex

            field = openapi.Parameter(
                name=variable,
                required=True,
                in_=openapi.IN_PATH,
-                type=type,
-                pattern=pattern,
-                description=description,
+                **attrs
            )
            parameters.append(field)

@@ -309,6 +309,7 @@ class Items(SwaggerDict):
        :param .Items items: only valid if `type` is ``array``
        """
        super(Items, self).__init__(**extra)
+        assert type is not None, "type is required!"
        self.type = type
        self.format = format
        self.enum = enum
@@ -372,6 +373,7 @@ class Schema(SwaggerDict):
            # common error
            raise AssertionError(
                "the `requires` attribute of schema must be an array of required properties, not a boolean!")
+        assert type is not None, "type is required!"
        self.description = description
        self.required = required
        self.type = type
@@ -84,6 +84,7 @@ class _UIRenderer(BaseRenderer):
            'showExtensions': swagger_settings.SHOW_EXTENSIONS,
            'defaultModelRendering': swagger_settings.DEFAULT_MODEL_RENDERING,
            'defaultModelExpandDepth': swagger_settings.DEFAULT_MODEL_DEPTH,
+            'defaultModelsExpandDepth': swagger_settings.DEFAULT_MODEL_DEPTH,
        }
        data = {k: v for k, v in data.items() if v is not None}
        if swagger_settings.VALIDATOR_URL != '':
@@ -163,7 +163,14 @@
            plugins: [
                SwaggerUIBundle.plugins.DownloadUrl
            ],
-            layout: "StandaloneLayout"
+            layout: "StandaloneLayout",
+            filter: true,
+            requestInterceptor: function(request) {
+                console.log(request);
+                var headers = request.headers || {};
+                headers["X-CSRFToken"] = document.querySelector("[name=csrfmiddlewaretoken]").value;
+                return request;
+            }
        };

        var swaggerSettings = {};
@@ -1,13 +1,20 @@
+import logging
 from collections import OrderedDict

 from django.core.validators import RegexValidator
+from django.db import models
 from django.utils.encoding import force_text
 from rest_framework import serializers
 from rest_framework.mixins import RetrieveModelMixin, DestroyModelMixin, UpdateModelMixin
+from rest_framework.schemas.inspectors import get_pk_description
+from rest_framework.settings import api_settings
+from rest_framework.utils import json, encoders

 from . import openapi
 from .errors import SwaggerGenerationError

+logger = logging.getLogger(__name__)
+
 #: used to forcibly remove the body of a request via :func:`.swagger_auto_schema`
 no_body = object()

@@ -156,6 +163,87 @@ def swagger_auto_schema(method=None, methods=None, auto_schema=None, request_bod
    return decorator


+def get_model_field(queryset, field_name):
+    """Try to get information about a model and model field from a queryset.
+
+    :param queryset: the queryset
+    :param field_name: the target field name
+    :returns: the model and target field from the queryset as a 2-tuple; both elements can be ``None``
+    :rtype: tuple
+    """
+    model = getattr(queryset, 'model', None)
+    try:
+        model_field = model._meta.get_field(field_name)
+    except Exception:  # pragma: no cover
+        model_field = None
+
+    return model, model_field
+
+
+model_field_to_swagger_type = [
+    (models.AutoField, (openapi.TYPE_INTEGER, None)),
+    (models.BinaryField, (openapi.TYPE_STRING, openapi.FORMAT_BINARY)),
+    (models.BooleanField, (openapi.TYPE_BOOLEAN, None)),
+    (models.NullBooleanField, (openapi.TYPE_BOOLEAN, None)),
+    (models.DateTimeField, (openapi.TYPE_STRING, openapi.FORMAT_DATETIME)),
+    (models.DateField, (openapi.TYPE_STRING, openapi.FORMAT_DATE)),
+    (models.DecimalField, (openapi.TYPE_NUMBER, None)),
+    (models.DurationField, (openapi.TYPE_INTEGER, None)),
+    (models.FloatField, (openapi.TYPE_NUMBER, None)),
+    (models.IntegerField, (openapi.TYPE_INTEGER, None)),
+    (models.IPAddressField, (openapi.TYPE_STRING, openapi.FORMAT_IPV4)),
+    (models.GenericIPAddressField, (openapi.TYPE_STRING, openapi.FORMAT_IPV6)),
+    (models.SlugField, (openapi.TYPE_STRING, openapi.FORMAT_SLUG)),
+    (models.TextField, (openapi.TYPE_STRING, None)),
+    (models.TimeField, (openapi.TYPE_STRING, None)),
+    (models.UUIDField, (openapi.TYPE_STRING, openapi.FORMAT_UUID)),
+    (models.CharField, (openapi.TYPE_STRING, None)),
+]
+
+
+def inspect_model_field(model, model_field):
+    """Extract information from a django model field instance.
+
+    :param model: the django model
+    :param model_field: a field on the model
+    :return: description, type, format and pattern extracted from the model field
+    :rtype: OrderedDict
+    """
+    if model is not None and model_field is not None:
+        for model_field_class, tf in model_field_to_swagger_type:
+            if isinstance(model_field, model_field_class):
+                swagger_type, format = tf
+                break
+        else:  # pragma: no cover
+            swagger_type, format = None, None
+
+        if format is None or format == openapi.FORMAT_SLUG:
+            pattern = find_regex(model_field)
+        else:
+            pattern = None
+
+        if model_field.help_text:
+            description = force_text(model_field.help_text)
+        elif model_field.primary_key:
+            description = get_pk_description(model, model_field)
+        else:
+            description = None
+    else:
+        description = None
+        swagger_type = None
+        format = None
+        pattern = None
+
+    result = OrderedDict([
+        ('description', description),
+        ('type', swagger_type or openapi.TYPE_STRING),
+        ('format', format),
+        ('pattern', pattern)
+    ])
+    # TODO: filter none
+    return result
+
+
 def serializer_field_to_swagger(field, swagger_object_type, definitions=None, **kwargs):
    """Convert a drf Serializer or Field instance into a Swagger object.

@@ -175,14 +263,50 @@ def serializer_field_to_swagger(field, swagger_object_type, definitions=None, **
    description = force_text(field.help_text) if field.help_text else None
    description = description if swagger_object_type != openapi.Items else None  # Items has no description either

-    def SwaggerType(**instance_kwargs):
-        if swagger_object_type == openapi.Parameter:
+    def SwaggerType(existing_object=None, **instance_kwargs):
+        if swagger_object_type == openapi.Parameter and 'required' not in instance_kwargs:
            instance_kwargs['required'] = field.required
-        if swagger_object_type != openapi.Items:
+        if swagger_object_type != openapi.Items and 'default' not in instance_kwargs:
            default = getattr(field, 'default', serializers.empty)
            if default is not serializers.empty:
-                instance_kwargs['default'] = default
+                if callable(default):
+                    try:
+                        if hasattr(default, 'set_context'):
+                            default.set_context(field)
+                        default = default()
+                    except Exception as e:  # pragma: no cover
+                        logger.warning("default for %s is callable but it raised an exception when "
+                                       "called; 'default' field will not be added to schema", field, exc_info=True)
+                        default = None
+
+                if default is not None:
+                    try:
+                        default = field.to_representation(default)
+                        # JSON roundtrip ensures that the value is valid JSON;
+                        # for example, sets get transformed into lists
+                        default = json.loads(json.dumps(default, cls=encoders.JSONEncoder))
+                    except Exception:  # pragma: no cover
+                        logger.warning("'default' on schema for %s will not be set because "
+                                       "to_representation raised an exception", field, exc_info=True)
+                        default = None
+
+                if default is not None:
+                    instance_kwargs['default'] = default
+
+        if swagger_object_type == openapi.Schema and 'read_only' not in instance_kwargs:
+            if field.read_only:
+                instance_kwargs['read_only'] = True
        instance_kwargs.update(kwargs)
+        instance_kwargs.pop('title', None)
+        instance_kwargs.pop('description', None)
+
+        if existing_object is not None:
+            existing_object.title = title
+            existing_object.description = description
+            for attr, val in instance_kwargs.items():
+                setattr(existing_object, attr, val)
+            return existing_object
+
        return swagger_object_type(title=title, description=description, **instance_kwargs)

    # arrays in Schema have Schema elements, arrays in Parameter and Items have Items elements
@@ -213,8 +337,6 @@ def serializer_field_to_swagger(field, swagger_object_type, definitions=None, **
            required = []
            for key, value in serializer.fields.items():
                properties[key] = serializer_field_to_swagger(value, ChildSwaggerType, definitions)
-                if value.read_only:
-                    properties[key].read_only = value.read_only
                if value.required:
                    required.append(key)

@@ -236,8 +358,29 @@ def serializer_field_to_swagger(field, swagger_object_type, definitions=None, **
            items=child_schema,
            unique_items=True,  # is this OK?
        )
+    elif isinstance(field, serializers.PrimaryKeyRelatedField):
+        if field.pk_field:
+            result = serializer_field_to_swagger(field.pk_field, swagger_object_type, definitions, **kwargs)
+            return SwaggerType(existing_object=result)
+
+        attrs = {'type': openapi.TYPE_STRING}
+        try:
+            model = field.queryset.model
+            pk_field = model._meta.pk
+        except Exception:  # pragma: no cover
+            logger.warning("an exception was raised when attempting to extract the primary key related to %s; "
+                           "falling back to plain string" % field, exc_info=True)
+        else:
+            attrs.update(inspect_model_field(model, pk_field))
+
+        return SwaggerType(**attrs)
+    elif isinstance(field, serializers.HyperlinkedRelatedField):
+        return SwaggerType(type=openapi.TYPE_STRING, format=openapi.FORMAT_URI)
+    elif isinstance(field, serializers.SlugRelatedField):
+        model, model_field = get_model_field(field.queryset, field.slug_field)
+        attrs = inspect_model_field(model, model_field)
+        return SwaggerType(**attrs)
    elif isinstance(field, serializers.RelatedField):
-        # TODO: infer type for PrimaryKeyRelatedField?
        return SwaggerType(type=openapi.TYPE_STRING)
    # ------ CHOICES
    elif isinstance(field, serializers.MultipleChoiceField):
@@ -251,7 +394,7 @@ def serializer_field_to_swagger(field, swagger_object_type, definitions=None, **
    elif isinstance(field, serializers.ChoiceField):
        return SwaggerType(type=openapi.TYPE_STRING, enum=list(field.choices.keys()))
    # ------ BOOL
-    elif isinstance(field, serializers.BooleanField):
+    elif isinstance(field, (serializers.BooleanField, serializers.NullBooleanField)):
        return SwaggerType(type=openapi.TYPE_BOOLEAN)
    # ------ NUMERIC
    elif isinstance(field, (serializers.DecimalField, serializers.FloatField)):
@@ -260,6 +403,8 @@ def serializer_field_to_swagger(field, swagger_object_type, definitions=None, **
    elif isinstance(field, serializers.IntegerField):
        # TODO: min_value max_value
        return SwaggerType(type=openapi.TYPE_INTEGER)
+    elif isinstance(field, serializers.DurationField):
+        return SwaggerType(type=openapi.TYPE_INTEGER)
    # ------ STRING
    elif isinstance(field, serializers.EmailField):
        return SwaggerType(type=openapi.TYPE_STRING, format=openapi.FORMAT_EMAIL)
@@ -286,21 +431,30 @@ def serializer_field_to_swagger(field, swagger_object_type, definitions=None, **
    elif isinstance(field, serializers.FileField):
        # swagger 2.0 does not support specifics about file fields, so ImageFile gets no special treatment
        # OpenAPI 3.0 does support it, so a future implementation could handle this better
-        err = SwaggerGenerationError("parameter of type file is supported only in a formData Parameter")
-        if swagger_object_type != openapi.Parameter:
+        err = SwaggerGenerationError("FileField is supported only in a formData Parameter or response Schema")
+        if swagger_object_type == openapi.Schema:
+            # FileField.to_representation returns URL or file name
+            result = SwaggerType(type=openapi.TYPE_STRING, read_only=True)
+            if getattr(field, 'use_url', api_settings.UPLOADED_FILES_USE_URL):
+                result.format = openapi.FORMAT_URI
+            return result
+        elif swagger_object_type == openapi.Parameter:
+            param = SwaggerType(type=openapi.TYPE_FILE)
+            if param['in'] != openapi.IN_FORM:
+                raise err  # pragma: no cover
+            return param
+        else:
            raise err  # pragma: no cover
-        param = SwaggerType(type=openapi.TYPE_FILE)
-        if param['in'] != openapi.IN_FORM:
-            raise err  # pragma: no cover
-        return param
    elif isinstance(field, serializers.DictField) and swagger_object_type == openapi.Schema:
        child_schema = serializer_field_to_swagger(field.child, ChildSwaggerType, definitions)
        return SwaggerType(
            type=openapi.TYPE_OBJECT,
            additional_properties=child_schema
        )
+    elif isinstance(field, serializers.ModelField):
+        return SwaggerType(type=openapi.TYPE_STRING)

-    # TODO unhandled fields: TimeField DurationField HiddenField ModelField NullBooleanField? JSONField
+    # TODO unhandled fields: TimeField HiddenField JSONField

    # everything else gets string by default
    return SwaggerType(type=openapi.TYPE_STRING)
@@ -1,6 +1,8 @@
-# Generated by Django 2.0 on 2017-12-05 04:05
+# Generated by Django 2.0 on 2017-12-23 09:07

+from django.conf import settings
 from django.db import migrations, models
+import django.db.models.deletion


 class Migration(migrations.Migration):
@@ -8,6 +10,7 @@ class Migration(migrations.Migration):
    initial = True

    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
    ]

    operations = [
@@ -15,12 +18,13 @@ class Migration(migrations.Migration):
            name='Article',
            fields=[
                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('title', models.CharField(help_text='Main article headline', max_length=255, unique=True)),
-                ('body', models.TextField(help_text='Article content', max_length=5000)),
-                ('slug', models.SlugField(blank=True, help_text='Unique URL slug identifying the article', unique=True)),
+                ('title', models.CharField(help_text='title model help_text', max_length=255, unique=True)),
+                ('body', models.TextField(help_text='article model help_text', max_length=5000)),
+                ('slug', models.SlugField(blank=True, help_text='slug model help_text', unique=True)),
                ('date_created', models.DateTimeField(auto_now_add=True)),
                ('date_modified', models.DateTimeField(auto_now=True)),
                ('cover', models.ImageField(blank=True, upload_to='article/original/')),
+                ('author', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='articles', to=settings.AUTH_USER_MODEL)),
            ],
        ),
    ]
@@ -7,5 +7,6 @@ class Article(models.Model):
    slug = models.SlugField(help_text="slug model help_text", unique=True, blank=True)
    date_created = models.DateTimeField(auto_now_add=True)
    date_modified = models.DateTimeField(auto_now=True)
+    author = models.ForeignKey('auth.User', related_name='articles', on_delete=models.CASCADE)

    cover = models.ImageField(upload_to='article/original/', blank=True)
@@ -7,15 +7,26 @@ class ArticleSerializer(serializers.ModelSerializer):
    references = serializers.DictField(
        help_text="this is a really bad example",
        child=serializers.URLField(help_text="but i needed to test these 2 fields somehow"),
+        read_only=True,
    )
-    uuid = serializers.UUIDField(help_text="should articles have UUIDs?")
+    uuid = serializers.UUIDField(help_text="should articles have UUIDs?", read_only=True)
+    cover_name = serializers.FileField(use_url=False, source='cover', read_only=True)

    class Meta:
        model = Article
-        fields = ('title', 'body', 'slug', 'date_created', 'date_modified', 'references', 'uuid')
-        read_only_fields = ('date_created', 'date_modified')
+        fields = ('title', 'author', 'body', 'slug', 'date_created', 'date_modified',
+                  'references', 'uuid', 'cover', 'cover_name')
+        read_only_fields = ('date_created', 'date_modified',
+                            'references', 'uuid', 'cover_name')
        lookup_field = 'slug'
-        extra_kwargs = {'body': {'help_text': 'body serializer help_text'}}
+        extra_kwargs = {
+            'body': {'help_text': 'body serializer help_text'},
+            'author': {
+                'default': serializers.CurrentUserDefault(),
+                'help_text': "The ID of the user that created this article; if none is provided, "
+                             "defaults to the currently logged in user."
+            },
+        }


 class ImageUploadSerializer(serializers.Serializer):
@@ -1,5 +1,6 @@
 import datetime

+from django.utils.decorators import method_decorator
 from django_filters.rest_framework import DjangoFilterBackend
 from rest_framework import viewsets
 from rest_framework.decorators import detail_route, list_route
@@ -19,6 +20,14 @@ class NoPagingAutoSchema(SwaggerAutoSchema):
        return False


+class ArticlePagination(LimitOffsetPagination):
+    default_limit = 5
+    max_limit = 25
+
+
+@method_decorator(name='list', decorator=swagger_auto_schema(
+    operation_description="description from swagger_auto_schema via method_decorator"
+))
 class ArticleViewSet(viewsets.ModelViewSet):
    """
    ArticleViewSet class docstring
@@ -37,12 +46,11 @@ class ArticleViewSet(viewsets.ModelViewSet):
    lookup_value_regex = r'[a-z0-9]+(?:-[a-z0-9]+)'
    serializer_class = serializers.ArticleSerializer

-    pagination_class = LimitOffsetPagination
-    max_page_size = 5
+    pagination_class = ArticlePagination
    filter_backends = (DjangoFilterBackend, OrderingFilter)
    filter_fields = ('title',)
-    ordering_fields = ('date_modified',)
-    ordering = ('username',)
+    ordering_fields = ('date_modified', 'date_created')
+    ordering = ('date_created',)

    @swagger_auto_schema(auto_schema=NoPagingAutoSchema)
    @list_route(methods=['get'])
@@ -1,27 +0,0 @@
-# Generated by Django 2.0 on 2017-12-05 04:05
-
-from django.conf import settings
-from django.db import migrations, models
-import django.db.models.deletion
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
-        ('snippets', '0001_initial'),
-    ]
-
-    operations = [
-        migrations.AddField(
-            model_name='snippet',
-            name='owner',
-            field=models.ForeignKey(default='', on_delete=django.db.models.deletion.CASCADE, related_name='snippets', to=settings.AUTH_USER_MODEL),
-            preserve_default=False,
-        ),
-        migrations.AlterField(
-            model_name='snippet',
-            name='code',
-            field=models.TextField(help_text='code model help text'),
-        ),
-    ]
@@ -1,3 +1,4 @@
+from django.contrib.auth import get_user_model
 from rest_framework import serializers

 from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES
@@ -23,20 +24,35 @@ class SnippetSerializer(serializers.Serializer):
    create: docstring for create from serializer classdoc
    """
    id = serializers.IntegerField(read_only=True, help_text="id serializer help text")
-    owner = serializers.ReadOnlyField(source='owner.username')
+    owner = serializers.PrimaryKeyRelatedField(
+        queryset=get_user_model().objects.all(),
+        default=serializers.CurrentUserDefault(),
+        help_text="The ID of the user that created this snippet; if none is provided, "
+                  "defaults to the currently logged in user."
+    )
+    owner_as_string = serializers.PrimaryKeyRelatedField(
+        help_text="The ID of the user that created this snippet.",
+        pk_field=serializers.CharField(help_text="this help text should not show up"),
+        read_only=True,
+        source='owner',
+    )
    title = serializers.CharField(required=False, allow_blank=True, max_length=100)
    code = serializers.CharField(style={'base_template': 'textarea.html'})
    linenos = serializers.BooleanField(required=False)
    language = LanguageSerializer(help_text="Sample help text for language")
    styles = serializers.MultipleChoiceField(choices=STYLE_CHOICES, default=['friendly'])
    lines = serializers.ListField(child=serializers.IntegerField(), allow_empty=True, allow_null=True, required=False)
-    example_projects = serializers.ListSerializer(child=ExampleProjectSerializer())
-    difficulty_factor = serializers.FloatField(help_text="this is here just to test FloatField")
+    example_projects = serializers.ListSerializer(child=ExampleProjectSerializer(), read_only=True)
+    difficulty_factor = serializers.FloatField(help_text="this is here just to test FloatField",
+                                               read_only=True, default=lambda: 6.9)

    def create(self, validated_data):
        """
        Create and return a new `Snippet` instance, given the validated data.
        """
+        del validated_data['styles']
+        del validated_data['lines']
+        del validated_data['difficulty_factor']
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
@@ -1,8 +1,17 @@
-from django.conf.urls import url
+import django

 from . import views

-urlpatterns = [
-    url(r'$', views.SnippetList.as_view()),
-    url(r'^(?P<pk>[0-9]+)/$', views.SnippetDetail.as_view()),
-]
+if django.VERSION[:2] >= (2, 0):
+    from django.urls import path
+
+    urlpatterns = [
+        path('', views.SnippetList.as_view()),
+        path('<int:pk>/', views.SnippetDetail.as_view()),
+    ]
+else:
+    from django.conf.urls import url
+    urlpatterns = [
+        url('^$', views.SnippetList.as_view()),
+        url(r'^(?P<pk>\d+)/$', views.SnippetDetail.as_view()),
+    ]
@@ -6,14 +6,16 @@ from snippets.models import Snippet

 class UserSerializerrr(serializers.ModelSerializer):
    snippets = serializers.PrimaryKeyRelatedField(many=True, queryset=Snippet.objects.all())
+    article_slugs = serializers.SlugRelatedField(read_only=True, slug_field='slug', many=True, source='articlessss')
    last_connected_ip = serializers.IPAddressField(help_text="i'm out of ideas", protocol='ipv4', read_only=True)
    last_connected_at = serializers.DateField(help_text="really?", read_only=True)

    class Meta:
        model = User
-        fields = ('id', 'username', 'email', 'snippets', 'last_connected_ip', 'last_connected_at')
+        fields = ('id', 'username', 'email', 'articles', 'snippets',
+                  'last_connected_ip', 'last_connected_at', 'article_slugs')


 class UserListQuerySerializer(serializers.Serializer):
-    username = serializers.CharField(help_text="this field is generated from a query_serializer")
-    is_staff = serializers.BooleanField(help_text="this one too!")
+    username = serializers.CharField(help_text="this field is generated from a query_serializer", required=False)
+    is_staff = serializers.BooleanField(help_text="this one too!", required=False)
@@ -4,5 +4,5 @@ from users import views

 urlpatterns = [
    url(r'^$', views.UserList.as_view()),
-    url(r'^(?P<pk>[0-9]+)/$', views.user_detail),
+    url(r'^(?P<pk>\d+)/$', views.user_detail),
 ]
@@ -3,6 +3,9 @@ import json
 import os

 import pytest
+from django.contrib.auth.models import User
+from rest_framework.test import APIRequestFactory
+from rest_framework.views import APIView
 from ruamel import yaml

 from drf_yasg import openapi, codecs
@@ -10,11 +13,16 @@ from drf_yasg.generators import OpenAPISchemaGenerator


@pytest.fixture
-def generator():
-    return OpenAPISchemaGenerator(
-        info=openapi.Info(title="Test generator", default_version="v1"),
-        version="v2",
-    )
+def mock_schema_request(db):
+    from rest_framework.test import force_authenticate
+
+    factory = APIRequestFactory()
+    user = User.objects.create_user(username='admin', is_staff=True, is_superuser=True)
+
+    request = factory.get('/swagger.json')
+    force_authenticate(request, user=user)
+    request = APIView().initialize_request(request)
+    return request


@pytest.fixture
@@ -28,19 +36,22 @@ def codec_yaml():


@pytest.fixture
-def swagger(generator):
-    return generator.get_schema(None, True)
+def swagger(mock_schema_request):
+    generator = OpenAPISchemaGenerator(
+        info=openapi.Info(title="Test generator", default_version="v1"),
+        version="v2",
+    )
+    return generator.get_schema(mock_schema_request, True)


@pytest.fixture
-def swagger_dict(generator):
-    swagger = generator.get_schema(None, True)
+def swagger_dict(swagger):
    json_bytes = codec_json().encode(swagger)
    return json.loads(json_bytes.decode('utf-8'))


@pytest.fixture
-def validate_schema():
+def validate_schema(db):
    def validate_schema(swagger):
        from flex.core import parse as validate_flex
        from swagger_spec_validator.validator20 import validate_spec as validate_ssv
@@ -16,7 +16,7 @@ paths:
  /articles/:
    get:
      operationId: articles_list
-      description: ArticleViewSet class docstring
+      description: description from swagger_auto_schema via method_decorator
      parameters:
        - name: title
          in: query
@@ -178,6 +178,7 @@ paths:
        description: slug model help_text
        required: true
        type: string
+        format: slug
        pattern: '[a-z0-9]+(?:-[a-z0-9]+)'
  /articles/{slug}/image/:
    get:
@@ -231,6 +232,7 @@ paths:
        description: slug model help_text
        required: true
        type: string
+        format: slug
        pattern: '[a-z0-9]+(?:-[a-z0-9]+)'
  /plain/:
    get:
@@ -355,12 +357,12 @@ paths:
        - name: username
          in: query
          description: this field is generated from a query_serializer
-          required: true
+          required: false
          type: string
        - name: is_staff
          in: query
          description: this one too!
-          required: true
+          required: false
          type: boolean
      responses:
        '200':
@@ -459,13 +461,16 @@ definitions:
    required:
      - title
      - body
-      - references
-      - uuid
    type: object
    properties:
      title:
        description: title model help_text
        type: string
+      author:
+        description: The ID of the user that created this article; if none is provided,
+          defaults to the currently logged in user.
+        type: integer
+        default: 1
      body:
        description: body serializer help_text
        type: string
@@ -489,10 +494,19 @@ definitions:
          description: but i needed to test these 2 fields somehow
          type: string
          format: uri
+        readOnly: true
      uuid:
        description: should articles have UUIDs?
        type: string
        format: uuid
+        readOnly: true
+      cover:
+        type: string
+        readOnly: true
+        format: uri
+      cover_name:
+        type: string
+        readOnly: true
  Project:
    required:
      - project_name
@@ -509,8 +523,6 @@ definitions:
    required:
      - code
      - language
-      - example_projects
-      - difficulty_factor
    type: object
    properties:
      id:
@@ -518,6 +530,12 @@ definitions:
        type: integer
        readOnly: true
      owner:
+        description: The ID of the user that created this snippet; if none is provided,
+          defaults to the currently logged in user.
+        type: integer
+        default: 1
+      owner_as_string:
+        description: The ID of the user that created this snippet.
        type: string
        readOnly: true
      title:
@@ -1013,12 +1031,16 @@ definitions:
        type: array
        items:
          $ref: '#/definitions/Project'
+        readOnly: true
      difficulty_factor:
        description: this is here just to test FloatField
        type: number
+        default: 6.9
+        readOnly: true
  UserSerializerrr:
    required:
      - username
+      - articles
      - snippets
    type: object
    properties:
@@ -1032,10 +1054,15 @@ definitions:
      email:
        type: string
        format: email
+      articles:
+        type: array
+        items:
+          type: integer
+        uniqueItems: true
      snippets:
        type: array
        items:
-          type: string
+          type: integer
        uniqueItems: true
      last_connected_ip:
        description: i'm out of ideas
@@ -1047,6 +1074,13 @@ definitions:
        type: string
        format: date
        readOnly: true
+      article_slugs:
+        type: array
+        items:
+          type: string
+          readOnly: true
+        uniqueItems: true
+        readOnly: true
 securityDefinitions:
  basic:
    type: basic
@@ -12,7 +12,7 @@ def test_appropriate_status_codes(swagger_dict):

 def test_operation_docstrings(swagger_dict):
    articles_list = swagger_dict['paths']['/articles/']
-    assert articles_list['get']['description'] == "ArticleViewSet class docstring"
+    assert articles_list['get']['description'] == "description from swagger_auto_schema via method_decorator"
    assert articles_list['post']['description'] == "ArticleViewSet class docstring"

    articles_detail = swagger_dict['paths']['/articles/{slug}/']
@@ -2,7 +2,6 @@ from datadiff.tools import assert_equal


 def test_reference_schema(swagger_dict, reference_schema):
-    # formatted better than pytest diff
    swagger_dict = dict(swagger_dict)
    reference_schema = dict(reference_schema)
    ignore = ['info', 'host', 'schemes', 'basePath', 'securityDefinitions']
@@ -10,4 +9,5 @@ def test_reference_schema(swagger_dict, reference_schema):
        swagger_dict.pop(attr, None)
        reference_schema.pop(attr, None)

+    # formatted better than pytest diff
    assert_equal(swagger_dict, reference_schema)
@@ -7,16 +7,11 @@ from drf_yasg import openapi, codecs
 from drf_yasg.generators import OpenAPISchemaGenerator


-def test_schema_generates_without_errors(generator):
-    generator.get_schema(None, True)
-
-
-def test_schema_is_valid(generator, codec_yaml):
-    swagger = generator.get_schema(request=None, public=False)
+def test_schema_is_valid(swagger, codec_yaml):
    codec_yaml.encode(swagger)


-def test_invalid_schema_fails(codec_json):
+def test_invalid_schema_fails(codec_json, mock_schema_request):
    # noinspection PyTypeChecker
    bad_generator = OpenAPISchemaGenerator(
        info=openapi.Info(
@@ -26,40 +21,37 @@ def test_invalid_schema_fails(codec_json):
        version="v2",
    )

-    swagger = bad_generator.get_schema(None, True)
+    swagger = bad_generator.get_schema(mock_schema_request, True)
    with pytest.raises(codecs.SwaggerValidationError):
        codec_json.encode(swagger)


-def test_json_codec_roundtrip(codec_json, generator, validate_schema):
-    swagger = generator.get_schema(None, True)
+def test_json_codec_roundtrip(codec_json, swagger, validate_schema):
    json_bytes = codec_json.encode(swagger)
    validate_schema(json.loads(json_bytes.decode('utf-8')))


-def test_yaml_codec_roundtrip(codec_yaml, generator, validate_schema):
-    swagger = generator.get_schema(None, True)
+def test_yaml_codec_roundtrip(codec_yaml, swagger, validate_schema):
    yaml_bytes = codec_yaml.encode(swagger)
    assert b'omap' not in yaml_bytes  # ensure no ugly !!omap is outputted
    assert b'&id' not in yaml_bytes and b'*id' not in yaml_bytes  # ensure no YAML references are generated
    validate_schema(yaml.safe_load(yaml_bytes.decode('utf-8')))


-def test_yaml_and_json_match(codec_yaml, codec_json, generator):
-    swagger = generator.get_schema(None, True)
+def test_yaml_and_json_match(codec_yaml, codec_json, swagger):
    yaml_schema = yaml.safe_load(codec_yaml.encode(swagger).decode('utf-8'))
    json_schema = json.loads(codec_json.encode(swagger).decode('utf-8'))
    assert yaml_schema == json_schema


-def test_basepath_only():
+def test_basepath_only(mock_schema_request):
    generator = OpenAPISchemaGenerator(
        info=openapi.Info(title="Test generator", default_version="v1"),
        version="v2",
        url='/basepath/',
    )

-    swagger = generator.get_schema(None, public=True)
+    swagger = generator.get_schema(mock_schema_request, public=True)
    assert 'host' not in swagger
    assert 'schemes' not in swagger
    assert swagger['basePath'] == '/'  # base path is not implemented for now
@@ -30,7 +30,7 @@ deps =
    -rrequirements/test.txt

 commands =
-    pytest --cov-config .coveragerc --cov-append --cov
+    pytest --cov-config .coveragerc --cov-append --cov {posargs}

 [testenv:py36-drfmaster]
 pip_pre = True
@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+
+npm update
+cp node_modules/redoc/dist/redoc.min.js src/drf_yasg/static/drf-yasg/redoc/redoc.min.js
+cp -r node_modules/swagger-ui-dist src/drf_yasg/static/drf-yasg/
+rm -f src/drf_yasg/static/drf-yasg/swagger-ui-dist/package.json src/drf_yasg/static/drf-yasg/swagger-ui-dist/.npmignore
Author	SHA1	Message	Date
Cristi Vîjdea	73adc49b2c	Prepare release 1.0.6	2017-12-23 12:29:34 +01:00
Cristi Vîjdea	313d122004	Update swagger-ui to 3.8.0	2017-12-23 12:29:19 +01:00
Cristi Vîjdea	443d74b636	Merge pull request #27 from axnsan12/fix/callable-default Fix callable default handling	2017-12-23 12:22:35 +01:00
Cristi Vîjdea	43034ddc4b	Fixed assumption of dict ordering	2017-12-23 12:04:02 +01:00
Cristi Vîjdea	9f6ee4da87	Improve RelatedField and callable default handling - callable default values will now be properly called - PrimaryKeyRelatedField and SlugRelatedField will now return an appropriate type based on the relation model's Field - mock views now have a request object bound even when public is True	2017-12-23 11:52:57 +01:00
Nicolas Delaby	f05889292a	Add type inspection for PrimaryKeyRelatedField (#26 ) Guess the type for PrimaryKeyRelatedField from the related ModelField.	2017-12-22 21:00:13 +01:00
Cristi Vîjdea	8a8a9faeeb	Fix swagger Try it out and make endpoints work	2017-12-21 17:20:46 +01:00
Cristi Vîjdea	7683a28816	Merge pull request #20 from axnsan12/release/1.0.5 Version 1.0.5	2017-12-18 16:15:55 +01:00
Cristi Vîjdea	260a994baf	Disable Codecov build failures	2017-12-18 15:33:09 +01:00
Cristi Vîjdea	6060192a89	Update changelog and clean up code	2017-12-18 14:23:57 +01:00
Cristi Vîjdea	06a461ec09	Merge pull request #21 from h-hirokawa/file-field-response Add support for FileField response.	2017-12-18 13:16:21 +01:00
h-hirokawa	cae07f3eaf	Add `read_only` to FileField response.	2017-12-18 20:30:14 +09:00
h-hirokawa	16b697b40d	Add a field to ArticleSerializer in testproj for coverage.	2017-12-18 19:31:32 +09:00
h-hirokawa	8a0d5a964d	Add support for serializers.FileField response.	2017-12-18 19:03:40 +09:00
Cristi Vîjdea	521172c195	Clean up Django 2 path backslashes In Django 2, routes defines via urls.path are aggresively escaped when converted into regex. This is a naive fix which unescapes all characters outside capture groups, but in the context of OpenAPI is okay because regular expressions inside paths are not supported anyway. This issue affects django-rest-framework as well, as outlined in encode/django-rest-framework#5672, encode/django-rest-framework#5675.	2017-12-18 01:06:14 +01:00
Cristi Vîjdea	f6c30181fe	Use Django 2.0 for building docs	2017-12-17 11:18:49 +01:00
Cristi Vîjdea	da4b7d4e74	Fix test to account for changed description See `8a5be407e2`.	2017-12-17 02:36:48 +01:00
Cristi Vîjdea	6346d855cf	Update swagger-ui to 3.7.0 and add UI update script	2017-12-17 02:34:53 +01:00
Cristi Vîjdea	53593af36f	Update documentation and changelog	2017-12-17 01:44:49 +01:00
Cristi Vîjdea	738326ac43	Fix crash caused by read-only nested Serializers	2017-12-17 01:43:57 +01:00
Cristi Vîjdea	8a5be407e2	Document exotic usages of swagger_auto_schema method_decorator works out of the box so might as well document an example	2017-12-16 20:38:40 +01:00