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

Improve the UX of failed vulnerability retrieval by the API #2235

Open
andrewpollock opened this issue May 23, 2024 · 1 comment
Open

Improve the UX of failed vulnerability retrieval by the API #2235

andrewpollock opened this issue May 23, 2024 · 1 comment
Assignees
Labels
api API-related infrastructure backlog Important but currently unprioritized documentation Improvements or additions to documentation

Comments

@andrewpollock
Copy link
Contributor

andrewpollock commented May 23, 2024

Describe the bug
Users try to retrieve a vulnerability (typically a CVE) by the API that the web interface reports as an alias of another vulnerability and that retrieval fails because the CVE record does not exist in OSV.dev

To Reproduce
Steps to reproduce the behaviour:

  1. View a vulnerability record on OSV.dev with an (unlinked) alias to a CVE
  2. Attempt to retrieve that CVE via the API
  3. Get a 404/Bug not found response from the API

Expected behaviour
The user receives some pointers to documentation to assist with interpreting the search failure.

My initial thoughts:

Screenshots

Contrived example:

$ GET -s https://api.osv.dev/v1/vulns/CVE-2025-0001
404 Not Found
{"code":5,"message":"Bug not found."}
@andrewpollock andrewpollock added documentation Improvements or additions to documentation api API-related infrastructure labels May 23, 2024
Copy link

This issue has not had any activity for 60 days and will be automatically closed in two weeks

@github-actions github-actions bot added the stale The issue or PR is stale and pending automated closure label Jul 30, 2024
@andrewpollock andrewpollock self-assigned this Aug 5, 2024
@oliverchang oliverchang added backlog Important but currently unprioritized and removed stale The issue or PR is stale and pending automated closure labels Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api API-related infrastructure backlog Important but currently unprioritized documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants