We need to update the VulnerableCode RTD documentation to reflect the replacement of vulnerabilities with security advisories as the primary data structure. The sections that need attention include:
- Overview: Distinguish between references to vulnerabilities in general and the new advisory data. For example the second bullet under "What can I do with VulnerableCode? says: "With the JSON API, you can perform package queries using Package URLs (purl) or query by vulnerability id (“VCID”). You can also query by CPEs and other vulnerability aliases. The API provides paginated index and detail endpoints and includes indexes of vulnerable CPEs and vulnerable Package URLs." I would expect this to say that you can query by advisory/AVID.
- User interface / search by vulnerabilities refers to VCID instead of AVID in the screen shots and text.
- API overview uses vulnerability terminology and the API endpoints reference shows /api/vulnerabilities. I do not know whether we still offer a cpe endpoint. It is not listed at: https://public2.vulnerablecode.io/api/docs/
- Framework Overview seems to refer to VCID instead of AVID
- Model Overview (DB diagram) is from 2023-11-27. It needs to be updated for the change from vulnerabilties to advisories.
- Importers and Sources tables seem to be redundant (separate problem but lets fix it).
We need to update the VulnerableCode RTD documentation to reflect the replacement of vulnerabilities with security advisories as the primary data structure. The sections that need attention include: