From b54cbe2c737b3672737bb7cd1919a030cd75484c Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Wed, 11 Aug 2021 18:10:52 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/api/graphql/reference/index.md | 62 +++++++++++++++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) (limited to 'doc/api/graphql') diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 64b85b60ed4..4959722665d 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -4421,6 +4421,39 @@ Input type: `VulnerabilityConfirmInput` | `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | | `vulnerability` | [`Vulnerability`](#vulnerability) | The vulnerability after state change. | +### `Mutation.vulnerabilityCreate` + +Input type: `VulnerabilityCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| `confidence` | [`VulnerabilityConfidence`](#vulnerabilityconfidence) | Confidence of the vulnerability (defaults to `unknown`). | +| `confirmedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to confirmed (defaults to creation time if status is `confirmed`). | +| `description` | [`String!`](#string) | Description of the vulnerability. | +| `detectedAt` | [`Time`](#time) | Timestamp of when the vulnerability was first detected (defaults to creation time). | +| `dismissedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to dismissed (defaults to creation time if status is `dismissed`). | +| `identifiers` | [`[VulnerabilityIdentifierInput!]!`](#vulnerabilityidentifierinput) | Array of CVE or CWE identifiers for the vulnerability. | +| `message` | [`String`](#string) | Additional information about the vulnerability. | +| `project` | [`ProjectID!`](#projectid) | ID of the project to attach the Vulnerability to. | +| `resolvedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to resolved (defaults to creation time if status is `resolved`). | +| `scannerName` | [`String!`](#string) | Name of the security scanner used to discover the vulnerability. | +| `scannerType` | [`SecurityScannerType!`](#securityscannertype) | Type of the security scanner used to discover the vulnerability. | +| `severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability (defaults to `unknown`). | +| `solution` | [`String`](#string) | How to fix this vulnerability. | +| `state` | [`VulnerabilityState`](#vulnerabilitystate) | State of the vulnerability (defaults to `detected`). | +| `title` | [`String!`](#string) | Title of the vulnerability. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| `vulnerability` | [`Vulnerability`](#vulnerability) | Vulnerability created. | + ### `Mutation.vulnerabilityDismiss` Input type: `VulnerabilityDismissInput` @@ -13188,6 +13221,7 @@ Represents summary of a security report. | `coverageFuzzing` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `coverage_fuzzing` scan. | | `dast` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `dast` scan. | | `dependencyScanning` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `dependency_scanning` scan. | +| `generic` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `generic` scan. | | `sast` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `sast` scan. | | `secretDetection` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `secret_detection` scan. | @@ -14068,7 +14102,7 @@ Represents a vulnerability. | `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | | `primaryIdentifier` | [`VulnerabilityIdentifier`](#vulnerabilityidentifier) | Primary identifier of the vulnerability. | | `project` | [`Project`](#project) | The project on which the vulnerability was found. | -| `reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING, CLUSTER_IMAGE_SCANNING). `Scan Type` in the UI. | +| `reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING, CLUSTER_IMAGE_SCANNING, GENERIC). `Scan Type` in the UI. | | `resolvedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to resolved. | | `resolvedBy` | [`UserCore`](#usercore) | The user that resolved the vulnerability. | | `resolvedOnDefaultBranch` | [`Boolean!`](#boolean) | Indicates whether the vulnerability is fixed on the default branch or not. | @@ -15795,6 +15829,20 @@ Possible states of a user. | `private` | The snippet is visible only to the snippet creator. | | `public` | The snippet can be accessed without any authentication. | +### `VulnerabilityConfidence` + +Confidence that a given vulnerability is present in the codebase. + +| Value | Description | +| ----- | ----------- | +| `CONFIRMED` | | +| `EXPERIMENTAL` | | +| `HIGH` | | +| `IGNORE` | | +| `LOW` | | +| `MEDIUM` | | +| `UNKNOWN` | | + ### `VulnerabilityDismissalReason` The dismissal reason of the Vulnerability. @@ -15856,6 +15904,7 @@ The type of the security scan that found the vulnerability. | `COVERAGE_FUZZING` | | | `DAST` | | | `DEPENDENCY_SCANNING` | | +| `GENERIC` | | | `SAST` | | | `SECRET_DETECTION` | | @@ -17274,3 +17323,14 @@ A time-frame defined as a closed inclusive range of two dates. | `width` | [`Int`](#int) | Total width of the image. | | `x` | [`Int`](#int) | X position of the note. | | `y` | [`Int`](#int) | Y position of the note. | + +### `VulnerabilityIdentifierInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `externalId` | [`String`](#string) | External ID of the vulnerability identifier. | +| `externalType` | [`String`](#string) | External type of the vulnerability identifier. | +| `name` | [`String!`](#string) | Name of the vulnerability identifier. | +| `url` | [`String!`](#string) | URL of the vulnerability identifier. | -- cgit v1.2.3