Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Cristi Vîjdea
|
de3c5a77fd | ||
|
Cristi Vîjdea
|
5929ff55a0 | ||
|
Cristi Vîjdea
|
7982f62f38 | ||
|
Cristi Vîjdea
|
9fa4765121 | ||
|
Jack Cushman
|
544d72db0a | ||
|
Cristi Vîjdea
|
696ec3a94a | ||
|
Cristi Vîjdea
|
e0aec3ff45 | ||
|
John Carter
|
ee7b9a0734 | ||
|
Cristi Vîjdea
|
0697c415ed | ||
|
Andrew Yager
|
4825ec70b1 | ||
|
Cristi Vîjdea
|
54ad90415d | ||
|
Cristi Vîjdea
|
1184ea8b46 | ||
|
Cristi Vîjdea
|
6ac58b8cf7 | ||
|
Cristi Vîjdea
|
d627a1bc5d | ||
|
Cristi Vîjdea
|
38e884b5ea | ||
|
Cristi Vîjdea
|
2ef7cfbfe3 | ||
|
Cristi Vîjdea
|
58adbb8f4c | ||
|
Cristi Vîjdea
|
34c7fa2b0e |
@@ -3,6 +3,32 @@ Changelog
|
||||
#########
|
||||
|
||||
|
||||
*********
|
||||
**1.9.1**
|
||||
*********
|
||||
|
||||
*Release date: Jun 30, 2018*
|
||||
|
||||
- **IMPROVED:** added a ``swagger_fake_view`` marker to more easily detect mock views in view methods;
|
||||
``getattr(self, 'swagger_fake_view', False)`` inside a view method like ``get_serializer_class`` will tell you if the
|
||||
view instnace is being used for swagger schema introspection (:issue:`154`)
|
||||
- **IMPROVED:** updated ``swagger-ui`` to version 3.17.1
|
||||
- **IMPROVED:** updated ``ReDoc`` to version 2.0.0-alpha.25
|
||||
- **FIXED:** fixed wrong handling of duplicate urls in urlconf (:pr:`155`)
|
||||
- **FIXED:** fixed crash when passing ``None`` as a response override (:issue:`148`)
|
||||
|
||||
*********
|
||||
**1.9.0**
|
||||
*********
|
||||
|
||||
*Release date: Jun 16, 2018*
|
||||
|
||||
- **ADDED:** added ``DEFAULT_GENERATOR_CLASS`` setting and ``--generator-class`` argument to the ``generate_swagger``
|
||||
management command (:issue:`140`)
|
||||
- **FIXED:** fixed wrongly required ``'count'`` response field on ``CursorPagination`` (:issue:`141`)
|
||||
- **FIXED:** fixed some cases where ``swagger_extra_fields`` would not be handlded (:pr:`142`)
|
||||
- **FIXED:** fixed crash when encountering ``coreapi.Fields``\ s without a ``schema`` (:issue:`143`)
|
||||
|
||||
*********
|
||||
**1.8.0**
|
||||
*********
|
||||
|
||||
@@ -174,6 +174,15 @@ in a few ways:
|
||||
:ref:`@swagger_auto_schema <custom-spec-swagger-auto-schema>`, to prevent ``get_serializer`` from being called on
|
||||
the view
|
||||
* :ref:`exclude your endpoint from introspection <custom-spec-excluding-endpoints>`
|
||||
* use the ``swagger_fake_view`` marker to detect requests generated by ``drf-yasg``:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
def get_serializer_class(self):
|
||||
if getattr(self, 'swagger_fake_view', False):
|
||||
return TodoTreeSerializer
|
||||
|
||||
raise NotImplementedError("must not call this")
|
||||
|
||||
.. _SCRIPT_NAME: https://www.python.org/dev/peps/pep-0333/#environ-variables
|
||||
.. _FORCE_SCRIPT_NAME: https://docs.djangoproject.com/en/2.0/ref/settings/#force-script-name
|
||||
|
||||
+9
-1
@@ -43,6 +43,14 @@ The possible settings and their default values are as follows:
|
||||
Default classes
|
||||
===============
|
||||
|
||||
DEFAULT_GENERATOR_CLASS
|
||||
-------------------------
|
||||
|
||||
:class:`~.generators.OpenAPISchemaGenerator` subclass that will be used by default for generating the final
|
||||
:class:`.Schema` object. Can be overriden by the ``generator_class`` argument to :func:`.get_schema_view`.
|
||||
|
||||
**Default**: :class:`drf_yasg.generators.OpenAPISchemaGenerator`
|
||||
|
||||
DEFAULT_AUTO_SCHEMA_CLASS
|
||||
-------------------------
|
||||
|
||||
@@ -102,7 +110,7 @@ DEFAULT_INFO
|
||||
------------
|
||||
|
||||
An import string to an :class:`.openapi.Info` object. This will be used when running the ``generate_swagger``
|
||||
management command, or if no ``info`` argument is passed to ``get_schema_view``.
|
||||
management command, or if no ``info`` argument is passed to :func:`.get_schema_view`.
|
||||
|
||||
**Default**: :python:`None`
|
||||
|
||||
|
||||
Generated
+105
-94
@@ -57,9 +57,9 @@
|
||||
"integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0="
|
||||
},
|
||||
"classnames": {
|
||||
"version": "2.2.5",
|
||||
"resolved": "https://registry.npmjs.org/classnames/-/classnames-2.2.5.tgz",
|
||||
"integrity": "sha1-+zgB1FNGdknvNgPH1hoCvRKb3m0="
|
||||
"version": "2.2.6",
|
||||
"resolved": "https://registry.npmjs.org/classnames/-/classnames-2.2.6.tgz",
|
||||
"integrity": "sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q=="
|
||||
},
|
||||
"clipboard": {
|
||||
"version": "2.0.1",
|
||||
@@ -113,9 +113,9 @@
|
||||
"integrity": "sha1-/qJhbcZ2spYmhrOvjb2+GAskTgU="
|
||||
},
|
||||
"css-to-react-native": {
|
||||
"version": "2.2.0",
|
||||
"resolved": "https://registry.npmjs.org/css-to-react-native/-/css-to-react-native-2.2.0.tgz",
|
||||
"integrity": "sha512-SWG8+tsVRBHpxn1cSDmx7B95DJCiKwUecBbboGpm2znDCnJDMGkcoYR73w1p2IZMab6iNqVms8VC+4TrSqoFeQ==",
|
||||
"version": "2.2.1",
|
||||
"resolved": "https://registry.npmjs.org/css-to-react-native/-/css-to-react-native-2.2.1.tgz",
|
||||
"integrity": "sha512-v++LRcf633phJiYZBDqtmGPj3+BVof0isd2jgwYLWZJ5YSuhCkrfYtDsNhM6oJthiEco0f9tDVJ1vUkDJNgGEA==",
|
||||
"requires": {
|
||||
"css-color-keywords": "^1.0.0",
|
||||
"fbjs": "^0.8.5",
|
||||
@@ -152,9 +152,9 @@
|
||||
"integrity": "sha1-ZyIm3HTI95mtNTB9+TaroRrNYBg="
|
||||
},
|
||||
"dompurify": {
|
||||
"version": "1.0.4",
|
||||
"resolved": "https://registry.npmjs.org/dompurify/-/dompurify-1.0.4.tgz",
|
||||
"integrity": "sha512-Y/HFiY5NACdpMs8DJQhNCjF8Kj6msjQRLW5fgD628gBk6a2tjZcVN57SF/PvEgogxsrBPXOF0f3d6qNiAdIYoA=="
|
||||
"version": "1.0.5",
|
||||
"resolved": "https://registry.npmjs.org/dompurify/-/dompurify-1.0.5.tgz",
|
||||
"integrity": "sha512-W7QHgBwTbTh3/Xv0jQyckJOTN2uigyrwOTidFv0qRbT6s6HtuIO3e1LXKbA35FJ34dbptQ5Yznkd/ELAdJ2wOw=="
|
||||
},
|
||||
"encoding": {
|
||||
"version": "0.1.12",
|
||||
@@ -209,9 +209,9 @@
|
||||
"integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc="
|
||||
},
|
||||
"fbjs": {
|
||||
"version": "0.8.16",
|
||||
"resolved": "https://registry.npmjs.org/fbjs/-/fbjs-0.8.16.tgz",
|
||||
"integrity": "sha1-XmdDL1UNxBtXK/VYR7ispk5TN9s=",
|
||||
"version": "0.8.17",
|
||||
"resolved": "https://registry.npmjs.org/fbjs/-/fbjs-0.8.17.tgz",
|
||||
"integrity": "sha1-xNWY6taUkRJlPWWIsBpc3Nn5D90=",
|
||||
"requires": {
|
||||
"core-js": "^1.0.0",
|
||||
"isomorphic-fetch": "^2.1.1",
|
||||
@@ -219,7 +219,7 @@
|
||||
"object-assign": "^4.1.0",
|
||||
"promise": "^7.1.1",
|
||||
"setimmediate": "^1.0.5",
|
||||
"ua-parser-js": "^0.7.9"
|
||||
"ua-parser-js": "^0.7.18"
|
||||
}
|
||||
},
|
||||
"find-up": {
|
||||
@@ -274,9 +274,9 @@
|
||||
"integrity": "sha1-nZ55MWXOAXoA8AQYxD+UKnsdEfo="
|
||||
},
|
||||
"hoist-non-react-statics": {
|
||||
"version": "2.5.0",
|
||||
"resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-2.5.0.tgz",
|
||||
"integrity": "sha512-6Bl6XsDT1ntE0lHbIhr4Kp2PGcleGZ66qu5Jqk8lc0Xc/IeG6gVLmwUGs/K0Us+L8VWoKgj0uWdPMataOsm31w=="
|
||||
"version": "2.5.5",
|
||||
"resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-2.5.5.tgz",
|
||||
"integrity": "sha512-rqcy4pJo55FTTLWt+bU8ukscqHeE/e9KWvsOW2b/a3afxQZhwkQdT1rPPCJ0rYXdj4vNcasY8zHTH+jF/qStxw=="
|
||||
},
|
||||
"iconv-lite": {
|
||||
"version": "0.4.23",
|
||||
@@ -287,9 +287,9 @@
|
||||
}
|
||||
},
|
||||
"ieee754": {
|
||||
"version": "1.1.11",
|
||||
"resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.1.11.tgz",
|
||||
"integrity": "sha512-VhDzCKN7K8ufStx/CLj5/PDTMgph+qwN5Pkd5i0sGnVwk56zJ0lkT8Qzi1xqWLS0Wp29DgDtNeS7v8/wMoZeHg=="
|
||||
"version": "1.1.12",
|
||||
"resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.1.12.tgz",
|
||||
"integrity": "sha512-GguP+DRY+pJ3soyIiGPTvdiVXjZ+DbXOxGpXn3eMvNW4x4irjqXm4wHKscC+TfxSJ0yw/S1F24tqdMNsMZTiLA=="
|
||||
},
|
||||
"invert-kv": {
|
||||
"version": "1.0.0",
|
||||
@@ -339,9 +339,9 @@
|
||||
"integrity": "sha1-mGbfOVECEw449/mWvOtlRDIJwls="
|
||||
},
|
||||
"js-yaml": {
|
||||
"version": "3.11.0",
|
||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.11.0.tgz",
|
||||
"integrity": "sha512-saJstZWv7oNeOyBh3+Dx1qWzhW0+e6/8eDzo7p5rDFqxntSztloLtuKu+Ejhtq82jsilwOIZYsCz+lIjthg1Hw==",
|
||||
"version": "3.12.0",
|
||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.12.0.tgz",
|
||||
"integrity": "sha512-PIt2cnwmPfL4hKNwqeiuz4bKfnzHTBv6HyVgjahA6mPLwPDzjDWrplJBMjHUFxku/N3FlmrbyPclad+I+4mJ3A==",
|
||||
"requires": {
|
||||
"argparse": "^1.0.7",
|
||||
"esprima": "^4.0.0"
|
||||
@@ -406,9 +406,9 @@
|
||||
}
|
||||
},
|
||||
"lunr": {
|
||||
"version": "2.2.0",
|
||||
"resolved": "https://registry.npmjs.org/lunr/-/lunr-2.2.0.tgz",
|
||||
"integrity": "sha512-HNuCi0meEZZpfORgJuxmXu5yHkdWrWew9dphUj+ouCbNNT38ud5YXWKVcLo1gSwQcDdKMXn+lRuDiXLfllnnjA=="
|
||||
"version": "2.3.0",
|
||||
"resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.0.tgz",
|
||||
"integrity": "sha1-TXwMoSvdHgRHsMExuRQgkpdAyI8="
|
||||
},
|
||||
"mark.js": {
|
||||
"version": "8.11.1",
|
||||
@@ -416,9 +416,9 @@
|
||||
"integrity": "sha1-GA8fnr74sOY45BZq1S24eb6y/8U="
|
||||
},
|
||||
"marked": {
|
||||
"version": "0.3.19",
|
||||
"resolved": "https://registry.npmjs.org/marked/-/marked-0.3.19.tgz",
|
||||
"integrity": "sha512-ea2eGWOqNxPcXv8dyERdSr/6FmzvWwzjMxpfGB/sbMccXoct+xY+YukPD+QTUZwyvK7BZwcr4m21WBOW41pAkg=="
|
||||
"version": "0.3.18",
|
||||
"resolved": "https://registry.npmjs.org/marked/-/marked-0.3.18.tgz",
|
||||
"integrity": "sha512-49i2QYhfULqaXzNZpxC808PisuCTGT2fgG0zrzdCI9N3rIfAWfW0nggvbXr6zvpynZdOG5+9xNxdzP0kwZnERw=="
|
||||
},
|
||||
"mem": {
|
||||
"version": "1.1.0",
|
||||
@@ -428,6 +428,11 @@
|
||||
"mimic-fn": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"memoize-one": {
|
||||
"version": "3.1.1",
|
||||
"resolved": "https://registry.npmjs.org/memoize-one/-/memoize-one-3.1.1.tgz",
|
||||
"integrity": "sha512-YqVh744GsMlZu6xkhGslPSqSurOv6P+kLN2J3ysBZfagLcL5FdRK/0UpgLoL8hwjjEvvAVkjJZyFP+1T6p1vgA=="
|
||||
},
|
||||
"mimic-fn": {
|
||||
"version": "1.2.0",
|
||||
"resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-1.2.0.tgz",
|
||||
@@ -442,14 +447,14 @@
|
||||
}
|
||||
},
|
||||
"mobx": {
|
||||
"version": "4.2.1",
|
||||
"resolved": "https://registry.npmjs.org/mobx/-/mobx-4.2.1.tgz",
|
||||
"integrity": "sha1-3UGQ2vG0PUGjoihYUlP5lwsKJ90="
|
||||
"version": "4.3.1",
|
||||
"resolved": "https://registry.npmjs.org/mobx/-/mobx-4.3.1.tgz",
|
||||
"integrity": "sha1-M05aq0kWsdQ/D682BaZLG0s8y40="
|
||||
},
|
||||
"mobx-react": {
|
||||
"version": "5.1.2",
|
||||
"resolved": "https://registry.npmjs.org/mobx-react/-/mobx-react-5.1.2.tgz",
|
||||
"integrity": "sha1-7FwtKaHfgj29GzfiFPo2oJBwVOI=",
|
||||
"version": "5.2.3",
|
||||
"resolved": "https://registry.npmjs.org/mobx-react/-/mobx-react-5.2.3.tgz",
|
||||
"integrity": "sha512-OuSlF2nJEa1PGookZcZnINbvEK4iWNNYiqUh6aebk2AkWxj3sG8OafDOQMcMYApQALTHRsrBIjOx/K8TFxcz7w==",
|
||||
"requires": {
|
||||
"hoist-non-react-statics": "^2.5.0",
|
||||
"react-lifecycles-compat": "^3.0.2"
|
||||
@@ -504,9 +509,9 @@
|
||||
}
|
||||
},
|
||||
"openapi-sampler": {
|
||||
"version": "1.0.0-beta.9",
|
||||
"resolved": "https://registry.npmjs.org/openapi-sampler/-/openapi-sampler-1.0.0-beta.9.tgz",
|
||||
"integrity": "sha1-HkuldvqPtjG2iK5g6ZW9J6wIdJI=",
|
||||
"version": "1.0.0-beta.13",
|
||||
"resolved": "https://registry.npmjs.org/openapi-sampler/-/openapi-sampler-1.0.0-beta.13.tgz",
|
||||
"integrity": "sha512-NReKJh92NlUmY9CDo86L1Skkx3DMDeWmiLoqMxQSX7xBpoSx8WJ1JdTb7nEwz6M7S+WDPrQsEfS5BaIW27nMrQ==",
|
||||
"requires": {
|
||||
"json-pointer": "^0.6.0"
|
||||
}
|
||||
@@ -527,9 +532,9 @@
|
||||
"integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4="
|
||||
},
|
||||
"p-limit": {
|
||||
"version": "1.2.0",
|
||||
"resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.2.0.tgz",
|
||||
"integrity": "sha512-Y/OtIaXtUPr4/YpMv1pCL5L5ed0rumAaAeBSj12F+bSlMdys7i8oQF/GUJmfpTS/QoaRrS/k6pma29haJpsMng==",
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz",
|
||||
"integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==",
|
||||
"requires": {
|
||||
"p-try": "^1.0.0"
|
||||
}
|
||||
@@ -558,14 +563,14 @@
|
||||
"integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A="
|
||||
},
|
||||
"perfect-scrollbar": {
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://registry.npmjs.org/perfect-scrollbar/-/perfect-scrollbar-1.3.0.tgz",
|
||||
"integrity": "sha512-7Ub8YOvZB5k+pTy0K3LYUDnH9Xl3qvHcclJyIX+AV5UxHxll146iVGq4rtc+848nTDBQq89J7QxKKMA++cTXzQ=="
|
||||
"version": "1.4.0",
|
||||
"resolved": "https://registry.npmjs.org/perfect-scrollbar/-/perfect-scrollbar-1.4.0.tgz",
|
||||
"integrity": "sha512-/2Sk/khljhdrsamjJYS5NjrH+GKEHEwh7zFSiYyxROyYKagkE4kSn2zDQDRTOMo8mpT2jikxx6yI1dG7lNP/hw=="
|
||||
},
|
||||
"polished": {
|
||||
"version": "1.9.2",
|
||||
"resolved": "https://registry.npmjs.org/polished/-/polished-1.9.2.tgz",
|
||||
"integrity": "sha512-mPocQrVUSiqQdHNZFGL1iHJmsR/etiv05Nf2oZUbya+GMsQkZVEBl5wonN+Sr/e9zQBEhT6yrMjxAUJ06eyocQ=="
|
||||
"version": "1.9.3",
|
||||
"resolved": "https://registry.npmjs.org/polished/-/polished-1.9.3.tgz",
|
||||
"integrity": "sha512-4NmSD7fMFlM8roNxs7YXPv7UFRbYzb0gufR5zBxJLRzY54+zFsavxBo6zsQzP9ep6Hh3pC2pTyrpSTBEaB6IkQ=="
|
||||
},
|
||||
"postcss-value-parser": {
|
||||
"version": "3.3.0",
|
||||
@@ -573,9 +578,9 @@
|
||||
"integrity": "sha1-h/OPnxj3dKSrTIojL1xc6IcqnRU="
|
||||
},
|
||||
"prismjs": {
|
||||
"version": "1.14.0",
|
||||
"resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.14.0.tgz",
|
||||
"integrity": "sha512-sa2s4m60bXs+kU3jcuUwx3ZCrUH7o0kuqnOOINbODqlRrDB7KY8SRx+xR/D7nHLlgfDdG7zXbRO8wJ+su5Ls0A==",
|
||||
"version": "1.15.0",
|
||||
"resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.15.0.tgz",
|
||||
"integrity": "sha512-Lf2JrFYx8FanHrjoV5oL8YHCclLQgbJcVZR+gikGGMqz6ub5QVWDTM6YIwm3BuPxM/LOV+rKns3LssXNLIf+DA==",
|
||||
"requires": {
|
||||
"clipboard": "^2.0.0"
|
||||
}
|
||||
@@ -594,11 +599,10 @@
|
||||
}
|
||||
},
|
||||
"prop-types": {
|
||||
"version": "15.6.1",
|
||||
"resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.6.1.tgz",
|
||||
"integrity": "sha512-4ec7bY1Y66LymSUOH/zARVYObB23AT2h8cf6e/O6ZALB/N0sqZFEx7rq6EYPX2MkOdKORuooI/H5k9TlR4q7kQ==",
|
||||
"version": "15.6.2",
|
||||
"resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.6.2.tgz",
|
||||
"integrity": "sha512-3pboPvLiWD7dkI3qf3KbUe6hKFKa52w+AE0VCqECtf+QHAKgOL37tTaNCnuX1nAAQ4ZhyP+kYVKf8rLmJ/feDQ==",
|
||||
"requires": {
|
||||
"fbjs": "^0.8.16",
|
||||
"loose-envify": "^1.3.1",
|
||||
"object-assign": "^4.1.1"
|
||||
}
|
||||
@@ -617,22 +621,22 @@
|
||||
}
|
||||
},
|
||||
"react-hot-loader": {
|
||||
"version": "4.1.3",
|
||||
"resolved": "https://registry.npmjs.org/react-hot-loader/-/react-hot-loader-4.1.3.tgz",
|
||||
"integrity": "sha512-CF3Y/qUfL1PkM6TPrELNsSiHGKJFRnpyLdzsk+HV4IIuQAY2g1aZXQmK4L/O8WOaldoOujxAYfRfpzrWTvmvtg==",
|
||||
"version": "4.3.3",
|
||||
"resolved": "https://registry.npmjs.org/react-hot-loader/-/react-hot-loader-4.3.3.tgz",
|
||||
"integrity": "sha512-N2yYEfI8mIeE9DffyMHrHQz0WryDdF8d1CJ4rpQ15hNAu3xco6wQ6JtKIIc/8w0igFWh2XpV0rIkuE4tpKLivQ==",
|
||||
"requires": {
|
||||
"fast-levenshtein": "^2.0.6",
|
||||
"global": "^4.3.0",
|
||||
"hoist-non-react-statics": "^2.5.0",
|
||||
"prop-types": "^15.6.1",
|
||||
"react-lifecycles-compat": "^3.0.2",
|
||||
"react-lifecycles-compat": "^3.0.4",
|
||||
"shallowequal": "^1.0.2"
|
||||
}
|
||||
},
|
||||
"react-is": {
|
||||
"version": "16.3.2",
|
||||
"resolved": "https://registry.npmjs.org/react-is/-/react-is-16.3.2.tgz",
|
||||
"integrity": "sha512-ybEM7YOr4yBgFd6w8dJqwxegqZGJNBZl6U27HnGKuTZmDvVrD5quWOK/wAnMywiZzW+Qsk+l4X2c70+thp/A8Q=="
|
||||
"version": "16.4.1",
|
||||
"resolved": "https://registry.npmjs.org/react-is/-/react-is-16.4.1.tgz",
|
||||
"integrity": "sha512-xpb0PpALlFWNw/q13A+1aHeyJyLYCg0/cCHPUA43zYluZuIPHaHL3k8OBsTgQtxqW0FhyDEMvi8fZ/+7+r4OSQ=="
|
||||
},
|
||||
"react-lifecycles-compat": {
|
||||
"version": "3.0.4",
|
||||
@@ -649,33 +653,35 @@
|
||||
}
|
||||
},
|
||||
"redoc": {
|
||||
"version": "2.0.0-alpha.20",
|
||||
"resolved": "https://registry.npmjs.org/redoc/-/redoc-2.0.0-alpha.20.tgz",
|
||||
"integrity": "sha512-oJ6CACoflRW7BvvfUTANjNj9+8bvWweg8gBKJnl4gTcao1tA1NsN7hNRv7uGpN79RP8eMFBSlRHcGmxKONU/tA==",
|
||||
"version": "2.0.0-alpha.25",
|
||||
"resolved": "https://registry.npmjs.org/redoc/-/redoc-2.0.0-alpha.25.tgz",
|
||||
"integrity": "sha512-pTrOm8OFUzouBLnE/D8lGSLmwvXpjNr14FpPvE8mfysX7UOs9BT7F06oVpujSqx2TjV6V1Mr3/nsAPonSLX10g==",
|
||||
"requires": {
|
||||
"classnames": "^2.2.5",
|
||||
"classnames": "^2.2.6",
|
||||
"decko": "^1.2.0",
|
||||
"dompurify": "^1.0.2",
|
||||
"dompurify": "^1.0.5",
|
||||
"eventemitter3": "^3.0.0",
|
||||
"json-pointer": "^0.6.0",
|
||||
"json-schema-ref-parser": "^5.0.0",
|
||||
"lunr": "^2.1.5",
|
||||
"lunr": "^2.3.0",
|
||||
"mark.js": "^8.11.1",
|
||||
"marked": "^0.3.19",
|
||||
"mobx": "^4.1.0",
|
||||
"mobx-react": "^5.0.0",
|
||||
"openapi-sampler": "1.0.0-beta.9",
|
||||
"perfect-scrollbar": "^1.3.0",
|
||||
"marked": "0.3.18",
|
||||
"memoize-one": "^3.1.1",
|
||||
"mobx": "^4.3.0",
|
||||
"mobx-react": "^5.2.3",
|
||||
"openapi-sampler": "1.0.0-beta.13",
|
||||
"perfect-scrollbar": "^1.4.0",
|
||||
"polished": "^1.9.2",
|
||||
"prismjs": "^1.12.2",
|
||||
"prop-types": "^15.6.0",
|
||||
"prismjs": "^1.15.0",
|
||||
"prop-types": "^15.6.2",
|
||||
"react-dropdown": "^1.3.0",
|
||||
"react-hot-loader": "^4.0.0",
|
||||
"react-hot-loader": "^4.3.3",
|
||||
"react-tabs": "^2.0.0",
|
||||
"slugify": "^1.2.1",
|
||||
"stickyfill": "^1.1.1",
|
||||
"styled-components": "^3.2.3",
|
||||
"swagger2openapi": "^2.11.0"
|
||||
"styled-components": "^3.3.3",
|
||||
"swagger2openapi": "^2.11.0",
|
||||
"tslib": "^1.9.3"
|
||||
}
|
||||
},
|
||||
"reftools": {
|
||||
@@ -715,9 +721,9 @@
|
||||
"integrity": "sha1-KQy7Iy4waULX1+qbg3Mqt4VvgoU="
|
||||
},
|
||||
"shallowequal": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.0.2.tgz",
|
||||
"integrity": "sha512-zlVXeVUKvo+HEv1e2KQF/csyeMKx2oHvatQ9l6XjCUj3agvC8XGf6R9HvIPDSmp8FNPvx7b5kaEJTRi7CqxtEw=="
|
||||
"version": "1.1.0",
|
||||
"resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz",
|
||||
"integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ=="
|
||||
},
|
||||
"shebang-command": {
|
||||
"version": "1.2.0",
|
||||
@@ -823,9 +829,9 @@
|
||||
"integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8="
|
||||
},
|
||||
"styled-components": {
|
||||
"version": "3.2.6",
|
||||
"resolved": "https://registry.npmjs.org/styled-components/-/styled-components-3.2.6.tgz",
|
||||
"integrity": "sha1-mebnWnRr3t0pWhfgPdFJMFWhzDs=",
|
||||
"version": "3.3.3",
|
||||
"resolved": "https://registry.npmjs.org/styled-components/-/styled-components-3.3.3.tgz",
|
||||
"integrity": "sha1-CecCBVqxH3qOq4IpscDQuFUJVoY=",
|
||||
"requires": {
|
||||
"buffer": "^5.0.3",
|
||||
"css-to-react-native": "^2.0.3",
|
||||
@@ -840,9 +846,9 @@
|
||||
}
|
||||
},
|
||||
"stylis": {
|
||||
"version": "3.5.0",
|
||||
"resolved": "https://registry.npmjs.org/stylis/-/stylis-3.5.0.tgz",
|
||||
"integrity": "sha512-pP7yXN6dwMzAR29Q0mBrabPCe0/mNO1MSr93bhay+hcZondvMMTpeGyd8nbhYJdyperNT2DRxONQuUGcJr5iPw=="
|
||||
"version": "3.5.1",
|
||||
"resolved": "https://registry.npmjs.org/stylis/-/stylis-3.5.1.tgz",
|
||||
"integrity": "sha512-yM4PyeHuwhIOUHNJxi1/Mbq8kVLv4AkyE7IYLP/LK0lIFcr3tRa2H1iZlBYKIxOlf+/jruBTe8DdKSyQX9w4OA=="
|
||||
},
|
||||
"stylis-rule-sheet": {
|
||||
"version": "0.0.10",
|
||||
@@ -858,9 +864,9 @@
|
||||
}
|
||||
},
|
||||
"swagger-ui-dist": {
|
||||
"version": "3.14.2",
|
||||
"resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.14.2.tgz",
|
||||
"integrity": "sha1-aayy6HOFF5ICwx6Iw/Bl8xBlEFY="
|
||||
"version": "3.17.1",
|
||||
"resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.17.1.tgz",
|
||||
"integrity": "sha1-2wjtaBvPuhMUn35hD0izbNTBfeg="
|
||||
},
|
||||
"swagger2openapi": {
|
||||
"version": "2.11.16",
|
||||
@@ -891,6 +897,11 @@
|
||||
"integrity": "sha512-2NM0auVBGft5tee/OxP4PI3d8WItkDM+fPnaRAVo6xTDI2knbz9eC5ArWGqtGlYqiH3RU5yMpdyTTO7MguC4ow==",
|
||||
"optional": true
|
||||
},
|
||||
"tslib": {
|
||||
"version": "1.9.3",
|
||||
"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.3.tgz",
|
||||
"integrity": "sha512-4krF8scpejhaOgqzBEcGM7yDIEfi0/8+8zDRZhNZZ2kjmHJ4hv3zCbQWxoJGz1iw5U0Jl0nma13xzHXcncMavQ=="
|
||||
},
|
||||
"ua-parser-js": {
|
||||
"version": "0.7.18",
|
||||
"resolved": "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-0.7.18.tgz",
|
||||
@@ -902,9 +913,9 @@
|
||||
"integrity": "sha512-dcQ1GWpOD/eEQ97k66aiEVpNnapVj90/+R+SXTPYGHpYBBypfKJEQjLrvMZ7YXbKm21gXd4NcuxUTjiv1YtLng=="
|
||||
},
|
||||
"which": {
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://registry.npmjs.org/which/-/which-1.3.0.tgz",
|
||||
"integrity": "sha512-xcJpopdamTuY5duC/KnTTNBraPK54YwpenP4lzxU8H91GudWpFv38u0CKjclE1Wi2EH2EDz5LRcHcKbCIzqGyg==",
|
||||
"version": "1.3.1",
|
||||
"resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz",
|
||||
"integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==",
|
||||
"requires": {
|
||||
"isexe": "^2.0.0"
|
||||
}
|
||||
@@ -967,9 +978,9 @@
|
||||
"integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI="
|
||||
},
|
||||
"yargs": {
|
||||
"version": "11.0.0",
|
||||
"resolved": "https://registry.npmjs.org/yargs/-/yargs-11.0.0.tgz",
|
||||
"integrity": "sha512-Rjp+lMYQOWtgqojx1dEWorjCofi1YN7AoFvYV7b1gx/7dAAeuI4kN5SZiEvr0ZmsZTOpDRcCqrpI10L31tFkBw==",
|
||||
"version": "11.1.0",
|
||||
"resolved": "https://registry.npmjs.org/yargs/-/yargs-11.1.0.tgz",
|
||||
"integrity": "sha512-NwW69J42EsCSanF8kyn5upxvjp5ds+t3+udGBeTbFnERA+lF541DDpMawzo4z6W/QrzNM18D+BPMiOBibnFV5A==",
|
||||
"requires": {
|
||||
"cliui": "^4.0.0",
|
||||
"decamelize": "^1.1.1",
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "drf-yasg",
|
||||
"dependencies": {
|
||||
"redoc": "^2.0.0-alpha.20",
|
||||
"swagger-ui-dist": "^3.14.2"
|
||||
"redoc": "^2.0.0-alpha.25",
|
||||
"swagger-ui-dist": "^3.17.1"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
||||
@@ -1,2 +1,5 @@
|
||||
[bdist_wheel]
|
||||
universal = 1
|
||||
|
||||
[metadata]
|
||||
license_file = LICENSE.rst
|
||||
|
||||
@@ -2,6 +2,7 @@ from django.conf import settings
|
||||
from rest_framework.settings import perform_import
|
||||
|
||||
SWAGGER_DEFAULTS = {
|
||||
'DEFAULT_GENERATOR_CLASS': 'drf_yasg.generators.OpenAPISchemaGenerator',
|
||||
'DEFAULT_AUTO_SCHEMA_CLASS': 'drf_yasg.inspectors.SwaggerAutoSchema',
|
||||
|
||||
'DEFAULT_FIELD_INSPECTORS': [
|
||||
@@ -68,6 +69,7 @@ REDOC_DEFAULTS = {
|
||||
}
|
||||
|
||||
IMPORT_STRINGS = [
|
||||
'DEFAULT_GENERATOR_CLASS',
|
||||
'DEFAULT_AUTO_SCHEMA_CLASS',
|
||||
'DEFAULT_FIELD_INSPECTORS',
|
||||
'DEFAULT_FILTER_INSPECTORS',
|
||||
|
||||
@@ -72,7 +72,7 @@ class EndpointEnumerator(_EndpointEnumerator):
|
||||
|
||||
return path
|
||||
|
||||
def get_api_endpoints(self, patterns=None, prefix='', app_name=None, namespace=None):
|
||||
def get_api_endpoints(self, patterns=None, prefix='', app_name=None, namespace=None, previously_seen_endpoints=None):
|
||||
"""
|
||||
Return a list of all available API endpoints by inspecting the URL conf.
|
||||
|
||||
@@ -82,6 +82,8 @@ class EndpointEnumerator(_EndpointEnumerator):
|
||||
patterns = self.patterns
|
||||
|
||||
api_endpoints = []
|
||||
if previously_seen_endpoints is None:
|
||||
previously_seen_endpoints = set()
|
||||
|
||||
for pattern in patterns:
|
||||
path_regex = prefix + get_original_route(pattern)
|
||||
@@ -92,6 +94,13 @@ class EndpointEnumerator(_EndpointEnumerator):
|
||||
url_name = pattern.name
|
||||
if self.should_include_endpoint(path, callback, app_name or '', namespace or '', url_name):
|
||||
path = self.replace_version(path, callback)
|
||||
|
||||
# avoid adding endpoints that have already been seen,
|
||||
# as Django resolves urls in top-down order
|
||||
if path in previously_seen_endpoints:
|
||||
continue
|
||||
previously_seen_endpoints.add(path)
|
||||
|
||||
for method in self.get_allowed_methods(callback):
|
||||
endpoint = (path, method, callback)
|
||||
api_endpoints.append(endpoint)
|
||||
@@ -103,7 +112,8 @@ class EndpointEnumerator(_EndpointEnumerator):
|
||||
patterns=pattern.url_patterns,
|
||||
prefix=path_regex,
|
||||
app_name="%s:%s" % (app_name, pattern.app_name) if app_name else pattern.app_name,
|
||||
namespace="%s:%s" % (namespace, pattern.namespace) if namespace else pattern.namespace
|
||||
namespace="%s:%s" % (namespace, pattern.namespace) if namespace else pattern.namespace,
|
||||
previously_seen_endpoints=previously_seen_endpoints
|
||||
)
|
||||
api_endpoints.extend(nested_endpoints)
|
||||
else:
|
||||
@@ -243,6 +253,8 @@ class OpenAPISchemaGenerator(object):
|
||||
view_method = getattr(view, method, None)
|
||||
if view_method is not None: # pragma: no cover
|
||||
setattr(view_method.__func__, '_swagger_auto_schema', overrides)
|
||||
|
||||
setattr(view, 'swagger_fake_view', True)
|
||||
return view
|
||||
|
||||
def get_endpoints(self, request):
|
||||
|
||||
@@ -36,10 +36,7 @@ class InlineSerializerInspector(SerializerInspector):
|
||||
setattr(schema, attr, val)
|
||||
|
||||
def get_schema(self, serializer):
|
||||
result = self.probe_field_inspectors(serializer, openapi.Schema, self.use_definitions)
|
||||
schema = openapi.resolve_ref(result, self.components)
|
||||
self.add_manual_fields(serializer, schema)
|
||||
return result
|
||||
return self.probe_field_inspectors(serializer, openapi.Schema, self.use_definitions)
|
||||
|
||||
def add_manual_parameters(self, serializer, parameters):
|
||||
"""Add/replace parameters from the given list of automatically generated request parameters. This method
|
||||
@@ -95,7 +92,7 @@ class InlineSerializerInspector(SerializerInspector):
|
||||
for property_name, child in field.fields.items():
|
||||
property_name = self.get_property_name(property_name)
|
||||
prop_kwargs = {
|
||||
'read_only': child.read_only or None
|
||||
'read_only': bool(child.read_only) or None
|
||||
}
|
||||
prop_kwargs = filter_none(prop_kwargs)
|
||||
|
||||
@@ -117,6 +114,10 @@ class InlineSerializerInspector(SerializerInspector):
|
||||
# but is visually displayed like the model name, which is confusing
|
||||
# it is better to just remove title from inline models
|
||||
del result.title
|
||||
|
||||
# Provide an option to add manual paremeters to a schema
|
||||
# for example, to add examples
|
||||
self.add_manual_fields(field, result)
|
||||
return result
|
||||
|
||||
if not ref_name or not use_references:
|
||||
|
||||
@@ -48,7 +48,7 @@ class CoreAPICompatInspector(PaginatorInspector, FilterInspector):
|
||||
in_=location_to_in[field.location],
|
||||
type=coreapi_types.get(type(field.schema), openapi.TYPE_STRING),
|
||||
required=field.required,
|
||||
description=field.schema.description,
|
||||
description=field.schema.description if field.schema else None,
|
||||
)
|
||||
|
||||
|
||||
@@ -70,7 +70,10 @@ class DjangoRestResponsePagination(PaginatorInspector):
|
||||
('previous', openapi.Schema(type=openapi.TYPE_STRING, format=openapi.FORMAT_URI)),
|
||||
('results', response_schema),
|
||||
)),
|
||||
required=['count', 'results']
|
||||
required=['results']
|
||||
)
|
||||
|
||||
if has_count:
|
||||
paged_schema.required.insert(0, 'count')
|
||||
|
||||
return paged_schema
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import logging
|
||||
from collections import OrderedDict
|
||||
|
||||
from rest_framework.request import is_form_media_type
|
||||
@@ -12,6 +13,8 @@ from ..utils import (
|
||||
)
|
||||
from .base import ViewInspector
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class SwaggerAutoSchema(ViewInspector):
|
||||
def __init__(self, view, path, method, components, request, overrides):
|
||||
@@ -83,7 +86,12 @@ class SwaggerAutoSchema(ViewInspector):
|
||||
"""
|
||||
if not hasattr(self.view, 'get_serializer'):
|
||||
return None
|
||||
return self.view.get_serializer()
|
||||
try:
|
||||
return self.view.get_serializer()
|
||||
except Exception:
|
||||
log.warning("view's get_serializer raised exception (%s %s %s)",
|
||||
self.method, self.path, type(self.view).__name__, exc_info=True)
|
||||
return None
|
||||
|
||||
def get_request_serializer(self):
|
||||
"""Return the request serializer (used for parsing the request payload) for this endpoint.
|
||||
@@ -222,6 +230,8 @@ class SwaggerAutoSchema(ViewInspector):
|
||||
response = openapi.Response(
|
||||
description=serializer
|
||||
)
|
||||
elif not serializer:
|
||||
continue
|
||||
elif isinstance(serializer, openapi.Response):
|
||||
response = serializer
|
||||
if hasattr(response, 'schema') and not isinstance(response.schema, openapi.Schema.OR_REF):
|
||||
|
||||
@@ -2,6 +2,7 @@ import json
|
||||
import logging
|
||||
import os
|
||||
from collections import OrderedDict
|
||||
from importlib import import_module
|
||||
|
||||
from django.contrib.auth.models import User
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
@@ -12,7 +13,15 @@ from rest_framework.views import APIView
|
||||
from ... import openapi
|
||||
from ...app_settings import swagger_settings
|
||||
from ...codecs import OpenAPICodecJson, OpenAPICodecYaml
|
||||
from ...generators import OpenAPISchemaGenerator
|
||||
|
||||
|
||||
def import_class(import_string):
|
||||
if not import_string:
|
||||
return None
|
||||
|
||||
module_path, class_name = import_string.rsplit('.', 1)
|
||||
module = import_module(module_path)
|
||||
return getattr(module, class_name)
|
||||
|
||||
|
||||
class Command(BaseCommand):
|
||||
@@ -64,6 +73,11 @@ class Command(BaseCommand):
|
||||
'OpenAPISchemaGenerator.get_schema().\n'
|
||||
'This option implies --mock-request.'
|
||||
)
|
||||
parser.add_argument(
|
||||
'-g', '--generator-class', dest='generator_class_name',
|
||||
default='',
|
||||
help='Import string pointing to an OpenAPISchemaGenerator subclass to use for schema generation.'
|
||||
)
|
||||
|
||||
def write_schema(self, schema, stream, format):
|
||||
if format == 'json':
|
||||
@@ -89,7 +103,8 @@ class Command(BaseCommand):
|
||||
request = APIView().initialize_request(request)
|
||||
return request
|
||||
|
||||
def handle(self, output_file, overwrite, format, api_url, mock, user, private, *args, **options):
|
||||
def handle(self, output_file, overwrite, format, api_url, mock, user, private, generator_class_name,
|
||||
*args, **kwargs):
|
||||
# disable logs of WARNING and below
|
||||
logging.disable(logging.WARNING)
|
||||
|
||||
@@ -117,7 +132,8 @@ class Command(BaseCommand):
|
||||
|
||||
request = self.get_mock_request(api_url, format, user) if mock else None
|
||||
|
||||
generator = OpenAPISchemaGenerator(
|
||||
generator_class = import_class(generator_class_name) or swagger_settings.DEFAULT_GENERATOR_CLASS
|
||||
generator = generator_class(
|
||||
info=info,
|
||||
url=api_url
|
||||
)
|
||||
|
||||
+27
-27
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -76,6 +76,8 @@ def swagger_auto_schema(method=None, methods=None, auto_schema=unset, request_bo
|
||||
|
||||
* if a plain string is given as value, a :class:`.Response` with no body and that string as its description
|
||||
will be generated
|
||||
* if ``None`` is given as a value, the response is ignored; this is mainly useful for disabling default
|
||||
2xx responses, i.e. ``responses={200: None, 302: 'something'}``
|
||||
* if a :class:`.Schema`, :class:`.SchemaRef` is given, a :class:`.Response` with the schema as its body and
|
||||
an empty description will be generated
|
||||
* a ``Serializer`` class or instance will be converted into a :class:`.Schema` and treated as above
|
||||
|
||||
@@ -11,7 +11,6 @@ from rest_framework.settings import api_settings
|
||||
from rest_framework.views import APIView
|
||||
|
||||
from .app_settings import swagger_settings
|
||||
from .generators import OpenAPISchemaGenerator
|
||||
from .renderers import OpenAPIRenderer, ReDocRenderer, SwaggerJSONRenderer, SwaggerUIRenderer, SwaggerYAMLRenderer
|
||||
|
||||
SPEC_RENDERERS = (SwaggerYAMLRenderer, SwaggerJSONRenderer, OpenAPIRenderer)
|
||||
@@ -46,7 +45,7 @@ def deferred_never_cache(view_func):
|
||||
|
||||
|
||||
def get_schema_view(info=None, url=None, patterns=None, urlconf=None, public=False, validators=None,
|
||||
generator_class=OpenAPISchemaGenerator,
|
||||
generator_class=swagger_settings.DEFAULT_GENERATOR_CLASS,
|
||||
authentication_classes=api_settings.DEFAULT_AUTHENTICATION_CLASSES,
|
||||
permission_classes=api_settings.DEFAULT_PERMISSION_CLASSES):
|
||||
"""Create a SchemaView class with default renderers and generators.
|
||||
|
||||
@@ -13,6 +13,6 @@ router.register(r'recursive', views.TodoRecursiveView)
|
||||
urlpatterns = router.urls
|
||||
|
||||
urlpatterns += [
|
||||
url(r'^(?P<todo_id>\d+)/yetanother/(?P<yetanother_id>\d+)/$',
|
||||
url(r'^(?P<todo_id>\d+)/yetanothers/(?P<yetanother_id>\d+)/$',
|
||||
views.NestedTodoView.as_view(), ),
|
||||
]
|
||||
|
||||
+40
-2
@@ -1,6 +1,8 @@
|
||||
from rest_framework import viewsets
|
||||
from rest_framework.generics import RetrieveAPIView
|
||||
|
||||
from drf_yasg.utils import swagger_auto_schema
|
||||
|
||||
from .models import Todo, TodoAnother, TodoTree, TodoYetAnother
|
||||
from .serializer import (
|
||||
TodoAnotherSerializer, TodoRecursiveSerializer, TodoSerializer, TodoTreeSerializer, TodoYetAnotherSerializer
|
||||
@@ -31,9 +33,45 @@ class NestedTodoView(RetrieveAPIView):
|
||||
|
||||
class TodoTreeView(viewsets.ReadOnlyModelViewSet):
|
||||
queryset = TodoTree.objects.all()
|
||||
serializer_class = TodoTreeSerializer
|
||||
|
||||
def get_serializer_class(self):
|
||||
if getattr(self, 'swagger_fake_view', False):
|
||||
return TodoTreeSerializer
|
||||
|
||||
raise NotImplementedError("must not call this")
|
||||
|
||||
|
||||
class TodoRecursiveView(viewsets.ModelViewSet):
|
||||
queryset = TodoTree.objects.all()
|
||||
serializer_class = TodoRecursiveSerializer
|
||||
|
||||
def get_serializer(self, *args, **kwargs):
|
||||
raise NotImplementedError("must not call this")
|
||||
|
||||
def get_serializer_class(self):
|
||||
raise NotImplementedError("must not call this")
|
||||
|
||||
def get_serializer_context(self):
|
||||
raise NotImplementedError("must not call this")
|
||||
|
||||
@swagger_auto_schema(request_body=TodoRecursiveSerializer)
|
||||
def create(self, request, *args, **kwargs):
|
||||
return super(TodoRecursiveView, self).create(request, *args, **kwargs)
|
||||
|
||||
@swagger_auto_schema(responses={200: None, 302: 'Redirect somewhere'})
|
||||
def retrieve(self, request, *args, **kwargs):
|
||||
return super(TodoRecursiveView, self).retrieve(request, *args, **kwargs)
|
||||
|
||||
@swagger_auto_schema(request_body=TodoRecursiveSerializer)
|
||||
def update(self, request, *args, **kwargs):
|
||||
return super(TodoRecursiveView, self).update(request, *args, **kwargs)
|
||||
|
||||
@swagger_auto_schema(request_body=TodoRecursiveSerializer)
|
||||
def partial_update(self, request, *args, **kwargs):
|
||||
return super(TodoRecursiveView, self).update(request, *args, **kwargs)
|
||||
|
||||
def destroy(self, request, *args, **kwargs):
|
||||
return super(TodoRecursiveView, self).destroy(request, *args, **kwargs)
|
||||
|
||||
@swagger_auto_schema(responses={200: TodoRecursiveSerializer(many=True)})
|
||||
def list(self, request, *args, **kwargs):
|
||||
return super(TodoRecursiveView, self).list(request, *args, **kwargs)
|
||||
|
||||
@@ -560,10 +560,8 @@ paths:
|
||||
description: ''
|
||||
parameters: []
|
||||
responses:
|
||||
'200':
|
||||
description: ''
|
||||
schema:
|
||||
$ref: '#/definitions/TodoRecursive'
|
||||
'302':
|
||||
description: Redirect somewhere
|
||||
tags:
|
||||
- todo
|
||||
put:
|
||||
@@ -697,9 +695,9 @@ paths:
|
||||
description: A unique integer value identifying this todo.
|
||||
required: true
|
||||
type: integer
|
||||
/todo/{todo_id}/yetanother/{yetanother_id}/:
|
||||
/todo/{todo_id}/yetanothers/{yetanother_id}/:
|
||||
get:
|
||||
operationId: todo_yetanother_read
|
||||
operationId: todo_yetanothers_read
|
||||
description: ''
|
||||
parameters: []
|
||||
responses:
|
||||
|
||||
@@ -11,17 +11,18 @@ import pytest
|
||||
from django.contrib.auth.models import User
|
||||
from django.core.management import call_command
|
||||
|
||||
from drf_yasg import openapi
|
||||
from drf_yasg.codecs import yaml_sane_load
|
||||
from drf_yasg.generators import OpenAPISchemaGenerator
|
||||
|
||||
|
||||
def call_generate_swagger(output_file='-', overwrite=False, format='', api_url='',
|
||||
mock=False, user='', private=False, **kwargs):
|
||||
mock=False, user='', private=False, generator_class_name='', **kwargs):
|
||||
out = StringIO()
|
||||
call_command(
|
||||
'generate_swagger', stdout=out,
|
||||
output_file=output_file, overwrite=overwrite, format=format,
|
||||
api_url=api_url, mock=mock, user=user, private=private,
|
||||
**kwargs
|
||||
output_file=output_file, overwrite=overwrite, format=format, api_url=api_url, mock=mock, user=user,
|
||||
private=private, generator_class_name=generator_class_name, **kwargs
|
||||
)
|
||||
return out.getvalue()
|
||||
|
||||
@@ -46,6 +47,17 @@ def test_no_mock(db):
|
||||
assert len(output_schema['paths']) > 0
|
||||
|
||||
|
||||
class EmptySchemaGenerator(OpenAPISchemaGenerator):
|
||||
def get_paths(self, endpoints, components, request, public):
|
||||
return openapi.Paths(paths={}), ''
|
||||
|
||||
|
||||
def test_generator_class(db):
|
||||
output = call_generate_swagger(generator_class_name='test_management.EmptySchemaGenerator')
|
||||
output_schema = json.loads(output, object_pairs_hook=OrderedDict)
|
||||
assert len(output_schema['paths']) == 0
|
||||
|
||||
|
||||
def silentremove(filename):
|
||||
try:
|
||||
os.remove(filename)
|
||||
|
||||
@@ -2,7 +2,9 @@ import json
|
||||
from collections import OrderedDict
|
||||
|
||||
import pytest
|
||||
from django.conf.urls import url
|
||||
from rest_framework import routers, serializers, viewsets
|
||||
from rest_framework.decorators import api_view
|
||||
from rest_framework.response import Response
|
||||
|
||||
from drf_yasg import codecs, openapi
|
||||
@@ -113,3 +115,35 @@ def test_replaced_serializer():
|
||||
responses = swagger['paths']['/details/{id}/']['get']['responses']
|
||||
assert '404' in responses
|
||||
assert responses['404']['schema']['$ref'] == "#/definitions/Detail"
|
||||
|
||||
|
||||
def test_url_order():
|
||||
# this view with description override should show up in the schema ...
|
||||
@swagger_auto_schema(method='get', operation_description="description override")
|
||||
@api_view()
|
||||
def test_override(request, pk=None):
|
||||
return Response({"message": "Hello, world!"})
|
||||
|
||||
# ... instead of this view which appears later in the url patterns
|
||||
@api_view()
|
||||
def test_view(request, pk=None):
|
||||
return Response({"message": "Hello, world!"})
|
||||
|
||||
patterns = [
|
||||
url(r'^/test/$', test_override),
|
||||
url(r'^/test/$', test_view),
|
||||
]
|
||||
|
||||
generator = OpenAPISchemaGenerator(
|
||||
info=openapi.Info(title="Test generator", default_version="v1"),
|
||||
version="v2",
|
||||
url='',
|
||||
patterns=patterns
|
||||
)
|
||||
|
||||
# description override is successful
|
||||
swagger = generator.get_schema(None, True)
|
||||
assert swagger['paths']['/test/']['get']['description'] == 'description override'
|
||||
|
||||
# get_endpoints only includes one endpoint
|
||||
assert len(generator.get_endpoints(None)['/test/'][1]) == 1
|
||||
|
||||
Reference in New Issue
Block a user