Commit Graph

334 Commits (01391ca9eb357688a231eff269a06de95f717346)

Author SHA1 Message Date
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
Cristi Vîjdea a2c21539f7
Prepare release 1.0.4 2017-12-16 18:18:21 +01:00
Cristi Vîjdea 73bd7a136d
Add query_serializer argument to swagger_auto_schema (#17)
Closes #16.
2017-12-16 15:37:42 +01:00
Cristi Vîjdea bdf7e8a4ae Prepare release 1.0.3 2017-12-15 19:25:25 +01:00
Cristi Vîjdea 174f1153b4
Fix broken SwaggerDict pickling (#15)
Closes #14.
2017-12-15 18:47:10 +01:00
Cristi Vîjdea af2a44e1e9 Update documentation about Responses and form data 2017-12-15 12:13:09 +01:00
Cristi Vîjdea f6a535eb45 Do not attempt to generate a response schema for form-only requests
It would probably fail because Schema objects cannot represent files
2017-12-15 11:14:47 +01:00
Cristi Vîjdea e14c102b59 Repack into version 1.0.2 2017-12-13 11:16:09 +01:00
Cristi Vîjdea 83e539ab2e Rename to drf-yasg, part 2 2017-12-13 10:45:43 +01:00
Cristi Vîjdea c66f7e8e01 Rename to drf-yasg
drf-swagger was already taken
2017-12-13 10:22:03 +01:00
Cristi Vîjdea 71b3fd2895 Clean up for publish to pypi 2017-12-12 23:42:54 +01:00
Cristi Vîjdea 8883894775
Add more tests and cleanup coverage reports (#13)
Closes #11
2017-12-12 17:30:58 +01:00
Cristi Vîjdea 53ac55a24b
Add dcumentation (#12)
* added sphinx documentation
* filled in most missing docstrings
* updated README and setup.py, added CONTRIBUTING
* added docs build target
2017-12-12 11:14:33 +01:00
Cristi Vîjdea bfced82ae4
Add suport for Response schemas (#10)
Schemas generated from Serializers will now be added to the `definitions` section by default, and used as `$ref` objects where needed.  
The Schema definition name is based on the serializer class name, and can be overriden by specifying a `__ref_name__` property on the Serializer. If this property is set to None, the schema will not be added to `definitions` and will be forced inline.

Closes #6, #7.
2017-12-10 03:06:49 +01:00
Cristi Vîjdea 53b2560063 Add codecov configuration 2017-12-08 18:26:39 +01:00
Cristi Vîjdea e5f598cdf3
Merge pull request #9 from axnsan12/schema-customization
Preliminary work on manual schema customization hooks
2017-12-08 17:59:02 +01:00
Cristi Vîjdea 652795f5db Add swagger_auto_schema method decorator for Operation customization
See #5.
2017-12-08 17:45:00 +01:00
Cristi Vîjdea 82cac4ef0d Sort paths in output 2017-12-06 10:46:27 +01:00
Cristi Vîjdea 3f428d0cd1 Add `127.0.0.1` and `localhost` to ALLOWED_HOSTS 2017-12-06 09:46:33 +01:00
Cristi Vîjdea dce00156d5
Rewrite schema generation (#1)
* Completeley rewritten schema generation
* Added support for python 2.7 and 3.4
* Restructured testing and build configuration
* Added nested request schemas

This rewrite completely replaces the public interface of the django rest schema generation library, so 
further changes will be needed to re-enable and further extend the customization points one might want.
2017-12-05 19:46:02 +01:00
Cristi Vîjdea 5658910711 Merge branch 'fix-travis' 2017-12-03 00:02:36 +01:00
Cristi Vîjdea 93c51b992d Fix python 3.7 -> 3.7-dev and add flake8 testing
Also fixed flake8 errors.
2017-12-02 23:48:58 +01:00
Cristi Vîjdea fed253aeed Switch to tox-travis instead of multiple TOX_ENV 2017-12-02 22:57:49 +01:00
Cristi Vîjdea 2f4c23f7ec Fix .travis.yml #1 2017-12-02 22:53:09 +01:00
Cristi Vîjdea 2b0d80dc0f Restructure project to add test support
* separated drf_swagger and testproj modules, moved both out of project root
* added testing support via pytest and tox
* enabled Travis CI
* integrated coverage & Coveralls
2017-12-02 22:48:29 +01:00
Cristi Vîjdea 207973ae5a Add README and documentation 2017-11-30 22:24:17 +01:00
Cristi Vîjdea ed02e3c3a1 Initial implementation as coreapi wrapper
* schema generation implemented via coreapi Document and openapi_codec
* schema interface selectable from the latest versions of swagger-ui and redoc
* feature parity with django-rest-swagger 2
2017-11-30 04:23:56 +01:00
Cristi Vîjdea cbd8cb68cf
Initial commit 2017-11-29 11:30:23 +01:00