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

Reset default VCIO API to v1 and announce availability of v2 #1663

Open
mjherzog opened this issue Nov 18, 2024 · 1 comment
Open

Reset default VCIO API to v1 and announce availability of v2 #1663

mjherzog opened this issue Nov 18, 2024 · 1 comment

Comments

@mjherzog
Copy link
Member

Sometime last week the default API for VCIO changed to v2 without any announcement of the change or how v2 is different.

When you select API from the top menu and click on the VulnerableCode JSON REST API link you are sent to:

https://public.vulnerablecode.io/api/v2/ shows:
The default basic root view for DefaultRouter
GET /api/v2/

You can apparently get to the old API by removing /v2/ from the URL - https://public.vulnerablecode.io/api/ shows:
The default basic root view for DefaultRouter
GET /api/

This is very confusing. I do not see any documentation at: https://vulnerablecode.readthedocs.io/en/latest/api.html about the v2 API and how it is different from v1.

Longer term we probably need something like the DejaCode dropdown menu, but in the short term perhaps we could add a one-time menu item for the v2 API to alert users about the change. And obviously we need documentation of v2 and the differences from v1 in ReadTheDocs.

@TG1999
Copy link
Contributor

TG1999 commented Nov 19, 2024

@mjherzog ack! good catch

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

No branches or pull requests

3 participants