_content/security/vulndb: move API docs to separate page
Also add link to the main page to relevant documentation.
Change-Id: I824e5385a53a578d722f1c3dc97457de1d0efce2
Reviewed-on: https://go-review.googlesource.com/c/website/+/410245
Reviewed-by: Julie Qiu <julieqiu@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Tatiana Bradley <tatiana@golang.org>
Run-TryBot: Julie Qiu <julieqiu@google.com>
diff --git a/_content/security/vulndb/api.md b/_content/security/vulndb/api.md
new file mode 100644
index 0000000..cb03bc3
--- /dev/null
+++ b/_content/security/vulndb/api.md
@@ -0,0 +1,62 @@
+---
+title: Go Vulnerability Database API
+layout: article
+---
+
+## Overview
+
+The Go vulnerability database is rooted at `https://vuln.go.dev` and
+provides data as JSON. We recommend using
+[client.Client](https://pkg.go.dev/golang.org/x/vuln/client#Client) to read
+data from the Go vulnerability database.
+
+Do not rely on the contents of the x/vulndb repository. The YAML files in that
+repository are maintained using an internal format that is subject to change
+without warning.
+
+## API
+
+The endpoints in the table below are supported. For each path:
+
+- `$base` is the path portion of a Go vulnerability database URL (`https://vuln.go.dev`).
+- `$module` is a module path
+- `$vuln` is a Go vulnerability ID (for example, `GO-2021-1234`)
+
+<table>
+ <thead>
+ <tr>
+ <th>Path</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>$base/index.json</code></td>
+ <td>
+ List of module paths in the database mapped to its last modified
+ timestamp (<a href="https://vuln.go.dev/index.json">link</a>).
+ </td>
+ </tr>
+ <tr>
+ <td><code>$base/$module.json</code></td>
+ <td>
+ List of vulnerability entries for that module (<a href="https://vuln.go.dev/golang.org/x/crypto.json">example</a>).
+ </td>
+ </tr>
+ <tr>
+ <td><code>$base/ID/index.json</code></td>
+ <td>
+ List of all the vulnerability entries in the database.
+ </td>
+ </tr>
+ <tr>
+ <td><code>$base/ID/$vuln.json</code></td>
+ <td>
+ An individual Go vulnerability report.
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+Note that these paths and format are provisional and likely to change until an
+approved proposal.
diff --git a/_content/security/vulndb/index.md b/_content/security/vulndb/index.md
index c6bdacf..c567440 100644
--- a/_content/security/vulndb/index.md
+++ b/_content/security/vulndb/index.md
@@ -45,58 +45,19 @@
6. A **web portal** that presents information about vulnerabilities, hosted at
[pkg.go.dev/vuln](https://pkg.go.dev/vuln).
-## Protocol
-The Go vulnerability database is rooted at `https://vuln.go.dev` and
-provides data as JSON. We recommend using
-[client.Client](https://pkg.go.dev/golang.org/x/vuln/client#Client) to read
-data from the Go vulnerability database.
+## References
-Do not rely on the contents of the x/vulndb repository. The YAML files in that
-repository are maintained using an internal format that is subject to change
-without warning.
+### [Go Vulnerability Database API](https://go.dev/security/vulndb/api)
-The endpoints in the table below are supported. For each path:
+Documentation on the Go vulnerability database API.
-- `$base` is the path portion of a Go vulnerability database URL (`https://vuln.go.dev`).
-- `$module` is a module path
-- `$vuln` is a Go vulnerabilitiy ID (for example, `GO-2021-1234`)
+### [Vulnerability Detection For Go](https://go.dev/security/vulncheck)
-<table>
- <thead>
- <tr>
- <th>Path</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>$base/index.json</code></td>
- <td>
- List of module paths in the database mapped to its last modified
- timestamp (<a href="https://vuln.go.dev/index.json">link</a>).
- </td>
- </tr>
- <tr>
- <td><code>$base/$module.json</code></td>
- <td>
- List of vulnerability entries for that module (<a href="https://vuln.go.dev/golang.org/x/crypto.json">example</a>).
- </td>
- </tr>
- <tr>
- <td><code>$base/ID/index.json</code></td>
- <td>
- List of all the vulnerability entries in the database.
- </td>
- </tr>
- <tr>
- <td><code>$base/ID/$vuln.json</code></td>
- <td>
- An individual Go vulnerability report.
- </td>
- </tr>
- </tbody>
-</table>
+An explanation of the features of vulncheck. Reference documentation is
+at
+[pkg.go.dev/golang.org/x/vuln/vulncheck](https://pkg.go.dev/golang.org/x/vuln/vulncheck)
-Note that these paths and format are provisional and likely to change until an
-approved proposal.
+### [Command govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck)
+
+Documentation on the CLI tool govulncheck.
