Skip to content

docs: Clarify querybatch response mapping#5442

Closed
Haihan-Jiang wants to merge 1 commit into
google:masterfrom
Haihan-Jiang:docs-querybatch-response-order
Closed

docs: Clarify querybatch response mapping#5442
Haihan-Jiang wants to merge 1 commit into
google:masterfrom
Haihan-Jiang:docs-querybatch-response-order

Conversation

@Haihan-Jiang
Copy link
Copy Markdown

Clarifies the /v1/querybatch response shape:

  • each result maps to the query at the same index
  • an empty result object means that query has no matched vulnerabilities
  • returned vuln entries are id/modified summaries, not full OSV records
  • clients should fetch full records with GET /v1/vulns/{id} and can use id + modified for cache freshness

Tests:

  • git diff --check
  • test -f docs/api/get-v1-vulns.md

Not run:

  • bundle exec jekyll build; the local system Ruby is 2.6 and the docs lockfile requires Bundler 2.4.20.

Fixes #466.

@G-Rath
Copy link
Copy Markdown
Collaborator

G-Rath commented May 26, 2026

Please read and follow our contributing guide before opening pull requests

@G-Rath G-Rath closed this May 26, 2026
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.

Clarify documentation of return format for /v1/querybatch API

2 participants