-
Notifications
You must be signed in to change notification settings - Fork 190
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
Labels
documentation
Everything about documentation
Comments
We can use either redoc or swagger-ui https://www.django-rest-framework.org/topics/documenting-your-api/ |
We were using drf-spectacular previously, but it's not been used anymore because of tfranzel/drf-spectacular#389 |
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
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
The text was updated successfully, but these errors were encountered: