docs: document data sources and external services#2457
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2457 +/- ##
=======================================
Coverage 67.80% 67.80%
=======================================
Files 172 172
Lines 13318 13318
=======================================
Hits 9030 9030
Misses 3574 3574
Partials 714 714 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Document the external services OSV-Scanner communicates with: - OSV.dev API for vulnerability queries - deps.dev API for license and dependency information - Package registries (Maven, npm) for native resolution Fixes google#1433
Ankitsinghsisodya
force-pushed
the
docs/document-data-sources
branch
from
aa9ea1c to
e1e2d96
Compare
Contributor
Author
|
@cuixq, I have done all the required changes suggested by you. |
cuixq
approved these changes
Jan 12, 2026
- Add link to offline mode documentation for --offline reference - Clarify native registry wording for dependency resolution
…sources' into docs/document-data-sources
Contributor
Author
|
Thanks @cuixq! Both suggestions have been applied. |
Contributor
Author
another-rex
approved these changes
Jan 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Issue: #1433
This PR adds a "Data Sources and Privacy" section to the README documenting the external services OSV-Scanner communicates with during operation.
Fixes #1433
Details
Added documentation for:
/v1/querybatch,/v1/determineversion) - Vulnerability queries and vendored C/C++ detectionThe section also clarifies that
--offlinemode disables network requests, and that no source code is transmitted.Testing
Checklist