Add swagger support and improve REST API documentation #59
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
can we test this in stage? |
andrey-canon
requested changes
Feb 9, 2021
eox_tagging/api/v1/viewset.py
Outdated
| """ | ||
| Fetch details for a single tag by key | ||
| """, | ||
| responses={404: "Not found"}, |
There was a problem hiding this comment.
could you use the status from drf ?
eox_tagging/api_schema.py
Outdated
| security_definitions = { | ||
| "OAuth2": { | ||
| "flow": "application", | ||
| "tokenUrl": "{}/oauth2/access_token/".format(settings.LMS_ROOT_URL), |
There was a problem hiding this comment.
you can get this url by using reverse()
andrey-canon
approved these changes
Feb 9, 2021
* A new view under `/eox-tagging/api-docs` can be used to interact
with the REST API
* Added descriptions of all the parameters and methods used by the
API
* Included a backport fix for carltongibson/django-filter#1323
MoisesGSalas
force-pushed
the
mgs/swagger-docs
branch
from
7efbc77 to
f64209a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similarly to eox-core, this PR aims to provide documentation that's more easily accessible.
Changes include:
/eox-tagging/api-docs/that will serve the live documentation