diff options
Diffstat (limited to 'doc/api/graphql/reference/index.md')
| -rw-r--r-- | doc/api/graphql/reference/index.md | 280 |
1 files changed, 233 insertions, 47 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index f49a12568ed..c6ad2cb82c7 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -26,6 +26,150 @@ in [Removed Items](../removed_items.md). <!-- vale gitlab.Spelling = NO --> +## Queries + +Queries are used to get the resources, filter or query them. + +For more information, visit [Queries and Mutations](https://graphql.org/learn/queries/). + +### CiApplicationSettings + +CI related settings that apply to the entire instance. + +### CiConfig + +Get linted and processed contents of a CI config. Should not be requested more than once per request. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `content` | Contents of `.gitlab-ci.yml`. | String! | +| `dryRun` | Run pipeline creation simulation, or only do static check. | Boolean | +| `projectPath` | The project of the CI config. | ID! | + +### ContainerRepository + +Find a container repository. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `id` | The global ID of the container repository. | ContainerRepositoryID! | + +### CurrentUser + +Get information about current user. + +### DesignManagement + +Fields related to design management. + +### Echo + +Text to echo back. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `text` | Text to echo back. | String! | + +### GeoNode + +Find a Geo node. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `name` | The name of the Geo node. Defaults to the current Geo node name. | String | + +### Group + +Find a group. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! | + +### InstanceSecurityDashboard + +Fields related to Instance Security Dashboard. + +### Issue + +Find an Issue. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `id` | The global ID of the Issue. | IssueID! | + +### Iteration + +Find an iteration. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `id` | Find an iteration by its ID. | IterationID! | + +### Metadata + +Metadata about GitLab. + +### Milestone + +Find a milestone. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `id` | Find a milestone by its ID. | MilestoneID! | + +### Namespace + +Find a namespace. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! | + +### Package + +Find a package. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `id` | The global ID of the package. | PackagesPackageID! | + +### Project + +Find a project. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! | + +### RunnerSetup + +Get runner setup instructions. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `architecture` | Architecture to generate the instructions for. | String! | +| `groupId` | Group to register the runner for. | GroupID | +| `platform` | Platform to generate the instructions for. | String! | +| `projectId` | Project to register the runner for. | ProjectID | + +### User + +Find a user. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `id` | ID of the User. | UserID | +| `username` | Username of the User. | String | + +### Vulnerability + +Find a vulnerability. + +| Name | Description | Type | +| ----- | ---- | ----------- | +| `id` | The Global ID of the Vulnerability. | VulnerabilityID! | + ## Object types Object types represent the resources that the GitLab GraphQL API can return. @@ -130,6 +274,9 @@ An endpoint and credentials used to accept alerts for a project. | `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | | `id` | ID! | ID of the integration. | | `name` | String | Name of the integration. | +| `payloadAlertFields` | AlertManagementPayloadAlertField! => Array | Extract alert fields from payload example for custom mapping. | +| `payloadAttributeMappings` | AlertManagementPayloadAlertMappingField! => Array | The custom mapping of GitLab alert attributes to fields from the payload_example. | +| `payloadExample` | JsonString | The example of an alert payload. | | `token` | String | Token used to authenticate alert notification requests. | | `type` | AlertManagementIntegrationType! | Type of integration. | | `url` | String | Endpoint which accepts alert notifications. | @@ -144,6 +291,17 @@ Parsed field from an alert used for custom mappings. | `path` | String! => Array | Path to value inside payload JSON. | | `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. | +### AlertManagementPayloadAlertMappingField + +Parsed field (with its name) from an alert used for custom mappings. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `fieldName` | AlertManagementPayloadAlertFieldName | A GitLab alert field name. | +| `label` | String | Human-readable label of the payload path. | +| `path` | String! => Array | Path to value inside payload JSON. | +| `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. | + ### AlertManagementPrometheusIntegration An endpoint and credentials used to accept Prometheus alerts for a project. @@ -204,7 +362,7 @@ Autogenerated return type of ApiFuzzingCiConfigurationCreate. ### ApiFuzzingScanProfile -An API Fuzzing scan profile.. +An API Fuzzing scan profile. | Field | Type | Description | | ----- | ---- | ----------- | @@ -280,7 +438,7 @@ Autogenerated return type of AwardEmojiToggle. ### Board -Represents a project or group board. +Represents a project or group issue board. | Field | Type | Description | | ----- | ---- | ----------- | @@ -559,6 +717,7 @@ Autogenerated return type of ClusterAgentDelete. | `clusterAgent` | ClusterAgent | Cluster agent this token is associated with. | | `createdAt` | Time | Timestamp the token was created. | | `createdByUser` | User | The user who created the token. | +| `description` | String | Description of the token. | | `id` | ClustersAgentTokenID! | Global ID of the token. | ### ClusterAgentTokenCreatePayload @@ -643,7 +802,7 @@ Represents a ComplianceFramework associated with a Project. | `description` | String! | Description of the compliance framework. | | `id` | ID! | Compliance framework ID. | | `name` | String! | Name of the compliance framework. | -| `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hippa`. | +| `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. | ### ComposerMetadata @@ -1539,9 +1698,13 @@ Represents an epic board. | Field | Type | Description | | ----- | ---- | ----------- | -| `id` | BoardsEpicBoardID! | Global ID of the board. | +| `hideBacklogList` | Boolean | Whether or not backlog list is hidden. | +| `hideClosedList` | Boolean | Whether or not closed list is hidden. | +| `id` | BoardsEpicBoardID! | Global ID of the epic board. | | `lists` | EpicListConnection | Epic board lists. | -| `name` | String | Name of the board. | +| `name` | String | Name of the epic board. | +| `webPath` | String! | Web path of the epic board. | +| `webUrl` | String! | Web URL of the epic board. | ### EpicBoardCreatePayload @@ -1955,7 +2118,7 @@ Describes an incident management on-call schedule. ### IncidentManagementOncallShift -A block of time for which a participant is on-call.. +A block of time for which a participant is on-call. | Field | Type | Description | | ----- | ---- | ----------- | @@ -1972,16 +2135,6 @@ A block of time for which a participant is on-call.. | `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. | | `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard. | -### InstanceStatisticsMeasurement - -Represents a recorded measurement (object count) for the Admins. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | Int! | Object count. | -| `identifier` | MeasurementIdentifier! | The type of objects being measured. | -| `recordedAt` | Time | The time the measurement was recorded. | - ### Issue | Field | Type | Description | @@ -2262,11 +2415,13 @@ Autogenerated return type of JiraImportUsers. | Field | Type | Description | | ----- | ---- | ----------- | | `color` | String! | Background color of the label. | +| `createdAt` | Time! | When this label was created. | | `description` | String | Description of the label (Markdown rendered as HTML for caching). | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `id` | ID! | Label ID. | | `textColor` | String! | Text color of the label. | | `title` | String! | Content of the label. | +| `updatedAt` | Time! | When this label was last updated. | ### LabelCreatePayload @@ -2780,7 +2935,7 @@ Represents a version of a package in the Package Registry. ### PageInfo -Information about pagination in a connection.. +Information about pagination in a connection. | Field | Type | Description | | ----- | ---- | ----------- | @@ -2810,6 +2965,7 @@ Information about pagination in a connection.. | `path` | String | Relative path to the pipeline's page. | | `project` | Project | Project the pipeline belongs to. | | `retryable` | Boolean! | Specifies if a pipeline can be retried. | +| `securityReportFindings` | PipelineSecurityReportFindingConnection | Vulnerability findings reported on the pipeline. | | `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline. | | `sha` | String! | SHA of the pipeline's commit. | | `sourceJob` | CiJob | Job where pipeline was triggered from. | @@ -2874,6 +3030,25 @@ Autogenerated return type of PipelineRetry. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipeline` | Pipeline | The pipeline after mutation. | +### PipelineSecurityReportFinding + +Represents vulnerability finding of a security report on the pipeline. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `confidence` | String | Type of the security report that found the vulnerability. | +| `description` | String | Description of the vulnerability finding. | +| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerabilit finding. | +| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. | +| `name` | String | Name of the vulnerability finding. | +| `project` | Project | The project on which the vulnerability finding was found. | +| `projectFingerprint` | String | Name of the vulnerability finding. | +| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability finding. | +| `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. | +| `severity` | VulnerabilitySeverity | Severity of the vulnerability finding. | +| `solution` | String | URL to the vulnerability's details page. | +| `uuid` | String | Name of the vulnerability finding. | + ### Project | Field | Type | Description | @@ -2882,6 +3057,7 @@ Autogenerated return type of PipelineRetry. | `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project. | | `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project. | | `alertManagementAlerts` | AlertManagementAlertConnection | Alert Management alerts of the project. | +| `alertManagementHttpIntegrations` | AlertManagementHttpIntegrationConnection | HTTP Integrations which can receive alerts for the project. | | `alertManagementIntegrations` | AlertManagementIntegrationConnection | Integrations which can receive alerts for the project. | | `alertManagementPayloadFields` | AlertManagementPayloadAlertField! => Array | Extract alert fields from payload for custom mapping. | | `allowMergeOnSkippedPipeline` | Boolean | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs. | @@ -4053,6 +4229,16 @@ Autogenerated return type of UpdateSnippet. | `spam` | Boolean | Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response. | | `spamLogId` | Int | The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | +### UsageTrendsMeasurement + +Represents a recorded measurement (object count) for the Admins. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `count` | Int! | Object count. | +| `identifier` | MeasurementIdentifier! | The type of objects being measured. | +| `recordedAt` | Time | The time the measurement was recorded. | + ### User | Field | Type | Description | @@ -4172,9 +4358,9 @@ Represents the vulnerability details base. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | ### VulnerabilityDetailBoolean @@ -4182,9 +4368,9 @@ Represents the vulnerability details boolean value. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | Boolean! | Value of the field. | ### VulnerabilityDetailCode @@ -4193,10 +4379,10 @@ Represents the vulnerability details code field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `lang` | String | Language of the code. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | String! | Source code. | ### VulnerabilityDetailCommit @@ -4205,9 +4391,9 @@ Represents the vulnerability details commit field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | String! | The commit SHA value. | ### VulnerabilityDetailDiff @@ -4218,9 +4404,9 @@ Represents the vulnerability details diff field. | ----- | ---- | ----------- | | `after` | String! | Value of the field after the change. | | `before` | String! | Value of the field before the change. | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | ### VulnerabilityDetailFileLocation @@ -4228,12 +4414,12 @@ Represents the vulnerability details location within a file in the project. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `fileName` | String! | File name. | | `lineEnd` | Int! | End line number of the file location. | | `lineStart` | Int! | Start line number of the file location. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | ### VulnerabilityDetailInt @@ -4241,9 +4427,9 @@ Represents the vulnerability details integer value. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | Int! | Value of the field. | ### VulnerabilityDetailList @@ -4252,10 +4438,10 @@ Represents the vulnerability details list value. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `items` | VulnerabilityDetail! => Array | List of details. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | ### VulnerabilityDetailMarkdown @@ -4263,9 +4449,9 @@ Represents the vulnerability details Markdown field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | String! | Value of the Markdown field. | ### VulnerabilityDetailModuleLocation @@ -4274,10 +4460,10 @@ Represents the vulnerability details location within a file in the project. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `moduleName` | String! | Module name. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `offset` | Int! | Offset of the module location. | ### VulnerabilityDetailTable @@ -4286,10 +4472,10 @@ Represents the vulnerability details table value. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `headers` | VulnerabilityDetail! => Array | Table headers. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `rows` | VulnerabilityDetail! => Array | Table rows. | ### VulnerabilityDetailText @@ -4298,9 +4484,9 @@ Represents the vulnerability details text field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | String! | Value of the text field. | ### VulnerabilityDetailUrl @@ -4309,10 +4495,10 @@ Represents the vulnerability details URL field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `href` | String! | Href of the URL. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `text` | String | Text of the URL. | ### VulnerabilityDismissPayload @@ -5116,7 +5302,7 @@ Possible identifier types for a measurement. ### MergeRequestNewState -New state to apply to a merge request.. +New state to apply to a merge request. | Value | Description | | ----- | ----------- | @@ -5309,9 +5495,9 @@ Size of UI component in SAST configuration page. | Value | Description | | ----- | ----------- | -| `LARGE` | | -| `MEDIUM` | | -| `SMALL` | | +| `LARGE` | The size of UI component in SAST configuration page is large. | +| `MEDIUM` | The size of UI component in SAST configuration page is medium. | +| `SMALL` | The size of UI component in SAST configuration page is small. | ### SecurityReportTypeEnum |