Skip to content

Commit 66f5552

Browse files
Add clarification to FAQ on how OSV.dev handles withdrawn records. (#2295)
Co-authored-by: Andrew Pollock <[email protected]>
1 parent 3376f6c commit 66f5552

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/faq.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,23 @@ In some cases, there may be no applicable versions, so the `affected.versions[]`
6464
array is empty. This field, when empty, is omitted in the API output, and
6565
present (but empty) in the [data exports](#is-the-database-available-to-download).
6666

67+
## How does OSV.dev handle withdrawn records?
68+
69+
Records that have the [`withdrawn`](https://ossf.github.io/osv-schema/#withdrawn-field) field set will be excluded from:
70+
* the responses to POST API queries
71+
* the main [list page](https://osv.dev/list) and related search results
72+
The entry remains in the database, and:
73+
* is returned by the `/vulns/<ID>` GET API
74+
* is visible at `https://osv.dev/vulnerability/<ID>` page (and clearly visibly marked as "withdrawn")
75+
* still exported in the [GCS exports](#is-the-database-available-to-download) (including the `withdrawn` field)
76+
77+
## How does OSV.dev handle deleted records?
78+
79+
When a record is deleted from an upstream source, OSV.dev currently handles them differently, depending on where they're imported from:
80+
81+
- GCS sources: OSV.dev marks deleted records as [`withdrawn`](https://ossf.github.io/osv-schema/#withdrawn-field). There is additionally a safety threshold in the case of feed availability issues: if more than 10% of records are about to be marked as `withdrawn`, OSV.dev aborts and does not proceed.
82+
- REST and Git sources: OSV.dev leaves the existing records valid but orphaned. This behaviour will be changed to match the GCS source. See <https://github.com/google/osv.dev/issues/2101> and <https://github.com/google/osv.dev/issues/2294>.
83+
6784
## How do I use OSV as an open source user?
6885

6986
OSV.dev provides an [easy-to-use API](../api/) for querying against the aggregated database of vulnerabilities.

0 commit comments

Comments
 (0)