Skip to content

VCIO V3 API migration completed#173

Open
TG1999 wants to merge 4 commits into
aboutcode-org:mainfrom
TG1999:announce_v3_api
Open

VCIO V3 API migration completed#173
TG1999 wants to merge 4 commits into
aboutcode-org:mainfrom
TG1999:announce_v3_api

Conversation

@TG1999

@TG1999 TG1999 commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

No description provided.

TG1999 added 3 commits July 6, 2026 23:56
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
@mjherzog

mjherzog commented Jul 6, 2026

Copy link
Copy Markdown
Member

@TG1999 - I would recommend two changes:

  • Lead with V3 and why it is a major upgrade with deprecation second
  • Provide a bit more commentary on V3 vs the older versions

Some possible text is:


Introducing VulnerableCode V3

The AboutCode team has released v40.0.0 https://github.com/aboutcode-org/vulnerablecode/releases/tag/v40.0.0 with the the V3 VulnerableCode API which replaces "vulnerabilities" with "advisories". Prior to this release we reported vulnerabilities for each PURL (Package-URL) where a vulnerability combined multiple advisories. With the new advisory model each advisory is reported individually which provides more granular data and makes it easier for you to prioritize data sources that you trust more.

With this release the VulnerableCode V1 and V2 APIs have been deprecated along with the corresponding vulnerability-based data. You can download the V1/V2 vulnerability data from: https://github.com/aboutcode-org/vulnerablecode/releases/tag/vcio-v1. This is a final data archive for the old data structure.

Refer to https://public.vulnerablecode.io/api/docs/ and https://vulnerablecode.readthedocs.io/en/latest/api_v3_usage.html to understand the latest V3 API usage.


I am concerned that the documentation references contain a confusing mixture of content for the new and old APIs and data structures. And the January blog post does not really explain the features or benefits of the new approach.
We need to address that very soon. I posted one issue for the data model: aboutcode-org/vulnerablecode#2296 but covers only one of the sections that we need to update.

Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants