Skip to content

Commit ae47470

Browse files
committed
_content/doc/security/vuln: document the review_status field for vulns
Adds documentation explaining how to interpret the new ecosystem_specific.review_status field. Change-Id: I537c3ab9e205b7a5c840fd4b01197ed152f8ccc1 Reviewed-on: https://go-review.googlesource.com/c/website/+/586495 LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: Damien Neil <[email protected]>
1 parent 03b6662 commit ae47470

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

_content/doc/security/vuln/database.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,11 +189,26 @@ array will have these two fields:
189189
- **goos**: a string array with the execution operating system where the symbols appear, if known
190190
- **goarch**: a string array with the architecture where the symbols appear, if known
191191

192-
### database_specific.url
192+
### database_specific
193+
194+
The `database_specific` field contains custom fields specific to the Go vulnerability database.
195+
196+
#### database_specific.url
193197

194198
The `database_specific.url` field is a string representing the fully-qualified
195199
URL of the Go vulnerability report, e.g, "https://pkg.go.dev/vuln/GO-2023-1621".
196200

201+
#### database_specific.review_status
202+
203+
The `database_specific.review_status` field is a string representing the review
204+
status of the vulnerability report. If not present, the report should be
205+
considered `REVIEWED`. The possible values are:
206+
207+
- `UNREVIEWED`: The report was automatically generated based on another source, such as
208+
a CVE or GHSA. Its data may be limited and has not been verified by the Go team.
209+
- `REVIEWED`: The report originated from the Go team, or was generated based on an external source.
210+
A member of the Go team has reviewed the report, and where appropriate, added additional data.
211+
197212
For information on other fields in the schema, refer to the [OSV spec](https://ossf.github.io/osv-schema).
198213

199214
## Examples

0 commit comments

Comments
 (0)