Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API documentation for VulnerableCode.io #976

Closed
mjherzog opened this issue Oct 20, 2022 · 3 comments
Closed

Add API documentation for VulnerableCode.io #976

mjherzog opened this issue Oct 20, 2022 · 3 comments
Labels
documentation Everything about documentation

Comments

@mjherzog
Copy link
Member

We need to add basic API usage documentation for VulnerableCode.io. This should probably be added in the Reference section and then we can provide a direct link to the new section from VCIO. My assumption is that this documentation can be generated in the same way as we handle API documentation for SCIO

@mjherzog mjherzog added the documentation Everything about documentation label Oct 20, 2022
@TG1999
Copy link
Contributor

TG1999 commented Oct 25, 2022

We can use either redoc or swagger-ui https://www.django-rest-framework.org/topics/documenting-your-api/

@TG1999
Copy link
Contributor

TG1999 commented Oct 25, 2022

We were using drf-spectacular previously, but it's not been used anymore because of tfranzel/drf-spectacular#389

@pombredanne
Copy link
Collaborator

This is completed. Closing. See https://public.vulnerablecode.io/api/docs/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Everything about documentation
Projects
None yet
Development

No branches or pull requests

3 participants