Skip to content

docs: Clarify querybatch response mapping #5442

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.

Sign up for GitHub

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

Closed
Haihan-Jiang wants to merge 1 commit into from
Closed

docs: Clarify querybatch response mapping #5442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/api/post-v1-querybatch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ nav_order: 3
# POST /v1/querybatch
Query for multiple packages (by either package and version or git commit hash) at once. Returns vulnerability ids and modified field only. The response ordering will be guaranteed to match the input.

Each item in `results` corresponds to the query at the same index in `queries`.
If a query has no matched vulnerabilities, its corresponding result entry may
be an empty object. The `vulns` entries are intentionally summaries containing
`id` and `modified`, not full vulnerability records. To retrieve the complete
OSV record, call [GET /v1/vulns/{id}](get-v1-vulns.md) for the returned IDs;
clients can use the `id` and `modified` pair to decide whether a cached record
is still fresh.

{: .no_toc }

<details open markdown="block">
Expand Down