summaryrefslogtreecommitdiff
path: root/doc/api/vulnerability_findings.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/vulnerability_findings.md')
-rw-r--r--doc/api/vulnerability_findings.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/vulnerability_findings.md b/doc/api/vulnerability_findings.md
index d1d4966f0f0..f5e607d6829 100644
--- a/doc/api/vulnerability_findings.md
+++ b/doc/api/vulnerability_findings.md
@@ -6,7 +6,7 @@ NOTE: **Note:**
This API resource is renamed from Vulnerabilities to Vulnerability Findings because the Vulnerabilities are reserved
for serving the upcoming [Standalone Vulnerability objects](https://gitlab.com/gitlab-org/gitlab/issues/13561).
To fix any broken integrations with the former Vulnerabilities API, change the `vulnerabilities` URL part to be
-`vulnerability_findings`.
+`vulnerability_findings`.
Every API call to vulnerability findings must be [authenticated](README.md#authentication).
@@ -46,6 +46,9 @@ GET /projects/:id/vulnerability_findings?confidence=unknown,experimental
GET /projects/:id/vulnerability_findings?pipeline_id=42
```
+CAUTION: **Deprecation:**
+Beginning with GitLab 12.9, the `undefined` severity level is deprecated and the `undefined` confidence level isn't reported for new vulnerabilities.
+
| Attribute | Type | Required | Description |
| ------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) which the authenticated user is a member of. |