Briq
/
drf-yasg
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix README and CONTRIBUTING

openapi3
Cristi Vîjdea 2018-01-12 15:18:18 +01:00
parent fc253665dd
commit e30af0287f
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.rst
View File

@ -103,16 +103,17 @@ Maintainer's notes
Release checklist Release checklist
================= =================
* update ``docs/changelog.rst`` with changes since the latest tag * update ``docs/changelog.rst`` with changes since the last tagged version
* commit & tag the release * commit & tag the release - ``git tag x.x.x -m "Release version x.x.x"``
* push using ``git push --follow-tags`` * push using ``git push --follow-tags``
* verify that `Travis`_ has built the tag and succesfully published the release to PyPI * verify that `Travis`_ has built the tag and succesfully published the release to `PyPI`_
* publish release notes `on GitHub`_ * publish release notes `on GitHub`_
* start the `ReadTheDocs build`_ if it has not already started * start the `ReadTheDocs build`_ if it has not already started
* deploy the live demo `on Heroku`_ * deploy the live demo `on Heroku`_
.. _Travis: https://travis-ci.org/axnsan12/drf-yasg/builds .. _Travis: https://travis-ci.org/axnsan12/drf-yasg/builds
.. _PyPI: https://pypi.org/project/drf-yasg/
.. _on GitHub: https://github.com/axnsan12/drf-yasg/releases .. _on GitHub: https://github.com/axnsan12/drf-yasg/releases
.. _ReadTheDocs build: https://readthedocs.org/projects/drf-yasg/builds/ .. _ReadTheDocs build: https://readthedocs.org/projects/drf-yasg/builds/
.. _on Heroku: https://dashboard.heroku.com/pipelines/412d1cae-6a95-4f5e-810b-94869133f36a .. _on Heroku: https://dashboard.heroku.com/pipelines/412d1cae-6a95-4f5e-810b-94869133f36a

6
README.rst
View File

@ -42,10 +42,8 @@ Features
- generated Swagger schema can be automatically validated by - generated Swagger schema can be automatically validated by
`swagger-spec-validator <https://github.com/Yelp/swagger_spec_validator>`_ or `swagger-spec-validator <https://github.com/Yelp/swagger_spec_validator>`_ or
`flex <https://github.com/pipermerriam/flex>`_ `flex <https://github.com/pipermerriam/flex>`_
- supports Django REST Framework API versioning - supports Django REST Framework API versioning with ``URLPathVersioning`` and ``NamespaceVersioning``; other DRF
or custom versioning schemes are not currently supported
+ ``URLPathVersioning`` and ``NamespaceVersioning`` are supported
+ ``HostnameVersioning``, ``AcceptHeaderVersioning`` and ``QueryParameterVersioning`` are not currently supported
.. figure:: https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/redoc-nested-response.png .. figure:: https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/redoc-nested-response.png
:width: 100% :width: 100%