diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-05-19 15:44:42 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-05-19 15:44:42 +0000 |
| commit | 4555e1b21c365ed8303ffb7a3325d773c9b8bf31 (patch) | |
| tree | 5423a1c7516cffe36384133ade12572cf709398d /doc/api | |
| parent | e570267f2f6b326480d284e0164a6464ba4081bc (diff) | |
| download | gitlab-ce-4555e1b21c365ed8303ffb7a3325d773c9b8bf31.tar.gz | |
Add latest changes from gitlab-org/gitlab@13-12-stable-eev13.12.0-rc42
Diffstat (limited to 'doc/api')
78 files changed, 14239 insertions, 6779 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 1a914fb1dbe..db0c593dc03 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -1,10 +1,10 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# API Docs +# API Docs **(FREE)** Use the GitLab [REST](http://spec.openapis.org/oas/v3.0.3) API to automate GitLab. @@ -125,9 +125,10 @@ There are several ways you can authenticate with the GitLab API: - [Session cookie](#session-cookie) - [GitLab CI/CD job token](#gitlab-cicd-job-token) **(Specific endpoints only)** -NOTE: -Project access tokens are supported for self-managed instances on Free and -higher. They're also supported on GitLab.com Bronze and higher. +Project access tokens are supported by: + +- Self-managed GitLab Free and higher. +- GitLab SaaS Premium and higher. If you are an administrator, you or your application can authenticate as a specific user. To do so, use: @@ -208,6 +209,7 @@ You can use a GitLab CI/CD job token to authenticate with specific API endpoints Package Registry, you can use [deploy tokens](../user/project/deploy_tokens/index.md). - [Container Registry](../user/packages/container_registry/index.md) (the `$CI_REGISTRY_PASSWORD` is `$CI_JOB_TOKEN`). + - [Container Registry API](container_registry.md) (scoped to the job's project, when the `ci_job_token_scope` feature flag is enabled) - [Get job artifacts](job_artifacts.md#get-job-artifacts). - [Get job token's job](jobs.md#get-job-tokens-job). - [Pipeline triggers](pipeline_triggers.md), using the `token=` parameter. @@ -776,7 +778,3 @@ some API endpoints also support `text/plain`. In [GitLab 13.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/250342), API endpoints do not support `text/plain` by default, unless it's explicitly documented. - -This change is deployed behind the `:api_always_use_application_json` [feature flag](../user/feature_flags.md), -enabled by default. On GitLab self-managed instances, GitLab administrators can choose -to [disable it](../administration/feature_flags.md). **(FREE SELF)** diff --git a/doc/api/admin_sidekiq_queues.md b/doc/api/admin_sidekiq_queues.md index 9cbdcb863d6..d0e310ab548 100644 --- a/doc/api/admin_sidekiq_queues.md +++ b/doc/api/admin_sidekiq_queues.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Enablement +group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/api_resources.md b/doc/api/api_resources.md index b0d03ebad74..9200d47effe 100644 --- a/doc/api/api_resources.md +++ b/doc/api/api_resources.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/applications.md b/doc/api/applications.md index b3741a3cb30..b3a46b70c9e 100644 --- a/doc/api/applications.md +++ b/doc/api/applications.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/avatar.md b/doc/api/avatar.md index 5d50fac86f0..baa670f3e93 100644 --- a/doc/api/avatar.md +++ b/doc/api/avatar.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index 04b2727f575..de56405056a 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Growth +group: Activation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/commits.md b/doc/api/commits.md index 117f949aba0..22d98b2b0a6 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -316,7 +316,6 @@ Example response: { "id": "8b090c1b79a14f2bd9e8a738f717824ff53aebad", "short_id": "8b090c1b", - "title": "Feature added", "author_name": "Example User", "author_email": "user@example.com", "authored_date": "2016-12-12T20:10:39.000+01:00", diff --git a/doc/api/container_registry.md b/doc/api/container_registry.md index f29f8aaf6e9..0b37c0ad91a 100644 --- a/doc/api/container_registry.md +++ b/doc/api/container_registry.md @@ -6,10 +6,30 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Container Registry API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/55978) in GitLab 11.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/55978) in GitLab 11.8. +> - The use of `CI_JOB_TOKEN` scoped to the current project was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49750) in GitLab 13.12. This is the API documentation of the [GitLab Container Registry](../user/packages/container_registry/index.md). +When the `ci_job_token_scope` feature flag is enabled (it is **disabled by default**), you can use the below endpoints +from a CI/CD job, by passing the `$CI_JOB_TOKEN` variable as the `JOB-TOKEN` header. +The job token will only have access to its own project. + +[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md) +can opt to enable it. + +To enable it: + +```ruby +Feature.enable(:ci_job_token_scope) +``` + +To disable it: + +```ruby +Feature.disable(:ci_job_token_scope) +``` + ## List registry repositories ### Within a project diff --git a/doc/api/custom_attributes.md b/doc/api/custom_attributes.md index 68d27b77998..a17b3b78b18 100644 --- a/doc/api/custom_attributes.md +++ b/doc/api/custom_attributes.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/dependencies.md b/doc/api/dependencies.md index 6beb57a6da0..6175c26ed75 100644 --- a/doc/api/dependencies.md +++ b/doc/api/dependencies.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Secure +group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md index eae46d5f2f5..ad144946445 100644 --- a/doc/api/deploy_tokens.md +++ b/doc/api/deploy_tokens.md @@ -16,6 +16,12 @@ Get a list of all deploy tokens across the GitLab instance. This endpoint requir GET /deploy_tokens ``` +Parameters: + +| Attribute | Type | Required | Description | +|-----------|----------|------------------------|-------------| +| `active` | boolean | **{dotted-circle}** No | Limit by active status. | + Example request: ```shell @@ -31,6 +37,8 @@ Example response: "name": "MyToken", "username": "gitlab+deploy-token-1", "expires_at": "2020-02-14T00:00:00.000Z", + "revoked": false, + "expired": false, "scopes": [ "read_repository", "read_registry" @@ -55,9 +63,10 @@ GET /projects/:id/deploy_tokens Parameters: -| Attribute | Type | Required | Description | -|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| Attribute | Type | Required | Description | +|:---------------|:---------------|:-----------------------|:------------| +| `id` | integer/string | **{check-circle}** Yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `active` | boolean | **{dotted-circle}** No | Limit by active status. | Example request: @@ -74,6 +83,8 @@ Example response: "name": "MyToken", "username": "gitlab+deploy-token-1", "expires_at": "2020-02-14T00:00:00.000Z", + "revoked": false, + "expired": false, "scopes": [ "read_repository", "read_registry" @@ -92,13 +103,17 @@ Creates a new deploy token for a project. POST /projects/:id/deploy_tokens ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `name` | string | yes | New deploy token's name | -| `expires_at` | datetime | no | Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `username` | string | no | Username for deploy token. Default is `gitlab+deploy-token-{n}` | -| `scopes` | array of strings | yes | Indicates the deploy token scopes. Must be at least one of `read_repository`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`. | +Parameters: + +| Attribute | Type | Required | Description | +| ------------ | ---------------- | ---------------------- | ----------- | +| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `name` | string | **{check-circle}** Yes | New deploy token's name | +| `expires_at` | datetime | **{dotted-circle}** No | Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | +| `username` | string | **{dotted-circle}** No | Username for deploy token. Default is `gitlab+deploy-token-{n}` | +| `scopes` | array of strings | **{check-circle}** Yes | Indicates the deploy token scopes. Must be at least one of `read_repository`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`. | + +Example request: ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{"name": "My deploy token", "expires_at": "2021-01-01", "username": "custom-user", "scopes": ["read_repository"]}' "https://gitlab.example.com/api/v4/projects/5/deploy_tokens/" @@ -113,6 +128,8 @@ Example response: "username": "custom-user", "expires_at": "2021-01-01T00:00:00.000Z", "token": "jMRvtPNxrn3crTAGukpZ", + "revoked": false, + "expired": false, "scopes": [ "read_repository" ] @@ -129,10 +146,12 @@ Removes a deploy token from the project. DELETE /projects/:id/deploy_tokens/:token_id ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `token_id` | integer | yes | The ID of the deploy token | +Parameters: + +| Attribute | Type | Required | Description | +| ---------- | -------------- | ---------------------- | ----------- | +| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `token_id` | integer | **{check-circle}** Yes | The ID of the deploy token | Example request: @@ -157,9 +176,10 @@ GET /groups/:id/deploy_tokens Parameters: -| Attribute | Type | Required | Description | -|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| Attribute | Type | Required | Description | +|:---------------|:---------------|:-----------------------|:------------| +| `id` | integer/string | **{check-circle}** Yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `active` | boolean | **{dotted-circle}** No | Limit by active status. | Example request: @@ -176,6 +196,8 @@ Example response: "name": "MyToken", "username": "gitlab+deploy-token-1", "expires_at": "2020-02-14T00:00:00.000Z", + "revoked": false, + "expired": false, "scopes": [ "read_repository", "read_registry" @@ -194,13 +216,15 @@ Creates a new deploy token for a group. POST /groups/:id/deploy_tokens ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | -| `name` | string | yes | New deploy token's name | -| `expires_at` | datetime | no | Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `username` | string | no | Username for deploy token. Default is `gitlab+deploy-token-{n}` | -| `scopes` | array of strings | yes | Indicates the deploy token scopes. Must be at least one of `read_repository`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`. | +Parameters: + +| Attribute | Type | Required | Description | +| ------------ | ---- | --------- | ----------- | +| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `name` | string | **{check-circle}** Yes | New deploy token's name | +| `expires_at` | datetime | **{dotted-circle}** No | Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | +| `username` | string | **{dotted-circle}** No | Username for deploy token. Default is `gitlab+deploy-token-{n}` | +| `scopes` | array of strings | **{check-circle}** Yes | Indicates the deploy token scopes. Must be at least one of `read_repository`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`. | Example request: @@ -217,6 +241,8 @@ Example response: "username": "custom-user", "expires_at": "2021-01-01T00:00:00.000Z", "token": "jMRvtPNxrn3crTAGukpZ", + "revoked": false, + "expired": false, "scopes": [ "read_registry" ] @@ -233,10 +259,12 @@ Removes a deploy token from the group. DELETE /groups/:id/deploy_tokens/:token_id ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `token_id` | integer | yes | The ID of the deploy token | +Parameters: + +| Attribute | Type | Required | Description | +| ----------- | -------------- | ---------------------- | ----------- | +| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `token_id` | integer | **{check-circle}** Yes | The ID of the deploy token | Example request: diff --git a/doc/api/deployments.md b/doc/api/deployments.md index 32d3ab55f9f..cf224ad60ab 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -266,7 +266,7 @@ Example of response "status": "success", "updated_at": "2016-08-11T07:43:52.143Z", "web_url": "http://gitlab.dev/root/project/pipelines/5" - } + }, "runner": null } } diff --git a/doc/api/discussions.md b/doc/api/discussions.md index 828370c3386..3d40349ecca 100644 --- a/doc/api/discussions.md +++ b/doc/api/discussions.md @@ -270,7 +270,7 @@ GET /projects/:id/snippets/:snippet_id/discussions "system": false, "noteable_id": 3, "noteable_type": "Snippet", - "noteable_id": null + "noteable_iid": null }, { "id": 1129, @@ -290,7 +290,7 @@ GET /projects/:id/snippets/:snippet_id/discussions "system": false, "noteable_id": 3, "noteable_type": "Snippet", - "noteable_id": null, + "noteable_iid": null, "resolvable": false } ] @@ -317,7 +317,7 @@ GET /projects/:id/snippets/:snippet_id/discussions "system": false, "noteable_id": 3, "noteable_type": "Snippet", - "noteable_id": null, + "noteable_iid": null, "resolvable": false } ] @@ -476,7 +476,7 @@ GET /groups/:id/epics/:epic_id/discussions "system": false, "noteable_id": 3, "noteable_type": "Epic", - "noteable_id": null, + "noteable_iid": null, "resolvable": false }, { @@ -497,7 +497,7 @@ GET /groups/:id/epics/:epic_id/discussions "system": false, "noteable_id": 3, "noteable_type": "Epic", - "noteable_id": null, + "noteable_iid": null, "resolvable": false } ] @@ -524,7 +524,7 @@ GET /groups/:id/epics/:epic_id/discussions "system": false, "noteable_id": 3, "noteable_type": "Epic", - "noteable_id": null, + "noteable_iid": null, "resolvable": false } ] @@ -757,7 +757,7 @@ Diff comments also contain position: "notes": [ { "id": 1128, - "type": DiffNote, + "type": "DiffNote", "body": "diff comment", "attachment": null, "author": { @@ -787,12 +787,12 @@ Diff comments also contain position: "line_range": { "start": { "line_code": "588440f66559714280628a4f9799f0c4eb880a4a_10_10", - "type": "new", + "type": "new" }, "end": { "line_code": "588440f66559714280628a4f9799f0c4eb880a4a_11_11", "type": "old" - }, + } } }, "resolved": false, @@ -853,9 +853,9 @@ Parameters for all comments: | `position[start_sha]` | string | yes | SHA referencing commit in target branch | | `position[head_sha]` | string | yes | SHA referencing HEAD of this merge request | | `position[position_type]` | string | yes | Type of the position reference', allowed values: `text` or `image` | -| `position[new_path]` | string | no | File path after change | +| `position[new_path]` | string | yes (if the position type is `text`) | File path after change | | `position[new_line]` | integer | no | Line number after change (for `text` diff notes) | -| `position[old_path]` | string | no | File path before change | +| `position[old_path]` | string | yes (if the position type is `text`) | File path before change | | `position[old_line]` | integer | no | Line number before change (for `text` diff notes) | | `position[line_range]` | hash | no | Line range for a multi-line diff note | | `position[width]` | integer | no | Width of the image (for `image` diff notes) | @@ -863,10 +863,63 @@ Parameters for all comments: | `position[x]` | float | no | X coordinate (for `image` diff notes) | | `position[y]` | float | no | Y coordinate (for `image` diff notes) | +#### Create a new thread on the overview page + ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions?body=comment" ``` +#### Create a new thread in the merge request diff + +- Both `position[old_path]` and `position[new_path]` are required and must refer to the file path before and after the change. +- To create a thread on an added line (highlighted in green in the merge request diff), use `position[new_line]` and don't include `position[old_line]`. +- To create a thread on a removed line (highlighted in red in the merge request diff), use `position[old_line]` and don't include `position[new_line]`. +- To create a thread on an unchanged line, include both `position[new_line]` and `position[old_line]` for the line. These positions might not be the same if earlier changes in the file changed the line number. This is a bug that we plan to fix in [GraphQL `createDiffNote` forces clients to compute redundant information (#325161)](https://gitlab.com/gitlab-org/gitlab/-/issues/325161). +- If you specify incorrect `base`/`head`/`start` `SHA` parameters, you might run into the following bug: [Merge request comments receive "download" link instead of inline code (#296829)](https://gitlab.com/gitlab-org/gitlab/-/issues/296829). + +To create a new thread: + +1. [Get the latest merge request version](merge_requests.md#get-mr-diff-versions): + + ```shell + curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/versions" + ```` + +1. Note the details of the latest version, which is listed first in the response array. + + ```json + [ + { + "id": 164560414, + "head_commit_sha": "f9ce7e16e56c162edbc9e480108041cf6b0291fe", + "base_commit_sha": "5e6dffa282c5129aa67cd227a0429be21bfdaf80", + "start_commit_sha": "5e6dffa282c5129aa67cd227a0429be21bfdaf80", + "created_at": "2021-03-30T09:18:27.351Z", + "merge_request_id": 93958054, + "state": "collected", + "real_size": "2" + }, + "previous versions are here" + ] + ``` + +1. Create a new diff thread. This example creates a thread on an added line: + + ```shell + curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\ + --form 'position[position_type]=text'\ + --form 'position[base_sha]=<use base_commit_sha from the versions response>'\ + --form 'position[head_sha]=<use head_commit_sha from the versions response>'\ + --form 'position[start_sha]=<use start_commit_sha from the versions response>'\ + --form 'position[new_path]=file.js'\ + --form 'position[old_path]=file.js'\ + --form 'position[new_line]=18'\ + --form 'body=test comment body'\ + "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions" + ``` + +#### Parameters for multiline comments + Parameters for multiline comments only: | Attribute | Type | Required | Description | @@ -1089,7 +1142,7 @@ Diff comments contain also position: "notes": [ { "id": 1128, - "type": DiffNote, + "type": "DiffNote", "body": "diff comment", "attachment": null, "author": { diff --git a/doc/api/dora4_group_analytics.md b/doc/api/dora4_group_analytics.md index 8935fa1e121..743dcf728a2 100644 --- a/doc/api/dora4_group_analytics.md +++ b/doc/api/dora4_group_analytics.md @@ -1,87 +1,8 @@ --- -stage: Release -group: Release -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments -type: reference, api +redirect_to: 'dora/metrics.md' --- -# DORA4 Analytics Group API **(ULTIMATE SELF)** +This document was moved to [another location](dora/metrics.md). -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291747) in GitLab 13.9. -> - [Deployed behind a feature flag](../user/feature_flags.md), disabled by default. -> - Disabled on GitLab.com. -> - Not recommended for production use. -> - To use in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-dora4-analytics-group-api). - -WARNING: -These endpoints are deprecated and will be removed in GitLab 14.0. Use the [DORA metrics API](dora/metrics.md) instead. - -WARNING: -This feature might not be available to you. Check the **version history** note above for details. - -All methods require reporter authorization. - -## List group deployment frequencies - -Get a list of all group deployment frequencies: - -```plaintext -GET /groups/:id/analytics/deployment_frequency?environment=:environment&from=:from&to=:to&interval=:interval -``` - -Attributes: - -| Attribute | Type | Required | Description | -|--------------|--------|----------|-----------------------| -| `id` | string | yes | The ID of the group. | - -Parameters: - -| Parameter | Type | Required | Description | -|--------------|--------|----------|-----------------------| -| `environment`| string | yes | The name of the environment to filter by. | -| `from` | string | yes | Datetime range to start from. Inclusive, ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). | -| `to` | string | no | Datetime range to end at. Exclusive, ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). | -| `interval` | string | no | The bucketing interval (`all`, `monthly`, `daily`). | - -Example request: - -```shell -curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/analytics/deployment_frequency?environment=:environment&from=:from&to=:to&interval=:interval" -``` - -Example response: - -```json -[ - { - "from": "2017-01-01", - "to": "2017-01-02", - "value": 106 - }, - { - "from": "2017-01-02", - "to": "2017-01-03", - "value": 55 - } -] -``` - -## Enable or disable DORA4 Analytics Group API **(ULTIMATE SELF)** - -DORA4 Analytics Group API is under development and not ready for production use. It is -deployed behind a feature flag that is **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md) -can enable it. - -To enable it: - -```ruby -Feature.enable(:dora4_group_deployment_frequency_api) -``` - -To disable it: - -```ruby -Feature.disable(:dora4_group_deployment_frequency_api) -``` +<!-- This redirect file can be deleted after <2021-07-25>. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/api/epic_issues.md b/doc/api/epic_issues.md index c4a8e2d40cc..3644375ad0a 100644 --- a/doc/api/epic_issues.md +++ b/doc/api/epic_issues.md @@ -107,7 +107,6 @@ Example response: "award_emoji": "http://localhost:3001/api/v4/projects/8/issues/6/award_emoji", "project": "http://localhost:3001/api/v4/projects/8" }, - "subscribed": true, "epic_issue_id": 2 } ] diff --git a/doc/api/epic_links.md b/doc/api/epic_links.md index 228f68531fd..e570b9f31cf 100644 --- a/doc/api/epic_links.md +++ b/doc/api/epic_links.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9188) in GitLab 11.8. -Manages parent-child [epic relationships](../user/group/epics/index.md#multi-level-child-epics). +Manages parent-child [epic relationships](../user/group/epics/manage_epics.md#multi-level-child-epics). Every API call to `epic_links` must be authenticated. @@ -97,7 +97,7 @@ Example response: "id": 6, "iid": 38, "group_id": 1, - "parent_id": 5 + "parent_id": 5, "title": "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est.", "description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.", "author": { diff --git a/doc/api/events.md b/doc/api/events.md index 38d2c934061..49d99cc43fe 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -1,10 +1,10 @@ --- -stage: none -group: unassigned +stage: Manage +group: Compliance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Events +# Events API ## Filter parameters @@ -71,10 +71,10 @@ Parameters: | --------- | ---- | -------- | ----------- | | `action` | string | no | Include only events of a particular [action type](#action-types) | | `target_type` | string | no | Include only events of a particular [target type](#target-types) | -| `before` | date | no | Include only events created before a particular date. Please see [here for the supported format](#date-formatting) | -| `after` | date | no | Include only events created after a particular date. Please see [here for the supported format](#date-formatting) | +| `before` | date | no | Include only events created before a particular date. [View how to format dates](#date-formatting). | +| `after` | date | no | Include only events created after a particular date. [View how to format dates](#date-formatting). | | `scope` | string | no | Include all events across a user's projects. | -| `sort` | string | no | Sort events in `asc` or `desc` order by `created_at`. Default is `desc` | +| `sort` | string | no | Sort events in `asc` or `desc` order by `created_at`. Default is `desc`. | Example request: @@ -148,9 +148,9 @@ Parameters: | `id` | integer | yes | The ID or Username of the user | | `action` | string | no | Include only events of a particular [action type](#action-types) | | `target_type` | string | no | Include only events of a particular [target type](#target-types) | -| `before` | date | no | Include only events created before a particular date. Please see [here for the supported format](#date-formatting) | -| `after` | date | no | Include only events created after a particular date. Please see [here for the supported format](#date-formatting) | -| `sort` | string | no | Sort events in `asc` or `desc` order by `created_at`. Default is `desc` | +| `before` | date | no | Include only events created before a particular date. [View how to format dates](#date-formatting). | +| `after` | date | no | Include only events created after a particular date. [View how to format dates](#date-formatting). | +| `sort` | string | no | Sort events in `asc` or `desc` order by `created_at`. Default is `desc`. | | `page` | integer | no | The page of results to return. Defaults to 1. | | `per_page` | integer | no | The number of results per page. Defaults to 20. | @@ -286,9 +286,9 @@ Parameters: | `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `action` | string | no | Include only events of a particular [action type](#action-types) | | `target_type` | string | no | Include only events of a particular [target type](#target-types) | -| `before` | date | no | Include only events created before a particular date. Please see [here for the supported format](#date-formatting) | -| `after` | date | no | Include only events created after a particular date. Please see [here for the supported format](#date-formatting) | -| `sort` | string | no | Sort events in `asc` or `desc` order by `created_at`. Default is `desc` | +| `before` | date | no | Include only events created before a particular date. [View how to format dates](#date-formatting). | +| `after` | date | no | Include only events created after a particular date. [View how to format dates](#date-formatting). | +| `sort` | string | no | Sort events in `asc` or `desc` order by `created_at`. Default is `desc`. | Example request: @@ -301,7 +301,7 @@ Example response: ```json [ { - "id": 8 + "id": 8, "title":null, "project_id":1, "action_name":"opened", diff --git a/doc/api/feature_flag_user_lists.md b/doc/api/feature_flag_user_lists.md index e0a5fe99663..af8b3fcc71e 100644 --- a/doc/api/feature_flag_user_lists.md +++ b/doc/api/feature_flag_user_lists.md @@ -126,7 +126,7 @@ Example response: "iid": 1, "project_id": 1, "created_at": "2020-02-04T08:13:10.507Z", - "updated_at": "2020-02-04T08:13:10.507Z", + "updated_at": "2020-02-04T08:13:10.507Z" } ``` diff --git a/doc/api/feature_flags.md b/doc/api/feature_flags.md index fa5481b12a7..50cb9b1141e 100644 --- a/doc/api/feature_flags.md +++ b/doc/api/feature_flags.md @@ -70,7 +70,7 @@ Example response: "version": "new_version_flag", "created_at":"2019-11-04T08:13:10.507Z", "updated_at":"2019-11-04T08:13:10.507Z", - "scopes":[] + "scopes":[], "strategies": [ { "id": 2, diff --git a/doc/api/geo_nodes.md b/doc/api/geo_nodes.md index 38f11d8dfe2..7926aeeeed7 100644 --- a/doc/api/geo_nodes.md +++ b/doc/api/geo_nodes.md @@ -362,9 +362,6 @@ Example response: "wikis_checksum_mismatch_count": 1, "repositories_retrying_verification_count": 1, "wikis_retrying_verification_count": 3, - "repositories_checked_count": 7, - "repositories_checked_failed_count": 2, - "repositories_checked_in_percentage": "17.07%", "last_event_id": 23, "last_event_timestamp": 1509681166, "cursor_last_event_id": null, diff --git a/doc/api/graphql/audit_report.md b/doc/api/graphql/audit_report.md index 74ac8710160..a68af6e8646 100644 --- a/doc/api/graphql/audit_report.md +++ b/doc/api/graphql/audit_report.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/graphql/getting_started.md b/doc/api/graphql/getting_started.md index fe92b17a121..b48ce48f6c3 100644 --- a/doc/api/graphql/getting_started.md +++ b/doc/api/graphql/getting_started.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/graphql/index.md b/doc/api/graphql/index.md index ace41e0e92d..5864e5878b7 100644 --- a/doc/api/graphql/index.md +++ b/doc/api/graphql/index.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index e353346b0b1..7f496e1aded 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -24,19 +24,21 @@ Fields that are deprecated are marked with **{warning-solid}**. Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-and-removal-process) can be found in [Removed Items](../removed_items.md). -<!-- vale gitlab.Spelling = NO --> +<!-- vale off --> +<!-- Docs linting disabled after this line. --> +<!-- See https://docs.gitlab.com/ee/development/documentation/testing.html#disable-vale-tests --> ## `Query` type The `Query` type contains the API's top-level entry points for all executable queries. -### `ciApplicationSettings` +### `Query.ciApplicationSettings` CI related settings that apply to the entire instance. Returns [`CiApplicationSettings`](#ciapplicationsettings). -### `ciConfig` +### `Query.ciConfig` Linted and processed contents of a CI config. Should not be requested more than once per request. @@ -47,11 +49,11 @@ Returns [`CiConfig`](#ciconfig). | Name | Type | Description | | ---- | ---- | ----------- | -| `content` | [`String!`](#string) | Contents of `.gitlab-ci.yml`. | -| `dryRun` | [`Boolean`](#boolean) | Run pipeline creation simulation, or only do static check. | -| `projectPath` | [`ID!`](#id) | The project of the CI config. | +| <a id="queryciconfigcontent"></a>`content` | [`String!`](#string) | Contents of `.gitlab-ci.yml`. | +| <a id="queryciconfigdryrun"></a>`dryRun` | [`Boolean`](#boolean) | Run pipeline creation simulation, or only do static check. | +| <a id="queryciconfigprojectpath"></a>`projectPath` | [`ID!`](#id) | The project of the CI config. | -### `containerRepository` +### `Query.containerRepository` Find a container repository. @@ -61,44 +63,44 @@ Returns [`ContainerRepositoryDetails`](#containerrepositorydetails). | Name | Type | Description | | ---- | ---- | ----------- | -| `id` | [`ContainerRepositoryID!`](#containerrepositoryid) | The global ID of the container repository. | +| <a id="querycontainerrepositoryid"></a>`id` | [`ContainerRepositoryID!`](#containerrepositoryid) | The global ID of the container repository. | -### `currentLicense` +### `Query.currentLicense` Fields related to the current license. Returns [`CurrentLicense`](#currentlicense). -### `currentUser` +### `Query.currentUser` Get information about current user. -Returns [`User`](#user). +Returns [`UserCore`](#usercore). -### `designManagement` +### `Query.designManagement` Fields related to design management. Returns [`DesignManagement!`](#designmanagement). -### `devopsAdoptionSegments` +### `Query.devopsAdoptionSegments` -Get configured DevOps adoption segments on the instance. +Get configured DevOps adoption segments on the instance. **BETA** This endpoint is subject to change without notice. Returns [`DevopsAdoptionSegmentConnection`](#devopsadoptionsegmentconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `directDescendantsOnly` | [`Boolean`](#boolean) | Limits segments to direct descendants of specified parent. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `parentNamespaceId` | [`NamespaceID`](#namespaceid) | Filter by ancestor namespace. | +| <a id="querydevopsadoptionsegmentsdirectdescendantsonly"></a>`directDescendantsOnly` | [`Boolean`](#boolean) | Limits segments to direct descendants of specified parent. | +| <a id="querydevopsadoptionsegmentsparentnamespaceid"></a>`parentNamespaceId` | [`NamespaceID`](#namespaceid) | Filter by ancestor namespace. | -### `echo` +### `Query.echo` Testing endpoint to validate the API with. @@ -108,9 +110,9 @@ Returns [`String!`](#string). | Name | Type | Description | | ---- | ---- | ----------- | -| `text` | [`String!`](#string) | Text to echo back. | +| <a id="queryechotext"></a>`text` | [`String!`](#string) | Text to echo back. | -### `geoNode` +### `Query.geoNode` Find a Geo node. @@ -120,9 +122,9 @@ Returns [`GeoNode`](#geonode). | Name | Type | Description | | ---- | ---- | ----------- | -| `name` | [`String`](#string) | The name of the Geo node. Defaults to the current Geo node name. | +| <a id="querygeonodename"></a>`name` | [`String`](#string) | The name of the Geo node. Defaults to the current Geo node name. | -### `group` +### `Query.group` Find a group. @@ -132,40 +134,40 @@ Returns [`Group`](#group). | Name | Type | Description | | ---- | ---- | ----------- | -| `fullPath` | [`ID!`](#id) | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | +| <a id="querygroupfullpath"></a>`fullPath` | [`ID!`](#id) | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | -### `instanceSecurityDashboard` +### `Query.instanceSecurityDashboard` Fields related to Instance Security Dashboard. Returns [`InstanceSecurityDashboard`](#instancesecuritydashboard). -### `instanceStatisticsMeasurements` +### `Query.instanceStatisticsMeasurements` Get statistics on the instance. WARNING: **Deprecated** in 13.10. This was renamed. -Use: `Query.usageTrendsMeasurements`. +Use: [`Query.usageTrendsMeasurements`](#queryusagetrendsmeasurements). Returns [`UsageTrendsMeasurementConnection`](#usagetrendsmeasurementconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `identifier` | [`MeasurementIdentifier!`](#measurementidentifier) | The type of measurement/statistics to retrieve. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `recordedAfter` | [`Time`](#time) | Measurement recorded after this date. | -| `recordedBefore` | [`Time`](#time) | Measurement recorded before this date. | +| <a id="queryinstancestatisticsmeasurementsidentifier"></a>`identifier` | [`MeasurementIdentifier!`](#measurementidentifier) | The type of measurement/statistics to retrieve. | +| <a id="queryinstancestatisticsmeasurementsrecordedafter"></a>`recordedAfter` | [`Time`](#time) | Measurement recorded after this date. | +| <a id="queryinstancestatisticsmeasurementsrecordedbefore"></a>`recordedBefore` | [`Time`](#time) | Measurement recorded before this date. | -### `issue` +### `Query.issue` -Find an Issue. +Find an issue. Returns [`Issue`](#issue). @@ -173,9 +175,9 @@ Returns [`Issue`](#issue). | Name | Type | Description | | ---- | ---- | ----------- | -| `id` | [`IssueID!`](#issueid) | The global ID of the Issue. | +| <a id="queryissueid"></a>`id` | [`IssueID!`](#issueid) | The global ID of the issue. | -### `iteration` +### `Query.iteration` Find an iteration. @@ -185,30 +187,37 @@ Returns [`Iteration`](#iteration). | Name | Type | Description | | ---- | ---- | ----------- | -| `id` | [`IterationID!`](#iterationid) | Find an iteration by its ID. | +| <a id="queryiterationid"></a>`id` | [`IterationID!`](#iterationid) | Find an iteration by its ID. | -### `licenseHistoryEntries` +### `Query.licenseHistoryEntries` Fields related to entries in the license history. Returns [`LicenseHistoryEntryConnection`](#licensehistoryentryconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +### `Query.mergeRequest` + +Find a merge request. + +Returns [`MergeRequest`](#mergerequest). + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | +| <a id="querymergerequestid"></a>`id` | [`MergeRequestID!`](#mergerequestid) | The global ID of the merge request. | -### `metadata` +### `Query.metadata` Metadata about GitLab. Returns [`Metadata`](#metadata). -### `milestone` +### `Query.milestone` Find a milestone. @@ -218,9 +227,9 @@ Returns [`Milestone`](#milestone). | Name | Type | Description | | ---- | ---- | ----------- | -| `id` | [`MilestoneID!`](#milestoneid) | Find a milestone by its ID. | +| <a id="querymilestoneid"></a>`id` | [`MilestoneID!`](#milestoneid) | Find a milestone by its ID. | -### `namespace` +### `Query.namespace` Find a namespace. @@ -230,9 +239,9 @@ Returns [`Namespace`](#namespace). | Name | Type | Description | | ---- | ---- | ----------- | -| `fullPath` | [`ID!`](#id) | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | +| <a id="querynamespacefullpath"></a>`fullPath` | [`ID!`](#id) | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | -### `package` +### `Query.package` Find a package. @@ -242,9 +251,9 @@ Returns [`PackageDetailsType`](#packagedetailstype). | Name | Type | Description | | ---- | ---- | ----------- | -| `id` | [`PackagesPackageID!`](#packagespackageid) | The global ID of the package. | +| <a id="querypackageid"></a>`id` | [`PackagesPackageID!`](#packagespackageid) | The global ID of the package. | -### `project` +### `Query.project` Find a project. @@ -254,44 +263,51 @@ Returns [`Project`](#project). | Name | Type | Description | | ---- | ---- | ----------- | -| `fullPath` | [`ID!`](#id) | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | +| <a id="queryprojectfullpath"></a>`fullPath` | [`ID!`](#id) | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | -### `projects` +### `Query.projects` Find projects visible to the current user. Returns [`ProjectConnection`](#projectconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `ids` | [`[ID!]`](#id) | Filter projects by IDs. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `membership` | [`Boolean`](#boolean) | Limit projects that the current user is a member of. | -| `search` | [`String`](#string) | Search query for project name, path, or description. | -| `searchNamespaces` | [`Boolean`](#boolean) | Include namespace in project search. | -| `sort` | [`String`](#string) | Sort order of results. | +| <a id="queryprojectsids"></a>`ids` | [`[ID!]`](#id) | Filter projects by IDs. | +| <a id="queryprojectsmembership"></a>`membership` | [`Boolean`](#boolean) | Limit projects that the current user is a member of. | +| <a id="queryprojectssearch"></a>`search` | [`String`](#string) | Search query for project name, path, or description. | +| <a id="queryprojectssearchnamespaces"></a>`searchNamespaces` | [`Boolean`](#boolean) | Include namespace in project search. | +| <a id="queryprojectssort"></a>`sort` | [`String`](#string) | Sort order of results. | -### `runnerPlatforms` +### `Query.runner` -Supported runner platforms. +Find a runner. Available only when feature flag `runner_graphql_query` is enabled. -Returns [`RunnerPlatformConnection`](#runnerplatformconnection). +Returns [`CiRunner`](#cirunner). #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | +| <a id="queryrunnerid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | Runner ID. | + +### `Query.runnerPlatforms` -### `runnerSetup` +Supported runner platforms. + +Returns [`RunnerPlatformConnection`](#runnerplatformconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +### `Query.runnerSetup` Runner setup instructions. @@ -301,125 +317,144 @@ Returns [`RunnerSetup`](#runnersetup). | Name | Type | Description | | ---- | ---- | ----------- | -| `architecture` | [`String!`](#string) | Architecture to generate the instructions for. | -| `groupId` | [`GroupID`](#groupid) | Group to register the runner for. Deprecated in 13.11: No longer used. | -| `platform` | [`String!`](#string) | Platform to generate the instructions for. | -| `projectId` | [`ProjectID`](#projectid) | Project to register the runner for. Deprecated in 13.11: No longer used. | +| <a id="queryrunnersetuparchitecture"></a>`architecture` | [`String!`](#string) | Architecture to generate the instructions for. | +| <a id="queryrunnersetupgroupid"></a>`groupId` **{warning-solid}** | [`GroupID`](#groupid) | **Deprecated** in 13.11. No longer used. | +| <a id="queryrunnersetupplatform"></a>`platform` | [`String!`](#string) | Platform to generate the instructions for. | +| <a id="queryrunnersetupprojectid"></a>`projectId` **{warning-solid}** | [`ProjectID`](#projectid) | **Deprecated** in 13.11. No longer used. | + +### `Query.runners` + +Find runners visible to the current user. Available only when feature flag `runner_graphql_query` is enabled. + +Returns [`CiRunnerConnection`](#cirunnerconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="queryrunnerssort"></a>`sort` | [`CiRunnerSort`](#cirunnersort) | Sort order of results. | +| <a id="queryrunnersstatus"></a>`status` | [`CiRunnerStatus`](#cirunnerstatus) | Filter runners by status. | +| <a id="queryrunnerstaglist"></a>`tagList` | [`[String!]`](#string) | Filter by tags associated with the runner (comma-separated or array). | +| <a id="queryrunnerstype"></a>`type` | [`CiRunnerType`](#cirunnertype) | Filter runners by type. | -### `snippets` +### `Query.snippets` Find Snippets visible to the current user. Returns [`SnippetConnection`](#snippetconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `authorId` | [`UserID`](#userid) | The ID of an author. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `explore` | [`Boolean`](#boolean) | Explore personal snippets. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `projectId` | [`ProjectID`](#projectid) | The ID of a project. | -| `type` | [`TypeEnum`](#typeenum) | The type of snippet. | -| `visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | The visibility of the snippet. | +| <a id="querysnippetsauthorid"></a>`authorId` | [`UserID`](#userid) | The ID of an author. | +| <a id="querysnippetsexplore"></a>`explore` | [`Boolean`](#boolean) | Explore personal snippets. | +| <a id="querysnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | +| <a id="querysnippetsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The ID of a project. | +| <a id="querysnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | The type of snippet. | +| <a id="querysnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | The visibility of the snippet. | -### `usageTrendsMeasurements` +### `Query.usageTrendsMeasurements` Get statistics on the instance. Returns [`UsageTrendsMeasurementConnection`](#usagetrendsmeasurementconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `identifier` | [`MeasurementIdentifier!`](#measurementidentifier) | The type of measurement/statistics to retrieve. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `recordedAfter` | [`Time`](#time) | Measurement recorded after this date. | -| `recordedBefore` | [`Time`](#time) | Measurement recorded before this date. | +| <a id="queryusagetrendsmeasurementsidentifier"></a>`identifier` | [`MeasurementIdentifier!`](#measurementidentifier) | The type of measurement/statistics to retrieve. | +| <a id="queryusagetrendsmeasurementsrecordedafter"></a>`recordedAfter` | [`Time`](#time) | Measurement recorded after this date. | +| <a id="queryusagetrendsmeasurementsrecordedbefore"></a>`recordedBefore` | [`Time`](#time) | Measurement recorded before this date. | -### `user` +### `Query.user` Find a user. -Returns [`User`](#user). +Returns [`UserCore`](#usercore). #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `id` | [`UserID`](#userid) | ID of the User. | -| `username` | [`String`](#string) | Username of the User. | +| <a id="queryuserid"></a>`id` | [`UserID`](#userid) | ID of the User. | +| <a id="queryuserusername"></a>`username` | [`String`](#string) | Username of the User. | -### `users` +### `Query.users` Find users. -Returns [`UserConnection`](#userconnection). +Returns [`UserCoreConnection`](#usercoreconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `admins` | [`Boolean`](#boolean) | Return only admin users. | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `ids` | [`[ID!]`](#id) | List of user Global IDs. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `search` | [`String`](#string) | Query to search users by name, username, or primary email. | -| `sort` | [`Sort`](#sort) | Sort users by this criteria. | -| `usernames` | [`[String!]`](#string) | List of usernames. | +| <a id="queryusersadmins"></a>`admins` | [`Boolean`](#boolean) | Return only admin users. | +| <a id="queryusersids"></a>`ids` | [`[ID!]`](#id) | List of user Global IDs. | +| <a id="queryuserssearch"></a>`search` | [`String`](#string) | Query to search users by name, username, or primary email. | +| <a id="queryuserssort"></a>`sort` | [`Sort`](#sort) | Sort users by this criteria. | +| <a id="queryusersusernames"></a>`usernames` | [`[String!]`](#string) | List of usernames. | -### `vulnerabilities` +### `Query.vulnerabilities` Vulnerabilities reported on projects on the current user's instance security dashboard. Returns [`VulnerabilityConnection`](#vulnerabilityconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `hasIssues` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have linked issues. | -| `hasResolution` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have been resolved on default branch. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. | -| `reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. | -| `scanner` | [`[String!]`](#string) | Filter vulnerabilities by VulnerabilityScanner.externalId. | -| `scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. | -| `severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. | -| `sort` | [`VulnerabilitySort`](#vulnerabilitysort) | List vulnerabilities by sort order. | -| `state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. | - -### `vulnerabilitiesCountByDay` +| <a id="queryvulnerabilitieshasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have linked issues. | +| <a id="queryvulnerabilitieshasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have been resolved on default branch. | +| <a id="queryvulnerabilitiesprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. | +| <a id="queryvulnerabilitiesreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. | +| <a id="queryvulnerabilitiesscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by VulnerabilityScanner.externalId. | +| <a id="queryvulnerabilitiesscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. | +| <a id="queryvulnerabilitiesseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. | +| <a id="queryvulnerabilitiessort"></a>`sort` | [`VulnerabilitySort`](#vulnerabilitysort) | List vulnerabilities by sort order. | +| <a id="queryvulnerabilitiesstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. | + +### `Query.vulnerabilitiesCountByDay` Number of vulnerabilities per day for the projects on the current user's instance security dashboard. Returns [`VulnerabilitiesCountByDayConnection`](#vulnerabilitiescountbydayconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | -| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | -| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. | -| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | -| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. | +| <a id="queryvulnerabilitiescountbydayenddate"></a>`endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. | +| <a id="queryvulnerabilitiescountbydaystartdate"></a>`startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. | -### `vulnerabilitiesCountByDayAndSeverity` +### `Query.vulnerabilitiesCountByDayAndSeverity` Number of vulnerabilities per severity level, per day, for the projects on the current user's instance security dashboard. @@ -428,7135 +463,13032 @@ current user's instance security dashboard. WARNING: **Deprecated** in 13.3. Use of this is not recommended. -Use: `Query.vulnerabilitiesCountByDay`. +Use: [`Query.vulnerabilitiesCountByDay`](#queryvulnerabilitiescountbyday). Returns [`VulnerabilitiesCountByDayAndSeverityConnection`](#vulnerabilitiescountbydayandseverityconnection). +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="queryvulnerabilitiescountbydayandseverityenddate"></a>`endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. | +| <a id="queryvulnerabilitiescountbydayandseveritystartdate"></a>`startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. | + +### `Query.vulnerability` + +Find a vulnerability. + +Returns [`Vulnerability`](#vulnerability). + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="queryvulnerabilityid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | The Global ID of the Vulnerability. | + +## `Mutation` type + +The `Mutation` type contains all the mutations you can execute. + +All mutations receive their arguments in a single input object named `input`, and all mutations +support at least a return field `errors` containing a list of error messages. + +All input objects may have a `clientMutationId: String` field, identifying the mutation. + +For example: + +```graphql +mutation($id: NoteableID!, $body: String!) { + createNote(input: { noteableId: $id, body: $body }) { + errors + } +} +``` + +### `Mutation.addAwardEmoji` + +WARNING: +**Deprecated** in 13.2. +Use awardEmojiAdd. + +Input type: `AddAwardEmojiInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationaddawardemojiawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | The global ID of the awardable resource. | +| <a id="mutationaddawardemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationaddawardemojiname"></a>`name` | [`String!`](#string) | The emoji name. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationaddawardemojiawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | +| <a id="mutationaddawardemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationaddawardemojierrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.addProjectToSecurityDashboard` + +Input type: `AddProjectToSecurityDashboardInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationaddprojecttosecuritydashboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationaddprojecttosecuritydashboardid"></a>`id` | [`ProjectID!`](#projectid) | ID of the project to be added to Instance Security Dashboard. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationaddprojecttosecuritydashboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationaddprojecttosecuritydashboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationaddprojecttosecuritydashboardproject"></a>`project` | [`Project`](#project) | Project that was added to the Instance Security Dashboard. | + +### `Mutation.adminSidekiqQueuesDeleteJobs` + +Input type: `AdminSidekiqQueuesDeleteJobsInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationadminsidekiqqueuesdeletejobscallerid"></a>`callerId` | [`String`](#string) | Delete jobs matching caller_id in the context metadata. | +| <a id="mutationadminsidekiqqueuesdeletejobsclientid"></a>`clientId` | [`String`](#string) | Delete jobs matching client_id in the context metadata. | +| <a id="mutationadminsidekiqqueuesdeletejobsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationadminsidekiqqueuesdeletejobsfeaturecategory"></a>`featureCategory` | [`String`](#string) | Delete jobs matching feature_category in the context metadata. | +| <a id="mutationadminsidekiqqueuesdeletejobsproject"></a>`project` | [`String`](#string) | Delete jobs matching project in the context metadata. | +| <a id="mutationadminsidekiqqueuesdeletejobsqueuename"></a>`queueName` | [`String!`](#string) | The name of the queue to delete jobs from. | +| <a id="mutationadminsidekiqqueuesdeletejobsrelatedclass"></a>`relatedClass` | [`String`](#string) | Delete jobs matching related_class in the context metadata. | +| <a id="mutationadminsidekiqqueuesdeletejobsremoteip"></a>`remoteIp` | [`String`](#string) | Delete jobs matching remote_ip in the context metadata. | +| <a id="mutationadminsidekiqqueuesdeletejobsrootnamespace"></a>`rootNamespace` | [`String`](#string) | Delete jobs matching root_namespace in the context metadata. | +| <a id="mutationadminsidekiqqueuesdeletejobssubscriptionplan"></a>`subscriptionPlan` | [`String`](#string) | Delete jobs matching subscription_plan in the context metadata. | +| <a id="mutationadminsidekiqqueuesdeletejobsuser"></a>`user` | [`String`](#string) | Delete jobs matching user in the context metadata. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationadminsidekiqqueuesdeletejobsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationadminsidekiqqueuesdeletejobserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationadminsidekiqqueuesdeletejobsresult"></a>`result` | [`DeleteJobsResponse`](#deletejobsresponse) | Information about the status of the deletion request. | + +### `Mutation.alertSetAssignees` + +Input type: `AlertSetAssigneesInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationalertsetassigneesassigneeusernames"></a>`assigneeUsernames` | [`[String!]!`](#string) | The usernames to assign to the alert. Replaces existing assignees by default. | +| <a id="mutationalertsetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationalertsetassigneesiid"></a>`iid` | [`String!`](#string) | The IID of the alert to mutate. | +| <a id="mutationalertsetassigneesoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | The operation to perform. Defaults to REPLACE. | +| <a id="mutationalertsetassigneesprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the alert to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationalertsetassigneesalert"></a>`alert` | [`AlertManagementAlert`](#alertmanagementalert) | The alert after mutation. | +| <a id="mutationalertsetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationalertsetassigneeserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationalertsetassigneesissue"></a>`issue` | [`Issue`](#issue) | The issue created after mutation. | +| <a id="mutationalertsetassigneestodo"></a>`todo` | [`Todo`](#todo) | The to-do item after mutation. | + +### `Mutation.alertTodoCreate` + +Input type: `AlertTodoCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationalerttodocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationalerttodocreateiid"></a>`iid` | [`String!`](#string) | The IID of the alert to mutate. | +| <a id="mutationalerttodocreateprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the alert to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationalerttodocreatealert"></a>`alert` | [`AlertManagementAlert`](#alertmanagementalert) | The alert after mutation. | +| <a id="mutationalerttodocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationalerttodocreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationalerttodocreateissue"></a>`issue` | [`Issue`](#issue) | The issue created after mutation. | +| <a id="mutationalerttodocreatetodo"></a>`todo` | [`Todo`](#todo) | The to-do item after mutation. | + +### `Mutation.apiFuzzingCiConfigurationCreate` + +Input type: `ApiFuzzingCiConfigurationCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationapifuzzingciconfigurationcreateapispecificationfile"></a>`apiSpecificationFile` | [`String!`](#string) | File path or URL to the file that defines the API surface for scanning. Must be in the format specified by the `scanMode` argument. | +| <a id="mutationapifuzzingciconfigurationcreateauthpassword"></a>`authPassword` | [`String`](#string) | CI variable containing the password for authenticating with the target API. | +| <a id="mutationapifuzzingciconfigurationcreateauthusername"></a>`authUsername` | [`String`](#string) | CI variable containing the username for authenticating with the target API. | +| <a id="mutationapifuzzingciconfigurationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationapifuzzingciconfigurationcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. | +| <a id="mutationapifuzzingciconfigurationcreatescanmode"></a>`scanMode` | [`ApiFuzzingScanMode!`](#apifuzzingscanmode) | The mode for API fuzzing scans. | +| <a id="mutationapifuzzingciconfigurationcreatescanprofile"></a>`scanProfile` | [`String`](#string) | Name of a default profile to use for scanning. Ex: Quick-10. | +| <a id="mutationapifuzzingciconfigurationcreatetarget"></a>`target` | [`String!`](#string) | URL for the target of API fuzzing scans. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationapifuzzingciconfigurationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationapifuzzingciconfigurationcreateconfigurationyaml"></a>`configurationYaml` | [`String`](#string) | A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans. | +| <a id="mutationapifuzzingciconfigurationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationapifuzzingciconfigurationcreategitlabciyamleditpath"></a>`gitlabCiYamlEditPath` | [`String`](#string) | The location at which the project's `.gitlab-ci.yml` file can be edited in the browser. | + +### `Mutation.awardEmojiAdd` + +Input type: `AwardEmojiAddInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationawardemojiaddawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | The global ID of the awardable resource. | +| <a id="mutationawardemojiaddclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationawardemojiaddname"></a>`name` | [`String!`](#string) | The emoji name. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationawardemojiaddawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | +| <a id="mutationawardemojiaddclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationawardemojiadderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.awardEmojiRemove` + +Input type: `AwardEmojiRemoveInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationawardemojiremoveawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | The global ID of the awardable resource. | +| <a id="mutationawardemojiremoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationawardemojiremovename"></a>`name` | [`String!`](#string) | The emoji name. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationawardemojiremoveawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | +| <a id="mutationawardemojiremoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationawardemojiremoveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.awardEmojiToggle` + +Input type: `AwardEmojiToggleInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationawardemojitoggleawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | The global ID of the awardable resource. | +| <a id="mutationawardemojitoggleclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationawardemojitogglename"></a>`name` | [`String!`](#string) | The emoji name. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationawardemojitoggleawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | +| <a id="mutationawardemojitoggleclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationawardemojitoggleerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationawardemojitoggletoggledon"></a>`toggledOn` | [`Boolean!`](#boolean) | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. | + +### `Mutation.boardListCreate` + +Input type: `BoardListCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationboardlistcreateassigneeid"></a>`assigneeId` | [`UserID`](#userid) | Global ID of an existing user. | +| <a id="mutationboardlistcreatebacklog"></a>`backlog` | [`Boolean`](#boolean) | Create the backlog list. | +| <a id="mutationboardlistcreateboardid"></a>`boardId` | [`BoardID!`](#boardid) | Global ID of the issue board to mutate. | +| <a id="mutationboardlistcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationboardlistcreateiterationid"></a>`iterationId` | [`IterationID`](#iterationid) | Global ID of an existing iteration. | +| <a id="mutationboardlistcreatelabelid"></a>`labelId` | [`LabelID`](#labelid) | Global ID of an existing label. | +| <a id="mutationboardlistcreatemilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | Global ID of an existing milestone. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationboardlistcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationboardlistcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationboardlistcreatelist"></a>`list` | [`BoardList`](#boardlist) | Issue list in the issue board. | + +### `Mutation.boardListUpdateLimitMetrics` + +Input type: `BoardListUpdateLimitMetricsInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationboardlistupdatelimitmetricsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationboardlistupdatelimitmetricslimitmetric"></a>`limitMetric` | [`ListLimitMetric`](#listlimitmetric) | The new limit metric type for the list. | +| <a id="mutationboardlistupdatelimitmetricslistid"></a>`listId` | [`ListID!`](#listid) | The global ID of the list. | +| <a id="mutationboardlistupdatelimitmetricsmaxissuecount"></a>`maxIssueCount` | [`Int`](#int) | The new maximum issue count limit. | +| <a id="mutationboardlistupdatelimitmetricsmaxissueweight"></a>`maxIssueWeight` | [`Int`](#int) | The new maximum issue weight limit. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationboardlistupdatelimitmetricsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationboardlistupdatelimitmetricserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationboardlistupdatelimitmetricslist"></a>`list` | [`BoardList`](#boardlist) | The updated list. | + +### `Mutation.bulkFindOrCreateDevopsAdoptionSegments` + +**BETA** This endpoint is subject to change without notice. + +Input type: `BulkFindOrCreateDevopsAdoptionSegmentsInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationbulkfindorcreatedevopsadoptionsegmentsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationbulkfindorcreatedevopsadoptionsegmentsnamespaceids"></a>`namespaceIds` | [`[NamespaceID!]!`](#namespaceid) | List of Namespace IDs for the segments. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationbulkfindorcreatedevopsadoptionsegmentsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationbulkfindorcreatedevopsadoptionsegmentserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationbulkfindorcreatedevopsadoptionsegmentssegments"></a>`segments` | [`[DevopsAdoptionSegment!]`](#devopsadoptionsegment) | Created segments after mutation. | + +### `Mutation.ciCdSettingsUpdate` + +Input type: `CiCdSettingsUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcicdsettingsupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcicdsettingsupdatefullpath"></a>`fullPath` | [`ID!`](#id) | Full Path of the project the settings belong to. | +| <a id="mutationcicdsettingsupdatekeeplatestartifact"></a>`keepLatestArtifact` | [`Boolean`](#boolean) | Indicates if the latest artifact should be kept for this project. | +| <a id="mutationcicdsettingsupdatemergepipelinesenabled"></a>`mergePipelinesEnabled` | [`Boolean`](#boolean) | Indicates if merge pipelines are enabled for the project. | +| <a id="mutationcicdsettingsupdatemergetrainsenabled"></a>`mergeTrainsEnabled` | [`Boolean`](#boolean) | Indicates if merge trains are enabled for the project. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcicdsettingsupdatecicdsettings"></a>`ciCdSettings` | [`ProjectCiCdSetting!`](#projectcicdsetting) | The CI/CD settings after mutation. | +| <a id="mutationcicdsettingsupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcicdsettingsupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.clusterAgentDelete` + +Input type: `ClusterAgentDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationclusteragentdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationclusteragentdeleteid"></a>`id` | [`ClustersAgentID!`](#clustersagentid) | Global ID of the cluster agent that will be deleted. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationclusteragentdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationclusteragentdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.clusterAgentTokenCreate` + +Input type: `ClusterAgentTokenCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationclusteragenttokencreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationclusteragenttokencreateclusteragentid"></a>`clusterAgentId` | [`ClustersAgentID!`](#clustersagentid) | Global ID of the cluster agent that will be associated with the new token. | +| <a id="mutationclusteragenttokencreatedescription"></a>`description` | [`String`](#string) | Description of the token. | +| <a id="mutationclusteragenttokencreatename"></a>`name` | [`String!`](#string) | Name of the token. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationclusteragenttokencreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationclusteragenttokencreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationclusteragenttokencreatesecret"></a>`secret` | [`String`](#string) | Token secret value. Make sure you save it - you won't be able to access it again. | +| <a id="mutationclusteragenttokencreatetoken"></a>`token` | [`ClusterAgentToken`](#clusteragenttoken) | Token created after mutation. | + +### `Mutation.clusterAgentTokenDelete` + +Input type: `ClusterAgentTokenDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationclusteragenttokendeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationclusteragenttokendeleteid"></a>`id` | [`ClustersAgentTokenID!`](#clustersagenttokenid) | Global ID of the cluster agent token that will be deleted. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationclusteragenttokendeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationclusteragenttokendeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.commitCreate` + +Input type: `CommitCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcommitcreateactions"></a>`actions` | [`[CommitAction!]!`](#commitaction) | Array of action hashes to commit as a batch. | +| <a id="mutationcommitcreatebranch"></a>`branch` | [`String!`](#string) | Name of the branch to commit into, it can be a new branch. | +| <a id="mutationcommitcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcommitcreatemessage"></a>`message` | [`String!`](#string) | Raw commit message. | +| <a id="mutationcommitcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path the branch is associated with. | +| <a id="mutationcommitcreatestartbranch"></a>`startBranch` | [`String`](#string) | If on a new branch, name of the original branch. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcommitcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcommitcreatecommit"></a>`commit` | [`Commit`](#commit) | The commit after mutation. | +| <a id="mutationcommitcreatecommitpipelinepath"></a>`commitPipelinePath` | [`String`](#string) | ETag path for the commit's pipeline. | +| <a id="mutationcommitcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.configureSast` + +Configure SAST for a project by enabling SAST in a new or modified +`.gitlab-ci.yml` file in a new branch. The new branch and a URL to +create a Merge Request are a part of the response. + +Input type: `ConfigureSastInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationconfiguresastclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationconfiguresastconfiguration"></a>`configuration` | [`SastCiConfigurationInput!`](#sastciconfigurationinput) | SAST CI configuration for the project. | +| <a id="mutationconfiguresastprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationconfiguresastbranch"></a>`branch` | [`String`](#string) | Branch that has the new/modified `.gitlab-ci.yml` file. | +| <a id="mutationconfiguresastclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationconfiguresasterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationconfiguresastsuccesspath"></a>`successPath` | [`String`](#string) | Redirect path to use when the response is successful. | + +### `Mutation.configureSecretDetection` + +Configure Secret Detection for a project by enabling Secret Detection +in a new or modified `.gitlab-ci.yml` file in a new branch. The new +branch and a URL to create a Merge Request are a part of the +response. + +Input type: `ConfigureSecretDetectionInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationconfiguresecretdetectionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationconfiguresecretdetectionprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationconfiguresecretdetectionbranch"></a>`branch` | [`String`](#string) | Branch that has the new/modified `.gitlab-ci.yml` file. | +| <a id="mutationconfiguresecretdetectionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationconfiguresecretdetectionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationconfiguresecretdetectionsuccesspath"></a>`successPath` | [`String`](#string) | Redirect path to use when the response is successful. | + +### `Mutation.createAlertIssue` + +Input type: `CreateAlertIssueInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatealertissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatealertissueiid"></a>`iid` | [`String!`](#string) | The IID of the alert to mutate. | +| <a id="mutationcreatealertissueprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the alert to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatealertissuealert"></a>`alert` | [`AlertManagementAlert`](#alertmanagementalert) | The alert after mutation. | +| <a id="mutationcreatealertissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatealertissueerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreatealertissueissue"></a>`issue` | [`Issue`](#issue) | The issue created after mutation. | +| <a id="mutationcreatealertissuetodo"></a>`todo` | [`Todo`](#todo) | The to-do item after mutation. | + +### `Mutation.createAnnotation` + +Input type: `CreateAnnotationInput` + #### Arguments | Name | Type | Description | | ---- | ---- | ----------- | +| <a id="mutationcreateannotationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateannotationclusterid"></a>`clusterId` | [`ClustersClusterID`](#clustersclusterid) | The global ID of the cluster to add an annotation to. | +| <a id="mutationcreateannotationdashboardpath"></a>`dashboardPath` | [`String!`](#string) | The path to a file defining the dashboard on which the annotation should be added. | +| <a id="mutationcreateannotationdescription"></a>`description` | [`String!`](#string) | The description of the annotation. | +| <a id="mutationcreateannotationendingat"></a>`endingAt` | [`Time`](#time) | Timestamp indicating ending moment to which the annotation relates. | +| <a id="mutationcreateannotationenvironmentid"></a>`environmentId` | [`EnvironmentID`](#environmentid) | The global ID of the environment to add an annotation to. | +| <a id="mutationcreateannotationstartingat"></a>`startingAt` | [`Time!`](#time) | Timestamp indicating starting moment to which the annotation relates. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateannotationannotation"></a>`annotation` | [`MetricsDashboardAnnotation`](#metricsdashboardannotation) | The created annotation. | +| <a id="mutationcreateannotationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateannotationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.createBoard` + +Input type: `CreateBoardInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateboardassigneeid"></a>`assigneeId` | [`UserID`](#userid) | ID of user to be assigned to the board. | +| <a id="mutationcreateboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateboardgrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. | +| <a id="mutationcreateboardhidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. | +| <a id="mutationcreateboardhideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. | +| <a id="mutationcreateboarditerationid"></a>`iterationId` | [`IterationID`](#iterationid) | ID of iteration to be assigned to the board. | +| <a id="mutationcreateboardlabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the board. | +| <a id="mutationcreateboardlabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. | +| <a id="mutationcreateboardmilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | ID of milestone to be assigned to the board. | +| <a id="mutationcreateboardname"></a>`name` | [`String`](#string) | The board name. | +| <a id="mutationcreateboardprojectpath"></a>`projectPath` | [`ID`](#id) | Full path of the project with which the resource is associated. | +| <a id="mutationcreateboardweight"></a>`weight` | [`Int`](#int) | Weight value to be assigned to the board. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateboardboard"></a>`board` | [`Board`](#board) | The board after mutation. | +| <a id="mutationcreateboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.createBranch` + +Input type: `CreateBranchInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatebranchclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatebranchname"></a>`name` | [`String!`](#string) | Name of the branch. | +| <a id="mutationcreatebranchprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path the branch is associated with. | +| <a id="mutationcreatebranchref"></a>`ref` | [`String!`](#string) | Branch name or commit SHA to create branch from. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatebranchbranch"></a>`branch` | [`Branch`](#branch) | Branch after mutation. | +| <a id="mutationcreatebranchclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatebrancherrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.createClusterAgent` + +Input type: `CreateClusterAgentInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateclusteragentclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateclusteragentname"></a>`name` | [`String!`](#string) | Name of the cluster agent. | +| <a id="mutationcreateclusteragentprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the associated project for this cluster agent. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateclusteragentclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateclusteragentclusteragent"></a>`clusterAgent` | [`ClusterAgent`](#clusteragent) | Cluster agent created after mutation. | +| <a id="mutationcreateclusteragenterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.createComplianceFramework` + +Input type: `CreateComplianceFrameworkInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatecomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatecomplianceframeworknamespacepath"></a>`namespacePath` | [`ID!`](#id) | Full path of the namespace to add the compliance framework to. | +| <a id="mutationcreatecomplianceframeworkparams"></a>`params` | [`ComplianceFrameworkInput!`](#complianceframeworkinput) | Parameters to update the compliance framework with. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatecomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatecomplianceframeworkerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreatecomplianceframeworkframework"></a>`framework` | [`ComplianceFramework`](#complianceframework) | The created compliance framework. | + +### `Mutation.createCustomEmoji` + +Available only when feature flag `custom_emoji` is enabled. + +Input type: `CreateCustomEmojiInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatecustomemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatecustomemojigrouppath"></a>`groupPath` | [`ID!`](#id) | Namespace full path the emoji is associated with. | +| <a id="mutationcreatecustomemojiname"></a>`name` | [`String!`](#string) | Name of the emoji. | +| <a id="mutationcreatecustomemojiurl"></a>`url` | [`String!`](#string) | Location of the emoji file. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatecustomemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatecustomemojicustomemoji"></a>`customEmoji` | [`CustomEmoji`](#customemoji) | The new custom emoji. | +| <a id="mutationcreatecustomemojierrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.createDevopsAdoptionSegment` + +**BETA** This endpoint is subject to change without notice. + +Input type: `CreateDevopsAdoptionSegmentInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatedevopsadoptionsegmentclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatedevopsadoptionsegmentnamespaceid"></a>`namespaceId` | [`NamespaceID!`](#namespaceid) | Namespace ID to set for the segment. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatedevopsadoptionsegmentclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatedevopsadoptionsegmenterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreatedevopsadoptionsegmentsegment"></a>`segment` | [`DevopsAdoptionSegment`](#devopsadoptionsegment) | The segment after mutation. | + +### `Mutation.createDiffNote` + +Input type: `CreateDiffNoteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatediffnotebody"></a>`body` | [`String!`](#string) | Content of the note. | +| <a id="mutationcreatediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatediffnoteconfidential"></a>`confidential` | [`Boolean`](#boolean) | The confidentiality flag of a note. Default is false. | +| <a id="mutationcreatediffnotenoteableid"></a>`noteableId` | [`NoteableID!`](#noteableid) | The global ID of the resource to add a note to. | +| <a id="mutationcreatediffnoteposition"></a>`position` | [`DiffPositionInput!`](#diffpositioninput) | The position of this note on a diff. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatediffnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreatediffnotenote"></a>`note` | [`Note`](#note) | The note after mutation. | + +### `Mutation.createEpic` + +Input type: `CreateEpicInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateepicaddlabelids"></a>`addLabelIds` | [`[ID!]`](#id) | The IDs of labels to be added to the epic. | +| <a id="mutationcreateepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateepicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. | +| <a id="mutationcreateepicdescription"></a>`description` | [`String`](#string) | The description of the epic. | +| <a id="mutationcreateepicduedatefixed"></a>`dueDateFixed` | [`String`](#string) | The end date of the epic. | +| <a id="mutationcreateepicduedateisfixed"></a>`dueDateIsFixed` | [`Boolean`](#boolean) | Indicates end date should be sourced from due_date_fixed field not the issue milestones. | +| <a id="mutationcreateepicgrouppath"></a>`groupPath` | [`ID!`](#id) | The group the epic to mutate is in. | +| <a id="mutationcreateepicremovelabelids"></a>`removeLabelIds` | [`[ID!]`](#id) | The IDs of labels to be removed from the epic. | +| <a id="mutationcreateepicstartdatefixed"></a>`startDateFixed` | [`String`](#string) | The start date of the epic. | +| <a id="mutationcreateepicstartdateisfixed"></a>`startDateIsFixed` | [`Boolean`](#boolean) | Indicates start date should be sourced from start_date_fixed field not the issue milestones. | +| <a id="mutationcreateepictitle"></a>`title` | [`String`](#string) | The title of the epic. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateepicepic"></a>`epic` | [`Epic`](#epic) | The created epic. | +| <a id="mutationcreateepicerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.createImageDiffNote` + +Input type: `CreateImageDiffNoteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateimagediffnotebody"></a>`body` | [`String!`](#string) | Content of the note. | +| <a id="mutationcreateimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateimagediffnoteconfidential"></a>`confidential` | [`Boolean`](#boolean) | The confidentiality flag of a note. Default is false. | +| <a id="mutationcreateimagediffnotenoteableid"></a>`noteableId` | [`NoteableID!`](#noteableid) | The global ID of the resource to add a note to. | +| <a id="mutationcreateimagediffnoteposition"></a>`position` | [`DiffImagePositionInput!`](#diffimagepositioninput) | The position of this note on a diff. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateimagediffnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreateimagediffnotenote"></a>`note` | [`Note`](#note) | The note after mutation. | + +### `Mutation.createIssue` + +Input type: `CreateIssueInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateissueassigneeids"></a>`assigneeIds` | [`[UserID!]`](#userid) | The array of user IDs to assign to the issue. | +| <a id="mutationcreateissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateissueconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates the issue is confidential. | +| <a id="mutationcreateissuecreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the issue was created. Available only for admins and project owners. | +| <a id="mutationcreateissuedescription"></a>`description` | [`String`](#string) | Description of the issue. | +| <a id="mutationcreateissuediscussiontoresolve"></a>`discussionToResolve` | [`String`](#string) | The ID of a discussion to resolve. Also pass `merge_request_to_resolve_discussions_of`. | +| <a id="mutationcreateissueduedate"></a>`dueDate` | [`ISO8601Date`](#iso8601date) | Due date of the issue. | +| <a id="mutationcreateissueepicid"></a>`epicId` | [`EpicID`](#epicid) | The ID of an epic to associate the issue with. | +| <a id="mutationcreateissuehealthstatus"></a>`healthStatus` | [`HealthStatus`](#healthstatus) | The desired health status. | +| <a id="mutationcreateissueiid"></a>`iid` | [`Int`](#int) | The IID (internal ID) of a project issue. Only admins and project owners can modify. | +| <a id="mutationcreateissuelabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | The IDs of labels to be added to the issue. | +| <a id="mutationcreateissuelabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. | +| <a id="mutationcreateissuelocked"></a>`locked` | [`Boolean`](#boolean) | Indicates discussion is locked on the issue. | +| <a id="mutationcreateissuemergerequesttoresolvediscussionsof"></a>`mergeRequestToResolveDiscussionsOf` | [`MergeRequestID`](#mergerequestid) | The IID of a merge request for which to resolve discussions. | +| <a id="mutationcreateissuemilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | The ID of the milestone to assign to the issue. On update milestone will be removed if set to null. | +| <a id="mutationcreateissueprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path the issue is associated with. | +| <a id="mutationcreateissuetitle"></a>`title` | [`String!`](#string) | Title of the issue. | +| <a id="mutationcreateissuetype"></a>`type` | [`IssueType`](#issuetype) | Type of the issue. | +| <a id="mutationcreateissueweight"></a>`weight` | [`Int`](#int) | The weight of the issue. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateissueerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreateissueissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.createIteration` + +Input type: `CreateIterationInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateiterationdescription"></a>`description` | [`String`](#string) | The description of the iteration. | +| <a id="mutationcreateiterationduedate"></a>`dueDate` | [`String`](#string) | The end date of the iteration. | +| <a id="mutationcreateiterationgrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. | +| <a id="mutationcreateiterationprojectpath"></a>`projectPath` | [`ID`](#id) | Full path of the project with which the resource is associated. | +| <a id="mutationcreateiterationstartdate"></a>`startDate` | [`String`](#string) | The start date of the iteration. | +| <a id="mutationcreateiterationtitle"></a>`title` | [`String`](#string) | The title of the iteration. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreateiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreateiterationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreateiterationiteration"></a>`iteration` | [`Iteration`](#iteration) | The created iteration. | + +### `Mutation.createNote` + +Input type: `CreateNoteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatenotebody"></a>`body` | [`String!`](#string) | Content of the note. | +| <a id="mutationcreatenoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatenoteconfidential"></a>`confidential` | [`Boolean`](#boolean) | The confidentiality flag of a note. Default is false. | +| <a id="mutationcreatenotediscussionid"></a>`discussionId` | [`DiscussionID`](#discussionid) | The global ID of the discussion this note is in reply to. | +| <a id="mutationcreatenotenoteableid"></a>`noteableId` | [`NoteableID!`](#noteableid) | The global ID of the resource to add a note to. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatenoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatenoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreatenotenote"></a>`note` | [`Note`](#note) | The note after mutation. | + +### `Mutation.createRequirement` + +Input type: `CreateRequirementInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreaterequirementclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreaterequirementdescription"></a>`description` | [`String`](#string) | Description of the requirement. | +| <a id="mutationcreaterequirementprojectpath"></a>`projectPath` | [`ID!`](#id) | Full project path the requirement is associated with. | +| <a id="mutationcreaterequirementtitle"></a>`title` | [`String`](#string) | Title of the requirement. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreaterequirementclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreaterequirementerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreaterequirementrequirement"></a>`requirement` | [`Requirement`](#requirement) | Requirement after mutation. | + +### `Mutation.createSnippet` + +Input type: `CreateSnippetInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatesnippetblobactions"></a>`blobActions` | [`[SnippetBlobActionInputType!]`](#snippetblobactioninputtype) | Actions to perform over the snippet repository and blobs. | +| <a id="mutationcreatesnippetcaptcharesponse"></a>`captchaResponse` **{warning-solid}** | [`String`](#string) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationcreatesnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatesnippetdescription"></a>`description` | [`String`](#string) | Description of the snippet. | +| <a id="mutationcreatesnippetprojectpath"></a>`projectPath` | [`ID`](#id) | The project full path the snippet is associated with. | +| <a id="mutationcreatesnippetspamlogid"></a>`spamLogId` **{warning-solid}** | [`Int`](#int) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationcreatesnippettitle"></a>`title` | [`String!`](#string) | Title of the snippet. | +| <a id="mutationcreatesnippetuploadedfiles"></a>`uploadedFiles` | [`[String!]`](#string) | The paths to files uploaded in the snippet description. | +| <a id="mutationcreatesnippetvisibilitylevel"></a>`visibilityLevel` | [`VisibilityLevelsEnum!`](#visibilitylevelsenum) | The visibility level of the snippet. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatesnippetcaptchasitekey"></a>`captchaSiteKey` **{warning-solid}** | [`String`](#string) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationcreatesnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatesnippeterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreatesnippetneedscaptcharesponse"></a>`needsCaptchaResponse` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationcreatesnippetsnippet"></a>`snippet` | [`Snippet`](#snippet) | The snippet after mutation. | +| <a id="mutationcreatesnippetspam"></a>`spam` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationcreatesnippetspamlogid"></a>`spamLogId` **{warning-solid}** | [`Int`](#int) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | + +### `Mutation.createTestCase` + +Input type: `CreateTestCaseInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatetestcaseclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatetestcasedescription"></a>`description` | [`String`](#string) | The test case description. | +| <a id="mutationcreatetestcaselabelids"></a>`labelIds` | [`[ID!]`](#id) | The IDs of labels to be added to the test case. | +| <a id="mutationcreatetestcaseprojectpath"></a>`projectPath` | [`ID!`](#id) | The project full path to create the test case. | +| <a id="mutationcreatetestcasetitle"></a>`title` | [`String!`](#string) | The test case title. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationcreatetestcaseclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationcreatetestcaseerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationcreatetestcasetestcase"></a>`testCase` | [`Issue`](#issue) | The test case created. | + +### `Mutation.dastOnDemandScanCreate` + +Input type: `DastOnDemandScanCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastondemandscancreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastondemandscancreatedastscannerprofileid"></a>`dastScannerProfileId` | [`DastScannerProfileID`](#dastscannerprofileid) | ID of the scanner profile to be used for the scan. | +| <a id="mutationdastondemandscancreatedastsiteprofileid"></a>`dastSiteProfileId` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile to be used for the scan. | +| <a id="mutationdastondemandscancreatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the site profile belongs to. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastondemandscancreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastondemandscancreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastondemandscancreatepipelineurl"></a>`pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. | + +### `Mutation.dastProfileCreate` + +Input type: `DastProfileCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastprofilecreatebranchname"></a>`branchName` | [`String`](#string) | The associated branch. | +| <a id="mutationdastprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastprofilecreatedastscannerprofileid"></a>`dastScannerProfileId` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the scanner profile to be associated. | +| <a id="mutationdastprofilecreatedastsiteprofileid"></a>`dastSiteProfileId` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile to be associated. | +| <a id="mutationdastprofilecreatedescription"></a>`description` | [`String`](#string) | The description of the profile. Defaults to an empty string. | +| <a id="mutationdastprofilecreatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the profile belongs to. | +| <a id="mutationdastprofilecreatename"></a>`name` | [`String!`](#string) | The name of the profile. | +| <a id="mutationdastprofilecreaterunaftercreate"></a>`runAfterCreate` | [`Boolean`](#boolean) | Run scan using profile after creation. Defaults to false. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastprofilecreatedastprofile"></a>`dastProfile` | [`DastProfile`](#dastprofile) | The created profile. | +| <a id="mutationdastprofilecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastprofilecreatepipelineurl"></a>`pipelineUrl` | [`String`](#string) | The URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`. | + +### `Mutation.dastProfileDelete` + +Input type: `DastProfileDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastprofiledeleteid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the profile to be deleted. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastprofiledeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.dastProfileRun` + +Input type: `DastProfileRunInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastprofilerunclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastprofilerunfullpath"></a>`fullPath` | [`ID!`](#id) | Full path for the project the scanner profile belongs to. | +| <a id="mutationdastprofilerunid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the profile to be used for the scan. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastprofilerunclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastprofilerunerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastprofilerunpipelineurl"></a>`pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. | + +### `Mutation.dastProfileUpdate` + +Input type: `DastProfileUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastprofileupdatebranchname"></a>`branchName` | [`String`](#string) | The associated branch. | +| <a id="mutationdastprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastprofileupdatedastscannerprofileid"></a>`dastScannerProfileId` | [`DastScannerProfileID`](#dastscannerprofileid) | ID of the scanner profile to be associated. | +| <a id="mutationdastprofileupdatedastsiteprofileid"></a>`dastSiteProfileId` | [`DastSiteProfileID`](#dastsiteprofileid) | ID of the site profile to be associated. | +| <a id="mutationdastprofileupdatedescription"></a>`description` | [`String`](#string) | The description of the profile. Defaults to an empty string. | +| <a id="mutationdastprofileupdatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the profile belongs to. | +| <a id="mutationdastprofileupdateid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the profile to be deleted. | +| <a id="mutationdastprofileupdatename"></a>`name` | [`String`](#string) | The name of the profile. | +| <a id="mutationdastprofileupdaterunafterupdate"></a>`runAfterUpdate` | [`Boolean`](#boolean) | Run scan using profile after update. Defaults to false. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastprofileupdatedastprofile"></a>`dastProfile` | [`DastProfile`](#dastprofile) | The updated profile. | +| <a id="mutationdastprofileupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastprofileupdatepipelineurl"></a>`pipelineUrl` | [`String`](#string) | The URL of the pipeline that was created. Requires the input argument `runAfterUpdate` to be set to `true` when calling the mutation, otherwise no pipeline will be created. | + +### `Mutation.dastScannerProfileCreate` + +Input type: `DastScannerProfileCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastscannerprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastscannerprofilecreatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the scanner profile belongs to. | +| <a id="mutationdastscannerprofilecreateprofilename"></a>`profileName` | [`String!`](#string) | The name of the scanner profile. | +| <a id="mutationdastscannerprofilecreatescantype"></a>`scanType` | [`DastScanTypeEnum`](#dastscantypeenum) | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. | +| <a id="mutationdastscannerprofilecreateshowdebugmessages"></a>`showDebugMessages` | [`Boolean`](#boolean) | Indicates if debug messages should be included in DAST console output. True to include the debug messages. | +| <a id="mutationdastscannerprofilecreatespidertimeout"></a>`spiderTimeout` | [`Int`](#int) | The maximum number of minutes allowed for the spider to traverse the site. | +| <a id="mutationdastscannerprofilecreatetargettimeout"></a>`targetTimeout` | [`Int`](#int) | The maximum number of seconds allowed for the site under test to respond to a request. | +| <a id="mutationdastscannerprofilecreateuseajaxspider"></a>`useAjaxSpider` | [`Boolean`](#boolean) | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastscannerprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastscannerprofilecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastscannerprofilecreateglobalid"></a>`globalId` **{warning-solid}** | [`DastScannerProfileID`](#dastscannerprofileid) | **Deprecated:** Use `id`. Deprecated in 13.6. | +| <a id="mutationdastscannerprofilecreateid"></a>`id` | [`DastScannerProfileID`](#dastscannerprofileid) | ID of the scanner profile. | + +### `Mutation.dastScannerProfileDelete` + +Input type: `DastScannerProfileDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastscannerprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastscannerprofiledeletefullpath"></a>`fullPath` | [`ID!`](#id) | Full path for the project the scanner profile belongs to. | +| <a id="mutationdastscannerprofiledeleteid"></a>`id` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the scanner profile to be deleted. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastscannerprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastscannerprofiledeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.dastScannerProfileUpdate` + +Input type: `DastScannerProfileUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastscannerprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastscannerprofileupdatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the scanner profile belongs to. | +| <a id="mutationdastscannerprofileupdateid"></a>`id` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the scanner profile to be updated. | +| <a id="mutationdastscannerprofileupdateprofilename"></a>`profileName` | [`String!`](#string) | The name of the scanner profile. | +| <a id="mutationdastscannerprofileupdatescantype"></a>`scanType` | [`DastScanTypeEnum`](#dastscantypeenum) | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. | +| <a id="mutationdastscannerprofileupdateshowdebugmessages"></a>`showDebugMessages` | [`Boolean`](#boolean) | Indicates if debug messages should be included in DAST console output. True to include the debug messages. | +| <a id="mutationdastscannerprofileupdatespidertimeout"></a>`spiderTimeout` | [`Int!`](#int) | The maximum number of minutes allowed for the spider to traverse the site. | +| <a id="mutationdastscannerprofileupdatetargettimeout"></a>`targetTimeout` | [`Int!`](#int) | The maximum number of seconds allowed for the site under test to respond to a request. | +| <a id="mutationdastscannerprofileupdateuseajaxspider"></a>`useAjaxSpider` | [`Boolean`](#boolean) | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastscannerprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastscannerprofileupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastscannerprofileupdateid"></a>`id` | [`DastScannerProfileID`](#dastscannerprofileid) | ID of the scanner profile. | + +### `Mutation.dastSiteProfileCreate` + +Input type: `DastSiteProfileCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsiteprofilecreateauth"></a>`auth` | [`DastSiteProfileAuthInput`](#dastsiteprofileauthinput) | Parameters for authentication. Will be ignored if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="mutationdastsiteprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsiteprofilecreateexcludedurls"></a>`excludedUrls` | [`[String!]`](#string) | The URLs to skip during an authenticated scan. Defaults to `[]`. Will be ignored if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="mutationdastsiteprofilecreatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the site profile belongs to. | +| <a id="mutationdastsiteprofilecreateprofilename"></a>`profileName` | [`String!`](#string) | The name of the site profile. | +| <a id="mutationdastsiteprofilecreaterequestheaders"></a>`requestHeaders` | [`String`](#string) | Comma-separated list of request header names and values to be added to every request made by DAST. Will be ignored if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="mutationdastsiteprofilecreatetargettype"></a>`targetType` | [`DastTargetTypeEnum`](#dasttargettypeenum) | The type of target to be scanned. Will be ignored if `security_dast_site_profiles_api_option` feature flag is disabled. | +| <a id="mutationdastsiteprofilecreatetargeturl"></a>`targetUrl` | [`String`](#string) | The URL of the target to be scanned. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsiteprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsiteprofilecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastsiteprofilecreateid"></a>`id` | [`DastSiteProfileID`](#dastsiteprofileid) | ID of the site profile. | + +### `Mutation.dastSiteProfileDelete` + +Input type: `DastSiteProfileDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsiteprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsiteprofiledeletefullpath"></a>`fullPath` | [`ID!`](#id) | The project the site profile belongs to. | +| <a id="mutationdastsiteprofiledeleteid"></a>`id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile to be deleted. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsiteprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsiteprofiledeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.dastSiteProfileUpdate` + +Input type: `DastSiteProfileUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsiteprofileupdateauth"></a>`auth` | [`DastSiteProfileAuthInput`](#dastsiteprofileauthinput) | Parameters for authentication. Will be ignored if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="mutationdastsiteprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsiteprofileupdateexcludedurls"></a>`excludedUrls` | [`[String!]`](#string) | The URLs to skip during an authenticated scan. Will be ignored if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="mutationdastsiteprofileupdatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the site profile belongs to. | +| <a id="mutationdastsiteprofileupdateid"></a>`id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile to be updated. | +| <a id="mutationdastsiteprofileupdateprofilename"></a>`profileName` | [`String!`](#string) | The name of the site profile. | +| <a id="mutationdastsiteprofileupdaterequestheaders"></a>`requestHeaders` | [`String`](#string) | Comma-separated list of request header names and values to be added to every request made by DAST. Will be ignored if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="mutationdastsiteprofileupdatetargettype"></a>`targetType` | [`DastTargetTypeEnum`](#dasttargettypeenum) | The type of target to be scanned. Will be ignored if `security_dast_site_profiles_api_option` feature flag is disabled. | +| <a id="mutationdastsiteprofileupdatetargeturl"></a>`targetUrl` | [`String`](#string) | The URL of the target to be scanned. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsiteprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsiteprofileupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastsiteprofileupdateid"></a>`id` | [`DastSiteProfileID`](#dastsiteprofileid) | ID of the site profile. | + +### `Mutation.dastSiteTokenCreate` + +Input type: `DastSiteTokenCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsitetokencreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsitetokencreatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the site token belongs to. | +| <a id="mutationdastsitetokencreatetargeturl"></a>`targetUrl` | [`String`](#string) | The URL of the target to be validated. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsitetokencreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsitetokencreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastsitetokencreateid"></a>`id` | [`DastSiteTokenID`](#dastsitetokenid) | ID of the site token. | +| <a id="mutationdastsitetokencreatestatus"></a>`status` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | The current validation status of the target. | +| <a id="mutationdastsitetokencreatetoken"></a>`token` | [`String`](#string) | Token string. | + +### `Mutation.dastSiteValidationCreate` + +Input type: `DastSiteValidationCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsitevalidationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsitevalidationcreatedastsitetokenid"></a>`dastSiteTokenId` | [`DastSiteTokenID!`](#dastsitetokenid) | ID of the site token. | +| <a id="mutationdastsitevalidationcreatefullpath"></a>`fullPath` | [`ID!`](#id) | The project the site profile belongs to. | +| <a id="mutationdastsitevalidationcreatestrategy"></a>`strategy` | [`DastSiteValidationStrategyEnum`](#dastsitevalidationstrategyenum) | The validation strategy to be used. | +| <a id="mutationdastsitevalidationcreatevalidationpath"></a>`validationPath` | [`String!`](#string) | The path to be requested during validation. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsitevalidationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsitevalidationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdastsitevalidationcreateid"></a>`id` | [`DastSiteValidationID`](#dastsitevalidationid) | ID of the site validation. | +| <a id="mutationdastsitevalidationcreatestatus"></a>`status` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | The current validation status. | + +### `Mutation.dastSiteValidationRevoke` + +Input type: `DastSiteValidationRevokeInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsitevalidationrevokeclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsitevalidationrevokefullpath"></a>`fullPath` | [`ID!`](#id) | The project the site validation belongs to. | +| <a id="mutationdastsitevalidationrevokenormalizedtargeturl"></a>`normalizedTargetUrl` | [`String!`](#string) | Normalized URL of the target to be revoked. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdastsitevalidationrevokeclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdastsitevalidationrevokeerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.deleteAnnotation` + +Input type: `DeleteAnnotationInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdeleteannotationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdeleteannotationid"></a>`id` | [`MetricsDashboardAnnotationID!`](#metricsdashboardannotationid) | Global ID of the annotation to delete. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdeleteannotationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdeleteannotationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.deleteDevopsAdoptionSegment` + +**BETA** This endpoint is subject to change without notice. + +Input type: `DeleteDevopsAdoptionSegmentInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdeletedevopsadoptionsegmentclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdeletedevopsadoptionsegmentid"></a>`id` | [`[AnalyticsDevopsAdoptionSegmentID!]!`](#analyticsdevopsadoptionsegmentid) | One or many IDs of the segments to delete. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdeletedevopsadoptionsegmentclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdeletedevopsadoptionsegmenterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.designManagementDelete` + +Input type: `DesignManagementDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdesignmanagementdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdesignmanagementdeletefilenames"></a>`filenames` | [`[String!]!`](#string) | The filenames of the designs to delete. | +| <a id="mutationdesignmanagementdeleteiid"></a>`iid` | [`ID!`](#id) | The IID of the issue to modify designs for. | +| <a id="mutationdesignmanagementdeleteprojectpath"></a>`projectPath` | [`ID!`](#id) | The project where the issue is to upload designs for. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdesignmanagementdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdesignmanagementdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdesignmanagementdeleteversion"></a>`version` | [`DesignVersion`](#designversion) | The new version in which the designs are deleted. | + +### `Mutation.designManagementMove` + +Input type: `DesignManagementMoveInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdesignmanagementmoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdesignmanagementmoveid"></a>`id` | [`DesignManagementDesignID!`](#designmanagementdesignid) | ID of the design to move. | +| <a id="mutationdesignmanagementmovenext"></a>`next` | [`DesignManagementDesignID`](#designmanagementdesignid) | ID of the immediately following design. | +| <a id="mutationdesignmanagementmoveprevious"></a>`previous` | [`DesignManagementDesignID`](#designmanagementdesignid) | ID of the immediately preceding design. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdesignmanagementmoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdesignmanagementmovedesigncollection"></a>`designCollection` | [`DesignCollection`](#designcollection) | The current state of the collection. | +| <a id="mutationdesignmanagementmoveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.designManagementUpload` + +Input type: `DesignManagementUploadInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdesignmanagementuploadclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdesignmanagementuploadfiles"></a>`files` | [`[Upload!]!`](#upload) | The files to upload. | +| <a id="mutationdesignmanagementuploadiid"></a>`iid` | [`ID!`](#id) | The IID of the issue to modify designs for. | +| <a id="mutationdesignmanagementuploadprojectpath"></a>`projectPath` | [`ID!`](#id) | The project where the issue is to upload designs for. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdesignmanagementuploadclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdesignmanagementuploaddesigns"></a>`designs` | [`[Design!]!`](#design) | The designs that were uploaded by the mutation. | +| <a id="mutationdesignmanagementuploaderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdesignmanagementuploadskippeddesigns"></a>`skippedDesigns` | [`[Design!]!`](#design) | Any designs that were skipped from the upload due to there being no change to their content since their last version. | + +### `Mutation.destroyBoard` + +Input type: `DestroyBoardInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroyboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroyboardid"></a>`id` | [`BoardID!`](#boardid) | The global ID of the board to destroy. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroyboardboard"></a>`board` | [`Board`](#board) | The board after mutation. | +| <a id="mutationdestroyboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroyboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.destroyBoardList` + +Input type: `DestroyBoardListInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroyboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroyboardlistlistid"></a>`listId` | [`ListID!`](#listid) | Global ID of the list to destroy. Only label lists are accepted. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroyboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroyboardlisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdestroyboardlistlist"></a>`list` | [`BoardList`](#boardlist) | The list after mutation. | + +### `Mutation.destroyComplianceFramework` + +Input type: `DestroyComplianceFrameworkInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroycomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroycomplianceframeworkid"></a>`id` | [`ComplianceManagementFrameworkID!`](#compliancemanagementframeworkid) | The global ID of the compliance framework to destroy. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroycomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroycomplianceframeworkerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.destroyContainerRepository` + +Input type: `DestroyContainerRepositoryInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroycontainerrepositoryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroycontainerrepositoryid"></a>`id` | [`ContainerRepositoryID!`](#containerrepositoryid) | ID of the container repository. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroycontainerrepositoryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroycontainerrepositorycontainerrepository"></a>`containerRepository` | [`ContainerRepository!`](#containerrepository) | The container repository policy after scheduling the deletion. | +| <a id="mutationdestroycontainerrepositoryerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.destroyContainerRepositoryTags` + +Input type: `DestroyContainerRepositoryTagsInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroycontainerrepositorytagsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroycontainerrepositorytagsid"></a>`id` | [`ContainerRepositoryID!`](#containerrepositoryid) | ID of the container repository. | +| <a id="mutationdestroycontainerrepositorytagstagnames"></a>`tagNames` | [`[String!]!`](#string) | Container repository tag(s) to delete. Total number can't be greater than 20. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroycontainerrepositorytagsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroycontainerrepositorytagsdeletedtagnames"></a>`deletedTagNames` | [`[String!]!`](#string) | Deleted container repository tags. | +| <a id="mutationdestroycontainerrepositorytagserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.destroyEpicBoard` + +Input type: `DestroyEpicBoardInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroyepicboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroyepicboardid"></a>`id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the board to destroy. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroyepicboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroyepicboardepicboard"></a>`epicBoard` | [`EpicBoard`](#epicboard) | Epic board after mutation. | +| <a id="mutationdestroyepicboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.destroyNote` + +Input type: `DestroyNoteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroynoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroynoteid"></a>`id` | [`NoteID!`](#noteid) | The global ID of the note to destroy. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroynoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroynoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdestroynotenote"></a>`note` | [`Note`](#note) | The note after mutation. | + +### `Mutation.destroySnippet` + +Input type: `DestroySnippetInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroysnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroysnippetid"></a>`id` | [`SnippetID!`](#snippetid) | The global ID of the snippet to destroy. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdestroysnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdestroysnippeterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdestroysnippetsnippet"></a>`snippet` | [`Snippet`](#snippet) | The snippet after mutation. | + +### `Mutation.discussionToggleResolve` + +Toggles the resolved state of a discussion. + +Input type: `DiscussionToggleResolveInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdiscussiontoggleresolveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdiscussiontoggleresolveid"></a>`id` | [`DiscussionID!`](#discussionid) | The global ID of the discussion. | +| <a id="mutationdiscussiontoggleresolveresolve"></a>`resolve` | [`Boolean!`](#boolean) | Will resolve the discussion when true, and unresolve the discussion when false. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdiscussiontoggleresolveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdiscussiontoggleresolvediscussion"></a>`discussion` | [`Discussion`](#discussion) | The discussion after mutation. | +| <a id="mutationdiscussiontoggleresolveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.dismissVulnerability` + +WARNING: +**Deprecated** in 13.5. +Use vulnerabilityDismiss. + +Input type: `DismissVulnerabilityInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdismissvulnerabilityclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdismissvulnerabilitycomment"></a>`comment` | [`String`](#string) | Comment why vulnerability should be dismissed. | +| <a id="mutationdismissvulnerabilitydismissalreason"></a>`dismissalReason` | [`VulnerabilityDismissalReason`](#vulnerabilitydismissalreason) | Reason why vulnerability should be dismissed. | +| <a id="mutationdismissvulnerabilityid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be dismissed. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationdismissvulnerabilityclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationdismissvulnerabilityerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationdismissvulnerabilityvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | The vulnerability after dismissal. | + +### `Mutation.environmentsCanaryIngressUpdate` + +Input type: `EnvironmentsCanaryIngressUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationenvironmentscanaryingressupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationenvironmentscanaryingressupdateid"></a>`id` | [`EnvironmentID!`](#environmentid) | The global ID of the environment to update. | +| <a id="mutationenvironmentscanaryingressupdateweight"></a>`weight` | [`Int!`](#int) | The weight of the Canary Ingress. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationenvironmentscanaryingressupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationenvironmentscanaryingressupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.epicAddIssue` + +Input type: `EpicAddIssueInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicaddissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicaddissuegrouppath"></a>`groupPath` | [`ID!`](#id) | The group the epic to mutate belongs to. | +| <a id="mutationepicaddissueiid"></a>`iid` | [`ID!`](#id) | The IID of the epic to mutate. | +| <a id="mutationepicaddissueissueiid"></a>`issueIid` | [`String!`](#string) | The IID of the issue to be added. | +| <a id="mutationepicaddissueprojectpath"></a>`projectPath` | [`ID!`](#id) | The full path of the project the issue belongs to. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicaddissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicaddissueepic"></a>`epic` | [`Epic`](#epic) | The epic after mutation. | +| <a id="mutationepicaddissueepicissue"></a>`epicIssue` | [`EpicIssue`](#epicissue) | The epic-issue relation. | +| <a id="mutationepicaddissueerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.epicBoardCreate` + +Input type: `EpicBoardCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicboardcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicboardcreategrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. | +| <a id="mutationepicboardcreatehidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. | +| <a id="mutationepicboardcreatehideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. | +| <a id="mutationepicboardcreatelabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the board. | +| <a id="mutationepicboardcreatelabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. | +| <a id="mutationepicboardcreatename"></a>`name` | [`String`](#string) | The board name. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicboardcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicboardcreateepicboard"></a>`epicBoard` | [`EpicBoard`](#epicboard) | The created epic board. | +| <a id="mutationepicboardcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.epicBoardListCreate` + +Input type: `EpicBoardListCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicboardlistcreatebacklog"></a>`backlog` | [`Boolean`](#boolean) | Create the backlog list. | +| <a id="mutationepicboardlistcreateboardid"></a>`boardId` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the issue board to mutate. | +| <a id="mutationepicboardlistcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicboardlistcreatelabelid"></a>`labelId` | [`LabelID`](#labelid) | Global ID of an existing label. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicboardlistcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicboardlistcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationepicboardlistcreatelist"></a>`list` | [`EpicList`](#epiclist) | Epic list in the epic board. | + +### `Mutation.epicBoardListDestroy` + +Destroys an epic board list. + +Input type: `EpicBoardListDestroyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicboardlistdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicboardlistdestroylistid"></a>`listId` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the epic board list to destroy. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicboardlistdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicboardlistdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationepicboardlistdestroylist"></a>`list` | [`EpicList`](#epiclist) | The epic board list. `null` if the board was destroyed successfully. | + +### `Mutation.epicBoardUpdate` + +Input type: `EpicBoardUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicboardupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicboardupdatehidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. | +| <a id="mutationepicboardupdatehideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. | +| <a id="mutationepicboardupdateid"></a>`id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | The epic board global ID. | +| <a id="mutationepicboardupdatelabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the board. | +| <a id="mutationepicboardupdatelabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. | +| <a id="mutationepicboardupdatename"></a>`name` | [`String`](#string) | The board name. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicboardupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicboardupdateepicboard"></a>`epicBoard` | [`EpicBoard`](#epicboard) | The updated epic board. | +| <a id="mutationepicboardupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.epicMoveList` + +Input type: `EpicMoveListInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicmovelistboardid"></a>`boardId` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the board that the epic is in. | +| <a id="mutationepicmovelistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicmovelistepicid"></a>`epicId` | [`EpicID!`](#epicid) | ID of the epic to mutate. | +| <a id="mutationepicmovelistfromlistid"></a>`fromListId` | [`BoardsEpicListID!`](#boardsepiclistid) | ID of the board list that the epic will be moved from. | +| <a id="mutationepicmovelisttolistid"></a>`toListId` | [`BoardsEpicListID!`](#boardsepiclistid) | ID of the board list that the epic will be moved to. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicmovelistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicmovelisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.epicSetSubscription` + +Input type: `EpicSetSubscriptionInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicsetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicsetsubscriptiongrouppath"></a>`groupPath` | [`ID!`](#id) | The group the epic to mutate belongs to. | +| <a id="mutationepicsetsubscriptioniid"></a>`iid` | [`ID!`](#id) | The IID of the epic to mutate. | +| <a id="mutationepicsetsubscriptionsubscribedstate"></a>`subscribedState` | [`Boolean!`](#boolean) | The desired state of the subscription. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepicsetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepicsetsubscriptionepic"></a>`epic` | [`Epic`](#epic) | The epic after mutation. | +| <a id="mutationepicsetsubscriptionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.epicTreeReorder` + +Input type: `EpicTreeReorderInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepictreereorderbaseepicid"></a>`baseEpicId` | [`EpicID!`](#epicid) | The ID of the base epic of the tree. | +| <a id="mutationepictreereorderclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepictreereordermoved"></a>`moved` | [`EpicTreeNodeFieldsInputType!`](#epictreenodefieldsinputtype) | Parameters for updating the tree positions. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationepictreereorderclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationepictreereordererrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.exportRequirements` + +Input type: `ExportRequirementsInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationexportrequirementsauthorusername"></a>`authorUsername` | [`[String!]`](#string) | Filter requirements by author username. | +| <a id="mutationexportrequirementsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationexportrequirementsprojectpath"></a>`projectPath` | [`ID!`](#id) | Full project path the requirements are associated with. | +| <a id="mutationexportrequirementssearch"></a>`search` | [`String`](#string) | Search query for requirement title. | +| <a id="mutationexportrequirementsselectedfields"></a>`selectedFields` | [`[String!]`](#string) | List of selected requirements fields to be exported. | +| <a id="mutationexportrequirementssort"></a>`sort` | [`Sort`](#sort) | List requirements by sort order. | +| <a id="mutationexportrequirementsstate"></a>`state` | [`RequirementState`](#requirementstate) | Filter requirements by state. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationexportrequirementsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationexportrequirementserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.gitlabSubscriptionActivate` + +Input type: `GitlabSubscriptionActivateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationgitlabsubscriptionactivateactivationcode"></a>`activationCode` | [`String!`](#string) | Activation code received after purchasing a GitLab subscription. | +| <a id="mutationgitlabsubscriptionactivateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationgitlabsubscriptionactivateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationgitlabsubscriptionactivateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationgitlabsubscriptionactivatelicense"></a>`license` | [`CurrentLicense`](#currentlicense) | The current license. | + +### `Mutation.httpIntegrationCreate` + +Input type: `HttpIntegrationCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationhttpintegrationcreateactive"></a>`active` | [`Boolean!`](#boolean) | Whether the integration is receiving alerts. | +| <a id="mutationhttpintegrationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationhttpintegrationcreatename"></a>`name` | [`String!`](#string) | The name of the integration. | +| <a id="mutationhttpintegrationcreatepayloadattributemappings"></a>`payloadAttributeMappings` | [`[AlertManagementPayloadAlertFieldInput!]`](#alertmanagementpayloadalertfieldinput) | The custom mapping of GitLab alert attributes to fields from the payload_example. | +| <a id="mutationhttpintegrationcreatepayloadexample"></a>`payloadExample` | [`JsonString`](#jsonstring) | The example of an alert payload. | +| <a id="mutationhttpintegrationcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to create the integration in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationhttpintegrationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationhttpintegrationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationhttpintegrationcreateintegration"></a>`integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The HTTP integration. | + +### `Mutation.httpIntegrationDestroy` + +Input type: `HttpIntegrationDestroyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationhttpintegrationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationhttpintegrationdestroyid"></a>`id` | [`AlertManagementHttpIntegrationID!`](#alertmanagementhttpintegrationid) | The ID of the integration to remove. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationhttpintegrationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationhttpintegrationdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationhttpintegrationdestroyintegration"></a>`integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The HTTP integration. | + +### `Mutation.httpIntegrationResetToken` + +Input type: `HttpIntegrationResetTokenInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationhttpintegrationresettokenclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationhttpintegrationresettokenid"></a>`id` | [`AlertManagementHttpIntegrationID!`](#alertmanagementhttpintegrationid) | The ID of the integration to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationhttpintegrationresettokenclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationhttpintegrationresettokenerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationhttpintegrationresettokenintegration"></a>`integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The HTTP integration. | + +### `Mutation.httpIntegrationUpdate` + +Input type: `HttpIntegrationUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationhttpintegrationupdateactive"></a>`active` | [`Boolean`](#boolean) | Whether the integration is receiving alerts. | +| <a id="mutationhttpintegrationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationhttpintegrationupdateid"></a>`id` | [`AlertManagementHttpIntegrationID!`](#alertmanagementhttpintegrationid) | The ID of the integration to mutate. | +| <a id="mutationhttpintegrationupdatename"></a>`name` | [`String`](#string) | The name of the integration. | +| <a id="mutationhttpintegrationupdatepayloadattributemappings"></a>`payloadAttributeMappings` | [`[AlertManagementPayloadAlertFieldInput!]`](#alertmanagementpayloadalertfieldinput) | The custom mapping of GitLab alert attributes to fields from the payload_example. | +| <a id="mutationhttpintegrationupdatepayloadexample"></a>`payloadExample` | [`JsonString`](#jsonstring) | The example of an alert payload. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationhttpintegrationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationhttpintegrationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationhttpintegrationupdateintegration"></a>`integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The HTTP integration. | + +### `Mutation.issueMove` + +Input type: `IssueMoveInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuemoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuemoveiid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuemoveprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | +| <a id="mutationissuemovetargetprojectpath"></a>`targetProjectPath` | [`ID!`](#id) | The project to move the issue to. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuemoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuemoveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuemoveissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueMoveList` + +Input type: `IssueMoveListInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuemovelistboardid"></a>`boardId` | [`BoardID!`](#boardid) | Global ID of the board that the issue is in. | +| <a id="mutationissuemovelistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuemovelistepicid"></a>`epicId` | [`EpicID`](#epicid) | The ID of the parent epic. NULL when removing the association. | +| <a id="mutationissuemovelistfromlistid"></a>`fromListId` | [`ID`](#id) | ID of the board list that the issue will be moved from. | +| <a id="mutationissuemovelistiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. | +| <a id="mutationissuemovelistmoveafterid"></a>`moveAfterId` | [`ID`](#id) | ID of issue that should be placed after the current issue. | +| <a id="mutationissuemovelistmovebeforeid"></a>`moveBeforeId` | [`ID`](#id) | ID of issue that should be placed before the current issue. | +| <a id="mutationissuemovelistprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. | +| <a id="mutationissuemovelisttolistid"></a>`toListId` | [`ID`](#id) | ID of the board list that the issue will be moved to. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuemovelistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuemovelisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuemovelistissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetAssignees` + +Input type: `IssueSetAssigneesInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetassigneesassigneeusernames"></a>`assigneeUsernames` | [`[String!]!`](#string) | The usernames to assign to the resource. Replaces existing assignees by default. | +| <a id="mutationissuesetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetassigneesiid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetassigneesoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | The operation to perform. Defaults to REPLACE. | +| <a id="mutationissuesetassigneesprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetassigneeserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetassigneesissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetConfidential` + +Input type: `IssueSetConfidentialInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetconfidentialclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetconfidentialconfidential"></a>`confidential` | [`Boolean!`](#boolean) | Whether or not to set the issue as a confidential. | +| <a id="mutationissuesetconfidentialiid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetconfidentialprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetconfidentialclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetconfidentialerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetconfidentialissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetDueDate` + +Input type: `IssueSetDueDateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetduedateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetduedateduedate"></a>`dueDate` | [`Time`](#time) | The desired due date for the issue, due date will be removed if absent or set to null. | +| <a id="mutationissuesetduedateiid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetduedateprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetduedateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetduedateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetduedateissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetEpic` + +Input type: `IssueSetEpicInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetepicepicid"></a>`epicId` | [`EpicID`](#epicid) | Global ID of the epic to be assigned to the issue, epic will be removed if absent or set to null. | +| <a id="mutationissuesetepiciid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetepicprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetepicerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetepicissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetIteration` + +Input type: `IssueSetIterationInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetiterationiid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetiterationiterationid"></a>`iterationId` | [`IterationID`](#iterationid) | The iteration to assign to the issue. | +| <a id="mutationissuesetiterationprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetiterationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetiterationissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetLocked` + +Input type: `IssueSetLockedInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetlockediid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetlockedlocked"></a>`locked` | [`Boolean!`](#boolean) | Whether or not to lock discussion on the issue. | +| <a id="mutationissuesetlockedprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetlockederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetlockedissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetSeverity` + +Input type: `IssueSetSeverityInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetseverityclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetseverityiid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetseverityprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | +| <a id="mutationissuesetseverityseverity"></a>`severity` | [`IssuableSeverity!`](#issuableseverity) | Set the incident severity level. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetseverityclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetseverityerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetseverityissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetSubscription` + +Input type: `IssueSetSubscriptionInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetsubscriptioniid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetsubscriptionprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | +| <a id="mutationissuesetsubscriptionsubscribedstate"></a>`subscribedState` | [`Boolean!`](#boolean) | The desired state of the subscription. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetsubscriptionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetsubscriptionissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.issueSetWeight` + +Input type: `IssueSetWeightInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetweightclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetweightiid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationissuesetweightprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | +| <a id="mutationissuesetweightweight"></a>`weight` | [`Int!`](#int) | The desired weight for the issue. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationissuesetweightclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationissuesetweighterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationissuesetweightissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.iterationCadenceCreate` + +Input type: `IterationCadenceCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationiterationcadencecreateactive"></a>`active` | [`Boolean!`](#boolean) | Whether the iteration cadence is active. | +| <a id="mutationiterationcadencecreateautomatic"></a>`automatic` | [`Boolean!`](#boolean) | Whether the iteration cadence should automatically generate future iterations. | +| <a id="mutationiterationcadencecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationiterationcadencecreatedescription"></a>`description` | [`String`](#string) | Description of the iteration cadence. Maximum length is 5000 characters. | +| <a id="mutationiterationcadencecreatedurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. | +| <a id="mutationiterationcadencecreategrouppath"></a>`groupPath` | [`ID!`](#id) | The group where the iteration cadence is created. | +| <a id="mutationiterationcadencecreateiterationsinadvance"></a>`iterationsInAdvance` | [`Int`](#int) | Future iterations to be created when iteration cadence is set to automatic. | +| <a id="mutationiterationcadencecreaterollover"></a>`rollOver` | [`Boolean`](#boolean) | Whether the iteration cadence should roll over issues to the next iteration or not. | +| <a id="mutationiterationcadencecreatestartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the iteration cadence start date. | +| <a id="mutationiterationcadencecreatetitle"></a>`title` | [`String`](#string) | Title of the iteration cadence. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationiterationcadencecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationiterationcadencecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationiterationcadencecreateiterationcadence"></a>`iterationCadence` | [`IterationCadence`](#iterationcadence) | The created iteration cadence. | + +### `Mutation.iterationCadenceDestroy` + +Input type: `IterationCadenceDestroyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationiterationcadencedestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationiterationcadencedestroyid"></a>`id` | [`IterationsCadenceID!`](#iterationscadenceid) | Global ID of the iteration cadence. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationiterationcadencedestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationiterationcadencedestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationiterationcadencedestroygroup"></a>`group` | [`Group!`](#group) | Group the iteration cadence belongs to. | + +### `Mutation.iterationCadenceUpdate` + +Input type: `IterationCadenceUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationiterationcadenceupdateactive"></a>`active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. | +| <a id="mutationiterationcadenceupdateautomatic"></a>`automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate future iterations. | +| <a id="mutationiterationcadenceupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationiterationcadenceupdatedescription"></a>`description` | [`String`](#string) | Description of the iteration cadence. Maximum length is 5000 characters. | +| <a id="mutationiterationcadenceupdatedurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. | +| <a id="mutationiterationcadenceupdateid"></a>`id` | [`IterationsCadenceID!`](#iterationscadenceid) | Global ID of the iteration cadence. | +| <a id="mutationiterationcadenceupdateiterationsinadvance"></a>`iterationsInAdvance` | [`Int`](#int) | Future iterations to be created when iteration cadence is set to automatic. | +| <a id="mutationiterationcadenceupdaterollover"></a>`rollOver` | [`Boolean`](#boolean) | Whether the iteration cadence should roll over issues to the next iteration or not. | +| <a id="mutationiterationcadenceupdatestartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the iteration cadence start date. | +| <a id="mutationiterationcadenceupdatetitle"></a>`title` | [`String`](#string) | Title of the iteration cadence. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationiterationcadenceupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationiterationcadenceupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationiterationcadenceupdateiterationcadence"></a>`iterationCadence` | [`IterationCadence`](#iterationcadence) | The updated iteration cadence. | + +### `Mutation.iterationDelete` + +Input type: `IterationDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationiterationdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationiterationdeleteid"></a>`id` | [`IterationID!`](#iterationid) | ID of the iteration. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationiterationdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationiterationdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationiterationdeletegroup"></a>`group` | [`Group!`](#group) | Group the iteration belongs to. | + +### `Mutation.jiraImportStart` + +Input type: `JiraImportStartInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationjiraimportstartclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationjiraimportstartjiraprojectkey"></a>`jiraProjectKey` | [`String!`](#string) | Project key of the importer Jira project. | +| <a id="mutationjiraimportstartjiraprojectname"></a>`jiraProjectName` | [`String`](#string) | Project name of the importer Jira project. | +| <a id="mutationjiraimportstartprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to import the Jira project into. | +| <a id="mutationjiraimportstartusersmapping"></a>`usersMapping` | [`[JiraUsersMappingInputType!]`](#jirausersmappinginputtype) | The mapping of Jira to GitLab users. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationjiraimportstartclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationjiraimportstarterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationjiraimportstartjiraimport"></a>`jiraImport` | [`JiraImport`](#jiraimport) | The Jira import data after mutation. | + +### `Mutation.jiraImportUsers` + +Input type: `JiraImportUsersInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationjiraimportusersclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationjiraimportusersprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to import the Jira users into. | +| <a id="mutationjiraimportusersstartat"></a>`startAt` | [`Int`](#int) | The index of the record the import should started at, default 0 (50 records returned). | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationjiraimportusersclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationjiraimportuserserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationjiraimportusersjirausers"></a>`jiraUsers` | [`[JiraUser!]`](#jirauser) | Users returned from Jira, matched by email and name if possible. | + +### `Mutation.jobPlay` + +Input type: `JobPlayInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationjobplayclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationjobplayid"></a>`id` | [`CiBuildID!`](#cibuildid) | The ID of the job to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationjobplayclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationjobplayerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationjobplayjob"></a>`job` | [`CiJob`](#cijob) | The job after the mutation. | + +### `Mutation.jobRetry` + +Input type: `JobRetryInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationjobretryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationjobretryid"></a>`id` | [`CiBuildID!`](#cibuildid) | The ID of the job to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationjobretryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationjobretryerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationjobretryjob"></a>`job` | [`CiJob`](#cijob) | The job after the mutation. | + +### `Mutation.labelCreate` + +Input type: `LabelCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationlabelcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationlabelcreatecolor"></a>`color` | [`String`](#string) | The color of the label given in 6-digit hex notation with leading '#' sign (for example, `#FFAABB`) or one of the CSS color names. | +| <a id="mutationlabelcreatedescription"></a>`description` | [`String`](#string) | Description of the label. | +| <a id="mutationlabelcreategrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. | +| <a id="mutationlabelcreateprojectpath"></a>`projectPath` | [`ID`](#id) | Full path of the project with which the resource is associated. | +| <a id="mutationlabelcreateremoveonclose"></a>`removeOnClose` | [`Boolean`](#boolean) | Whether the label should be removed from an issue when the issue is closed. | +| <a id="mutationlabelcreatetitle"></a>`title` | [`String!`](#string) | Title of the label. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationlabelcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationlabelcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationlabelcreatelabel"></a>`label` | [`Label`](#label) | The label after mutation. | + +### `Mutation.markAsSpamSnippet` + +Input type: `MarkAsSpamSnippetInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmarkasspamsnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmarkasspamsnippetid"></a>`id` | [`SnippetID!`](#snippetid) | The global ID of the snippet to update. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmarkasspamsnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmarkasspamsnippeterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmarkasspamsnippetsnippet"></a>`snippet` | [`Snippet`](#snippet) | The snippet after mutation. | + +### `Mutation.mergeRequestAccept` + +Accepts a merge request. +When accepted, the source branch will be merged into the target branch, either +immediately if possible, or using one of the automatic merge strategies. + +Input type: `MergeRequestAcceptInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestacceptclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestacceptcommitmessage"></a>`commitMessage` | [`String`](#string) | Custom merge commit message. | +| <a id="mutationmergerequestacceptiid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestacceptprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | +| <a id="mutationmergerequestacceptsha"></a>`sha` | [`String!`](#string) | The HEAD SHA at the time when this merge was requested. | +| <a id="mutationmergerequestacceptshouldremovesourcebranch"></a>`shouldRemoveSourceBranch` | [`Boolean`](#boolean) | Should the source branch be removed. | +| <a id="mutationmergerequestacceptsquash"></a>`squash` | [`Boolean`](#boolean) | Squash commits on the source branch before merge. | +| <a id="mutationmergerequestacceptsquashcommitmessage"></a>`squashCommitMessage` | [`String`](#string) | Custom squash commit message (if squash is true). | +| <a id="mutationmergerequestacceptstrategy"></a>`strategy` | [`MergeStrategyEnum`](#mergestrategyenum) | How to merge this merge request. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestacceptclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestaccepterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestacceptmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestCreate` + +Input type: `MergeRequestCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestcreatedescription"></a>`description` | [`String`](#string) | Description of the merge request (Markdown rendered as HTML for caching). | +| <a id="mutationmergerequestcreatelabels"></a>`labels` | [`[String!]`](#string) | Labels of the merge request. | +| <a id="mutationmergerequestcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path the merge request is associated with. | +| <a id="mutationmergerequestcreatesourcebranch"></a>`sourceBranch` | [`String!`](#string) | Source branch of the merge request. | +| <a id="mutationmergerequestcreatetargetbranch"></a>`targetBranch` | [`String!`](#string) | Target branch of the merge request. | +| <a id="mutationmergerequestcreatetitle"></a>`title` | [`String!`](#string) | Title of the merge request. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestcreatemergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestReviewerRereview` + +Input type: `MergeRequestReviewerRereviewInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestreviewerrereviewclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestreviewerrereviewiid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestreviewerrereviewprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | +| <a id="mutationmergerequestreviewerrereviewuserid"></a>`userId` | [`UserID!`](#userid) | The user ID for the user that has been requested for a new review. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestreviewerrereviewclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestreviewerrereviewerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestreviewerrereviewmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestSetAssignees` + +Input type: `MergeRequestSetAssigneesInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetassigneesassigneeusernames"></a>`assigneeUsernames` | [`[String!]!`](#string) | The usernames to assign to the resource. Replaces existing assignees by default. | +| <a id="mutationmergerequestsetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetassigneesiid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestsetassigneesoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | The operation to perform. Defaults to REPLACE. | +| <a id="mutationmergerequestsetassigneesprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetassigneeserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestsetassigneesmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestSetDraft` + +Input type: `MergeRequestSetDraftInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetdraftclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetdraftdraft"></a>`draft` | [`Boolean!`](#boolean) | Whether or not to set the merge request as a draft. | +| <a id="mutationmergerequestsetdraftiid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestsetdraftprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetdraftclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetdrafterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestsetdraftmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestSetLabels` + +Input type: `MergeRequestSetLabelsInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetlabelsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetlabelsiid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestsetlabelslabelids"></a>`labelIds` | [`[LabelID!]!`](#labelid) | The Label IDs to set. Replaces existing labels by default. | +| <a id="mutationmergerequestsetlabelsoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | Changes the operation mode. Defaults to REPLACE. | +| <a id="mutationmergerequestsetlabelsprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetlabelsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetlabelserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestsetlabelsmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestSetLocked` + +Input type: `MergeRequestSetLockedInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetlockediid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestsetlockedlocked"></a>`locked` | [`Boolean!`](#boolean) | Whether or not to lock the merge request. | +| <a id="mutationmergerequestsetlockedprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetlockederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestsetlockedmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestSetMilestone` + +Input type: `MergeRequestSetMilestoneInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetmilestoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetmilestoneiid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestsetmilestonemilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | The milestone to assign to the merge request. | +| <a id="mutationmergerequestsetmilestoneprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetmilestoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetmilestoneerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestsetmilestonemergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestSetSubscription` + +Input type: `MergeRequestSetSubscriptionInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetsubscriptioniid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestsetsubscriptionprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | +| <a id="mutationmergerequestsetsubscriptionsubscribedstate"></a>`subscribedState` | [`Boolean!`](#boolean) | The desired state of the subscription. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetsubscriptionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestsetsubscriptionmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestSetWip` + +WARNING: +**Deprecated** in 13.12. +Use mergeRequestSetDraft. + +Input type: `MergeRequestSetWipInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetwipclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetwipiid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestsetwipprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | +| <a id="mutationmergerequestsetwipwip"></a>`wip` | [`Boolean!`](#boolean) | Whether or not to set the merge request as a draft. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestsetwipclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestsetwiperrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestsetwipmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.mergeRequestUpdate` + +Update attributes of a merge request. + +Input type: `MergeRequestUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestupdatedescription"></a>`description` | [`String`](#string) | Description of the merge request (Markdown rendered as HTML for caching). | +| <a id="mutationmergerequestupdateiid"></a>`iid` | [`String!`](#string) | The IID of the merge request to mutate. | +| <a id="mutationmergerequestupdateprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the merge request to mutate is in. | +| <a id="mutationmergerequestupdatestate"></a>`state` | [`MergeRequestNewState`](#mergerequestnewstate) | The action to perform to change the state. | +| <a id="mutationmergerequestupdatetargetbranch"></a>`targetBranch` | [`String`](#string) | Target branch of the merge request. | +| <a id="mutationmergerequestupdatetitle"></a>`title` | [`String`](#string) | Title of the merge request. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationmergerequestupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationmergerequestupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationmergerequestupdatemergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | + +### `Mutation.namespaceIncreaseStorageTemporarily` + +Input type: `NamespaceIncreaseStorageTemporarilyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationnamespaceincreasestoragetemporarilyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationnamespaceincreasestoragetemporarilyid"></a>`id` | [`NamespaceID!`](#namespaceid) | The global ID of the namespace to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationnamespaceincreasestoragetemporarilyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationnamespaceincreasestoragetemporarilyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationnamespaceincreasestoragetemporarilynamespace"></a>`namespace` | [`Namespace`](#namespace) | The namespace after mutation. | + +### `Mutation.oncallRotationCreate` + +Input type: `OncallRotationCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallrotationcreateactiveperiod"></a>`activePeriod` | [`OncallRotationActivePeriodInputType`](#oncallrotationactiveperiodinputtype) | The active period of time that the on-call rotation should take place. | +| <a id="mutationoncallrotationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallrotationcreateendsat"></a>`endsAt` | [`OncallRotationDateInputType`](#oncallrotationdateinputtype) | The end date and time of the on-call rotation, in the timezone of the on-call schedule. | +| <a id="mutationoncallrotationcreatename"></a>`name` | [`String!`](#string) | The name of the on-call rotation. | +| <a id="mutationoncallrotationcreateparticipants"></a>`participants` | [`[OncallUserInputType!]!`](#oncalluserinputtype) | The usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. | +| <a id="mutationoncallrotationcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to create the on-call schedule in. | +| <a id="mutationoncallrotationcreaterotationlength"></a>`rotationLength` | [`OncallRotationLengthInputType!`](#oncallrotationlengthinputtype) | The rotation length of the on-call rotation. | +| <a id="mutationoncallrotationcreatescheduleiid"></a>`scheduleIid` | [`String!`](#string) | The IID of the on-call schedule to create the on-call rotation in. | +| <a id="mutationoncallrotationcreatestartsat"></a>`startsAt` | [`OncallRotationDateInputType!`](#oncallrotationdateinputtype) | The start date and time of the on-call rotation, in the timezone of the on-call schedule. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallrotationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallrotationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationoncallrotationcreateoncallrotation"></a>`oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The on-call rotation. | + +### `Mutation.oncallRotationDestroy` + +Input type: `OncallRotationDestroyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallrotationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallrotationdestroyid"></a>`id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | The ID of the on-call rotation to remove. | +| <a id="mutationoncallrotationdestroyprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to remove the on-call schedule from. | +| <a id="mutationoncallrotationdestroyscheduleiid"></a>`scheduleIid` | [`String!`](#string) | The IID of the on-call schedule to the on-call rotation belongs to. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallrotationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallrotationdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationoncallrotationdestroyoncallrotation"></a>`oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The on-call rotation. | + +### `Mutation.oncallRotationUpdate` + +Input type: `OncallRotationUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallrotationupdateactiveperiod"></a>`activePeriod` | [`OncallRotationActivePeriodInputType`](#oncallrotationactiveperiodinputtype) | The active period of time that the on-call rotation should take place. | +| <a id="mutationoncallrotationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallrotationupdateendsat"></a>`endsAt` | [`OncallRotationDateInputType`](#oncallrotationdateinputtype) | The end date and time of the on-call rotation, in the timezone of the on-call schedule. | +| <a id="mutationoncallrotationupdateid"></a>`id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | The ID of the on-call schedule to create the on-call rotation in. | +| <a id="mutationoncallrotationupdatename"></a>`name` | [`String`](#string) | The name of the on-call rotation. | +| <a id="mutationoncallrotationupdateparticipants"></a>`participants` | [`[OncallUserInputType!]`](#oncalluserinputtype) | The usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. | +| <a id="mutationoncallrotationupdaterotationlength"></a>`rotationLength` | [`OncallRotationLengthInputType`](#oncallrotationlengthinputtype) | The rotation length of the on-call rotation. | +| <a id="mutationoncallrotationupdatestartsat"></a>`startsAt` | [`OncallRotationDateInputType`](#oncallrotationdateinputtype) | The start date and time of the on-call rotation, in the timezone of the on-call schedule. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallrotationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallrotationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationoncallrotationupdateoncallrotation"></a>`oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The on-call rotation. | + +### `Mutation.oncallScheduleCreate` + +Input type: `OncallScheduleCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallschedulecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallschedulecreatedescription"></a>`description` | [`String`](#string) | The description of the on-call schedule. | +| <a id="mutationoncallschedulecreatename"></a>`name` | [`String!`](#string) | The name of the on-call schedule. | +| <a id="mutationoncallschedulecreateprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to create the on-call schedule in. | +| <a id="mutationoncallschedulecreatetimezone"></a>`timezone` | [`String!`](#string) | The timezone of the on-call schedule. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallschedulecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallschedulecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationoncallschedulecreateoncallschedule"></a>`oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The on-call schedule. | + +### `Mutation.oncallScheduleDestroy` + +Input type: `OncallScheduleDestroyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallscheduledestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallscheduledestroyiid"></a>`iid` | [`String!`](#string) | The on-call schedule internal ID to remove. | +| <a id="mutationoncallscheduledestroyprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to remove the on-call schedule from. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallscheduledestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallscheduledestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationoncallscheduledestroyoncallschedule"></a>`oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The on-call schedule. | + +### `Mutation.oncallScheduleUpdate` + +Input type: `OncallScheduleUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallscheduleupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallscheduleupdatedescription"></a>`description` | [`String`](#string) | The description of the on-call schedule. | +| <a id="mutationoncallscheduleupdateiid"></a>`iid` | [`String!`](#string) | The on-call schedule internal ID to update. | +| <a id="mutationoncallscheduleupdatename"></a>`name` | [`String`](#string) | The name of the on-call schedule. | +| <a id="mutationoncallscheduleupdateprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to update the on-call schedule in. | +| <a id="mutationoncallscheduleupdatetimezone"></a>`timezone` | [`String`](#string) | The timezone of the on-call schedule. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationoncallscheduleupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationoncallscheduleupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationoncallscheduleupdateoncallschedule"></a>`oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The on-call schedule. | + +### `Mutation.pipelineCancel` + +Input type: `PipelineCancelInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationpipelinecancelclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationpipelinecancelid"></a>`id` | [`CiPipelineID!`](#cipipelineid) | The ID of the pipeline to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationpipelinecancelclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationpipelinecancelerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.pipelineDestroy` + +Input type: `PipelineDestroyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationpipelinedestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationpipelinedestroyid"></a>`id` | [`CiPipelineID!`](#cipipelineid) | The ID of the pipeline to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationpipelinedestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationpipelinedestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.pipelineRetry` + +Input type: `PipelineRetryInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationpipelineretryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationpipelineretryid"></a>`id` | [`CiPipelineID!`](#cipipelineid) | The ID of the pipeline to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationpipelineretryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationpipelineretryerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationpipelineretrypipeline"></a>`pipeline` | [`Pipeline`](#pipeline) | The pipeline after mutation. | + +### `Mutation.prometheusIntegrationCreate` + +Input type: `PrometheusIntegrationCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationprometheusintegrationcreateactive"></a>`active` | [`Boolean!`](#boolean) | Whether the integration is receiving alerts. | +| <a id="mutationprometheusintegrationcreateapiurl"></a>`apiUrl` | [`String!`](#string) | Endpoint at which Prometheus can be queried. | +| <a id="mutationprometheusintegrationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationprometheusintegrationcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | The project to create the integration in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationprometheusintegrationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationprometheusintegrationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationprometheusintegrationcreateintegration"></a>`integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | The newly created integration. | + +### `Mutation.prometheusIntegrationResetToken` + +Input type: `PrometheusIntegrationResetTokenInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationprometheusintegrationresettokenclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationprometheusintegrationresettokenid"></a>`id` | [`PrometheusServiceID!`](#prometheusserviceid) | The ID of the integration to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationprometheusintegrationresettokenclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationprometheusintegrationresettokenerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationprometheusintegrationresettokenintegration"></a>`integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | The newly created integration. | + +### `Mutation.prometheusIntegrationUpdate` + +Input type: `PrometheusIntegrationUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationprometheusintegrationupdateactive"></a>`active` | [`Boolean`](#boolean) | Whether the integration is receiving alerts. | +| <a id="mutationprometheusintegrationupdateapiurl"></a>`apiUrl` | [`String`](#string) | Endpoint at which Prometheus can be queried. | +| <a id="mutationprometheusintegrationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationprometheusintegrationupdateid"></a>`id` | [`PrometheusServiceID!`](#prometheusserviceid) | The ID of the integration to mutate. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationprometheusintegrationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationprometheusintegrationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationprometheusintegrationupdateintegration"></a>`integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | The newly created integration. | + +### `Mutation.promoteToEpic` + +Input type: `PromoteToEpicInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationpromotetoepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationpromotetoepicgrouppath"></a>`groupPath` | [`ID`](#id) | The group the promoted epic will belong to. | +| <a id="mutationpromotetoepiciid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationpromotetoepicprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationpromotetoepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationpromotetoepicepic"></a>`epic` | [`Epic`](#epic) | The epic after issue promotion. | +| <a id="mutationpromotetoepicerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationpromotetoepicissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.releaseAssetLinkCreate` + +Input type: `ReleaseAssetLinkCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleaseassetlinkcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleaseassetlinkcreatedirectassetpath"></a>`directAssetPath` | [`String`](#string) | Relative path for a direct asset link. | +| <a id="mutationreleaseassetlinkcreatelinktype"></a>`linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | The type of the asset link. | +| <a id="mutationreleaseassetlinkcreatename"></a>`name` | [`String!`](#string) | Name of the asset link. | +| <a id="mutationreleaseassetlinkcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the asset link is associated with. | +| <a id="mutationreleaseassetlinkcreatetagname"></a>`tagName` | [`String!`](#string) | Name of the associated release's tag. | +| <a id="mutationreleaseassetlinkcreateurl"></a>`url` | [`String!`](#string) | URL of the asset link. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleaseassetlinkcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleaseassetlinkcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationreleaseassetlinkcreatelink"></a>`link` | [`ReleaseAssetLink`](#releaseassetlink) | The asset link after mutation. | + +### `Mutation.releaseAssetLinkDelete` + +Input type: `ReleaseAssetLinkDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleaseassetlinkdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleaseassetlinkdeleteid"></a>`id` | [`ReleasesLinkID!`](#releaseslinkid) | ID of the release asset link to delete. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleaseassetlinkdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleaseassetlinkdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationreleaseassetlinkdeletelink"></a>`link` | [`ReleaseAssetLink`](#releaseassetlink) | The deleted release asset link. | + +### `Mutation.releaseAssetLinkUpdate` + +Input type: `ReleaseAssetLinkUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleaseassetlinkupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleaseassetlinkupdatedirectassetpath"></a>`directAssetPath` | [`String`](#string) | Relative path for a direct asset link. | +| <a id="mutationreleaseassetlinkupdateid"></a>`id` | [`ReleasesLinkID!`](#releaseslinkid) | ID of the release asset link to update. | +| <a id="mutationreleaseassetlinkupdatelinktype"></a>`linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | The type of the asset link. | +| <a id="mutationreleaseassetlinkupdatename"></a>`name` | [`String`](#string) | Name of the asset link. | +| <a id="mutationreleaseassetlinkupdateurl"></a>`url` | [`String`](#string) | URL of the asset link. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleaseassetlinkupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleaseassetlinkupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationreleaseassetlinkupdatelink"></a>`link` | [`ReleaseAssetLink`](#releaseassetlink) | The asset link after mutation. | + +### `Mutation.releaseCreate` + +Input type: `ReleaseCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleasecreateassets"></a>`assets` | [`ReleaseAssetsInput`](#releaseassetsinput) | Assets associated to the release. | +| <a id="mutationreleasecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleasecreatedescription"></a>`description` | [`String`](#string) | Description (also known as "release notes") of the release. | +| <a id="mutationreleasecreatemilestones"></a>`milestones` | [`[String!]`](#string) | The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. | +| <a id="mutationreleasecreatename"></a>`name` | [`String`](#string) | Name of the release. | +| <a id="mutationreleasecreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the release is associated with. | +| <a id="mutationreleasecreateref"></a>`ref` | [`String`](#string) | The commit SHA or branch name to use if creating a new tag. | +| <a id="mutationreleasecreatereleasedat"></a>`releasedAt` | [`Time`](#time) | The date when the release will be/was ready. Defaults to the current time. | +| <a id="mutationreleasecreatetagname"></a>`tagName` | [`String!`](#string) | Name of the tag to associate with the release. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleasecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleasecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationreleasecreaterelease"></a>`release` | [`Release`](#release) | The release after mutation. | + +### `Mutation.releaseDelete` + +Input type: `ReleaseDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleasedeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleasedeleteprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the release is associated with. | +| <a id="mutationreleasedeletetagname"></a>`tagName` | [`String!`](#string) | Name of the tag associated with the release to delete. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleasedeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleasedeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationreleasedeleterelease"></a>`release` | [`Release`](#release) | The deleted release. | + +### `Mutation.releaseUpdate` + +Input type: `ReleaseUpdateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleaseupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleaseupdatedescription"></a>`description` | [`String`](#string) | Description (release notes) of the release. | +| <a id="mutationreleaseupdatemilestones"></a>`milestones` | [`[String!]`](#string) | The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. | +| <a id="mutationreleaseupdatename"></a>`name` | [`String`](#string) | Name of the release. | +| <a id="mutationreleaseupdateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the release is associated with. | +| <a id="mutationreleaseupdatereleasedat"></a>`releasedAt` | [`Time`](#time) | The release date. | +| <a id="mutationreleaseupdatetagname"></a>`tagName` | [`String!`](#string) | Name of the tag associated with the release. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationreleaseupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationreleaseupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationreleaseupdaterelease"></a>`release` | [`Release`](#release) | The release after mutation. | + +### `Mutation.removeAwardEmoji` + +WARNING: +**Deprecated** in 13.2. +Use awardEmojiRemove. + +Input type: `RemoveAwardEmojiInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationremoveawardemojiawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | The global ID of the awardable resource. | +| <a id="mutationremoveawardemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationremoveawardemojiname"></a>`name` | [`String!`](#string) | The emoji name. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationremoveawardemojiawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | +| <a id="mutationremoveawardemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationremoveawardemojierrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.removeProjectFromSecurityDashboard` + +Input type: `RemoveProjectFromSecurityDashboardInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationremoveprojectfromsecuritydashboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationremoveprojectfromsecuritydashboardid"></a>`id` | [`ProjectID!`](#projectid) | ID of the project to remove from the Instance Security Dashboard. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationremoveprojectfromsecuritydashboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationremoveprojectfromsecuritydashboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.repositionImageDiffNote` + +Repositions a DiffNote on an image (a `Note` where the `position.positionType` is `"image"`). + +Input type: `RepositionImageDiffNoteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationrepositionimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationrepositionimagediffnoteid"></a>`id` | [`DiffNoteID!`](#diffnoteid) | The global ID of the DiffNote to update. | +| <a id="mutationrepositionimagediffnoteposition"></a>`position` | [`UpdateDiffImagePositionInput!`](#updatediffimagepositioninput) | The position of this note on a diff. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationrepositionimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationrepositionimagediffnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationrepositionimagediffnotenote"></a>`note` | [`Note`](#note) | The note after mutation. | + +### `Mutation.revertVulnerabilityToDetected` + +WARNING: +**Deprecated** in 13.5. +Use vulnerabilityRevertToDetected. + +Input type: `RevertVulnerabilityToDetectedInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationrevertvulnerabilitytodetectedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationrevertvulnerabilitytodetectedid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be reverted. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationrevertvulnerabilitytodetectedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationrevertvulnerabilitytodetectederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationrevertvulnerabilitytodetectedvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | The vulnerability after revert. | + +### `Mutation.runDastScan` + +WARNING: +**Deprecated** in 13.4. +Use DastOnDemandScanCreate. + +Input type: `RunDASTScanInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationrundastscanbranch"></a>`branch` | [`String!`](#string) | The branch to be associated with the scan. | +| <a id="mutationrundastscanclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationrundastscanprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the DAST scan belongs to. | +| <a id="mutationrundastscanscantype"></a>`scanType` | [`DastScanTypeEnum!`](#dastscantypeenum) | The type of scan to be run. | +| <a id="mutationrundastscantargeturl"></a>`targetUrl` | [`String!`](#string) | The URL of the target to be scanned. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationrundastscanclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationrundastscanerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationrundastscanpipelineurl"></a>`pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. | + +### `Mutation.terraformStateDelete` + +Input type: `TerraformStateDeleteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationterraformstatedeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationterraformstatedeleteid"></a>`id` | [`TerraformStateID!`](#terraformstateid) | Global ID of the Terraform state. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationterraformstatedeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationterraformstatedeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.terraformStateLock` + +Input type: `TerraformStateLockInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationterraformstatelockclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationterraformstatelockid"></a>`id` | [`TerraformStateID!`](#terraformstateid) | Global ID of the Terraform state. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationterraformstatelockclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationterraformstatelockerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.terraformStateUnlock` + +Input type: `TerraformStateUnlockInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationterraformstateunlockclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationterraformstateunlockid"></a>`id` | [`TerraformStateID!`](#terraformstateid) | Global ID of the Terraform state. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationterraformstateunlockclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationterraformstateunlockerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.todoCreate` + +Input type: `TodoCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodocreatetargetid"></a>`targetId` | [`TodoableID!`](#todoableid) | The global ID of the to-do item's parent. Issues, merge requests, designs and epics are supported. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodocreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationtodocreatetodo"></a>`todo` | [`Todo`](#todo) | The to-do item created. | + +### `Mutation.todoMarkDone` + +Input type: `TodoMarkDoneInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodomarkdoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodomarkdoneid"></a>`id` | [`TodoID!`](#todoid) | The global ID of the to-do item to mark as done. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodomarkdoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodomarkdoneerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationtodomarkdonetodo"></a>`todo` | [`Todo!`](#todo) | The requested to-do item. | + +### `Mutation.todoRestore` + +Input type: `TodoRestoreInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodorestoreclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodorestoreid"></a>`id` | [`TodoID!`](#todoid) | The global ID of the to-do item to restore. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodorestoreclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodorestoreerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationtodorestoretodo"></a>`todo` | [`Todo!`](#todo) | The requested to-do item. | + +### `Mutation.todoRestoreMany` + +Input type: `TodoRestoreManyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodorestoremanyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodorestoremanyids"></a>`ids` | [`[TodoID!]!`](#todoid) | The global IDs of the to-do items to restore (a maximum of 50 is supported at once). | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodorestoremanyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodorestoremanyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationtodorestoremanytodos"></a>`todos` | [`[Todo!]!`](#todo) | Updated to-do items. | +| <a id="mutationtodorestoremanyupdatedids"></a>`updatedIds` **{warning-solid}** | [`[TodoID!]!`](#todoid) | **Deprecated:** Use to-do items. Deprecated in 13.2. | + +### `Mutation.todosMarkAllDone` + +Input type: `TodosMarkAllDoneInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodosmarkalldoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtodosmarkalldoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtodosmarkalldoneerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationtodosmarkalldonetodos"></a>`todos` | [`[Todo!]!`](#todo) | Updated to-do items. | +| <a id="mutationtodosmarkalldoneupdatedids"></a>`updatedIds` **{warning-solid}** | [`[TodoID!]!`](#todoid) | **Deprecated:** Use to-do items. Deprecated in 13.2. | + +### `Mutation.toggleAwardEmoji` + +WARNING: +**Deprecated** in 13.2. +Use awardEmojiToggle. + +Input type: `ToggleAwardEmojiInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtoggleawardemojiawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | The global ID of the awardable resource. | +| <a id="mutationtoggleawardemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtoggleawardemojiname"></a>`name` | [`String!`](#string) | The emoji name. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationtoggleawardemojiawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | +| <a id="mutationtoggleawardemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationtoggleawardemojierrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationtoggleawardemojitoggledon"></a>`toggledOn` | [`Boolean!`](#boolean) | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. | + +### `Mutation.updateAlertStatus` + +Input type: `UpdateAlertStatusInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatealertstatusclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatealertstatusiid"></a>`iid` | [`String!`](#string) | The IID of the alert to mutate. | +| <a id="mutationupdatealertstatusprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the alert to mutate is in. | +| <a id="mutationupdatealertstatusstatus"></a>`status` | [`AlertManagementStatus!`](#alertmanagementstatus) | The status to set the alert. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatealertstatusalert"></a>`alert` | [`AlertManagementAlert`](#alertmanagementalert) | The alert after mutation. | +| <a id="mutationupdatealertstatusclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatealertstatuserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdatealertstatusissue"></a>`issue` | [`Issue`](#issue) | The issue created after mutation. | +| <a id="mutationupdatealertstatustodo"></a>`todo` | [`Todo`](#todo) | The to-do item after mutation. | + +### `Mutation.updateBoard` + +Input type: `UpdateBoardInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateboardassigneeid"></a>`assigneeId` | [`UserID`](#userid) | ID of user to be assigned to the board. | +| <a id="mutationupdateboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateboardhidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. | +| <a id="mutationupdateboardhideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. | +| <a id="mutationupdateboardid"></a>`id` | [`BoardID!`](#boardid) | The board global ID. | +| <a id="mutationupdateboarditerationid"></a>`iterationId` | [`IterationID`](#iterationid) | ID of iteration to be assigned to the board. | +| <a id="mutationupdateboardlabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the board. | +| <a id="mutationupdateboardlabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. | +| <a id="mutationupdateboardmilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | ID of milestone to be assigned to the board. | +| <a id="mutationupdateboardname"></a>`name` | [`String`](#string) | The board name. | +| <a id="mutationupdateboardweight"></a>`weight` | [`Int`](#int) | Weight value to be assigned to the board. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateboardboard"></a>`board` | [`Board`](#board) | The board after mutation. | +| <a id="mutationupdateboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.updateBoardEpicUserPreferences` + +Input type: `UpdateBoardEpicUserPreferencesInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateboardepicuserpreferencesboardid"></a>`boardId` | [`BoardID!`](#boardid) | The board global ID. | +| <a id="mutationupdateboardepicuserpreferencesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateboardepicuserpreferencescollapsed"></a>`collapsed` | [`Boolean!`](#boolean) | Whether the epic should be collapsed in the board. | +| <a id="mutationupdateboardepicuserpreferencesepicid"></a>`epicId` | [`EpicID!`](#epicid) | ID of an epic to set preferences for. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateboardepicuserpreferencesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateboardepicuserpreferencesepicuserpreferences"></a>`epicUserPreferences` | [`BoardEpicUserPreferences`](#boardepicuserpreferences) | User preferences for the epic in the board after mutation. | +| <a id="mutationupdateboardepicuserpreferenceserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.updateBoardList` + +Input type: `UpdateBoardListInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateboardlistcollapsed"></a>`collapsed` | [`Boolean`](#boolean) | Indicates if the list is collapsed for this user. | +| <a id="mutationupdateboardlistlistid"></a>`listId` | [`ListID!`](#listid) | Global ID of the list. | +| <a id="mutationupdateboardlistposition"></a>`position` | [`Int`](#int) | Position of list within the board. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateboardlisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdateboardlistlist"></a>`list` | [`BoardList`](#boardlist) | Mutated list. | + +### `Mutation.updateComplianceFramework` + +Input type: `UpdateComplianceFrameworkInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatecomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatecomplianceframeworkid"></a>`id` | [`ComplianceManagementFrameworkID!`](#compliancemanagementframeworkid) | The global ID of the compliance framework to update. | +| <a id="mutationupdatecomplianceframeworkparams"></a>`params` | [`ComplianceFrameworkInput!`](#complianceframeworkinput) | Parameters to update the compliance framework with. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatecomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatecomplianceframeworkcomplianceframework"></a>`complianceFramework` | [`ComplianceFramework`](#complianceframework) | The compliance framework after mutation. | +| <a id="mutationupdatecomplianceframeworkerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.updateContainerExpirationPolicy` + +Input type: `UpdateContainerExpirationPolicyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatecontainerexpirationpolicycadence"></a>`cadence` | [`ContainerExpirationPolicyCadenceEnum`](#containerexpirationpolicycadenceenum) | This container expiration policy schedule. | +| <a id="mutationupdatecontainerexpirationpolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatecontainerexpirationpolicyenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether this container expiration policy is enabled. | +| <a id="mutationupdatecontainerexpirationpolicykeepn"></a>`keepN` | [`ContainerExpirationPolicyKeepEnum`](#containerexpirationpolicykeepenum) | Number of tags to retain. | +| <a id="mutationupdatecontainerexpirationpolicynameregex"></a>`nameRegex` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will expire. | +| <a id="mutationupdatecontainerexpirationpolicynameregexkeep"></a>`nameRegexKeep` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will be preserved. | +| <a id="mutationupdatecontainerexpirationpolicyolderthan"></a>`olderThan` | [`ContainerExpirationPolicyOlderThanEnum`](#containerexpirationpolicyolderthanenum) | Tags older that this will expire. | +| <a id="mutationupdatecontainerexpirationpolicyprojectpath"></a>`projectPath` | [`ID!`](#id) | The project path where the container expiration policy is located. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatecontainerexpirationpolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatecontainerexpirationpolicycontainerexpirationpolicy"></a>`containerExpirationPolicy` | [`ContainerExpirationPolicy`](#containerexpirationpolicy) | The container expiration policy after mutation. | +| <a id="mutationupdatecontainerexpirationpolicyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.updateEpic` + +Input type: `UpdateEpicInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateepicaddlabelids"></a>`addLabelIds` | [`[ID!]`](#id) | The IDs of labels to be added to the epic. | +| <a id="mutationupdateepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateepicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. | +| <a id="mutationupdateepicdescription"></a>`description` | [`String`](#string) | The description of the epic. | +| <a id="mutationupdateepicduedatefixed"></a>`dueDateFixed` | [`String`](#string) | The end date of the epic. | +| <a id="mutationupdateepicduedateisfixed"></a>`dueDateIsFixed` | [`Boolean`](#boolean) | Indicates end date should be sourced from due_date_fixed field not the issue milestones. | +| <a id="mutationupdateepicgrouppath"></a>`groupPath` | [`ID!`](#id) | The group the epic to mutate is in. | +| <a id="mutationupdateepiciid"></a>`iid` | [`ID!`](#id) | The IID of the epic to mutate. | +| <a id="mutationupdateepicremovelabelids"></a>`removeLabelIds` | [`[ID!]`](#id) | The IDs of labels to be removed from the epic. | +| <a id="mutationupdateepicstartdatefixed"></a>`startDateFixed` | [`String`](#string) | The start date of the epic. | +| <a id="mutationupdateepicstartdateisfixed"></a>`startDateIsFixed` | [`Boolean`](#boolean) | Indicates start date should be sourced from start_date_fixed field not the issue milestones. | +| <a id="mutationupdateepicstateevent"></a>`stateEvent` | [`EpicStateEvent`](#epicstateevent) | State event for the epic. | +| <a id="mutationupdateepictitle"></a>`title` | [`String`](#string) | The title of the epic. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateepicepic"></a>`epic` | [`Epic`](#epic) | The epic after mutation. | +| <a id="mutationupdateepicerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.updateEpicBoardList` + +Input type: `UpdateEpicBoardListInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateepicboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateepicboardlistcollapsed"></a>`collapsed` | [`Boolean`](#boolean) | Indicates if the list is collapsed for this user. | +| <a id="mutationupdateepicboardlistlistid"></a>`listId` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the epic list. | +| <a id="mutationupdateepicboardlistposition"></a>`position` | [`Int`](#int) | Position of list within the board. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateepicboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateepicboardlisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdateepicboardlistlist"></a>`list` | [`EpicList`](#epiclist) | Mutated epic list. | + +### `Mutation.updateImageDiffNote` + +Updates a DiffNote on an image (a `Note` where the `position.positionType` is `"image"`). +If the body of the Note contains only quick actions, +the Note will be destroyed during the update, and no Note will be +returned. + +Input type: `UpdateImageDiffNoteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateimagediffnotebody"></a>`body` | [`String`](#string) | Content of the note. | +| <a id="mutationupdateimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateimagediffnoteid"></a>`id` | [`NoteID!`](#noteid) | The global ID of the note to update. | +| <a id="mutationupdateimagediffnoteposition"></a>`position` | [`UpdateDiffImagePositionInput`](#updatediffimagepositioninput) | The position of this note on a diff. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateimagediffnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdateimagediffnotenote"></a>`note` | [`Note`](#note) | The note after mutation. | + +### `Mutation.updateIssue` + +Input type: `UpdateIssueInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateissueaddlabelids"></a>`addLabelIds` | [`[ID!]`](#id) | The IDs of labels to be added to the issue. | +| <a id="mutationupdateissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateissueconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates the issue is confidential. | +| <a id="mutationupdateissuedescription"></a>`description` | [`String`](#string) | Description of the issue. | +| <a id="mutationupdateissueduedate"></a>`dueDate` | [`ISO8601Date`](#iso8601date) | Due date of the issue. | +| <a id="mutationupdateissueepicid"></a>`epicId` | [`EpicID`](#epicid) | The ID of the parent epic. NULL when removing the association. | +| <a id="mutationupdateissuehealthstatus"></a>`healthStatus` | [`HealthStatus`](#healthstatus) | The desired health status. | +| <a id="mutationupdateissueiid"></a>`iid` | [`String!`](#string) | The IID of the issue to mutate. | +| <a id="mutationupdateissuelocked"></a>`locked` | [`Boolean`](#boolean) | Indicates discussion is locked on the issue. | +| <a id="mutationupdateissuemilestoneid"></a>`milestoneId` | [`ID`](#id) | The ID of the milestone to assign to the issue. On update milestone will be removed if set to null. | +| <a id="mutationupdateissueprojectpath"></a>`projectPath` | [`ID!`](#id) | The project the issue to mutate is in. | +| <a id="mutationupdateissueremovelabelids"></a>`removeLabelIds` | [`[ID!]`](#id) | The IDs of labels to be removed from the issue. | +| <a id="mutationupdateissuestateevent"></a>`stateEvent` | [`IssueStateEvent`](#issuestateevent) | Close or reopen an issue. | +| <a id="mutationupdateissuetitle"></a>`title` | [`String`](#string) | Title of the issue. | +| <a id="mutationupdateissuetype"></a>`type` | [`IssueType`](#issuetype) | Type of the issue. | +| <a id="mutationupdateissueweight"></a>`weight` | [`Int`](#int) | The weight of the issue. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateissueerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdateissueissue"></a>`issue` | [`Issue`](#issue) | The issue after mutation. | + +### `Mutation.updateIteration` + +Input type: `UpdateIterationInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateiterationdescription"></a>`description` | [`String`](#string) | Description of the iteration. | +| <a id="mutationupdateiterationduedate"></a>`dueDate` | [`String`](#string) | End date of the iteration. | +| <a id="mutationupdateiterationgrouppath"></a>`groupPath` | [`ID!`](#id) | Group of the iteration. | +| <a id="mutationupdateiterationid"></a>`id` | [`ID!`](#id) | Global ID of the iteration. | +| <a id="mutationupdateiterationstartdate"></a>`startDate` | [`String`](#string) | Start date of the iteration. | +| <a id="mutationupdateiterationtitle"></a>`title` | [`String`](#string) | Title of the iteration. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdateiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdateiterationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdateiterationiteration"></a>`iteration` | [`Iteration`](#iteration) | Updated iteration. | + +### `Mutation.updateNamespacePackageSettings` + +Input type: `UpdateNamespacePackageSettingsInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatenamespacepackagesettingsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatenamespacepackagesettingsgenericduplicateexceptionregex"></a>`genericDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. | +| <a id="mutationupdatenamespacepackagesettingsgenericduplicatesallowed"></a>`genericDuplicatesAllowed` | [`Boolean`](#boolean) | Indicates whether duplicate generic packages are allowed for this namespace. | +| <a id="mutationupdatenamespacepackagesettingsmavenduplicateexceptionregex"></a>`mavenDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. | +| <a id="mutationupdatenamespacepackagesettingsmavenduplicatesallowed"></a>`mavenDuplicatesAllowed` | [`Boolean`](#boolean) | Indicates whether duplicate Maven packages are allowed for this namespace. | +| <a id="mutationupdatenamespacepackagesettingsnamespacepath"></a>`namespacePath` | [`ID!`](#id) | The namespace path where the namespace package setting is located. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatenamespacepackagesettingsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatenamespacepackagesettingserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdatenamespacepackagesettingspackagesettings"></a>`packageSettings` | [`PackageSettings`](#packagesettings) | The namespace package setting after mutation. | + +### `Mutation.updateNote` + +Updates a Note. +If the body of the Note contains only quick actions, +the Note will be destroyed during the update, and no Note will be +returned. + +Input type: `UpdateNoteInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatenotebody"></a>`body` | [`String`](#string) | Content of the note. | +| <a id="mutationupdatenoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatenoteconfidential"></a>`confidential` | [`Boolean`](#boolean) | The confidentiality flag of a note. Default is false. | +| <a id="mutationupdatenoteid"></a>`id` | [`NoteID!`](#noteid) | The global ID of the note to update. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatenoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatenoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdatenotenote"></a>`note` | [`Note`](#note) | The note after mutation. | + +### `Mutation.updateRequirement` + +Input type: `UpdateRequirementInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdaterequirementclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdaterequirementdescription"></a>`description` | [`String`](#string) | Description of the requirement. | +| <a id="mutationupdaterequirementiid"></a>`iid` | [`String!`](#string) | The IID of the requirement to update. | +| <a id="mutationupdaterequirementlasttestreportstate"></a>`lastTestReportState` | [`TestReportState`](#testreportstate) | Creates a test report for the requirement with the given state. | +| <a id="mutationupdaterequirementprojectpath"></a>`projectPath` | [`ID!`](#id) | Full project path the requirement is associated with. | +| <a id="mutationupdaterequirementstate"></a>`state` | [`RequirementState`](#requirementstate) | State of the requirement. | +| <a id="mutationupdaterequirementtitle"></a>`title` | [`String`](#string) | Title of the requirement. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdaterequirementclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdaterequirementerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdaterequirementrequirement"></a>`requirement` | [`Requirement`](#requirement) | Requirement after mutation. | + +### `Mutation.updateSnippet` + +Input type: `UpdateSnippetInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatesnippetblobactions"></a>`blobActions` | [`[SnippetBlobActionInputType!]`](#snippetblobactioninputtype) | Actions to perform over the snippet repository and blobs. | +| <a id="mutationupdatesnippetcaptcharesponse"></a>`captchaResponse` **{warning-solid}** | [`String`](#string) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationupdatesnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatesnippetdescription"></a>`description` | [`String`](#string) | Description of the snippet. | +| <a id="mutationupdatesnippetid"></a>`id` | [`SnippetID!`](#snippetid) | The global ID of the snippet to update. | +| <a id="mutationupdatesnippetspamlogid"></a>`spamLogId` **{warning-solid}** | [`Int`](#int) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationupdatesnippettitle"></a>`title` | [`String`](#string) | Title of the snippet. | +| <a id="mutationupdatesnippetvisibilitylevel"></a>`visibilityLevel` | [`VisibilityLevelsEnum`](#visibilitylevelsenum) | The visibility level of the snippet. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationupdatesnippetcaptchasitekey"></a>`captchaSiteKey` **{warning-solid}** | [`String`](#string) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationupdatesnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationupdatesnippeterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationupdatesnippetneedscaptcharesponse"></a>`needsCaptchaResponse` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationupdatesnippetsnippet"></a>`snippet` | [`Snippet`](#snippet) | The snippet after mutation. | +| <a id="mutationupdatesnippetspam"></a>`spam` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | +| <a id="mutationupdatesnippetspamlogid"></a>`spamLogId` **{warning-solid}** | [`Int`](#int) | **Deprecated:** Use spam protection with HTTP headers instead. Deprecated in 13.11. | + +### `Mutation.userCalloutCreate` + +Input type: `UserCalloutCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationusercalloutcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationusercalloutcreatefeaturename"></a>`featureName` | [`String!`](#string) | The feature name you want to dismiss the callout for. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationusercalloutcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationusercalloutcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationusercalloutcreateusercallout"></a>`userCallout` | [`UserCallout!`](#usercallout) | The user callout dismissed. | + +### `Mutation.vulnerabilityConfirm` + +Input type: `VulnerabilityConfirmInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityconfirmclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityconfirmid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be confirmed. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityconfirmclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityconfirmerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationvulnerabilityconfirmvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | The vulnerability after state change. | + +### `Mutation.vulnerabilityDismiss` + +Input type: `VulnerabilityDismissInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilitydismissclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilitydismisscomment"></a>`comment` | [`String`](#string) | Comment why vulnerability should be dismissed. | +| <a id="mutationvulnerabilitydismissdismissalreason"></a>`dismissalReason` | [`VulnerabilityDismissalReason`](#vulnerabilitydismissalreason) | Reason why vulnerability should be dismissed. | +| <a id="mutationvulnerabilitydismissid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be dismissed. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilitydismissclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilitydismisserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationvulnerabilitydismissvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | The vulnerability after dismissal. | + +### `Mutation.vulnerabilityExternalIssueLinkCreate` + +Input type: `VulnerabilityExternalIssueLinkCreateInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityexternalissuelinkcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityexternalissuelinkcreateexternaltracker"></a>`externalTracker` | [`VulnerabilityExternalIssueLinkExternalTracker!`](#vulnerabilityexternalissuelinkexternaltracker) | External tracker type of the external issue link. | +| <a id="mutationvulnerabilityexternalissuelinkcreateid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability. | +| <a id="mutationvulnerabilityexternalissuelinkcreatelinktype"></a>`linkType` | [`VulnerabilityExternalIssueLinkType!`](#vulnerabilityexternalissuelinktype) | Type of the external issue link. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityexternalissuelinkcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityexternalissuelinkcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationvulnerabilityexternalissuelinkcreateexternalissuelink"></a>`externalIssueLink` | [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink) | The created external issue link. | + +### `Mutation.vulnerabilityExternalIssueLinkDestroy` + +Input type: `VulnerabilityExternalIssueLinkDestroyInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityexternalissuelinkdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityexternalissuelinkdestroyid"></a>`id` | [`VulnerabilitiesExternalIssueLinkID!`](#vulnerabilitiesexternalissuelinkid) | The global ID of the vulnerability external issue link. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityexternalissuelinkdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityexternalissuelinkdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | + +### `Mutation.vulnerabilityResolve` + +Input type: `VulnerabilityResolveInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityresolveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityresolveid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be resolved. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityresolveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityresolveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationvulnerabilityresolvevulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | The vulnerability after state change. | + +### `Mutation.vulnerabilityRevertToDetected` + +Input type: `VulnerabilityRevertToDetectedInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityreverttodetectedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityreverttodetectedid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be reverted. | + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mutationvulnerabilityreverttodetectedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="mutationvulnerabilityreverttodetectederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="mutationvulnerabilityreverttodetectedvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | The vulnerability after revert. | + +## Connections + +Some types in our schema are `Connection` types - they represent a paginated +collection of edges between two nodes in the graph. These follow the +[Relay cursor connections specification](https://relay.dev/graphql/connections.htm). + +### Pagination arguments {#connection-pagination-arguments} + +All connection fields support the following pagination arguments: + +| Name | Type | Description | +|------|------|-------------| | `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. | | `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. | -| `endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. | | `first` | [`Int`](#int) | Returns the first _n_ elements from the list. | | `last` | [`Int`](#int) | Returns the last _n_ elements from the list. | -| `startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. | -### `vulnerability` +Since these arguments are common to all connection fields, they are not repeated for each connection. -Find a vulnerability. +### Connection fields -Returns [`Vulnerability`](#vulnerability). +All connections have at least the following fields: -#### Arguments +| Name | Type | Description | +|------|------|-------------| +| `pageInfo` | [`PageInfo!`](#pageinfo) | Pagination information. | +| `edges` | `[edge!]` | The edges. | +| `nodes` | `[item!]` | The items in the current page. | + +The precise type of `Edge` and `Item` depends on the kind of connection. A +[`ProjectConnection`](#projectconnection) will have nodes that have the type +[`[Project!]`](#project), and edges that have the type [`ProjectEdge`](#projectedge). + +### Connection types + +Some of the types in the schema exist solely to model connections. Each connection +has a distinct, named type, with a distinct named edge type. These are listed separately +below. + +#### `AlertManagementAlertConnection` + +The connection type for [`AlertManagementAlert`](#alertmanagementalert). + +##### Fields | Name | Type | Description | | ---- | ---- | ----------- | -| `id` | [`VulnerabilityID!`](#vulnerabilityid) | The Global ID of the Vulnerability. | +| <a id="alertmanagementalertconnectionedges"></a>`edges` | [`[AlertManagementAlertEdge]`](#alertmanagementalertedge) | A list of edges. | +| <a id="alertmanagementalertconnectionnodes"></a>`nodes` | [`[AlertManagementAlert]`](#alertmanagementalert) | A list of nodes. | +| <a id="alertmanagementalertconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -## Object types +#### `AlertManagementAlertEdge` -Object types represent the resources that the GitLab GraphQL API can return. -They contain _fields_. Each field has its own type, which will either be one of the -basic GraphQL [scalar types](https://graphql.org/learn/schema/#scalar-types) -(e.g.: `String` or `Boolean`) or other object types. +The edge type for [`AlertManagementAlert`](#alertmanagementalert). -For more information, see -[Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields) -on `graphql.org`. +##### Fields -### `AccessLevel` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementalertedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="alertmanagementalertedgenode"></a>`node` | [`AlertManagementAlert`](#alertmanagementalert) | The item at the end of the edge. | -Represents the access level of a relationship between a User and object that it is related to. +#### `AlertManagementHttpIntegrationConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `integerValue` | [`Int`](#int) | Integer representation of access level. | -| `stringValue` | [`AccessLevelEnum`](#accesslevelenum) | String representation of access level. | +The connection type for [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration). -### `AddAwardEmojiPayload` +##### Fields -Autogenerated return type of AddAwardEmoji. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementhttpintegrationconnectionedges"></a>`edges` | [`[AlertManagementHttpIntegrationEdge]`](#alertmanagementhttpintegrationedge) | A list of edges. | +| <a id="alertmanagementhttpintegrationconnectionnodes"></a>`nodes` | [`[AlertManagementHttpIntegration]`](#alertmanagementhttpintegration) | A list of nodes. | +| <a id="alertmanagementhttpintegrationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### `AlertManagementHttpIntegrationEdge` -### `AddProjectToSecurityDashboardPayload` +The edge type for [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration). -Autogenerated return type of AddProjectToSecurityDashboard. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `project` | [`Project`](#project) | Project that was added to the Instance Security Dashboard. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementhttpintegrationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="alertmanagementhttpintegrationedgenode"></a>`node` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The item at the end of the edge. | -### `AdminSidekiqQueuesDeleteJobsPayload` +#### `AlertManagementIntegrationConnection` -Autogenerated return type of AdminSidekiqQueuesDeleteJobs. +The connection type for [`AlertManagementIntegration`](#alertmanagementintegration). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `result` | [`DeleteJobsResponse`](#deletejobsresponse) | Information about the status of the deletion request. | +##### Fields -### `AlertManagementAlert` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementintegrationconnectionedges"></a>`edges` | [`[AlertManagementIntegrationEdge]`](#alertmanagementintegrationedge) | A list of edges. | +| <a id="alertmanagementintegrationconnectionnodes"></a>`nodes` | [`[AlertManagementIntegration]`](#alertmanagementintegration) | A list of nodes. | +| <a id="alertmanagementintegrationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Describes an alert from the project's Alert Management. +#### `AlertManagementIntegrationEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `assignees` | [`UserConnection`](#userconnection) | Assignees of the alert. | -| `createdAt` | [`Time`](#time) | Timestamp the alert was created. | -| `description` | [`String`](#string) | Description of the alert. | -| `details` | [`JSON`](#json) | Alert details. | -| `detailsUrl` | [`String!`](#string) | The URL of the alert detail page. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `endedAt` | [`Time`](#time) | Timestamp the alert ended. | -| `environment` | [`Environment`](#environment) | Environment for the alert. | -| `eventCount` | [`Int`](#int) | Number of events of this alert. | -| `hosts` | [`[String!]`](#string) | List of hosts the alert came from. | -| `iid` | [`ID!`](#id) | Internal ID of the alert. | -| `issue` | [`Issue`](#issue) | Issue attached to the alert. | -| `issueIid` **{warning-solid}** | [`ID`](#id) | **Deprecated** in 13.10. Use issue field. | -| `metricsDashboardUrl` | [`String`](#string) | URL for metrics embed for the alert. | -| `monitoringTool` | [`String`](#string) | Monitoring tool the alert came from. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `prometheusAlert` | [`PrometheusAlert`](#prometheusalert) | The alert condition for Prometheus. | -| `runbook` | [`String`](#string) | Runbook for the alert as defined in alert details. | -| `service` | [`String`](#string) | Service the alert came from. | -| `severity` | [`AlertManagementSeverity`](#alertmanagementseverity) | Severity of the alert. | -| `startedAt` | [`Time`](#time) | Timestamp the alert was raised. | -| `status` | [`AlertManagementStatus`](#alertmanagementstatus) | Status of the alert. | -| `title` | [`String`](#string) | Title of the alert. | -| `todos` | [`TodoConnection`](#todoconnection) | To-do items of the current user for the alert. | -| `updatedAt` | [`Time`](#time) | Timestamp the alert was last updated. | - -### `AlertManagementAlertConnection` - -The connection type for AlertManagementAlert. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[AlertManagementAlertEdge]`](#alertmanagementalertedge) | A list of edges. | -| `nodes` | [`[AlertManagementAlert]`](#alertmanagementalert) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `AlertManagementAlertEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`AlertManagementAlert`](#alertmanagementalert) | The item at the end of the edge. | +The edge type for [`AlertManagementIntegration`](#alertmanagementintegration). -### `AlertManagementAlertStatusCountsType` +##### Fields -Represents total number of alerts for the represented categories. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementintegrationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="alertmanagementintegrationedgenode"></a>`node` | [`AlertManagementIntegration`](#alertmanagementintegration) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `acknowledged` | [`Int`](#int) | Number of alerts with status ACKNOWLEDGED for the project. | -| `all` | [`Int`](#int) | Total number of alerts for the project. | -| `ignored` | [`Int`](#int) | Number of alerts with status IGNORED for the project. | -| `open` | [`Int`](#int) | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project. | -| `resolved` | [`Int`](#int) | Number of alerts with status RESOLVED for the project. | -| `triggered` | [`Int`](#int) | Number of alerts with status TRIGGERED for the project. | +#### `AwardEmojiConnection` -### `AlertManagementHttpIntegration` +The connection type for [`AwardEmoji`](#awardemoji). -An endpoint and credentials used to accept alerts for a project. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. | -| `apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | -| `id` | [`ID!`](#id) | ID of the integration. | -| `name` | [`String`](#string) | Name of the integration. | -| `payloadAlertFields` | [`[AlertManagementPayloadAlertField!]`](#alertmanagementpayloadalertfield) | Extract alert fields from payload example for custom mapping. | -| `payloadAttributeMappings` | [`[AlertManagementPayloadAlertMappingField!]`](#alertmanagementpayloadalertmappingfield) | The custom mapping of GitLab alert attributes to fields from the payload_example. | -| `payloadExample` | [`JsonString`](#jsonstring) | The example of an alert payload. | -| `token` | [`String`](#string) | Token used to authenticate alert notification requests. | -| `type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. | -| `url` | [`String`](#string) | Endpoint which accepts alert notifications. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="awardemojiconnectionedges"></a>`edges` | [`[AwardEmojiEdge]`](#awardemojiedge) | A list of edges. | +| <a id="awardemojiconnectionnodes"></a>`nodes` | [`[AwardEmoji]`](#awardemoji) | A list of nodes. | +| <a id="awardemojiconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `AlertManagementHttpIntegrationConnection` +#### `AwardEmojiEdge` -The connection type for AlertManagementHttpIntegration. +The edge type for [`AwardEmoji`](#awardemoji). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[AlertManagementHttpIntegrationEdge]`](#alertmanagementhttpintegrationedge) | A list of edges. | -| `nodes` | [`[AlertManagementHttpIntegration]`](#alertmanagementhttpintegration) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `AlertManagementHttpIntegrationEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="awardemojiedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="awardemojiedgenode"></a>`node` | [`AwardEmoji`](#awardemoji) | The item at the end of the edge. | -An edge in a connection. +#### `BlobConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The item at the end of the edge. | +The connection type for [`Blob`](#blob). -### `AlertManagementIntegrationConnection` +##### Fields -The connection type for AlertManagementIntegration. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="blobconnectionedges"></a>`edges` | [`[BlobEdge]`](#blobedge) | A list of edges. | +| <a id="blobconnectionnodes"></a>`nodes` | [`[Blob]`](#blob) | A list of nodes. | +| <a id="blobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[AlertManagementIntegrationEdge]`](#alertmanagementintegrationedge) | A list of edges. | -| `nodes` | [`[AlertManagementIntegration]`](#alertmanagementintegration) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### `BlobEdge` -### `AlertManagementIntegrationEdge` +The edge type for [`Blob`](#blob). -An edge in a connection. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`AlertManagementIntegration`](#alertmanagementintegration) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="blobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="blobedgenode"></a>`node` | [`Blob`](#blob) | The item at the end of the edge. | -### `AlertManagementPayloadAlertField` +#### `BoardConnection` -Parsed field from an alert used for custom mappings. +The connection type for [`Board`](#board). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `label` | [`String`](#string) | Human-readable label of the payload path. | -| `path` | [`[PayloadAlertFieldPathSegment!]`](#payloadalertfieldpathsegment) | Path to value inside payload JSON. | -| `type` | [`AlertManagementPayloadAlertFieldType`](#alertmanagementpayloadalertfieldtype) | Type of the parsed value. | +##### Fields -### `AlertManagementPayloadAlertMappingField` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardconnectionedges"></a>`edges` | [`[BoardEdge]`](#boardedge) | A list of edges. | +| <a id="boardconnectionnodes"></a>`nodes` | [`[Board]`](#board) | A list of nodes. | +| <a id="boardconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Parsed field (with its name) from an alert used for custom mappings. +#### `BoardEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `fieldName` | [`AlertManagementPayloadAlertFieldName`](#alertmanagementpayloadalertfieldname) | A GitLab alert field name. | -| `label` | [`String`](#string) | Human-readable label of the payload path. | -| `path` | [`[PayloadAlertFieldPathSegment!]`](#payloadalertfieldpathsegment) | Path to value inside payload JSON. | -| `type` | [`AlertManagementPayloadAlertFieldType`](#alertmanagementpayloadalertfieldtype) | Type of the parsed value. | +The edge type for [`Board`](#board). -### `AlertManagementPrometheusIntegration` +##### Fields -An endpoint and credentials used to accept Prometheus alerts for a project. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="boardedgenode"></a>`node` | [`Board`](#board) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. | -| `apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | -| `id` | [`ID!`](#id) | ID of the integration. | -| `name` | [`String`](#string) | Name of the integration. | -| `token` | [`String`](#string) | Token used to authenticate alert notification requests. | -| `type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. | -| `url` | [`String`](#string) | Endpoint which accepts alert notifications. | +#### `BoardEpicConnection` -### `AlertSetAssigneesPayload` +The connection type for [`BoardEpic`](#boardepic). -Autogenerated return type of AlertSetAssignees. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `alert` | [`AlertManagementAlert`](#alertmanagementalert) | The alert after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue created after mutation. | -| `todo` | [`Todo`](#todo) | The to-do item after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardepicconnectionedges"></a>`edges` | [`[BoardEpicEdge]`](#boardepicedge) | A list of edges. | +| <a id="boardepicconnectionnodes"></a>`nodes` | [`[BoardEpic]`](#boardepic) | A list of nodes. | +| <a id="boardepicconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `AlertTodoCreatePayload` +#### `BoardEpicEdge` -Autogenerated return type of AlertTodoCreate. +The edge type for [`BoardEpic`](#boardepic). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `alert` | [`AlertManagementAlert`](#alertmanagementalert) | The alert after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue created after mutation. | -| `todo` | [`Todo`](#todo) | The to-do item after mutation. | +##### Fields -### `ApiFuzzingCiConfiguration` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardepicedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="boardepicedgenode"></a>`node` | [`BoardEpic`](#boardepic) | The item at the end of the edge. | -Data associated with configuring API fuzzing scans in GitLab CI. +#### `BoardListConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `scanModes` | [`[ApiFuzzingScanMode!]`](#apifuzzingscanmode) | All available scan modes. | -| `scanProfiles` | [`[ApiFuzzingScanProfile!]`](#apifuzzingscanprofile) | All default scan profiles. | +The connection type for [`BoardList`](#boardlist). -### `ApiFuzzingCiConfigurationCreatePayload` +##### Fields -Autogenerated return type of ApiFuzzingCiConfigurationCreate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardlistconnectionedges"></a>`edges` | [`[BoardListEdge]`](#boardlistedge) | A list of edges. | +| <a id="boardlistconnectionnodes"></a>`nodes` | [`[BoardList]`](#boardlist) | A list of nodes. | +| <a id="boardlistconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `configurationYaml` | [`String`](#string) | A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `gitlabCiYamlEditPath` | [`String`](#string) | The location at which the project's `.gitlab-ci.yml` file can be edited in the browser. | +#### `BoardListEdge` -### `ApiFuzzingScanProfile` +The edge type for [`BoardList`](#boardlist). -An API Fuzzing scan profile. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | A short description of the profile. | -| `name` | [`String`](#string) | The unique name of the profile. | -| `yaml` | [`String`](#string) | A syntax highlit HTML representation of the YAML. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardlistedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="boardlistedgenode"></a>`node` | [`BoardList`](#boardlist) | The item at the end of the edge. | -### `ApprovalRule` +#### `CiBuildNeedConnection` -Describes a rule for who can approve merge requests. +The connection type for [`CiBuildNeed`](#cibuildneed). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `id` | [`GlobalID!`](#globalid) | ID of the rule. | -| `name` | [`String`](#string) | Name of the rule. | -| `type` | [`ApprovalRuleType`](#approvalruletype) | Type of the rule. | +##### Fields -### `AwardEmoji` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cibuildneedconnectionedges"></a>`edges` | [`[CiBuildNeedEdge]`](#cibuildneededge) | A list of edges. | +| <a id="cibuildneedconnectionnodes"></a>`nodes` | [`[CiBuildNeed]`](#cibuildneed) | A list of nodes. | +| <a id="cibuildneedconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -An emoji awarded by a user. +#### `CiBuildNeedEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String!`](#string) | The emoji description. | -| `emoji` | [`String!`](#string) | The emoji as an icon. | -| `name` | [`String!`](#string) | The emoji name. | -| `unicode` | [`String!`](#string) | The emoji in Unicode. | -| `unicodeVersion` | [`String!`](#string) | The Unicode version for this emoji. | -| `user` | [`User!`](#user) | The user who awarded the emoji. | +The edge type for [`CiBuildNeed`](#cibuildneed). -### `AwardEmojiAddPayload` +##### Fields -Autogenerated return type of AwardEmojiAdd. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cibuildneededgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="cibuildneededgenode"></a>`node` | [`CiBuildNeed`](#cibuildneed) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### `CiConfigGroupConnection` -### `AwardEmojiConnection` +The connection type for [`CiConfigGroup`](#ciconfiggroup). -The connection type for AwardEmoji. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[AwardEmojiEdge]`](#awardemojiedge) | A list of edges. | -| `nodes` | [`[AwardEmoji]`](#awardemoji) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfiggroupconnectionedges"></a>`edges` | [`[CiConfigGroupEdge]`](#ciconfiggroupedge) | A list of edges. | +| <a id="ciconfiggroupconnectionnodes"></a>`nodes` | [`[CiConfigGroup]`](#ciconfiggroup) | A list of nodes. | +| <a id="ciconfiggroupconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `AwardEmojiEdge` +#### `CiConfigGroupEdge` -An edge in a connection. +The edge type for [`CiConfigGroup`](#ciconfiggroup). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`AwardEmoji`](#awardemoji) | The item at the end of the edge. | +##### Fields -### `AwardEmojiRemovePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfiggroupedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="ciconfiggroupedgenode"></a>`node` | [`CiConfigGroup`](#ciconfiggroup) | The item at the end of the edge. | -Autogenerated return type of AwardEmojiRemove. +#### `CiConfigJobConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +The connection type for [`CiConfigJob`](#ciconfigjob). -### `AwardEmojiTogglePayload` +##### Fields -Autogenerated return type of AwardEmojiToggle. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigjobconnectionedges"></a>`edges` | [`[CiConfigJobEdge]`](#ciconfigjobedge) | A list of edges. | +| <a id="ciconfigjobconnectionnodes"></a>`nodes` | [`[CiConfigJob]`](#ciconfigjob) | A list of nodes. | +| <a id="ciconfigjobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `toggledOn` | [`Boolean!`](#boolean) | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. | +#### `CiConfigJobEdge` -### `BaseService` +The edge type for [`CiConfigJob`](#ciconfigjob). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean`](#boolean) | Indicates if the service is active. | -| `type` | [`String`](#string) | Class name of the service. | +##### Fields -### `Blob` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigjobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="ciconfigjobedgenode"></a>`node` | [`CiConfigJob`](#ciconfigjob) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `flatPath` | [`String!`](#string) | Flat path of the entry. | -| `id` | [`ID!`](#id) | ID of the entry. | -| `lfsOid` | [`String`](#string) | LFS ID of the blob. | -| `mode` | [`String`](#string) | Blob mode in numeric format. | -| `name` | [`String!`](#string) | Name of the entry. | -| `path` | [`String!`](#string) | Path of the entry. | -| `sha` | [`String!`](#string) | Last commit SHA for the entry. | -| `type` | [`EntryType!`](#entrytype) | Type of tree entry. | -| `webPath` | [`String`](#string) | Web path of the blob. | -| `webUrl` | [`String`](#string) | Web URL of the blob. | +#### `CiConfigNeedConnection` -### `BlobConnection` +The connection type for [`CiConfigNeed`](#ciconfigneed). -The connection type for Blob. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[BlobEdge]`](#blobedge) | A list of edges. | -| `nodes` | [`[Blob]`](#blob) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigneedconnectionedges"></a>`edges` | [`[CiConfigNeedEdge]`](#ciconfigneededge) | A list of edges. | +| <a id="ciconfigneedconnectionnodes"></a>`nodes` | [`[CiConfigNeed]`](#ciconfigneed) | A list of nodes. | +| <a id="ciconfigneedconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `BlobEdge` +#### `CiConfigNeedEdge` -An edge in a connection. +The edge type for [`CiConfigNeed`](#ciconfigneed). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Blob`](#blob) | The item at the end of the edge. | +##### Fields -### `Board` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigneededgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="ciconfigneededgenode"></a>`node` | [`CiConfigNeed`](#ciconfigneed) | The item at the end of the edge. | -Represents a project or group issue board. +#### `CiConfigStageConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `assignee` | [`User`](#user) | The board assignee. | -| `createdAt` | [`Time!`](#time) | Timestamp of when the board was created. | -| `epics` | [`BoardEpicConnection`](#boardepicconnection) | Epics associated with board issues. | -| `hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. | -| `hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. | -| `id` | [`ID!`](#id) | ID (global ID) of the board. | -| `iteration` | [`Iteration`](#iteration) | The board iteration. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels of the board. | -| `lists` | [`BoardListConnection`](#boardlistconnection) | Lists of the board. | -| `milestone` | [`Milestone`](#milestone) | The board milestone. | -| `name` | [`String`](#string) | Name of the board. | -| `updatedAt` | [`Time!`](#time) | Timestamp of when the board was last updated. | -| `webPath` | [`String!`](#string) | Web path of the board. | -| `webUrl` | [`String!`](#string) | Web URL of the board. | -| `weight` | [`Int`](#int) | Weight of the board. | - -### `BoardConnection` - -The connection type for Board. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[BoardEdge]`](#boardedge) | A list of edges. | -| `nodes` | [`[Board]`](#board) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `BoardEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Board`](#board) | The item at the end of the edge. | +The connection type for [`CiConfigStage`](#ciconfigstage). -### `BoardEpic` +##### Fields -Represents an epic on an issue board. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigstageconnectionedges"></a>`edges` | [`[CiConfigStageEdge]`](#ciconfigstageedge) | A list of edges. | +| <a id="ciconfigstageconnectionnodes"></a>`nodes` | [`[CiConfigStage]`](#ciconfigstage) | A list of nodes. | +| <a id="ciconfigstageconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `author` | [`User!`](#user) | Author of the epic. | -| `awardEmoji` | [`AwardEmojiConnection`](#awardemojiconnection) | A list of award emojis associated with the epic. | -| `children` | [`EpicConnection`](#epicconnection) | Children (sub-epics) of the epic. | -| `closedAt` | [`Time`](#time) | Timestamp of when the epic was closed. | -| `confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. | -| `createdAt` | [`Time`](#time) | Timestamp of when the epic was created. | -| `currentUserTodos` | [`TodoConnection!`](#todoconnection) | To-do items for the current user. | -| `descendantCounts` | [`EpicDescendantCount`](#epicdescendantcount) | Number of open and closed descendant epics and issues. | -| `descendantWeightSum` | [`EpicDescendantWeights`](#epicdescendantweights) | Total weight of open and closed issues in the epic and its descendants. | -| `description` | [`String`](#string) | Description of the epic. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `downvotes` | [`Int!`](#int) | Number of downvotes the epic has received. | -| `dueDate` | [`Time`](#time) | Due date of the epic. | -| `dueDateFixed` | [`Time`](#time) | Fixed due date of the epic. | -| `dueDateFromMilestones` | [`Time`](#time) | Inherited due date of the epic from milestones. | -| `dueDateIsFixed` | [`Boolean`](#boolean) | Indicates if the due date has been manually set. | -| `events` | [`EventConnection`](#eventconnection) | A list of events associated with the object. | -| `group` | [`Group!`](#group) | Group to which the epic belongs. | -| `hasChildren` | [`Boolean!`](#boolean) | Indicates if the epic has children. | -| `hasIssues` | [`Boolean!`](#boolean) | Indicates if the epic has direct issues. | -| `hasParent` | [`Boolean!`](#boolean) | Indicates if the epic has a parent epic. | -| `healthStatus` | [`EpicHealthStatus`](#epichealthstatus) | Current health status of the epic. | -| `id` | [`ID!`](#id) | ID of the epic. | -| `iid` | [`ID!`](#id) | Internal ID of the epic. | -| `issues` | [`EpicIssueConnection`](#epicissueconnection) | A list of issues associated with the epic. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels assigned to the epic. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `parent` | [`Epic`](#epic) | Parent epic of the epic. | -| `participants` | [`UserConnection`](#userconnection) | List of participants for the epic. | -| `reference` | [`String!`](#string) | Internal reference of the epic. Returned in shortened format by default. | -| `relationPath` | [`String`](#string) | URI path of the epic-issue relationship. | -| `relativePosition` | [`Int`](#int) | The relative position of the epic in the epic tree. | -| `startDate` | [`Time`](#time) | Start date of the epic. | -| `startDateFixed` | [`Time`](#time) | Fixed start date of the epic. | -| `startDateFromMilestones` | [`Time`](#time) | Inherited start date of the epic from milestones. | -| `startDateIsFixed` | [`Boolean`](#boolean) | Indicates if the start date has been manually set. | -| `state` | [`EpicState!`](#epicstate) | State of the epic. | -| `subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the epic. | -| `title` | [`String`](#string) | Title of the epic. | -| `titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | -| `updatedAt` | [`Time`](#time) | Timestamp of when the epic was updated. | -| `upvotes` | [`Int!`](#int) | Number of upvotes the epic has received. | -| `userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the epic. | -| `userNotesCount` | [`Int!`](#int) | Number of user notes of the epic. | -| `userPermissions` | [`EpicPermissions!`](#epicpermissions) | Permissions for the current user on the resource. | -| `userPreferences` | [`BoardEpicUserPreferences`](#boardepicuserpreferences) | User preferences for the epic on the issue board. | -| `webPath` | [`String!`](#string) | Web path of the epic. | -| `webUrl` | [`String!`](#string) | Web URL of the epic. | - -### `BoardEpicConnection` - -The connection type for BoardEpic. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[BoardEpicEdge]`](#boardepicedge) | A list of edges. | -| `nodes` | [`[BoardEpic]`](#boardepic) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `BoardEpicEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`BoardEpic`](#boardepic) | The item at the end of the edge. | +#### `CiConfigStageEdge` -### `BoardEpicUserPreferences` +The edge type for [`CiConfigStage`](#ciconfigstage). -Represents user preferences for a board epic. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `collapsed` | [`Boolean!`](#boolean) | Indicates epic should be displayed as collapsed. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigstageedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="ciconfigstageedgenode"></a>`node` | [`CiConfigStage`](#ciconfigstage) | The item at the end of the edge. | -### `BoardList` +#### `CiGroupConnection` -Represents a list for an issue board. +The connection type for [`CiGroup`](#cigroup). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `assignee` | [`User`](#user) | Assignee in the list. | -| `collapsed` | [`Boolean`](#boolean) | Indicates if the list is collapsed for this user. | -| `id` | [`ID!`](#id) | ID (global ID) of the list. | -| `issues` | [`IssueConnection`](#issueconnection) | Board issues. | -| `issuesCount` | [`Int`](#int) | Count of issues in the list. | -| `iteration` | [`Iteration`](#iteration) | Iteration of the list. | -| `label` | [`Label`](#label) | Label of the list. | -| `limitMetric` | [`ListLimitMetric`](#listlimitmetric) | The current limit metric for the list. | -| `listType` | [`String!`](#string) | Type of the list. | -| `maxIssueCount` | [`Int`](#int) | Maximum number of issues in the list. | -| `maxIssueWeight` | [`Int`](#int) | Maximum weight of issues in the list. | -| `milestone` | [`Milestone`](#milestone) | Milestone of the list. | -| `position` | [`Int`](#int) | Position of list within the board. | -| `title` | [`String!`](#string) | Title of the list. | -| `totalWeight` | [`Int`](#int) | Total weight of all issues in the list. | +##### Fields -### `BoardListConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cigroupconnectionedges"></a>`edges` | [`[CiGroupEdge]`](#cigroupedge) | A list of edges. | +| <a id="cigroupconnectionnodes"></a>`nodes` | [`[CiGroup]`](#cigroup) | A list of nodes. | +| <a id="cigroupconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -The connection type for BoardList. +#### `CiGroupEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[BoardListEdge]`](#boardlistedge) | A list of edges. | -| `nodes` | [`[BoardList]`](#boardlist) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +The edge type for [`CiGroup`](#cigroup). -### `BoardListCreatePayload` +##### Fields -Autogenerated return type of BoardListCreate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cigroupedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="cigroupedgenode"></a>`node` | [`CiGroup`](#cigroup) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `list` | [`BoardList`](#boardlist) | Issue list in the issue board. | +#### `CiJobArtifactConnection` -### `BoardListEdge` +The connection type for [`CiJobArtifact`](#cijobartifact). -An edge in a connection. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`BoardList`](#boardlist) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cijobartifactconnectionedges"></a>`edges` | [`[CiJobArtifactEdge]`](#cijobartifactedge) | A list of edges. | +| <a id="cijobartifactconnectionnodes"></a>`nodes` | [`[CiJobArtifact]`](#cijobartifact) | A list of nodes. | +| <a id="cijobartifactconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `BoardListUpdateLimitMetricsPayload` +#### `CiJobArtifactEdge` -Autogenerated return type of BoardListUpdateLimitMetrics. +The edge type for [`CiJobArtifact`](#cijobartifact). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `list` | [`BoardList`](#boardlist) | The updated list. | +##### Fields -### `Branch` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cijobartifactedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="cijobartifactedgenode"></a>`node` | [`CiJobArtifact`](#cijobartifact) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `commit` | [`Commit`](#commit) | Commit for the branch. | -| `name` | [`String!`](#string) | Name of the branch. | +#### `CiJobConnection` -### `BulkFindOrCreateDevopsAdoptionSegmentsPayload` +The connection type for [`CiJob`](#cijob). -Autogenerated return type of BulkFindOrCreateDevopsAdoptionSegments. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `segments` | [`[DevopsAdoptionSegment!]`](#devopsadoptionsegment) | Created segments after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cijobconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="cijobconnectionedges"></a>`edges` | [`[CiJobEdge]`](#cijobedge) | A list of edges. | +| <a id="cijobconnectionnodes"></a>`nodes` | [`[CiJob]`](#cijob) | A list of nodes. | +| <a id="cijobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `BurnupChartDailyTotals` +#### `CiJobEdge` -Represents the total number of issues and their weights for a particular day. +The edge type for [`CiJob`](#cijob). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `completedCount` | [`Int!`](#int) | Number of closed issues as of this day. | -| `completedWeight` | [`Int!`](#int) | Total weight of closed issues as of this day. | -| `date` | [`ISO8601Date!`](#iso8601date) | Date for burnup totals. | -| `scopeCount` | [`Int!`](#int) | Number of issues as of this day. | -| `scopeWeight` | [`Int!`](#int) | Total weight of issues as of this day. | +##### Fields -### `CiApplicationSettings` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cijobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="cijobedgenode"></a>`node` | [`CiJob`](#cijob) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `keepLatestArtifact` | [`Boolean`](#boolean) | Whether to keep the latest jobs artifacts. | +#### `CiRunnerConnection` -### `CiBuildNeed` +The connection type for [`CiRunner`](#cirunner). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `name` | [`String`](#string) | Name of the job we need to complete. | +##### Fields -### `CiBuildNeedConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cirunnerconnectionedges"></a>`edges` | [`[CiRunnerEdge]`](#cirunneredge) | A list of edges. | +| <a id="cirunnerconnectionnodes"></a>`nodes` | [`[CiRunner]`](#cirunner) | A list of nodes. | +| <a id="cirunnerconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -The connection type for CiBuildNeed. +#### `CiRunnerEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CiBuildNeedEdge]`](#cibuildneededge) | A list of edges. | -| `nodes` | [`[CiBuildNeed]`](#cibuildneed) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +The edge type for [`CiRunner`](#cirunner). -### `CiBuildNeedEdge` +##### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cirunneredgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="cirunneredgenode"></a>`node` | [`CiRunner`](#cirunner) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiBuildNeed`](#cibuildneed) | The item at the end of the edge. | +#### `CiStageConnection` -### `CiCdSettingsUpdatePayload` +The connection type for [`CiStage`](#cistage). -Autogenerated return type of CiCdSettingsUpdate. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `ciCdSettings` | [`ProjectCiCdSetting!`](#projectcicdsetting) | The CI/CD settings after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cistageconnectionedges"></a>`edges` | [`[CiStageEdge]`](#cistageedge) | A list of edges. | +| <a id="cistageconnectionnodes"></a>`nodes` | [`[CiStage]`](#cistage) | A list of nodes. | +| <a id="cistageconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CiConfig` +#### `CiStageEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `errors` | [`[String!]`](#string) | Linting errors. | -| `mergedYaml` | [`String`](#string) | Merged CI configuration YAML. | -| `stages` | [`CiConfigStageConnection`](#ciconfigstageconnection) | Stages of the pipeline. | -| `status` | [`CiConfigStatus`](#ciconfigstatus) | Status of linting, can be either valid or invalid. | +The edge type for [`CiStage`](#cistage). -### `CiConfigGroup` +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `jobs` | [`CiConfigJobConnection`](#ciconfigjobconnection) | Jobs in group. | -| `name` | [`String`](#string) | Name of the job group. | -| `size` | [`Int`](#int) | Size of the job group. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cistageedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="cistageedgenode"></a>`node` | [`CiStage`](#cistage) | The item at the end of the edge. | -### `CiConfigGroupConnection` +#### `ClusterAgentConnection` -The connection type for CiConfigGroup. +The connection type for [`ClusterAgent`](#clusteragent). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CiConfigGroupEdge]`](#ciconfiggroupedge) | A list of edges. | -| `nodes` | [`[CiConfigGroup]`](#ciconfiggroup) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `CiConfigGroupEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="clusteragentconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="clusteragentconnectionedges"></a>`edges` | [`[ClusterAgentEdge]`](#clusteragentedge) | A list of edges. | +| <a id="clusteragentconnectionnodes"></a>`nodes` | [`[ClusterAgent]`](#clusteragent) | A list of nodes. | +| <a id="clusteragentconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -An edge in a connection. +#### `ClusterAgentEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiConfigGroup`](#ciconfiggroup) | The item at the end of the edge. | +The edge type for [`ClusterAgent`](#clusteragent). -### `CiConfigJob` +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `afterScript` | [`[String!]`](#string) | Override a set of commands that are executed after the job. | -| `allowFailure` | [`Boolean`](#boolean) | Allow job to fail. | -| `beforeScript` | [`[String!]`](#string) | Override a set of commands that are executed before the job. | -| `environment` | [`String`](#string) | Name of an environment to which the job deploys. | -| `except` | [`CiConfigJobRestriction`](#ciconfigjobrestriction) | Limit when jobs are not created. | -| `groupName` | [`String`](#string) | Name of the job group. | -| `name` | [`String`](#string) | Name of the job. | -| `needs` | [`CiConfigNeedConnection`](#ciconfigneedconnection) | Builds that must complete before the jobs run. | -| `only` | [`CiConfigJobRestriction`](#ciconfigjobrestriction) | Jobs are created when these conditions do not apply. | -| `script` | [`[String!]`](#string) | Shell script that is executed by a runner. | -| `stage` | [`String`](#string) | Name of the job stage. | -| `tags` | [`[String!]`](#string) | List of tags that are used to select a runner. | -| `when` | [`String`](#string) | When to run the job. | - -### `CiConfigJobConnection` - -The connection type for CiConfigJob. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CiConfigJobEdge]`](#ciconfigjobedge) | A list of edges. | -| `nodes` | [`[CiConfigJob]`](#ciconfigjob) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `CiConfigJobEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiConfigJob`](#ciconfigjob) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="clusteragentedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="clusteragentedgenode"></a>`node` | [`ClusterAgent`](#clusteragent) | The item at the end of the edge. | -### `CiConfigJobRestriction` +#### `ClusterAgentTokenConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `refs` | [`[String!]`](#string) | The Git refs the job restriction applies to. | +The connection type for [`ClusterAgentToken`](#clusteragenttoken). -### `CiConfigNeed` +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `name` | [`String`](#string) | Name of the need. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="clusteragenttokenconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="clusteragenttokenconnectionedges"></a>`edges` | [`[ClusterAgentTokenEdge]`](#clusteragenttokenedge) | A list of edges. | +| <a id="clusteragenttokenconnectionnodes"></a>`nodes` | [`[ClusterAgentToken]`](#clusteragenttoken) | A list of nodes. | +| <a id="clusteragenttokenconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CiConfigNeedConnection` +#### `ClusterAgentTokenEdge` -The connection type for CiConfigNeed. +The edge type for [`ClusterAgentToken`](#clusteragenttoken). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CiConfigNeedEdge]`](#ciconfigneededge) | A list of edges. | -| `nodes` | [`[CiConfigNeed]`](#ciconfigneed) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `CiConfigNeedEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="clusteragenttokenedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="clusteragenttokenedgenode"></a>`node` | [`ClusterAgentToken`](#clusteragenttoken) | The item at the end of the edge. | -An edge in a connection. +#### `CodeCoverageActivityConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiConfigNeed`](#ciconfigneed) | The item at the end of the edge. | +The connection type for [`CodeCoverageActivity`](#codecoverageactivity). -### `CiConfigStage` +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `groups` | [`CiConfigGroupConnection`](#ciconfiggroupconnection) | Groups of jobs for the stage. | -| `name` | [`String`](#string) | Name of the stage. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="codecoverageactivityconnectionedges"></a>`edges` | [`[CodeCoverageActivityEdge]`](#codecoverageactivityedge) | A list of edges. | +| <a id="codecoverageactivityconnectionnodes"></a>`nodes` | [`[CodeCoverageActivity]`](#codecoverageactivity) | A list of nodes. | +| <a id="codecoverageactivityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CiConfigStageConnection` +#### `CodeCoverageActivityEdge` -The connection type for CiConfigStage. +The edge type for [`CodeCoverageActivity`](#codecoverageactivity). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CiConfigStageEdge]`](#ciconfigstageedge) | A list of edges. | -| `nodes` | [`[CiConfigStage]`](#ciconfigstage) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `CiConfigStageEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="codecoverageactivityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="codecoverageactivityedgenode"></a>`node` | [`CodeCoverageActivity`](#codecoverageactivity) | The item at the end of the edge. | -An edge in a connection. +#### `CodeQualityDegradationConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiConfigStage`](#ciconfigstage) | The item at the end of the edge. | +The connection type for [`CodeQualityDegradation`](#codequalitydegradation). -### `CiGroup` +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the group. | -| `jobs` | [`CiJobConnection`](#cijobconnection) | Jobs in group. | -| `name` | [`String`](#string) | Name of the job group. | -| `size` | [`Int`](#int) | Size of the group. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="codequalitydegradationconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="codequalitydegradationconnectionedges"></a>`edges` | [`[CodeQualityDegradationEdge]`](#codequalitydegradationedge) | A list of edges. | +| <a id="codequalitydegradationconnectionnodes"></a>`nodes` | [`[CodeQualityDegradation]`](#codequalitydegradation) | A list of nodes. | +| <a id="codequalitydegradationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CiGroupConnection` +#### `CodeQualityDegradationEdge` -The connection type for CiGroup. +The edge type for [`CodeQualityDegradation`](#codequalitydegradation). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CiGroupEdge]`](#cigroupedge) | A list of edges. | -| `nodes` | [`[CiGroup]`](#cigroup) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `CiGroupEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="codequalitydegradationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="codequalitydegradationedgenode"></a>`node` | [`CodeQualityDegradation`](#codequalitydegradation) | The item at the end of the edge. | -An edge in a connection. +#### `CommitConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiGroup`](#cigroup) | The item at the end of the edge. | +The connection type for [`Commit`](#commit). -### `CiJob` +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean!`](#boolean) | Indicates the job is active. | -| `allowFailure` | [`Boolean!`](#boolean) | Whether this job is allowed to fail. | -| `artifacts` | [`CiJobArtifactConnection`](#cijobartifactconnection) | Artifacts generated by the job. | -| `cancelable` | [`Boolean!`](#boolean) | Indicates the job can be canceled. | -| `commitPath` | [`String`](#string) | Path to the commit that triggered the job. | -| `coverage` | [`Float`](#float) | Coverage level of the job. | -| `createdAt` | [`Time!`](#time) | When the job was created. | -| `detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the job. | -| `duration` | [`Int`](#int) | Duration of the job in seconds. | -| `finishedAt` | [`Time`](#time) | When a job has finished running. | -| `id` | [`JobID`](#jobid) | ID of the job. | -| `name` | [`String`](#string) | Name of the job. | -| `needs` | [`CiBuildNeedConnection`](#cibuildneedconnection) | References to builds that must complete before the jobs run. | -| `pipeline` | [`Pipeline`](#pipeline) | Pipeline the job belongs to. | -| `playable` | [`Boolean!`](#boolean) | Indicates the job can be played. | -| `queuedAt` | [`Time`](#time) | When the job was enqueued and marked as pending. | -| `refName` | [`String`](#string) | Ref name of the job. | -| `refPath` | [`String`](#string) | Path to the ref. | -| `retryable` | [`Boolean!`](#boolean) | Indicates the job can be retried. | -| `scheduledAt` | [`Time`](#time) | Schedule for the build. | -| `schedulingType` | [`String`](#string) | Type of pipeline scheduling. Value is `dag` if the pipeline uses the `needs` keyword, and `stage` otherwise. | -| `shortSha` | [`String!`](#string) | Short SHA1 ID of the commit. | -| `stage` | [`CiStage`](#cistage) | Stage of the job. | -| `startedAt` | [`Time`](#time) | When the job was started. | -| `status` | [`CiJobStatus`](#cijobstatus) | Status of the job. | -| `tags` | [`[String!]`](#string) | Tags for the current job. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="commitconnectionedges"></a>`edges` | [`[CommitEdge]`](#commitedge) | A list of edges. | +| <a id="commitconnectionnodes"></a>`nodes` | [`[Commit]`](#commit) | A list of nodes. | +| <a id="commitconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CiJobArtifact` +#### `CommitEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `downloadPath` | [`String`](#string) | URL for downloading the artifact's file. | -| `fileType` | [`JobArtifactFileType`](#jobartifactfiletype) | File type of the artifact. | +The edge type for [`Commit`](#commit). -### `CiJobArtifactConnection` +##### Fields -The connection type for CiJobArtifact. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="commitedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="commitedgenode"></a>`node` | [`Commit`](#commit) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CiJobArtifactEdge]`](#cijobartifactedge) | A list of edges. | -| `nodes` | [`[CiJobArtifact]`](#cijobartifact) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### `ComplianceFrameworkConnection` -### `CiJobArtifactEdge` +The connection type for [`ComplianceFramework`](#complianceframework). -An edge in a connection. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiJobArtifact`](#cijobartifact) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="complianceframeworkconnectionedges"></a>`edges` | [`[ComplianceFrameworkEdge]`](#complianceframeworkedge) | A list of edges. | +| <a id="complianceframeworkconnectionnodes"></a>`nodes` | [`[ComplianceFramework]`](#complianceframework) | A list of nodes. | +| <a id="complianceframeworkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CiJobConnection` +#### `ComplianceFrameworkEdge` -The connection type for CiJob. +The edge type for [`ComplianceFramework`](#complianceframework). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[CiJobEdge]`](#cijobedge) | A list of edges. | -| `nodes` | [`[CiJob]`](#cijob) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `CiJobEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="complianceframeworkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="complianceframeworkedgenode"></a>`node` | [`ComplianceFramework`](#complianceframework) | The item at the end of the edge. | -An edge in a connection. +#### `ContainerRepositoryConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiJob`](#cijob) | The item at the end of the edge. | +The connection type for [`ContainerRepository`](#containerrepository). -### `CiStage` +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the stage. | -| `groups` | [`CiGroupConnection`](#cigroupconnection) | Group of jobs for the stage. | -| `jobs` | [`CiJobConnection`](#cijobconnection) | Jobs for the stage. | -| `name` | [`String`](#string) | Name of the stage. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="containerrepositoryconnectionedges"></a>`edges` | [`[ContainerRepositoryEdge]`](#containerrepositoryedge) | A list of edges. | +| <a id="containerrepositoryconnectionnodes"></a>`nodes` | [`[ContainerRepository]`](#containerrepository) | A list of nodes. | +| <a id="containerrepositoryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CiStageConnection` +#### `ContainerRepositoryEdge` -The connection type for CiStage. +The edge type for [`ContainerRepository`](#containerrepository). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CiStageEdge]`](#cistageedge) | A list of edges. | -| `nodes` | [`[CiStage]`](#cistage) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `CiStageEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="containerrepositoryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="containerrepositoryedgenode"></a>`node` | [`ContainerRepository`](#containerrepository) | The item at the end of the edge. | -An edge in a connection. +#### `ContainerRepositoryTagConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CiStage`](#cistage) | The item at the end of the edge. | +The connection type for [`ContainerRepositoryTag`](#containerrepositorytag). -### `ClusterAgent` +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp the cluster agent was created. | -| `createdByUser` | [`User`](#user) | User object, containing information about the person who created the agent. | -| `id` | [`ID!`](#id) | ID of the cluster agent. | -| `name` | [`String`](#string) | Name of the cluster agent. | -| `project` | [`Project`](#project) | The project this cluster agent is associated with. | -| `tokens` | [`ClusterAgentTokenConnection`](#clusteragenttokenconnection) | Tokens associated with the cluster agent. | -| `updatedAt` | [`Time`](#time) | Timestamp the cluster agent was updated. | -| `webPath` | [`String`](#string) | Web path of the cluster agent. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="containerrepositorytagconnectionedges"></a>`edges` | [`[ContainerRepositoryTagEdge]`](#containerrepositorytagedge) | A list of edges. | +| <a id="containerrepositorytagconnectionnodes"></a>`nodes` | [`[ContainerRepositoryTag]`](#containerrepositorytag) | A list of nodes. | +| <a id="containerrepositorytagconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `ClusterAgentConnection` +#### `ContainerRepositoryTagEdge` -The connection type for ClusterAgent. +The edge type for [`ContainerRepositoryTag`](#containerrepositorytag). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[ClusterAgentEdge]`](#clusteragentedge) | A list of edges. | -| `nodes` | [`[ClusterAgent]`](#clusteragent) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `ClusterAgentDeletePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="containerrepositorytagedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="containerrepositorytagedgenode"></a>`node` | [`ContainerRepositoryTag`](#containerrepositorytag) | The item at the end of the edge. | -Autogenerated return type of ClusterAgentDelete. +#### `CustomEmojiConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +The connection type for [`CustomEmoji`](#customemoji). -### `ClusterAgentEdge` +##### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="customemojiconnectionedges"></a>`edges` | [`[CustomEmojiEdge]`](#customemojiedge) | A list of edges. | +| <a id="customemojiconnectionnodes"></a>`nodes` | [`[CustomEmoji]`](#customemoji) | A list of nodes. | +| <a id="customemojiconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ClusterAgent`](#clusteragent) | The item at the end of the edge. | +#### `CustomEmojiEdge` -### `ClusterAgentToken` +The edge type for [`CustomEmoji`](#customemoji). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clusterAgent` | [`ClusterAgent`](#clusteragent) | Cluster agent this token is associated with. | -| `createdAt` | [`Time`](#time) | Timestamp the token was created. | -| `createdByUser` | [`User`](#user) | The user who created the token. | -| `description` | [`String`](#string) | Description of the token. | -| `id` | [`ClustersAgentTokenID!`](#clustersagenttokenid) | Global ID of the token. | -| `lastUsedAt` | [`Time`](#time) | Timestamp the token was last used. | -| `name` | [`String`](#string) | Name given to the token. | +##### Fields -### `ClusterAgentTokenConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="customemojiedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="customemojiedgenode"></a>`node` | [`CustomEmoji`](#customemoji) | The item at the end of the edge. | -The connection type for ClusterAgentToken. +#### `DastProfileConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[ClusterAgentTokenEdge]`](#clusteragenttokenedge) | A list of edges. | -| `nodes` | [`[ClusterAgentToken]`](#clusteragenttoken) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +The connection type for [`DastProfile`](#dastprofile). -### `ClusterAgentTokenCreatePayload` +##### Fields -Autogenerated return type of ClusterAgentTokenCreate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastprofileconnectionedges"></a>`edges` | [`[DastProfileEdge]`](#dastprofileedge) | A list of edges. | +| <a id="dastprofileconnectionnodes"></a>`nodes` | [`[DastProfile]`](#dastprofile) | A list of nodes. | +| <a id="dastprofileconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `secret` | [`String`](#string) | Token secret value. Make sure you save it - you won't be able to access it again. | -| `token` | [`ClusterAgentToken`](#clusteragenttoken) | Token created after mutation. | +#### `DastProfileEdge` -### `ClusterAgentTokenDeletePayload` +The edge type for [`DastProfile`](#dastprofile). -Autogenerated return type of ClusterAgentTokenDelete. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastprofileedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="dastprofileedgenode"></a>`node` | [`DastProfile`](#dastprofile) | The item at the end of the edge. | -### `ClusterAgentTokenEdge` +#### `DastScannerProfileConnection` -An edge in a connection. +The connection type for [`DastScannerProfile`](#dastscannerprofile). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ClusterAgentToken`](#clusteragenttoken) | The item at the end of the edge. | +##### Fields -### `CodeCoverageActivity` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastscannerprofileconnectionedges"></a>`edges` | [`[DastScannerProfileEdge]`](#dastscannerprofileedge) | A list of edges. | +| <a id="dastscannerprofileconnectionnodes"></a>`nodes` | [`[DastScannerProfile]`](#dastscannerprofile) | A list of nodes. | +| <a id="dastscannerprofileconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Represents the code coverage activity for a group. +#### `DastScannerProfileEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `averageCoverage` | [`Float`](#float) | Average percentage of the different code coverage results available for the group. | -| `coverageCount` | [`Int`](#int) | Number of different code coverage results available for the group. | -| `date` | [`Date!`](#date) | Date when the code coverage was created. | -| `projectCount` | [`Int`](#int) | Number of projects with code coverage results for the group. | +The edge type for [`DastScannerProfile`](#dastscannerprofile). -### `CodeCoverageActivityConnection` +##### Fields -The connection type for CodeCoverageActivity. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastscannerprofileedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="dastscannerprofileedgenode"></a>`node` | [`DastScannerProfile`](#dastscannerprofile) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CodeCoverageActivityEdge]`](#codecoverageactivityedge) | A list of edges. | -| `nodes` | [`[CodeCoverageActivity]`](#codecoverageactivity) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### `DastSiteProfileConnection` -### `CodeCoverageActivityEdge` +The connection type for [`DastSiteProfile`](#dastsiteprofile). -An edge in a connection. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CodeCoverageActivity`](#codecoverageactivity) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsiteprofileconnectionedges"></a>`edges` | [`[DastSiteProfileEdge]`](#dastsiteprofileedge) | A list of edges. | +| <a id="dastsiteprofileconnectionnodes"></a>`nodes` | [`[DastSiteProfile]`](#dastsiteprofile) | A list of nodes. | +| <a id="dastsiteprofileconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CodeCoverageSummary` +#### `DastSiteProfileEdge` -Represents the code coverage summary for a project. +The edge type for [`DastSiteProfile`](#dastsiteprofile). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `averageCoverage` | [`Float`](#float) | Average percentage of the different code coverage results available for the project. | -| `coverageCount` | [`Int`](#int) | Number of different code coverage results available. | -| `lastUpdatedOn` | [`Date`](#date) | Latest date when the code coverage was created for the project. | +##### Fields -### `Commit` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsiteprofileedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="dastsiteprofileedgenode"></a>`node` | [`DastSiteProfile`](#dastsiteprofile) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `author` | [`User`](#user) | Author of the commit. | -| `authorGravatar` | [`String`](#string) | Commit authors gravatar. | -| `authorName` | [`String`](#string) | Commit authors name. | -| `authoredDate` | [`Time`](#time) | Timestamp of when the commit was authored. | -| `description` | [`String`](#string) | Description of the commit message. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `id` | [`ID!`](#id) | ID (global ID) of the commit. | -| `message` | [`String`](#string) | Raw commit message. | -| `pipelines` | [`PipelineConnection`](#pipelineconnection) | Pipelines of the commit ordered latest first. | -| `sha` | [`String!`](#string) | SHA1 ID of the commit. | -| `shortId` | [`String!`](#string) | Short SHA1 ID of the commit. | -| `signatureHtml` | [`String`](#string) | Rendered HTML of the commit signature. | -| `title` | [`String`](#string) | Title of the commit message. | -| `titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | -| `webPath` | [`String!`](#string) | Web path of the commit. | -| `webUrl` | [`String!`](#string) | Web URL of the commit. | - -### `CommitConnection` - -The connection type for Commit. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CommitEdge]`](#commitedge) | A list of edges. | -| `nodes` | [`[Commit]`](#commit) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `CommitCreatePayload` - -Autogenerated return type of CommitCreate. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `commit` | [`Commit`](#commit) | The commit after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | - -### `CommitEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Commit`](#commit) | The item at the end of the edge. | +#### `DastSiteValidationConnection` -### `ComplianceFramework` +The connection type for [`DastSiteValidation`](#dastsitevalidation). -Represents a ComplianceFramework associated with a Project. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `color` | [`String!`](#string) | Hexadecimal representation of compliance framework's label color. | -| `description` | [`String!`](#string) | Description of the compliance framework. | -| `id` | [`ID!`](#id) | Compliance framework ID. | -| `name` | [`String!`](#string) | Name of the compliance framework. | -| `pipelineConfigurationFullPath` | [`String`](#string) | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsitevalidationconnectionedges"></a>`edges` | [`[DastSiteValidationEdge]`](#dastsitevalidationedge) | A list of edges. | +| <a id="dastsitevalidationconnectionnodes"></a>`nodes` | [`[DastSiteValidation]`](#dastsitevalidation) | A list of nodes. | +| <a id="dastsitevalidationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `ComplianceFrameworkConnection` +#### `DastSiteValidationEdge` -The connection type for ComplianceFramework. +The edge type for [`DastSiteValidation`](#dastsitevalidation). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ComplianceFrameworkEdge]`](#complianceframeworkedge) | A list of edges. | -| `nodes` | [`[ComplianceFramework]`](#complianceframework) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `ComplianceFrameworkEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsitevalidationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="dastsitevalidationedgenode"></a>`node` | [`DastSiteValidation`](#dastsitevalidation) | The item at the end of the edge. | -An edge in a connection. +#### `DesignAtVersionConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ComplianceFramework`](#complianceframework) | The item at the end of the edge. | +The connection type for [`DesignAtVersion`](#designatversion). -### `ComposerMetadata` +##### Fields -Composer metadata. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designatversionconnectionedges"></a>`edges` | [`[DesignAtVersionEdge]`](#designatversionedge) | A list of edges. | +| <a id="designatversionconnectionnodes"></a>`nodes` | [`[DesignAtVersion]`](#designatversion) | A list of nodes. | +| <a id="designatversionconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `composerJson` | [`PackageComposerJsonType!`](#packagecomposerjsontype) | Data of the Composer JSON file. | -| `targetSha` | [`String!`](#string) | Target SHA of the package. | +#### `DesignAtVersionEdge` -### `ConanFileMetadata` +The edge type for [`DesignAtVersion`](#designatversion). -Conan file metadata. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `conanFileType` | [`ConanMetadatumFileTypeEnum!`](#conanmetadatumfiletypeenum) | Type of the Conan file. | -| `conanPackageReference` | [`String`](#string) | Reference of the Conan package. | -| `createdAt` | [`Time!`](#time) | Date of creation. | -| `id` | [`PackagesConanFileMetadatumID!`](#packagesconanfilemetadatumid) | ID of the metadatum. | -| `packageRevision` | [`String`](#string) | Revision of the package. | -| `recipeRevision` | [`String!`](#string) | Revision of the Conan recipe. | -| `updatedAt` | [`Time!`](#time) | Date of most recent update. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designatversionedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="designatversionedgenode"></a>`node` | [`DesignAtVersion`](#designatversion) | The item at the end of the edge. | -### `ConanMetadata` +#### `DesignConnection` -Conan metadata. +The connection type for [`Design`](#design). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Date of creation. | -| `id` | [`PackagesConanMetadatumID!`](#packagesconanmetadatumid) | ID of the metadatum. | -| `packageChannel` | [`String!`](#string) | Channel of the Conan package. | -| `packageUsername` | [`String!`](#string) | Username of the Conan package. | -| `recipe` | [`String!`](#string) | Recipe of the Conan package. | -| `recipePath` | [`String!`](#string) | Recipe path of the Conan package. | -| `updatedAt` | [`Time!`](#time) | Date of most recent update. | +##### Fields -### `ConfigureSastPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designconnectionedges"></a>`edges` | [`[DesignEdge]`](#designedge) | A list of edges. | +| <a id="designconnectionnodes"></a>`nodes` | [`[Design]`](#design) | A list of nodes. | +| <a id="designconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Autogenerated return type of ConfigureSast. +#### `DesignEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `status` | [`String!`](#string) | Status of creating the commit for the supplied SAST CI configuration. | -| `successPath` | [`String`](#string) | Redirect path to use when the response is successful. | +The edge type for [`Design`](#design). -### `ContainerExpirationPolicy` +##### Fields -A tag expiration policy designed to keep only the images that matter most. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="designedgenode"></a>`node` | [`Design`](#design) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cadence` | [`ContainerExpirationPolicyCadenceEnum!`](#containerexpirationpolicycadenceenum) | This container expiration policy schedule. | -| `createdAt` | [`Time!`](#time) | Timestamp of when the container expiration policy was created. | -| `enabled` | [`Boolean!`](#boolean) | Indicates whether this container expiration policy is enabled. | -| `keepN` | [`ContainerExpirationPolicyKeepEnum`](#containerexpirationpolicykeepenum) | Number of tags to retain. | -| `nameRegex` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will expire. | -| `nameRegexKeep` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will be preserved. | -| `nextRunAt` | [`Time`](#time) | Next time that this container expiration policy will get executed. | -| `olderThan` | [`ContainerExpirationPolicyOlderThanEnum`](#containerexpirationpolicyolderthanenum) | Tags older that this will expire. | -| `updatedAt` | [`Time!`](#time) | Timestamp of when the container expiration policy was updated. | +#### `DesignVersionConnection` -### `ContainerRepository` +The connection type for [`DesignVersion`](#designversion). -A container repository. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `canDelete` | [`Boolean!`](#boolean) | Can the current user delete the container repository. | -| `createdAt` | [`Time!`](#time) | Timestamp when the container repository was created. | -| `expirationPolicyCleanupStatus` | [`ContainerRepositoryCleanupStatus`](#containerrepositorycleanupstatus) | The tags cleanup status for the container repository. | -| `expirationPolicyStartedAt` | [`Time`](#time) | Timestamp when the cleanup done by the expiration policy was started on the container repository. | -| `id` | [`ID!`](#id) | ID of the container repository. | -| `location` | [`String!`](#string) | URL of the container repository. | -| `name` | [`String!`](#string) | Name of the container repository. | -| `path` | [`String!`](#string) | Path of the container repository. | -| `project` | [`Project!`](#project) | Project of the container registry. | -| `status` | [`ContainerRepositoryStatus`](#containerrepositorystatus) | Status of the container repository. | -| `tagsCount` | [`Int!`](#int) | Number of tags associated with this image. | -| `updatedAt` | [`Time!`](#time) | Timestamp when the container repository was updated. | - -### `ContainerRepositoryConnection` - -The connection type for ContainerRepository. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ContainerRepositoryEdge]`](#containerrepositoryedge) | A list of edges. | -| `nodes` | [`[ContainerRepository]`](#containerrepository) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designversionconnectionedges"></a>`edges` | [`[DesignVersionEdge]`](#designversionedge) | A list of edges. | +| <a id="designversionconnectionnodes"></a>`nodes` | [`[DesignVersion]`](#designversion) | A list of nodes. | +| <a id="designversionconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `ContainerRepositoryDetails` +#### `DesignVersionEdge` -Details of a container repository. +The edge type for [`DesignVersion`](#designversion). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `canDelete` | [`Boolean!`](#boolean) | Can the current user delete the container repository. | -| `createdAt` | [`Time!`](#time) | Timestamp when the container repository was created. | -| `expirationPolicyCleanupStatus` | [`ContainerRepositoryCleanupStatus`](#containerrepositorycleanupstatus) | The tags cleanup status for the container repository. | -| `expirationPolicyStartedAt` | [`Time`](#time) | Timestamp when the cleanup done by the expiration policy was started on the container repository. | -| `id` | [`ID!`](#id) | ID of the container repository. | -| `location` | [`String!`](#string) | URL of the container repository. | -| `name` | [`String!`](#string) | Name of the container repository. | -| `path` | [`String!`](#string) | Path of the container repository. | -| `project` | [`Project!`](#project) | Project of the container registry. | -| `status` | [`ContainerRepositoryStatus`](#containerrepositorystatus) | Status of the container repository. | -| `tags` | [`ContainerRepositoryTagConnection`](#containerrepositorytagconnection) | Tags of the container repository. | -| `tagsCount` | [`Int!`](#int) | Number of tags associated with this image. | -| `updatedAt` | [`Time!`](#time) | Timestamp when the container repository was updated. | - -### `ContainerRepositoryEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ContainerRepository`](#containerrepository) | The item at the end of the edge. | +##### Fields -### `ContainerRepositoryTag` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designversionedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="designversionedgenode"></a>`node` | [`DesignVersion`](#designversion) | The item at the end of the edge. | -A tag from a container repository. +#### `DevopsAdoptionSegmentConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `canDelete` | [`Boolean!`](#boolean) | Can the current user delete this tag. | -| `createdAt` | [`Time`](#time) | Timestamp when the tag was created. | -| `digest` | [`String`](#string) | Digest of the tag. | -| `location` | [`String!`](#string) | URL of the tag. | -| `name` | [`String!`](#string) | Name of the tag. | -| `path` | [`String!`](#string) | Path of the tag. | -| `revision` | [`String`](#string) | Revision of the tag. | -| `shortRevision` | [`String`](#string) | Short revision of the tag. | -| `totalSize` | [`BigInt`](#bigint) | The size of the tag. | +The connection type for [`DevopsAdoptionSegment`](#devopsadoptionsegment). -### `ContainerRepositoryTagConnection` +##### Fields -The connection type for ContainerRepositoryTag. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="devopsadoptionsegmentconnectionedges"></a>`edges` | [`[DevopsAdoptionSegmentEdge]`](#devopsadoptionsegmentedge) | A list of edges. | +| <a id="devopsadoptionsegmentconnectionnodes"></a>`nodes` | [`[DevopsAdoptionSegment]`](#devopsadoptionsegment) | A list of nodes. | +| <a id="devopsadoptionsegmentconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ContainerRepositoryTagEdge]`](#containerrepositorytagedge) | A list of edges. | -| `nodes` | [`[ContainerRepositoryTag]`](#containerrepositorytag) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### `DevopsAdoptionSegmentEdge` -### `ContainerRepositoryTagEdge` +The edge type for [`DevopsAdoptionSegment`](#devopsadoptionsegment). -An edge in a connection. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ContainerRepositoryTag`](#containerrepositorytag) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="devopsadoptionsegmentedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="devopsadoptionsegmentedgenode"></a>`node` | [`DevopsAdoptionSegment`](#devopsadoptionsegment) | The item at the end of the edge. | -### `CreateAlertIssuePayload` +#### `DiscussionConnection` -Autogenerated return type of CreateAlertIssue. +The connection type for [`Discussion`](#discussion). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `alert` | [`AlertManagementAlert`](#alertmanagementalert) | The alert after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue created after mutation. | -| `todo` | [`Todo`](#todo) | The to-do item after mutation. | +##### Fields -### `CreateAnnotationPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="discussionconnectionedges"></a>`edges` | [`[DiscussionEdge]`](#discussionedge) | A list of edges. | +| <a id="discussionconnectionnodes"></a>`nodes` | [`[Discussion]`](#discussion) | A list of nodes. | +| <a id="discussionconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Autogenerated return type of CreateAnnotation. +#### `DiscussionEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `annotation` | [`MetricsDashboardAnnotation`](#metricsdashboardannotation) | The created annotation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +The edge type for [`Discussion`](#discussion). -### `CreateBoardPayload` +##### Fields -Autogenerated return type of CreateBoard. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="discussionedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="discussionedgenode"></a>`node` | [`Discussion`](#discussion) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `board` | [`Board`](#board) | The board after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### `EnvironmentConnection` -### `CreateBranchPayload` +The connection type for [`Environment`](#environment). -Autogenerated return type of CreateBranch. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `branch` | [`Branch`](#branch) | Branch after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="environmentconnectionedges"></a>`edges` | [`[EnvironmentEdge]`](#environmentedge) | A list of edges. | +| <a id="environmentconnectionnodes"></a>`nodes` | [`[Environment]`](#environment) | A list of nodes. | +| <a id="environmentconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CreateClusterAgentPayload` +#### `EnvironmentEdge` -Autogenerated return type of CreateClusterAgent. +The edge type for [`Environment`](#environment). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `clusterAgent` | [`ClusterAgent`](#clusteragent) | Cluster agent created after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +##### Fields -### `CreateComplianceFrameworkPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="environmentedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="environmentedgenode"></a>`node` | [`Environment`](#environment) | The item at the end of the edge. | -Autogenerated return type of CreateComplianceFramework. +#### `EpicBoardConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `framework` | [`ComplianceFramework`](#complianceframework) | The created compliance framework. | +The connection type for [`EpicBoard`](#epicboard). -### `CreateCustomEmojiPayload` +##### Fields -Autogenerated return type of CreateCustomEmoji. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicboardconnectionedges"></a>`edges` | [`[EpicBoardEdge]`](#epicboardedge) | A list of edges. | +| <a id="epicboardconnectionnodes"></a>`nodes` | [`[EpicBoard]`](#epicboard) | A list of nodes. | +| <a id="epicboardconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `customEmoji` | [`CustomEmoji`](#customemoji) | The new custom emoji. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### `EpicBoardEdge` -### `CreateDevopsAdoptionSegmentPayload` +The edge type for [`EpicBoard`](#epicboard). -Autogenerated return type of CreateDevopsAdoptionSegment. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `segment` | [`DevopsAdoptionSegment`](#devopsadoptionsegment) | The segment after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicboardedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="epicboardedgenode"></a>`node` | [`EpicBoard`](#epicboard) | The item at the end of the edge. | -### `CreateDiffNotePayload` +#### `EpicConnection` -Autogenerated return type of CreateDiffNote. +The connection type for [`Epic`](#epic). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `note` | [`Note`](#note) | The note after mutation. | +##### Fields -### `CreateEpicPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicconnectionedges"></a>`edges` | [`[EpicEdge]`](#epicedge) | A list of edges. | +| <a id="epicconnectionnodes"></a>`nodes` | [`[Epic]`](#epic) | A list of nodes. | +| <a id="epicconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Autogenerated return type of CreateEpic. +#### `EpicEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epic` | [`Epic`](#epic) | The created epic. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +The edge type for [`Epic`](#epic). -### `CreateImageDiffNotePayload` +##### Fields -Autogenerated return type of CreateImageDiffNote. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="epicedgenode"></a>`node` | [`Epic`](#epic) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `note` | [`Note`](#note) | The note after mutation. | +#### `EpicIssueConnection` -### `CreateIssuePayload` +The connection type for [`EpicIssue`](#epicissue). -Autogenerated return type of CreateIssue. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicissueconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="epicissueconnectionedges"></a>`edges` | [`[EpicIssueEdge]`](#epicissueedge) | A list of edges. | +| <a id="epicissueconnectionnodes"></a>`nodes` | [`[EpicIssue]`](#epicissue) | A list of nodes. | +| <a id="epicissueconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| <a id="epicissueconnectionweight"></a>`weight` | [`Int!`](#int) | Total weight of issues collection. | -### `CreateIterationPayload` +#### `EpicIssueEdge` -Autogenerated return type of CreateIteration. +The edge type for [`EpicIssue`](#epicissue). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `iteration` | [`Iteration`](#iteration) | The created iteration. | +##### Fields -### `CreateNotePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicissueedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="epicissueedgenode"></a>`node` | [`EpicIssue`](#epicissue) | The item at the end of the edge. | -Autogenerated return type of CreateNote. +#### `EpicListConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `note` | [`Note`](#note) | The note after mutation. | +The connection type for [`EpicList`](#epiclist). -### `CreateRequirementPayload` +##### Fields -Autogenerated return type of CreateRequirement. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epiclistconnectionedges"></a>`edges` | [`[EpicListEdge]`](#epiclistedge) | A list of edges. | +| <a id="epiclistconnectionnodes"></a>`nodes` | [`[EpicList]`](#epiclist) | A list of nodes. | +| <a id="epiclistconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `requirement` | [`Requirement`](#requirement) | Requirement after mutation. | +#### `EpicListEdge` -### `CreateSnippetPayload` +The edge type for [`EpicList`](#epiclist). -Autogenerated return type of CreateSnippet. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `captchaSiteKey` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use spam protection with HTTP headers instead. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `needsCaptchaResponse` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated** in 13.11. Use spam protection with HTTP headers instead. | -| `snippet` | [`Snippet`](#snippet) | The snippet after mutation. | -| `spam` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated** in 13.11. Use spam protection with HTTP headers instead. | -| `spamLogId` **{warning-solid}** | [`Int`](#int) | **Deprecated** in 13.11. Use spam protection with HTTP headers instead. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epiclistedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="epiclistedgenode"></a>`node` | [`EpicList`](#epiclist) | The item at the end of the edge. | -### `CreateTestCasePayload` +#### `EventConnection` -Autogenerated return type of CreateTestCase. +The connection type for [`Event`](#event). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `testCase` | [`Issue`](#issue) | The test case created. | +##### Fields -### `CurrentLicense` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="eventconnectionedges"></a>`edges` | [`[EventEdge]`](#eventedge) | A list of edges. | +| <a id="eventconnectionnodes"></a>`nodes` | [`[Event]`](#event) | A list of nodes. | +| <a id="eventconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Represents the current license. +#### `EventEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `activatedAt` | [`Date`](#date) | Date when the license was activated. | -| `billableUsersCount` | [`Int`](#int) | Number of billable users on the system. | -| `company` | [`String`](#string) | Company of the licensee. | -| `email` | [`String`](#string) | Email of the licensee. | -| `expiresAt` | [`Date`](#date) | Date when the license expires. | -| `id` | [`ID!`](#id) | ID of the license. | -| `lastSync` | [`Time`](#time) | Date when the license was last synced. | -| `maximumUserCount` | [`Int`](#int) | Highest number of billable users on the system during the term of the current license. | -| `name` | [`String`](#string) | Name of the licensee. | -| `plan` | [`String!`](#string) | Name of the subscription plan. | -| `startsAt` | [`Date`](#date) | Date when the license started. | -| `type` | [`String!`](#string) | Type of the license. | -| `usersInLicenseCount` | [`Int`](#int) | Number of paid users in the license. | -| `usersOverLicenseCount` | [`Int`](#int) | Number of users over the paid users in the license. | +The edge type for [`Event`](#event). -### `CustomEmoji` +##### Fields -A custom emoji uploaded by user. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="eventedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="eventedgenode"></a>`node` | [`Event`](#event) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `external` | [`Boolean!`](#boolean) | Whether the emoji is an external link. | -| `id` | [`CustomEmojiID!`](#customemojiid) | The ID of the emoji. | -| `name` | [`String!`](#string) | The name of the emoji. | -| `url` | [`String!`](#string) | The link to file of the emoji. | +#### `GroupMemberConnection` -### `CustomEmojiConnection` +The connection type for [`GroupMember`](#groupmember). -The connection type for CustomEmoji. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[CustomEmojiEdge]`](#customemojiedge) | A list of edges. | -| `nodes` | [`[CustomEmoji]`](#customemoji) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupmemberconnectionedges"></a>`edges` | [`[GroupMemberEdge]`](#groupmemberedge) | A list of edges. | +| <a id="groupmemberconnectionnodes"></a>`nodes` | [`[GroupMember]`](#groupmember) | A list of nodes. | +| <a id="groupmemberconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `CustomEmojiEdge` +#### `GroupMemberEdge` -An edge in a connection. +The edge type for [`GroupMember`](#groupmember). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`CustomEmoji`](#customemoji) | The item at the end of the edge. | +##### Fields -### `DastOnDemandScanCreatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupmemberedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="groupmemberedgenode"></a>`node` | [`GroupMember`](#groupmember) | The item at the end of the edge. | -Autogenerated return type of DastOnDemandScanCreate. +#### `GroupWikiRepositoryRegistryConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. | +The connection type for [`GroupWikiRepositoryRegistry`](#groupwikirepositoryregistry). -### `DastProfile` +##### Fields -Represents a DAST Profile. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupwikirepositoryregistryconnectionedges"></a>`edges` | [`[GroupWikiRepositoryRegistryEdge]`](#groupwikirepositoryregistryedge) | A list of edges. | +| <a id="groupwikirepositoryregistryconnectionnodes"></a>`nodes` | [`[GroupWikiRepositoryRegistry]`](#groupwikirepositoryregistry) | A list of nodes. | +| <a id="groupwikirepositoryregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `branch` | [`DastProfileBranch`](#dastprofilebranch) | The associated branch. | -| `dastScannerProfile` | [`DastScannerProfile`](#dastscannerprofile) | The associated scanner profile. | -| `dastSiteProfile` | [`DastSiteProfile`](#dastsiteprofile) | The associated site profile. | -| `description` | [`String`](#string) | The description of the scan. | -| `editPath` | [`String`](#string) | Relative web path to the edit page of a profile. | -| `id` | [`DastProfileID!`](#dastprofileid) | ID of the profile. | -| `name` | [`String`](#string) | The name of the profile. | +#### `GroupWikiRepositoryRegistryEdge` -### `DastProfileBranch` +The edge type for [`GroupWikiRepositoryRegistry`](#groupwikirepositoryregistry). -Represents a DAST Profile Branch. +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupwikirepositoryregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="groupwikirepositoryregistryedgenode"></a>`node` | [`GroupWikiRepositoryRegistry`](#groupwikirepositoryregistry) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `exists` | [`Boolean`](#boolean) | Indicates whether or not the branch exists. | -| `name` | [`String`](#string) | The name of the branch. | +#### `IncidentManagementOncallRotationConnection` -### `DastProfileConnection` +The connection type for [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation). -The connection type for DastProfile. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DastProfileEdge]`](#dastprofileedge) | A list of edges. | -| `nodes` | [`[DastProfile]`](#dastprofile) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallrotationconnectionedges"></a>`edges` | [`[IncidentManagementOncallRotationEdge]`](#incidentmanagementoncallrotationedge) | A list of edges. | +| <a id="incidentmanagementoncallrotationconnectionnodes"></a>`nodes` | [`[IncidentManagementOncallRotation]`](#incidentmanagementoncallrotation) | A list of nodes. | +| <a id="incidentmanagementoncallrotationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `DastProfileCreatePayload` +#### `IncidentManagementOncallRotationEdge` -Autogenerated return type of DastProfileCreate. +The edge type for [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `dastProfile` | [`DastProfile`](#dastprofile) | The created profile. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `pipelineUrl` | [`String`](#string) | The URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`. | +##### Fields -### `DastProfileDeletePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallrotationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="incidentmanagementoncallrotationedgenode"></a>`node` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The item at the end of the edge. | -Autogenerated return type of DastProfileDelete. +#### `IncidentManagementOncallScheduleConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +The connection type for [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule). -### `DastProfileEdge` +##### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallscheduleconnectionedges"></a>`edges` | [`[IncidentManagementOncallScheduleEdge]`](#incidentmanagementoncallscheduleedge) | A list of edges. | +| <a id="incidentmanagementoncallscheduleconnectionnodes"></a>`nodes` | [`[IncidentManagementOncallSchedule]`](#incidentmanagementoncallschedule) | A list of nodes. | +| <a id="incidentmanagementoncallscheduleconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`DastProfile`](#dastprofile) | The item at the end of the edge. | +#### `IncidentManagementOncallScheduleEdge` -### `DastProfileRunPayload` +The edge type for [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule). -Autogenerated return type of DastProfileRun. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallscheduleedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="incidentmanagementoncallscheduleedgenode"></a>`node` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The item at the end of the edge. | -### `DastProfileUpdatePayload` +#### `IncidentManagementOncallShiftConnection` -Autogenerated return type of DastProfileUpdate. +The connection type for [`IncidentManagementOncallShift`](#incidentmanagementoncallshift). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `dastProfile` | [`DastProfile`](#dastprofile) | The updated profile. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `pipelineUrl` | [`String`](#string) | The URL of the pipeline that was created. Requires the input argument `runAfterUpdate` to be set to `true` when calling the mutation, otherwise no pipeline will be created. | +##### Fields -### `DastScannerProfile` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallshiftconnectionedges"></a>`edges` | [`[IncidentManagementOncallShiftEdge]`](#incidentmanagementoncallshiftedge) | A list of edges. | +| <a id="incidentmanagementoncallshiftconnectionnodes"></a>`nodes` | [`[IncidentManagementOncallShift]`](#incidentmanagementoncallshift) | A list of nodes. | +| <a id="incidentmanagementoncallshiftconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Represents a DAST scanner profile. +#### `IncidentManagementOncallShiftEdge` + +The edge type for [`IncidentManagementOncallShift`](#incidentmanagementoncallshift). + +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `editPath` | [`String`](#string) | Relative web path to the edit page of a scanner profile. | -| `globalId` **{warning-solid}** | [`DastScannerProfileID!`](#dastscannerprofileid) | **Deprecated** in 13.6. Use `id`. | -| `id` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the DAST scanner profile. | -| `profileName` | [`String`](#string) | Name of the DAST scanner profile. | -| `referencedInSecurityPolicies` | [`[String!]`](#string) | List of security policy names that are referencing given project. | -| `scanType` | [`DastScanTypeEnum`](#dastscantypeenum) | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. | -| `showDebugMessages` | [`Boolean!`](#boolean) | Indicates if debug messages should be included in DAST console output. True to include the debug messages. | -| `spiderTimeout` | [`Int`](#int) | The maximum number of minutes allowed for the spider to traverse the site. | -| `targetTimeout` | [`Int`](#int) | The maximum number of seconds allowed for the site under test to respond to a request. | -| `useAjaxSpider` | [`Boolean!`](#boolean) | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallshiftedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="incidentmanagementoncallshiftedgenode"></a>`node` | [`IncidentManagementOncallShift`](#incidentmanagementoncallshift) | The item at the end of the edge. | + +#### `IssueConnection` -### `DastScannerProfileConnection` +The connection type for [`Issue`](#issue). -The connection type for DastScannerProfile. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DastScannerProfileEdge]`](#dastscannerprofileedge) | A list of edges. | -| `nodes` | [`[DastScannerProfile]`](#dastscannerprofile) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="issueconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="issueconnectionedges"></a>`edges` | [`[IssueEdge]`](#issueedge) | A list of edges. | +| <a id="issueconnectionnodes"></a>`nodes` | [`[Issue]`](#issue) | A list of nodes. | +| <a id="issueconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| <a id="issueconnectionweight"></a>`weight` | [`Int!`](#int) | Total weight of issues collection. | -### `DastScannerProfileCreatePayload` +#### `IssueEdge` -Autogenerated return type of DastScannerProfileCreate. +The edge type for [`Issue`](#issue). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `globalId` **{warning-solid}** | [`DastScannerProfileID`](#dastscannerprofileid) | **Deprecated** in 13.6. Use `id`. | -| `id` | [`DastScannerProfileID`](#dastscannerprofileid) | ID of the scanner profile. | +##### Fields -### `DastScannerProfileDeletePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="issueedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="issueedgenode"></a>`node` | [`Issue`](#issue) | The item at the end of the edge. | -Autogenerated return type of DastScannerProfileDelete. +#### `IterationCadenceConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +The connection type for [`IterationCadence`](#iterationcadence). -### `DastScannerProfileEdge` +##### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="iterationcadenceconnectionedges"></a>`edges` | [`[IterationCadenceEdge]`](#iterationcadenceedge) | A list of edges. | +| <a id="iterationcadenceconnectionnodes"></a>`nodes` | [`[IterationCadence]`](#iterationcadence) | A list of nodes. | +| <a id="iterationcadenceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`DastScannerProfile`](#dastscannerprofile) | The item at the end of the edge. | +#### `IterationCadenceEdge` -### `DastScannerProfileUpdatePayload` +The edge type for [`IterationCadence`](#iterationcadence). -Autogenerated return type of DastScannerProfileUpdate. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `id` | [`DastScannerProfileID`](#dastscannerprofileid) | ID of the scanner profile. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="iterationcadenceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="iterationcadenceedgenode"></a>`node` | [`IterationCadence`](#iterationcadence) | The item at the end of the edge. | -### `DastSiteProfile` +#### `IterationConnection` -Represents a DAST Site Profile. +The connection type for [`Iteration`](#iteration). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `auth` | [`DastSiteProfileAuth`](#dastsiteprofileauth) | Target authentication details. Will always return `null` if `security_dast_site_profiles_additional_fields` feature flag is disabled. | -| `editPath` | [`String`](#string) | Relative web path to the edit page of a site profile. | -| `excludedUrls` | [`[String!]`](#string) | The URLs to skip during an authenticated scan. Will always return `null` if `security_dast_site_profiles_additional_fields` feature flag is disabled. | -| `id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile. | -| `normalizedTargetUrl` | [`String`](#string) | Normalized URL of the target to be scanned. | -| `profileName` | [`String`](#string) | The name of the site profile. | -| `referencedInSecurityPolicies` | [`[String!]`](#string) | List of security policy names that are referencing given project. | -| `requestHeaders` | [`String`](#string) | Comma-separated list of request header names and values to be added to every request made by DAST. Will always return `null` if `security_dast_site_profiles_additional_fields` feature flag is disabled. | -| `targetType` | [`DastTargetTypeEnum`](#dasttargettypeenum) | The type of target to be scanned. Will always return `null` if `security_dast_site_profiles_api_option` feature flag is disabled. | -| `targetUrl` | [`String`](#string) | The URL of the target to be scanned. | -| `userPermissions` | [`DastSiteProfilePermissions!`](#dastsiteprofilepermissions) | Permissions for the current user on the resource. | -| `validationStatus` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | The current validation status of the site profile. | +##### Fields -### `DastSiteProfileAuth` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="iterationconnectionedges"></a>`edges` | [`[IterationEdge]`](#iterationedge) | A list of edges. | +| <a id="iterationconnectionnodes"></a>`nodes` | [`[Iteration]`](#iteration) | A list of nodes. | +| <a id="iterationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Input type for DastSiteProfile authentication. +#### `IterationEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `enabled` | [`Boolean`](#boolean) | Indicates whether authentication is enabled. | -| `password` | [`String`](#string) | Redacted password to authenticate with on the target website. | -| `passwordField` | [`String`](#string) | The name of password field at the sign-in HTML form. | -| `url` | [`String`](#string) | The URL of the page containing the sign-in HTML form on the target website. | -| `username` | [`String`](#string) | The username to authenticate with on the target website. | -| `usernameField` | [`String`](#string) | The name of username field at the sign-in HTML form. | +The edge type for [`Iteration`](#iteration). -### `DastSiteProfileConnection` +##### Fields -The connection type for DastSiteProfile. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="iterationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="iterationedgenode"></a>`node` | [`Iteration`](#iteration) | The item at the end of the edge. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DastSiteProfileEdge]`](#dastsiteprofileedge) | A list of edges. | -| `nodes` | [`[DastSiteProfile]`](#dastsiteprofile) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### `JiraImportConnection` -### `DastSiteProfileCreatePayload` +The connection type for [`JiraImport`](#jiraimport). -Autogenerated return type of DastSiteProfileCreate. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `id` | [`DastSiteProfileID`](#dastsiteprofileid) | ID of the site profile. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jiraimportconnectionedges"></a>`edges` | [`[JiraImportEdge]`](#jiraimportedge) | A list of edges. | +| <a id="jiraimportconnectionnodes"></a>`nodes` | [`[JiraImport]`](#jiraimport) | A list of nodes. | +| <a id="jiraimportconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -### `DastSiteProfileDeletePayload` +#### `JiraImportEdge` -Autogenerated return type of DastSiteProfileDelete. +The edge type for [`JiraImport`](#jiraimport). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +##### Fields -### `DastSiteProfileEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jiraimportedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="jiraimportedgenode"></a>`node` | [`JiraImport`](#jiraimport) | The item at the end of the edge. | -An edge in a connection. +#### `JiraProjectConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`DastSiteProfile`](#dastsiteprofile) | The item at the end of the edge. | +The connection type for [`JiraProject`](#jiraproject). -### `DastSiteProfilePermissions` +##### Fields -Check permissions for the current user on site profile. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jiraprojectconnectionedges"></a>`edges` | [`[JiraProjectEdge]`](#jiraprojectedge) | A list of edges. | +| <a id="jiraprojectconnectionnodes"></a>`nodes` | [`[JiraProject]`](#jiraproject) | A list of nodes. | +| <a id="jiraprojectconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createOnDemandDastScan` | [`Boolean!`](#boolean) | Indicates the user can perform `create_on_demand_dast_scan` on this resource. | +#### `JiraProjectEdge` -### `DastSiteProfileUpdatePayload` +The edge type for [`JiraProject`](#jiraproject). -Autogenerated return type of DastSiteProfileUpdate. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `id` | [`DastSiteProfileID`](#dastsiteprofileid) | ID of the site profile. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jiraprojectedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="jiraprojectedgenode"></a>`node` | [`JiraProject`](#jiraproject) | The item at the end of the edge. | -### `DastSiteTokenCreatePayload` +#### `LabelConnection` -Autogenerated return type of DastSiteTokenCreate. +The connection type for [`Label`](#label). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `id` | [`DastSiteTokenID`](#dastsitetokenid) | ID of the site token. | -| `status` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | The current validation status of the target. | -| `token` | [`String`](#string) | Token string. | +##### Fields -### `DastSiteValidation` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="labelconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="labelconnectionedges"></a>`edges` | [`[LabelEdge]`](#labeledge) | A list of edges. | +| <a id="labelconnectionnodes"></a>`nodes` | [`[Label]`](#label) | A list of nodes. | +| <a id="labelconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -Represents a DAST Site Validation. +#### `LabelEdge` + +The edge type for [`Label`](#label). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="labeledgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="labeledgenode"></a>`node` | [`Label`](#label) | The item at the end of the edge. | + +#### `LfsObjectRegistryConnection` + +The connection type for [`LfsObjectRegistry`](#lfsobjectregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="lfsobjectregistryconnectionedges"></a>`edges` | [`[LfsObjectRegistryEdge]`](#lfsobjectregistryedge) | A list of edges. | +| <a id="lfsobjectregistryconnectionnodes"></a>`nodes` | [`[LfsObjectRegistry]`](#lfsobjectregistry) | A list of nodes. | +| <a id="lfsobjectregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `LfsObjectRegistryEdge` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `id` | [`DastSiteValidationID!`](#dastsitevalidationid) | Global ID of the site validation. | -| `normalizedTargetUrl` | [`String`](#string) | Normalized URL of the target to be validated. | -| `status` | [`DastSiteProfileValidationStatusEnum!`](#dastsiteprofilevalidationstatusenum) | Status of the site validation. | +The edge type for [`LfsObjectRegistry`](#lfsobjectregistry). -### `DastSiteValidationConnection` +##### Fields -The connection type for DastSiteValidation. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="lfsobjectregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="lfsobjectregistryedgenode"></a>`node` | [`LfsObjectRegistry`](#lfsobjectregistry) | The item at the end of the edge. | + +#### `LicenseHistoryEntryConnection` + +The connection type for [`LicenseHistoryEntry`](#licensehistoryentry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="licensehistoryentryconnectionedges"></a>`edges` | [`[LicenseHistoryEntryEdge]`](#licensehistoryentryedge) | A list of edges. | +| <a id="licensehistoryentryconnectionnodes"></a>`nodes` | [`[LicenseHistoryEntry]`](#licensehistoryentry) | A list of nodes. | +| <a id="licensehistoryentryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `LicenseHistoryEntryEdge` + +The edge type for [`LicenseHistoryEntry`](#licensehistoryentry). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DastSiteValidationEdge]`](#dastsitevalidationedge) | A list of edges. | -| `nodes` | [`[DastSiteValidation]`](#dastsitevalidation) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### Fields -### `DastSiteValidationCreatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="licensehistoryentryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="licensehistoryentryedgenode"></a>`node` | [`LicenseHistoryEntry`](#licensehistoryentry) | The item at the end of the edge. | + +#### `MemberInterfaceConnection` + +The connection type for [`MemberInterface`](#memberinterface). + +##### Fields -Autogenerated return type of DastSiteValidationCreate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="memberinterfaceconnectionedges"></a>`edges` | [`[MemberInterfaceEdge]`](#memberinterfaceedge) | A list of edges. | +| <a id="memberinterfaceconnectionnodes"></a>`nodes` | [`[MemberInterface]`](#memberinterface) | A list of nodes. | +| <a id="memberinterfaceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `id` | [`DastSiteValidationID`](#dastsitevalidationid) | ID of the site validation. | -| `status` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | The current validation status. | +#### `MemberInterfaceEdge` -### `DastSiteValidationEdge` +The edge type for [`MemberInterface`](#memberinterface). -An edge in a connection. +##### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`DastSiteValidation`](#dastsitevalidation) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="memberinterfaceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="memberinterfaceedgenode"></a>`node` | [`MemberInterface`](#memberinterface) | The item at the end of the edge. | -### `DastSiteValidationRevokePayload` +#### `MergeRequestAssigneeConnection` -Autogenerated return type of DastSiteValidationRevoke. +The connection type for [`MergeRequestAssignee`](#mergerequestassignee). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +##### Fields -### `DeleteAnnotationPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneeconnectionedges"></a>`edges` | [`[MergeRequestAssigneeEdge]`](#mergerequestassigneeedge) | A list of edges. | +| <a id="mergerequestassigneeconnectionnodes"></a>`nodes` | [`[MergeRequestAssignee]`](#mergerequestassignee) | A list of nodes. | +| <a id="mergerequestassigneeconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `MergeRequestAssigneeEdge` + +The edge type for [`MergeRequestAssignee`](#mergerequestassignee). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneeedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="mergerequestassigneeedgenode"></a>`node` | [`MergeRequestAssignee`](#mergerequestassignee) | The item at the end of the edge. | + +#### `MergeRequestConnection` + +The connection type for [`MergeRequest`](#mergerequest). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="mergerequestconnectionedges"></a>`edges` | [`[MergeRequestEdge]`](#mergerequestedge) | A list of edges. | +| <a id="mergerequestconnectionnodes"></a>`nodes` | [`[MergeRequest]`](#mergerequest) | A list of nodes. | +| <a id="mergerequestconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| <a id="mergerequestconnectiontotaltimetomerge"></a>`totalTimeToMerge` | [`Float`](#float) | Total sum of time to merge, in seconds, for the collection of merge requests. | + +#### `MergeRequestDiffRegistryConnection` + +The connection type for [`MergeRequestDiffRegistry`](#mergerequestdiffregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestdiffregistryconnectionedges"></a>`edges` | [`[MergeRequestDiffRegistryEdge]`](#mergerequestdiffregistryedge) | A list of edges. | +| <a id="mergerequestdiffregistryconnectionnodes"></a>`nodes` | [`[MergeRequestDiffRegistry]`](#mergerequestdiffregistry) | A list of nodes. | +| <a id="mergerequestdiffregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `MergeRequestDiffRegistryEdge` + +The edge type for [`MergeRequestDiffRegistry`](#mergerequestdiffregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestdiffregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="mergerequestdiffregistryedgenode"></a>`node` | [`MergeRequestDiffRegistry`](#mergerequestdiffregistry) | The item at the end of the edge. | + +#### `MergeRequestEdge` + +The edge type for [`MergeRequest`](#mergerequest). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="mergerequestedgenode"></a>`node` | [`MergeRequest`](#mergerequest) | The item at the end of the edge. | + +#### `MergeRequestReviewerConnection` + +The connection type for [`MergeRequestReviewer`](#mergerequestreviewer). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestreviewerconnectionedges"></a>`edges` | [`[MergeRequestReviewerEdge]`](#mergerequestrevieweredge) | A list of edges. | +| <a id="mergerequestreviewerconnectionnodes"></a>`nodes` | [`[MergeRequestReviewer]`](#mergerequestreviewer) | A list of nodes. | +| <a id="mergerequestreviewerconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `MergeRequestReviewerEdge` + +The edge type for [`MergeRequestReviewer`](#mergerequestreviewer). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestrevieweredgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="mergerequestrevieweredgenode"></a>`node` | [`MergeRequestReviewer`](#mergerequestreviewer) | The item at the end of the edge. | + +#### `MetricsDashboardAnnotationConnection` + +The connection type for [`MetricsDashboardAnnotation`](#metricsdashboardannotation). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="metricsdashboardannotationconnectionedges"></a>`edges` | [`[MetricsDashboardAnnotationEdge]`](#metricsdashboardannotationedge) | A list of edges. | +| <a id="metricsdashboardannotationconnectionnodes"></a>`nodes` | [`[MetricsDashboardAnnotation]`](#metricsdashboardannotation) | A list of nodes. | +| <a id="metricsdashboardannotationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `MetricsDashboardAnnotationEdge` + +The edge type for [`MetricsDashboardAnnotation`](#metricsdashboardannotation). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="metricsdashboardannotationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="metricsdashboardannotationedgenode"></a>`node` | [`MetricsDashboardAnnotation`](#metricsdashboardannotation) | The item at the end of the edge. | + +#### `MilestoneConnection` + +The connection type for [`Milestone`](#milestone). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="milestoneconnectionedges"></a>`edges` | [`[MilestoneEdge]`](#milestoneedge) | A list of edges. | +| <a id="milestoneconnectionnodes"></a>`nodes` | [`[Milestone]`](#milestone) | A list of nodes. | +| <a id="milestoneconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `MilestoneEdge` + +The edge type for [`Milestone`](#milestone). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="milestoneedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="milestoneedgenode"></a>`node` | [`Milestone`](#milestone) | The item at the end of the edge. | + +#### `NamespaceConnection` + +The connection type for [`Namespace`](#namespace). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="namespaceconnectionedges"></a>`edges` | [`[NamespaceEdge]`](#namespaceedge) | A list of edges. | +| <a id="namespaceconnectionnodes"></a>`nodes` | [`[Namespace]`](#namespace) | A list of nodes. | +| <a id="namespaceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `NamespaceEdge` + +The edge type for [`Namespace`](#namespace). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="namespaceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="namespaceedgenode"></a>`node` | [`Namespace`](#namespace) | The item at the end of the edge. | -Autogenerated return type of DeleteAnnotation. +#### `NoteConnection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +The connection type for [`Note`](#note). -### `DeleteDevopsAdoptionSegmentPayload` +##### Fields -Autogenerated return type of DeleteDevopsAdoptionSegment. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="noteconnectionedges"></a>`edges` | [`[NoteEdge]`](#noteedge) | A list of edges. | +| <a id="noteconnectionnodes"></a>`nodes` | [`[Note]`](#note) | A list of nodes. | +| <a id="noteconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `NoteEdge` + +The edge type for [`Note`](#note). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="noteedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="noteedgenode"></a>`node` | [`Note`](#note) | The item at the end of the edge. | + +#### `OncallParticipantTypeConnection` + +The connection type for [`OncallParticipantType`](#oncallparticipanttype). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="oncallparticipanttypeconnectionedges"></a>`edges` | [`[OncallParticipantTypeEdge]`](#oncallparticipanttypeedge) | A list of edges. | +| <a id="oncallparticipanttypeconnectionnodes"></a>`nodes` | [`[OncallParticipantType]`](#oncallparticipanttype) | A list of nodes. | +| <a id="oncallparticipanttypeconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `OncallParticipantTypeEdge` + +The edge type for [`OncallParticipantType`](#oncallparticipanttype). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="oncallparticipanttypeedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="oncallparticipanttypeedgenode"></a>`node` | [`OncallParticipantType`](#oncallparticipanttype) | The item at the end of the edge. | + +#### `PackageConnection` + +The connection type for [`Package`](#package). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packageconnectionedges"></a>`edges` | [`[PackageEdge]`](#packageedge) | A list of edges. | +| <a id="packageconnectionnodes"></a>`nodes` | [`[Package]`](#package) | A list of nodes. | +| <a id="packageconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `PackageEdge` + +The edge type for [`Package`](#package). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packageedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="packageedgenode"></a>`node` | [`Package`](#package) | The item at the end of the edge. | + +#### `PackageFileConnection` + +The connection type for [`PackageFile`](#packagefile). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagefileconnectionedges"></a>`edges` | [`[PackageFileEdge]`](#packagefileedge) | A list of edges. | +| <a id="packagefileconnectionnodes"></a>`nodes` | [`[PackageFile]`](#packagefile) | A list of nodes. | +| <a id="packagefileconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `PackageFileEdge` + +The edge type for [`PackageFile`](#packagefile). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagefileedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="packagefileedgenode"></a>`node` | [`PackageFile`](#packagefile) | The item at the end of the edge. | + +#### `PackageFileRegistryConnection` + +The connection type for [`PackageFileRegistry`](#packagefileregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagefileregistryconnectionedges"></a>`edges` | [`[PackageFileRegistryEdge]`](#packagefileregistryedge) | A list of edges. | +| <a id="packagefileregistryconnectionnodes"></a>`nodes` | [`[PackageFileRegistry]`](#packagefileregistry) | A list of nodes. | +| <a id="packagefileregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `PackageFileRegistryEdge` + +The edge type for [`PackageFileRegistry`](#packagefileregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagefileregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="packagefileregistryedgenode"></a>`node` | [`PackageFileRegistry`](#packagefileregistry) | The item at the end of the edge. | + +#### `PackageTagConnection` + +The connection type for [`PackageTag`](#packagetag). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagetagconnectionedges"></a>`edges` | [`[PackageTagEdge]`](#packagetagedge) | A list of edges. | +| <a id="packagetagconnectionnodes"></a>`nodes` | [`[PackageTag]`](#packagetag) | A list of nodes. | +| <a id="packagetagconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `PackageTagEdge` + +The edge type for [`PackageTag`](#packagetag). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagetagedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="packagetagedgenode"></a>`node` | [`PackageTag`](#packagetag) | The item at the end of the edge. | + +#### `PathLockConnection` + +The connection type for [`PathLock`](#pathlock). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pathlockconnectionedges"></a>`edges` | [`[PathLockEdge]`](#pathlockedge) | A list of edges. | +| <a id="pathlockconnectionnodes"></a>`nodes` | [`[PathLock]`](#pathlock) | A list of nodes. | +| <a id="pathlockconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `PathLockEdge` + +The edge type for [`PathLock`](#pathlock). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pathlockedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="pathlockedgenode"></a>`node` | [`PathLock`](#pathlock) | The item at the end of the edge. | + +#### `PipelineArtifactRegistryConnection` + +The connection type for [`PipelineArtifactRegistry`](#pipelineartifactregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelineartifactregistryconnectionedges"></a>`edges` | [`[PipelineArtifactRegistryEdge]`](#pipelineartifactregistryedge) | A list of edges. | +| <a id="pipelineartifactregistryconnectionnodes"></a>`nodes` | [`[PipelineArtifactRegistry]`](#pipelineartifactregistry) | A list of nodes. | +| <a id="pipelineartifactregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `PipelineArtifactRegistryEdge` + +The edge type for [`PipelineArtifactRegistry`](#pipelineartifactregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelineartifactregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="pipelineartifactregistryedgenode"></a>`node` | [`PipelineArtifactRegistry`](#pipelineartifactregistry) | The item at the end of the edge. | + +#### `PipelineConnection` + +The connection type for [`Pipeline`](#pipeline). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelineconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="pipelineconnectionedges"></a>`edges` | [`[PipelineEdge]`](#pipelineedge) | A list of edges. | +| <a id="pipelineconnectionnodes"></a>`nodes` | [`[Pipeline]`](#pipeline) | A list of nodes. | +| <a id="pipelineconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `PipelineEdge` + +The edge type for [`Pipeline`](#pipeline). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelineedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="pipelineedgenode"></a>`node` | [`Pipeline`](#pipeline) | The item at the end of the edge. | + +#### `PipelineSecurityReportFindingConnection` + +The connection type for [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinesecurityreportfindingconnectionedges"></a>`edges` | [`[PipelineSecurityReportFindingEdge]`](#pipelinesecurityreportfindingedge) | A list of edges. | +| <a id="pipelinesecurityreportfindingconnectionnodes"></a>`nodes` | [`[PipelineSecurityReportFinding]`](#pipelinesecurityreportfinding) | A list of nodes. | +| <a id="pipelinesecurityreportfindingconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `PipelineSecurityReportFindingEdge` + +The edge type for [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinesecurityreportfindingedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="pipelinesecurityreportfindingedgenode"></a>`node` | [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding) | The item at the end of the edge. | + +#### `ProjectConnection` + +The connection type for [`Project`](#project). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectconnectionedges"></a>`edges` | [`[ProjectEdge]`](#projectedge) | A list of edges. | +| <a id="projectconnectionnodes"></a>`nodes` | [`[Project]`](#project) | A list of nodes. | +| <a id="projectconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `ProjectEdge` + +The edge type for [`Project`](#project). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="projectedgenode"></a>`node` | [`Project`](#project) | The item at the end of the edge. | + +#### `ProjectMemberConnection` + +The connection type for [`ProjectMember`](#projectmember). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectmemberconnectionedges"></a>`edges` | [`[ProjectMemberEdge]`](#projectmemberedge) | A list of edges. | +| <a id="projectmemberconnectionnodes"></a>`nodes` | [`[ProjectMember]`](#projectmember) | A list of nodes. | +| <a id="projectmemberconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `ProjectMemberEdge` + +The edge type for [`ProjectMember`](#projectmember). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectmemberedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="projectmemberedgenode"></a>`node` | [`ProjectMember`](#projectmember) | The item at the end of the edge. | + +#### `ReleaseAssetLinkConnection` + +The connection type for [`ReleaseAssetLink`](#releaseassetlink). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseassetlinkconnectionedges"></a>`edges` | [`[ReleaseAssetLinkEdge]`](#releaseassetlinkedge) | A list of edges. | +| <a id="releaseassetlinkconnectionnodes"></a>`nodes` | [`[ReleaseAssetLink]`](#releaseassetlink) | A list of nodes. | +| <a id="releaseassetlinkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `ReleaseAssetLinkEdge` + +The edge type for [`ReleaseAssetLink`](#releaseassetlink). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseassetlinkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="releaseassetlinkedgenode"></a>`node` | [`ReleaseAssetLink`](#releaseassetlink) | The item at the end of the edge. | + +#### `ReleaseConnection` + +The connection type for [`Release`](#release). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="releaseconnectionedges"></a>`edges` | [`[ReleaseEdge]`](#releaseedge) | A list of edges. | +| <a id="releaseconnectionnodes"></a>`nodes` | [`[Release]`](#release) | A list of nodes. | +| <a id="releaseconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### `ReleaseEdge` + +The edge type for [`Release`](#release). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="releaseedgenode"></a>`node` | [`Release`](#release) | The item at the end of the edge. | + +#### `ReleaseEvidenceConnection` + +The connection type for [`ReleaseEvidence`](#releaseevidence). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseevidenceconnectionedges"></a>`edges` | [`[ReleaseEvidenceEdge]`](#releaseevidenceedge) | A list of edges. | +| <a id="releaseevidenceconnectionnodes"></a>`nodes` | [`[ReleaseEvidence]`](#releaseevidence) | A list of nodes. | +| <a id="releaseevidenceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `ReleaseEvidenceEdge` + +The edge type for [`ReleaseEvidence`](#releaseevidence). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseevidenceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="releaseevidenceedgenode"></a>`node` | [`ReleaseEvidence`](#releaseevidence) | The item at the end of the edge. | + +#### `ReleaseSourceConnection` + +The connection type for [`ReleaseSource`](#releasesource). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releasesourceconnectionedges"></a>`edges` | [`[ReleaseSourceEdge]`](#releasesourceedge) | A list of edges. | +| <a id="releasesourceconnectionnodes"></a>`nodes` | [`[ReleaseSource]`](#releasesource) | A list of nodes. | +| <a id="releasesourceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `ReleaseSourceEdge` + +The edge type for [`ReleaseSource`](#releasesource). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releasesourceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="releasesourceedgenode"></a>`node` | [`ReleaseSource`](#releasesource) | The item at the end of the edge. | + +#### `RepositoryBlobConnection` + +The connection type for [`RepositoryBlob`](#repositoryblob). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="repositoryblobconnectionedges"></a>`edges` | [`[RepositoryBlobEdge]`](#repositoryblobedge) | A list of edges. | +| <a id="repositoryblobconnectionnodes"></a>`nodes` | [`[RepositoryBlob]`](#repositoryblob) | A list of nodes. | +| <a id="repositoryblobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `RepositoryBlobEdge` + +The edge type for [`RepositoryBlob`](#repositoryblob). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="repositoryblobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="repositoryblobedgenode"></a>`node` | [`RepositoryBlob`](#repositoryblob) | The item at the end of the edge. | + +#### `RequirementConnection` + +The connection type for [`Requirement`](#requirement). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="requirementconnectionedges"></a>`edges` | [`[RequirementEdge]`](#requirementedge) | A list of edges. | +| <a id="requirementconnectionnodes"></a>`nodes` | [`[Requirement]`](#requirement) | A list of nodes. | +| <a id="requirementconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `RequirementEdge` + +The edge type for [`Requirement`](#requirement). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="requirementedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="requirementedgenode"></a>`node` | [`Requirement`](#requirement) | The item at the end of the edge. | + +#### `RunnerArchitectureConnection` + +The connection type for [`RunnerArchitecture`](#runnerarchitecture). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="runnerarchitectureconnectionedges"></a>`edges` | [`[RunnerArchitectureEdge]`](#runnerarchitectureedge) | A list of edges. | +| <a id="runnerarchitectureconnectionnodes"></a>`nodes` | [`[RunnerArchitecture]`](#runnerarchitecture) | A list of nodes. | +| <a id="runnerarchitectureconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `RunnerArchitectureEdge` + +The edge type for [`RunnerArchitecture`](#runnerarchitecture). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="runnerarchitectureedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="runnerarchitectureedgenode"></a>`node` | [`RunnerArchitecture`](#runnerarchitecture) | The item at the end of the edge. | + +#### `RunnerPlatformConnection` + +The connection type for [`RunnerPlatform`](#runnerplatform). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="runnerplatformconnectionedges"></a>`edges` | [`[RunnerPlatformEdge]`](#runnerplatformedge) | A list of edges. | +| <a id="runnerplatformconnectionnodes"></a>`nodes` | [`[RunnerPlatform]`](#runnerplatform) | A list of nodes. | +| <a id="runnerplatformconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `RunnerPlatformEdge` + +The edge type for [`RunnerPlatform`](#runnerplatform). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="runnerplatformedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="runnerplatformedgenode"></a>`node` | [`RunnerPlatform`](#runnerplatform) | The item at the end of the edge. | + +#### `SastCiConfigurationAnalyzersEntityConnection` + +The connection type for [`SastCiConfigurationAnalyzersEntity`](#sastciconfigurationanalyzersentity). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationanalyzersentityconnectionedges"></a>`edges` | [`[SastCiConfigurationAnalyzersEntityEdge]`](#sastciconfigurationanalyzersentityedge) | A list of edges. | +| <a id="sastciconfigurationanalyzersentityconnectionnodes"></a>`nodes` | [`[SastCiConfigurationAnalyzersEntity]`](#sastciconfigurationanalyzersentity) | A list of nodes. | +| <a id="sastciconfigurationanalyzersentityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `SastCiConfigurationAnalyzersEntityEdge` + +The edge type for [`SastCiConfigurationAnalyzersEntity`](#sastciconfigurationanalyzersentity). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationanalyzersentityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="sastciconfigurationanalyzersentityedgenode"></a>`node` | [`SastCiConfigurationAnalyzersEntity`](#sastciconfigurationanalyzersentity) | The item at the end of the edge. | + +#### `SastCiConfigurationEntityConnection` + +The connection type for [`SastCiConfigurationEntity`](#sastciconfigurationentity). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationentityconnectionedges"></a>`edges` | [`[SastCiConfigurationEntityEdge]`](#sastciconfigurationentityedge) | A list of edges. | +| <a id="sastciconfigurationentityconnectionnodes"></a>`nodes` | [`[SastCiConfigurationEntity]`](#sastciconfigurationentity) | A list of nodes. | +| <a id="sastciconfigurationentityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `SastCiConfigurationEntityEdge` + +The edge type for [`SastCiConfigurationEntity`](#sastciconfigurationentity). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationentityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="sastciconfigurationentityedgenode"></a>`node` | [`SastCiConfigurationEntity`](#sastciconfigurationentity) | The item at the end of the edge. | + +#### `SastCiConfigurationOptionsEntityConnection` + +The connection type for [`SastCiConfigurationOptionsEntity`](#sastciconfigurationoptionsentity). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationoptionsentityconnectionedges"></a>`edges` | [`[SastCiConfigurationOptionsEntityEdge]`](#sastciconfigurationoptionsentityedge) | A list of edges. | +| <a id="sastciconfigurationoptionsentityconnectionnodes"></a>`nodes` | [`[SastCiConfigurationOptionsEntity]`](#sastciconfigurationoptionsentity) | A list of nodes. | +| <a id="sastciconfigurationoptionsentityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `SastCiConfigurationOptionsEntityEdge` + +The edge type for [`SastCiConfigurationOptionsEntity`](#sastciconfigurationoptionsentity). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationoptionsentityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="sastciconfigurationoptionsentityedgenode"></a>`node` | [`SastCiConfigurationOptionsEntity`](#sastciconfigurationoptionsentity) | The item at the end of the edge. | + +#### `ScanConnection` + +The connection type for [`Scan`](#scan). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="scanconnectionedges"></a>`edges` | [`[ScanEdge]`](#scanedge) | A list of edges. | +| <a id="scanconnectionnodes"></a>`nodes` | [`[Scan]`](#scan) | A list of nodes. | +| <a id="scanconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `ScanEdge` + +The edge type for [`Scan`](#scan). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="scanedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="scanedgenode"></a>`node` | [`Scan`](#scan) | The item at the end of the edge. | + +#### `ScannedResourceConnection` + +The connection type for [`ScannedResource`](#scannedresource). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="scannedresourceconnectionedges"></a>`edges` | [`[ScannedResourceEdge]`](#scannedresourceedge) | A list of edges. | +| <a id="scannedresourceconnectionnodes"></a>`nodes` | [`[ScannedResource]`](#scannedresource) | A list of nodes. | +| <a id="scannedresourceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `ScannedResourceEdge` + +The edge type for [`ScannedResource`](#scannedresource). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="scannedresourceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="scannedresourceedgenode"></a>`node` | [`ScannedResource`](#scannedresource) | The item at the end of the edge. | + +#### `SentryErrorConnection` + +The connection type for [`SentryError`](#sentryerror). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorconnectionedges"></a>`edges` | [`[SentryErrorEdge]`](#sentryerroredge) | A list of edges. | +| <a id="sentryerrorconnectionnodes"></a>`nodes` | [`[SentryError]`](#sentryerror) | A list of nodes. | +| <a id="sentryerrorconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `SentryErrorEdge` + +The edge type for [`SentryError`](#sentryerror). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerroredgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="sentryerroredgenode"></a>`node` | [`SentryError`](#sentryerror) | The item at the end of the edge. | + +#### `ServiceConnection` + +The connection type for [`Service`](#service). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="serviceconnectionedges"></a>`edges` | [`[ServiceEdge]`](#serviceedge) | A list of edges. | +| <a id="serviceconnectionnodes"></a>`nodes` | [`[Service]`](#service) | A list of nodes. | +| <a id="serviceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `ServiceEdge` + +The edge type for [`Service`](#service). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="serviceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="serviceedgenode"></a>`node` | [`Service`](#service) | The item at the end of the edge. | + +#### `SnippetBlobConnection` + +The connection type for [`SnippetBlob`](#snippetblob). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetblobconnectionedges"></a>`edges` | [`[SnippetBlobEdge]`](#snippetblobedge) | A list of edges. | +| <a id="snippetblobconnectionnodes"></a>`nodes` | [`[SnippetBlob]`](#snippetblob) | A list of nodes. | +| <a id="snippetblobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `SnippetBlobEdge` + +The edge type for [`SnippetBlob`](#snippetblob). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetblobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="snippetblobedgenode"></a>`node` | [`SnippetBlob`](#snippetblob) | The item at the end of the edge. | + +#### `SnippetConnection` + +The connection type for [`Snippet`](#snippet). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetconnectionedges"></a>`edges` | [`[SnippetEdge]`](#snippetedge) | A list of edges. | +| <a id="snippetconnectionnodes"></a>`nodes` | [`[Snippet]`](#snippet) | A list of nodes. | +| <a id="snippetconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `SnippetEdge` + +The edge type for [`Snippet`](#snippet). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="snippetedgenode"></a>`node` | [`Snippet`](#snippet) | The item at the end of the edge. | + +#### `SnippetRepositoryRegistryConnection` + +The connection type for [`SnippetRepositoryRegistry`](#snippetrepositoryregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetrepositoryregistryconnectionedges"></a>`edges` | [`[SnippetRepositoryRegistryEdge]`](#snippetrepositoryregistryedge) | A list of edges. | +| <a id="snippetrepositoryregistryconnectionnodes"></a>`nodes` | [`[SnippetRepositoryRegistry]`](#snippetrepositoryregistry) | A list of nodes. | +| <a id="snippetrepositoryregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `SnippetRepositoryRegistryEdge` + +The edge type for [`SnippetRepositoryRegistry`](#snippetrepositoryregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetrepositoryregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="snippetrepositoryregistryedgenode"></a>`node` | [`SnippetRepositoryRegistry`](#snippetrepositoryregistry) | The item at the end of the edge. | + +#### `SubmoduleConnection` + +The connection type for [`Submodule`](#submodule). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="submoduleconnectionedges"></a>`edges` | [`[SubmoduleEdge]`](#submoduleedge) | A list of edges. | +| <a id="submoduleconnectionnodes"></a>`nodes` | [`[Submodule]`](#submodule) | A list of nodes. | +| <a id="submoduleconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `SubmoduleEdge` + +The edge type for [`Submodule`](#submodule). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="submoduleedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="submoduleedgenode"></a>`node` | [`Submodule`](#submodule) | The item at the end of the edge. | + +#### `TerraformStateConnection` + +The connection type for [`TerraformState`](#terraformstate). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="terraformstateconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="terraformstateconnectionedges"></a>`edges` | [`[TerraformStateEdge]`](#terraformstateedge) | A list of edges. | +| <a id="terraformstateconnectionnodes"></a>`nodes` | [`[TerraformState]`](#terraformstate) | A list of nodes. | +| <a id="terraformstateconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `TerraformStateEdge` + +The edge type for [`TerraformState`](#terraformstate). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="terraformstateedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="terraformstateedgenode"></a>`node` | [`TerraformState`](#terraformstate) | The item at the end of the edge. | + +#### `TerraformStateVersionRegistryConnection` + +The connection type for [`TerraformStateVersionRegistry`](#terraformstateversionregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="terraformstateversionregistryconnectionedges"></a>`edges` | [`[TerraformStateVersionRegistryEdge]`](#terraformstateversionregistryedge) | A list of edges. | +| <a id="terraformstateversionregistryconnectionnodes"></a>`nodes` | [`[TerraformStateVersionRegistry]`](#terraformstateversionregistry) | A list of nodes. | +| <a id="terraformstateversionregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `TerraformStateVersionRegistryEdge` + +The edge type for [`TerraformStateVersionRegistry`](#terraformstateversionregistry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="terraformstateversionregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="terraformstateversionregistryedgenode"></a>`node` | [`TerraformStateVersionRegistry`](#terraformstateversionregistry) | The item at the end of the edge. | + +#### `TestCaseConnection` + +The connection type for [`TestCase`](#testcase). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testcaseconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="testcaseconnectionedges"></a>`edges` | [`[TestCaseEdge]`](#testcaseedge) | A list of edges. | +| <a id="testcaseconnectionnodes"></a>`nodes` | [`[TestCase]`](#testcase) | A list of nodes. | +| <a id="testcaseconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `TestCaseEdge` + +The edge type for [`TestCase`](#testcase). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testcaseedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="testcaseedgenode"></a>`node` | [`TestCase`](#testcase) | The item at the end of the edge. | + +#### `TestReportConnection` + +The connection type for [`TestReport`](#testreport). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testreportconnectionedges"></a>`edges` | [`[TestReportEdge]`](#testreportedge) | A list of edges. | +| <a id="testreportconnectionnodes"></a>`nodes` | [`[TestReport]`](#testreport) | A list of nodes. | +| <a id="testreportconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `TestReportEdge` + +The edge type for [`TestReport`](#testreport). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testreportedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="testreportedgenode"></a>`node` | [`TestReport`](#testreport) | The item at the end of the edge. | + +#### `TestSuiteSummaryConnection` + +The connection type for [`TestSuiteSummary`](#testsuitesummary). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testsuitesummaryconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. | +| <a id="testsuitesummaryconnectionedges"></a>`edges` | [`[TestSuiteSummaryEdge]`](#testsuitesummaryedge) | A list of edges. | +| <a id="testsuitesummaryconnectionnodes"></a>`nodes` | [`[TestSuiteSummary]`](#testsuitesummary) | A list of nodes. | +| <a id="testsuitesummaryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `TestSuiteSummaryEdge` + +The edge type for [`TestSuiteSummary`](#testsuitesummary). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testsuitesummaryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="testsuitesummaryedgenode"></a>`node` | [`TestSuiteSummary`](#testsuitesummary) | The item at the end of the edge. | + +#### `TimelogConnection` + +The connection type for [`Timelog`](#timelog). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="timelogconnectionedges"></a>`edges` | [`[TimelogEdge]`](#timelogedge) | A list of edges. | +| <a id="timelogconnectionnodes"></a>`nodes` | [`[Timelog]`](#timelog) | A list of nodes. | +| <a id="timelogconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `TimelogEdge` + +The edge type for [`Timelog`](#timelog). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="timelogedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="timelogedgenode"></a>`node` | [`Timelog`](#timelog) | The item at the end of the edge. | + +#### `TodoConnection` + +The connection type for [`Todo`](#todo). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="todoconnectionedges"></a>`edges` | [`[TodoEdge]`](#todoedge) | A list of edges. | +| <a id="todoconnectionnodes"></a>`nodes` | [`[Todo]`](#todo) | A list of nodes. | +| <a id="todoconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `TodoEdge` + +The edge type for [`Todo`](#todo). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="todoedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="todoedgenode"></a>`node` | [`Todo`](#todo) | The item at the end of the edge. | + +#### `TreeEntryConnection` + +The connection type for [`TreeEntry`](#treeentry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="treeentryconnectionedges"></a>`edges` | [`[TreeEntryEdge]`](#treeentryedge) | A list of edges. | +| <a id="treeentryconnectionnodes"></a>`nodes` | [`[TreeEntry]`](#treeentry) | A list of nodes. | +| <a id="treeentryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `TreeEntryEdge` + +The edge type for [`TreeEntry`](#treeentry). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="treeentryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="treeentryedgenode"></a>`node` | [`TreeEntry`](#treeentry) | The item at the end of the edge. | + +#### `UsageTrendsMeasurementConnection` + +The connection type for [`UsageTrendsMeasurement`](#usagetrendsmeasurement). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usagetrendsmeasurementconnectionedges"></a>`edges` | [`[UsageTrendsMeasurementEdge]`](#usagetrendsmeasurementedge) | A list of edges. | +| <a id="usagetrendsmeasurementconnectionnodes"></a>`nodes` | [`[UsageTrendsMeasurement]`](#usagetrendsmeasurement) | A list of nodes. | +| <a id="usagetrendsmeasurementconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `UsageTrendsMeasurementEdge` + +The edge type for [`UsageTrendsMeasurement`](#usagetrendsmeasurement). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usagetrendsmeasurementedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="usagetrendsmeasurementedgenode"></a>`node` | [`UsageTrendsMeasurement`](#usagetrendsmeasurement) | The item at the end of the edge. | + +#### `UserCalloutConnection` + +The connection type for [`UserCallout`](#usercallout). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercalloutconnectionedges"></a>`edges` | [`[UserCalloutEdge]`](#usercalloutedge) | A list of edges. | +| <a id="usercalloutconnectionnodes"></a>`nodes` | [`[UserCallout]`](#usercallout) | A list of nodes. | +| <a id="usercalloutconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `UserCalloutEdge` + +The edge type for [`UserCallout`](#usercallout). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercalloutedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="usercalloutedgenode"></a>`node` | [`UserCallout`](#usercallout) | The item at the end of the edge. | + +#### `UserCoreConnection` + +The connection type for [`UserCore`](#usercore). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercoreconnectionedges"></a>`edges` | [`[UserCoreEdge]`](#usercoreedge) | A list of edges. | +| <a id="usercoreconnectionnodes"></a>`nodes` | [`[UserCore]`](#usercore) | A list of nodes. | +| <a id="usercoreconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `UserCoreEdge` + +The edge type for [`UserCore`](#usercore). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercoreedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="usercoreedgenode"></a>`node` | [`UserCore`](#usercore) | The item at the end of the edge. | + +#### `VulnerabilitiesCountByDayAndSeverityConnection` + +The connection type for [`VulnerabilitiesCountByDayAndSeverity`](#vulnerabilitiescountbydayandseverity). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitiescountbydayandseverityconnectionedges"></a>`edges` | [`[VulnerabilitiesCountByDayAndSeverityEdge]`](#vulnerabilitiescountbydayandseverityedge) | A list of edges. | +| <a id="vulnerabilitiescountbydayandseverityconnectionnodes"></a>`nodes` | [`[VulnerabilitiesCountByDayAndSeverity]`](#vulnerabilitiescountbydayandseverity) | A list of nodes. | +| <a id="vulnerabilitiescountbydayandseverityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `VulnerabilitiesCountByDayAndSeverityEdge` + +The edge type for [`VulnerabilitiesCountByDayAndSeverity`](#vulnerabilitiescountbydayandseverity). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitiescountbydayandseverityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="vulnerabilitiescountbydayandseverityedgenode"></a>`node` | [`VulnerabilitiesCountByDayAndSeverity`](#vulnerabilitiescountbydayandseverity) | The item at the end of the edge. | + +#### `VulnerabilitiesCountByDayConnection` + +The connection type for [`VulnerabilitiesCountByDay`](#vulnerabilitiescountbyday). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitiescountbydayconnectionedges"></a>`edges` | [`[VulnerabilitiesCountByDayEdge]`](#vulnerabilitiescountbydayedge) | A list of edges. | +| <a id="vulnerabilitiescountbydayconnectionnodes"></a>`nodes` | [`[VulnerabilitiesCountByDay]`](#vulnerabilitiescountbyday) | A list of nodes. | +| <a id="vulnerabilitiescountbydayconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `VulnerabilitiesCountByDayEdge` + +The edge type for [`VulnerabilitiesCountByDay`](#vulnerabilitiescountbyday). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitiescountbydayedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="vulnerabilitiescountbydayedgenode"></a>`node` | [`VulnerabilitiesCountByDay`](#vulnerabilitiescountbyday) | The item at the end of the edge. | + +#### `VulnerabilityConnection` + +The connection type for [`Vulnerability`](#vulnerability). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityconnectionedges"></a>`edges` | [`[VulnerabilityEdge]`](#vulnerabilityedge) | A list of edges. | +| <a id="vulnerabilityconnectionnodes"></a>`nodes` | [`[Vulnerability]`](#vulnerability) | A list of nodes. | +| <a id="vulnerabilityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `VulnerabilityEdge` + +The edge type for [`Vulnerability`](#vulnerability). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="vulnerabilityedgenode"></a>`node` | [`Vulnerability`](#vulnerability) | The item at the end of the edge. | + +#### `VulnerabilityExternalIssueLinkConnection` + +The connection type for [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityexternalissuelinkconnectionedges"></a>`edges` | [`[VulnerabilityExternalIssueLinkEdge]`](#vulnerabilityexternalissuelinkedge) | A list of edges. | +| <a id="vulnerabilityexternalissuelinkconnectionnodes"></a>`nodes` | [`[VulnerabilityExternalIssueLink]`](#vulnerabilityexternalissuelink) | A list of nodes. | +| <a id="vulnerabilityexternalissuelinkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `VulnerabilityExternalIssueLinkEdge` + +The edge type for [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityexternalissuelinkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="vulnerabilityexternalissuelinkedgenode"></a>`node` | [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink) | The item at the end of the edge. | + +#### `VulnerabilityIssueLinkConnection` + +The connection type for [`VulnerabilityIssueLink`](#vulnerabilityissuelink). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityissuelinkconnectionedges"></a>`edges` | [`[VulnerabilityIssueLinkEdge]`](#vulnerabilityissuelinkedge) | A list of edges. | +| <a id="vulnerabilityissuelinkconnectionnodes"></a>`nodes` | [`[VulnerabilityIssueLink]`](#vulnerabilityissuelink) | A list of nodes. | +| <a id="vulnerabilityissuelinkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `VulnerabilityIssueLinkEdge` + +The edge type for [`VulnerabilityIssueLink`](#vulnerabilityissuelink). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityissuelinkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="vulnerabilityissuelinkedgenode"></a>`node` | [`VulnerabilityIssueLink`](#vulnerabilityissuelink) | The item at the end of the edge. | + +#### `VulnerabilityScannerConnection` + +The connection type for [`VulnerabilityScanner`](#vulnerabilityscanner). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityscannerconnectionedges"></a>`edges` | [`[VulnerabilityScannerEdge]`](#vulnerabilityscanneredge) | A list of edges. | +| <a id="vulnerabilityscannerconnectionnodes"></a>`nodes` | [`[VulnerabilityScanner]`](#vulnerabilityscanner) | A list of nodes. | +| <a id="vulnerabilityscannerconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `VulnerabilityScannerEdge` + +The edge type for [`VulnerabilityScanner`](#vulnerabilityscanner). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityscanneredgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="vulnerabilityscanneredgenode"></a>`node` | [`VulnerabilityScanner`](#vulnerabilityscanner) | The item at the end of the edge. | + +## Object types + +Object types represent the resources that the GitLab GraphQL API can return. +They contain _fields_. Each field has its own type, which will either be one of the +basic GraphQL [scalar types](https://graphql.org/learn/schema/#scalar-types) +(e.g.: `String` or `Boolean`) or other object types. Fields may have arguments. +Fields with arguments are exactly like top-level queries, and are listed beneath +the table of fields for each object type. + +For more information, see +[Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields) +on `graphql.org`. + +### `AccessLevel` + +Represents the access level of a relationship between a User and object that it is related to. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="accesslevelintegervalue"></a>`integerValue` | [`Int`](#int) | Integer representation of access level. | +| <a id="accesslevelstringvalue"></a>`stringValue` | [`AccessLevelEnum`](#accesslevelenum) | String representation of access level. | + +### `AlertManagementAlert` + +Describes an alert from the project's Alert Management. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementalertassignees"></a>`assignees` | [`UserCoreConnection`](#usercoreconnection) | Assignees of the alert. (see [Connections](#connections)) | +| <a id="alertmanagementalertcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp the alert was created. | +| <a id="alertmanagementalertdescription"></a>`description` | [`String`](#string) | Description of the alert. | +| <a id="alertmanagementalertdetails"></a>`details` | [`JSON`](#json) | Alert details. | +| <a id="alertmanagementalertdetailsurl"></a>`detailsUrl` | [`String!`](#string) | The URL of the alert detail page. | +| <a id="alertmanagementalertdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="alertmanagementalertendedat"></a>`endedAt` | [`Time`](#time) | Timestamp the alert ended. | +| <a id="alertmanagementalertenvironment"></a>`environment` | [`Environment`](#environment) | Environment for the alert. | +| <a id="alertmanagementalerteventcount"></a>`eventCount` | [`Int`](#int) | Number of events of this alert. | +| <a id="alertmanagementalerthosts"></a>`hosts` | [`[String!]`](#string) | List of hosts the alert came from. | +| <a id="alertmanagementalertiid"></a>`iid` | [`ID!`](#id) | Internal ID of the alert. | +| <a id="alertmanagementalertissue"></a>`issue` | [`Issue`](#issue) | Issue attached to the alert. | +| <a id="alertmanagementalertissueiid"></a>`issueIid` **{warning-solid}** | [`ID`](#id) | **Deprecated** in 13.10. Use issue field. | +| <a id="alertmanagementalertmetricsdashboardurl"></a>`metricsDashboardUrl` | [`String`](#string) | URL for metrics embed for the alert. | +| <a id="alertmanagementalertmonitoringtool"></a>`monitoringTool` | [`String`](#string) | Monitoring tool the alert came from. | +| <a id="alertmanagementalertnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="alertmanagementalertprometheusalert"></a>`prometheusAlert` | [`PrometheusAlert`](#prometheusalert) | The alert condition for Prometheus. | +| <a id="alertmanagementalertrunbook"></a>`runbook` | [`String`](#string) | Runbook for the alert as defined in alert details. | +| <a id="alertmanagementalertservice"></a>`service` | [`String`](#string) | Service the alert came from. | +| <a id="alertmanagementalertseverity"></a>`severity` | [`AlertManagementSeverity`](#alertmanagementseverity) | Severity of the alert. | +| <a id="alertmanagementalertstartedat"></a>`startedAt` | [`Time`](#time) | Timestamp the alert was raised. | +| <a id="alertmanagementalertstatus"></a>`status` | [`AlertManagementStatus`](#alertmanagementstatus) | Status of the alert. | +| <a id="alertmanagementalerttitle"></a>`title` | [`String`](#string) | Title of the alert. | +| <a id="alertmanagementalertupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp the alert was last updated. | + +#### Fields with arguments + +##### `AlertManagementAlert.todos` + +To-do items of the current user for the alert. + +Returns [`TodoConnection`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementalerttodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | The action to be filtered. | +| <a id="alertmanagementalerttodosauthorid"></a>`authorId` | [`[ID!]`](#id) | The ID of an author. | +| <a id="alertmanagementalerttodosgroupid"></a>`groupId` | [`[ID!]`](#id) | The ID of a group. | +| <a id="alertmanagementalerttodosprojectid"></a>`projectId` | [`[ID!]`](#id) | The ID of a project. | +| <a id="alertmanagementalerttodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | The state of the todo. | +| <a id="alertmanagementalerttodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | The type of the todo. | + +### `AlertManagementAlertStatusCountsType` + +Represents total number of alerts for the represented categories. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementalertstatuscountstypeacknowledged"></a>`acknowledged` | [`Int`](#int) | Number of alerts with status ACKNOWLEDGED for the project. | +| <a id="alertmanagementalertstatuscountstypeall"></a>`all` | [`Int`](#int) | Total number of alerts for the project. | +| <a id="alertmanagementalertstatuscountstypeignored"></a>`ignored` | [`Int`](#int) | Number of alerts with status IGNORED for the project. | +| <a id="alertmanagementalertstatuscountstypeopen"></a>`open` | [`Int`](#int) | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project. | +| <a id="alertmanagementalertstatuscountstyperesolved"></a>`resolved` | [`Int`](#int) | Number of alerts with status RESOLVED for the project. | +| <a id="alertmanagementalertstatuscountstypetriggered"></a>`triggered` | [`Int`](#int) | Number of alerts with status TRIGGERED for the project. | + +### `AlertManagementHttpIntegration` + +An endpoint and credentials used to accept alerts for a project. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementhttpintegrationactive"></a>`active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. | +| <a id="alertmanagementhttpintegrationapiurl"></a>`apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | +| <a id="alertmanagementhttpintegrationid"></a>`id` | [`ID!`](#id) | ID of the integration. | +| <a id="alertmanagementhttpintegrationname"></a>`name` | [`String`](#string) | Name of the integration. | +| <a id="alertmanagementhttpintegrationpayloadalertfields"></a>`payloadAlertFields` | [`[AlertManagementPayloadAlertField!]`](#alertmanagementpayloadalertfield) | Extract alert fields from payload example for custom mapping. | +| <a id="alertmanagementhttpintegrationpayloadattributemappings"></a>`payloadAttributeMappings` | [`[AlertManagementPayloadAlertMappingField!]`](#alertmanagementpayloadalertmappingfield) | The custom mapping of GitLab alert attributes to fields from the payload_example. | +| <a id="alertmanagementhttpintegrationpayloadexample"></a>`payloadExample` | [`JsonString`](#jsonstring) | The example of an alert payload. | +| <a id="alertmanagementhttpintegrationtoken"></a>`token` | [`String`](#string) | Token used to authenticate alert notification requests. | +| <a id="alertmanagementhttpintegrationtype"></a>`type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. | +| <a id="alertmanagementhttpintegrationurl"></a>`url` | [`String`](#string) | Endpoint which accepts alert notifications. | + +### `AlertManagementPayloadAlertField` + +Parsed field from an alert used for custom mappings. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementpayloadalertfieldlabel"></a>`label` | [`String`](#string) | Human-readable label of the payload path. | +| <a id="alertmanagementpayloadalertfieldpath"></a>`path` | [`[PayloadAlertFieldPathSegment!]`](#payloadalertfieldpathsegment) | Path to value inside payload JSON. | +| <a id="alertmanagementpayloadalertfieldtype"></a>`type` | [`AlertManagementPayloadAlertFieldType`](#alertmanagementpayloadalertfieldtype) | Type of the parsed value. | + +### `AlertManagementPayloadAlertMappingField` + +Parsed field (with its name) from an alert used for custom mappings. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementpayloadalertmappingfieldfieldname"></a>`fieldName` | [`AlertManagementPayloadAlertFieldName`](#alertmanagementpayloadalertfieldname) | A GitLab alert field name. | +| <a id="alertmanagementpayloadalertmappingfieldlabel"></a>`label` | [`String`](#string) | Human-readable label of the payload path. | +| <a id="alertmanagementpayloadalertmappingfieldpath"></a>`path` | [`[PayloadAlertFieldPathSegment!]`](#payloadalertfieldpathsegment) | Path to value inside payload JSON. | +| <a id="alertmanagementpayloadalertmappingfieldtype"></a>`type` | [`AlertManagementPayloadAlertFieldType`](#alertmanagementpayloadalertfieldtype) | Type of the parsed value. | + +### `AlertManagementPrometheusIntegration` + +An endpoint and credentials used to accept Prometheus alerts for a project. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementprometheusintegrationactive"></a>`active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. | +| <a id="alertmanagementprometheusintegrationapiurl"></a>`apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | +| <a id="alertmanagementprometheusintegrationid"></a>`id` | [`ID!`](#id) | ID of the integration. | +| <a id="alertmanagementprometheusintegrationname"></a>`name` | [`String`](#string) | Name of the integration. | +| <a id="alertmanagementprometheusintegrationtoken"></a>`token` | [`String`](#string) | Token used to authenticate alert notification requests. | +| <a id="alertmanagementprometheusintegrationtype"></a>`type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. | +| <a id="alertmanagementprometheusintegrationurl"></a>`url` | [`String`](#string) | Endpoint which accepts alert notifications. | + +### `ApiFuzzingCiConfiguration` + +Data associated with configuring API fuzzing scans in GitLab CI. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="apifuzzingciconfigurationscanmodes"></a>`scanModes` | [`[ApiFuzzingScanMode!]`](#apifuzzingscanmode) | All available scan modes. | +| <a id="apifuzzingciconfigurationscanprofiles"></a>`scanProfiles` | [`[ApiFuzzingScanProfile!]`](#apifuzzingscanprofile) | All default scan profiles. | + +### `ApiFuzzingScanProfile` + +An API Fuzzing scan profile. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="apifuzzingscanprofiledescription"></a>`description` | [`String`](#string) | A short description of the profile. | +| <a id="apifuzzingscanprofilename"></a>`name` | [`String`](#string) | The unique name of the profile. | +| <a id="apifuzzingscanprofileyaml"></a>`yaml` | [`String`](#string) | A syntax highlit HTML representation of the YAML. | + +### `ApprovalRule` + +Describes a rule for who can approve merge requests. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="approvalruleid"></a>`id` | [`GlobalID!`](#globalid) | ID of the rule. | +| <a id="approvalrulename"></a>`name` | [`String`](#string) | Name of the rule. | +| <a id="approvalruletype"></a>`type` | [`ApprovalRuleType`](#approvalruletype) | Type of the rule. | + +### `AwardEmoji` + +An emoji awarded by a user. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="awardemojidescription"></a>`description` | [`String!`](#string) | The emoji description. | +| <a id="awardemojiemoji"></a>`emoji` | [`String!`](#string) | The emoji as an icon. | +| <a id="awardemojiname"></a>`name` | [`String!`](#string) | The emoji name. | +| <a id="awardemojiunicode"></a>`unicode` | [`String!`](#string) | The emoji in Unicode. | +| <a id="awardemojiunicodeversion"></a>`unicodeVersion` | [`String!`](#string) | The Unicode version for this emoji. | +| <a id="awardemojiuser"></a>`user` | [`UserCore!`](#usercore) | The user who awarded the emoji. | + +### `BaseService` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="baseserviceactive"></a>`active` | [`Boolean`](#boolean) | Indicates if the service is active. | +| <a id="baseservicetype"></a>`type` | [`String`](#string) | Class name of the service. | + +### `Blob` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="blobflatpath"></a>`flatPath` | [`String!`](#string) | Flat path of the entry. | +| <a id="blobid"></a>`id` | [`ID!`](#id) | ID of the entry. | +| <a id="bloblfsoid"></a>`lfsOid` | [`String`](#string) | LFS ID of the blob. | +| <a id="blobmode"></a>`mode` | [`String`](#string) | Blob mode in numeric format. | +| <a id="blobname"></a>`name` | [`String!`](#string) | Name of the entry. | +| <a id="blobpath"></a>`path` | [`String!`](#string) | Path of the entry. | +| <a id="blobsha"></a>`sha` | [`String!`](#string) | Last commit SHA for the entry. | +| <a id="blobtype"></a>`type` | [`EntryType!`](#entrytype) | Type of tree entry. | +| <a id="blobwebpath"></a>`webPath` | [`String`](#string) | Web path of the blob. | +| <a id="blobweburl"></a>`webUrl` | [`String`](#string) | Web URL of the blob. | + +### `BlobViewer` + +Represents how the blob content should be displayed. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="blobviewercollapsed"></a>`collapsed` | [`Boolean!`](#boolean) | Shows whether the blob should be displayed collapsed. | +| <a id="blobviewerfiletype"></a>`fileType` | [`String!`](#string) | Content file type. | +| <a id="blobviewerloadasync"></a>`loadAsync` | [`Boolean!`](#boolean) | Shows whether the blob content is loaded asynchronously. | +| <a id="blobviewerloadingpartialname"></a>`loadingPartialName` | [`String!`](#string) | Loading partial name. | +| <a id="blobviewerrendererror"></a>`renderError` | [`String`](#string) | Error rendering the blob content. | +| <a id="blobviewertoolarge"></a>`tooLarge` | [`Boolean!`](#boolean) | Shows whether the blob is too large to be displayed. | +| <a id="blobviewertype"></a>`type` | [`BlobViewersType!`](#blobviewerstype) | Type of blob viewer. | + +### `Board` + +Represents a project or group issue board. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardassignee"></a>`assignee` | [`UserCore`](#usercore) | The board assignee. | +| <a id="boardcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the board was created. | +| <a id="boardhidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. | +| <a id="boardhideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. | +| <a id="boardid"></a>`id` | [`ID!`](#id) | ID (global ID) of the board. | +| <a id="boarditeration"></a>`iteration` | [`Iteration`](#iteration) | The board iteration. | +| <a id="boardlabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the board. (see [Connections](#connections)) | +| <a id="boardmilestone"></a>`milestone` | [`Milestone`](#milestone) | The board milestone. | +| <a id="boardname"></a>`name` | [`String`](#string) | Name of the board. | +| <a id="boardupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the board was last updated. | +| <a id="boardwebpath"></a>`webPath` | [`String!`](#string) | Web path of the board. | +| <a id="boardweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the board. | +| <a id="boardweight"></a>`weight` | [`Int`](#int) | Weight of the board. | + +#### Fields with arguments + +##### `Board.epics` + +Epics associated with board issues. + +Returns [`BoardEpicConnection`](#boardepicconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardepicsissuefilters"></a>`issueFilters` | [`BoardIssueInput`](#boardissueinput) | Filters applied when selecting issues on the board. | + +##### `Board.lists` + +Lists of the board. + +Returns [`BoardListConnection`](#boardlistconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardlistsid"></a>`id` | [`ListID`](#listid) | Find a list by its global ID. | +| <a id="boardlistsissuefilters"></a>`issueFilters` | [`BoardIssueInput`](#boardissueinput) | Filters applied when getting issue metadata in the board list. | + +### `BoardEpic` + +Represents an epic on an issue board. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardepicauthor"></a>`author` | [`UserCore!`](#usercore) | Author of the epic. | +| <a id="boardepicawardemoji"></a>`awardEmoji` | [`AwardEmojiConnection`](#awardemojiconnection) | A list of award emojis associated with the epic. (see [Connections](#connections)) | +| <a id="boardepicclosedat"></a>`closedAt` | [`Time`](#time) | Timestamp of when the epic was closed. | +| <a id="boardepicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. | +| <a id="boardepiccreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the epic was created. | +| <a id="boardepicdescendantcounts"></a>`descendantCounts` | [`EpicDescendantCount`](#epicdescendantcount) | Number of open and closed descendant epics and issues. | +| <a id="boardepicdescendantweightsum"></a>`descendantWeightSum` | [`EpicDescendantWeights`](#epicdescendantweights) | Total weight of open and closed issues in the epic and its descendants. | +| <a id="boardepicdescription"></a>`description` | [`String`](#string) | Description of the epic. | +| <a id="boardepicdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="boardepicdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="boardepicdownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes the epic has received. | +| <a id="boardepicduedate"></a>`dueDate` | [`Time`](#time) | Due date of the epic. | +| <a id="boardepicduedatefixed"></a>`dueDateFixed` | [`Time`](#time) | Fixed due date of the epic. | +| <a id="boardepicduedatefrommilestones"></a>`dueDateFromMilestones` | [`Time`](#time) | Inherited due date of the epic from milestones. | +| <a id="boardepicduedateisfixed"></a>`dueDateIsFixed` | [`Boolean`](#boolean) | Indicates if the due date has been manually set. | +| <a id="boardepicevents"></a>`events` | [`EventConnection`](#eventconnection) | A list of events associated with the object. (see [Connections](#connections)) | +| <a id="boardepicgroup"></a>`group` | [`Group!`](#group) | Group to which the epic belongs. | +| <a id="boardepichaschildren"></a>`hasChildren` | [`Boolean!`](#boolean) | Indicates if the epic has children. | +| <a id="boardepichasissues"></a>`hasIssues` | [`Boolean!`](#boolean) | Indicates if the epic has direct issues. | +| <a id="boardepichasparent"></a>`hasParent` | [`Boolean!`](#boolean) | Indicates if the epic has a parent epic. | +| <a id="boardepichealthstatus"></a>`healthStatus` | [`EpicHealthStatus`](#epichealthstatus) | Current health status of the epic. | +| <a id="boardepicid"></a>`id` | [`ID!`](#id) | ID of the epic. | +| <a id="boardepiciid"></a>`iid` | [`ID!`](#id) | Internal ID of the epic. | +| <a id="boardepicissues"></a>`issues` | [`EpicIssueConnection`](#epicissueconnection) | A list of issues associated with the epic. (see [Connections](#connections)) | +| <a id="boardepiclabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels assigned to the epic. (see [Connections](#connections)) | +| <a id="boardepicnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="boardepicparent"></a>`parent` | [`Epic`](#epic) | Parent epic of the epic. | +| <a id="boardepicparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | List of participants for the epic. (see [Connections](#connections)) | +| <a id="boardepicrelationpath"></a>`relationPath` | [`String`](#string) | URI path of the epic-issue relationship. | +| <a id="boardepicrelativeposition"></a>`relativePosition` | [`Int`](#int) | The relative position of the epic in the epic tree. | +| <a id="boardepicstartdate"></a>`startDate` | [`Time`](#time) | Start date of the epic. | +| <a id="boardepicstartdatefixed"></a>`startDateFixed` | [`Time`](#time) | Fixed start date of the epic. | +| <a id="boardepicstartdatefrommilestones"></a>`startDateFromMilestones` | [`Time`](#time) | Inherited start date of the epic from milestones. | +| <a id="boardepicstartdateisfixed"></a>`startDateIsFixed` | [`Boolean`](#boolean) | Indicates if the start date has been manually set. | +| <a id="boardepicstate"></a>`state` | [`EpicState!`](#epicstate) | State of the epic. | +| <a id="boardepicsubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the epic. | +| <a id="boardepictitle"></a>`title` | [`String`](#string) | Title of the epic. | +| <a id="boardepictitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | +| <a id="boardepicupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp of when the epic was updated. | +| <a id="boardepicupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes the epic has received. | +| <a id="boardepicuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the epic. | +| <a id="boardepicusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes of the epic. | +| <a id="boardepicuserpermissions"></a>`userPermissions` | [`EpicPermissions!`](#epicpermissions) | Permissions for the current user on the resource. | +| <a id="boardepicuserpreferences"></a>`userPreferences` | [`BoardEpicUserPreferences`](#boardepicuserpreferences) | User preferences for the epic on the issue board. | +| <a id="boardepicwebpath"></a>`webPath` | [`String!`](#string) | Web path of the epic. | +| <a id="boardepicweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the epic. | + +#### Fields with arguments + +##### `BoardEpic.children` + +Children (sub-epics) of the epic. + +Returns [`EpicConnection`](#epicconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardepicchildrenauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. | +| <a id="boardepicchildrenconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. | +| <a id="boardepicchildrenenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. | +| <a id="boardepicchildreniid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". | +| <a id="boardepicchildreniidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. | +| <a id="boardepicchildreniids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., [1, 2]. | +| <a id="boardepicchildrenincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. | +| <a id="boardepicchildrenlabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. | +| <a id="boardepicchildrenmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. | +| <a id="boardepicchildrenmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. | +| <a id="boardepicchildrensearch"></a>`search` | [`String`](#string) | Search query for epic title or description. | +| <a id="boardepicchildrensort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. | +| <a id="boardepicchildrenstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. | +| <a id="boardepicchildrenstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. | +| <a id="boardepicchildrentimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. | + +##### `BoardEpic.currentUserTodos` + +To-do items for the current user. + +Returns [`TodoConnection!`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardepiccurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. | + +##### `BoardEpic.reference` + +Internal reference of the epic. Returned in shortened format by default. + +Returns [`String!`](#string). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardepicreferencefull"></a>`full` | [`Boolean`](#boolean) | Indicates if the reference should be returned in full. | + +### `BoardEpicUserPreferences` + +Represents user preferences for a board epic. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardepicuserpreferencescollapsed"></a>`collapsed` | [`Boolean!`](#boolean) | Indicates epic should be displayed as collapsed. | + +### `BoardList` + +Represents a list for an issue board. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardlistassignee"></a>`assignee` | [`UserCore`](#usercore) | Assignee in the list. | +| <a id="boardlistcollapsed"></a>`collapsed` | [`Boolean`](#boolean) | Indicates if the list is collapsed for this user. | +| <a id="boardlistid"></a>`id` | [`ID!`](#id) | ID (global ID) of the list. | +| <a id="boardlistissuescount"></a>`issuesCount` | [`Int`](#int) | Count of issues in the list. | +| <a id="boardlistiteration"></a>`iteration` | [`Iteration`](#iteration) | Iteration of the list. | +| <a id="boardlistlabel"></a>`label` | [`Label`](#label) | Label of the list. | +| <a id="boardlistlimitmetric"></a>`limitMetric` | [`ListLimitMetric`](#listlimitmetric) | The current limit metric for the list. | +| <a id="boardlistlisttype"></a>`listType` | [`String!`](#string) | Type of the list. | +| <a id="boardlistmaxissuecount"></a>`maxIssueCount` | [`Int`](#int) | Maximum number of issues in the list. | +| <a id="boardlistmaxissueweight"></a>`maxIssueWeight` | [`Int`](#int) | Maximum weight of issues in the list. | +| <a id="boardlistmilestone"></a>`milestone` | [`Milestone`](#milestone) | Milestone of the list. | +| <a id="boardlistposition"></a>`position` | [`Int`](#int) | Position of list within the board. | +| <a id="boardlisttitle"></a>`title` | [`String!`](#string) | Title of the list. | +| <a id="boardlisttotalweight"></a>`totalWeight` | [`Int`](#int) | Total weight of all issues in the list. | + +#### Fields with arguments + +##### `BoardList.issues` + +Board issues. + +Returns [`IssueConnection`](#issueconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardlistissuesfilters"></a>`filters` | [`BoardIssueInput`](#boardissueinput) | Filters applied when selecting issues in the board list. | + +### `Branch` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="branchcommit"></a>`commit` | [`Commit`](#commit) | Commit for the branch. | +| <a id="branchname"></a>`name` | [`String!`](#string) | Name of the branch. | + +### `BurnupChartDailyTotals` + +Represents the total number of issues and their weights for a particular day. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="burnupchartdailytotalscompletedcount"></a>`completedCount` | [`Int!`](#int) | Number of closed issues as of this day. | +| <a id="burnupchartdailytotalscompletedweight"></a>`completedWeight` | [`Int!`](#int) | Total weight of closed issues as of this day. | +| <a id="burnupchartdailytotalsdate"></a>`date` | [`ISO8601Date!`](#iso8601date) | Date for burnup totals. | +| <a id="burnupchartdailytotalsscopecount"></a>`scopeCount` | [`Int!`](#int) | Number of issues as of this day. | +| <a id="burnupchartdailytotalsscopeweight"></a>`scopeWeight` | [`Int!`](#int) | Total weight of issues as of this day. | + +### `CiApplicationSettings` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciapplicationsettingskeeplatestartifact"></a>`keepLatestArtifact` | [`Boolean`](#boolean) | Whether to keep the latest jobs artifacts. | + +### `CiBuildNeed` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cibuildneedname"></a>`name` | [`String`](#string) | Name of the job we need to complete. | + +### `CiConfig` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigerrors"></a>`errors` | [`[String!]`](#string) | Linting errors. | +| <a id="ciconfigmergedyaml"></a>`mergedYaml` | [`String`](#string) | Merged CI configuration YAML. | +| <a id="ciconfigstages"></a>`stages` | [`CiConfigStageConnection`](#ciconfigstageconnection) | Stages of the pipeline. (see [Connections](#connections)) | +| <a id="ciconfigstatus"></a>`status` | [`CiConfigStatus`](#ciconfigstatus) | Status of linting, can be either valid or invalid. | + +### `CiConfigGroup` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfiggroupjobs"></a>`jobs` | [`CiConfigJobConnection`](#ciconfigjobconnection) | Jobs in group. (see [Connections](#connections)) | +| <a id="ciconfiggroupname"></a>`name` | [`String`](#string) | Name of the job group. | +| <a id="ciconfiggroupsize"></a>`size` | [`Int`](#int) | Size of the job group. | + +### `CiConfigJob` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigjobafterscript"></a>`afterScript` | [`[String!]`](#string) | Override a set of commands that are executed after the job. | +| <a id="ciconfigjoballowfailure"></a>`allowFailure` | [`Boolean`](#boolean) | Allow job to fail. | +| <a id="ciconfigjobbeforescript"></a>`beforeScript` | [`[String!]`](#string) | Override a set of commands that are executed before the job. | +| <a id="ciconfigjobenvironment"></a>`environment` | [`String`](#string) | Name of an environment to which the job deploys. | +| <a id="ciconfigjobexcept"></a>`except` | [`CiConfigJobRestriction`](#ciconfigjobrestriction) | Limit when jobs are not created. | +| <a id="ciconfigjobgroupname"></a>`groupName` | [`String`](#string) | Name of the job group. | +| <a id="ciconfigjobname"></a>`name` | [`String`](#string) | Name of the job. | +| <a id="ciconfigjobneeds"></a>`needs` | [`CiConfigNeedConnection`](#ciconfigneedconnection) | Builds that must complete before the jobs run. (see [Connections](#connections)) | +| <a id="ciconfigjobonly"></a>`only` | [`CiConfigJobRestriction`](#ciconfigjobrestriction) | Jobs are created when these conditions do not apply. | +| <a id="ciconfigjobscript"></a>`script` | [`[String!]`](#string) | Shell script that is executed by a runner. | +| <a id="ciconfigjobstage"></a>`stage` | [`String`](#string) | Name of the job stage. | +| <a id="ciconfigjobtags"></a>`tags` | [`[String!]`](#string) | List of tags that are used to select a runner. | +| <a id="ciconfigjobwhen"></a>`when` | [`String`](#string) | When to run the job. | + +### `CiConfigJobRestriction` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigjobrestrictionrefs"></a>`refs` | [`[String!]`](#string) | The Git refs the job restriction applies to. | + +### `CiConfigNeed` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigneedname"></a>`name` | [`String`](#string) | Name of the need. | + +### `CiConfigStage` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="ciconfigstagegroups"></a>`groups` | [`CiConfigGroupConnection`](#ciconfiggroupconnection) | Groups of jobs for the stage. (see [Connections](#connections)) | +| <a id="ciconfigstagename"></a>`name` | [`String`](#string) | Name of the stage. | + +### `CiGroup` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cigroupdetailedstatus"></a>`detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the group. | +| <a id="cigroupjobs"></a>`jobs` | [`CiJobConnection`](#cijobconnection) | Jobs in group. (see [Connections](#connections)) | +| <a id="cigroupname"></a>`name` | [`String`](#string) | Name of the job group. | +| <a id="cigroupsize"></a>`size` | [`Int`](#int) | Size of the group. | + +### `CiJob` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cijobactive"></a>`active` | [`Boolean!`](#boolean) | Indicates the job is active. | +| <a id="cijoballowfailure"></a>`allowFailure` | [`Boolean!`](#boolean) | Whether the job is allowed to fail. | +| <a id="cijobartifacts"></a>`artifacts` | [`CiJobArtifactConnection`](#cijobartifactconnection) | Artifacts generated by the job. (see [Connections](#connections)) | +| <a id="cijobcancelable"></a>`cancelable` | [`Boolean!`](#boolean) | Indicates the job can be canceled. | +| <a id="cijobcommitpath"></a>`commitPath` | [`String`](#string) | Path to the commit that triggered the job. | +| <a id="cijobcoverage"></a>`coverage` | [`Float`](#float) | Coverage level of the job. | +| <a id="cijobcreatedat"></a>`createdAt` | [`Time!`](#time) | When the job was created. | +| <a id="cijobcreatedbytag"></a>`createdByTag` | [`Boolean!`](#boolean) | Whether the job was created by a tag. | +| <a id="cijobdetailedstatus"></a>`detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the job. | +| <a id="cijobduration"></a>`duration` | [`Int`](#int) | Duration of the job in seconds. | +| <a id="cijobfinishedat"></a>`finishedAt` | [`Time`](#time) | When a job has finished running. | +| <a id="cijobid"></a>`id` | [`JobID`](#jobid) | ID of the job. | +| <a id="cijobmanualjob"></a>`manualJob` | [`Boolean`](#boolean) | Whether the job has a manual action. | +| <a id="cijobname"></a>`name` | [`String`](#string) | Name of the job. | +| <a id="cijobneeds"></a>`needs` | [`CiBuildNeedConnection`](#cibuildneedconnection) | References to builds that must complete before the jobs run. (see [Connections](#connections)) | +| <a id="cijobpipeline"></a>`pipeline` | [`Pipeline`](#pipeline) | Pipeline the job belongs to. | +| <a id="cijobplayable"></a>`playable` | [`Boolean!`](#boolean) | Indicates the job can be played. | +| <a id="cijobqueuedat"></a>`queuedAt` | [`Time`](#time) | When the job was enqueued and marked as pending. | +| <a id="cijobqueuedduration"></a>`queuedDuration` | [`Duration`](#duration) | How long the job was enqueued before starting. | +| <a id="cijobrefname"></a>`refName` | [`String`](#string) | Ref name of the job. | +| <a id="cijobrefpath"></a>`refPath` | [`String`](#string) | Path to the ref. | +| <a id="cijobretryable"></a>`retryable` | [`Boolean!`](#boolean) | Indicates the job can be retried. | +| <a id="cijobscheduledat"></a>`scheduledAt` | [`Time`](#time) | Schedule for the build. | +| <a id="cijobschedulingtype"></a>`schedulingType` | [`String`](#string) | Type of pipeline scheduling. Value is `dag` if the pipeline uses the `needs` keyword, and `stage` otherwise. | +| <a id="cijobshortsha"></a>`shortSha` | [`String!`](#string) | Short SHA1 ID of the commit. | +| <a id="cijobstage"></a>`stage` | [`CiStage`](#cistage) | Stage of the job. | +| <a id="cijobstartedat"></a>`startedAt` | [`Time`](#time) | When the job was started. | +| <a id="cijobstatus"></a>`status` | [`CiJobStatus`](#cijobstatus) | Status of the job. | +| <a id="cijobstuck"></a>`stuck` | [`Boolean!`](#boolean) | Indicates the job is stuck. | +| <a id="cijobtags"></a>`tags` | [`[String!]`](#string) | Tags for the current job. | +| <a id="cijobtriggered"></a>`triggered` | [`Boolean`](#boolean) | Whether the job was triggered. | +| <a id="cijobuserpermissions"></a>`userPermissions` | [`JobPermissions!`](#jobpermissions) | Permissions for the current user on the resource. | + +### `CiJobArtifact` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cijobartifactdownloadpath"></a>`downloadPath` | [`String`](#string) | URL for downloading the artifact's file. | +| <a id="cijobartifactfiletype"></a>`fileType` | [`JobArtifactFileType`](#jobartifactfiletype) | File type of the artifact. | + +### `CiRunner` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cirunneraccesslevel"></a>`accessLevel` | [`CiRunnerAccessLevel!`](#cirunneraccesslevel) | Access level of the runner. | +| <a id="cirunneractive"></a>`active` | [`Boolean!`](#boolean) | Indicates the runner is allowed to receive jobs. | +| <a id="cirunnercontactedat"></a>`contactedAt` | [`Time`](#time) | Last contact from the runner. | +| <a id="cirunnerdescription"></a>`description` | [`String`](#string) | Description of the runner. | +| <a id="cirunnerid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | ID of the runner. | +| <a id="cirunneripaddress"></a>`ipAddress` | [`String!`](#string) | IP address of the runner. | +| <a id="cirunnerlocked"></a>`locked` | [`Boolean`](#boolean) | Indicates the runner is locked. | +| <a id="cirunnermaximumtimeout"></a>`maximumTimeout` | [`Int`](#int) | Maximum timeout (in seconds) for jobs processed by the runner. | +| <a id="cirunnerrevision"></a>`revision` | [`String!`](#string) | Revision of the runner. | +| <a id="cirunnerrununtagged"></a>`runUntagged` | [`Boolean!`](#boolean) | Indicates the runner is able to run untagged jobs. | +| <a id="cirunnerrunnertype"></a>`runnerType` | [`CiRunnerType!`](#cirunnertype) | Type of the runner. | +| <a id="cirunnershortsha"></a>`shortSha` | [`String`](#string) | First eight characters of the runner's token used to authenticate new job requests. Used as the runner's unique ID. | +| <a id="cirunnerstatus"></a>`status` | [`CiRunnerStatus!`](#cirunnerstatus) | Status of the runner. | +| <a id="cirunnertaglist"></a>`tagList` | [`[String!]`](#string) | Tags associated with the runner. | +| <a id="cirunnerversion"></a>`version` | [`String!`](#string) | Version of the runner. | + +### `CiStage` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cistagedetailedstatus"></a>`detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the stage. | +| <a id="cistagegroups"></a>`groups` | [`CiGroupConnection`](#cigroupconnection) | Group of jobs for the stage. (see [Connections](#connections)) | +| <a id="cistagejobs"></a>`jobs` | [`CiJobConnection`](#cijobconnection) | Jobs for the stage. (see [Connections](#connections)) | +| <a id="cistagename"></a>`name` | [`String`](#string) | Name of the stage. | + +### `CiTemplate` + +GitLab CI/CD configuration template. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="citemplatecontent"></a>`content` | [`String!`](#string) | Contents of the CI template. | +| <a id="citemplatename"></a>`name` | [`String!`](#string) | Name of the CI template. | + +### `ClusterAgent` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="clusteragentcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp the cluster agent was created. | +| <a id="clusteragentcreatedbyuser"></a>`createdByUser` | [`UserCore`](#usercore) | User object, containing information about the person who created the agent. | +| <a id="clusteragentid"></a>`id` | [`ID!`](#id) | ID of the cluster agent. | +| <a id="clusteragentname"></a>`name` | [`String`](#string) | Name of the cluster agent. | +| <a id="clusteragentproject"></a>`project` | [`Project`](#project) | The project this cluster agent is associated with. | +| <a id="clusteragenttokens"></a>`tokens` | [`ClusterAgentTokenConnection`](#clusteragenttokenconnection) | Tokens associated with the cluster agent. (see [Connections](#connections)) | +| <a id="clusteragentupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp the cluster agent was updated. | +| <a id="clusteragentwebpath"></a>`webPath` | [`String`](#string) | Web path of the cluster agent. | + +### `ClusterAgentToken` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="clusteragenttokenclusteragent"></a>`clusterAgent` | [`ClusterAgent`](#clusteragent) | Cluster agent this token is associated with. | +| <a id="clusteragenttokencreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp the token was created. | +| <a id="clusteragenttokencreatedbyuser"></a>`createdByUser` | [`UserCore`](#usercore) | The user who created the token. | +| <a id="clusteragenttokendescription"></a>`description` | [`String`](#string) | Description of the token. | +| <a id="clusteragenttokenid"></a>`id` | [`ClustersAgentTokenID!`](#clustersagenttokenid) | Global ID of the token. | +| <a id="clusteragenttokenlastusedat"></a>`lastUsedAt` | [`Time`](#time) | Timestamp the token was last used. | +| <a id="clusteragenttokenname"></a>`name` | [`String`](#string) | Name given to the token. | + +### `CodeCoverageActivity` + +Represents the code coverage activity for a group. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="codecoverageactivityaveragecoverage"></a>`averageCoverage` | [`Float`](#float) | Average percentage of the different code coverage results available for the group. | +| <a id="codecoverageactivitycoveragecount"></a>`coverageCount` | [`Int`](#int) | Number of different code coverage results available for the group. | +| <a id="codecoverageactivitydate"></a>`date` | [`Date!`](#date) | Date when the code coverage was created. | +| <a id="codecoverageactivityprojectcount"></a>`projectCount` | [`Int`](#int) | Number of projects with code coverage results for the group. | + +### `CodeCoverageSummary` + +Represents the code coverage summary for a project. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="codecoveragesummaryaveragecoverage"></a>`averageCoverage` | [`Float`](#float) | Average percentage of the different code coverage results available for the project. | +| <a id="codecoveragesummarycoveragecount"></a>`coverageCount` | [`Int`](#int) | Number of different code coverage results available. | +| <a id="codecoveragesummarylastupdatedon"></a>`lastUpdatedOn` | [`Date`](#date) | Latest date when the code coverage was created for the project. | + +### `CodeQualityDegradation` + +Represents a code quality degradation on the pipeline. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="codequalitydegradationdescription"></a>`description` | [`String!`](#string) | A description of the code quality degradation. | +| <a id="codequalitydegradationfingerprint"></a>`fingerprint` | [`String!`](#string) | A unique fingerprint to identify the code quality degradation. For example, an MD5 hash. | +| <a id="codequalitydegradationline"></a>`line` | [`Int!`](#int) | The line on which the code quality degradation occurred. | +| <a id="codequalitydegradationpath"></a>`path` | [`String!`](#string) | The relative path to the file containing the code quality degradation. | +| <a id="codequalitydegradationseverity"></a>`severity` | [`CodeQualityDegradationSeverity!`](#codequalitydegradationseverity) | Status of the degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO). | + +### `Commit` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="commitauthor"></a>`author` | [`UserCore`](#usercore) | Author of the commit. | +| <a id="commitauthorgravatar"></a>`authorGravatar` | [`String`](#string) | Commit authors gravatar. | +| <a id="commitauthorname"></a>`authorName` | [`String`](#string) | Commit authors name. | +| <a id="commitauthoreddate"></a>`authoredDate` | [`Time`](#time) | Timestamp of when the commit was authored. | +| <a id="commitdescription"></a>`description` | [`String`](#string) | Description of the commit message. | +| <a id="commitdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="commitid"></a>`id` | [`ID!`](#id) | ID (global ID) of the commit. | +| <a id="commitmessage"></a>`message` | [`String`](#string) | Raw commit message. | +| <a id="commitsha"></a>`sha` | [`String!`](#string) | SHA1 ID of the commit. | +| <a id="commitshortid"></a>`shortId` | [`String!`](#string) | Short SHA1 ID of the commit. | +| <a id="commitsignaturehtml"></a>`signatureHtml` | [`String`](#string) | Rendered HTML of the commit signature. | +| <a id="committitle"></a>`title` | [`String`](#string) | Title of the commit message. | +| <a id="committitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | +| <a id="commitwebpath"></a>`webPath` | [`String!`](#string) | Web path of the commit. | +| <a id="commitweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the commit. | + +#### Fields with arguments + +##### `Commit.pipelines` + +Pipelines of the commit ordered latest first. + +Returns [`PipelineConnection`](#pipelineconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="commitpipelinesref"></a>`ref` | [`String`](#string) | Filter pipelines by the ref they are run for. | +| <a id="commitpipelinessha"></a>`sha` | [`String`](#string) | Filter pipelines by the sha of the commit they are run for. | +| <a id="commitpipelinesstatus"></a>`status` | [`PipelineStatusEnum`](#pipelinestatusenum) | Filter pipelines by their status. | + +### `ComplianceFramework` + +Represents a ComplianceFramework associated with a Project. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="complianceframeworkcolor"></a>`color` | [`String!`](#string) | Hexadecimal representation of compliance framework's label color. | +| <a id="complianceframeworkdescription"></a>`description` | [`String!`](#string) | Description of the compliance framework. | +| <a id="complianceframeworkid"></a>`id` | [`ID!`](#id) | Compliance framework ID. | +| <a id="complianceframeworkname"></a>`name` | [`String!`](#string) | Name of the compliance framework. | +| <a id="complianceframeworkpipelineconfigurationfullpath"></a>`pipelineConfigurationFullPath` | [`String`](#string) | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. | + +### `ComposerMetadata` + +Composer metadata. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="composermetadatacomposerjson"></a>`composerJson` | [`PackageComposerJsonType!`](#packagecomposerjsontype) | Data of the Composer JSON file. | +| <a id="composermetadatatargetsha"></a>`targetSha` | [`String!`](#string) | Target SHA of the package. | + +### `ConanFileMetadata` + +Conan file metadata. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="conanfilemetadataconanfiletype"></a>`conanFileType` | [`ConanMetadatumFileTypeEnum!`](#conanmetadatumfiletypeenum) | Type of the Conan file. | +| <a id="conanfilemetadataconanpackagereference"></a>`conanPackageReference` | [`String`](#string) | Reference of the Conan package. | +| <a id="conanfilemetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. | +| <a id="conanfilemetadataid"></a>`id` | [`PackagesConanFileMetadatumID!`](#packagesconanfilemetadatumid) | ID of the metadatum. | +| <a id="conanfilemetadatapackagerevision"></a>`packageRevision` | [`String`](#string) | Revision of the package. | +| <a id="conanfilemetadatareciperevision"></a>`recipeRevision` | [`String!`](#string) | Revision of the Conan recipe. | +| <a id="conanfilemetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. | + +### `ConanMetadata` + +Conan metadata. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="conanmetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. | +| <a id="conanmetadataid"></a>`id` | [`PackagesConanMetadatumID!`](#packagesconanmetadatumid) | ID of the metadatum. | +| <a id="conanmetadatapackagechannel"></a>`packageChannel` | [`String!`](#string) | Channel of the Conan package. | +| <a id="conanmetadatapackageusername"></a>`packageUsername` | [`String!`](#string) | Username of the Conan package. | +| <a id="conanmetadatarecipe"></a>`recipe` | [`String!`](#string) | Recipe of the Conan package. | +| <a id="conanmetadatarecipepath"></a>`recipePath` | [`String!`](#string) | Recipe path of the Conan package. | +| <a id="conanmetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. | + +### `ContainerExpirationPolicy` + +A tag expiration policy designed to keep only the images that matter most. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="containerexpirationpolicycadence"></a>`cadence` | [`ContainerExpirationPolicyCadenceEnum!`](#containerexpirationpolicycadenceenum) | This container expiration policy schedule. | +| <a id="containerexpirationpolicycreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the container expiration policy was created. | +| <a id="containerexpirationpolicyenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether this container expiration policy is enabled. | +| <a id="containerexpirationpolicykeepn"></a>`keepN` | [`ContainerExpirationPolicyKeepEnum`](#containerexpirationpolicykeepenum) | Number of tags to retain. | +| <a id="containerexpirationpolicynameregex"></a>`nameRegex` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will expire. | +| <a id="containerexpirationpolicynameregexkeep"></a>`nameRegexKeep` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will be preserved. | +| <a id="containerexpirationpolicynextrunat"></a>`nextRunAt` | [`Time`](#time) | Next time that this container expiration policy will get executed. | +| <a id="containerexpirationpolicyolderthan"></a>`olderThan` | [`ContainerExpirationPolicyOlderThanEnum`](#containerexpirationpolicyolderthanenum) | Tags older that this will expire. | +| <a id="containerexpirationpolicyupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the container expiration policy was updated. | + +### `ContainerRepository` + +A container repository. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="containerrepositorycandelete"></a>`canDelete` | [`Boolean!`](#boolean) | Can the current user delete the container repository. | +| <a id="containerrepositorycreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp when the container repository was created. | +| <a id="containerrepositoryexpirationpolicycleanupstatus"></a>`expirationPolicyCleanupStatus` | [`ContainerRepositoryCleanupStatus`](#containerrepositorycleanupstatus) | The tags cleanup status for the container repository. | +| <a id="containerrepositoryexpirationpolicystartedat"></a>`expirationPolicyStartedAt` | [`Time`](#time) | Timestamp when the cleanup done by the expiration policy was started on the container repository. | +| <a id="containerrepositoryid"></a>`id` | [`ID!`](#id) | ID of the container repository. | +| <a id="containerrepositorylocation"></a>`location` | [`String!`](#string) | URL of the container repository. | +| <a id="containerrepositoryname"></a>`name` | [`String!`](#string) | Name of the container repository. | +| <a id="containerrepositorypath"></a>`path` | [`String!`](#string) | Path of the container repository. | +| <a id="containerrepositoryproject"></a>`project` | [`Project!`](#project) | Project of the container registry. | +| <a id="containerrepositorystatus"></a>`status` | [`ContainerRepositoryStatus`](#containerrepositorystatus) | Status of the container repository. | +| <a id="containerrepositorytagscount"></a>`tagsCount` | [`Int!`](#int) | Number of tags associated with this image. | +| <a id="containerrepositoryupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp when the container repository was updated. | + +### `ContainerRepositoryDetails` + +Details of a container repository. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="containerrepositorydetailscandelete"></a>`canDelete` | [`Boolean!`](#boolean) | Can the current user delete the container repository. | +| <a id="containerrepositorydetailscreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp when the container repository was created. | +| <a id="containerrepositorydetailsexpirationpolicycleanupstatus"></a>`expirationPolicyCleanupStatus` | [`ContainerRepositoryCleanupStatus`](#containerrepositorycleanupstatus) | The tags cleanup status for the container repository. | +| <a id="containerrepositorydetailsexpirationpolicystartedat"></a>`expirationPolicyStartedAt` | [`Time`](#time) | Timestamp when the cleanup done by the expiration policy was started on the container repository. | +| <a id="containerrepositorydetailsid"></a>`id` | [`ID!`](#id) | ID of the container repository. | +| <a id="containerrepositorydetailslocation"></a>`location` | [`String!`](#string) | URL of the container repository. | +| <a id="containerrepositorydetailsname"></a>`name` | [`String!`](#string) | Name of the container repository. | +| <a id="containerrepositorydetailspath"></a>`path` | [`String!`](#string) | Path of the container repository. | +| <a id="containerrepositorydetailsproject"></a>`project` | [`Project!`](#project) | Project of the container registry. | +| <a id="containerrepositorydetailsstatus"></a>`status` | [`ContainerRepositoryStatus`](#containerrepositorystatus) | Status of the container repository. | +| <a id="containerrepositorydetailstags"></a>`tags` | [`ContainerRepositoryTagConnection`](#containerrepositorytagconnection) | Tags of the container repository. (see [Connections](#connections)) | +| <a id="containerrepositorydetailstagscount"></a>`tagsCount` | [`Int!`](#int) | Number of tags associated with this image. | +| <a id="containerrepositorydetailsupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp when the container repository was updated. | + +### `ContainerRepositoryTag` + +A tag from a container repository. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="containerrepositorytagcandelete"></a>`canDelete` | [`Boolean!`](#boolean) | Can the current user delete this tag. | +| <a id="containerrepositorytagcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the tag was created. | +| <a id="containerrepositorytagdigest"></a>`digest` | [`String`](#string) | Digest of the tag. | +| <a id="containerrepositorytaglocation"></a>`location` | [`String!`](#string) | URL of the tag. | +| <a id="containerrepositorytagname"></a>`name` | [`String!`](#string) | Name of the tag. | +| <a id="containerrepositorytagpath"></a>`path` | [`String!`](#string) | Path of the tag. | +| <a id="containerrepositorytagrevision"></a>`revision` | [`String`](#string) | Revision of the tag. | +| <a id="containerrepositorytagshortrevision"></a>`shortRevision` | [`String`](#string) | Short revision of the tag. | +| <a id="containerrepositorytagtotalsize"></a>`totalSize` | [`BigInt`](#bigint) | The size of the tag. | + +### `CurrentLicense` + +Represents the current license. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="currentlicenseactivatedat"></a>`activatedAt` | [`Date`](#date) | Date when the license was activated. | +| <a id="currentlicensebillableuserscount"></a>`billableUsersCount` | [`Int`](#int) | Number of billable users on the system. | +| <a id="currentlicensecompany"></a>`company` | [`String`](#string) | Company of the licensee. | +| <a id="currentlicenseemail"></a>`email` | [`String`](#string) | Email of the licensee. | +| <a id="currentlicenseexpiresat"></a>`expiresAt` | [`Date`](#date) | Date when the license expires. | +| <a id="currentlicenseid"></a>`id` | [`ID!`](#id) | ID of the license. | +| <a id="currentlicenselastsync"></a>`lastSync` | [`Time`](#time) | Date when the license was last synced. | +| <a id="currentlicensemaximumusercount"></a>`maximumUserCount` | [`Int`](#int) | Highest number of billable users on the system during the term of the current license. | +| <a id="currentlicensename"></a>`name` | [`String`](#string) | Name of the licensee. | +| <a id="currentlicenseplan"></a>`plan` | [`String!`](#string) | Name of the subscription plan. | +| <a id="currentlicensestartsat"></a>`startsAt` | [`Date`](#date) | Date when the license started. | +| <a id="currentlicensetype"></a>`type` | [`String!`](#string) | Type of the license. | +| <a id="currentlicenseusersinlicensecount"></a>`usersInLicenseCount` | [`Int`](#int) | Number of paid users in the license. | +| <a id="currentlicenseusersoverlicensecount"></a>`usersOverLicenseCount` | [`Int`](#int) | Number of users over the paid users in the license. | + +### `CustomEmoji` + +A custom emoji uploaded by user. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="customemojiexternal"></a>`external` | [`Boolean!`](#boolean) | Whether the emoji is an external link. | +| <a id="customemojiid"></a>`id` | [`CustomEmojiID!`](#customemojiid) | The ID of the emoji. | +| <a id="customemojiname"></a>`name` | [`String!`](#string) | The name of the emoji. | +| <a id="customemojiurl"></a>`url` | [`String!`](#string) | The link to file of the emoji. | + +### `DastProfile` + +Represents a DAST Profile. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastprofilebranch"></a>`branch` | [`DastProfileBranch`](#dastprofilebranch) | The associated branch. | +| <a id="dastprofiledastscannerprofile"></a>`dastScannerProfile` | [`DastScannerProfile`](#dastscannerprofile) | The associated scanner profile. | +| <a id="dastprofiledastsiteprofile"></a>`dastSiteProfile` | [`DastSiteProfile`](#dastsiteprofile) | The associated site profile. | +| <a id="dastprofiledescription"></a>`description` | [`String`](#string) | The description of the scan. | +| <a id="dastprofileeditpath"></a>`editPath` | [`String`](#string) | Relative web path to the edit page of a profile. | +| <a id="dastprofileid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the profile. | +| <a id="dastprofilename"></a>`name` | [`String`](#string) | The name of the profile. | + +### `DastProfileBranch` + +Represents a DAST Profile Branch. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastprofilebranchexists"></a>`exists` | [`Boolean`](#boolean) | Indicates whether or not the branch exists. | +| <a id="dastprofilebranchname"></a>`name` | [`String`](#string) | The name of the branch. | + +### `DastScannerProfile` + +Represents a DAST scanner profile. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastscannerprofileeditpath"></a>`editPath` | [`String`](#string) | Relative web path to the edit page of a scanner profile. | +| <a id="dastscannerprofileglobalid"></a>`globalId` **{warning-solid}** | [`DastScannerProfileID!`](#dastscannerprofileid) | **Deprecated** in 13.6. Use `id`. | +| <a id="dastscannerprofileid"></a>`id` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the DAST scanner profile. | +| <a id="dastscannerprofileprofilename"></a>`profileName` | [`String`](#string) | Name of the DAST scanner profile. | +| <a id="dastscannerprofilereferencedinsecuritypolicies"></a>`referencedInSecurityPolicies` | [`[String!]`](#string) | List of security policy names that are referencing given project. | +| <a id="dastscannerprofilescantype"></a>`scanType` | [`DastScanTypeEnum`](#dastscantypeenum) | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. | +| <a id="dastscannerprofileshowdebugmessages"></a>`showDebugMessages` | [`Boolean!`](#boolean) | Indicates if debug messages should be included in DAST console output. True to include the debug messages. | +| <a id="dastscannerprofilespidertimeout"></a>`spiderTimeout` | [`Int`](#int) | The maximum number of minutes allowed for the spider to traverse the site. | +| <a id="dastscannerprofiletargettimeout"></a>`targetTimeout` | [`Int`](#int) | The maximum number of seconds allowed for the site under test to respond to a request. | +| <a id="dastscannerprofileuseajaxspider"></a>`useAjaxSpider` | [`Boolean!`](#boolean) | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. | + +### `DastSiteProfile` + +Represents a DAST Site Profile. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsiteprofileauth"></a>`auth` | [`DastSiteProfileAuth`](#dastsiteprofileauth) | Target authentication details. Will always return `null` if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="dastsiteprofileeditpath"></a>`editPath` | [`String`](#string) | Relative web path to the edit page of a site profile. | +| <a id="dastsiteprofileexcludedurls"></a>`excludedUrls` | [`[String!]`](#string) | The URLs to skip during an authenticated scan. Will always return `null` if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="dastsiteprofileid"></a>`id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile. | +| <a id="dastsiteprofilenormalizedtargeturl"></a>`normalizedTargetUrl` | [`String`](#string) | Normalized URL of the target to be scanned. | +| <a id="dastsiteprofileprofilename"></a>`profileName` | [`String`](#string) | The name of the site profile. | +| <a id="dastsiteprofilereferencedinsecuritypolicies"></a>`referencedInSecurityPolicies` | [`[String!]`](#string) | List of security policy names that are referencing given project. | +| <a id="dastsiteprofilerequestheaders"></a>`requestHeaders` | [`String`](#string) | Comma-separated list of request header names and values to be added to every request made by DAST. Will always return `null` if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| <a id="dastsiteprofiletargettype"></a>`targetType` | [`DastTargetTypeEnum`](#dasttargettypeenum) | The type of target to be scanned. Will always return `null` if `security_dast_site_profiles_api_option` feature flag is disabled. | +| <a id="dastsiteprofiletargeturl"></a>`targetUrl` | [`String`](#string) | The URL of the target to be scanned. | +| <a id="dastsiteprofileuserpermissions"></a>`userPermissions` | [`DastSiteProfilePermissions!`](#dastsiteprofilepermissions) | Permissions for the current user on the resource. | +| <a id="dastsiteprofilevalidationstatus"></a>`validationStatus` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | The current validation status of the site profile. | + +### `DastSiteProfileAuth` + +Input type for DastSiteProfile authentication. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsiteprofileauthenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether authentication is enabled. | +| <a id="dastsiteprofileauthpassword"></a>`password` | [`String`](#string) | Redacted password to authenticate with on the target website. | +| <a id="dastsiteprofileauthpasswordfield"></a>`passwordField` | [`String`](#string) | The name of password field at the sign-in HTML form. | +| <a id="dastsiteprofileauthurl"></a>`url` | [`String`](#string) | The URL of the page containing the sign-in HTML form on the target website. | +| <a id="dastsiteprofileauthusername"></a>`username` | [`String`](#string) | The username to authenticate with on the target website. | +| <a id="dastsiteprofileauthusernamefield"></a>`usernameField` | [`String`](#string) | The name of username field at the sign-in HTML form. | + +### `DastSiteProfilePermissions` + +Check permissions for the current user on site profile. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsiteprofilepermissionscreateondemanddastscan"></a>`createOnDemandDastScan` | [`Boolean!`](#boolean) | Indicates the user can perform `create_on_demand_dast_scan` on this resource. | + +### `DastSiteValidation` + +Represents a DAST Site Validation. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsitevalidationid"></a>`id` | [`DastSiteValidationID!`](#dastsitevalidationid) | Global ID of the site validation. | +| <a id="dastsitevalidationnormalizedtargeturl"></a>`normalizedTargetUrl` | [`String`](#string) | Normalized URL of the target to be validated. | +| <a id="dastsitevalidationstatus"></a>`status` | [`DastSiteProfileValidationStatusEnum!`](#dastsiteprofilevalidationstatusenum) | Status of the site validation. | ### `DeleteJobsResponse` The response from the AdminSidekiqQueuesDeleteJobs mutation. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `completed` | [`Boolean`](#boolean) | Whether or not the entire queue was processed in time; if not, retrying the same request is safe. | -| `deletedJobs` | [`Int`](#int) | The number of matching jobs deleted. | -| `queueSize` | [`Int`](#int) | The queue size after processing. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="deletejobsresponsecompleted"></a>`completed` | [`Boolean`](#boolean) | Whether or not the entire queue was processed in time; if not, retrying the same request is safe. | +| <a id="deletejobsresponsedeletedjobs"></a>`deletedJobs` | [`Int`](#int) | The number of matching jobs deleted. | +| <a id="deletejobsresponsequeuesize"></a>`queueSize` | [`Int`](#int) | The queue size after processing. | ### `Design` A single design. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `currentUserTodos` | [`TodoConnection!`](#todoconnection) | To-do items for the current user. | -| `diffRefs` | [`DiffRefs!`](#diffrefs) | The diff refs for this design. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. | -| `filename` | [`String!`](#string) | The filename of the design. | -| `fullPath` | [`String!`](#string) | The full path to the design file. | -| `id` | [`ID!`](#id) | The ID of this design. | -| `image` | [`String!`](#string) | The URL of the full-sized image. | -| `imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. | -| `issue` | [`Issue!`](#issue) | The issue the design belongs to. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `notesCount` | [`Int!`](#int) | The total count of user-created notes for this design. | -| `project` | [`Project!`](#project) | The project the design belongs to. | -| `versions` | [`DesignVersionConnection!`](#designversionconnection) | All versions related to this design ordered newest first. | +#### Fields -### `DesignAtVersion` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designdiffrefs"></a>`diffRefs` | [`DiffRefs!`](#diffrefs) | The diff refs for this design. | +| <a id="designdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="designevent"></a>`event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. | +| <a id="designfilename"></a>`filename` | [`String!`](#string) | The filename of the design. | +| <a id="designfullpath"></a>`fullPath` | [`String!`](#string) | The full path to the design file. | +| <a id="designid"></a>`id` | [`ID!`](#id) | The ID of this design. | +| <a id="designimage"></a>`image` | [`String!`](#string) | The URL of the full-sized image. | +| <a id="designimagev432x230"></a>`imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. | +| <a id="designissue"></a>`issue` | [`Issue!`](#issue) | The issue the design belongs to. | +| <a id="designnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="designnotescount"></a>`notesCount` | [`Int!`](#int) | The total count of user-created notes for this design. | +| <a id="designproject"></a>`project` | [`Project!`](#project) | The project the design belongs to. | -A design pinned to a specific version. The image field reflects the design as of the associated version. +#### Fields with arguments + +##### `Design.currentUserTodos` + +To-do items for the current user. + +Returns [`TodoConnection!`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designcurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. | + +##### `Design.versions` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `design` | [`Design!`](#design) | The underlying design. | -| `diffRefs` | [`DiffRefs!`](#diffrefs) | The diff refs for this design. | -| `event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. | -| `filename` | [`String!`](#string) | The filename of the design. | -| `fullPath` | [`String!`](#string) | The full path to the design file. | -| `id` | [`ID!`](#id) | The ID of this design. | -| `image` | [`String!`](#string) | The URL of the full-sized image. | -| `imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. | -| `issue` | [`Issue!`](#issue) | The issue the design belongs to. | -| `notesCount` | [`Int!`](#int) | The total count of user-created notes for this design. | -| `project` | [`Project!`](#project) | The project the design belongs to. | -| `version` | [`DesignVersion!`](#designversion) | The version this design-at-versions is pinned to. | +All versions related to this design ordered newest first. -### `DesignAtVersionConnection` +Returns [`DesignVersionConnection!`](#designversionconnection). -The connection type for DesignAtVersion. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DesignAtVersionEdge]`](#designatversionedge) | A list of edges. | -| `nodes` | [`[DesignAtVersion]`](#designatversion) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +###### Arguments -### `DesignAtVersionEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designversionsearlierorequaltoid"></a>`earlierOrEqualToId` | [`DesignManagementVersionID`](#designmanagementversionid) | The Global ID of the most recent acceptable version. | +| <a id="designversionsearlierorequaltosha"></a>`earlierOrEqualToSha` | [`String`](#string) | The SHA256 of the most recent acceptable version. | + +### `DesignAtVersion` + +A design pinned to a specific version. The image field reflects the design as of the associated version. -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`DesignAtVersion`](#designatversion) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designatversiondesign"></a>`design` | [`Design!`](#design) | The underlying design. | +| <a id="designatversiondiffrefs"></a>`diffRefs` | [`DiffRefs!`](#diffrefs) | The diff refs for this design. | +| <a id="designatversionevent"></a>`event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. | +| <a id="designatversionfilename"></a>`filename` | [`String!`](#string) | The filename of the design. | +| <a id="designatversionfullpath"></a>`fullPath` | [`String!`](#string) | The full path to the design file. | +| <a id="designatversionid"></a>`id` | [`ID!`](#id) | The ID of this design. | +| <a id="designatversionimage"></a>`image` | [`String!`](#string) | The URL of the full-sized image. | +| <a id="designatversionimagev432x230"></a>`imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. | +| <a id="designatversionissue"></a>`issue` | [`Issue!`](#issue) | The issue the design belongs to. | +| <a id="designatversionnotescount"></a>`notesCount` | [`Int!`](#int) | The total count of user-created notes for this design. | +| <a id="designatversionproject"></a>`project` | [`Project!`](#project) | The project the design belongs to. | +| <a id="designatversionversion"></a>`version` | [`DesignVersion!`](#designversion) | The version this design-at-versions is pinned to. | ### `DesignCollection` A collection of designs. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `copyState` | [`DesignCollectionCopyState`](#designcollectioncopystate) | Copy state of the design collection. | -| `design` | [`Design`](#design) | Find a specific design. | -| `designAtVersion` | [`DesignAtVersion`](#designatversion) | Find a design as of a version. | -| `designs` | [`DesignConnection!`](#designconnection) | All designs for the design collection. | -| `issue` | [`Issue!`](#issue) | Issue associated with the design collection. | -| `project` | [`Project!`](#project) | Project associated with the design collection. | -| `version` | [`DesignVersion`](#designversion) | A specific version. | -| `versions` | [`DesignVersionConnection!`](#designversionconnection) | All versions related to all designs, ordered newest first. | +#### Fields -### `DesignConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designcollectioncopystate"></a>`copyState` | [`DesignCollectionCopyState`](#designcollectioncopystate) | Copy state of the design collection. | +| <a id="designcollectionissue"></a>`issue` | [`Issue!`](#issue) | Issue associated with the design collection. | +| <a id="designcollectionproject"></a>`project` | [`Project!`](#project) | Project associated with the design collection. | -The connection type for Design. +#### Fields with arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DesignEdge]`](#designedge) | A list of edges. | -| `nodes` | [`[Design]`](#design) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### `DesignCollection.design` -### `DesignEdge` +Find a specific design. -An edge in a connection. +Returns [`Design`](#design). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Design`](#design) | The item at the end of the edge. | +###### Arguments -### `DesignManagement` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designcollectiondesignfilename"></a>`filename` | [`String`](#string) | Find a design by its filename. | +| <a id="designcollectiondesignid"></a>`id` | [`DesignManagementDesignID`](#designmanagementdesignid) | Find a design by its ID. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `designAtVersion` | [`DesignAtVersion`](#designatversion) | Find a design as of a version. | -| `version` | [`DesignVersion`](#designversion) | Find a version. | +##### `DesignCollection.designAtVersion` -### `DesignManagementDeletePayload` +Find a design as of a version. -Autogenerated return type of DesignManagementDelete. +Returns [`DesignAtVersion`](#designatversion). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `version` | [`DesignVersion`](#designversion) | The new version in which the designs are deleted. | +###### Arguments -### `DesignManagementMovePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designcollectiondesignatversionid"></a>`id` | [`DesignManagementDesignAtVersionID!`](#designmanagementdesignatversionid) | The Global ID of the design at this version. | -Autogenerated return type of DesignManagementMove. +##### `DesignCollection.designs` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `designCollection` | [`DesignCollection`](#designcollection) | The current state of the collection. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +All designs for the design collection. -### `DesignManagementUploadPayload` +Returns [`DesignConnection!`](#designconnection). -Autogenerated return type of DesignManagementUpload. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `designs` | [`[Design!]!`](#design) | The designs that were uploaded by the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `skippedDesigns` | [`[Design!]!`](#design) | Any designs that were skipped from the upload due to there being no change to their content since their last version. | +###### Arguments -### `DesignVersion` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designcollectiondesignsatversion"></a>`atVersion` | [`DesignManagementVersionID`](#designmanagementversionid) | Filters designs to only those that existed at the version. If argument is omitted or nil then all designs will reflect the latest version. | +| <a id="designcollectiondesignsfilenames"></a>`filenames` | [`[String!]`](#string) | Filters designs by their filename. | +| <a id="designcollectiondesignsids"></a>`ids` | [`[DesignManagementDesignID!]`](#designmanagementdesignid) | Filters designs by their ID. | -A specific version in which designs were added, modified or deleted. +##### `DesignCollection.version` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `designAtVersion` | [`DesignAtVersion!`](#designatversion) | A particular design as of this version, provided it is visible at this version. | -| `designs` | [`DesignConnection!`](#designconnection) | All designs that were changed in the version. | -| `designsAtVersion` | [`DesignAtVersionConnection!`](#designatversionconnection) | All designs that are visible at this version, as of this version. | -| `id` | [`ID!`](#id) | ID of the design version. | -| `sha` | [`ID!`](#id) | SHA of the design version. | +A specific version. -### `DesignVersionConnection` +Returns [`DesignVersion`](#designversion). -The connection type for DesignVersion. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DesignVersionEdge]`](#designversionedge) | A list of edges. | -| `nodes` | [`[DesignVersion]`](#designversion) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designcollectionversionid"></a>`id` | [`DesignManagementVersionID`](#designmanagementversionid) | The Global ID of the version. | +| <a id="designcollectionversionsha"></a>`sha` | [`String`](#string) | The SHA256 of a specific version. | -### `DesignVersionEdge` +##### `DesignCollection.versions` -An edge in a connection. +All versions related to all designs, ordered newest first. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`DesignVersion`](#designversion) | The item at the end of the edge. | +Returns [`DesignVersionConnection!`](#designversionconnection). -### `DestroyBoardListPayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of DestroyBoardList. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `list` | [`BoardList`](#boardlist) | The list after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designcollectionversionsearlierorequaltoid"></a>`earlierOrEqualToId` | [`DesignManagementVersionID`](#designmanagementversionid) | The Global ID of the most recent acceptable version. | +| <a id="designcollectionversionsearlierorequaltosha"></a>`earlierOrEqualToSha` | [`String`](#string) | The SHA256 of the most recent acceptable version. | -### `DestroyBoardPayload` +### `DesignManagement` -Autogenerated return type of DestroyBoard. +#### Fields with arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `board` | [`Board`](#board) | The board after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +##### `DesignManagement.designAtVersion` -### `DestroyComplianceFrameworkPayload` +Find a design as of a version. -Autogenerated return type of DestroyComplianceFramework. +Returns [`DesignAtVersion`](#designatversion). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +###### Arguments -### `DestroyContainerRepositoryPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designmanagementdesignatversionid"></a>`id` | [`DesignManagementDesignAtVersionID!`](#designmanagementdesignatversionid) | The Global ID of the design at this version. | -Autogenerated return type of DestroyContainerRepository. +##### `DesignManagement.version` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `containerRepository` | [`ContainerRepository!`](#containerrepository) | The container repository policy after scheduling the deletion. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +Find a version. -### `DestroyContainerRepositoryTagsPayload` +Returns [`DesignVersion`](#designversion). -Autogenerated return type of DestroyContainerRepositoryTags. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `deletedTagNames` | [`[String!]!`](#string) | Deleted container repository tags. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designmanagementversionid"></a>`id` | [`DesignManagementVersionID!`](#designmanagementversionid) | The Global ID of the version. | -### `DestroyEpicBoardPayload` +### `DesignVersion` -Autogenerated return type of DestroyEpicBoard. +A specific version in which designs were added, modified or deleted. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epicBoard` | [`EpicBoard`](#epicboard) | Epic board after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### Fields -### `DestroyNotePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designversionauthor"></a>`author` | [`UserCore!`](#usercore) | Author of the version. | +| <a id="designversioncreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the version was created. | +| <a id="designversiondesigns"></a>`designs` | [`DesignConnection!`](#designconnection) | All designs that were changed in the version. (see [Connections](#connections)) | +| <a id="designversionid"></a>`id` | [`ID!`](#id) | ID of the design version. | +| <a id="designversionsha"></a>`sha` | [`ID!`](#id) | SHA of the design version. | -Autogenerated return type of DestroyNote. +#### Fields with arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `note` | [`Note`](#note) | The note after mutation. | +##### `DesignVersion.designAtVersion` -### `DestroySnippetPayload` +A particular design as of this version, provided it is visible at this version. -Autogenerated return type of DestroySnippet. +Returns [`DesignAtVersion!`](#designatversion). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `snippet` | [`Snippet`](#snippet) | The snippet after mutation. | +###### Arguments -### `DetailedStatus` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designversiondesignatversiondesignid"></a>`designId` | [`DesignManagementDesignID`](#designmanagementdesignid) | The ID of a specific design. | +| <a id="designversiondesignatversionfilename"></a>`filename` | [`String`](#string) | The filename of a specific design. | +| <a id="designversiondesignatversionid"></a>`id` | [`DesignManagementDesignAtVersionID`](#designmanagementdesignatversionid) | The ID of the DesignAtVersion. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `action` | [`StatusAction`](#statusaction) | Action information for the status. This includes method, button title, icon, path, and title. | -| `detailsPath` | [`String`](#string) | Path of the details for the status. | -| `favicon` | [`String`](#string) | Favicon of the status. | -| `group` | [`String`](#string) | Group of the status. | -| `hasDetails` | [`Boolean`](#boolean) | Indicates if the status has further details. | -| `icon` | [`String`](#string) | Icon of the status. | -| `label` | [`String`](#string) | Label of the status. | -| `text` | [`String`](#string) | Text of the status. | -| `tooltip` | [`String`](#string) | Tooltip associated with the status. | +##### `DesignVersion.designsAtVersion` -### `DevopsAdoptionSegment` +All designs that are visible at this version, as of this version. -Segment. +Returns [`DesignAtVersionConnection!`](#designatversionconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `id` | [`ID!`](#id) | ID of the segment. | -| `latestSnapshot` | [`DevopsAdoptionSnapshot`](#devopsadoptionsnapshot) | The latest adoption metrics for the segment. | -| `namespace` | [`Namespace`](#namespace) | Segment namespace. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `DevopsAdoptionSegmentConnection` +###### Arguments -The connection type for DevopsAdoptionSegment. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designversiondesignsatversionfilenames"></a>`filenames` | [`[String!]`](#string) | Filters designs by their filename. | +| <a id="designversiondesignsatversionids"></a>`ids` | [`[DesignManagementDesignID!]`](#designmanagementdesignid) | Filters designs by their ID. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DevopsAdoptionSegmentEdge]`](#devopsadoptionsegmentedge) | A list of edges. | -| `nodes` | [`[DevopsAdoptionSegment]`](#devopsadoptionsegment) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `DetailedStatus` -### `DevopsAdoptionSegmentEdge` +#### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="detailedstatusaction"></a>`action` | [`StatusAction`](#statusaction) | Action information for the status. This includes method, button title, icon, path, and title. | +| <a id="detailedstatusdetailspath"></a>`detailsPath` | [`String`](#string) | Path of the details for the status. | +| <a id="detailedstatusfavicon"></a>`favicon` | [`String`](#string) | Favicon of the status. | +| <a id="detailedstatusgroup"></a>`group` | [`String`](#string) | Group of the status. | +| <a id="detailedstatushasdetails"></a>`hasDetails` | [`Boolean`](#boolean) | Indicates if the status has further details. | +| <a id="detailedstatusicon"></a>`icon` | [`String`](#string) | Icon of the status. | +| <a id="detailedstatuslabel"></a>`label` | [`String`](#string) | Label of the status. | +| <a id="detailedstatustext"></a>`text` | [`String`](#string) | Text of the status. | +| <a id="detailedstatustooltip"></a>`tooltip` | [`String`](#string) | Tooltip associated with the status. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`DevopsAdoptionSegment`](#devopsadoptionsegment) | The item at the end of the edge. | +### `DevopsAdoptionSegment` + +Segment. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="devopsadoptionsegmentid"></a>`id` | [`ID!`](#id) | ID of the segment. | +| <a id="devopsadoptionsegmentlatestsnapshot"></a>`latestSnapshot` | [`DevopsAdoptionSnapshot`](#devopsadoptionsnapshot) | The latest adoption metrics for the segment. | +| <a id="devopsadoptionsegmentnamespace"></a>`namespace` | [`Namespace`](#namespace) | Segment namespace. | ### `DevopsAdoptionSnapshot` Snapshot. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `deploySucceeded` | [`Boolean!`](#boolean) | At least one deployment succeeded. | -| `endTime` | [`Time!`](#time) | The end time for the snapshot where the data points were collected. | -| `issueOpened` | [`Boolean!`](#boolean) | At least one issue was opened. | -| `mergeRequestApproved` | [`Boolean!`](#boolean) | At least one merge request was approved. | -| `mergeRequestOpened` | [`Boolean!`](#boolean) | At least one merge request was opened. | -| `pipelineSucceeded` | [`Boolean!`](#boolean) | At least one pipeline succeeded. | -| `recordedAt` | [`Time!`](#time) | The time the snapshot was recorded. | -| `runnerConfigured` | [`Boolean!`](#boolean) | At least one runner was used. | -| `securityScanSucceeded` | [`Boolean!`](#boolean) | At least one security scan succeeded. | -| `startTime` | [`Time!`](#time) | The start time for the snapshot where the data points were collected. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="devopsadoptionsnapshotcodeownersusedcount"></a>`codeOwnersUsedCount` | [`Int`](#int) | Total number of projects with existing CODEOWNERS file. | +| <a id="devopsadoptionsnapshotdeploysucceeded"></a>`deploySucceeded` | [`Boolean!`](#boolean) | At least one deployment succeeded. | +| <a id="devopsadoptionsnapshotendtime"></a>`endTime` | [`Time!`](#time) | The end time for the snapshot where the data points were collected. | +| <a id="devopsadoptionsnapshotissueopened"></a>`issueOpened` | [`Boolean!`](#boolean) | At least one issue was opened. | +| <a id="devopsadoptionsnapshotmergerequestapproved"></a>`mergeRequestApproved` | [`Boolean!`](#boolean) | At least one merge request was approved. | +| <a id="devopsadoptionsnapshotmergerequestopened"></a>`mergeRequestOpened` | [`Boolean!`](#boolean) | At least one merge request was opened. | +| <a id="devopsadoptionsnapshotpipelinesucceeded"></a>`pipelineSucceeded` | [`Boolean!`](#boolean) | At least one pipeline succeeded. | +| <a id="devopsadoptionsnapshotrecordedat"></a>`recordedAt` | [`Time!`](#time) | The time the snapshot was recorded. | +| <a id="devopsadoptionsnapshotrunnerconfigured"></a>`runnerConfigured` | [`Boolean!`](#boolean) | At least one runner was used. | +| <a id="devopsadoptionsnapshotsecurityscansucceeded"></a>`securityScanSucceeded` | [`Boolean!`](#boolean) | At least one security scan succeeded. | +| <a id="devopsadoptionsnapshotstarttime"></a>`startTime` | [`Time!`](#time) | The start time for the snapshot where the data points were collected. | +| <a id="devopsadoptionsnapshottotalprojectscount"></a>`totalProjectsCount` | [`Int`](#int) | Total number of projects. | ### `DiffPosition` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `diffRefs` | [`DiffRefs!`](#diffrefs) | Information about the branch, HEAD, and base at the time of commenting. | -| `filePath` | [`String!`](#string) | Path of the file that was changed. | -| `height` | [`Int`](#int) | Total height of the image. | -| `newLine` | [`Int`](#int) | Line on HEAD SHA that was changed. | -| `newPath` | [`String`](#string) | Path of the file on the HEAD SHA. | -| `oldLine` | [`Int`](#int) | Line on start SHA that was changed. | -| `oldPath` | [`String`](#string) | Path of the file on the start SHA. | -| `positionType` | [`DiffPositionType!`](#diffpositiontype) | Type of file the position refers to. | -| `width` | [`Int`](#int) | Total width of the image. | -| `x` | [`Int`](#int) | X position of the note. | -| `y` | [`Int`](#int) | Y position of the note. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="diffpositiondiffrefs"></a>`diffRefs` | [`DiffRefs!`](#diffrefs) | Information about the branch, HEAD, and base at the time of commenting. | +| <a id="diffpositionfilepath"></a>`filePath` | [`String!`](#string) | Path of the file that was changed. | +| <a id="diffpositionheight"></a>`height` | [`Int`](#int) | Total height of the image. | +| <a id="diffpositionnewline"></a>`newLine` | [`Int`](#int) | Line on HEAD SHA that was changed. | +| <a id="diffpositionnewpath"></a>`newPath` | [`String`](#string) | Path of the file on the HEAD SHA. | +| <a id="diffpositionoldline"></a>`oldLine` | [`Int`](#int) | Line on start SHA that was changed. | +| <a id="diffpositionoldpath"></a>`oldPath` | [`String`](#string) | Path of the file on the start SHA. | +| <a id="diffpositionpositiontype"></a>`positionType` | [`DiffPositionType!`](#diffpositiontype) | Type of file the position refers to. | +| <a id="diffpositionwidth"></a>`width` | [`Int`](#int) | Total width of the image. | +| <a id="diffpositionx"></a>`x` | [`Int`](#int) | X position of the note. | +| <a id="diffpositiony"></a>`y` | [`Int`](#int) | Y position of the note. | ### `DiffRefs` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `baseSha` | [`String`](#string) | Merge base of the branch the comment was made on. | -| `headSha` | [`String!`](#string) | SHA of the HEAD at the time the comment was made. | -| `startSha` | [`String!`](#string) | SHA of the branch being compared against. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="diffrefsbasesha"></a>`baseSha` | [`String`](#string) | Merge base of the branch the comment was made on. | +| <a id="diffrefsheadsha"></a>`headSha` | [`String!`](#string) | SHA of the HEAD at the time the comment was made. | +| <a id="diffrefsstartsha"></a>`startSha` | [`String!`](#string) | SHA of the branch being compared against. | ### `DiffStats` Changes to a single file. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `additions` | [`Int!`](#int) | Number of lines added to this file. | -| `deletions` | [`Int!`](#int) | Number of lines deleted from this file. | -| `path` | [`String!`](#string) | File path, relative to repository root. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="diffstatsadditions"></a>`additions` | [`Int!`](#int) | Number of lines added to this file. | +| <a id="diffstatsdeletions"></a>`deletions` | [`Int!`](#int) | Number of lines deleted from this file. | +| <a id="diffstatspath"></a>`path` | [`String!`](#string) | File path, relative to repository root. | ### `DiffStatsSummary` Aggregated summary of changes. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `additions` | [`Int!`](#int) | Number of lines added. | -| `changes` | [`Int!`](#int) | Number of lines changed. | -| `deletions` | [`Int!`](#int) | Number of lines deleted. | -| `fileCount` | [`Int!`](#int) | Number of files changed. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="diffstatssummaryadditions"></a>`additions` | [`Int!`](#int) | Number of lines added. | +| <a id="diffstatssummarychanges"></a>`changes` | [`Int!`](#int) | Number of lines changed. | +| <a id="diffstatssummarydeletions"></a>`deletions` | [`Int!`](#int) | Number of lines deleted. | +| <a id="diffstatssummaryfilecount"></a>`fileCount` | [`Int!`](#int) | Number of files changed. | ### `Discussion` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Timestamp of the discussion's creation. | -| `id` | [`DiscussionID!`](#discussionid) | ID of this discussion. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes in the discussion. | -| `replyId` | [`DiscussionID!`](#discussionid) | ID used to reply to this discussion. | -| `resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. | -| `resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. | -| `resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. | -| `resolvedBy` | [`User`](#user) | User who resolved the object. | +#### Fields -### `DiscussionConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="discussioncreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the discussion's creation. | +| <a id="discussionid"></a>`id` | [`DiscussionID!`](#discussionid) | ID of this discussion. | +| <a id="discussionnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes in the discussion. (see [Connections](#connections)) | +| <a id="discussionreplyid"></a>`replyId` | [`DiscussionID!`](#discussionid) | ID used to reply to this discussion. | +| <a id="discussionresolvable"></a>`resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. | +| <a id="discussionresolved"></a>`resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. | +| <a id="discussionresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. | +| <a id="discussionresolvedby"></a>`resolvedBy` | [`UserCore`](#usercore) | User who resolved the object. | -The connection type for Discussion. +### `Environment` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[DiscussionEdge]`](#discussionedge) | A list of edges. | -| `nodes` | [`[Discussion]`](#discussion) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Describes where code is deployed for a project. -### `DiscussionEdge` +#### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="environmentid"></a>`id` | [`ID!`](#id) | ID of the environment. | +| <a id="environmentlatestopenedmostseverealert"></a>`latestOpenedMostSevereAlert` | [`AlertManagementAlert`](#alertmanagementalert) | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. | +| <a id="environmentname"></a>`name` | [`String!`](#string) | Human-readable name of the environment. | +| <a id="environmentpath"></a>`path` | [`String!`](#string) | The path to the environment. | +| <a id="environmentstate"></a>`state` | [`String!`](#string) | State of the environment, for example: available/stopped. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Discussion`](#discussion) | The item at the end of the edge. | +#### Fields with arguments -### `DiscussionToggleResolvePayload` +##### `Environment.metricsDashboard` -Autogenerated return type of DiscussionToggleResolve. +Metrics dashboard schema for the environment. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `discussion` | [`Discussion`](#discussion) | The discussion after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +Returns [`MetricsDashboard`](#metricsdashboard). -### `DismissVulnerabilityPayload` +###### Arguments -Autogenerated return type of DismissVulnerability. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="environmentmetricsdashboardpath"></a>`path` | [`String!`](#string) | Path to a file which defines a metrics dashboard eg: `"config/prometheus/common_metrics.yml"`. | -| Field | 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) | The vulnerability after dismissal. | +### `Epic` -### `Environment` +Represents an epic. -Describes where code is deployed for a project. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `id` | [`ID!`](#id) | ID of the environment. | -| `latestOpenedMostSevereAlert` | [`AlertManagementAlert`](#alertmanagementalert) | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. | -| `metricsDashboard` | [`MetricsDashboard`](#metricsdashboard) | Metrics dashboard schema for the environment. | -| `name` | [`String!`](#string) | Human-readable name of the environment. | -| `path` | [`String!`](#string) | The path to the environment. | -| `state` | [`String!`](#string) | State of the environment, for example: available/stopped. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicauthor"></a>`author` | [`UserCore!`](#usercore) | Author of the epic. | +| <a id="epicawardemoji"></a>`awardEmoji` | [`AwardEmojiConnection`](#awardemojiconnection) | A list of award emojis associated with the epic. (see [Connections](#connections)) | +| <a id="epicclosedat"></a>`closedAt` | [`Time`](#time) | Timestamp of when the epic was closed. | +| <a id="epicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. | +| <a id="epiccreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the epic was created. | +| <a id="epicdescendantcounts"></a>`descendantCounts` | [`EpicDescendantCount`](#epicdescendantcount) | Number of open and closed descendant epics and issues. | +| <a id="epicdescendantweightsum"></a>`descendantWeightSum` | [`EpicDescendantWeights`](#epicdescendantweights) | Total weight of open and closed issues in the epic and its descendants. | +| <a id="epicdescription"></a>`description` | [`String`](#string) | Description of the epic. | +| <a id="epicdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="epicdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="epicdownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes the epic has received. | +| <a id="epicduedate"></a>`dueDate` | [`Time`](#time) | Due date of the epic. | +| <a id="epicduedatefixed"></a>`dueDateFixed` | [`Time`](#time) | Fixed due date of the epic. | +| <a id="epicduedatefrommilestones"></a>`dueDateFromMilestones` | [`Time`](#time) | Inherited due date of the epic from milestones. | +| <a id="epicduedateisfixed"></a>`dueDateIsFixed` | [`Boolean`](#boolean) | Indicates if the due date has been manually set. | +| <a id="epicevents"></a>`events` | [`EventConnection`](#eventconnection) | A list of events associated with the object. (see [Connections](#connections)) | +| <a id="epicgroup"></a>`group` | [`Group!`](#group) | Group to which the epic belongs. | +| <a id="epichaschildren"></a>`hasChildren` | [`Boolean!`](#boolean) | Indicates if the epic has children. | +| <a id="epichasissues"></a>`hasIssues` | [`Boolean!`](#boolean) | Indicates if the epic has direct issues. | +| <a id="epichasparent"></a>`hasParent` | [`Boolean!`](#boolean) | Indicates if the epic has a parent epic. | +| <a id="epichealthstatus"></a>`healthStatus` | [`EpicHealthStatus`](#epichealthstatus) | Current health status of the epic. | +| <a id="epicid"></a>`id` | [`ID!`](#id) | ID of the epic. | +| <a id="epiciid"></a>`iid` | [`ID!`](#id) | Internal ID of the epic. | +| <a id="epicissues"></a>`issues` | [`EpicIssueConnection`](#epicissueconnection) | A list of issues associated with the epic. (see [Connections](#connections)) | +| <a id="epiclabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels assigned to the epic. (see [Connections](#connections)) | +| <a id="epicnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="epicparent"></a>`parent` | [`Epic`](#epic) | Parent epic of the epic. | +| <a id="epicparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | List of participants for the epic. (see [Connections](#connections)) | +| <a id="epicrelationpath"></a>`relationPath` | [`String`](#string) | URI path of the epic-issue relationship. | +| <a id="epicrelativeposition"></a>`relativePosition` | [`Int`](#int) | The relative position of the epic in the epic tree. | +| <a id="epicstartdate"></a>`startDate` | [`Time`](#time) | Start date of the epic. | +| <a id="epicstartdatefixed"></a>`startDateFixed` | [`Time`](#time) | Fixed start date of the epic. | +| <a id="epicstartdatefrommilestones"></a>`startDateFromMilestones` | [`Time`](#time) | Inherited start date of the epic from milestones. | +| <a id="epicstartdateisfixed"></a>`startDateIsFixed` | [`Boolean`](#boolean) | Indicates if the start date has been manually set. | +| <a id="epicstate"></a>`state` | [`EpicState!`](#epicstate) | State of the epic. | +| <a id="epicsubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the epic. | +| <a id="epictitle"></a>`title` | [`String`](#string) | Title of the epic. | +| <a id="epictitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | +| <a id="epicupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp of when the epic was updated. | +| <a id="epicupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes the epic has received. | +| <a id="epicuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the epic. | +| <a id="epicusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes of the epic. | +| <a id="epicuserpermissions"></a>`userPermissions` | [`EpicPermissions!`](#epicpermissions) | Permissions for the current user on the resource. | +| <a id="epicwebpath"></a>`webPath` | [`String!`](#string) | Web path of the epic. | +| <a id="epicweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the epic. | + +#### Fields with arguments + +##### `Epic.children` + +Children (sub-epics) of the epic. + +Returns [`EpicConnection`](#epicconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -### `EnvironmentConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicchildrenauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. | +| <a id="epicchildrenconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. | +| <a id="epicchildrenenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. | +| <a id="epicchildreniid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". | +| <a id="epicchildreniidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. | +| <a id="epicchildreniids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., [1, 2]. | +| <a id="epicchildrenincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. | +| <a id="epicchildrenlabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. | +| <a id="epicchildrenmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. | +| <a id="epicchildrenmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. | +| <a id="epicchildrensearch"></a>`search` | [`String`](#string) | Search query for epic title or description. | +| <a id="epicchildrensort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. | +| <a id="epicchildrenstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. | +| <a id="epicchildrenstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. | +| <a id="epicchildrentimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. | + +##### `Epic.currentUserTodos` + +To-do items for the current user. + +Returns [`TodoConnection!`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -The connection type for Environment. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epiccurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[EnvironmentEdge]`](#environmentedge) | A list of edges. | -| `nodes` | [`[Environment]`](#environment) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### `Epic.reference` -### `EnvironmentEdge` +Internal reference of the epic. Returned in shortened format by default. -An edge in a connection. +Returns [`String!`](#string). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Environment`](#environment) | The item at the end of the edge. | +###### Arguments -### `EnvironmentsCanaryIngressUpdatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicreferencefull"></a>`full` | [`Boolean`](#boolean) | Indicates if the reference should be returned in full. | -Autogenerated return type of EnvironmentsCanaryIngressUpdate. +### `EpicBoard` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +Represents an epic board. -### `Epic` +#### Fields -Represents an epic. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicboardhidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. | +| <a id="epicboardhideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. | +| <a id="epicboardid"></a>`id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the epic board. | +| <a id="epicboardlabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the board. (see [Connections](#connections)) | +| <a id="epicboardname"></a>`name` | [`String`](#string) | Name of the epic board. | +| <a id="epicboardwebpath"></a>`webPath` | [`String!`](#string) | Web path of the epic board. | +| <a id="epicboardweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the epic board. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `author` | [`User!`](#user) | Author of the epic. | -| `awardEmoji` | [`AwardEmojiConnection`](#awardemojiconnection) | A list of award emojis associated with the epic. | -| `children` | [`EpicConnection`](#epicconnection) | Children (sub-epics) of the epic. | -| `closedAt` | [`Time`](#time) | Timestamp of when the epic was closed. | -| `confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. | -| `createdAt` | [`Time`](#time) | Timestamp of when the epic was created. | -| `currentUserTodos` | [`TodoConnection!`](#todoconnection) | To-do items for the current user. | -| `descendantCounts` | [`EpicDescendantCount`](#epicdescendantcount) | Number of open and closed descendant epics and issues. | -| `descendantWeightSum` | [`EpicDescendantWeights`](#epicdescendantweights) | Total weight of open and closed issues in the epic and its descendants. | -| `description` | [`String`](#string) | Description of the epic. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `downvotes` | [`Int!`](#int) | Number of downvotes the epic has received. | -| `dueDate` | [`Time`](#time) | Due date of the epic. | -| `dueDateFixed` | [`Time`](#time) | Fixed due date of the epic. | -| `dueDateFromMilestones` | [`Time`](#time) | Inherited due date of the epic from milestones. | -| `dueDateIsFixed` | [`Boolean`](#boolean) | Indicates if the due date has been manually set. | -| `events` | [`EventConnection`](#eventconnection) | A list of events associated with the object. | -| `group` | [`Group!`](#group) | Group to which the epic belongs. | -| `hasChildren` | [`Boolean!`](#boolean) | Indicates if the epic has children. | -| `hasIssues` | [`Boolean!`](#boolean) | Indicates if the epic has direct issues. | -| `hasParent` | [`Boolean!`](#boolean) | Indicates if the epic has a parent epic. | -| `healthStatus` | [`EpicHealthStatus`](#epichealthstatus) | Current health status of the epic. | -| `id` | [`ID!`](#id) | ID of the epic. | -| `iid` | [`ID!`](#id) | Internal ID of the epic. | -| `issues` | [`EpicIssueConnection`](#epicissueconnection) | A list of issues associated with the epic. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels assigned to the epic. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `parent` | [`Epic`](#epic) | Parent epic of the epic. | -| `participants` | [`UserConnection`](#userconnection) | List of participants for the epic. | -| `reference` | [`String!`](#string) | Internal reference of the epic. Returned in shortened format by default. | -| `relationPath` | [`String`](#string) | URI path of the epic-issue relationship. | -| `relativePosition` | [`Int`](#int) | The relative position of the epic in the epic tree. | -| `startDate` | [`Time`](#time) | Start date of the epic. | -| `startDateFixed` | [`Time`](#time) | Fixed start date of the epic. | -| `startDateFromMilestones` | [`Time`](#time) | Inherited start date of the epic from milestones. | -| `startDateIsFixed` | [`Boolean`](#boolean) | Indicates if the start date has been manually set. | -| `state` | [`EpicState!`](#epicstate) | State of the epic. | -| `subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the epic. | -| `title` | [`String`](#string) | Title of the epic. | -| `titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | -| `updatedAt` | [`Time`](#time) | Timestamp of when the epic was updated. | -| `upvotes` | [`Int!`](#int) | Number of upvotes the epic has received. | -| `userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the epic. | -| `userNotesCount` | [`Int!`](#int) | Number of user notes of the epic. | -| `userPermissions` | [`EpicPermissions!`](#epicpermissions) | Permissions for the current user on the resource. | -| `webPath` | [`String!`](#string) | Web path of the epic. | -| `webUrl` | [`String!`](#string) | Web URL of the epic. | - -### `EpicAddIssuePayload` - -Autogenerated return type of EpicAddIssue. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epic` | [`Epic`](#epic) | The epic after mutation. | -| `epicIssue` | [`EpicIssue`](#epicissue) | The epic-issue relation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### Fields with arguments -### `EpicBoard` +##### `EpicBoard.lists` -Represents an epic board. +Epic board lists. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. | -| `hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. | -| `id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the epic board. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels of the board. | -| `lists` | [`EpicListConnection`](#epiclistconnection) | Epic board lists. | -| `name` | [`String`](#string) | Name of the epic board. | -| `webPath` | [`String!`](#string) | Web path of the epic board. | -| `webUrl` | [`String!`](#string) | Web URL of the epic board. | +Returns [`EpicListConnection`](#epiclistconnection). -### `EpicBoardConnection` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -The connection type for EpicBoard. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[EpicBoardEdge]`](#epicboardedge) | A list of edges. | -| `nodes` | [`[EpicBoard]`](#epicboard) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicboardlistsid"></a>`id` | [`BoardsEpicListID`](#boardsepiclistid) | Find an epic board list by ID. | -### `EpicBoardCreatePayload` +### `EpicDescendantCount` -Autogenerated return type of EpicBoardCreate. +Counts of descendent epics. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epicBoard` | [`EpicBoard`](#epicboard) | The created epic board. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### Fields -### `EpicBoardEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicdescendantcountclosedepics"></a>`closedEpics` | [`Int`](#int) | Number of closed child epics. | +| <a id="epicdescendantcountclosedissues"></a>`closedIssues` | [`Int`](#int) | Number of closed epic issues. | +| <a id="epicdescendantcountopenedepics"></a>`openedEpics` | [`Int`](#int) | Number of opened child epics. | +| <a id="epicdescendantcountopenedissues"></a>`openedIssues` | [`Int`](#int) | Number of opened epic issues. | -An edge in a connection. +### `EpicDescendantWeights` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`EpicBoard`](#epicboard) | The item at the end of the edge. | +Total weight of open and closed descendant issues. -### `EpicBoardListCreatePayload` +#### Fields -Autogenerated return type of EpicBoardListCreate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicdescendantweightsclosedissues"></a>`closedIssues` | [`Int`](#int) | Total weight of completed (closed) issues in this epic, including epic descendants. | +| <a id="epicdescendantweightsopenedissues"></a>`openedIssues` | [`Int`](#int) | Total weight of opened issues in this epic, including epic descendants. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `list` | [`EpicList`](#epiclist) | Epic list in the epic board. | +### `EpicHealthStatus` -### `EpicBoardUpdatePayload` +Health status of child issues. -Autogenerated return type of EpicBoardUpdate. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epicBoard` | [`EpicBoard`](#epicboard) | The updated epic board. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epichealthstatusissuesatrisk"></a>`issuesAtRisk` | [`Int`](#int) | Number of issues at risk. | +| <a id="epichealthstatusissuesneedingattention"></a>`issuesNeedingAttention` | [`Int`](#int) | Number of issues that need attention. | +| <a id="epichealthstatusissuesontrack"></a>`issuesOnTrack` | [`Int`](#int) | Number of issues on track. | -### `EpicConnection` +### `EpicIssue` -The connection type for Epic. +Relationship between an epic and an issue. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[EpicEdge]`](#epicedge) | A list of edges. | -| `nodes` | [`[Epic]`](#epic) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### Fields -### `EpicDescendantCount` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicissuealertmanagementalert"></a>`alertManagementAlert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert associated to this issue. | +| <a id="epicissueassignees"></a>`assignees` | [`UserCoreConnection`](#usercoreconnection) | Assignees of the issue. (see [Connections](#connections)) | +| <a id="epicissueauthor"></a>`author` | [`UserCore!`](#usercore) | User that created the issue. | +| <a id="epicissueblocked"></a>`blocked` | [`Boolean!`](#boolean) | Indicates the issue is blocked. | +| <a id="epicissueblockedbycount"></a>`blockedByCount` | [`Int`](#int) | Count of issues blocking this issue. | +| <a id="epicissueblockedbyissues"></a>`blockedByIssues` | [`IssueConnection`](#issueconnection) | Issues blocking this issue. (see [Connections](#connections)) | +| <a id="epicissueclosedat"></a>`closedAt` | [`Time`](#time) | Timestamp of when the issue was closed. | +| <a id="epicissueconfidential"></a>`confidential` | [`Boolean!`](#boolean) | Indicates the issue is confidential. | +| <a id="epicissuecreatenoteemail"></a>`createNoteEmail` | [`String`](#string) | User specific email address for the issue. | +| <a id="epicissuecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the issue was created. | +| <a id="epicissuedescription"></a>`description` | [`String`](#string) | Description of the issue. | +| <a id="epicissuedescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="epicissuedesigncollection"></a>`designCollection` | [`DesignCollection`](#designcollection) | Collection of design images associated with this issue. | +| <a id="epicissuediscussionlocked"></a>`discussionLocked` | [`Boolean!`](#boolean) | Indicates discussion is locked on the issue. | +| <a id="epicissuediscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="epicissuedownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes the issue has received. | +| <a id="epicissueduedate"></a>`dueDate` | [`Time`](#time) | Due date of the issue. | +| <a id="epicissueemailsdisabled"></a>`emailsDisabled` | [`Boolean!`](#boolean) | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. | +| <a id="epicissueepic"></a>`epic` | [`Epic`](#epic) | Epic to which this issue belongs. | +| <a id="epicissueepicissueid"></a>`epicIssueId` | [`ID!`](#id) | ID of the epic-issue relation. | +| <a id="epicissuehealthstatus"></a>`healthStatus` | [`HealthStatus`](#healthstatus) | Current health status. | +| <a id="epicissuehumantimeestimate"></a>`humanTimeEstimate` | [`String`](#string) | Human-readable time estimate of the issue. | +| <a id="epicissuehumantotaltimespent"></a>`humanTotalTimeSpent` | [`String`](#string) | Human-readable total time reported as spent on the issue. | +| <a id="epicissueid"></a>`id` | [`ID`](#id) | Global ID of the epic-issue relation. | +| <a id="epicissueiid"></a>`iid` | [`ID!`](#id) | Internal ID of the issue. | +| <a id="epicissueiteration"></a>`iteration` | [`Iteration`](#iteration) | Iteration of the issue. | +| <a id="epicissuelabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the issue. (see [Connections](#connections)) | +| <a id="epicissuemetricimages"></a>`metricImages` | [`[MetricImage!]`](#metricimage) | Metric images associated to the issue. | +| <a id="epicissuemilestone"></a>`milestone` | [`Milestone`](#milestone) | Milestone of the issue. | +| <a id="epicissuemoved"></a>`moved` | [`Boolean`](#boolean) | Indicates if issue got moved from other project. | +| <a id="epicissuemovedto"></a>`movedTo` | [`Issue`](#issue) | Updated Issue after it got moved to another project. | +| <a id="epicissuenotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="epicissueparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | List of participants in the issue. (see [Connections](#connections)) | +| <a id="epicissuerelationpath"></a>`relationPath` | [`String`](#string) | URI path of the epic-issue relation. | +| <a id="epicissuerelativeposition"></a>`relativePosition` | [`Int`](#int) | Relative position of the issue (used for positioning in epic tree and issue boards). | +| <a id="epicissueseverity"></a>`severity` | [`IssuableSeverity`](#issuableseverity) | Severity level of the incident. | +| <a id="epicissuesladueat"></a>`slaDueAt` | [`Time`](#time) | Timestamp of when the issue SLA expires. | +| <a id="epicissuestate"></a>`state` | [`IssueState!`](#issuestate) | State of the issue. | +| <a id="epicissuestatuspagepublishedincident"></a>`statusPagePublishedIncident` | [`Boolean`](#boolean) | Indicates whether an issue is published to the status page. | +| <a id="epicissuesubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the issue. | +| <a id="epicissuetaskcompletionstatus"></a>`taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Task completion status of the issue. | +| <a id="epicissuetimeestimate"></a>`timeEstimate` | [`Int!`](#int) | Time estimate of the issue. | +| <a id="epicissuetimelogs"></a>`timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the issue. (see [Connections](#connections)) | +| <a id="epicissuetitle"></a>`title` | [`String!`](#string) | Title of the issue. | +| <a id="epicissuetitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | +| <a id="epicissuetotaltimespent"></a>`totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the issue. | +| <a id="epicissuetype"></a>`type` | [`IssueType`](#issuetype) | Type of the issue. | +| <a id="epicissueupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the issue was last updated. | +| <a id="epicissueupdatedby"></a>`updatedBy` | [`UserCore`](#usercore) | User that last updated the issue. | +| <a id="epicissueupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes the issue has received. | +| <a id="epicissueuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the issue. | +| <a id="epicissueusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes of the issue. | +| <a id="epicissueuserpermissions"></a>`userPermissions` | [`IssuePermissions!`](#issuepermissions) | Permissions for the current user on the resource. | +| <a id="epicissuewebpath"></a>`webPath` | [`String!`](#string) | Web path of the issue. | +| <a id="epicissueweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the issue. | +| <a id="epicissueweight"></a>`weight` | [`Int`](#int) | Weight of the issue. | + +#### Fields with arguments + +##### `EpicIssue.currentUserTodos` + +To-do items for the current user. + +Returns [`TodoConnection!`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -Counts of descendent epics. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicissuecurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `closedEpics` | [`Int`](#int) | Number of closed child epics. | -| `closedIssues` | [`Int`](#int) | Number of closed epic issues. | -| `openedEpics` | [`Int`](#int) | Number of opened child epics. | -| `openedIssues` | [`Int`](#int) | Number of opened epic issues. | +##### `EpicIssue.reference` -### `EpicDescendantWeights` +Internal reference of the issue. Returned in shortened format by default. -Total weight of open and closed descendant issues. +Returns [`String!`](#string). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `closedIssues` | [`Int`](#int) | Total weight of completed (closed) issues in this epic, including epic descendants. | -| `openedIssues` | [`Int`](#int) | Total weight of opened issues in this epic, including epic descendants. | +###### Arguments -### `EpicEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicissuereferencefull"></a>`full` | [`Boolean`](#boolean) | Boolean option specifying whether the reference should be returned in full. | -An edge in a connection. +### `EpicList` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Epic`](#epic) | The item at the end of the edge. | +Represents an epic board list. -### `EpicHealthStatus` +#### Fields -Health status of child issues. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epiclistcollapsed"></a>`collapsed` | [`Boolean`](#boolean) | Indicates if this list is collapsed for this user. | +| <a id="epiclistepicscount"></a>`epicsCount` | [`Int`](#int) | Count of epics in the list. | +| <a id="epiclistid"></a>`id` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the board list. | +| <a id="epiclistlabel"></a>`label` | [`Label`](#label) | Label of the list. | +| <a id="epiclistlisttype"></a>`listType` | [`String!`](#string) | Type of the list. | +| <a id="epiclistposition"></a>`position` | [`Int`](#int) | Position of the list within the board. | +| <a id="epiclisttitle"></a>`title` | [`String!`](#string) | Title of the list. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `issuesAtRisk` | [`Int`](#int) | Number of issues at risk. | -| `issuesNeedingAttention` | [`Int`](#int) | Number of issues that need attention. | -| `issuesOnTrack` | [`Int`](#int) | Number of issues on track. | +#### Fields with arguments -### `EpicIssue` +##### `EpicList.epics` -Relationship between an epic and an issue. +List epics. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `alertManagementAlert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert associated to this issue. | -| `assignees` | [`UserConnection`](#userconnection) | Assignees of the issue. | -| `author` | [`User!`](#user) | User that created the issue. | -| `blocked` | [`Boolean!`](#boolean) | Indicates the issue is blocked. | -| `blockedByCount` | [`Int`](#int) | Count of issues blocking this issue. | -| `blockedByIssues` | [`IssueConnection`](#issueconnection) | Issues blocking this issue. | -| `closedAt` | [`Time`](#time) | Timestamp of when the issue was closed. | -| `confidential` | [`Boolean!`](#boolean) | Indicates the issue is confidential. | -| `createNoteEmail` | [`String`](#string) | User specific email address for the issue. | -| `createdAt` | [`Time!`](#time) | Timestamp of when the issue was created. | -| `currentUserTodos` | [`TodoConnection!`](#todoconnection) | To-do items for the current user. | -| `description` | [`String`](#string) | Description of the issue. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `designCollection` | [`DesignCollection`](#designcollection) | Collection of design images associated with this issue. | -| `discussionLocked` | [`Boolean!`](#boolean) | Indicates discussion is locked on the issue. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `downvotes` | [`Int!`](#int) | Number of downvotes the issue has received. | -| `dueDate` | [`Time`](#time) | Due date of the issue. | -| `emailsDisabled` | [`Boolean!`](#boolean) | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. | -| `epic` | [`Epic`](#epic) | Epic to which this issue belongs. | -| `epicIssueId` | [`ID!`](#id) | ID of the epic-issue relation. | -| `healthStatus` | [`HealthStatus`](#healthstatus) | Current health status. | -| `humanTimeEstimate` | [`String`](#string) | Human-readable time estimate of the issue. | -| `humanTotalTimeSpent` | [`String`](#string) | Human-readable total time reported as spent on the issue. | -| `id` | [`ID`](#id) | Global ID of the epic-issue relation. | -| `iid` | [`ID!`](#id) | Internal ID of the issue. | -| `iteration` | [`Iteration`](#iteration) | Iteration of the issue. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels of the issue. | -| `metricImages` | [`[MetricImage!]`](#metricimage) | Metric images associated to the issue. | -| `milestone` | [`Milestone`](#milestone) | Milestone of the issue. | -| `moved` | [`Boolean`](#boolean) | Indicates if issue got moved from other project. | -| `movedTo` | [`Issue`](#issue) | Updated Issue after it got moved to another project. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `participants` | [`UserConnection`](#userconnection) | List of participants in the issue. | -| `reference` | [`String!`](#string) | Internal reference of the issue. Returned in shortened format by default. | -| `relationPath` | [`String`](#string) | URI path of the epic-issue relation. | -| `relativePosition` | [`Int`](#int) | Relative position of the issue (used for positioning in epic tree and issue boards). | -| `severity` | [`IssuableSeverity`](#issuableseverity) | Severity level of the incident. | -| `slaDueAt` | [`Time`](#time) | Timestamp of when the issue SLA expires. | -| `state` | [`IssueState!`](#issuestate) | State of the issue. | -| `statusPagePublishedIncident` | [`Boolean`](#boolean) | Indicates whether an issue is published to the status page. | -| `subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the issue. | -| `taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Task completion status of the issue. | -| `timeEstimate` | [`Int!`](#int) | Time estimate of the issue. | -| `timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the issue. | -| `title` | [`String!`](#string) | Title of the issue. | -| `titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | -| `totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the issue. | -| `type` | [`IssueType`](#issuetype) | Type of the issue. | -| `updatedAt` | [`Time!`](#time) | Timestamp of when the issue was last updated. | -| `updatedBy` | [`User`](#user) | User that last updated the issue. | -| `upvotes` | [`Int!`](#int) | Number of upvotes the issue has received. | -| `userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the issue. | -| `userNotesCount` | [`Int!`](#int) | Number of user notes of the issue. | -| `userPermissions` | [`IssuePermissions!`](#issuepermissions) | Permissions for the current user on the resource. | -| `webPath` | [`String!`](#string) | Web path of the issue. | -| `webUrl` | [`String!`](#string) | Web URL of the issue. | -| `weight` | [`Int`](#int) | Weight of the issue. | - -### `EpicIssueConnection` - -The connection type for EpicIssue. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[EpicIssueEdge]`](#epicissueedge) | A list of edges. | -| `nodes` | [`[EpicIssue]`](#epicissue) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| `weight` | [`Int!`](#int) | Total weight of issues collection. | - -### `EpicIssueEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`EpicIssue`](#epicissue) | The item at the end of the edge. | +Returns [`EpicConnection`](#epicconnection). -### `EpicList` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Represents an epic board list. +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epiclistepicsfilters"></a>`filters` | [`EpicFilters`](#epicfilters) | Filters applied when selecting epics in the board list. | + +### `EpicPermissions` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `collapsed` | [`Boolean`](#boolean) | Indicates if this list is collapsed for this user. | -| `epics` | [`EpicConnection`](#epicconnection) | List epics. | -| `epicsCount` | [`Int`](#int) | Count of epics in the list. | -| `id` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the board list. | -| `label` | [`Label`](#label) | Label of the list. | -| `listType` | [`String!`](#string) | Type of the list. | -| `position` | [`Int`](#int) | Position of the list within the board. | -| `title` | [`String!`](#string) | Title of the list. | +Check permissions for the current user on an epic. -### `EpicListConnection` +#### Fields -The connection type for EpicList. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicpermissionsadminepic"></a>`adminEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_epic` on this resource. | +| <a id="epicpermissionsawardemoji"></a>`awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. | +| <a id="epicpermissionscreateepic"></a>`createEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `create_epic` on this resource. | +| <a id="epicpermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | +| <a id="epicpermissionsdestroyepic"></a>`destroyEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_epic` on this resource. | +| <a id="epicpermissionsreadepic"></a>`readEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `read_epic` on this resource. | +| <a id="epicpermissionsreadepiciid"></a>`readEpicIid` | [`Boolean!`](#boolean) | Indicates the user can perform `read_epic_iid` on this resource. | +| <a id="epicpermissionsupdateepic"></a>`updateEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `update_epic` on this resource. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[EpicListEdge]`](#epiclistedge) | A list of edges. | -| `nodes` | [`[EpicList]`](#epiclist) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `Event` -### `EpicListEdge` +Representing an event. -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`EpicList`](#epiclist) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="eventaction"></a>`action` | [`EventAction!`](#eventaction) | Action of the event. | +| <a id="eventauthor"></a>`author` | [`UserCore!`](#usercore) | Author of this event. | +| <a id="eventcreatedat"></a>`createdAt` | [`Time!`](#time) | When this event was created. | +| <a id="eventid"></a>`id` | [`ID!`](#id) | ID of the event. | +| <a id="eventupdatedat"></a>`updatedAt` | [`Time!`](#time) | When this event was updated. | -### `EpicMoveListPayload` +### `ExternalIssue` -Autogenerated return type of EpicMoveList. +Represents an external issue. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### Fields -### `EpicPermissions` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="externalissuecreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the issue was created. | +| <a id="externalissueexternaltracker"></a>`externalTracker` | [`String`](#string) | Type of external tracker. | +| <a id="externalissuerelativereference"></a>`relativeReference` | [`String`](#string) | Relative reference of the issue in the external tracker. | +| <a id="externalissuestatus"></a>`status` | [`String`](#string) | Status of the issue in the external tracker. | +| <a id="externalissuetitle"></a>`title` | [`String`](#string) | Title of the issue in the external tracker. | +| <a id="externalissueupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp of when the issue was updated. | +| <a id="externalissueweburl"></a>`webUrl` | [`String`](#string) | URL to the issue in the external tracker. | -Check permissions for the current user on an epic. +### `GeoNode` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_epic` on this resource. | -| `awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. | -| `createEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `create_epic` on this resource. | -| `createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | -| `destroyEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_epic` on this resource. | -| `readEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `read_epic` on this resource. | -| `readEpicIid` | [`Boolean!`](#boolean) | Indicates the user can perform `read_epic_iid` on this resource. | -| `updateEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `update_epic` on this resource. | +#### Fields -### `EpicSetSubscriptionPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="geonodecontainerrepositoriesmaxcapacity"></a>`containerRepositoriesMaxCapacity` | [`Int`](#int) | The maximum concurrency of container repository sync for this secondary node. | +| <a id="geonodeenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether this Geo node is enabled. | +| <a id="geonodefilesmaxcapacity"></a>`filesMaxCapacity` | [`Int`](#int) | The maximum concurrency of LFS/attachment backfill for this secondary node. | +| <a id="geonodeid"></a>`id` | [`ID!`](#id) | ID of this GeoNode. | +| <a id="geonodeinternalurl"></a>`internalUrl` | [`String`](#string) | The URL defined on the primary node that secondary nodes should use to contact it. | +| <a id="geonodeminimumreverificationinterval"></a>`minimumReverificationInterval` | [`Int`](#int) | The interval (in days) in which the repository verification is valid. Once expired, it will be reverified. | +| <a id="geonodename"></a>`name` | [`String`](#string) | The unique identifier for this Geo node. | +| <a id="geonodeprimary"></a>`primary` | [`Boolean`](#boolean) | Indicates whether this Geo node is the primary. | +| <a id="geonodereposmaxcapacity"></a>`reposMaxCapacity` | [`Int`](#int) | The maximum concurrency of repository backfill for this secondary node. | +| <a id="geonodeselectivesyncnamespaces"></a>`selectiveSyncNamespaces` | [`NamespaceConnection`](#namespaceconnection) | The namespaces that should be synced, if `selective_sync_type` == `namespaces`. (see [Connections](#connections)) | +| <a id="geonodeselectivesyncshards"></a>`selectiveSyncShards` | [`[String!]`](#string) | The repository storages whose projects should be synced, if `selective_sync_type` == `shards`. | +| <a id="geonodeselectivesynctype"></a>`selectiveSyncType` | [`String`](#string) | Indicates if syncing is limited to only specific groups, or shards. | +| <a id="geonodesyncobjectstorage"></a>`syncObjectStorage` | [`Boolean`](#boolean) | Indicates if this secondary node will replicate blobs in Object Storage. | +| <a id="geonodeurl"></a>`url` | [`String`](#string) | The user-facing URL for this Geo node. | +| <a id="geonodeverificationmaxcapacity"></a>`verificationMaxCapacity` | [`Int`](#int) | The maximum concurrency of repository verification for this secondary node. | -Autogenerated return type of EpicSetSubscription. +#### Fields with arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epic` | [`Epic`](#epic) | The epic after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +##### `GeoNode.groupWikiRepositoryRegistries` -### `EpicTreeReorderPayload` +Find group wiki repository registries on this Geo node. -Autogenerated return type of EpicTreeReorder. +Returns [`GroupWikiRepositoryRegistryConnection`](#groupwikirepositoryregistryconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `Event` +###### Arguments -Representing an event. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="geonodegroupwikirepositoryregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `action` | [`EventAction!`](#eventaction) | Action of the event. | -| `author` | [`User!`](#user) | Author of this event. | -| `createdAt` | [`Time!`](#time) | When this event was created. | -| `id` | [`ID!`](#id) | ID of the event. | -| `updatedAt` | [`Time!`](#time) | When this event was updated. | +##### `GeoNode.lfsObjectRegistries` -### `EventConnection` +Find LFS object registries on this Geo node. -The connection type for Event. +Returns [`LfsObjectRegistryConnection`](#lfsobjectregistryconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[EventEdge]`](#eventedge) | A list of edges. | -| `nodes` | [`[Event]`](#event) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `EventEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="geonodelfsobjectregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Event`](#event) | The item at the end of the edge. | +##### `GeoNode.mergeRequestDiffRegistries` -### `ExportRequirementsPayload` +Find merge request diff registries on this Geo node. -Autogenerated return type of ExportRequirements. +Returns [`MergeRequestDiffRegistryConnection`](#mergerequestdiffregistryconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `ExternalIssue` +###### Arguments -Represents an external issue. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="geonodemergerequestdiffregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp of when the issue was created. | -| `externalTracker` | [`String`](#string) | Type of external tracker. | -| `relativeReference` | [`String`](#string) | Relative reference of the issue in the external tracker. | -| `status` | [`String`](#string) | Status of the issue in the external tracker. | -| `title` | [`String`](#string) | Title of the issue in the external tracker. | -| `updatedAt` | [`Time`](#time) | Timestamp of when the issue was updated. | -| `webUrl` | [`String`](#string) | URL to the issue in the external tracker. | +##### `GeoNode.packageFileRegistries` -### `GeoNode` +Package file registries of the GeoNode. + +Returns [`PackageFileRegistryConnection`](#packagefileregistryconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="geonodepackagefileregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. | + +##### `GeoNode.pipelineArtifactRegistries` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `containerRepositoriesMaxCapacity` | [`Int`](#int) | The maximum concurrency of container repository sync for this secondary node. | -| `enabled` | [`Boolean`](#boolean) | Indicates whether this Geo node is enabled. | -| `filesMaxCapacity` | [`Int`](#int) | The maximum concurrency of LFS/attachment backfill for this secondary node. | -| `groupWikiRepositoryRegistries` | [`GroupWikiRepositoryRegistryConnection`](#groupwikirepositoryregistryconnection) | Find group wiki repository registries on this Geo node. | -| `id` | [`ID!`](#id) | ID of this GeoNode. | -| `internalUrl` | [`String`](#string) | The URL defined on the primary node that secondary nodes should use to contact it. | -| `mergeRequestDiffRegistries` | [`MergeRequestDiffRegistryConnection`](#mergerequestdiffregistryconnection) | Find merge request diff registries on this Geo node. | -| `minimumReverificationInterval` | [`Int`](#int) | The interval (in days) in which the repository verification is valid. Once expired, it will be reverified. | -| `name` | [`String`](#string) | The unique identifier for this Geo node. | -| `packageFileRegistries` | [`PackageFileRegistryConnection`](#packagefileregistryconnection) | Package file registries of the GeoNode. | -| `pipelineArtifactRegistries` | [`PipelineArtifactRegistryConnection`](#pipelineartifactregistryconnection) | Find pipeline artifact registries on this Geo node. | -| `primary` | [`Boolean`](#boolean) | Indicates whether this Geo node is the primary. | -| `reposMaxCapacity` | [`Int`](#int) | The maximum concurrency of repository backfill for this secondary node. | -| `selectiveSyncNamespaces` | [`NamespaceConnection`](#namespaceconnection) | The namespaces that should be synced, if `selective_sync_type` == `namespaces`. | -| `selectiveSyncShards` | [`[String!]`](#string) | The repository storages whose projects should be synced, if `selective_sync_type` == `shards`. | -| `selectiveSyncType` | [`String`](#string) | Indicates if syncing is limited to only specific groups, or shards. | -| `snippetRepositoryRegistries` | [`SnippetRepositoryRegistryConnection`](#snippetrepositoryregistryconnection) | Find snippet repository registries on this Geo node. | -| `syncObjectStorage` | [`Boolean`](#boolean) | Indicates if this secondary node will replicate blobs in Object Storage. | -| `terraformStateVersionRegistries` | [`TerraformStateVersionRegistryConnection`](#terraformstateversionregistryconnection) | Find terraform state version registries on this Geo node. | -| `url` | [`String`](#string) | The user-facing URL for this Geo node. | -| `verificationMaxCapacity` | [`Int`](#int) | The maximum concurrency of repository verification for this secondary node. | - -### `GitlabSubscriptionActivatePayload` - -Autogenerated return type of GitlabSubscriptionActivate. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `license` | [`CurrentLicense`](#currentlicense) | The current license. | +Find pipeline artifact registries on this Geo node. + +Returns [`PipelineArtifactRegistryConnection`](#pipelineartifactregistryconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="geonodepipelineartifactregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. | + +##### `GeoNode.snippetRepositoryRegistries` + +Find snippet repository registries on this Geo node. + +Returns [`SnippetRepositoryRegistryConnection`](#snippetrepositoryregistryconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="geonodesnippetrepositoryregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. | + +##### `GeoNode.terraformStateVersionRegistries` + +Find terraform state version registries on this Geo node. + +Returns [`TerraformStateVersionRegistryConnection`](#terraformstateversionregistryconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="geonodeterraformstateversionregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. | ### `GrafanaIntegration` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Timestamp of the issue's creation. | -| `enabled` | [`Boolean!`](#boolean) | Indicates whether Grafana integration is enabled. | -| `grafanaUrl` | [`String!`](#string) | URL for the Grafana host for the Grafana integration. | -| `id` | [`ID!`](#id) | Internal ID of the Grafana integration. | -| `updatedAt` | [`Time!`](#time) | Timestamp of the issue's last activity. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="grafanaintegrationcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the issue's creation. | +| <a id="grafanaintegrationenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether Grafana integration is enabled. | +| <a id="grafanaintegrationgrafanaurl"></a>`grafanaUrl` | [`String!`](#string) | URL for the Grafana host for the Grafana integration. | +| <a id="grafanaintegrationid"></a>`id` | [`ID!`](#id) | Internal ID of the Grafana integration. | +| <a id="grafanaintegrationupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of the issue's last activity. | ### `Group` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `actualRepositorySizeLimit` | [`Float`](#float) | Size limit for repositories in the namespace in bytes. | -| `additionalPurchasedStorageSize` | [`Float`](#float) | Additional storage purchased for the root namespace in bytes. | -| `autoDevopsEnabled` | [`Boolean`](#boolean) | Indicates whether Auto DevOps is enabled for all projects within this group. | -| `avatarUrl` | [`String`](#string) | Avatar URL of the group. | -| `billableMembersCount` | [`Int`](#int) | The number of billable users in the group. | -| `board` | [`Board`](#board) | A single board of the group. | -| `boards` | [`BoardConnection`](#boardconnection) | Boards of the group. | -| `codeCoverageActivities` | [`CodeCoverageActivityConnection`](#codecoverageactivityconnection) | Represents the code coverage activity for this group. | -| `complianceFrameworks` | [`ComplianceFrameworkConnection`](#complianceframeworkconnection) | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. | -| `containerRepositories` | [`ContainerRepositoryConnection`](#containerrepositoryconnection) | Container repositories of the group. | -| `containerRepositoriesCount` | [`Int!`](#int) | Number of container repositories in the group. | -| `containsLockedProjects` | [`Boolean!`](#boolean) | Includes at least one project where the repository size exceeds the limit. | -| `customEmoji` | [`CustomEmojiConnection`](#customemojiconnection) | Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled. | -| `description` | [`String`](#string) | Description of the namespace. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `emailsDisabled` | [`Boolean`](#boolean) | Indicates if a group has email notifications disabled. | -| `epic` | [`Epic`](#epic) | Find a single epic. | -| `epicBoard` | [`EpicBoard`](#epicboard) | Find a single epic board. | -| `epicBoards` | [`EpicBoardConnection`](#epicboardconnection) | Find epic boards. | -| `epics` | [`EpicConnection`](#epicconnection) | Find epics. | -| `epicsEnabled` | [`Boolean`](#boolean) | Indicates if Epics are enabled for namespace. | -| `fullName` | [`String!`](#string) | Full name of the namespace. | -| `fullPath` | [`ID!`](#id) | Full path of the namespace. | -| `groupMembers` | [`GroupMemberConnection`](#groupmemberconnection) | A membership of a user within this group. | -| `id` | [`ID!`](#id) | ID of the namespace. | -| `isTemporaryStorageIncreaseEnabled` | [`Boolean!`](#boolean) | Status of the temporary storage increase. | -| `issues` | [`IssueConnection`](#issueconnection) | Issues for projects in this group. | -| `iterationCadences` | [`IterationCadenceConnection`](#iterationcadenceconnection) | Find iteration cadences. | -| `iterations` | [`IterationConnection`](#iterationconnection) | Find iterations. | -| `label` | [`Label`](#label) | A label available on this group. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels available on this group. | -| `lfsEnabled` | [`Boolean`](#boolean) | Indicates if Large File Storage (LFS) is enabled for namespace. | -| `mentionsDisabled` | [`Boolean`](#boolean) | Indicates if a group is disabled from getting mentioned. | -| `mergeRequests` | [`MergeRequestConnection`](#mergerequestconnection) | Merge requests for projects in this group. | -| `milestones` | [`MilestoneConnection`](#milestoneconnection) | Milestones of the group. | -| `name` | [`String!`](#string) | Name of the namespace. | -| `packageSettings` | [`PackageSettings`](#packagesettings) | The package settings for the namespace. | -| `packages` | [`PackageConnection`](#packageconnection) | Packages of the group. | -| `parent` | [`Group`](#group) | Parent group. | -| `path` | [`String!`](#string) | Path of the namespace. | -| `projectCreationLevel` | [`String`](#string) | The permission level required to create projects in the group. | -| `projects` | [`ProjectConnection!`](#projectconnection) | Projects within this namespace. | -| `repositorySizeExcessProjectCount` | [`Int!`](#int) | Number of projects in the root namespace where the repository size exceeds the limit. | -| `requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request access to namespace. | -| `requireTwoFactorAuthentication` | [`Boolean`](#boolean) | Indicates if all users in this group are required to set up two-factor authentication. | -| `rootStorageStatistics` | [`RootStorageStatistics`](#rootstoragestatistics) | Aggregated storage statistics of the namespace. Only available for root namespaces. | -| `shareWithGroupLock` | [`Boolean`](#boolean) | Indicates if sharing a project with another group within this group is prevented. | -| `stats` | [`GroupStats`](#groupstats) | Group statistics. | -| `storageSizeLimit` | [`Float`](#float) | Total storage limit of the root namespace in bytes. | -| `subgroupCreationLevel` | [`String`](#string) | The permission level required to create subgroups within the group. | -| `temporaryStorageIncreaseEndsOn` | [`Time`](#time) | Date until the temporary storage increase is active. | -| `timelogs` | [`TimelogConnection!`](#timelogconnection) | Time logged on issues in the group and its subgroups. | -| `totalRepositorySize` | [`Float`](#float) | Total repository size of all projects in the root namespace in bytes. | -| `totalRepositorySizeExcess` | [`Float`](#float) | Total excess repository size of all projects in the root namespace in bytes. | -| `twoFactorGracePeriod` | [`Int`](#int) | Time before two-factor authentication is enforced. | -| `userPermissions` | [`GroupPermissions!`](#grouppermissions) | Permissions for the current user on the resource. | -| `visibility` | [`String`](#string) | Visibility of the namespace. | -| `vulnerabilities` | [`VulnerabilityConnection`](#vulnerabilityconnection) | Vulnerabilities reported on the projects in the group and its subgroups. | -| `vulnerabilitiesCountByDay` | [`VulnerabilitiesCountByDayConnection`](#vulnerabilitiescountbydayconnection) | Number of vulnerabilities per day for the projects in the group and its subgroups. | -| `vulnerabilitiesCountByDayAndSeverity` **{warning-solid}** | [`VulnerabilitiesCountByDayAndSeverityConnection`](#vulnerabilitiescountbydayandseverityconnection) | **Deprecated** in 13.3. Use `vulnerabilitiesCountByDay`. | -| `vulnerabilityGrades` | [`[VulnerableProjectsByGrade!]!`](#vulnerableprojectsbygrade) | Represents vulnerable project counts for each grade. | -| `vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. | -| `vulnerabilitySeveritiesCount` | [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount) | Counts for each vulnerability severity in the group and its subgroups. | -| `webUrl` | [`String!`](#string) | Web URL of the group. | +#### Fields -### `GroupMember` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupactualrepositorysizelimit"></a>`actualRepositorySizeLimit` | [`Float`](#float) | Size limit for repositories in the namespace in bytes. | +| <a id="groupadditionalpurchasedstoragesize"></a>`additionalPurchasedStorageSize` | [`Float`](#float) | Additional storage purchased for the root namespace in bytes. | +| <a id="groupautodevopsenabled"></a>`autoDevopsEnabled` | [`Boolean`](#boolean) | Indicates whether Auto DevOps is enabled for all projects within this group. | +| <a id="groupavatarurl"></a>`avatarUrl` | [`String`](#string) | Avatar URL of the group. | +| <a id="groupbillablememberscount"></a>`billableMembersCount` | [`Int`](#int) | The number of billable users in the group. | +| <a id="groupcontainerrepositoriescount"></a>`containerRepositoriesCount` | [`Int!`](#int) | Number of container repositories in the group. | +| <a id="groupcontainslockedprojects"></a>`containsLockedProjects` | [`Boolean!`](#boolean) | Includes at least one project where the repository size exceeds the limit. | +| <a id="groupcustomemoji"></a>`customEmoji` | [`CustomEmojiConnection`](#customemojiconnection) | Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled. (see [Connections](#connections)) | +| <a id="groupdescription"></a>`description` | [`String`](#string) | Description of the namespace. | +| <a id="groupdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="groupemailsdisabled"></a>`emailsDisabled` | [`Boolean`](#boolean) | Indicates if a group has email notifications disabled. | +| <a id="groupepicboards"></a>`epicBoards` | [`EpicBoardConnection`](#epicboardconnection) | Find epic boards. (see [Connections](#connections)) | +| <a id="groupepicsenabled"></a>`epicsEnabled` | [`Boolean`](#boolean) | Indicates if Epics are enabled for namespace. | +| <a id="groupfullname"></a>`fullName` | [`String!`](#string) | Full name of the namespace. | +| <a id="groupfullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the namespace. | +| <a id="groupid"></a>`id` | [`ID!`](#id) | ID of the namespace. | +| <a id="groupistemporarystorageincreaseenabled"></a>`isTemporaryStorageIncreaseEnabled` | [`Boolean!`](#boolean) | Status of the temporary storage increase. | +| <a id="grouplfsenabled"></a>`lfsEnabled` | [`Boolean`](#boolean) | Indicates if Large File Storage (LFS) is enabled for namespace. | +| <a id="groupmentionsdisabled"></a>`mentionsDisabled` | [`Boolean`](#boolean) | Indicates if a group is disabled from getting mentioned. | +| <a id="groupname"></a>`name` | [`String!`](#string) | Name of the namespace. | +| <a id="grouppackagesettings"></a>`packageSettings` | [`PackageSettings`](#packagesettings) | The package settings for the namespace. | +| <a id="groupparent"></a>`parent` | [`Group`](#group) | Parent group. | +| <a id="grouppath"></a>`path` | [`String!`](#string) | Path of the namespace. | +| <a id="groupprojectcreationlevel"></a>`projectCreationLevel` | [`String`](#string) | The permission level required to create projects in the group. | +| <a id="grouprepositorysizeexcessprojectcount"></a>`repositorySizeExcessProjectCount` | [`Int!`](#int) | Number of projects in the root namespace where the repository size exceeds the limit. | +| <a id="grouprequestaccessenabled"></a>`requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request access to namespace. | +| <a id="grouprequiretwofactorauthentication"></a>`requireTwoFactorAuthentication` | [`Boolean`](#boolean) | Indicates if all users in this group are required to set up two-factor authentication. | +| <a id="grouprootstoragestatistics"></a>`rootStorageStatistics` | [`RootStorageStatistics`](#rootstoragestatistics) | Aggregated storage statistics of the namespace. Only available for root namespaces. | +| <a id="groupsharewithgrouplock"></a>`shareWithGroupLock` | [`Boolean`](#boolean) | Indicates if sharing a project with another group within this group is prevented. | +| <a id="groupstats"></a>`stats` | [`GroupStats`](#groupstats) | Group statistics. | +| <a id="groupstoragesizelimit"></a>`storageSizeLimit` | [`Float`](#float) | Total storage limit of the root namespace in bytes. | +| <a id="groupsubgroupcreationlevel"></a>`subgroupCreationLevel` | [`String`](#string) | The permission level required to create subgroups within the group. | +| <a id="grouptemporarystorageincreaseendson"></a>`temporaryStorageIncreaseEndsOn` | [`Time`](#time) | Date until the temporary storage increase is active. | +| <a id="grouptotalrepositorysize"></a>`totalRepositorySize` | [`Float`](#float) | Total repository size of all projects in the root namespace in bytes. | +| <a id="grouptotalrepositorysizeexcess"></a>`totalRepositorySizeExcess` | [`Float`](#float) | Total excess repository size of all projects in the root namespace in bytes. | +| <a id="grouptwofactorgraceperiod"></a>`twoFactorGracePeriod` | [`Int`](#int) | Time before two-factor authentication is enforced. | +| <a id="groupuserpermissions"></a>`userPermissions` | [`GroupPermissions!`](#grouppermissions) | Permissions for the current user on the resource. | +| <a id="groupvisibility"></a>`visibility` | [`String`](#string) | Visibility of the namespace. | +| <a id="groupvulnerabilityscanners"></a>`vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. (see [Connections](#connections)) | +| <a id="groupweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the group. | + +#### Fields with arguments + +##### `Group.board` + +A single board of the group. + +Returns [`Board`](#board). + +###### Arguments -Represents a Group Membership. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupboardid"></a>`id` | [`BoardID!`](#boardid) | The board's ID. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. | -| `createdAt` | [`Time`](#time) | Date and time the membership was created. | -| `createdBy` | [`User`](#user) | User that authorized membership. | -| `expiresAt` | [`Time`](#time) | Date and time the membership expires. | -| `group` | [`Group`](#group) | Group that a User is a member of. | -| `id` | [`ID!`](#id) | ID of the member. | -| `updatedAt` | [`Time`](#time) | Date and time the membership was last updated. | -| `user` | [`User!`](#user) | User that is associated with the member object. | -| `userPermissions` | [`GroupPermissions!`](#grouppermissions) | Permissions for the current user on the resource. | +##### `Group.boards` -### `GroupMemberConnection` +Boards of the group. -The connection type for GroupMember. +Returns [`BoardConnection`](#boardconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[GroupMemberEdge]`](#groupmemberedge) | A list of edges. | -| `nodes` | [`[GroupMember]`](#groupmember) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `GroupMemberEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupboardsid"></a>`id` | [`BoardID`](#boardid) | Find a board by its ID. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`GroupMember`](#groupmember) | The item at the end of the edge. | +##### `Group.codeCoverageActivities` -### `GroupPermissions` +Represents the code coverage activity for this group. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `readGroup` | [`Boolean!`](#boolean) | Indicates the user can perform `read_group` on this resource. | +Returns [`CodeCoverageActivityConnection`](#codecoverageactivityconnection). -### `GroupReleaseStats` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Contains release-related statistics about a group. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `releasesCount` | [`Int`](#int) | Total number of releases in all descendant projects of the group. Will always return `null` if `group_level_release_statistics` feature flag is disabled. | -| `releasesPercentage` | [`Int`](#int) | Percentage of the group's descendant projects that have at least one release. Will always return `null` if `group_level_release_statistics` feature flag is disabled. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupcodecoverageactivitiesstartdate"></a>`startDate` | [`Date!`](#date) | First day for which to fetch code coverage activity (maximum time window is set to 90 days). | -### `GroupStats` +##### `Group.complianceFrameworks` -Contains statistics about a group. +Compliance frameworks available to projects in this namespace. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `releaseStats` | [`GroupReleaseStats`](#groupreleasestats) | Statistics related to releases within the group. | +Returns [`ComplianceFrameworkConnection`](#complianceframeworkconnection). -### `GroupWikiRepositoryRegistry` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Represents the Geo sync and verification state of a group wiki repository. +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupcomplianceframeworksid"></a>`id` | [`ComplianceManagementFrameworkID`](#compliancemanagementframeworkid) | Global ID of a specific compliance framework to return. | + +##### `Group.containerRepositories` + +Container repositories of the group. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp when the GroupWikiRepositoryRegistry was created. | -| `groupWikiRepositoryId` | [`ID!`](#id) | ID of the Group Wiki Repository. | -| `id` | [`ID!`](#id) | ID of the GroupWikiRepositoryRegistry. | -| `lastSyncFailure` | [`String`](#string) | Error message during sync of the GroupWikiRepositoryRegistry. | -| `lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the GroupWikiRepositoryRegistry. | -| `retryAt` | [`Time`](#time) | Timestamp after which the GroupWikiRepositoryRegistry should be resynced. | -| `retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the GroupWikiRepositoryRegistry. | -| `state` | [`RegistryState`](#registrystate) | Sync state of the GroupWikiRepositoryRegistry. | +Returns [`ContainerRepositoryConnection`](#containerrepositoryconnection). -### `GroupWikiRepositoryRegistryConnection` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -The connection type for GroupWikiRepositoryRegistry. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[GroupWikiRepositoryRegistryEdge]`](#groupwikirepositoryregistryedge) | A list of edges. | -| `nodes` | [`[GroupWikiRepositoryRegistry]`](#groupwikirepositoryregistry) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupcontainerrepositoriesname"></a>`name` | [`String`](#string) | Filter the container repositories by their name. | +| <a id="groupcontainerrepositoriessort"></a>`sort` | [`ContainerRepositorySort`](#containerrepositorysort) | Sort container repositories by this criteria. | -### `GroupWikiRepositoryRegistryEdge` +##### `Group.epic` -An edge in a connection. +Find a single epic. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`GroupWikiRepositoryRegistry`](#groupwikirepositoryregistry) | The item at the end of the edge. | +Returns [`Epic`](#epic). -### `HttpIntegrationCreatePayload` +###### Arguments -Autogenerated return type of HttpIntegrationCreate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupepicauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. | +| <a id="groupepicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. | +| <a id="groupepicenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. | +| <a id="groupepiciid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". | +| <a id="groupepiciidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. | +| <a id="groupepiciids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., [1, 2]. | +| <a id="groupepicincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. | +| <a id="groupepiclabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. | +| <a id="groupepicmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. | +| <a id="groupepicmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. | +| <a id="groupepicsearch"></a>`search` | [`String`](#string) | Search query for epic title or description. | +| <a id="groupepicsort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. | +| <a id="groupepicstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. | +| <a id="groupepicstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. | +| <a id="groupepictimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. | + +##### `Group.epicBoard` + +Find a single epic board. + +Returns [`EpicBoard`](#epicboard). + +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The HTTP integration. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupepicboardid"></a>`id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Find an epic board by ID. | -### `HttpIntegrationDestroyPayload` +##### `Group.epics` -Autogenerated return type of HttpIntegrationDestroy. +Find epics. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The HTTP integration. | +Returns [`EpicConnection`](#epicconnection). -### `HttpIntegrationResetTokenPayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of HttpIntegrationResetToken. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The HTTP integration. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupepicsauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. | +| <a id="groupepicsconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. | +| <a id="groupepicsenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. | +| <a id="groupepicsiid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". | +| <a id="groupepicsiidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. | +| <a id="groupepicsiids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., [1, 2]. | +| <a id="groupepicsincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. | +| <a id="groupepicslabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. | +| <a id="groupepicsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. | +| <a id="groupepicsmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. | +| <a id="groupepicssearch"></a>`search` | [`String`](#string) | Search query for epic title or description. | +| <a id="groupepicssort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. | +| <a id="groupepicsstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. | +| <a id="groupepicsstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. | +| <a id="groupepicstimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. | + +##### `Group.groupMembers` + +A membership of a user within this group. + +Returns [`GroupMemberConnection`](#groupmemberconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -### `HttpIntegrationUpdatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupgroupmembersrelations"></a>`relations` | [`[GroupMemberRelation!]`](#groupmemberrelation) | Filter members by the given member relations. | +| <a id="groupgroupmemberssearch"></a>`search` | [`String`](#string) | Search query. | -Autogenerated return type of HttpIntegrationUpdate. +##### `Group.issues` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The HTTP integration. | +Issues for projects in this group. -### `IncidentManagementOncallRotation` +Returns [`IssueConnection`](#issueconnection). -Describes an incident management on-call rotation. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `activePeriod` | [`OncallRotationActivePeriodType`](#oncallrotationactiveperiodtype) | Active period for the on-call rotation. | -| `endsAt` | [`Time`](#time) | End date and time of the on-call rotation. | -| `id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | ID of the on-call rotation. | -| `length` | [`Int`](#int) | Length of the on-call schedule, in the units specified by lengthUnit. | -| `lengthUnit` | [`OncallRotationUnitEnum`](#oncallrotationunitenum) | Unit of the on-call rotation length. | -| `name` | [`String!`](#string) | Name of the on-call rotation. | -| `participants` | [`OncallParticipantTypeConnection`](#oncallparticipanttypeconnection) | Participants of the on-call rotation. | -| `shifts` | [`IncidentManagementOncallShiftConnection`](#incidentmanagementoncallshiftconnection) | Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. | -| `startsAt` | [`Time`](#time) | Start date of the on-call rotation. | +###### Arguments -### `IncidentManagementOncallRotationConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupissuesassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user assigned to the issues, "none" and "any" values are supported. | +| <a id="groupissuesassigneeusername"></a>`assigneeUsername` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use `assigneeUsernames`. | +| <a id="groupissuesassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | +| <a id="groupissuesauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. | +| <a id="groupissuesclosedafter"></a>`closedAfter` | [`Time`](#time) | Issues closed after this date. | +| <a id="groupissuesclosedbefore"></a>`closedBefore` | [`Time`](#time) | Issues closed before this date. | +| <a id="groupissuescreatedafter"></a>`createdAfter` | [`Time`](#time) | Issues created after this date. | +| <a id="groupissuescreatedbefore"></a>`createdBefore` | [`Time`](#time) | Issues created before this date. | +| <a id="groupissuesepicid"></a>`epicId` | [`String`](#string) | ID of an epic associated with the issues, "none" and "any" values are supported. | +| <a id="groupissuesiid"></a>`iid` | [`String`](#string) | IID of the issue. For example, "1". | +| <a id="groupissuesiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example, ["1", "2"]. | +| <a id="groupissuesincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include issues belonging to subgroups. | +| <a id="groupissuesiterationid"></a>`iterationId` | [`[ID]`](#id) | List of iteration Global IDs applied to the issue. | +| <a id="groupissuesiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by iteration ID wildcard. | +| <a id="groupissueslabelname"></a>`labelName` | [`[String]`](#string) | Labels applied to this issue. | +| <a id="groupissuesmilestonetitle"></a>`milestoneTitle` | [`[String]`](#string) | Milestone applied to this issue. | +| <a id="groupissuesnot"></a>`not` | [`NegatedIssueFilterInput`](#negatedissuefilterinput) | Negated arguments. | +| <a id="groupissuessearch"></a>`search` | [`String`](#string) | Search query for issue title or description. | +| <a id="groupissuessort"></a>`sort` | [`IssueSort`](#issuesort) | Sort issues by this criteria. | +| <a id="groupissuesstate"></a>`state` | [`IssuableState`](#issuablestate) | Current state of this issue. | +| <a id="groupissuestypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter issues by the given issue types. | +| <a id="groupissuesupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Issues updated after this date. | +| <a id="groupissuesupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Issues updated before this date. | +| <a id="groupissuesweight"></a>`weight` | [`String`](#string) | Weight applied to the issue, "none" and "any" values are supported. | + +##### `Group.iterationCadences` + +Find iteration cadences. + +Returns [`IterationCadenceConnection`](#iterationcadenceconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -The connection type for IncidentManagementOncallRotation. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupiterationcadencesactive"></a>`active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. | +| <a id="groupiterationcadencesautomatic"></a>`automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate future iterations. | +| <a id="groupiterationcadencesdurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. | +| <a id="groupiterationcadencesid"></a>`id` | [`IterationsCadenceID`](#iterationscadenceid) | Global ID of the iteration cadence to look up. | +| <a id="groupiterationcadencesincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Whether to include ancestor groups to search iterations cadences in. | +| <a id="groupiterationcadencestitle"></a>`title` | [`String`](#string) | Fuzzy search by title. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[IncidentManagementOncallRotationEdge]`](#incidentmanagementoncallrotationedge) | A list of edges. | -| `nodes` | [`[IncidentManagementOncallRotation]`](#incidentmanagementoncallrotation) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### `Group.iterations` -### `IncidentManagementOncallRotationEdge` +Find iterations. -An edge in a connection. +Returns [`IterationConnection`](#iterationconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The item at the end of the edge. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `IncidentManagementOncallSchedule` +###### Arguments -Describes an incident management on-call schedule. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupiterationsenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. | +| <a id="groupiterationsid"></a>`id` | [`ID`](#id) | Global ID of the Iteration to look up. | +| <a id="groupiterationsiid"></a>`iid` | [`ID`](#id) | Internal ID of the Iteration to look up. | +| <a id="groupiterationsincludeancestors"></a>`includeAncestors` | [`Boolean`](#boolean) | Whether to include ancestor iterations. Defaults to true. | +| <a id="groupiterationsiterationcadenceids"></a>`iterationCadenceIds` | [`[IterationsCadenceID!]`](#iterationscadenceid) | Global iteration cadence IDs by which to look up the iterations. | +| <a id="groupiterationsstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. | +| <a id="groupiterationsstate"></a>`state` | [`IterationState`](#iterationstate) | Filter iterations by state. | +| <a id="groupiterationstimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. | +| <a id="groupiterationstitle"></a>`title` | [`String`](#string) | Fuzzy search by title. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the on-call schedule. | -| `iid` | [`ID!`](#id) | Internal ID of the on-call schedule. | -| `name` | [`String!`](#string) | Name of the on-call schedule. | -| `rotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | On-call rotation for the on-call schedule. | -| `rotations` | [`IncidentManagementOncallRotationConnection!`](#incidentmanagementoncallrotationconnection) | On-call rotations for the on-call schedule. | -| `timezone` | [`String!`](#string) | Time zone of the on-call schedule. | +##### `Group.label` -### `IncidentManagementOncallScheduleConnection` +A label available on this group. -The connection type for IncidentManagementOncallSchedule. +Returns [`Label`](#label). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[IncidentManagementOncallScheduleEdge]`](#incidentmanagementoncallscheduleedge) | A list of edges. | -| `nodes` | [`[IncidentManagementOncallSchedule]`](#incidentmanagementoncallschedule) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +###### Arguments -### `IncidentManagementOncallScheduleEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="grouplabeltitle"></a>`title` | [`String!`](#string) | Title of the label. | -An edge in a connection. +##### `Group.labels` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The item at the end of the edge. | +Labels available on this group. -### `IncidentManagementOncallShift` +Returns [`LabelConnection`](#labelconnection). -A block of time for which a participant is on-call. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `endsAt` | [`Time`](#time) | End time of the on-call shift. | -| `participant` | [`OncallParticipantType`](#oncallparticipanttype) | Participant assigned to the on-call shift. | -| `startsAt` | [`Time`](#time) | Start time of the on-call shift. | +###### Arguments -### `IncidentManagementOncallShiftConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="grouplabelsincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include labels from ancestor groups. | +| <a id="grouplabelsincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include labels from descendant groups. | +| <a id="grouplabelsonlygrouplabels"></a>`onlyGroupLabels` | [`Boolean`](#boolean) | Include only group level labels. | +| <a id="grouplabelssearchterm"></a>`searchTerm` | [`String`](#string) | A search term to find labels with. | -The connection type for IncidentManagementOncallShift. +##### `Group.mergeRequests` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[IncidentManagementOncallShiftEdge]`](#incidentmanagementoncallshiftedge) | A list of edges. | -| `nodes` | [`[IncidentManagementOncallShift]`](#incidentmanagementoncallshift) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Merge requests for projects in this group. -### `IncidentManagementOncallShiftEdge` +Returns [`MergeRequestConnection`](#mergerequestconnection). -An edge in a connection. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`IncidentManagementOncallShift`](#incidentmanagementoncallshift) | The item at the end of the edge. | +###### Arguments -### `InstanceSecurityDashboard` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="groupmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="groupmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="groupmergerequestsincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include merge requests belonging to subgroups. | +| <a id="groupmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="groupmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="groupmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="groupmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="groupmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="groupmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="groupmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="groupmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="groupmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `projects` | [`ProjectConnection!`](#projectconnection) | Projects selected in Instance Security Dashboard. | -| `vulnerabilityGrades` | [`[VulnerableProjectsByGrade!]!`](#vulnerableprojectsbygrade) | Represents vulnerable project counts for each grade. | -| `vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. | -| `vulnerabilitySeveritiesCount` | [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount) | Counts for each vulnerability severity from projects selected in Instance Security Dashboard. | +##### `Group.milestones` -### `Issue` +Milestones of the group. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `alertManagementAlert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert associated to this issue. | -| `assignees` | [`UserConnection`](#userconnection) | Assignees of the issue. | -| `author` | [`User!`](#user) | User that created the issue. | -| `blocked` | [`Boolean!`](#boolean) | Indicates the issue is blocked. | -| `blockedByCount` | [`Int`](#int) | Count of issues blocking this issue. | -| `blockedByIssues` | [`IssueConnection`](#issueconnection) | Issues blocking this issue. | -| `closedAt` | [`Time`](#time) | Timestamp of when the issue was closed. | -| `confidential` | [`Boolean!`](#boolean) | Indicates the issue is confidential. | -| `createNoteEmail` | [`String`](#string) | User specific email address for the issue. | -| `createdAt` | [`Time!`](#time) | Timestamp of when the issue was created. | -| `currentUserTodos` | [`TodoConnection!`](#todoconnection) | To-do items for the current user. | -| `description` | [`String`](#string) | Description of the issue. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `designCollection` | [`DesignCollection`](#designcollection) | Collection of design images associated with this issue. | -| `discussionLocked` | [`Boolean!`](#boolean) | Indicates discussion is locked on the issue. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `downvotes` | [`Int!`](#int) | Number of downvotes the issue has received. | -| `dueDate` | [`Time`](#time) | Due date of the issue. | -| `emailsDisabled` | [`Boolean!`](#boolean) | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. | -| `epic` | [`Epic`](#epic) | Epic to which this issue belongs. | -| `healthStatus` | [`HealthStatus`](#healthstatus) | Current health status. | -| `humanTimeEstimate` | [`String`](#string) | Human-readable time estimate of the issue. | -| `humanTotalTimeSpent` | [`String`](#string) | Human-readable total time reported as spent on the issue. | -| `id` | [`ID!`](#id) | ID of the issue. | -| `iid` | [`ID!`](#id) | Internal ID of the issue. | -| `iteration` | [`Iteration`](#iteration) | Iteration of the issue. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels of the issue. | -| `metricImages` | [`[MetricImage!]`](#metricimage) | Metric images associated to the issue. | -| `milestone` | [`Milestone`](#milestone) | Milestone of the issue. | -| `moved` | [`Boolean`](#boolean) | Indicates if issue got moved from other project. | -| `movedTo` | [`Issue`](#issue) | Updated Issue after it got moved to another project. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `participants` | [`UserConnection`](#userconnection) | List of participants in the issue. | -| `reference` | [`String!`](#string) | Internal reference of the issue. Returned in shortened format by default. | -| `relativePosition` | [`Int`](#int) | Relative position of the issue (used for positioning in epic tree and issue boards). | -| `severity` | [`IssuableSeverity`](#issuableseverity) | Severity level of the incident. | -| `slaDueAt` | [`Time`](#time) | Timestamp of when the issue SLA expires. | -| `state` | [`IssueState!`](#issuestate) | State of the issue. | -| `statusPagePublishedIncident` | [`Boolean`](#boolean) | Indicates whether an issue is published to the status page. | -| `subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the issue. | -| `taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Task completion status of the issue. | -| `timeEstimate` | [`Int!`](#int) | Time estimate of the issue. | -| `timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the issue. | -| `title` | [`String!`](#string) | Title of the issue. | -| `titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | -| `totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the issue. | -| `type` | [`IssueType`](#issuetype) | Type of the issue. | -| `updatedAt` | [`Time!`](#time) | Timestamp of when the issue was last updated. | -| `updatedBy` | [`User`](#user) | User that last updated the issue. | -| `upvotes` | [`Int!`](#int) | Number of upvotes the issue has received. | -| `userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the issue. | -| `userNotesCount` | [`Int!`](#int) | Number of user notes of the issue. | -| `userPermissions` | [`IssuePermissions!`](#issuepermissions) | Permissions for the current user on the resource. | -| `webPath` | [`String!`](#string) | Web path of the issue. | -| `webUrl` | [`String!`](#string) | Web URL of the issue. | -| `weight` | [`Int`](#int) | Weight of the issue. | - -### `IssueConnection` - -The connection type for Issue. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[IssueEdge]`](#issueedge) | A list of edges. | -| `nodes` | [`[Issue]`](#issue) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| `weight` | [`Int!`](#int) | Total weight of issues collection. | - -### `IssueEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Issue`](#issue) | The item at the end of the edge. | - -### `IssueMoveListPayload` - -Autogenerated return type of IssueMoveList. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | - -### `IssueMovePayload` - -Autogenerated return type of IssueMove. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +Returns [`MilestoneConnection`](#milestoneconnection). -### `IssuePermissions` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Check permissions for the current user on a issue. +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupmilestonescontainingdate"></a>`containingDate` | [`Time`](#time) | A date that the milestone contains. | +| <a id="groupmilestonesenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. | +| <a id="groupmilestonesids"></a>`ids` | [`[ID!]`](#id) | Array of global milestone IDs, e.g., `"gid://gitlab/Milestone/1"`. | +| <a id="groupmilestonesincludeancestors"></a>`includeAncestors` | [`Boolean`](#boolean) | Include milestones from all parent groups. | +| <a id="groupmilestonesincludedescendants"></a>`includeDescendants` | [`Boolean`](#boolean) | Include milestones from all subgroups and subprojects. | +| <a id="groupmilestonessearchtitle"></a>`searchTitle` | [`String`](#string) | A search string for the title. | +| <a id="groupmilestonesstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. | +| <a id="groupmilestonesstate"></a>`state` | [`MilestoneStateEnum`](#milestonestateenum) | Filter milestones by state. | +| <a id="groupmilestonestimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. | +| <a id="groupmilestonestitle"></a>`title` | [`String`](#string) | The title of the milestone. | + +##### `Group.packages` + +Packages of the group. + +Returns [`PackageConnection`](#packageconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="grouppackagesincludeversionless"></a>`includeVersionless` | [`Boolean`](#boolean) | Include versionless packages. | +| <a id="grouppackagespackagename"></a>`packageName` | [`String`](#string) | Search a package by name. | +| <a id="grouppackagespackagetype"></a>`packageType` | [`PackageTypeEnum`](#packagetypeenum) | Filter a package by type. | +| <a id="grouppackagessort"></a>`sort` | [`PackageGroupSort`](#packagegroupsort) | Sort packages by this criteria. | +| <a id="grouppackagesstatus"></a>`status` | [`PackageStatus`](#packagestatus) | Filter a package by status. | + +##### `Group.projects` + +Projects within this namespace. + +Returns [`ProjectConnection!`](#projectconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupprojectshascodecoverage"></a>`hasCodeCoverage` | [`Boolean`](#boolean) | Returns only the projects which have code coverage. | +| <a id="groupprojectshasvulnerabilities"></a>`hasVulnerabilities` | [`Boolean`](#boolean) | Returns only the projects which have vulnerabilities. | +| <a id="groupprojectsids"></a>`ids` | [`[ID!]`](#id) | Filter projects by IDs. | +| <a id="groupprojectsincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include also subgroup projects. | +| <a id="groupprojectssearch"></a>`search` | [`String`](#string) | Search project with most similar names or paths. | +| <a id="groupprojectssort"></a>`sort` | [`NamespaceProjectSort`](#namespaceprojectsort) | Sort projects by this criteria. | + +##### `Group.timelogs` + +Time logged on issues and merge requests in the group and its subgroups. + +Returns [`TimelogConnection!`](#timelogconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="grouptimelogsenddate"></a>`endDate` | [`Time`](#time) | List time logs within a date range where the logged date is equal to or before endDate. | +| <a id="grouptimelogsendtime"></a>`endTime` | [`Time`](#time) | List time-logs within a time range where the logged time is equal to or before endTime. | +| <a id="grouptimelogsstartdate"></a>`startDate` | [`Time`](#time) | List time logs within a date range where the logged date is equal to or after startDate. | +| <a id="grouptimelogsstarttime"></a>`startTime` | [`Time`](#time) | List time-logs within a time range where the logged time is equal to or after startTime. | + +##### `Group.vulnerabilities` + +Vulnerabilities reported on the projects in the group and its subgroups. + +Returns [`VulnerabilityConnection`](#vulnerabilityconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupvulnerabilitieshasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have linked issues. | +| <a id="groupvulnerabilitieshasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have been resolved on default branch. | +| <a id="groupvulnerabilitiesprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. | +| <a id="groupvulnerabilitiesreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. | +| <a id="groupvulnerabilitiesscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by VulnerabilityScanner.externalId. | +| <a id="groupvulnerabilitiesscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. | +| <a id="groupvulnerabilitiesseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. | +| <a id="groupvulnerabilitiessort"></a>`sort` | [`VulnerabilitySort`](#vulnerabilitysort) | List vulnerabilities by sort order. | +| <a id="groupvulnerabilitiesstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. | + +##### `Group.vulnerabilitiesCountByDay` + +Number of vulnerabilities per day for the projects in the group and its subgroups. + +Returns [`VulnerabilitiesCountByDayConnection`](#vulnerabilitiescountbydayconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupvulnerabilitiescountbydayenddate"></a>`endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. | +| <a id="groupvulnerabilitiescountbydaystartdate"></a>`startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. | + +##### `Group.vulnerabilitiesCountByDayAndSeverity` + +Number of vulnerabilities per severity level, per day, for the projects in the group and its subgroups. + +WARNING: +**Deprecated** in 13.3. +Use `vulnerabilitiesCountByDay`. + +Returns [`VulnerabilitiesCountByDayAndSeverityConnection`](#vulnerabilitiescountbydayandseverityconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupvulnerabilitiescountbydayandseverityenddate"></a>`endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. | +| <a id="groupvulnerabilitiescountbydayandseveritystartdate"></a>`startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. | + +##### `Group.vulnerabilityGrades` + +Represents vulnerable project counts for each grade. + +Returns [`[VulnerableProjectsByGrade!]!`](#vulnerableprojectsbygrade). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupvulnerabilitygradesincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include grades belonging to subgroups. | + +##### `Group.vulnerabilitySeveritiesCount` + +Counts for each vulnerability severity in the group and its subgroups. + +Returns [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupvulnerabilityseveritiescountprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. | +| <a id="groupvulnerabilityseveritiescountreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. | +| <a id="groupvulnerabilityseveritiescountscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by scanner. | +| <a id="groupvulnerabilityseveritiescountseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. | +| <a id="groupvulnerabilityseveritiescountstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. | + +### `GroupMember` + +Represents a Group Membership. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupmemberaccesslevel"></a>`accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. | +| <a id="groupmembercreatedat"></a>`createdAt` | [`Time`](#time) | Date and time the membership was created. | +| <a id="groupmembercreatedby"></a>`createdBy` | [`UserCore`](#usercore) | User that authorized membership. | +| <a id="groupmemberexpiresat"></a>`expiresAt` | [`Time`](#time) | Date and time the membership expires. | +| <a id="groupmembergroup"></a>`group` | [`Group`](#group) | Group that a User is a member of. | +| <a id="groupmemberid"></a>`id` | [`ID!`](#id) | ID of the member. | +| <a id="groupmemberupdatedat"></a>`updatedAt` | [`Time`](#time) | Date and time the membership was last updated. | +| <a id="groupmemberuser"></a>`user` | [`UserCore!`](#usercore) | User that is associated with the member object. | +| <a id="groupmemberuserpermissions"></a>`userPermissions` | [`GroupPermissions!`](#grouppermissions) | Permissions for the current user on the resource. | + +### `GroupPermissions` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="grouppermissionsreadgroup"></a>`readGroup` | [`Boolean!`](#boolean) | Indicates the user can perform `read_group` on this resource. | + +### `GroupReleaseStats` + +Contains release-related statistics about a group. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupreleasestatsreleasescount"></a>`releasesCount` | [`Int`](#int) | Total number of releases in all descendant projects of the group. | +| <a id="groupreleasestatsreleasespercentage"></a>`releasesPercentage` | [`Int`](#int) | Percentage of the group's descendant projects that have at least one release. | + +### `GroupStats` + +Contains statistics about a group. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupstatsreleasestats"></a>`releaseStats` | [`GroupReleaseStats`](#groupreleasestats) | Statistics related to releases within the group. | + +### `GroupWikiRepositoryRegistry` + +Represents the Geo sync and verification state of a group wiki repository. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="groupwikirepositoryregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the GroupWikiRepositoryRegistry was created. | +| <a id="groupwikirepositoryregistrygroupwikirepositoryid"></a>`groupWikiRepositoryId` | [`ID!`](#id) | ID of the Group Wiki Repository. | +| <a id="groupwikirepositoryregistryid"></a>`id` | [`ID!`](#id) | ID of the GroupWikiRepositoryRegistry. | +| <a id="groupwikirepositoryregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the GroupWikiRepositoryRegistry. | +| <a id="groupwikirepositoryregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the GroupWikiRepositoryRegistry. | +| <a id="groupwikirepositoryregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the GroupWikiRepositoryRegistry should be resynced. | +| <a id="groupwikirepositoryregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the GroupWikiRepositoryRegistry. | +| <a id="groupwikirepositoryregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the GroupWikiRepositoryRegistry. | + +### `IncidentManagementOncallRotation` + +Describes an incident management on-call rotation. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallrotationactiveperiod"></a>`activePeriod` | [`OncallRotationActivePeriodType`](#oncallrotationactiveperiodtype) | Active period for the on-call rotation. | +| <a id="incidentmanagementoncallrotationendsat"></a>`endsAt` | [`Time`](#time) | End date and time of the on-call rotation. | +| <a id="incidentmanagementoncallrotationid"></a>`id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | ID of the on-call rotation. | +| <a id="incidentmanagementoncallrotationlength"></a>`length` | [`Int`](#int) | Length of the on-call schedule, in the units specified by lengthUnit. | +| <a id="incidentmanagementoncallrotationlengthunit"></a>`lengthUnit` | [`OncallRotationUnitEnum`](#oncallrotationunitenum) | Unit of the on-call rotation length. | +| <a id="incidentmanagementoncallrotationname"></a>`name` | [`String!`](#string) | Name of the on-call rotation. | +| <a id="incidentmanagementoncallrotationparticipants"></a>`participants` | [`OncallParticipantTypeConnection`](#oncallparticipanttypeconnection) | Participants of the on-call rotation. (see [Connections](#connections)) | +| <a id="incidentmanagementoncallrotationstartsat"></a>`startsAt` | [`Time`](#time) | Start date of the on-call rotation. | + +#### Fields with arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_issue` on this resource. | -| `createDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `create_design` on this resource. | -| `createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | -| `destroyDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_design` on this resource. | -| `readDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `read_design` on this resource. | -| `readIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `read_issue` on this resource. | -| `reopenIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `reopen_issue` on this resource. | -| `updateIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `update_issue` on this resource. | +##### `IncidentManagementOncallRotation.shifts` -### `IssueSetAssigneesPayload` +Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. -Autogenerated return type of IssueSetAssignees. +Returns [`IncidentManagementOncallShiftConnection`](#incidentmanagementoncallshiftconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `IssueSetConfidentialPayload` +###### Arguments -Autogenerated return type of IssueSetConfidential. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallrotationshiftsendtime"></a>`endTime` | [`Time!`](#time) | End of timeframe to include shifts for. Cannot exceed one month after start. | +| <a id="incidentmanagementoncallrotationshiftsstarttime"></a>`startTime` | [`Time!`](#time) | Start of timeframe to include shifts for. | + +### `IncidentManagementOncallSchedule` + +Describes an incident management on-call schedule. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallscheduledescription"></a>`description` | [`String`](#string) | Description of the on-call schedule. | +| <a id="incidentmanagementoncallscheduleiid"></a>`iid` | [`ID!`](#id) | Internal ID of the on-call schedule. | +| <a id="incidentmanagementoncallschedulename"></a>`name` | [`String!`](#string) | Name of the on-call schedule. | +| <a id="incidentmanagementoncallschedulerotations"></a>`rotations` | [`IncidentManagementOncallRotationConnection!`](#incidentmanagementoncallrotationconnection) | On-call rotations for the on-call schedule. (see [Connections](#connections)) | +| <a id="incidentmanagementoncallscheduletimezone"></a>`timezone` | [`String!`](#string) | Time zone of the on-call schedule. | + +#### Fields with arguments + +##### `IncidentManagementOncallSchedule.rotation` + +On-call rotation for the on-call schedule. + +Returns [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallschedulerotationid"></a>`id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | ID of the on-call rotation. | + +### `IncidentManagementOncallShift` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +A block of time for which a participant is on-call. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="incidentmanagementoncallshiftendsat"></a>`endsAt` | [`Time`](#time) | End time of the on-call shift. | +| <a id="incidentmanagementoncallshiftparticipant"></a>`participant` | [`OncallParticipantType`](#oncallparticipanttype) | Participant assigned to the on-call shift. | +| <a id="incidentmanagementoncallshiftstartsat"></a>`startsAt` | [`Time`](#time) | Start time of the on-call shift. | -### `IssueSetDueDatePayload` +### `InstanceSecurityDashboard` -Autogenerated return type of IssueSetDueDate. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="instancesecuritydashboardprojects"></a>`projects` | [`ProjectConnection!`](#projectconnection) | Projects selected in Instance Security Dashboard. (see [Connections](#connections)) | +| <a id="instancesecuritydashboardvulnerabilitygrades"></a>`vulnerabilityGrades` | [`[VulnerableProjectsByGrade!]!`](#vulnerableprojectsbygrade) | Represents vulnerable project counts for each grade. | +| <a id="instancesecuritydashboardvulnerabilityscanners"></a>`vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. (see [Connections](#connections)) | -### `IssueSetEpicPayload` +#### Fields with arguments -Autogenerated return type of IssueSetEpic. +##### `InstanceSecurityDashboard.vulnerabilitySeveritiesCount` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +Counts for each vulnerability severity from projects selected in Instance Security Dashboard. -### `IssueSetIterationPayload` +Returns [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount). -Autogenerated return type of IssueSetIteration. +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="instancesecuritydashboardvulnerabilityseveritiescountprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. | +| <a id="instancesecuritydashboardvulnerabilityseveritiescountreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. | +| <a id="instancesecuritydashboardvulnerabilityseveritiescountscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by scanner. | +| <a id="instancesecuritydashboardvulnerabilityseveritiescountseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. | +| <a id="instancesecuritydashboardvulnerabilityseveritiescountstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +### `Issue` -### `IssueSetLockedPayload` +#### Fields -Autogenerated return type of IssueSetLocked. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="issuealertmanagementalert"></a>`alertManagementAlert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert associated to this issue. | +| <a id="issueassignees"></a>`assignees` | [`UserCoreConnection`](#usercoreconnection) | Assignees of the issue. (see [Connections](#connections)) | +| <a id="issueauthor"></a>`author` | [`UserCore!`](#usercore) | User that created the issue. | +| <a id="issueblocked"></a>`blocked` | [`Boolean!`](#boolean) | Indicates the issue is blocked. | +| <a id="issueblockedbycount"></a>`blockedByCount` | [`Int`](#int) | Count of issues blocking this issue. | +| <a id="issueblockedbyissues"></a>`blockedByIssues` | [`IssueConnection`](#issueconnection) | Issues blocking this issue. (see [Connections](#connections)) | +| <a id="issueclosedat"></a>`closedAt` | [`Time`](#time) | Timestamp of when the issue was closed. | +| <a id="issueconfidential"></a>`confidential` | [`Boolean!`](#boolean) | Indicates the issue is confidential. | +| <a id="issuecreatenoteemail"></a>`createNoteEmail` | [`String`](#string) | User specific email address for the issue. | +| <a id="issuecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the issue was created. | +| <a id="issuedescription"></a>`description` | [`String`](#string) | Description of the issue. | +| <a id="issuedescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="issuedesigncollection"></a>`designCollection` | [`DesignCollection`](#designcollection) | Collection of design images associated with this issue. | +| <a id="issuediscussionlocked"></a>`discussionLocked` | [`Boolean!`](#boolean) | Indicates discussion is locked on the issue. | +| <a id="issuediscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="issuedownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes the issue has received. | +| <a id="issueduedate"></a>`dueDate` | [`Time`](#time) | Due date of the issue. | +| <a id="issueemailsdisabled"></a>`emailsDisabled` | [`Boolean!`](#boolean) | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. | +| <a id="issueepic"></a>`epic` | [`Epic`](#epic) | Epic to which this issue belongs. | +| <a id="issuehealthstatus"></a>`healthStatus` | [`HealthStatus`](#healthstatus) | Current health status. | +| <a id="issuehumantimeestimate"></a>`humanTimeEstimate` | [`String`](#string) | Human-readable time estimate of the issue. | +| <a id="issuehumantotaltimespent"></a>`humanTotalTimeSpent` | [`String`](#string) | Human-readable total time reported as spent on the issue. | +| <a id="issueid"></a>`id` | [`ID!`](#id) | ID of the issue. | +| <a id="issueiid"></a>`iid` | [`ID!`](#id) | Internal ID of the issue. | +| <a id="issueiteration"></a>`iteration` | [`Iteration`](#iteration) | Iteration of the issue. | +| <a id="issuelabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the issue. (see [Connections](#connections)) | +| <a id="issuemetricimages"></a>`metricImages` | [`[MetricImage!]`](#metricimage) | Metric images associated to the issue. | +| <a id="issuemilestone"></a>`milestone` | [`Milestone`](#milestone) | Milestone of the issue. | +| <a id="issuemoved"></a>`moved` | [`Boolean`](#boolean) | Indicates if issue got moved from other project. | +| <a id="issuemovedto"></a>`movedTo` | [`Issue`](#issue) | Updated Issue after it got moved to another project. | +| <a id="issuenotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="issueparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | List of participants in the issue. (see [Connections](#connections)) | +| <a id="issuerelativeposition"></a>`relativePosition` | [`Int`](#int) | Relative position of the issue (used for positioning in epic tree and issue boards). | +| <a id="issueseverity"></a>`severity` | [`IssuableSeverity`](#issuableseverity) | Severity level of the incident. | +| <a id="issuesladueat"></a>`slaDueAt` | [`Time`](#time) | Timestamp of when the issue SLA expires. | +| <a id="issuestate"></a>`state` | [`IssueState!`](#issuestate) | State of the issue. | +| <a id="issuestatuspagepublishedincident"></a>`statusPagePublishedIncident` | [`Boolean`](#boolean) | Indicates whether an issue is published to the status page. | +| <a id="issuesubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the issue. | +| <a id="issuetaskcompletionstatus"></a>`taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Task completion status of the issue. | +| <a id="issuetimeestimate"></a>`timeEstimate` | [`Int!`](#int) | Time estimate of the issue. | +| <a id="issuetimelogs"></a>`timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the issue. (see [Connections](#connections)) | +| <a id="issuetitle"></a>`title` | [`String!`](#string) | Title of the issue. | +| <a id="issuetitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | +| <a id="issuetotaltimespent"></a>`totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the issue. | +| <a id="issuetype"></a>`type` | [`IssueType`](#issuetype) | Type of the issue. | +| <a id="issueupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the issue was last updated. | +| <a id="issueupdatedby"></a>`updatedBy` | [`UserCore`](#usercore) | User that last updated the issue. | +| <a id="issueupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes the issue has received. | +| <a id="issueuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the issue. | +| <a id="issueusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes of the issue. | +| <a id="issueuserpermissions"></a>`userPermissions` | [`IssuePermissions!`](#issuepermissions) | Permissions for the current user on the resource. | +| <a id="issuewebpath"></a>`webPath` | [`String!`](#string) | Web path of the issue. | +| <a id="issueweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the issue. | +| <a id="issueweight"></a>`weight` | [`Int`](#int) | Weight of the issue. | + +#### Fields with arguments + +##### `Issue.currentUserTodos` + +To-do items for the current user. + +Returns [`TodoConnection!`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="issuecurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. | -### `IssueSetSeverityPayload` +##### `Issue.reference` -Autogenerated return type of IssueSetSeverity. +Internal reference of the issue. Returned in shortened format by default. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +Returns [`String!`](#string). -### `IssueSetSubscriptionPayload` +###### Arguments -Autogenerated return type of IssueSetSubscription. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="issuereferencefull"></a>`full` | [`Boolean`](#boolean) | Boolean option specifying whether the reference should be returned in full. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +### `IssuePermissions` -### `IssueSetWeightPayload` +Check permissions for the current user on a issue. -Autogenerated return type of IssueSetWeight. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="issuepermissionsadminissue"></a>`adminIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_issue` on this resource. | +| <a id="issuepermissionscreatedesign"></a>`createDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `create_design` on this resource. | +| <a id="issuepermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | +| <a id="issuepermissionsdestroydesign"></a>`destroyDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_design` on this resource. | +| <a id="issuepermissionsreaddesign"></a>`readDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `read_design` on this resource. | +| <a id="issuepermissionsreadissue"></a>`readIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `read_issue` on this resource. | +| <a id="issuepermissionsreopenissue"></a>`reopenIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `reopen_issue` on this resource. | +| <a id="issuepermissionsupdateissue"></a>`updateIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `update_issue` on this resource. | ### `IssueStatusCountsType` Represents total number of issues for the represented statuses. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `all` | [`Int`](#int) | Number of issues with status ALL for the project. | -| `closed` | [`Int`](#int) | Number of issues with status CLOSED for the project. | -| `opened` | [`Int`](#int) | Number of issues with status OPENED for the project. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="issuestatuscountstypeall"></a>`all` | [`Int`](#int) | Number of issues with status ALL for the project. | +| <a id="issuestatuscountstypeclosed"></a>`closed` | [`Int`](#int) | Number of issues with status CLOSED for the project. | +| <a id="issuestatuscountstypeopened"></a>`opened` | [`Int`](#int) | Number of issues with status OPENED for the project. | ### `Iteration` Represents an iteration object. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Timestamp of iteration creation. | -| `description` | [`String`](#string) | Description of the iteration. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `dueDate` | [`Time`](#time) | Timestamp of the iteration due date. | -| `id` | [`ID!`](#id) | ID of the iteration. | -| `iid` | [`ID!`](#id) | Internal ID of the iteration. | -| `iterationCadence` | [`IterationCadence!`](#iterationcadence) | Cadence of the iteration. | -| `report` | [`TimeboxReport`](#timeboxreport) | Historically accurate report about the timebox. | -| `scopedPath` | [`String`](#string) | Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. | -| `scopedUrl` | [`String`](#string) | Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. | -| `startDate` | [`Time`](#time) | Timestamp of the iteration start date. | -| `state` | [`IterationState!`](#iterationstate) | State of the iteration. | -| `title` | [`String!`](#string) | Title of the iteration. | -| `updatedAt` | [`Time!`](#time) | Timestamp of last iteration update. | -| `webPath` | [`String!`](#string) | Web path of the iteration. | -| `webUrl` | [`String!`](#string) | Web URL of the iteration. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="iterationcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of iteration creation. | +| <a id="iterationdescription"></a>`description` | [`String`](#string) | Description of the iteration. | +| <a id="iterationdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="iterationduedate"></a>`dueDate` | [`Time`](#time) | Timestamp of the iteration due date. | +| <a id="iterationid"></a>`id` | [`ID!`](#id) | ID of the iteration. | +| <a id="iterationiid"></a>`iid` | [`ID!`](#id) | Internal ID of the iteration. | +| <a id="iterationiterationcadence"></a>`iterationCadence` | [`IterationCadence!`](#iterationcadence) | Cadence of the iteration. | +| <a id="iterationreport"></a>`report` | [`TimeboxReport`](#timeboxreport) | Historically accurate report about the timebox. | +| <a id="iterationscopedpath"></a>`scopedPath` | [`String`](#string) | Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. | +| <a id="iterationscopedurl"></a>`scopedUrl` | [`String`](#string) | Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. | +| <a id="iterationstartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the iteration start date. | +| <a id="iterationstate"></a>`state` | [`IterationState!`](#iterationstate) | State of the iteration. | +| <a id="iterationtitle"></a>`title` | [`String!`](#string) | Title of the iteration. | +| <a id="iterationupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of last iteration update. | +| <a id="iterationwebpath"></a>`webPath` | [`String!`](#string) | Web path of the iteration. | +| <a id="iterationweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the iteration. | ### `IterationCadence` Represents an iteration cadence. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. | -| `automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate future iterations. | -| `durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. | -| `id` | [`IterationsCadenceID!`](#iterationscadenceid) | Global ID of the iteration cadence. | -| `iterationsInAdvance` | [`Int`](#int) | Future iterations to be created when iteration cadence is set to automatic. | -| `startDate` | [`Time`](#time) | Timestamp of the iteration cadence start date. | -| `title` | [`String!`](#string) | Title of the iteration cadence. | +#### Fields -### `IterationCadenceConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="iterationcadenceactive"></a>`active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. | +| <a id="iterationcadenceautomatic"></a>`automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate future iterations. | +| <a id="iterationcadencedescription"></a>`description` | [`String`](#string) | Description of the iteration cadence. Maximum length is 5000 characters. | +| <a id="iterationcadencedurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. | +| <a id="iterationcadenceid"></a>`id` | [`IterationsCadenceID!`](#iterationscadenceid) | Global ID of the iteration cadence. | +| <a id="iterationcadenceiterationsinadvance"></a>`iterationsInAdvance` | [`Int`](#int) | Future iterations to be created when iteration cadence is set to automatic. | +| <a id="iterationcadencerollover"></a>`rollOver` | [`Boolean!`](#boolean) | Whether the iteration cadence should roll over issues to the next iteration or not. | +| <a id="iterationcadencestartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the iteration cadence start date. | +| <a id="iterationcadencetitle"></a>`title` | [`String!`](#string) | Title of the iteration cadence. | -The connection type for IterationCadence. +### `JiraImport` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[IterationCadenceEdge]`](#iterationcadenceedge) | A list of edges. | -| `nodes` | [`[IterationCadence]`](#iterationcadence) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### Fields -### `IterationCadenceCreatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jiraimportcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the Jira import was created. | +| <a id="jiraimportfailedtoimportcount"></a>`failedToImportCount` | [`Int!`](#int) | Count of issues that failed to import. | +| <a id="jiraimportimportedissuescount"></a>`importedIssuesCount` | [`Int!`](#int) | Count of issues that were successfully imported. | +| <a id="jiraimportjiraprojectkey"></a>`jiraProjectKey` | [`String!`](#string) | Project key for the imported Jira project. | +| <a id="jiraimportscheduledat"></a>`scheduledAt` | [`Time`](#time) | Timestamp of when the Jira import was scheduled. | +| <a id="jiraimportscheduledby"></a>`scheduledBy` | [`UserCore`](#usercore) | User that started the Jira import. | +| <a id="jiraimporttotalissuecount"></a>`totalIssueCount` | [`Int!`](#int) | Total count of issues that were attempted to import. | -Autogenerated return type of IterationCadenceCreate. +### `JiraProject` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `iterationCadence` | [`IterationCadence`](#iterationcadence) | The created iteration cadence. | +#### Fields -### `IterationCadenceEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jiraprojectkey"></a>`key` | [`String!`](#string) | Key of the Jira project. | +| <a id="jiraprojectname"></a>`name` | [`String`](#string) | Name of the Jira project. | +| <a id="jiraprojectprojectid"></a>`projectId` | [`Int!`](#int) | ID of the Jira project. | -An edge in a connection. +### `JiraService` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`IterationCadence`](#iterationcadence) | The item at the end of the edge. | +#### Fields -### `IterationCadenceUpdatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jiraserviceactive"></a>`active` | [`Boolean`](#boolean) | Indicates if the service is active. | +| <a id="jiraservicetype"></a>`type` | [`String`](#string) | Class name of the service. | -Autogenerated return type of IterationCadenceUpdate. +#### Fields with arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `iterationCadence` | [`IterationCadence`](#iterationcadence) | The updated iteration cadence. | +##### `JiraService.projects` -### `IterationConnection` +List of all Jira projects fetched through Jira REST API. -The connection type for Iteration. +Returns [`JiraProjectConnection`](#jiraprojectconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[IterationEdge]`](#iterationedge) | A list of edges. | -| `nodes` | [`[Iteration]`](#iteration) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `IterationEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jiraserviceprojectsname"></a>`name` | [`String`](#string) | Project name or key. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Iteration`](#iteration) | The item at the end of the edge. | +### `JiraUser` -### `JiraImport` +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp of when the Jira import was created. | -| `failedToImportCount` | [`Int!`](#int) | Count of issues that failed to import. | -| `importedIssuesCount` | [`Int!`](#int) | Count of issues that were successfully imported. | -| `jiraProjectKey` | [`String!`](#string) | Project key for the imported Jira project. | -| `scheduledAt` | [`Time`](#time) | Timestamp of when the Jira import was scheduled. | -| `scheduledBy` | [`User`](#user) | User that started the Jira import. | -| `totalIssueCount` | [`Int!`](#int) | Total count of issues that were attempted to import. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jirausergitlabid"></a>`gitlabId` | [`Int`](#int) | ID of the matched GitLab user. | +| <a id="jirausergitlabname"></a>`gitlabName` | [`String`](#string) | Name of the matched GitLab user. | +| <a id="jirausergitlabusername"></a>`gitlabUsername` | [`String`](#string) | Username of the matched GitLab user. | +| <a id="jirauserjiraaccountid"></a>`jiraAccountId` | [`String!`](#string) | Account ID of the Jira user. | +| <a id="jirauserjiradisplayname"></a>`jiraDisplayName` | [`String!`](#string) | Display name of the Jira user. | +| <a id="jirauserjiraemail"></a>`jiraEmail` | [`String`](#string) | Email of the Jira user, returned only for users with public emails. | -### `JiraImportConnection` +### `JobPermissions` -The connection type for JiraImport. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[JiraImportEdge]`](#jiraimportedge) | A list of edges. | -| `nodes` | [`[JiraImport]`](#jiraimport) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jobpermissionsreadbuild"></a>`readBuild` | [`Boolean!`](#boolean) | Indicates the user can perform `read_build` on this resource. | +| <a id="jobpermissionsreadjobartifacts"></a>`readJobArtifacts` | [`Boolean!`](#boolean) | Indicates the user can perform `read_job_artifacts` on this resource. | +| <a id="jobpermissionsupdatebuild"></a>`updateBuild` | [`Boolean!`](#boolean) | Indicates the user can perform `update_build` on this resource. | -### `JiraImportEdge` +### `Kas` -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`JiraImport`](#jiraimport) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="kasenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether the Kubernetes Agent Server is enabled. | +| <a id="kasexternalurl"></a>`externalUrl` | [`String`](#string) | The URL used by the Agents to communicate with KAS. | +| <a id="kasversion"></a>`version` | [`String`](#string) | KAS version. | -### `JiraImportStartPayload` +### `Label` -Autogenerated return type of JiraImportStart. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `jiraImport` | [`JiraImport`](#jiraimport) | The Jira import data after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="labelcolor"></a>`color` | [`String!`](#string) | Background color of the label. | +| <a id="labelcreatedat"></a>`createdAt` | [`Time!`](#time) | When this label was created. | +| <a id="labeldescription"></a>`description` | [`String`](#string) | Description of the label (Markdown rendered as HTML for caching). | +| <a id="labeldescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="labelid"></a>`id` | [`ID!`](#id) | Label ID. | +| <a id="labelremoveonclose"></a>`removeOnClose` | [`Boolean!`](#boolean) | Whether the label should be removed from an issue when the issue is closed. | +| <a id="labeltextcolor"></a>`textColor` | [`String!`](#string) | Text color of the label. | +| <a id="labeltitle"></a>`title` | [`String!`](#string) | Content of the label. | +| <a id="labelupdatedat"></a>`updatedAt` | [`Time!`](#time) | When this label was last updated. | -### `JiraImportUsersPayload` +### `LfsObjectRegistry` -Autogenerated return type of JiraImportUsers. +Represents the Geo sync and verification state of an LFS object. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `jiraUsers` | [`[JiraUser!]`](#jirauser) | Users returned from Jira, matched by email and name if possible. | +#### Fields -### `JiraProject` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="lfsobjectregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the LfsObjectRegistry was created. | +| <a id="lfsobjectregistryid"></a>`id` | [`ID!`](#id) | ID of the LfsObjectRegistry. | +| <a id="lfsobjectregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the LfsObjectRegistry. | +| <a id="lfsobjectregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the LfsObjectRegistry. | +| <a id="lfsobjectregistrylfsobjectid"></a>`lfsObjectId` | [`ID!`](#id) | ID of the LFS object. | +| <a id="lfsobjectregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the LfsObjectRegistry should be resynced. | +| <a id="lfsobjectregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the LfsObjectRegistry. | +| <a id="lfsobjectregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the LfsObjectRegistry. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `key` | [`String!`](#string) | Key of the Jira project. | -| `name` | [`String`](#string) | Name of the Jira project. | -| `projectId` | [`Int!`](#int) | ID of the Jira project. | +### `LicenseHistoryEntry` -### `JiraProjectConnection` +Represents an entry from the Cloud License history. -The connection type for JiraProject. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[JiraProjectEdge]`](#jiraprojectedge) | A list of edges. | -| `nodes` | [`[JiraProject]`](#jiraproject) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="licensehistoryentryactivatedat"></a>`activatedAt` | [`Date`](#date) | Date when the license was activated. | +| <a id="licensehistoryentrycompany"></a>`company` | [`String`](#string) | Company of the licensee. | +| <a id="licensehistoryentryemail"></a>`email` | [`String`](#string) | Email of the licensee. | +| <a id="licensehistoryentryexpiresat"></a>`expiresAt` | [`Date`](#date) | Date when the license expires. | +| <a id="licensehistoryentryid"></a>`id` | [`ID!`](#id) | ID of the license. | +| <a id="licensehistoryentryname"></a>`name` | [`String`](#string) | Name of the licensee. | +| <a id="licensehistoryentryplan"></a>`plan` | [`String!`](#string) | Name of the subscription plan. | +| <a id="licensehistoryentrystartsat"></a>`startsAt` | [`Date`](#date) | Date when the license started. | +| <a id="licensehistoryentrytype"></a>`type` | [`String!`](#string) | Type of the license. | +| <a id="licensehistoryentryusersinlicensecount"></a>`usersInLicenseCount` | [`Int`](#int) | Number of paid users in the license. | -### `JiraProjectEdge` +### `MavenMetadata` -An edge in a connection. +Maven metadata. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`JiraProject`](#jiraproject) | The item at the end of the edge. | +#### Fields -### `JiraService` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mavenmetadataappgroup"></a>`appGroup` | [`String!`](#string) | App group of the Maven package. | +| <a id="mavenmetadataappname"></a>`appName` | [`String!`](#string) | App name of the Maven package. | +| <a id="mavenmetadataappversion"></a>`appVersion` | [`String`](#string) | App version of the Maven package. | +| <a id="mavenmetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. | +| <a id="mavenmetadataid"></a>`id` | [`PackagesMavenMetadatumID!`](#packagesmavenmetadatumid) | ID of the metadatum. | +| <a id="mavenmetadatapath"></a>`path` | [`String!`](#string) | Path of the Maven package. | +| <a id="mavenmetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean`](#boolean) | Indicates if the service is active. | -| `projects` | [`JiraProjectConnection`](#jiraprojectconnection) | List of all Jira projects fetched through Jira REST API. | -| `type` | [`String`](#string) | Class name of the service. | +### `MergeRequest` -### `JiraUser` +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `gitlabId` | [`Int`](#int) | ID of the matched GitLab user. | -| `gitlabName` | [`String`](#string) | Name of the matched GitLab user. | -| `gitlabUsername` | [`String`](#string) | Username of the matched GitLab user. | -| `jiraAccountId` | [`String!`](#string) | Account ID of the Jira user. | -| `jiraDisplayName` | [`String!`](#string) | Display name of the Jira user. | -| `jiraEmail` | [`String`](#string) | Email of the Jira user, returned only for users with public emails. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestallowcollaboration"></a>`allowCollaboration` | [`Boolean`](#boolean) | Indicates if members of the target project can push to the fork. | +| <a id="mergerequestapprovalsleft"></a>`approvalsLeft` | [`Int`](#int) | Number of approvals left. | +| <a id="mergerequestapprovalsrequired"></a>`approvalsRequired` | [`Int`](#int) | Number of approvals required. | +| <a id="mergerequestapproved"></a>`approved` | [`Boolean!`](#boolean) | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. | +| <a id="mergerequestapprovedby"></a>`approvedBy` | [`UserCoreConnection`](#usercoreconnection) | Users who approved the merge request. (see [Connections](#connections)) | +| <a id="mergerequestassignees"></a>`assignees` | [`MergeRequestAssigneeConnection`](#mergerequestassigneeconnection) | Assignees of the merge request. (see [Connections](#connections)) | +| <a id="mergerequestauthor"></a>`author` | [`UserCore`](#usercore) | User who created this merge request. | +| <a id="mergerequestautomergeenabled"></a>`autoMergeEnabled` | [`Boolean!`](#boolean) | Indicates if auto merge is enabled for the merge request. | +| <a id="mergerequestautomergestrategy"></a>`autoMergeStrategy` | [`String`](#string) | Selected auto merge strategy. | +| <a id="mergerequestavailableautomergestrategies"></a>`availableAutoMergeStrategies` | [`[String!]`](#string) | Array of available auto merge strategies. | +| <a id="mergerequestcommitcount"></a>`commitCount` | [`Int`](#int) | Number of commits in the merge request. | +| <a id="mergerequestcommitswithoutmergecommits"></a>`commitsWithoutMergeCommits` | [`CommitConnection`](#commitconnection) | Merge request commits excluding merge commits. (see [Connections](#connections)) | +| <a id="mergerequestconflicts"></a>`conflicts` | [`Boolean!`](#boolean) | Indicates if the merge request has conflicts. | +| <a id="mergerequestcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the merge request was created. | +| <a id="mergerequestdefaultmergecommitmessage"></a>`defaultMergeCommitMessage` | [`String`](#string) | Default merge commit message of the merge request. | +| <a id="mergerequestdefaultmergecommitmessagewithdescription"></a>`defaultMergeCommitMessageWithDescription` | [`String`](#string) | Default merge commit message of the merge request with description. | +| <a id="mergerequestdefaultsquashcommitmessage"></a>`defaultSquashCommitMessage` | [`String`](#string) | Default squash commit message of the merge request. | +| <a id="mergerequestdescription"></a>`description` | [`String`](#string) | Description of the merge request (Markdown rendered as HTML for caching). | +| <a id="mergerequestdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="mergerequestdiffheadsha"></a>`diffHeadSha` | [`String`](#string) | Diff head SHA of the merge request. | +| <a id="mergerequestdiffrefs"></a>`diffRefs` | [`DiffRefs`](#diffrefs) | References of the base SHA, the head SHA, and the start SHA for this merge request. | +| <a id="mergerequestdiffstatssummary"></a>`diffStatsSummary` | [`DiffStatsSummary`](#diffstatssummary) | Summary of which files were changed in this merge request. | +| <a id="mergerequestdiscussionlocked"></a>`discussionLocked` | [`Boolean!`](#boolean) | Indicates if comments on the merge request are locked to members only. | +| <a id="mergerequestdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="mergerequestdivergedfromtargetbranch"></a>`divergedFromTargetBranch` | [`Boolean!`](#boolean) | Indicates if the source branch is behind the target branch. | +| <a id="mergerequestdownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes for the merge request. | +| <a id="mergerequestdraft"></a>`draft` | [`Boolean!`](#boolean) | Indicates if the merge request is a draft. | +| <a id="mergerequestforceremovesourcebranch"></a>`forceRemoveSourceBranch` | [`Boolean`](#boolean) | Indicates if the project settings will lead to source branch deletion after merge. | +| <a id="mergerequesthasci"></a>`hasCi` | [`Boolean!`](#boolean) | Indicates if the merge request has CI. | +| <a id="mergerequesthassecurityreports"></a>`hasSecurityReports` | [`Boolean!`](#boolean) | Indicates if the source branch has any security reports. | +| <a id="mergerequestheadpipeline"></a>`headPipeline` | [`Pipeline`](#pipeline) | The pipeline running on the branch HEAD of the merge request. | +| <a id="mergerequestid"></a>`id` | [`ID!`](#id) | ID of the merge request. | +| <a id="mergerequestiid"></a>`iid` | [`String!`](#string) | Internal ID of the merge request. | +| <a id="mergerequestinprogressmergecommitsha"></a>`inProgressMergeCommitSha` | [`String`](#string) | Commit SHA of the merge request if merge is in progress. | +| <a id="mergerequestlabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the merge request. (see [Connections](#connections)) | +| <a id="mergerequestmergecommitsha"></a>`mergeCommitSha` | [`String`](#string) | SHA of the merge request commit (set once merged). | +| <a id="mergerequestmergeerror"></a>`mergeError` | [`String`](#string) | Error message due to a merge error. | +| <a id="mergerequestmergeongoing"></a>`mergeOngoing` | [`Boolean!`](#boolean) | Indicates if a merge is currently occurring. | +| <a id="mergerequestmergestatus"></a>`mergeStatus` | [`String`](#string) | Status of the merge request. | +| <a id="mergerequestmergetrainscount"></a>`mergeTrainsCount` | [`Int`](#int) | Number of merge requests in the merge train. | +| <a id="mergerequestmergeuser"></a>`mergeUser` | [`UserCore`](#usercore) | User who merged this merge request. | +| <a id="mergerequestmergewhenpipelinesucceeds"></a>`mergeWhenPipelineSucceeds` | [`Boolean`](#boolean) | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS). | +| <a id="mergerequestmergeable"></a>`mergeable` | [`Boolean!`](#boolean) | Indicates if the merge request is mergeable. | +| <a id="mergerequestmergeablediscussionsstate"></a>`mergeableDiscussionsState` | [`Boolean`](#boolean) | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged. | +| <a id="mergerequestmergedat"></a>`mergedAt` | [`Time`](#time) | Timestamp of when the merge request was merged, null if not merged. | +| <a id="mergerequestmilestone"></a>`milestone` | [`Milestone`](#milestone) | The milestone of the merge request. | +| <a id="mergerequestnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="mergerequestparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. (see [Connections](#connections)) | +| <a id="mergerequestproject"></a>`project` | [`Project!`](#project) | Alias for target_project. | +| <a id="mergerequestprojectid"></a>`projectId` | [`Int!`](#int) | ID of the merge request project. | +| <a id="mergerequestrebasecommitsha"></a>`rebaseCommitSha` | [`String`](#string) | Rebase commit SHA of the merge request. | +| <a id="mergerequestrebaseinprogress"></a>`rebaseInProgress` | [`Boolean!`](#boolean) | Indicates if there is a rebase currently in progress for the merge request. | +| <a id="mergerequestreviewers"></a>`reviewers` | [`MergeRequestReviewerConnection`](#mergerequestreviewerconnection) | Users from whom a review has been requested. (see [Connections](#connections)) | +| <a id="mergerequestsecurityautofix"></a>`securityAutoFix` | [`Boolean`](#boolean) | Indicates if the merge request is created by @GitLab-Security-Bot. | +| <a id="mergerequestsecurityreportsuptodateontargetbranch"></a>`securityReportsUpToDateOnTargetBranch` | [`Boolean!`](#boolean) | Indicates if the target branch security reports are out of date. | +| <a id="mergerequestshouldberebased"></a>`shouldBeRebased` | [`Boolean!`](#boolean) | Indicates if the merge request will be rebased. | +| <a id="mergerequestshouldremovesourcebranch"></a>`shouldRemoveSourceBranch` | [`Boolean`](#boolean) | Indicates if the source branch of the merge request will be deleted after merge. | +| <a id="mergerequestsourcebranch"></a>`sourceBranch` | [`String!`](#string) | Source branch of the merge request. | +| <a id="mergerequestsourcebranchexists"></a>`sourceBranchExists` | [`Boolean!`](#boolean) | Indicates if the source branch of the merge request exists. | +| <a id="mergerequestsourcebranchprotected"></a>`sourceBranchProtected` | [`Boolean!`](#boolean) | Indicates if the source branch is protected. | +| <a id="mergerequestsourceproject"></a>`sourceProject` | [`Project`](#project) | Source project of the merge request. | +| <a id="mergerequestsourceprojectid"></a>`sourceProjectId` | [`Int`](#int) | ID of the merge request source project. | +| <a id="mergerequestsquash"></a>`squash` | [`Boolean!`](#boolean) | Indicates if squash on merge is enabled. | +| <a id="mergerequestsquashonmerge"></a>`squashOnMerge` | [`Boolean!`](#boolean) | Indicates if squash on merge is enabled. | +| <a id="mergerequeststate"></a>`state` | [`MergeRequestState!`](#mergerequeststate) | State of the merge request. | +| <a id="mergerequestsubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates if the currently logged in user is subscribed to this merge request. | +| <a id="mergerequesttargetbranch"></a>`targetBranch` | [`String!`](#string) | Target branch of the merge request. | +| <a id="mergerequesttargetbranchexists"></a>`targetBranchExists` | [`Boolean!`](#boolean) | Indicates if the target branch of the merge request exists. | +| <a id="mergerequesttargetproject"></a>`targetProject` | [`Project!`](#project) | Target project of the merge request. | +| <a id="mergerequesttargetprojectid"></a>`targetProjectId` | [`Int!`](#int) | ID of the merge request target project. | +| <a id="mergerequesttaskcompletionstatus"></a>`taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Completion status of tasks. | +| <a id="mergerequesttimeestimate"></a>`timeEstimate` | [`Int!`](#int) | Time estimate of the merge request. | +| <a id="mergerequesttimelogs"></a>`timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the merge request. (see [Connections](#connections)) | +| <a id="mergerequesttitle"></a>`title` | [`String!`](#string) | Title of the merge request. | +| <a id="mergerequesttitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | +| <a id="mergerequesttotaltimespent"></a>`totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the merge request. | +| <a id="mergerequestupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the merge request was last updated. | +| <a id="mergerequestupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes for the merge request. | +| <a id="mergerequestuserdiscussionscount"></a>`userDiscussionsCount` | [`Int`](#int) | Number of user discussions in the merge request. | +| <a id="mergerequestusernotescount"></a>`userNotesCount` | [`Int`](#int) | User notes count of the merge request. | +| <a id="mergerequestuserpermissions"></a>`userPermissions` | [`MergeRequestPermissions!`](#mergerequestpermissions) | Permissions for the current user on the resource. | +| <a id="mergerequestweburl"></a>`webUrl` | [`String`](#string) | Web URL of the merge request. | +| <a id="mergerequestworkinprogress"></a>`workInProgress` **{warning-solid}** | [`Boolean!`](#boolean) | **Deprecated** in 13.12. Use `draft`. | + +#### Fields with arguments + +##### `MergeRequest.currentUserTodos` + +To-do items for the current user. + +Returns [`TodoConnection!`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -### `Label` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestcurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `color` | [`String!`](#string) | Background color of the label. | -| `createdAt` | [`Time!`](#time) | When this label was created. | -| `description` | [`String`](#string) | Description of the label (Markdown rendered as HTML for caching). | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `id` | [`ID!`](#id) | Label ID. | -| `textColor` | [`String!`](#string) | Text color of the label. | -| `title` | [`String!`](#string) | Content of the label. | -| `updatedAt` | [`Time!`](#time) | When this label was last updated. | +##### `MergeRequest.diffStats` -### `LabelConnection` +Details about which files were changed in this merge request. -The connection type for Label. +Returns [`[DiffStats!]`](#diffstats). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[LabelEdge]`](#labeledge) | A list of edges. | -| `nodes` | [`[Label]`](#label) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +###### Arguments -### `LabelCreatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestdiffstatspath"></a>`path` | [`String`](#string) | A specific file-path. | -Autogenerated return type of LabelCreate. +##### `MergeRequest.pipelines` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `label` | [`Label`](#label) | The label after mutation. | +Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned. -### `LabelEdge` +Returns [`PipelineConnection`](#pipelineconnection). -An edge in a connection. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Label`](#label) | The item at the end of the edge. | +###### Arguments -### `LicenseHistoryEntry` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestpipelinesref"></a>`ref` | [`String`](#string) | Filter pipelines by the ref they are run for. | +| <a id="mergerequestpipelinessha"></a>`sha` | [`String`](#string) | Filter pipelines by the sha of the commit they are run for. | +| <a id="mergerequestpipelinesstatus"></a>`status` | [`PipelineStatusEnum`](#pipelinestatusenum) | Filter pipelines by their status. | -Represents an entry from the Cloud License history. +##### `MergeRequest.reference` + +Internal reference of the merge request. Returned in shortened format by default. + +Returns [`String!`](#string). + +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `activatedAt` | [`Date`](#date) | Date when the license was activated. | -| `company` | [`String`](#string) | Company of the licensee. | -| `email` | [`String`](#string) | Email of the licensee. | -| `expiresAt` | [`Date`](#date) | Date when the license expires. | -| `id` | [`ID!`](#id) | ID of the license. | -| `name` | [`String`](#string) | Name of the licensee. | -| `plan` | [`String!`](#string) | Name of the subscription plan. | -| `startsAt` | [`Date`](#date) | Date when the license started. | -| `type` | [`String!`](#string) | Type of the license. | -| `usersInLicenseCount` | [`Int`](#int) | Number of paid users in the license. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestreferencefull"></a>`full` | [`Boolean`](#boolean) | Boolean option specifying whether the reference should be returned in full. | + +### `MergeRequestAssignee` -### `LicenseHistoryEntryConnection` +A user assigned to a merge request. -The connection type for LicenseHistoryEntry. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[LicenseHistoryEntryEdge]`](#licensehistoryentryedge) | A list of edges. | -| `nodes` | [`[LicenseHistoryEntry]`](#licensehistoryentry) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneeavatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. | +| <a id="mergerequestassigneebot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. | +| <a id="mergerequestassigneecallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) | +| <a id="mergerequestassigneeemail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). | +| <a id="mergerequestassigneegroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. | +| <a id="mergerequestassigneegroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) | +| <a id="mergerequestassigneeid"></a>`id` | [`ID!`](#id) | ID of the user. | +| <a id="mergerequestassigneelocation"></a>`location` | [`String`](#string) | The location of the user. | +| <a id="mergerequestassigneemergerequestinteraction"></a>`mergeRequestInteraction` | [`UserMergeRequestInteraction`](#usermergerequestinteraction) | Details of this user's interactions with the merge request. | +| <a id="mergerequestassigneename"></a>`name` | [`String!`](#string) | Human-readable name of the user. | +| <a id="mergerequestassigneeprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) | +| <a id="mergerequestassigneepublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. | +| <a id="mergerequestassigneestate"></a>`state` | [`UserState!`](#userstate) | State of the user. | +| <a id="mergerequestassigneestatus"></a>`status` | [`UserStatus`](#userstatus) | User status. | +| <a id="mergerequestassigneeuserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. | +| <a id="mergerequestassigneeusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. | +| <a id="mergerequestassigneewebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. | +| <a id="mergerequestassigneeweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. | + +#### Fields with arguments + +##### `MergeRequestAssignee.assignedMergeRequests` + +Merge requests assigned to the user. + +Returns [`MergeRequestConnection`](#mergerequestconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -### `LicenseHistoryEntryEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneeassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="mergerequestassigneeassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="mergerequestassigneeassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="mergerequestassigneeassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="mergerequestassigneeassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="mergerequestassigneeassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="mergerequestassigneeassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="mergerequestassigneeassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="mergerequestassigneeassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="mergerequestassigneeassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="mergerequestassigneeassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="mergerequestassigneeassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="mergerequestassigneeassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="mergerequestassigneeassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | -An edge in a connection. +##### `MergeRequestAssignee.authoredMergeRequests` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`LicenseHistoryEntry`](#licensehistoryentry) | The item at the end of the edge. | +Merge requests authored by the user. -### `MarkAsSpamSnippetPayload` +Returns [`MergeRequestConnection`](#mergerequestconnection). -Autogenerated return type of MarkAsSpamSnippet. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `snippet` | [`Snippet`](#snippet) | The snippet after mutation. | +###### Arguments -### `MemberInterfaceConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneeauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="mergerequestassigneeauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="mergerequestassigneeauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="mergerequestassigneeauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="mergerequestassigneeauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="mergerequestassigneeauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="mergerequestassigneeauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="mergerequestassigneeauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="mergerequestassigneeauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="mergerequestassigneeauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="mergerequestassigneeauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="mergerequestassigneeauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="mergerequestassigneeauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="mergerequestassigneeauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | -The connection type for MemberInterface. +##### `MergeRequestAssignee.reviewRequestedMergeRequests` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[MemberInterfaceEdge]`](#memberinterfaceedge) | A list of edges. | -| `nodes` | [`[MemberInterface]`](#memberinterface) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Merge requests assigned to the user for review. -### `MemberInterfaceEdge` +Returns [`MergeRequestConnection`](#mergerequestconnection). -An edge in a connection. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`MemberInterface`](#memberinterface) | The item at the end of the edge. | +###### Arguments -### `MergeRequest` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneereviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="mergerequestassigneereviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="mergerequestassigneereviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="mergerequestassigneereviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="mergerequestassigneereviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="mergerequestassigneereviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="mergerequestassigneereviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="mergerequestassigneereviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="mergerequestassigneereviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="mergerequestassigneereviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="mergerequestassigneereviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="mergerequestassigneereviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="mergerequestassigneereviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="mergerequestassigneereviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | + +##### `MergeRequestAssignee.snippets` + +Snippets authored by the user. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `allowCollaboration` | [`Boolean`](#boolean) | Indicates if members of the target project can push to the fork. | -| `approvalsLeft` | [`Int`](#int) | Number of approvals left. | -| `approvalsRequired` | [`Int`](#int) | Number of approvals required. | -| `approved` | [`Boolean!`](#boolean) | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. | -| `approvedBy` | [`UserConnection`](#userconnection) | Users who approved the merge request. | -| `assignees` | [`UserConnection`](#userconnection) | Assignees of the merge request. | -| `author` | [`User`](#user) | User who created this merge request. | -| `autoMergeEnabled` | [`Boolean!`](#boolean) | Indicates if auto merge is enabled for the merge request. | -| `autoMergeStrategy` | [`String`](#string) | Selected auto merge strategy. | -| `availableAutoMergeStrategies` | [`[String!]`](#string) | Array of available auto merge strategies. | -| `commitCount` | [`Int`](#int) | Number of commits in the merge request. | -| `commitsWithoutMergeCommits` | [`CommitConnection`](#commitconnection) | Merge request commits excluding merge commits. | -| `conflicts` | [`Boolean!`](#boolean) | Indicates if the merge request has conflicts. | -| `createdAt` | [`Time!`](#time) | Timestamp of when the merge request was created. | -| `currentUserTodos` | [`TodoConnection!`](#todoconnection) | To-do items for the current user. | -| `defaultMergeCommitMessage` | [`String`](#string) | Default merge commit message of the merge request. | -| `defaultMergeCommitMessageWithDescription` | [`String`](#string) | Default merge commit message of the merge request with description. | -| `defaultSquashCommitMessage` | [`String`](#string) | Default squash commit message of the merge request. | -| `description` | [`String`](#string) | Description of the merge request (Markdown rendered as HTML for caching). | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `diffHeadSha` | [`String`](#string) | Diff head SHA of the merge request. | -| `diffRefs` | [`DiffRefs`](#diffrefs) | References of the base SHA, the head SHA, and the start SHA for this merge request. | -| `diffStats` | [`[DiffStats!]`](#diffstats) | Details about which files were changed in this merge request. | -| `diffStatsSummary` | [`DiffStatsSummary`](#diffstatssummary) | Summary of which files were changed in this merge request. | -| `discussionLocked` | [`Boolean!`](#boolean) | Indicates if comments on the merge request are locked to members only. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `divergedFromTargetBranch` | [`Boolean!`](#boolean) | Indicates if the source branch is behind the target branch. | -| `downvotes` | [`Int!`](#int) | Number of downvotes for the merge request. | -| `forceRemoveSourceBranch` | [`Boolean`](#boolean) | Indicates if the project settings will lead to source branch deletion after merge. | -| `hasCi` | [`Boolean!`](#boolean) | Indicates if the merge request has CI. | -| `hasSecurityReports` | [`Boolean!`](#boolean) | Indicates if the source branch has any security reports. | -| `headPipeline` | [`Pipeline`](#pipeline) | The pipeline running on the branch HEAD of the merge request. | -| `id` | [`ID!`](#id) | ID of the merge request. | -| `iid` | [`String!`](#string) | Internal ID of the merge request. | -| `inProgressMergeCommitSha` | [`String`](#string) | Commit SHA of the merge request if merge is in progress. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels of the merge request. | -| `mergeCommitSha` | [`String`](#string) | SHA of the merge request commit (set once merged). | -| `mergeError` | [`String`](#string) | Error message due to a merge error. | -| `mergeOngoing` | [`Boolean!`](#boolean) | Indicates if a merge is currently occurring. | -| `mergeStatus` | [`String`](#string) | Status of the merge request. | -| `mergeTrainsCount` | [`Int`](#int) | Number of merge requests in the merge train. | -| `mergeUser` | [`User`](#user) | User who merged this merge request. | -| `mergeWhenPipelineSucceeds` | [`Boolean`](#boolean) | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS). | -| `mergeable` | [`Boolean!`](#boolean) | Indicates if the merge request is mergeable. | -| `mergeableDiscussionsState` | [`Boolean`](#boolean) | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged. | -| `mergedAt` | [`Time`](#time) | Timestamp of when the merge request was merged, null if not merged. | -| `milestone` | [`Milestone`](#milestone) | The milestone of the merge request. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `participants` | [`UserConnection`](#userconnection) | Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. | -| `pipelines` | [`PipelineConnection`](#pipelineconnection) | Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned. | -| `project` | [`Project!`](#project) | Alias for target_project. | -| `projectId` | [`Int!`](#int) | ID of the merge request project. | -| `rebaseCommitSha` | [`String`](#string) | Rebase commit SHA of the merge request. | -| `rebaseInProgress` | [`Boolean!`](#boolean) | Indicates if there is a rebase currently in progress for the merge request. | -| `reference` | [`String!`](#string) | Internal reference of the merge request. Returned in shortened format by default. | -| `reviewers` | [`MergeRequestReviewerConnection`](#mergerequestreviewerconnection) | Users from whom a review has been requested. | -| `securityAutoFix` | [`Boolean`](#boolean) | Indicates if the merge request is created by @GitLab-Security-Bot. | -| `securityReportsUpToDateOnTargetBranch` | [`Boolean!`](#boolean) | Indicates if the target branch security reports are out of date. | -| `shouldBeRebased` | [`Boolean!`](#boolean) | Indicates if the merge request will be rebased. | -| `shouldRemoveSourceBranch` | [`Boolean`](#boolean) | Indicates if the source branch of the merge request will be deleted after merge. | -| `sourceBranch` | [`String!`](#string) | Source branch of the merge request. | -| `sourceBranchExists` | [`Boolean!`](#boolean) | Indicates if the source branch of the merge request exists. | -| `sourceBranchProtected` | [`Boolean!`](#boolean) | Indicates if the source branch is protected. | -| `sourceProject` | [`Project`](#project) | Source project of the merge request. | -| `sourceProjectId` | [`Int`](#int) | ID of the merge request source project. | -| `squash` | [`Boolean!`](#boolean) | Indicates if squash on merge is enabled. | -| `squashOnMerge` | [`Boolean!`](#boolean) | Indicates if squash on merge is enabled. | -| `state` | [`MergeRequestState!`](#mergerequeststate) | State of the merge request. | -| `subscribed` | [`Boolean!`](#boolean) | Indicates if the currently logged in user is subscribed to this merge request. | -| `targetBranch` | [`String!`](#string) | Target branch of the merge request. | -| `targetBranchExists` | [`Boolean!`](#boolean) | Indicates if the target branch of the merge request exists. | -| `targetProject` | [`Project!`](#project) | Target project of the merge request. | -| `targetProjectId` | [`Int!`](#int) | ID of the merge request target project. | -| `taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Completion status of tasks. | -| `timeEstimate` | [`Int!`](#int) | Time estimate of the merge request. | -| `timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the merge request. | -| `title` | [`String!`](#string) | Title of the merge request. | -| `titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | -| `totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the merge request. | -| `updatedAt` | [`Time!`](#time) | Timestamp of when the merge request was last updated. | -| `upvotes` | [`Int!`](#int) | Number of upvotes for the merge request. | -| `userDiscussionsCount` | [`Int`](#int) | Number of user discussions in the merge request. | -| `userNotesCount` | [`Int`](#int) | User notes count of the merge request. | -| `userPermissions` | [`MergeRequestPermissions!`](#mergerequestpermissions) | Permissions for the current user on the resource. | -| `webUrl` | [`String`](#string) | Web URL of the merge request. | -| `workInProgress` | [`Boolean!`](#boolean) | Indicates if the merge request is a draft. | - -### `MergeRequestAcceptPayload` - -Autogenerated return type of MergeRequestAccept. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | - -### `MergeRequestConnection` - -The connection type for MergeRequest. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[MergeRequestEdge]`](#mergerequestedge) | A list of edges. | -| `nodes` | [`[MergeRequest]`](#mergerequest) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | -| `totalTimeToMerge` | [`Float`](#float) | Total sum of time to merge, in seconds, for the collection of merge requests. | - -### `MergeRequestCreatePayload` - -Autogenerated return type of MergeRequestCreate. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +Returns [`SnippetConnection`](#snippetconnection). -### `MergeRequestDiffRegistry` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Represents the Geo sync and verification state of a Merge Request diff. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp when the MergeRequestDiffRegistry was created. | -| `id` | [`ID!`](#id) | ID of the MergeRequestDiffRegistry. | -| `lastSyncFailure` | [`String`](#string) | Error message during sync of the MergeRequestDiffRegistry. | -| `lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the MergeRequestDiffRegistry. | -| `mergeRequestDiffId` | [`ID!`](#id) | ID of the Merge Request diff. | -| `retryAt` | [`Time`](#time) | Timestamp after which the MergeRequestDiffRegistry should be resynced. | -| `retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the MergeRequestDiffRegistry. | -| `state` | [`RegistryState`](#registrystate) | Sync state of the MergeRequestDiffRegistry. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneesnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | +| <a id="mergerequestassigneesnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | The type of snippet. | +| <a id="mergerequestassigneesnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | The visibility of the snippet. | -### `MergeRequestDiffRegistryConnection` +##### `MergeRequestAssignee.starredProjects` -The connection type for MergeRequestDiffRegistry. +Projects starred by the user. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[MergeRequestDiffRegistryEdge]`](#mergerequestdiffregistryedge) | A list of edges. | -| `nodes` | [`[MergeRequestDiffRegistry]`](#mergerequestdiffregistry) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Returns [`ProjectConnection`](#projectconnection). -### `MergeRequestDiffRegistryEdge` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -An edge in a connection. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`MergeRequestDiffRegistry`](#mergerequestdiffregistry) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneestarredprojectssearch"></a>`search` | [`String`](#string) | Search query. | -### `MergeRequestEdge` +##### `MergeRequestAssignee.todos` -An edge in a connection. +To-do items of the user. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`MergeRequest`](#mergerequest) | The item at the end of the edge. | +Returns [`TodoConnection`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestassigneetodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | The action to be filtered. | +| <a id="mergerequestassigneetodosauthorid"></a>`authorId` | [`[ID!]`](#id) | The ID of an author. | +| <a id="mergerequestassigneetodosgroupid"></a>`groupId` | [`[ID!]`](#id) | The ID of a group. | +| <a id="mergerequestassigneetodosprojectid"></a>`projectId` | [`[ID!]`](#id) | The ID of a project. | +| <a id="mergerequestassigneetodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | The state of the todo. | +| <a id="mergerequestassigneetodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | The type of the todo. | + +### `MergeRequestDiffRegistry` + +Represents the Geo sync and verification state of a Merge Request diff. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestdiffregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the MergeRequestDiffRegistry was created. | +| <a id="mergerequestdiffregistryid"></a>`id` | [`ID!`](#id) | ID of the MergeRequestDiffRegistry. | +| <a id="mergerequestdiffregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the MergeRequestDiffRegistry. | +| <a id="mergerequestdiffregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the MergeRequestDiffRegistry. | +| <a id="mergerequestdiffregistrymergerequestdiffid"></a>`mergeRequestDiffId` | [`ID!`](#id) | ID of the Merge Request diff. | +| <a id="mergerequestdiffregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the MergeRequestDiffRegistry should be resynced. | +| <a id="mergerequestdiffregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the MergeRequestDiffRegistry. | +| <a id="mergerequestdiffregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the MergeRequestDiffRegistry. | ### `MergeRequestPermissions` Check permissions for the current user on a merge request. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_merge_request` on this resource. | -| `canMerge` | [`Boolean!`](#boolean) | Indicates the user can perform `can_merge` on this resource. | -| `cherryPickOnCurrentMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource. | -| `createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | -| `pushToSourceBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `push_to_source_branch` on this resource. | -| `readMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `read_merge_request` on this resource. | -| `removeSourceBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_source_branch` on this resource. | -| `revertOnCurrentMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `revert_on_current_merge_request` on this resource. | -| `updateMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `update_merge_request` on this resource. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestpermissionsadminmergerequest"></a>`adminMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_merge_request` on this resource. | +| <a id="mergerequestpermissionscanmerge"></a>`canMerge` | [`Boolean!`](#boolean) | Indicates the user can perform `can_merge` on this resource. | +| <a id="mergerequestpermissionscherrypickoncurrentmergerequest"></a>`cherryPickOnCurrentMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource. | +| <a id="mergerequestpermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | +| <a id="mergerequestpermissionspushtosourcebranch"></a>`pushToSourceBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `push_to_source_branch` on this resource. | +| <a id="mergerequestpermissionsreadmergerequest"></a>`readMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `read_merge_request` on this resource. | +| <a id="mergerequestpermissionsremovesourcebranch"></a>`removeSourceBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_source_branch` on this resource. | +| <a id="mergerequestpermissionsrevertoncurrentmergerequest"></a>`revertOnCurrentMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `revert_on_current_merge_request` on this resource. | +| <a id="mergerequestpermissionsupdatemergerequest"></a>`updateMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `update_merge_request` on this resource. | ### `MergeRequestReviewer` -A user from whom a merge request review has been requested. +A user assigned to a merge request as a reviewer. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `assignedMergeRequests` | [`MergeRequestConnection`](#mergerequestconnection) | Merge requests assigned to the user. | -| `authoredMergeRequests` | [`MergeRequestConnection`](#mergerequestconnection) | Merge requests authored by the user. | -| `avatarUrl` | [`String`](#string) | URL of the user's avatar. | -| `bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. | -| `callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. | -| `email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: `User.publicEmail`. | -| `groupCount` | [`Int`](#int) | Group count for the user. Available only when feature flag `user_group_counts` is enabled. | -| `groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. | -| `id` | [`ID!`](#id) | ID of the user. | -| `location` | [`String`](#string) | The location of the user. | -| `mergeRequestInteraction` | [`UserMergeRequestInteraction`](#usermergerequestinteraction) | Details of this user's interactions with the merge request. | -| `name` | [`String!`](#string) | Human-readable name of the user. | -| `projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. | -| `publicEmail` | [`String`](#string) | User's public email. | -| `reviewRequestedMergeRequests` | [`MergeRequestConnection`](#mergerequestconnection) | Merge requests assigned to the user for review. | -| `snippets` | [`SnippetConnection`](#snippetconnection) | Snippets authored by the user. | -| `starredProjects` | [`ProjectConnection`](#projectconnection) | Projects starred by the user. | -| `state` | [`UserState!`](#userstate) | State of the user. | -| `status` | [`UserStatus`](#userstatus) | User status. | -| `todos` | [`TodoConnection`](#todoconnection) | To-do items of the user. | -| `userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. | -| `username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. | -| `webPath` | [`String!`](#string) | Web path of the user. | -| `webUrl` | [`String!`](#string) | Web URL of the user. | +#### Fields -### `MergeRequestReviewerConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestrevieweravatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. | +| <a id="mergerequestreviewerbot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. | +| <a id="mergerequestreviewercallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) | +| <a id="mergerequestrevieweremail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). | +| <a id="mergerequestreviewergroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. | +| <a id="mergerequestreviewergroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) | +| <a id="mergerequestreviewerid"></a>`id` | [`ID!`](#id) | ID of the user. | +| <a id="mergerequestreviewerlocation"></a>`location` | [`String`](#string) | The location of the user. | +| <a id="mergerequestreviewermergerequestinteraction"></a>`mergeRequestInteraction` | [`UserMergeRequestInteraction`](#usermergerequestinteraction) | Details of this user's interactions with the merge request. | +| <a id="mergerequestreviewername"></a>`name` | [`String!`](#string) | Human-readable name of the user. | +| <a id="mergerequestreviewerprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) | +| <a id="mergerequestreviewerpublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. | +| <a id="mergerequestreviewerstate"></a>`state` | [`UserState!`](#userstate) | State of the user. | +| <a id="mergerequestreviewerstatus"></a>`status` | [`UserStatus`](#userstatus) | User status. | +| <a id="mergerequestrevieweruserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. | +| <a id="mergerequestreviewerusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. | +| <a id="mergerequestreviewerwebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. | +| <a id="mergerequestreviewerweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. | + +#### Fields with arguments + +##### `MergeRequestReviewer.assignedMergeRequests` + +Merge requests assigned to the user. + +Returns [`MergeRequestConnection`](#mergerequestconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -The connection type for MergeRequestReviewer. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestreviewerassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="mergerequestreviewerassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="mergerequestreviewerassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="mergerequestreviewerassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="mergerequestreviewerassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="mergerequestreviewerassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="mergerequestreviewerassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="mergerequestreviewerassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="mergerequestreviewerassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="mergerequestreviewerassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="mergerequestreviewerassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="mergerequestreviewerassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="mergerequestreviewerassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="mergerequestreviewerassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[MergeRequestReviewerEdge]`](#mergerequestrevieweredge) | A list of edges. | -| `nodes` | [`[MergeRequestReviewer]`](#mergerequestreviewer) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### `MergeRequestReviewer.authoredMergeRequests` -### `MergeRequestReviewerEdge` +Merge requests authored by the user. -An edge in a connection. +Returns [`MergeRequestConnection`](#mergerequestconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`MergeRequestReviewer`](#mergerequestreviewer) | The item at the end of the edge. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `MergeRequestReviewerRereviewPayload` +###### Arguments -Autogenerated return type of MergeRequestReviewerRereview. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestreviewerauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="mergerequestreviewerauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="mergerequestreviewerauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="mergerequestreviewerauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="mergerequestreviewerauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="mergerequestreviewerauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="mergerequestreviewerauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="mergerequestreviewerauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="mergerequestreviewerauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="mergerequestreviewerauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="mergerequestreviewerauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="mergerequestreviewerauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="mergerequestreviewerauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="mergerequestreviewerauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +##### `MergeRequestReviewer.reviewRequestedMergeRequests` -### `MergeRequestSetAssigneesPayload` +Merge requests assigned to the user for review. -Autogenerated return type of MergeRequestSetAssignees. +Returns [`MergeRequestConnection`](#mergerequestconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `MergeRequestSetLabelsPayload` +###### Arguments -Autogenerated return type of MergeRequestSetLabels. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestreviewerreviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="mergerequestreviewerreviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="mergerequestreviewerreviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="mergerequestreviewerreviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="mergerequestreviewerreviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="mergerequestreviewerreviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | + +##### `MergeRequestReviewer.snippets` + +Snippets authored by the user. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +Returns [`SnippetConnection`](#snippetconnection). -### `MergeRequestSetLockedPayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of MergeRequestSetLocked. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestreviewersnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | +| <a id="mergerequestreviewersnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | The type of snippet. | +| <a id="mergerequestreviewersnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | The visibility of the snippet. | -### `MergeRequestSetMilestonePayload` +##### `MergeRequestReviewer.starredProjects` -Autogenerated return type of MergeRequestSetMilestone. +Projects starred by the user. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +Returns [`ProjectConnection`](#projectconnection). -### `MergeRequestSetSubscriptionPayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of MergeRequestSetSubscription. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestreviewerstarredprojectssearch"></a>`search` | [`String`](#string) | Search query. | -### `MergeRequestSetWipPayload` +##### `MergeRequestReviewer.todos` -Autogenerated return type of MergeRequestSetWip. +To-do items of the user. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +Returns [`TodoConnection`](#todoconnection). -### `MergeRequestUpdatePayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of MergeRequestUpdate. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestreviewertodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | The action to be filtered. | +| <a id="mergerequestreviewertodosauthorid"></a>`authorId` | [`[ID!]`](#id) | The ID of an author. | +| <a id="mergerequestreviewertodosgroupid"></a>`groupId` | [`[ID!]`](#id) | The ID of a group. | +| <a id="mergerequestreviewertodosprojectid"></a>`projectId` | [`[ID!]`](#id) | The ID of a project. | +| <a id="mergerequestreviewertodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | The state of the todo. | +| <a id="mergerequestreviewertodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | The type of the todo. | ### `Metadata` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `revision` | [`String!`](#string) | Revision. | -| `version` | [`String!`](#string) | Version. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="metadatakas"></a>`kas` | [`Kas!`](#kas) | Metadata about KAS. | +| <a id="metadatarevision"></a>`revision` | [`String!`](#string) | Revision. | +| <a id="metadataversion"></a>`version` | [`String!`](#string) | Version. | ### `MetricImage` Represents a metric image upload. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `fileName` | [`String`](#string) | File name of the metric image. | -| `filePath` | [`String`](#string) | File path of the metric image. | -| `id` | [`ID!`](#id) | ID of the metric upload. | -| `iid` | [`ID!`](#id) | Internal ID of the metric upload. | -| `url` | [`String!`](#string) | URL of the metric source. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="metricimagefilename"></a>`fileName` | [`String`](#string) | File name of the metric image. | +| <a id="metricimagefilepath"></a>`filePath` | [`String`](#string) | File path of the metric image. | +| <a id="metricimageid"></a>`id` | [`ID!`](#id) | ID of the metric upload. | +| <a id="metricimageiid"></a>`iid` | [`ID!`](#id) | Internal ID of the metric upload. | +| <a id="metricimageurl"></a>`url` | [`String!`](#string) | URL of the metric source. | ### `MetricsDashboard` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `annotations` | [`MetricsDashboardAnnotationConnection`](#metricsdashboardannotationconnection) | Annotations added to the dashboard. | -| `path` | [`String`](#string) | Path to a file with the dashboard definition. | -| `schemaValidationWarnings` | [`[String!]`](#string) | Dashboard schema validation warnings. | +#### Fields -### `MetricsDashboardAnnotation` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="metricsdashboardpath"></a>`path` | [`String`](#string) | Path to a file with the dashboard definition. | +| <a id="metricsdashboardschemavalidationwarnings"></a>`schemaValidationWarnings` | [`[String!]`](#string) | Dashboard schema validation warnings. | + +#### Fields with arguments + +##### `MetricsDashboard.annotations` + +Annotations added to the dashboard. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the annotation. | -| `endingAt` | [`Time`](#time) | Timestamp marking end of annotated time span. | -| `id` | [`ID!`](#id) | ID of the annotation. | -| `panelId` | [`String`](#string) | ID of a dashboard panel to which the annotation should be scoped. | -| `startingAt` | [`Time`](#time) | Timestamp marking start of annotated time span. | +Returns [`MetricsDashboardAnnotationConnection`](#metricsdashboardannotationconnection). -### `MetricsDashboardAnnotationConnection` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -The connection type for MetricsDashboardAnnotation. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[MetricsDashboardAnnotationEdge]`](#metricsdashboardannotationedge) | A list of edges. | -| `nodes` | [`[MetricsDashboardAnnotation]`](#metricsdashboardannotation) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="metricsdashboardannotationsfrom"></a>`from` | [`Time!`](#time) | Timestamp marking date and time from which annotations need to be fetched. | +| <a id="metricsdashboardannotationsto"></a>`to` | [`Time`](#time) | Timestamp marking date and time to which annotations need to be fetched. | -### `MetricsDashboardAnnotationEdge` +### `MetricsDashboardAnnotation` -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`MetricsDashboardAnnotation`](#metricsdashboardannotation) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="metricsdashboardannotationdescription"></a>`description` | [`String`](#string) | Description of the annotation. | +| <a id="metricsdashboardannotationendingat"></a>`endingAt` | [`Time`](#time) | Timestamp marking end of annotated time span. | +| <a id="metricsdashboardannotationid"></a>`id` | [`ID!`](#id) | ID of the annotation. | +| <a id="metricsdashboardannotationpanelid"></a>`panelId` | [`String`](#string) | ID of a dashboard panel to which the annotation should be scoped. | +| <a id="metricsdashboardannotationstartingat"></a>`startingAt` | [`Time`](#time) | Timestamp marking start of annotated time span. | ### `Milestone` Represents a milestone. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Timestamp of milestone creation. | -| `description` | [`String`](#string) | Description of the milestone. | -| `dueDate` | [`Time`](#time) | Timestamp of the milestone due date. | -| `groupMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at group level. | -| `id` | [`ID!`](#id) | ID of the milestone. | -| `iid` | [`ID!`](#id) | Internal ID of the milestone. | -| `projectMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at project level. | -| `report` | [`TimeboxReport`](#timeboxreport) | Historically accurate report about the timebox. | -| `startDate` | [`Time`](#time) | Timestamp of the milestone start date. | -| `state` | [`MilestoneStateEnum!`](#milestonestateenum) | State of the milestone. | -| `stats` | [`MilestoneStats`](#milestonestats) | Milestone statistics. | -| `subgroupMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at subgroup level. | -| `title` | [`String!`](#string) | Title of the milestone. | -| `updatedAt` | [`Time!`](#time) | Timestamp of last milestone update. | -| `webPath` | [`String!`](#string) | Web path of the milestone. | - -### `MilestoneConnection` - -The connection type for Milestone. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[MilestoneEdge]`](#milestoneedge) | A list of edges. | -| `nodes` | [`[Milestone]`](#milestone) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `MilestoneEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Milestone`](#milestone) | The item at the end of the edge. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="milestonecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of milestone creation. | +| <a id="milestonedescription"></a>`description` | [`String`](#string) | Description of the milestone. | +| <a id="milestoneduedate"></a>`dueDate` | [`Time`](#time) | Timestamp of the milestone due date. | +| <a id="milestonegroupmilestone"></a>`groupMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at group level. | +| <a id="milestoneid"></a>`id` | [`ID!`](#id) | ID of the milestone. | +| <a id="milestoneiid"></a>`iid` | [`ID!`](#id) | Internal ID of the milestone. | +| <a id="milestoneprojectmilestone"></a>`projectMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at project level. | +| <a id="milestonereport"></a>`report` | [`TimeboxReport`](#timeboxreport) | Historically accurate report about the timebox. | +| <a id="milestonestartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the milestone start date. | +| <a id="milestonestate"></a>`state` | [`MilestoneStateEnum!`](#milestonestateenum) | State of the milestone. | +| <a id="milestonestats"></a>`stats` | [`MilestoneStats`](#milestonestats) | Milestone statistics. | +| <a id="milestonesubgroupmilestone"></a>`subgroupMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at subgroup level. | +| <a id="milestonetitle"></a>`title` | [`String!`](#string) | Title of the milestone. | +| <a id="milestoneupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of last milestone update. | +| <a id="milestonewebpath"></a>`webPath` | [`String!`](#string) | Web path of the milestone. | ### `MilestoneStats` Contains statistics about a milestone. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `closedIssuesCount` | [`Int`](#int) | Number of closed issues associated with the milestone. | -| `totalIssuesCount` | [`Int`](#int) | Total number of issues associated with the milestone. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="milestonestatsclosedissuescount"></a>`closedIssuesCount` | [`Int`](#int) | Number of closed issues associated with the milestone. | +| <a id="milestonestatstotalissuescount"></a>`totalIssuesCount` | [`Int`](#int) | Total number of issues associated with the milestone. | ### `Namespace` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `actualRepositorySizeLimit` | [`Float`](#float) | Size limit for repositories in the namespace in bytes. | -| `additionalPurchasedStorageSize` | [`Float`](#float) | Additional storage purchased for the root namespace in bytes. | -| `complianceFrameworks` | [`ComplianceFrameworkConnection`](#complianceframeworkconnection) | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. | -| `containsLockedProjects` | [`Boolean!`](#boolean) | Includes at least one project where the repository size exceeds the limit. | -| `description` | [`String`](#string) | Description of the namespace. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `fullName` | [`String!`](#string) | Full name of the namespace. | -| `fullPath` | [`ID!`](#id) | Full path of the namespace. | -| `id` | [`ID!`](#id) | ID of the namespace. | -| `isTemporaryStorageIncreaseEnabled` | [`Boolean!`](#boolean) | Status of the temporary storage increase. | -| `lfsEnabled` | [`Boolean`](#boolean) | Indicates if Large File Storage (LFS) is enabled for namespace. | -| `name` | [`String!`](#string) | Name of the namespace. | -| `packageSettings` | [`PackageSettings`](#packagesettings) | The package settings for the namespace. | -| `path` | [`String!`](#string) | Path of the namespace. | -| `projects` | [`ProjectConnection!`](#projectconnection) | Projects within this namespace. | -| `repositorySizeExcessProjectCount` | [`Int!`](#int) | Number of projects in the root namespace where the repository size exceeds the limit. | -| `requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request access to namespace. | -| `rootStorageStatistics` | [`RootStorageStatistics`](#rootstoragestatistics) | Aggregated storage statistics of the namespace. Only available for root namespaces. | -| `storageSizeLimit` | [`Float`](#float) | Total storage limit of the root namespace in bytes. | -| `temporaryStorageIncreaseEndsOn` | [`Time`](#time) | Date until the temporary storage increase is active. | -| `totalRepositorySize` | [`Float`](#float) | Total repository size of all projects in the root namespace in bytes. | -| `totalRepositorySizeExcess` | [`Float`](#float) | Total excess repository size of all projects in the root namespace in bytes. | -| `visibility` | [`String`](#string) | Visibility of the namespace. | - -### `NamespaceConnection` - -The connection type for Namespace. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[NamespaceEdge]`](#namespaceedge) | A list of edges. | -| `nodes` | [`[Namespace]`](#namespace) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `NamespaceEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Namespace`](#namespace) | The item at the end of the edge. | - -### `NamespaceIncreaseStorageTemporarilyPayload` - -Autogenerated return type of NamespaceIncreaseStorageTemporarily. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `namespace` | [`Namespace`](#namespace) | The namespace after mutation. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="namespaceactualrepositorysizelimit"></a>`actualRepositorySizeLimit` | [`Float`](#float) | Size limit for repositories in the namespace in bytes. | +| <a id="namespaceadditionalpurchasedstoragesize"></a>`additionalPurchasedStorageSize` | [`Float`](#float) | Additional storage purchased for the root namespace in bytes. | +| <a id="namespacecontainslockedprojects"></a>`containsLockedProjects` | [`Boolean!`](#boolean) | Includes at least one project where the repository size exceeds the limit. | +| <a id="namespacedescription"></a>`description` | [`String`](#string) | Description of the namespace. | +| <a id="namespacedescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="namespacefullname"></a>`fullName` | [`String!`](#string) | Full name of the namespace. | +| <a id="namespacefullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the namespace. | +| <a id="namespaceid"></a>`id` | [`ID!`](#id) | ID of the namespace. | +| <a id="namespaceistemporarystorageincreaseenabled"></a>`isTemporaryStorageIncreaseEnabled` | [`Boolean!`](#boolean) | Status of the temporary storage increase. | +| <a id="namespacelfsenabled"></a>`lfsEnabled` | [`Boolean`](#boolean) | Indicates if Large File Storage (LFS) is enabled for namespace. | +| <a id="namespacename"></a>`name` | [`String!`](#string) | Name of the namespace. | +| <a id="namespacepackagesettings"></a>`packageSettings` | [`PackageSettings`](#packagesettings) | The package settings for the namespace. | +| <a id="namespacepath"></a>`path` | [`String!`](#string) | Path of the namespace. | +| <a id="namespacerepositorysizeexcessprojectcount"></a>`repositorySizeExcessProjectCount` | [`Int!`](#int) | Number of projects in the root namespace where the repository size exceeds the limit. | +| <a id="namespacerequestaccessenabled"></a>`requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request access to namespace. | +| <a id="namespacerootstoragestatistics"></a>`rootStorageStatistics` | [`RootStorageStatistics`](#rootstoragestatistics) | Aggregated storage statistics of the namespace. Only available for root namespaces. | +| <a id="namespacestoragesizelimit"></a>`storageSizeLimit` | [`Float`](#float) | Total storage limit of the root namespace in bytes. | +| <a id="namespacetemporarystorageincreaseendson"></a>`temporaryStorageIncreaseEndsOn` | [`Time`](#time) | Date until the temporary storage increase is active. | +| <a id="namespacetotalrepositorysize"></a>`totalRepositorySize` | [`Float`](#float) | Total repository size of all projects in the root namespace in bytes. | +| <a id="namespacetotalrepositorysizeexcess"></a>`totalRepositorySizeExcess` | [`Float`](#float) | Total excess repository size of all projects in the root namespace in bytes. | +| <a id="namespacevisibility"></a>`visibility` | [`String`](#string) | Visibility of the namespace. | + +#### Fields with arguments + +##### `Namespace.complianceFrameworks` + +Compliance frameworks available to projects in this namespace. + +Returns [`ComplianceFrameworkConnection`](#complianceframeworkconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="namespacecomplianceframeworksid"></a>`id` | [`ComplianceManagementFrameworkID`](#compliancemanagementframeworkid) | Global ID of a specific compliance framework to return. | + +##### `Namespace.projects` + +Projects within this namespace. + +Returns [`ProjectConnection!`](#projectconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="namespaceprojectshascodecoverage"></a>`hasCodeCoverage` | [`Boolean`](#boolean) | Returns only the projects which have code coverage. | +| <a id="namespaceprojectshasvulnerabilities"></a>`hasVulnerabilities` | [`Boolean`](#boolean) | Returns only the projects which have vulnerabilities. | +| <a id="namespaceprojectsids"></a>`ids` | [`[ID!]`](#id) | Filter projects by IDs. | +| <a id="namespaceprojectsincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include also subgroup projects. | +| <a id="namespaceprojectssearch"></a>`search` | [`String`](#string) | Search project with most similar names or paths. | +| <a id="namespaceprojectssort"></a>`sort` | [`NamespaceProjectSort`](#namespaceprojectsort) | Sort projects by this criteria. | ### `Note` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `author` | [`User!`](#user) | User who wrote this note. | -| `body` | [`String!`](#string) | Content of the note. | -| `bodyHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `note`. | -| `confidential` | [`Boolean`](#boolean) | Indicates if this note is confidential. | -| `createdAt` | [`Time!`](#time) | Timestamp of the note creation. | -| `discussion` | [`Discussion`](#discussion) | The discussion this note is a part of. | -| `id` | [`NoteID!`](#noteid) | ID of the note. | -| `position` | [`DiffPosition`](#diffposition) | The position of this note on a diff. | -| `project` | [`Project`](#project) | Project associated with the note. | -| `resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. | -| `resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. | -| `resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. | -| `resolvedBy` | [`User`](#user) | User who resolved the object. | -| `system` | [`Boolean!`](#boolean) | Indicates whether this note was created by the system or by a user. | -| `systemNoteIconName` | [`String`](#string) | Name of the icon corresponding to a system note. | -| `updatedAt` | [`Time!`](#time) | Timestamp of the note's last activity. | -| `url` | [`String`](#string) | URL to view this Note in the Web UI. | -| `userPermissions` | [`NotePermissions!`](#notepermissions) | Permissions for the current user on the resource. | - -### `NoteConnection` - -The connection type for Note. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[NoteEdge]`](#noteedge) | A list of edges. | -| `nodes` | [`[Note]`](#note) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `NoteEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Note`](#note) | The item at the end of the edge. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="noteauthor"></a>`author` | [`UserCore!`](#usercore) | User who wrote this note. | +| <a id="notebody"></a>`body` | [`String!`](#string) | Content of the note. | +| <a id="notebodyhtml"></a>`bodyHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `note`. | +| <a id="noteconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if this note is confidential. | +| <a id="notecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the note creation. | +| <a id="notediscussion"></a>`discussion` | [`Discussion`](#discussion) | The discussion this note is a part of. | +| <a id="noteid"></a>`id` | [`NoteID!`](#noteid) | ID of the note. | +| <a id="noteposition"></a>`position` | [`DiffPosition`](#diffposition) | The position of this note on a diff. | +| <a id="noteproject"></a>`project` | [`Project`](#project) | Project associated with the note. | +| <a id="noteresolvable"></a>`resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. | +| <a id="noteresolved"></a>`resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. | +| <a id="noteresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. | +| <a id="noteresolvedby"></a>`resolvedBy` | [`UserCore`](#usercore) | User who resolved the object. | +| <a id="notesystem"></a>`system` | [`Boolean!`](#boolean) | Indicates whether this note was created by the system or by a user. | +| <a id="notesystemnoteiconname"></a>`systemNoteIconName` | [`String`](#string) | Name of the icon corresponding to a system note. | +| <a id="noteupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of the note's last activity. | +| <a id="noteurl"></a>`url` | [`String`](#string) | URL to view this Note in the Web UI. | +| <a id="noteuserpermissions"></a>`userPermissions` | [`NotePermissions!`](#notepermissions) | Permissions for the current user on the resource. | ### `NotePermissions` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminNote` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_note` on this resource. | -| `awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. | -| `createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | -| `readNote` | [`Boolean!`](#boolean) | Indicates the user can perform `read_note` on this resource. | -| `repositionNote` | [`Boolean!`](#boolean) | Indicates the user can perform `reposition_note` on this resource. | -| `resolveNote` | [`Boolean!`](#boolean) | Indicates the user can perform `resolve_note` on this resource. | +#### Fields -### `OncallParticipantType` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="notepermissionsadminnote"></a>`adminNote` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_note` on this resource. | +| <a id="notepermissionsawardemoji"></a>`awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. | +| <a id="notepermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | +| <a id="notepermissionsreadnote"></a>`readNote` | [`Boolean!`](#boolean) | Indicates the user can perform `read_note` on this resource. | +| <a id="notepermissionsrepositionnote"></a>`repositionNote` | [`Boolean!`](#boolean) | Indicates the user can perform `reposition_note` on this resource. | +| <a id="notepermissionsresolvenote"></a>`resolveNote` | [`Boolean!`](#boolean) | Indicates the user can perform `resolve_note` on this resource. | -The rotation participant and color palette. +### `NugetMetadata` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `colorPalette` | [`String`](#string) | The color palette to assign to the on-call user. For example "blue". | -| `colorWeight` | [`String`](#string) | The color weight to assign to for the on-call user, for example "500". Max 4 chars. For easy identification of the user. | -| `id` | [`IncidentManagementOncallParticipantID!`](#incidentmanagementoncallparticipantid) | ID of the on-call participant. | -| `user` | [`User!`](#user) | The user who is participating. | +Nuget metadata. -### `OncallParticipantTypeConnection` +#### Fields -The connection type for OncallParticipantType. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="nugetmetadataiconurl"></a>`iconUrl` | [`String!`](#string) | Icon URL of the Nuget package. | +| <a id="nugetmetadataid"></a>`id` | [`PackagesNugetMetadatumID!`](#packagesnugetmetadatumid) | ID of the metadatum. | +| <a id="nugetmetadatalicenseurl"></a>`licenseUrl` | [`String!`](#string) | License URL of the Nuget package. | +| <a id="nugetmetadataprojecturl"></a>`projectUrl` | [`String!`](#string) | Project URL of the Nuget package. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[OncallParticipantTypeEdge]`](#oncallparticipanttypeedge) | A list of edges. | -| `nodes` | [`[OncallParticipantType]`](#oncallparticipanttype) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `OncallParticipantType` -### `OncallParticipantTypeEdge` +The rotation participant and color palette. -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`OncallParticipantType`](#oncallparticipanttype) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="oncallparticipanttypecolorpalette"></a>`colorPalette` | [`String`](#string) | The color palette to assign to the on-call user. For example "blue". | +| <a id="oncallparticipanttypecolorweight"></a>`colorWeight` | [`String`](#string) | The color weight to assign to for the on-call user, for example "500". Max 4 chars. For easy identification of the user. | +| <a id="oncallparticipanttypeid"></a>`id` | [`IncidentManagementOncallParticipantID!`](#incidentmanagementoncallparticipantid) | ID of the on-call participant. | +| <a id="oncallparticipanttypeuser"></a>`user` | [`UserCore!`](#usercore) | The user who is participating. | ### `OncallRotationActivePeriodType` Active period time range for on-call rotation. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `endTime` | [`String`](#string) | The end of the rotation active period. | -| `startTime` | [`String`](#string) | The start of the rotation active period. | +#### Fields -### `OncallRotationCreatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="oncallrotationactiveperiodtypeendtime"></a>`endTime` | [`String`](#string) | The end of the rotation active period. | +| <a id="oncallrotationactiveperiodtypestarttime"></a>`startTime` | [`String`](#string) | The start of the rotation active period. | -Autogenerated return type of OncallRotationCreate. +### `Package` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The on-call rotation. | +Represents a package in the Package Registry. Note that this type is in beta and susceptible to changes. -### `OncallRotationDestroyPayload` +#### Fields -Autogenerated return type of OncallRotationDestroy. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagecreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. | +| <a id="packageid"></a>`id` | [`PackagesPackageID!`](#packagespackageid) | ID of the package. | +| <a id="packagemetadata"></a>`metadata` | [`PackageMetadata`](#packagemetadata) | Package metadata. | +| <a id="packagename"></a>`name` | [`String!`](#string) | Name of the package. | +| <a id="packagepackagetype"></a>`packageType` | [`PackageTypeEnum!`](#packagetypeenum) | Package type. | +| <a id="packagepipelines"></a>`pipelines` | [`PipelineConnection`](#pipelineconnection) | Pipelines that built the package. (see [Connections](#connections)) | +| <a id="packageproject"></a>`project` | [`Project!`](#project) | Project where the package is stored. | +| <a id="packagestatus"></a>`status` | [`PackageStatus!`](#packagestatus) | Package status. | +| <a id="packagetags"></a>`tags` | [`PackageTagConnection`](#packagetagconnection) | Package tags. (see [Connections](#connections)) | +| <a id="packageupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. | +| <a id="packageversion"></a>`version` | [`String`](#string) | Version string. | +| <a id="packageversions"></a>`versions` **{warning-solid}** | [`PackageConnection`](#packageconnection) | **Deprecated** in 13.11. This field is now only returned in the PackageDetailsType. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The on-call rotation. | +### `PackageComposerJsonType` -### `OncallRotationUpdatePayload` +Represents a composer JSON file. -Autogenerated return type of OncallRotationUpdate. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The on-call rotation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagecomposerjsontypelicense"></a>`license` | [`String`](#string) | The license set in the Composer JSON file. | +| <a id="packagecomposerjsontypename"></a>`name` | [`String`](#string) | The name set in the Composer JSON file. | +| <a id="packagecomposerjsontypetype"></a>`type` | [`String`](#string) | The type set in the Composer JSON file. | +| <a id="packagecomposerjsontypeversion"></a>`version` | [`String`](#string) | The version set in the Composer JSON file. | -### `OncallScheduleCreatePayload` +### `PackageDetailsType` -Autogenerated return type of OncallScheduleCreate. +Represents a package details in the Package Registry. Note that this type is in beta and susceptible to changes. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The on-call schedule. | +#### Fields -### `OncallScheduleDestroyPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagedetailstypecreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. | +| <a id="packagedetailstypeid"></a>`id` | [`PackagesPackageID!`](#packagespackageid) | ID of the package. | +| <a id="packagedetailstypemetadata"></a>`metadata` | [`PackageMetadata`](#packagemetadata) | Package metadata. | +| <a id="packagedetailstypename"></a>`name` | [`String!`](#string) | Name of the package. | +| <a id="packagedetailstypepackagefiles"></a>`packageFiles` | [`PackageFileConnection`](#packagefileconnection) | Package files. (see [Connections](#connections)) | +| <a id="packagedetailstypepackagetype"></a>`packageType` | [`PackageTypeEnum!`](#packagetypeenum) | Package type. | +| <a id="packagedetailstypepipelines"></a>`pipelines` | [`PipelineConnection`](#pipelineconnection) | Pipelines that built the package. (see [Connections](#connections)) | +| <a id="packagedetailstypeproject"></a>`project` | [`Project!`](#project) | Project where the package is stored. | +| <a id="packagedetailstypestatus"></a>`status` | [`PackageStatus!`](#packagestatus) | Package status. | +| <a id="packagedetailstypetags"></a>`tags` | [`PackageTagConnection`](#packagetagconnection) | Package tags. (see [Connections](#connections)) | +| <a id="packagedetailstypeupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. | +| <a id="packagedetailstypeversion"></a>`version` | [`String`](#string) | Version string. | +| <a id="packagedetailstypeversions"></a>`versions` | [`PackageConnection`](#packageconnection) | The other versions of the package. (see [Connections](#connections)) | -Autogenerated return type of OncallScheduleDestroy. +### `PackageFile` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The on-call schedule. | +Represents a package file. -### `OncallScheduleUpdatePayload` +#### Fields -Autogenerated return type of OncallScheduleUpdate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagefilecreatedat"></a>`createdAt` | [`Time!`](#time) | The created date. | +| <a id="packagefiledownloadpath"></a>`downloadPath` | [`String!`](#string) | Download path of the package file. | +| <a id="packagefilefilemd5"></a>`fileMd5` | [`String`](#string) | Md5 of the package file. | +| <a id="packagefilefilemetadata"></a>`fileMetadata` | [`PackageFileMetadata`](#packagefilemetadata) | File metadata. | +| <a id="packagefilefilename"></a>`fileName` | [`String!`](#string) | Name of the package file. | +| <a id="packagefilefilesha1"></a>`fileSha1` | [`String`](#string) | Sha1 of the package file. | +| <a id="packagefilefilesha256"></a>`fileSha256` | [`String`](#string) | Sha256 of the package file. | +| <a id="packagefileid"></a>`id` | [`PackagesPackageFileID!`](#packagespackagefileid) | ID of the file. | +| <a id="packagefilesize"></a>`size` | [`String!`](#string) | Size of the package file. | +| <a id="packagefileupdatedat"></a>`updatedAt` | [`Time!`](#time) | The updated date. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The on-call schedule. | +### `PackageFileRegistry` -### `Package` +Represents the Geo sync and verification state of a package file. -Represents a package in the Package Registry. Note that this type is in beta and susceptible to changes. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Date of creation. | -| `id` | [`PackagesPackageID!`](#packagespackageid) | ID of the package. | -| `metadata` | [`PackageMetadata`](#packagemetadata) | Package metadata. | -| `name` | [`String!`](#string) | Name of the package. | -| `packageType` | [`PackageTypeEnum!`](#packagetypeenum) | Package type. | -| `pipelines` | [`PipelineConnection`](#pipelineconnection) | Pipelines that built the package. | -| `project` | [`Project!`](#project) | Project where the package is stored. | -| `tags` | [`PackageTagConnection`](#packagetagconnection) | Package tags. | -| `updatedAt` | [`Time!`](#time) | Date of most recent update. | -| `version` | [`String`](#string) | Version string. | -| `versions` **{warning-solid}** | [`PackageConnection`](#packageconnection) | **Deprecated** in 13.11. This field is now only returned in the PackageDetailsType. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagefileregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the PackageFileRegistry was created. | +| <a id="packagefileregistryid"></a>`id` | [`ID!`](#id) | ID of the PackageFileRegistry. | +| <a id="packagefileregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the PackageFileRegistry. | +| <a id="packagefileregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the PackageFileRegistry. | +| <a id="packagefileregistrypackagefileid"></a>`packageFileId` | [`ID!`](#id) | ID of the PackageFile. | +| <a id="packagefileregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the PackageFileRegistry should be resynced. | +| <a id="packagefileregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the PackageFileRegistry. | +| <a id="packagefileregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the PackageFileRegistry. | -### `PackageComposerJsonType` +### `PackageSettings` -Represents a composer JSON file. +Namespace-level Package Registry settings. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `license` | [`String`](#string) | The license set in the Composer JSON file. | -| `name` | [`String`](#string) | The name set in the Composer JSON file. | -| `type` | [`String`](#string) | The type set in the Composer JSON file. | -| `version` | [`String`](#string) | The version set in the Composer JSON file. | +#### Fields -### `PackageConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagesettingsgenericduplicateexceptionregex"></a>`genericDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. | +| <a id="packagesettingsgenericduplicatesallowed"></a>`genericDuplicatesAllowed` | [`Boolean!`](#boolean) | Indicates whether duplicate generic packages are allowed for this namespace. | +| <a id="packagesettingsmavenduplicateexceptionregex"></a>`mavenDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. | +| <a id="packagesettingsmavenduplicatesallowed"></a>`mavenDuplicatesAllowed` | [`Boolean!`](#boolean) | Indicates whether duplicate Maven packages are allowed for this namespace. | -The connection type for Package. +### `PackageTag` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[PackageEdge]`](#packageedge) | A list of edges. | -| `nodes` | [`[Package]`](#package) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Represents a package tag. -### `PackageDetailsType` +#### Fields -Represents a package details in the Package Registry. Note that this type is in beta and susceptible to changes. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagetagcreatedat"></a>`createdAt` | [`Time!`](#time) | The created date. | +| <a id="packagetagid"></a>`id` | [`ID!`](#id) | The ID of the tag. | +| <a id="packagetagname"></a>`name` | [`String!`](#string) | The name of the tag. | +| <a id="packagetagupdatedat"></a>`updatedAt` | [`Time!`](#time) | The updated date. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Date of creation. | -| `id` | [`PackagesPackageID!`](#packagespackageid) | ID of the package. | -| `metadata` | [`PackageMetadata`](#packagemetadata) | Package metadata. | -| `name` | [`String!`](#string) | Name of the package. | -| `packageFiles` | [`PackageFileConnection`](#packagefileconnection) | Package files. | -| `packageType` | [`PackageTypeEnum!`](#packagetypeenum) | Package type. | -| `pipelines` | [`PipelineConnection`](#pipelineconnection) | Pipelines that built the package. | -| `project` | [`Project!`](#project) | Project where the package is stored. | -| `tags` | [`PackageTagConnection`](#packagetagconnection) | Package tags. | -| `updatedAt` | [`Time!`](#time) | Date of most recent update. | -| `version` | [`String`](#string) | Version string. | -| `versions` | [`PackageConnection`](#packageconnection) | The other versions of the package. | - -### `PackageEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Package`](#package) | The item at the end of the edge. | +### `PageInfo` -### `PackageFile` +Information about pagination in a connection. -Represents a package file. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | The created date. | -| `downloadPath` | [`String!`](#string) | Download path of the package file. | -| `fileMd5` | [`String`](#string) | Md5 of the package file. | -| `fileMetadata` | [`PackageFileMetadata`](#packagefilemetadata) | File metadata. | -| `fileName` | [`String!`](#string) | Name of the package file. | -| `fileSha1` | [`String`](#string) | Sha1 of the package file. | -| `fileSha256` | [`String`](#string) | Sha256 of the package file. | -| `id` | [`PackagesPackageFileID!`](#packagespackagefileid) | ID of the file. | -| `size` | [`String!`](#string) | Size of the package file. | -| `updatedAt` | [`Time!`](#time) | The updated date. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pageinfoendcursor"></a>`endCursor` | [`String`](#string) | When paginating forwards, the cursor to continue. | +| <a id="pageinfohasnextpage"></a>`hasNextPage` | [`Boolean!`](#boolean) | When paginating forwards, are there more items?. | +| <a id="pageinfohaspreviouspage"></a>`hasPreviousPage` | [`Boolean!`](#boolean) | When paginating backwards, are there more items?. | +| <a id="pageinfostartcursor"></a>`startCursor` | [`String`](#string) | When paginating backwards, the cursor to continue. | -### `PackageFileConnection` +### `PathLock` -The connection type for PackageFile. +Represents a file or directory in the project repository that has been locked. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[PackageFileEdge]`](#packagefileedge) | A list of edges. | -| `nodes` | [`[PackageFile]`](#packagefile) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### Fields -### `PackageFileEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pathlockid"></a>`id` | [`PathLockID!`](#pathlockid) | ID of the path lock. | +| <a id="pathlockpath"></a>`path` | [`String`](#string) | The locked path. | +| <a id="pathlockuser"></a>`user` | [`UserCore`](#usercore) | The user that has locked this path. | -An edge in a connection. +### `Pipeline` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`PackageFile`](#packagefile) | The item at the end of the edge. | +#### Fields -### `PackageFileRegistry` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelineactive"></a>`active` | [`Boolean!`](#boolean) | Indicates if the pipeline is active. | +| <a id="pipelinebeforesha"></a>`beforeSha` | [`String`](#string) | Base SHA of the source branch. | +| <a id="pipelinecancelable"></a>`cancelable` | [`Boolean!`](#boolean) | Specifies if a pipeline can be canceled. | +| <a id="pipelinecodequalityreports"></a>`codeQualityReports` | [`CodeQualityDegradationConnection`](#codequalitydegradationconnection) | Code Quality degradations reported on the pipeline. (see [Connections](#connections)) | +| <a id="pipelinecommitpath"></a>`commitPath` | [`String`](#string) | Path to the commit that triggered the pipeline. | +| <a id="pipelinecommittedat"></a>`committedAt` | [`Time`](#time) | Timestamp of the pipeline's commit. | +| <a id="pipelinecomplete"></a>`complete` | [`Boolean!`](#boolean) | Indicates if a pipeline is complete. | +| <a id="pipelineconfigsource"></a>`configSource` | [`PipelineConfigSourceEnum`](#pipelineconfigsourceenum) | Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE). | +| <a id="pipelinecoverage"></a>`coverage` | [`Float`](#float) | Coverage percentage. | +| <a id="pipelinecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the pipeline's creation. | +| <a id="pipelinedetailedstatus"></a>`detailedStatus` | [`DetailedStatus!`](#detailedstatus) | Detailed status of the pipeline. | +| <a id="pipelinedownstream"></a>`downstream` | [`PipelineConnection`](#pipelineconnection) | Pipelines this pipeline will trigger. (see [Connections](#connections)) | +| <a id="pipelineduration"></a>`duration` | [`Int`](#int) | Duration of the pipeline in seconds. | +| <a id="pipelinefinishedat"></a>`finishedAt` | [`Time`](#time) | Timestamp of the pipeline's completion. | +| <a id="pipelineid"></a>`id` | [`ID!`](#id) | ID of the pipeline. | +| <a id="pipelineiid"></a>`iid` | [`String!`](#string) | Internal ID of the pipeline. | +| <a id="pipelinepath"></a>`path` | [`String`](#string) | Relative path to the pipeline's page. | +| <a id="pipelineproject"></a>`project` | [`Project`](#project) | Project the pipeline belongs to. | +| <a id="pipelinequeuedduration"></a>`queuedDuration` | [`Duration`](#duration) | How long the pipeline was queued before starting. | +| <a id="pipelineretryable"></a>`retryable` | [`Boolean!`](#boolean) | Specifies if a pipeline can be retried. | +| <a id="pipelinesecurityreportsummary"></a>`securityReportSummary` | [`SecurityReportSummary`](#securityreportsummary) | Vulnerability and scanned resource counts for each security scanner of the pipeline. | +| <a id="pipelinesha"></a>`sha` | [`String!`](#string) | SHA of the pipeline's commit. | +| <a id="pipelinesourcejob"></a>`sourceJob` | [`CiJob`](#cijob) | Job where pipeline was triggered from. | +| <a id="pipelinestages"></a>`stages` | [`CiStageConnection`](#cistageconnection) | Stages of the pipeline. (see [Connections](#connections)) | +| <a id="pipelinestartedat"></a>`startedAt` | [`Time`](#time) | Timestamp when the pipeline was started. | +| <a id="pipelinestatus"></a>`status` | [`PipelineStatusEnum!`](#pipelinestatusenum) | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED). | +| <a id="pipelinetestreportsummary"></a>`testReportSummary` | [`TestReportSummary!`](#testreportsummary) | Summary of the test report generated by the pipeline. | +| <a id="pipelineupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of the pipeline's last activity. | +| <a id="pipelineupstream"></a>`upstream` | [`Pipeline`](#pipeline) | Pipeline that triggered the pipeline. | +| <a id="pipelineuser"></a>`user` | [`UserCore`](#usercore) | Pipeline user. | +| <a id="pipelineuserpermissions"></a>`userPermissions` | [`PipelinePermissions!`](#pipelinepermissions) | Permissions for the current user on the resource. | +| <a id="pipelineusesneeds"></a>`usesNeeds` | [`Boolean`](#boolean) | Indicates if the pipeline has jobs with `needs` dependencies. | +| <a id="pipelinewarnings"></a>`warnings` | [`Boolean!`](#boolean) | Indicates if a pipeline has warnings. | + +#### Fields with arguments + +##### `Pipeline.job` + +A specific job in this pipeline, either by name or ID. + +Returns [`CiJob`](#cijob). + +###### Arguments -Represents the Geo sync and verification state of a package file. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinejobid"></a>`id` | [`JobID`](#jobid) | ID of the job. | +| <a id="pipelinejobname"></a>`name` | [`String`](#string) | Name of the job. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp when the PackageFileRegistry was created. | -| `id` | [`ID!`](#id) | ID of the PackageFileRegistry. | -| `lastSyncFailure` | [`String`](#string) | Error message during sync of the PackageFileRegistry. | -| `lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the PackageFileRegistry. | -| `packageFileId` | [`ID!`](#id) | ID of the PackageFile. | -| `retryAt` | [`Time`](#time) | Timestamp after which the PackageFileRegistry should be resynced. | -| `retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the PackageFileRegistry. | -| `state` | [`RegistryState`](#registrystate) | Sync state of the PackageFileRegistry. | +##### `Pipeline.jobs` -### `PackageFileRegistryConnection` +Jobs belonging to the pipeline. -The connection type for PackageFileRegistry. +Returns [`CiJobConnection`](#cijobconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[PackageFileRegistryEdge]`](#packagefileregistryedge) | A list of edges. | -| `nodes` | [`[PackageFileRegistry]`](#packagefileregistry) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `PackageFileRegistryEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinejobssecurityreporttypes"></a>`securityReportTypes` | [`[SecurityReportTypeEnum!]`](#securityreporttypeenum) | Filter jobs by the type of security report they produce. | +| <a id="pipelinejobsstatuses"></a>`statuses` | [`[CiJobStatus!]`](#cijobstatus) | Filter jobs by status. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`PackageFileRegistry`](#packagefileregistry) | The item at the end of the edge. | +##### `Pipeline.securityReportFindings` -### `PackageSettings` +Vulnerability findings reported on the pipeline. -Namespace-level Package Registry settings. +Returns [`PipelineSecurityReportFindingConnection`](#pipelinesecurityreportfindingconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `mavenDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. | -| `mavenDuplicatesAllowed` | [`Boolean!`](#boolean) | Indicates whether duplicate Maven packages are allowed for this namespace. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `PackageTag` +###### Arguments -Represents a package tag. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinesecurityreportfindingsreporttype"></a>`reportType` | [`[String!]`](#string) | Filter vulnerability findings by report type. | +| <a id="pipelinesecurityreportfindingsscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerability findings by Scanner.externalId. | +| <a id="pipelinesecurityreportfindingsseverity"></a>`severity` | [`[String!]`](#string) | Filter vulnerability findings by severity. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | The created date. | -| `id` | [`ID!`](#id) | The ID of the tag. | -| `name` | [`String!`](#string) | The name of the tag. | -| `updatedAt` | [`Time!`](#time) | The updated date. | +##### `Pipeline.testSuite` -### `PackageTagConnection` +A specific test suite in a pipeline test report. -The connection type for PackageTag. +Returns [`TestSuite`](#testsuite). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[PackageTagEdge]`](#packagetagedge) | A list of edges. | -| `nodes` | [`[PackageTag]`](#packagetag) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +###### Arguments -### `PackageTagEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinetestsuitebuildids"></a>`buildIds` | [`[ID!]!`](#id) | IDs of the builds used to run the test suite. | -An edge in a connection. +### `PipelineAnalytics` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`PackageTag`](#packagetag) | The item at the end of the edge. | +#### Fields -### `PageInfo` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelineanalyticsmonthpipelineslabels"></a>`monthPipelinesLabels` | [`[String!]`](#string) | Labels for the monthly pipeline count. | +| <a id="pipelineanalyticsmonthpipelinessuccessful"></a>`monthPipelinesSuccessful` | [`[Int!]`](#int) | Total monthly successful pipeline count. | +| <a id="pipelineanalyticsmonthpipelinestotals"></a>`monthPipelinesTotals` | [`[Int!]`](#int) | Total monthly pipeline count. | +| <a id="pipelineanalyticspipelinetimeslabels"></a>`pipelineTimesLabels` | [`[String!]`](#string) | Pipeline times labels. | +| <a id="pipelineanalyticspipelinetimesvalues"></a>`pipelineTimesValues` | [`[Int!]`](#int) | Pipeline times. | +| <a id="pipelineanalyticsweekpipelineslabels"></a>`weekPipelinesLabels` | [`[String!]`](#string) | Labels for the weekly pipeline count. | +| <a id="pipelineanalyticsweekpipelinessuccessful"></a>`weekPipelinesSuccessful` | [`[Int!]`](#int) | Total weekly successful pipeline count. | +| <a id="pipelineanalyticsweekpipelinestotals"></a>`weekPipelinesTotals` | [`[Int!]`](#int) | Total weekly pipeline count. | +| <a id="pipelineanalyticsyearpipelineslabels"></a>`yearPipelinesLabels` | [`[String!]`](#string) | Labels for the yearly pipeline count. | +| <a id="pipelineanalyticsyearpipelinessuccessful"></a>`yearPipelinesSuccessful` | [`[Int!]`](#int) | Total yearly successful pipeline count. | +| <a id="pipelineanalyticsyearpipelinestotals"></a>`yearPipelinesTotals` | [`[Int!]`](#int) | Total yearly pipeline count. | -Information about pagination in a connection. +### `PipelineArtifactRegistry` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `endCursor` | [`String`](#string) | When paginating forwards, the cursor to continue. | -| `hasNextPage` | [`Boolean!`](#boolean) | When paginating forwards, are there more items?. | -| `hasPreviousPage` | [`Boolean!`](#boolean) | When paginating backwards, are there more items?. | -| `startCursor` | [`String`](#string) | When paginating backwards, the cursor to continue. | +Represents the Geo sync and verification state of a pipeline artifact. -### `Pipeline` +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean!`](#boolean) | Indicates if the pipeline is active. | -| `beforeSha` | [`String`](#string) | Base SHA of the source branch. | -| `cancelable` | [`Boolean!`](#boolean) | Specifies if a pipeline can be canceled. | -| `commitPath` | [`String`](#string) | Path to the commit that triggered the pipeline. | -| `committedAt` | [`Time`](#time) | Timestamp of the pipeline's commit. | -| `configSource` | [`PipelineConfigSourceEnum`](#pipelineconfigsourceenum) | Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE). | -| `coverage` | [`Float`](#float) | Coverage percentage. | -| `createdAt` | [`Time!`](#time) | Timestamp of the pipeline's creation. | -| `detailedStatus` | [`DetailedStatus!`](#detailedstatus) | Detailed status of the pipeline. | -| `downstream` | [`PipelineConnection`](#pipelineconnection) | Pipelines this pipeline will trigger. | -| `duration` | [`Int`](#int) | Duration of the pipeline in seconds. | -| `finishedAt` | [`Time`](#time) | Timestamp of the pipeline's completion. | -| `id` | [`ID!`](#id) | ID of the pipeline. | -| `iid` | [`String!`](#string) | Internal ID of the pipeline. | -| `job` | [`CiJob`](#cijob) | A specific job in this pipeline, either by name or ID. | -| `jobs` | [`CiJobConnection`](#cijobconnection) | Jobs belonging to the pipeline. | -| `path` | [`String`](#string) | Relative path to the pipeline's page. | -| `project` | [`Project`](#project) | Project the pipeline belongs to. | -| `retryable` | [`Boolean!`](#boolean) | Specifies if a pipeline can be retried. | -| `securityReportFindings` | [`PipelineSecurityReportFindingConnection`](#pipelinesecurityreportfindingconnection) | Vulnerability findings reported on the pipeline. | -| `securityReportSummary` | [`SecurityReportSummary`](#securityreportsummary) | Vulnerability and scanned resource counts for each security scanner of the pipeline. | -| `sha` | [`String!`](#string) | SHA of the pipeline's commit. | -| `sourceJob` | [`CiJob`](#cijob) | Job where pipeline was triggered from. | -| `stages` | [`CiStageConnection`](#cistageconnection) | Stages of the pipeline. | -| `startedAt` | [`Time`](#time) | Timestamp when the pipeline was started. | -| `status` | [`PipelineStatusEnum!`](#pipelinestatusenum) | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED). | -| `testReportSummary` | [`TestReportSummary!`](#testreportsummary) | Summary of the test report generated by the pipeline. | -| `testSuite` | [`TestSuite`](#testsuite) | A specific test suite in a pipeline test report. | -| `updatedAt` | [`Time!`](#time) | Timestamp of the pipeline's last activity. | -| `upstream` | [`Pipeline`](#pipeline) | Pipeline that triggered the pipeline. | -| `user` | [`User`](#user) | Pipeline user. | -| `userPermissions` | [`PipelinePermissions!`](#pipelinepermissions) | Permissions for the current user on the resource. | -| `usesNeeds` | [`Boolean`](#boolean) | Indicates if the pipeline has jobs with `needs` dependencies. | -| `warnings` | [`Boolean!`](#boolean) | Indicates if a pipeline has warnings. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelineartifactregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the PipelineArtifactRegistry was created. | +| <a id="pipelineartifactregistryid"></a>`id` | [`ID!`](#id) | ID of the PipelineArtifactRegistry. | +| <a id="pipelineartifactregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the PipelineArtifactRegistry. | +| <a id="pipelineartifactregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the PipelineArtifactRegistry. | +| <a id="pipelineartifactregistrypipelineartifactid"></a>`pipelineArtifactId` | [`ID!`](#id) | ID of the pipeline artifact. | +| <a id="pipelineartifactregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the PipelineArtifactRegistry should be resynced. | +| <a id="pipelineartifactregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the PipelineArtifactRegistry. | +| <a id="pipelineartifactregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the PipelineArtifactRegistry. | -### `PipelineAnalytics` +### `PipelinePermissions` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `monthPipelinesLabels` | [`[String!]`](#string) | Labels for the monthly pipeline count. | -| `monthPipelinesSuccessful` | [`[Int!]`](#int) | Total monthly successful pipeline count. | -| `monthPipelinesTotals` | [`[Int!]`](#int) | Total monthly pipeline count. | -| `pipelineTimesLabels` | [`[String!]`](#string) | Pipeline times labels. | -| `pipelineTimesValues` | [`[Int!]`](#int) | Pipeline times. | -| `weekPipelinesLabels` | [`[String!]`](#string) | Labels for the weekly pipeline count. | -| `weekPipelinesSuccessful` | [`[Int!]`](#int) | Total weekly successful pipeline count. | -| `weekPipelinesTotals` | [`[Int!]`](#int) | Total weekly pipeline count. | -| `yearPipelinesLabels` | [`[String!]`](#string) | Labels for the yearly pipeline count. | -| `yearPipelinesSuccessful` | [`[Int!]`](#int) | Total yearly successful pipeline count. | -| `yearPipelinesTotals` | [`[Int!]`](#int) | Total yearly pipeline count. | +#### Fields -### `PipelineArtifactRegistry` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinepermissionsadminpipeline"></a>`adminPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_pipeline` on this resource. | +| <a id="pipelinepermissionsdestroypipeline"></a>`destroyPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_pipeline` on this resource. | +| <a id="pipelinepermissionsupdatepipeline"></a>`updatePipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `update_pipeline` on this resource. | -Represents the Geo sync and verification state of a pipeline artifact. +### `PipelineSecurityReportFinding` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp when the PipelineArtifactRegistry was created. | -| `id` | [`ID!`](#id) | ID of the PipelineArtifactRegistry. | -| `lastSyncFailure` | [`String`](#string) | Error message during sync of the PipelineArtifactRegistry. | -| `lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the PipelineArtifactRegistry. | -| `pipelineArtifactId` | [`ID!`](#id) | ID of the pipeline artifact. | -| `retryAt` | [`Time`](#time) | Timestamp after which the PipelineArtifactRegistry should be resynced. | -| `retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the PipelineArtifactRegistry. | -| `state` | [`RegistryState`](#registrystate) | Sync state of the PipelineArtifactRegistry. | +Represents vulnerability finding of a security report on the pipeline. -### `PipelineArtifactRegistryConnection` +#### Fields -The connection type for PipelineArtifactRegistry. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinesecurityreportfindingconfidence"></a>`confidence` | [`String`](#string) | Type of the security report that found the vulnerability. | +| <a id="pipelinesecurityreportfindingdescription"></a>`description` | [`String`](#string) | Description of the vulnerability finding. | +| <a id="pipelinesecurityreportfindingidentifiers"></a>`identifiers` | [`[VulnerabilityIdentifier!]!`](#vulnerabilityidentifier) | Identifiers of the vulnerabilit finding. | +| <a id="pipelinesecurityreportfindinglocation"></a>`location` | [`VulnerabilityLocation`](#vulnerabilitylocation) | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. | +| <a id="pipelinesecurityreportfindingname"></a>`name` | [`String`](#string) | Name of the vulnerability finding. | +| <a id="pipelinesecurityreportfindingproject"></a>`project` | [`Project`](#project) | The project on which the vulnerability finding was found. | +| <a id="pipelinesecurityreportfindingprojectfingerprint"></a>`projectFingerprint` | [`String`](#string) | Name of the vulnerability finding. | +| <a id="pipelinesecurityreportfindingreporttype"></a>`reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the security report that found the vulnerability finding. | +| <a id="pipelinesecurityreportfindingscanner"></a>`scanner` | [`VulnerabilityScanner`](#vulnerabilityscanner) | Scanner metadata for the vulnerability. | +| <a id="pipelinesecurityreportfindingseverity"></a>`severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability finding. | +| <a id="pipelinesecurityreportfindingsolution"></a>`solution` | [`String`](#string) | URL to the vulnerability's details page. | +| <a id="pipelinesecurityreportfindinguuid"></a>`uuid` | [`String`](#string) | Name of the vulnerability finding. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[PipelineArtifactRegistryEdge]`](#pipelineartifactregistryedge) | A list of edges. | -| `nodes` | [`[PipelineArtifactRegistry]`](#pipelineartifactregistry) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `Project` -### `PipelineArtifactRegistryEdge` +#### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectactualrepositorysizelimit"></a>`actualRepositorySizeLimit` | [`Float`](#float) | Size limit for the repository in bytes. | +| <a id="projectallowmergeonskippedpipeline"></a>`allowMergeOnSkippedPipeline` | [`Boolean`](#boolean) | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs. | +| <a id="projectapifuzzingciconfiguration"></a>`apiFuzzingCiConfiguration` | [`ApiFuzzingCiConfiguration`](#apifuzzingciconfiguration) | API fuzzing configuration for the project. | +| <a id="projectarchived"></a>`archived` | [`Boolean`](#boolean) | Indicates the archived status of the project. | +| <a id="projectautoclosereferencedissues"></a>`autocloseReferencedIssues` | [`Boolean`](#boolean) | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically. | +| <a id="projectavatarurl"></a>`avatarUrl` | [`String`](#string) | URL to avatar image file of the project. | +| <a id="projectcicdsettings"></a>`ciCdSettings` | [`ProjectCiCdSetting`](#projectcicdsetting) | CI/CD settings for the project. | +| <a id="projectclusteragents"></a>`clusterAgents` | [`ClusterAgentConnection`](#clusteragentconnection) | Cluster agents associated with the project. (see [Connections](#connections)) | +| <a id="projectcodecoveragesummary"></a>`codeCoverageSummary` | [`CodeCoverageSummary`](#codecoveragesummary) | Code coverage summary associated with the project. | +| <a id="projectcomplianceframeworks"></a>`complianceFrameworks` | [`ComplianceFrameworkConnection`](#complianceframeworkconnection) | Compliance frameworks associated with the project. (see [Connections](#connections)) | +| <a id="projectcontainerexpirationpolicy"></a>`containerExpirationPolicy` | [`ContainerExpirationPolicy`](#containerexpirationpolicy) | The container expiration policy of the project. | +| <a id="projectcontainerregistryenabled"></a>`containerRegistryEnabled` | [`Boolean`](#boolean) | Indicates if the project stores Docker container images in a container registry. | +| <a id="projectcontainerrepositoriescount"></a>`containerRepositoriesCount` | [`Int!`](#int) | Number of container repositories in the project. | +| <a id="projectcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of the project creation. | +| <a id="projectdastprofiles"></a>`dastProfiles` | [`DastProfileConnection`](#dastprofileconnection) | DAST Profiles associated with the project. (see [Connections](#connections)) | +| <a id="projectdastscannerprofiles"></a>`dastScannerProfiles` | [`DastScannerProfileConnection`](#dastscannerprofileconnection) | The DAST scanner profiles associated with the project. (see [Connections](#connections)) | +| <a id="projectdastsiteprofiles"></a>`dastSiteProfiles` | [`DastSiteProfileConnection`](#dastsiteprofileconnection) | DAST Site Profiles associated with the project. (see [Connections](#connections)) | +| <a id="projectdescription"></a>`description` | [`String`](#string) | Short description of the project. | +| <a id="projectdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="projectforkscount"></a>`forksCount` | [`Int!`](#int) | Number of times the project has been forked. | +| <a id="projectfullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the project. | +| <a id="projectgrafanaintegration"></a>`grafanaIntegration` | [`GrafanaIntegration`](#grafanaintegration) | Grafana integration details for the project. | +| <a id="projectgroup"></a>`group` | [`Group`](#group) | Group of the project. | +| <a id="projecthttpurltorepo"></a>`httpUrlToRepo` | [`String`](#string) | URL to connect to the project via HTTPS. | +| <a id="projectid"></a>`id` | [`ID!`](#id) | ID of the project. | +| <a id="projectimportstatus"></a>`importStatus` | [`String`](#string) | Status of import background job of the project. | +| <a id="projectissuesenabled"></a>`issuesEnabled` | [`Boolean`](#boolean) | Indicates if Issues are enabled for the current user. | +| <a id="projectjiraimportstatus"></a>`jiraImportStatus` | [`String`](#string) | Status of Jira import background job of the project. | +| <a id="projectjiraimports"></a>`jiraImports` | [`JiraImportConnection`](#jiraimportconnection) | Jira imports into the project. (see [Connections](#connections)) | +| <a id="projectjobsenabled"></a>`jobsEnabled` | [`Boolean`](#boolean) | Indicates if CI/CD pipeline jobs are enabled for the current user. | +| <a id="projectlastactivityat"></a>`lastActivityAt` | [`Time`](#time) | Timestamp of the project last activity. | +| <a id="projectlfsenabled"></a>`lfsEnabled` | [`Boolean`](#boolean) | Indicates if the project has Large File Storage (LFS) enabled. | +| <a id="projectmergerequestsenabled"></a>`mergeRequestsEnabled` | [`Boolean`](#boolean) | Indicates if Merge Requests are enabled for the current user. | +| <a id="projectmergerequestsffonlyenabled"></a>`mergeRequestsFfOnlyEnabled` | [`Boolean`](#boolean) | Indicates if no merge commits should be created and all merges should instead be fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded. | +| <a id="projectname"></a>`name` | [`String!`](#string) | Name of the project (without namespace). | +| <a id="projectnamewithnamespace"></a>`nameWithNamespace` | [`String!`](#string) | Full name of the project with its namespace. | +| <a id="projectnamespace"></a>`namespace` | [`Namespace`](#namespace) | Namespace of the project. | +| <a id="projectonlyallowmergeifalldiscussionsareresolved"></a>`onlyAllowMergeIfAllDiscussionsAreResolved` | [`Boolean`](#boolean) | Indicates if merge requests of the project can only be merged when all the discussions are resolved. | +| <a id="projectonlyallowmergeifpipelinesucceeds"></a>`onlyAllowMergeIfPipelineSucceeds` | [`Boolean`](#boolean) | Indicates if merge requests of the project can only be merged with successful jobs. | +| <a id="projectopenissuescount"></a>`openIssuesCount` | [`Int`](#int) | Number of open issues for the project. | +| <a id="projectpath"></a>`path` | [`String!`](#string) | Path of the project. | +| <a id="projectpathlocks"></a>`pathLocks` | [`PathLockConnection`](#pathlockconnection) | The project's path locks. (see [Connections](#connections)) | +| <a id="projectpipelineanalytics"></a>`pipelineAnalytics` | [`PipelineAnalytics`](#pipelineanalytics) | Pipeline analytics. | +| <a id="projectprintingmergerequestlinkenabled"></a>`printingMergeRequestLinkEnabled` | [`Boolean`](#boolean) | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line. | +| <a id="projectpublicjobs"></a>`publicJobs` | [`Boolean`](#boolean) | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. | +| <a id="projectpushrules"></a>`pushRules` | [`PushRules`](#pushrules) | The project's push rules settings. | +| <a id="projectremovesourcebranchaftermerge"></a>`removeSourceBranchAfterMerge` | [`Boolean`](#boolean) | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project. | +| <a id="projectrepository"></a>`repository` | [`Repository`](#repository) | Git repository of the project. | +| <a id="projectrepositorysizeexcess"></a>`repositorySizeExcess` | [`Float`](#float) | Size of repository that exceeds the limit in bytes. | +| <a id="projectrequestaccessenabled"></a>`requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request member access to the project. | +| <a id="projectrequirementstatescount"></a>`requirementStatesCount` | [`RequirementStatesCount`](#requirementstatescount) | Number of requirements for the project by their state. | +| <a id="projectsastciconfiguration"></a>`sastCiConfiguration` | [`SastCiConfiguration`](#sastciconfiguration) | SAST CI configuration for the project. | +| <a id="projectsecuritydashboardpath"></a>`securityDashboardPath` | [`String`](#string) | Path to project's security dashboard. | +| <a id="projectsecurityscanners"></a>`securityScanners` | [`SecurityScanners`](#securityscanners) | Information about security analyzers used in the project. | +| <a id="projectsentryerrors"></a>`sentryErrors` | [`SentryErrorCollection`](#sentryerrorcollection) | Paginated collection of Sentry errors on the project. | +| <a id="projectservicedeskaddress"></a>`serviceDeskAddress` | [`String`](#string) | E-mail address of the service desk. | +| <a id="projectservicedeskenabled"></a>`serviceDeskEnabled` | [`Boolean`](#boolean) | Indicates if the project has service desk enabled. | +| <a id="projectsharedrunnersenabled"></a>`sharedRunnersEnabled` | [`Boolean`](#boolean) | Indicates if shared runners are enabled for the project. | +| <a id="projectsnippetsenabled"></a>`snippetsEnabled` | [`Boolean`](#boolean) | Indicates if Snippets are enabled for the current user. | +| <a id="projectsquashreadonly"></a>`squashReadOnly` | [`Boolean!`](#boolean) | Indicates if `squashReadOnly` is enabled. | +| <a id="projectsshurltorepo"></a>`sshUrlToRepo` | [`String`](#string) | URL to connect to the project via SSH. | +| <a id="projectstarcount"></a>`starCount` | [`Int!`](#int) | Number of times the project has been starred. | +| <a id="projectstatistics"></a>`statistics` | [`ProjectStatistics`](#projectstatistics) | Statistics of the project. | +| <a id="projectsuggestioncommitmessage"></a>`suggestionCommitMessage` | [`String`](#string) | The commit message used to apply merge request suggestions. | +| <a id="projecttaglist"></a>`tagList` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.12. Use `topics`. | +| <a id="projectterraformstates"></a>`terraformStates` | [`TerraformStateConnection`](#terraformstateconnection) | Terraform states associated with the project. (see [Connections](#connections)) | +| <a id="projecttopics"></a>`topics` | [`[String!]`](#string) | List of project topics. | +| <a id="projectuserpermissions"></a>`userPermissions` | [`ProjectPermissions!`](#projectpermissions) | Permissions for the current user on the resource. | +| <a id="projectvisibility"></a>`visibility` | [`String`](#string) | Visibility of the project. | +| <a id="projectvulnerabilityscanners"></a>`vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the project vulnerabilities. (see [Connections](#connections)) | +| <a id="projectweburl"></a>`webUrl` | [`String`](#string) | Web URL of the project. | +| <a id="projectwikienabled"></a>`wikiEnabled` | [`Boolean`](#boolean) | Indicates if Wikis are enabled for the current user. | + +#### Fields with arguments + +##### `Project.alertManagementAlert` + +A single Alert Management alert of the project. + +Returns [`AlertManagementAlert`](#alertmanagementalert). + +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`PipelineArtifactRegistry`](#pipelineartifactregistry) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectalertmanagementalertassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of a user assigned to the issue. | +| <a id="projectalertmanagementalertdomain"></a>`domain` | [`AlertManagementDomainFilter!`](#alertmanagementdomainfilter) | Filter query for given domain. | +| <a id="projectalertmanagementalertiid"></a>`iid` | [`String`](#string) | IID of the alert. For example, "1". | +| <a id="projectalertmanagementalertsearch"></a>`search` | [`String`](#string) | Search query for title, description, service, or monitoring_tool. | +| <a id="projectalertmanagementalertsort"></a>`sort` | [`AlertManagementAlertSort`](#alertmanagementalertsort) | Sort alerts by this criteria. | +| <a id="projectalertmanagementalertstatuses"></a>`statuses` | [`[AlertManagementStatus!]`](#alertmanagementstatus) | Alerts with the specified statues. For example, [TRIGGERED]. | -### `PipelineCancelPayload` +##### `Project.alertManagementAlertStatusCounts` -Autogenerated return type of PipelineCancel. +Counts of alerts by status for the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +Returns [`AlertManagementAlertStatusCountsType`](#alertmanagementalertstatuscountstype). -### `PipelineConnection` +###### Arguments -The connection type for Pipeline. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectalertmanagementalertstatuscountsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of a user assigned to the issue. | +| <a id="projectalertmanagementalertstatuscountssearch"></a>`search` | [`String`](#string) | Search query for title, description, service, or monitoring_tool. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[PipelineEdge]`](#pipelineedge) | A list of edges. | -| `nodes` | [`[Pipeline]`](#pipeline) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### `Project.alertManagementAlerts` -### `PipelineDestroyPayload` +Alert Management alerts of the project. -Autogenerated return type of PipelineDestroy. +Returns [`AlertManagementAlertConnection`](#alertmanagementalertconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `PipelineEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectalertmanagementalertsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of a user assigned to the issue. | +| <a id="projectalertmanagementalertsdomain"></a>`domain` | [`AlertManagementDomainFilter!`](#alertmanagementdomainfilter) | Filter query for given domain. | +| <a id="projectalertmanagementalertsiid"></a>`iid` | [`String`](#string) | IID of the alert. For example, "1". | +| <a id="projectalertmanagementalertssearch"></a>`search` | [`String`](#string) | Search query for title, description, service, or monitoring_tool. | +| <a id="projectalertmanagementalertssort"></a>`sort` | [`AlertManagementAlertSort`](#alertmanagementalertsort) | Sort alerts by this criteria. | +| <a id="projectalertmanagementalertsstatuses"></a>`statuses` | [`[AlertManagementStatus!]`](#alertmanagementstatus) | Alerts with the specified statues. For example, [TRIGGERED]. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Pipeline`](#pipeline) | The item at the end of the edge. | +##### `Project.alertManagementHttpIntegrations` -### `PipelinePermissions` +HTTP Integrations which can receive alerts for the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_pipeline` on this resource. | -| `destroyPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_pipeline` on this resource. | -| `updatePipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `update_pipeline` on this resource. | +Returns [`AlertManagementHttpIntegrationConnection`](#alertmanagementhttpintegrationconnection). -### `PipelineRetryPayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of PipelineRetry. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `pipeline` | [`Pipeline`](#pipeline) | The pipeline after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectalertmanagementhttpintegrationsid"></a>`id` | [`AlertManagementHttpIntegrationID`](#alertmanagementhttpintegrationid) | ID of the integration. | -### `PipelineSecurityReportFinding` +##### `Project.alertManagementIntegrations` -Represents vulnerability finding of a security report on the pipeline. +Integrations which can receive alerts for the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `confidence` | [`String`](#string) | Type of the security report that found the vulnerability. | -| `description` | [`String`](#string) | Description of the vulnerability finding. | -| `identifiers` | [`[VulnerabilityIdentifier!]!`](#vulnerabilityidentifier) | Identifiers of the vulnerabilit finding. | -| `location` | [`VulnerabilityLocation`](#vulnerabilitylocation) | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. | -| `name` | [`String`](#string) | Name of the vulnerability finding. | -| `project` | [`Project`](#project) | The project on which the vulnerability finding was found. | -| `projectFingerprint` | [`String`](#string) | Name of the vulnerability finding. | -| `reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the security report that found the vulnerability finding. | -| `scanner` | [`VulnerabilityScanner`](#vulnerabilityscanner) | Scanner metadata for the vulnerability. | -| `severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability finding. | -| `solution` | [`String`](#string) | URL to the vulnerability's details page. | -| `uuid` | [`String`](#string) | Name of the vulnerability finding. | +Returns [`AlertManagementIntegrationConnection`](#alertmanagementintegrationconnection). -### `PipelineSecurityReportFindingConnection` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -The connection type for PipelineSecurityReportFinding. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[PipelineSecurityReportFindingEdge]`](#pipelinesecurityreportfindingedge) | A list of edges. | -| `nodes` | [`[PipelineSecurityReportFinding]`](#pipelinesecurityreportfinding) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectalertmanagementintegrationsid"></a>`id` | [`GlobalID`](#globalid) | ID of the integration. | -### `PipelineSecurityReportFindingEdge` +##### `Project.alertManagementPayloadFields` -An edge in a connection. +Extract alert fields from payload for custom mapping. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding) | The item at the end of the edge. | +Returns [`[AlertManagementPayloadAlertField!]`](#alertmanagementpayloadalertfield). -### `Project` +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `actualRepositorySizeLimit` | [`Float`](#float) | Size limit for the repository in bytes. | -| `alertManagementAlert` | [`AlertManagementAlert`](#alertmanagementalert) | A single Alert Management alert of the project. | -| `alertManagementAlertStatusCounts` | [`AlertManagementAlertStatusCountsType`](#alertmanagementalertstatuscountstype) | Counts of alerts by status for the project. | -| `alertManagementAlerts` | [`AlertManagementAlertConnection`](#alertmanagementalertconnection) | Alert Management alerts of the project. | -| `alertManagementHttpIntegrations` | [`AlertManagementHttpIntegrationConnection`](#alertmanagementhttpintegrationconnection) | HTTP Integrations which can receive alerts for the project. | -| `alertManagementIntegrations` | [`AlertManagementIntegrationConnection`](#alertmanagementintegrationconnection) | Integrations which can receive alerts for the project. | -| `alertManagementPayloadFields` | [`[AlertManagementPayloadAlertField!]`](#alertmanagementpayloadalertfield) | Extract alert fields from payload for custom mapping. | -| `allowMergeOnSkippedPipeline` | [`Boolean`](#boolean) | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs. | -| `apiFuzzingCiConfiguration` | [`ApiFuzzingCiConfiguration`](#apifuzzingciconfiguration) | API fuzzing configuration for the project. | -| `archived` | [`Boolean`](#boolean) | Indicates the archived status of the project. | -| `autocloseReferencedIssues` | [`Boolean`](#boolean) | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically. | -| `avatarUrl` | [`String`](#string) | URL to avatar image file of the project. | -| `board` | [`Board`](#board) | A single board of the project. | -| `boards` | [`BoardConnection`](#boardconnection) | Boards of the project. | -| `ciCdSettings` | [`ProjectCiCdSetting`](#projectcicdsetting) | CI/CD settings for the project. | -| `clusterAgent` | [`ClusterAgent`](#clusteragent) | Find a single cluster agent by name. | -| `clusterAgents` | [`ClusterAgentConnection`](#clusteragentconnection) | Cluster agents associated with the project. | -| `codeCoverageSummary` | [`CodeCoverageSummary`](#codecoveragesummary) | Code coverage summary associated with the project. | -| `complianceFrameworks` | [`ComplianceFrameworkConnection`](#complianceframeworkconnection) | Compliance frameworks associated with the project. | -| `containerExpirationPolicy` | [`ContainerExpirationPolicy`](#containerexpirationpolicy) | The container expiration policy of the project. | -| `containerRegistryEnabled` | [`Boolean`](#boolean) | Indicates if the project stores Docker container images in a container registry. | -| `containerRepositories` | [`ContainerRepositoryConnection`](#containerrepositoryconnection) | Container repositories of the project. | -| `containerRepositoriesCount` | [`Int!`](#int) | Number of container repositories in the project. | -| `createdAt` | [`Time`](#time) | Timestamp of the project creation. | -| `dastProfiles` | [`DastProfileConnection`](#dastprofileconnection) | DAST Profiles associated with the project. | -| `dastScannerProfiles` | [`DastScannerProfileConnection`](#dastscannerprofileconnection) | The DAST scanner profiles associated with the project. | -| `dastSiteProfile` | [`DastSiteProfile`](#dastsiteprofile) | DAST Site Profile associated with the project. | -| `dastSiteProfiles` | [`DastSiteProfileConnection`](#dastsiteprofileconnection) | DAST Site Profiles associated with the project. | -| `dastSiteValidations` | [`DastSiteValidationConnection`](#dastsitevalidationconnection) | DAST Site Validations associated with the project. | -| `description` | [`String`](#string) | Short description of the project. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `environment` | [`Environment`](#environment) | A single environment of the project. | -| `environments` | [`EnvironmentConnection`](#environmentconnection) | Environments of the project. | -| `forksCount` | [`Int!`](#int) | Number of times the project has been forked. | -| `fullPath` | [`ID!`](#id) | Full path of the project. | -| `grafanaIntegration` | [`GrafanaIntegration`](#grafanaintegration) | Grafana integration details for the project. | -| `group` | [`Group`](#group) | Group of the project. | -| `httpUrlToRepo` | [`String`](#string) | URL to connect to the project via HTTPS. | -| `id` | [`ID!`](#id) | ID of the project. | -| `importStatus` | [`String`](#string) | Status of import background job of the project. | -| `incidentManagementOncallSchedules` | [`IncidentManagementOncallScheduleConnection`](#incidentmanagementoncallscheduleconnection) | Incident Management On-call schedules of the project. | -| `issue` | [`Issue`](#issue) | A single issue of the project. | -| `issueStatusCounts` | [`IssueStatusCountsType`](#issuestatuscountstype) | Counts of issues by status for the project. | -| `issues` | [`IssueConnection`](#issueconnection) | Issues of the project. | -| `issuesEnabled` | [`Boolean`](#boolean) | Indicates if Issues are enabled for the current user. | -| `iterationCadences` | [`IterationCadenceConnection`](#iterationcadenceconnection) | Find iteration cadences. | -| `iterations` | [`IterationConnection`](#iterationconnection) | Find iterations. | -| `jiraImportStatus` | [`String`](#string) | Status of Jira import background job of the project. | -| `jiraImports` | [`JiraImportConnection`](#jiraimportconnection) | Jira imports into the project. | -| `jobs` | [`CiJobConnection`](#cijobconnection) | Jobs of a project. This field can only be resolved for one project in any single request. | -| `jobsEnabled` | [`Boolean`](#boolean) | Indicates if CI/CD pipeline jobs are enabled for the current user. | -| `label` | [`Label`](#label) | A label available on this project. | -| `labels` | [`LabelConnection`](#labelconnection) | Labels available on this project. | -| `lastActivityAt` | [`Time`](#time) | Timestamp of the project last activity. | -| `lfsEnabled` | [`Boolean`](#boolean) | Indicates if the project has Large File Storage (LFS) enabled. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | A single merge request of the project. | -| `mergeRequests` | [`MergeRequestConnection`](#mergerequestconnection) | Merge requests of the project. | -| `mergeRequestsEnabled` | [`Boolean`](#boolean) | Indicates if Merge Requests are enabled for the current user. | -| `mergeRequestsFfOnlyEnabled` | [`Boolean`](#boolean) | Indicates if no merge commits should be created and all merges should instead be fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded. | -| `milestones` | [`MilestoneConnection`](#milestoneconnection) | Milestones of the project. | -| `name` | [`String!`](#string) | Name of the project (without namespace). | -| `nameWithNamespace` | [`String!`](#string) | Full name of the project with its namespace. | -| `namespace` | [`Namespace`](#namespace) | Namespace of the project. | -| `onlyAllowMergeIfAllDiscussionsAreResolved` | [`Boolean`](#boolean) | Indicates if merge requests of the project can only be merged when all the discussions are resolved. | -| `onlyAllowMergeIfPipelineSucceeds` | [`Boolean`](#boolean) | Indicates if merge requests of the project can only be merged with successful jobs. | -| `openIssuesCount` | [`Int`](#int) | Number of open issues for the project. | -| `packages` | [`PackageConnection`](#packageconnection) | Packages of the project. | -| `path` | [`String!`](#string) | Path of the project. | -| `pipeline` | [`Pipeline`](#pipeline) | Build pipeline of the project. | -| `pipelineAnalytics` | [`PipelineAnalytics`](#pipelineanalytics) | Pipeline analytics. | -| `pipelines` | [`PipelineConnection`](#pipelineconnection) | Build pipelines of the project. | -| `printingMergeRequestLinkEnabled` | [`Boolean`](#boolean) | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line. | -| `projectMembers` | [`MemberInterfaceConnection`](#memberinterfaceconnection) | Members of the project. | -| `publicJobs` | [`Boolean`](#boolean) | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. | -| `pushRules` | [`PushRules`](#pushrules) | The project's push rules settings. | -| `release` | [`Release`](#release) | A single release of the project. | -| `releases` | [`ReleaseConnection`](#releaseconnection) | Releases of the project. | -| `removeSourceBranchAfterMerge` | [`Boolean`](#boolean) | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project. | -| `repository` | [`Repository`](#repository) | Git repository of the project. | -| `repositorySizeExcess` | [`Float`](#float) | Size of repository that exceeds the limit in bytes. | -| `requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request member access to the project. | -| `requirement` | [`Requirement`](#requirement) | Find a single requirement. | -| `requirementStatesCount` | [`RequirementStatesCount`](#requirementstatescount) | Number of requirements for the project by their state. | -| `requirements` | [`RequirementConnection`](#requirementconnection) | Find requirements. | -| `sastCiConfiguration` | [`SastCiConfiguration`](#sastciconfiguration) | SAST CI configuration for the project. | -| `securityDashboardPath` | [`String`](#string) | Path to project's security dashboard. | -| `securityScanners` | [`SecurityScanners`](#securityscanners) | Information about security analyzers used in the project. | -| `sentryDetailedError` | [`SentryDetailedError`](#sentrydetailederror) | Detailed version of a Sentry error on the project. | -| `sentryErrors` | [`SentryErrorCollection`](#sentryerrorcollection) | Paginated collection of Sentry errors on the project. | -| `serviceDeskAddress` | [`String`](#string) | E-mail address of the service desk. | -| `serviceDeskEnabled` | [`Boolean`](#boolean) | Indicates if the project has service desk enabled. | -| `services` | [`ServiceConnection`](#serviceconnection) | Project services. | -| `sharedRunnersEnabled` | [`Boolean`](#boolean) | Indicates if shared runners are enabled for the project. | -| `snippets` | [`SnippetConnection`](#snippetconnection) | Snippets of the project. | -| `snippetsEnabled` | [`Boolean`](#boolean) | Indicates if Snippets are enabled for the current user. | -| `squashReadOnly` | [`Boolean!`](#boolean) | Indicates if `squashReadOnly` is enabled. | -| `sshUrlToRepo` | [`String`](#string) | URL to connect to the project via SSH. | -| `starCount` | [`Int!`](#int) | Number of times the project has been starred. | -| `statistics` | [`ProjectStatistics`](#projectstatistics) | Statistics of the project. | -| `suggestionCommitMessage` | [`String`](#string) | The commit message used to apply merge request suggestions. | -| `tagList` | [`String`](#string) | List of project topics (not Git tags). | -| `terraformState` | [`TerraformState`](#terraformstate) | Find a single Terraform state by name. | -| `terraformStates` | [`TerraformStateConnection`](#terraformstateconnection) | Terraform states associated with the project. | -| `userPermissions` | [`ProjectPermissions!`](#projectpermissions) | Permissions for the current user on the resource. | -| `visibility` | [`String`](#string) | Visibility of the project. | -| `vulnerabilities` | [`VulnerabilityConnection`](#vulnerabilityconnection) | Vulnerabilities reported on the project. | -| `vulnerabilitiesCountByDay` | [`VulnerabilitiesCountByDayConnection`](#vulnerabilitiescountbydayconnection) | Number of vulnerabilities per day for the project. | -| `vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the project vulnerabilities. | -| `vulnerabilitySeveritiesCount` | [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount) | Counts for each vulnerability severity in the project. | -| `webUrl` | [`String`](#string) | Web URL of the project. | -| `wikiEnabled` | [`Boolean`](#boolean) | Indicates if Wikis are enabled for the current user. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectalertmanagementpayloadfieldspayloadexample"></a>`payloadExample` | [`String!`](#string) | Sample payload for extracting alert fields for custom mappings. | -### `ProjectCiCdSetting` +##### `Project.board` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `keepLatestArtifact` | [`Boolean`](#boolean) | Whether to keep the latest builds artifacts. | -| `mergePipelinesEnabled` | [`Boolean`](#boolean) | Whether merge pipelines are enabled. | -| `mergeTrainsEnabled` | [`Boolean`](#boolean) | Whether merge trains are enabled. | -| `project` | [`Project`](#project) | Project the CI/CD settings belong to. | +A single board of the project. -### `ProjectConnection` +Returns [`Board`](#board). -The connection type for Project. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ProjectEdge]`](#projectedge) | A list of edges. | -| `nodes` | [`[Project]`](#project) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectboardid"></a>`id` | [`BoardID!`](#boardid) | The board's ID. | -### `ProjectEdge` +##### `Project.boards` -An edge in a connection. +Boards of the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Project`](#project) | The item at the end of the edge. | +Returns [`BoardConnection`](#boardconnection). -### `ProjectMember` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Represents a Project Membership. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. | -| `createdAt` | [`Time`](#time) | Date and time the membership was created. | -| `createdBy` | [`User`](#user) | User that authorized membership. | -| `expiresAt` | [`Time`](#time) | Date and time the membership expires. | -| `id` | [`ID!`](#id) | ID of the member. | -| `project` | [`Project`](#project) | Project that User is a member of. | -| `updatedAt` | [`Time`](#time) | Date and time the membership was last updated. | -| `user` | [`User!`](#user) | User that is associated with the member object. | -| `userPermissions` | [`ProjectPermissions!`](#projectpermissions) | Permissions for the current user on the resource. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectboardsid"></a>`id` | [`BoardID`](#boardid) | Find a board by its ID. | -### `ProjectMemberConnection` +##### `Project.ciTemplate` -The connection type for ProjectMember. +Find a single CI/CD template by name. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ProjectMemberEdge]`](#projectmemberedge) | A list of edges. | -| `nodes` | [`[ProjectMember]`](#projectmember) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Returns [`CiTemplate`](#citemplate). -### `ProjectMemberEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectcitemplatename"></a>`name` | [`String!`](#string) | Name of the CI/CD template to search for. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ProjectMember`](#projectmember) | The item at the end of the edge. | +##### `Project.clusterAgent` -### `ProjectPermissions` +Find a single cluster agent by name. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminOperations` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_operations` on this resource. | -| `adminProject` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_project` on this resource. | -| `adminRemoteMirror` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_remote_mirror` on this resource. | -| `adminWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_wiki` on this resource. | -| `archiveProject` | [`Boolean!`](#boolean) | Indicates the user can perform `archive_project` on this resource. | -| `changeNamespace` | [`Boolean!`](#boolean) | Indicates the user can perform `change_namespace` on this resource. | -| `changeVisibilityLevel` | [`Boolean!`](#boolean) | Indicates the user can perform `change_visibility_level` on this resource. | -| `createDeployment` | [`Boolean!`](#boolean) | Indicates the user can perform `create_deployment` on this resource. | -| `createDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `create_design` on this resource. | -| `createIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `create_issue` on this resource. | -| `createLabel` | [`Boolean!`](#boolean) | Indicates the user can perform `create_label` on this resource. | -| `createMergeRequestFrom` | [`Boolean!`](#boolean) | Indicates the user can perform `create_merge_request_from` on this resource. | -| `createMergeRequestIn` | [`Boolean!`](#boolean) | Indicates the user can perform `create_merge_request_in` on this resource. | -| `createPages` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pages` on this resource. | -| `createPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pipeline` on this resource. | -| `createPipelineSchedule` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pipeline_schedule` on this resource. | -| `createSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `create_snippet` on this resource. | -| `createWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `create_wiki` on this resource. | -| `destroyDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_design` on this resource. | -| `destroyPages` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_pages` on this resource. | -| `destroyWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_wiki` on this resource. | -| `downloadCode` | [`Boolean!`](#boolean) | Indicates the user can perform `download_code` on this resource. | -| `downloadWikiCode` | [`Boolean!`](#boolean) | Indicates the user can perform `download_wiki_code` on this resource. | -| `forkProject` | [`Boolean!`](#boolean) | Indicates the user can perform `fork_project` on this resource. | -| `pushCode` | [`Boolean!`](#boolean) | Indicates the user can perform `push_code` on this resource. | -| `pushToDeleteProtectedBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `push_to_delete_protected_branch` on this resource. | -| `readCommitStatus` | [`Boolean!`](#boolean) | Indicates the user can perform `read_commit_status` on this resource. | -| `readCycleAnalytics` | [`Boolean!`](#boolean) | Indicates the user can perform `read_cycle_analytics` on this resource. | -| `readDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `read_design` on this resource. | -| `readMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `read_merge_request` on this resource. | -| `readPagesContent` | [`Boolean!`](#boolean) | Indicates the user can perform `read_pages_content` on this resource. | -| `readProject` | [`Boolean!`](#boolean) | Indicates the user can perform `read_project` on this resource. | -| `readProjectMember` | [`Boolean!`](#boolean) | Indicates the user can perform `read_project_member` on this resource. | -| `readWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `read_wiki` on this resource. | -| `removeForkProject` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_fork_project` on this resource. | -| `removePages` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_pages` on this resource. | -| `removeProject` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_project` on this resource. | -| `renameProject` | [`Boolean!`](#boolean) | Indicates the user can perform `rename_project` on this resource. | -| `requestAccess` | [`Boolean!`](#boolean) | Indicates the user can perform `request_access` on this resource. | -| `updatePages` | [`Boolean!`](#boolean) | Indicates the user can perform `update_pages` on this resource. | -| `updateWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `update_wiki` on this resource. | -| `uploadFile` | [`Boolean!`](#boolean) | Indicates the user can perform `upload_file` on this resource. | +Returns [`ClusterAgent`](#clusteragent). -### `ProjectStatistics` +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `buildArtifactsSize` | [`Float!`](#float) | Build artifacts size of the project in bytes. | -| `commitCount` | [`Float!`](#float) | Commit count of the project. | -| `lfsObjectsSize` | [`Float!`](#float) | Large File Storage (LFS) object size of the project in bytes. | -| `packagesSize` | [`Float!`](#float) | Packages size of the project in bytes. | -| `repositorySize` | [`Float!`](#float) | Repository size of the project in bytes. | -| `snippetsSize` | [`Float`](#float) | Snippets size of the project in bytes. | -| `storageSize` | [`Float!`](#float) | Storage size of the project in bytes. | -| `uploadsSize` | [`Float`](#float) | Uploads size of the project in bytes. | -| `wikiSize` | [`Float`](#float) | Wiki size of the project in bytes. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectclusteragentname"></a>`name` | [`String!`](#string) | Name of the cluster agent. | -### `PrometheusAlert` +##### `Project.containerRepositories` -The alert condition for Prometheus. +Container repositories of the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `humanizedText` | [`String!`](#string) | The human-readable text of the alert condition. | -| `id` | [`ID!`](#id) | ID of the alert condition. | +Returns [`ContainerRepositoryConnection`](#containerrepositoryconnection). -### `PrometheusIntegrationCreatePayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of PrometheusIntegrationCreate. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | The newly created integration. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectcontainerrepositoriesname"></a>`name` | [`String`](#string) | Filter the container repositories by their name. | +| <a id="projectcontainerrepositoriessort"></a>`sort` | [`ContainerRepositorySort`](#containerrepositorysort) | Sort container repositories by this criteria. | -### `PrometheusIntegrationResetTokenPayload` +##### `Project.dastSiteProfile` -Autogenerated return type of PrometheusIntegrationResetToken. +DAST Site Profile associated with the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | The newly created integration. | +Returns [`DastSiteProfile`](#dastsiteprofile). -### `PrometheusIntegrationUpdatePayload` +###### Arguments -Autogenerated return type of PrometheusIntegrationUpdate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectdastsiteprofileid"></a>`id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | The newly created integration. | +##### `Project.dastSiteValidations` -### `PromoteToEpicPayload` +DAST Site Validations associated with the project. -Autogenerated return type of PromoteToEpic. +Returns [`DastSiteValidationConnection`](#dastsitevalidationconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epic` | [`Epic`](#epic) | The epic after issue promotion. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `PushRules` +###### Arguments -Represents rules that commit pushes must follow. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectdastsitevalidationsnormalizedtargeturls"></a>`normalizedTargetUrls` | [`[String!]`](#string) | Normalized URL of the target to be scanned. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `rejectUnsignedCommits` | [`Boolean!`](#boolean) | Indicates whether commits not signed through GPG will be rejected. | +##### `Project.environment` -### `RecentFailures` +A single environment of the project. -Recent failure history of a test case. +Returns [`Environment`](#environment). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `baseBranch` | [`String`](#string) | Name of the base branch of the project. | -| `count` | [`Int`](#int) | Number of times the test case has failed in the past 14 days. | +###### Arguments -### `Release` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectenvironmentname"></a>`name` | [`String`](#string) | Name of the environment. | +| <a id="projectenvironmentsearch"></a>`search` | [`String`](#string) | Search query for environment name. | +| <a id="projectenvironmentstates"></a>`states` | [`[String!]`](#string) | States of environments that should be included in result. | -Represents a release. +##### `Project.environments` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `assets` | [`ReleaseAssets`](#releaseassets) | Assets of the release. | -| `author` | [`User`](#user) | User that created the release. | -| `commit` | [`Commit`](#commit) | The commit associated with the release. | -| `createdAt` | [`Time`](#time) | Timestamp of when the release was created. | -| `description` | [`String`](#string) | Description (also known as "release notes") of the release. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `evidences` | [`ReleaseEvidenceConnection`](#releaseevidenceconnection) | Evidence for the release. | -| `links` | [`ReleaseLinks`](#releaselinks) | Links of the release. | -| `milestones` | [`MilestoneConnection`](#milestoneconnection) | Milestones associated to the release. | -| `name` | [`String`](#string) | Name of the release. | -| `releasedAt` | [`Time`](#time) | Timestamp of when the release was released. | -| `tagName` | [`String`](#string) | Name of the tag associated with the release. | -| `tagPath` | [`String`](#string) | Relative web path to the tag associated with the release. | -| `upcomingRelease` | [`Boolean`](#boolean) | Indicates the release is an upcoming release. | +Environments of the project. -### `ReleaseAssetLink` +Returns [`EnvironmentConnection`](#environmentconnection). -Represents an asset link associated with a release. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `directAssetUrl` | [`String`](#string) | Direct asset URL of the link. | -| `external` | [`Boolean`](#boolean) | Indicates the link points to an external resource. | -| `id` | [`ID!`](#id) | ID of the link. | -| `linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`. | -| `name` | [`String`](#string) | Name of the link. | -| `url` | [`String`](#string) | URL of the link. | +###### Arguments -### `ReleaseAssetLinkConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectenvironmentsname"></a>`name` | [`String`](#string) | Name of the environment. | +| <a id="projectenvironmentssearch"></a>`search` | [`String`](#string) | Search query for environment name. | +| <a id="projectenvironmentsstates"></a>`states` | [`[String!]`](#string) | States of environments that should be included in result. | -The connection type for ReleaseAssetLink. +##### `Project.incidentManagementOncallSchedules` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ReleaseAssetLinkEdge]`](#releaseassetlinkedge) | A list of edges. | -| `nodes` | [`[ReleaseAssetLink]`](#releaseassetlink) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Incident Management On-call schedules of the project. -### `ReleaseAssetLinkCreatePayload` +Returns [`IncidentManagementOncallScheduleConnection`](#incidentmanagementoncallscheduleconnection). -Autogenerated return type of ReleaseAssetLinkCreate. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `link` | [`ReleaseAssetLink`](#releaseassetlink) | The asset link after mutation. | +###### Arguments -### `ReleaseAssetLinkDeletePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectincidentmanagementoncallschedulesiids"></a>`iids` | [`[ID!]`](#id) | IIDs of on-call schedules. | -Autogenerated return type of ReleaseAssetLinkDelete. +##### `Project.issue` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `link` | [`ReleaseAssetLink`](#releaseassetlink) | The deleted release asset link. | +A single issue of the project. -### `ReleaseAssetLinkEdge` +Returns [`Issue`](#issue). -An edge in a connection. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ReleaseAssetLink`](#releaseassetlink) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectissueassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user assigned to the issues, "none" and "any" values are supported. | +| <a id="projectissueassigneeusername"></a>`assigneeUsername` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use `assigneeUsernames`. | +| <a id="projectissueassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | +| <a id="projectissueauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. | +| <a id="projectissueclosedafter"></a>`closedAfter` | [`Time`](#time) | Issues closed after this date. | +| <a id="projectissueclosedbefore"></a>`closedBefore` | [`Time`](#time) | Issues closed before this date. | +| <a id="projectissuecreatedafter"></a>`createdAfter` | [`Time`](#time) | Issues created after this date. | +| <a id="projectissuecreatedbefore"></a>`createdBefore` | [`Time`](#time) | Issues created before this date. | +| <a id="projectissueepicid"></a>`epicId` | [`String`](#string) | ID of an epic associated with the issues, "none" and "any" values are supported. | +| <a id="projectissueiid"></a>`iid` | [`String`](#string) | IID of the issue. For example, "1". | +| <a id="projectissueiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example, ["1", "2"]. | +| <a id="projectissueiterationid"></a>`iterationId` | [`[ID]`](#id) | List of iteration Global IDs applied to the issue. | +| <a id="projectissueiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by iteration ID wildcard. | +| <a id="projectissuelabelname"></a>`labelName` | [`[String]`](#string) | Labels applied to this issue. | +| <a id="projectissuemilestonetitle"></a>`milestoneTitle` | [`[String]`](#string) | Milestone applied to this issue. | +| <a id="projectissuenot"></a>`not` | [`NegatedIssueFilterInput`](#negatedissuefilterinput) | Negated arguments. | +| <a id="projectissuesearch"></a>`search` | [`String`](#string) | Search query for issue title or description. | +| <a id="projectissuesort"></a>`sort` | [`IssueSort`](#issuesort) | Sort issues by this criteria. | +| <a id="projectissuestate"></a>`state` | [`IssuableState`](#issuablestate) | Current state of this issue. | +| <a id="projectissuetypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter issues by the given issue types. | +| <a id="projectissueupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Issues updated after this date. | +| <a id="projectissueupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Issues updated before this date. | +| <a id="projectissueweight"></a>`weight` | [`String`](#string) | Weight applied to the issue, "none" and "any" values are supported. | + +##### `Project.issueStatusCounts` + +Counts of issues by status for the project. + +Returns [`IssueStatusCountsType`](#issuestatuscountstype). + +###### Arguments -### `ReleaseAssetLinkUpdatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectissuestatuscountsassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user assigned to the issues, "none" and "any" values are supported. | +| <a id="projectissuestatuscountsassigneeusername"></a>`assigneeUsername` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use `assigneeUsernames`. | +| <a id="projectissuestatuscountsassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | +| <a id="projectissuestatuscountsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. | +| <a id="projectissuestatuscountsclosedafter"></a>`closedAfter` | [`Time`](#time) | Issues closed after this date. | +| <a id="projectissuestatuscountsclosedbefore"></a>`closedBefore` | [`Time`](#time) | Issues closed before this date. | +| <a id="projectissuestatuscountscreatedafter"></a>`createdAfter` | [`Time`](#time) | Issues created after this date. | +| <a id="projectissuestatuscountscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Issues created before this date. | +| <a id="projectissuestatuscountsiid"></a>`iid` | [`String`](#string) | IID of the issue. For example, "1". | +| <a id="projectissuestatuscountsiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example, ["1", "2"]. | +| <a id="projectissuestatuscountslabelname"></a>`labelName` | [`[String]`](#string) | Labels applied to this issue. | +| <a id="projectissuestatuscountsmilestonetitle"></a>`milestoneTitle` | [`[String]`](#string) | Milestone applied to this issue. | +| <a id="projectissuestatuscountsnot"></a>`not` | [`NegatedIssueFilterInput`](#negatedissuefilterinput) | Negated arguments. | +| <a id="projectissuestatuscountssearch"></a>`search` | [`String`](#string) | Search query for issue title or description. | +| <a id="projectissuestatuscountstypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter issues by the given issue types. | +| <a id="projectissuestatuscountsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Issues updated after this date. | +| <a id="projectissuestatuscountsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Issues updated before this date. | + +##### `Project.issues` + +Issues of the project. + +Returns [`IssueConnection`](#issueconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -Autogenerated return type of ReleaseAssetLinkUpdate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectissuesassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user assigned to the issues, "none" and "any" values are supported. | +| <a id="projectissuesassigneeusername"></a>`assigneeUsername` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use `assigneeUsernames`. | +| <a id="projectissuesassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. | +| <a id="projectissuesauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. | +| <a id="projectissuesclosedafter"></a>`closedAfter` | [`Time`](#time) | Issues closed after this date. | +| <a id="projectissuesclosedbefore"></a>`closedBefore` | [`Time`](#time) | Issues closed before this date. | +| <a id="projectissuescreatedafter"></a>`createdAfter` | [`Time`](#time) | Issues created after this date. | +| <a id="projectissuescreatedbefore"></a>`createdBefore` | [`Time`](#time) | Issues created before this date. | +| <a id="projectissuesepicid"></a>`epicId` | [`String`](#string) | ID of an epic associated with the issues, "none" and "any" values are supported. | +| <a id="projectissuesiid"></a>`iid` | [`String`](#string) | IID of the issue. For example, "1". | +| <a id="projectissuesiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example, ["1", "2"]. | +| <a id="projectissuesiterationid"></a>`iterationId` | [`[ID]`](#id) | List of iteration Global IDs applied to the issue. | +| <a id="projectissuesiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by iteration ID wildcard. | +| <a id="projectissueslabelname"></a>`labelName` | [`[String]`](#string) | Labels applied to this issue. | +| <a id="projectissuesmilestonetitle"></a>`milestoneTitle` | [`[String]`](#string) | Milestone applied to this issue. | +| <a id="projectissuesnot"></a>`not` | [`NegatedIssueFilterInput`](#negatedissuefilterinput) | Negated arguments. | +| <a id="projectissuessearch"></a>`search` | [`String`](#string) | Search query for issue title or description. | +| <a id="projectissuessort"></a>`sort` | [`IssueSort`](#issuesort) | Sort issues by this criteria. | +| <a id="projectissuesstate"></a>`state` | [`IssuableState`](#issuablestate) | Current state of this issue. | +| <a id="projectissuestypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter issues by the given issue types. | +| <a id="projectissuesupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Issues updated after this date. | +| <a id="projectissuesupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Issues updated before this date. | +| <a id="projectissuesweight"></a>`weight` | [`String`](#string) | Weight applied to the issue, "none" and "any" values are supported. | + +##### `Project.iterationCadences` + +Find iteration cadences. + +Returns [`IterationCadenceConnection`](#iterationcadenceconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `link` | [`ReleaseAssetLink`](#releaseassetlink) | The asset link after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectiterationcadencesactive"></a>`active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. | +| <a id="projectiterationcadencesautomatic"></a>`automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate future iterations. | +| <a id="projectiterationcadencesdurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. | +| <a id="projectiterationcadencesid"></a>`id` | [`IterationsCadenceID`](#iterationscadenceid) | Global ID of the iteration cadence to look up. | +| <a id="projectiterationcadencesincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Whether to include ancestor groups to search iterations cadences in. | +| <a id="projectiterationcadencestitle"></a>`title` | [`String`](#string) | Fuzzy search by title. | -### `ReleaseAssets` +##### `Project.iterations` -A container for all assets associated with a release. +Find iterations. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int`](#int) | Number of assets of the release. | -| `links` | [`ReleaseAssetLinkConnection`](#releaseassetlinkconnection) | Asset links of the release. | -| `sources` | [`ReleaseSourceConnection`](#releasesourceconnection) | Sources of the release. | +Returns [`IterationConnection`](#iterationconnection). -### `ReleaseConnection` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -The connection type for Release. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[ReleaseEdge]`](#releaseedge) | A list of edges. | -| `nodes` | [`[Release]`](#release) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectiterationsenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. | +| <a id="projectiterationsid"></a>`id` | [`ID`](#id) | Global ID of the Iteration to look up. | +| <a id="projectiterationsiid"></a>`iid` | [`ID`](#id) | Internal ID of the Iteration to look up. | +| <a id="projectiterationsincludeancestors"></a>`includeAncestors` | [`Boolean`](#boolean) | Whether to include ancestor iterations. Defaults to true. | +| <a id="projectiterationsiterationcadenceids"></a>`iterationCadenceIds` | [`[IterationsCadenceID!]`](#iterationscadenceid) | Global iteration cadence IDs by which to look up the iterations. | +| <a id="projectiterationsstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. | +| <a id="projectiterationsstate"></a>`state` | [`IterationState`](#iterationstate) | Filter iterations by state. | +| <a id="projectiterationstimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. | +| <a id="projectiterationstitle"></a>`title` | [`String`](#string) | Fuzzy search by title. | -### `ReleaseCreatePayload` +##### `Project.jobs` -Autogenerated return type of ReleaseCreate. +Jobs of a project. This field can only be resolved for one project in any single request. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `release` | [`Release`](#release) | The release after mutation. | +Returns [`CiJobConnection`](#cijobconnection). -### `ReleaseDeletePayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of ReleaseDelete. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `release` | [`Release`](#release) | The deleted release. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectjobsstatuses"></a>`statuses` | [`[CiJobStatus!]`](#cijobstatus) | Filter jobs by status. | -### `ReleaseEdge` +##### `Project.label` -An edge in a connection. +A label available on this project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Release`](#release) | The item at the end of the edge. | +Returns [`Label`](#label). -### `ReleaseEvidence` +###### Arguments -Evidence for a release. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectlabeltitle"></a>`title` | [`String!`](#string) | Title of the label. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `collectedAt` | [`Time`](#time) | Timestamp when the evidence was collected. | -| `filepath` | [`String`](#string) | URL from where the evidence can be downloaded. | -| `id` | [`ID!`](#id) | ID of the evidence. | -| `sha` | [`String`](#string) | SHA1 ID of the evidence hash. | +##### `Project.labels` -### `ReleaseEvidenceConnection` +Labels available on this project. -The connection type for ReleaseEvidence. +Returns [`LabelConnection`](#labelconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ReleaseEvidenceEdge]`](#releaseevidenceedge) | A list of edges. | -| `nodes` | [`[ReleaseEvidence]`](#releaseevidence) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `ReleaseEvidenceEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectlabelsincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include labels from ancestor groups. | +| <a id="projectlabelssearchterm"></a>`searchTerm` | [`String`](#string) | A search term to find labels with. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ReleaseEvidence`](#releaseevidence) | The item at the end of the edge. | +##### `Project.mergeRequest` -### `ReleaseLinks` +A single merge request of the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `closedIssuesUrl` | [`String`](#string) | HTTP URL of the issues page, filtered by this release and `state=closed`. | -| `closedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page , filtered by this release and `state=closed`. | -| `editUrl` | [`String`](#string) | HTTP URL of the release's edit page. | -| `mergedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page , filtered by this release and `state=merged`. | -| `openedIssuesUrl` | [`String`](#string) | HTTP URL of the issues page, filtered by this release and `state=open`. | -| `openedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page, filtered by this release and `state=open`. | -| `selfUrl` | [`String`](#string) | HTTP URL of the release. | +Returns [`MergeRequest`](#mergerequest). -### `ReleaseSource` +###### Arguments -Represents the source code attached to a release in a particular format. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectmergerequestiid"></a>`iid` | [`String!`](#string) | IID of the merge request, for example `1`. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `format` | [`String`](#string) | Format of the source. | -| `url` | [`String`](#string) | Download URL of the source. | +##### `Project.mergeRequests` -### `ReleaseSourceConnection` +Merge requests of the project. -The connection type for ReleaseSource. +Returns [`MergeRequestConnection`](#mergerequestconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ReleaseSourceEdge]`](#releasesourceedge) | A list of edges. | -| `nodes` | [`[ReleaseSource]`](#releasesource) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `ReleaseSourceEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="projectmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="projectmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="projectmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="projectmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="projectmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="projectmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="projectmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="projectmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="projectmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="projectmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="projectmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="projectmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ReleaseSource`](#releasesource) | The item at the end of the edge. | +##### `Project.milestones` -### `ReleaseUpdatePayload` +Milestones of the project. -Autogenerated return type of ReleaseUpdate. +Returns [`MilestoneConnection`](#milestoneconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `release` | [`Release`](#release) | The release after mutation. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `RemoveAwardEmojiPayload` +###### Arguments -Autogenerated return type of RemoveAwardEmoji. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectmilestonescontainingdate"></a>`containingDate` | [`Time`](#time) | A date that the milestone contains. | +| <a id="projectmilestonesenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. | +| <a id="projectmilestonesids"></a>`ids` | [`[ID!]`](#id) | Array of global milestone IDs, e.g., `"gid://gitlab/Milestone/1"`. | +| <a id="projectmilestonesincludeancestors"></a>`includeAncestors` | [`Boolean`](#boolean) | Also return milestones in the project's parent group and its ancestors. | +| <a id="projectmilestonessearchtitle"></a>`searchTitle` | [`String`](#string) | A search string for the title. | +| <a id="projectmilestonesstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. | +| <a id="projectmilestonesstate"></a>`state` | [`MilestoneStateEnum`](#milestonestateenum) | Filter milestones by state. | +| <a id="projectmilestonestimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. | +| <a id="projectmilestonestitle"></a>`title` | [`String`](#string) | The title of the milestone. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +##### `Project.packages` -### `RemoveProjectFromSecurityDashboardPayload` +Packages of the project. -Autogenerated return type of RemoveProjectFromSecurityDashboard. +Returns [`PackageConnection`](#packageconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `RepositionImageDiffNotePayload` +###### Arguments -Autogenerated return type of RepositionImageDiffNote. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectpackagesincludeversionless"></a>`includeVersionless` | [`Boolean`](#boolean) | Include versionless packages. | +| <a id="projectpackagespackagename"></a>`packageName` | [`String`](#string) | Search a package by name. | +| <a id="projectpackagespackagetype"></a>`packageType` | [`PackageTypeEnum`](#packagetypeenum) | Filter a package by type. | +| <a id="projectpackagessort"></a>`sort` | [`PackageSort`](#packagesort) | Sort packages by this criteria. | +| <a id="projectpackagesstatus"></a>`status` | [`PackageStatus`](#packagestatus) | Filter a package by status. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `note` | [`Note`](#note) | The note after mutation. | +##### `Project.pipeline` -### `Repository` +Build pipeline of the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `blobs` | [`RepositoryBlobConnection`](#repositoryblobconnection) | Blobs contained within the repository. | -| `branchNames` | [`[String!]`](#string) | Names of branches available in this repository that match the search pattern. | -| `empty` | [`Boolean!`](#boolean) | Indicates repository has no visible content. | -| `exists` | [`Boolean!`](#boolean) | Indicates a corresponding Git repository exists on disk. | -| `rootRef` | [`String`](#string) | Default branch of the repository. | -| `tree` | [`Tree`](#tree) | Tree of the repository. | +Returns [`Pipeline`](#pipeline). -### `RepositoryBlob` +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `id` | [`ID!`](#id) | ID of the blob. | -| `lfsOid` | [`String`](#string) | LFS OID of the blob. | -| `mode` | [`String`](#string) | Blob mode. | -| `name` | [`String`](#string) | Blob name. | -| `oid` | [`String!`](#string) | OID of the blob. | -| `path` | [`String!`](#string) | Path of the blob. | -| `webPath` | [`String`](#string) | Web path of the blob. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectpipelineiid"></a>`iid` | [`ID`](#id) | IID of the Pipeline. For example, "1". | +| <a id="projectpipelinesha"></a>`sha` | [`String`](#string) | SHA of the Pipeline. For example, "dyd0f15ay83993f5ab66k927w28673882x99100b". | -### `RepositoryBlobConnection` +##### `Project.pipelines` -The connection type for RepositoryBlob. +Build pipelines of the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[RepositoryBlobEdge]`](#repositoryblobedge) | A list of edges. | -| `nodes` | [`[RepositoryBlob]`](#repositoryblob) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Returns [`PipelineConnection`](#pipelineconnection). -### `RepositoryBlobEdge` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -An edge in a connection. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`RepositoryBlob`](#repositoryblob) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectpipelinesref"></a>`ref` | [`String`](#string) | Filter pipelines by the ref they are run for. | +| <a id="projectpipelinessha"></a>`sha` | [`String`](#string) | Filter pipelines by the sha of the commit they are run for. | +| <a id="projectpipelinesstatus"></a>`status` | [`PipelineStatusEnum`](#pipelinestatusenum) | Filter pipelines by their status. | -### `Requirement` +##### `Project.projectMembers` -Represents a requirement. +Members of the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `author` | [`User!`](#user) | Author of the requirement. | -| `createdAt` | [`Time!`](#time) | Timestamp of when the requirement was created. | -| `description` | [`String`](#string) | Description of the requirement. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `id` | [`ID!`](#id) | ID of the requirement. | -| `iid` | [`ID!`](#id) | Internal ID of the requirement. | -| `lastTestReportManuallyCreated` | [`Boolean`](#boolean) | Indicates if latest test report was created by user. | -| `lastTestReportState` | [`TestReportState`](#testreportstate) | Latest requirement test report state. | -| `project` | [`Project!`](#project) | Project to which the requirement belongs. | -| `state` | [`RequirementState!`](#requirementstate) | State of the requirement. | -| `testReports` | [`TestReportConnection`](#testreportconnection) | Test reports of the requirement. | -| `title` | [`String`](#string) | Title of the requirement. | -| `titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | -| `updatedAt` | [`Time!`](#time) | Timestamp of when the requirement was last updated. | -| `userPermissions` | [`RequirementPermissions!`](#requirementpermissions) | Permissions for the current user on the resource. | - -### `RequirementConnection` - -The connection type for Requirement. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[RequirementEdge]`](#requirementedge) | A list of edges. | -| `nodes` | [`[Requirement]`](#requirement) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `RequirementEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Requirement`](#requirement) | The item at the end of the edge. | +Returns [`MemberInterfaceConnection`](#memberinterfaceconnection). -### `RequirementPermissions` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Check permissions for the current user on a requirement. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_requirement` on this resource. | -| `createRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `create_requirement` on this resource. | -| `destroyRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_requirement` on this resource. | -| `readRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `read_requirement` on this resource. | -| `updateRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `update_requirement` on this resource. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectprojectmembersrelations"></a>`relations` | [`[ProjectMemberRelation!]`](#projectmemberrelation) | Filter members by the given member relations. | +| <a id="projectprojectmemberssearch"></a>`search` | [`String`](#string) | Search query. | -### `RequirementStatesCount` +##### `Project.release` -Counts of requirements by their state. +A single release of the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `archived` | [`Int`](#int) | Number of archived requirements. | -| `opened` | [`Int`](#int) | Number of opened requirements. | +Returns [`Release`](#release). -### `RevertVulnerabilityToDetectedPayload` +###### Arguments -Autogenerated return type of RevertVulnerabilityToDetected. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectreleasetagname"></a>`tagName` | [`String!`](#string) | The name of the tag associated to the release. | -| Field | 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) | The vulnerability after revert. | +##### `Project.releases` -### `RootStorageStatistics` +Releases of the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `buildArtifactsSize` | [`Float!`](#float) | The CI artifacts size in bytes. | -| `lfsObjectsSize` | [`Float!`](#float) | The LFS objects size in bytes. | -| `packagesSize` | [`Float!`](#float) | The packages size in bytes. | -| `pipelineArtifactsSize` | [`Float!`](#float) | The CI pipeline artifacts size in bytes. | -| `repositorySize` | [`Float!`](#float) | The Git repository size in bytes. | -| `snippetsSize` | [`Float!`](#float) | The snippets size in bytes. | -| `storageSize` | [`Float!`](#float) | The total storage in bytes. | -| `uploadsSize` | [`Float!`](#float) | The uploads size in bytes. | -| `wikiSize` | [`Float!`](#float) | The wiki size in bytes. | +Returns [`ReleaseConnection`](#releaseconnection). -### `RunDASTScanPayload` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Autogenerated return type of RunDASTScan. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectreleasessort"></a>`sort` | [`ReleaseSort`](#releasesort) | Sort releases by this criteria. | -### `RunnerArchitecture` +##### `Project.requirement` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `downloadLocation` | [`String!`](#string) | Download location for the runner for the platform architecture. | -| `name` | [`String!`](#string) | Name of the runner platform architecture. | +Find a single requirement. -### `RunnerArchitectureConnection` +Returns [`Requirement`](#requirement). -The connection type for RunnerArchitecture. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[RunnerArchitectureEdge]`](#runnerarchitectureedge) | A list of edges. | -| `nodes` | [`[RunnerArchitecture]`](#runnerarchitecture) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectrequirementauthorusername"></a>`authorUsername` | [`[String!]`](#string) | Filter requirements by author username. | +| <a id="projectrequirementiid"></a>`iid` | [`ID`](#id) | IID of the requirement, e.g., "1". | +| <a id="projectrequirementiids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of requirements, e.g., [1, 2]. | +| <a id="projectrequirementlasttestreportstate"></a>`lastTestReportState` | [`RequirementStatusFilter`](#requirementstatusfilter) | The state of latest requirement test report. | +| <a id="projectrequirementsearch"></a>`search` | [`String`](#string) | Search query for requirement title. | +| <a id="projectrequirementsort"></a>`sort` | [`Sort`](#sort) | List requirements by sort order. | +| <a id="projectrequirementstate"></a>`state` | [`RequirementState`](#requirementstate) | Filter requirements by state. | -### `RunnerArchitectureEdge` +##### `Project.requirements` -An edge in a connection. +Find requirements. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`RunnerArchitecture`](#runnerarchitecture) | The item at the end of the edge. | +Returns [`RequirementConnection`](#requirementconnection). -### `RunnerPlatform` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `architectures` | [`RunnerArchitectureConnection`](#runnerarchitectureconnection) | Runner architectures supported for the platform. | -| `humanReadableName` | [`String!`](#string) | Human readable name of the runner platform. | -| `name` | [`String!`](#string) | Name slug of the runner platform. | +###### Arguments -### `RunnerPlatformConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectrequirementsauthorusername"></a>`authorUsername` | [`[String!]`](#string) | Filter requirements by author username. | +| <a id="projectrequirementsiid"></a>`iid` | [`ID`](#id) | IID of the requirement, e.g., "1". | +| <a id="projectrequirementsiids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of requirements, e.g., [1, 2]. | +| <a id="projectrequirementslasttestreportstate"></a>`lastTestReportState` | [`RequirementStatusFilter`](#requirementstatusfilter) | The state of latest requirement test report. | +| <a id="projectrequirementssearch"></a>`search` | [`String`](#string) | Search query for requirement title. | +| <a id="projectrequirementssort"></a>`sort` | [`Sort`](#sort) | List requirements by sort order. | +| <a id="projectrequirementsstate"></a>`state` | [`RequirementState`](#requirementstate) | Filter requirements by state. | -The connection type for RunnerPlatform. +##### `Project.sentryDetailedError` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[RunnerPlatformEdge]`](#runnerplatformedge) | A list of edges. | -| `nodes` | [`[RunnerPlatform]`](#runnerplatform) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Detailed version of a Sentry error on the project. -### `RunnerPlatformEdge` +Returns [`SentryDetailedError`](#sentrydetailederror). -An edge in a connection. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`RunnerPlatform`](#runnerplatform) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectsentrydetailederrorid"></a>`id` | [`GitlabErrorTrackingDetailedErrorID!`](#gitlaberrortrackingdetailederrorid) | ID of the Sentry issue. | -### `RunnerSetup` +##### `Project.services` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `installInstructions` | [`String!`](#string) | Instructions for installing the runner on the specified architecture. | -| `registerInstructions` | [`String`](#string) | Instructions for registering the runner. | +Project services. -### `SastCiConfiguration` +Returns [`ServiceConnection`](#serviceconnection). -Represents a CI configuration of SAST. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `analyzers` | [`SastCiConfigurationAnalyzersEntityConnection`](#sastciconfigurationanalyzersentityconnection) | List of analyzers entities attached to SAST configuration. | -| `global` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of global entities related to SAST configuration. | -| `pipeline` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of pipeline entities related to SAST configuration. | +###### Arguments -### `SastCiConfigurationAnalyzersEntity` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectservicesactive"></a>`active` | [`Boolean`](#boolean) | Indicates if the service is active. | +| <a id="projectservicestype"></a>`type` | [`ServiceType`](#servicetype) | Class name of the service. | -Represents an analyzer entity in SAST CI configuration. +##### `Project.snippets` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Analyzer description that is displayed on the form. | -| `enabled` | [`Boolean`](#boolean) | Indicates whether an analyzer is enabled. | -| `label` | [`String`](#string) | Analyzer label used in the config UI. | -| `name` | [`String`](#string) | Name of the analyzer. | -| `variables` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of supported variables. | +Snippets of the project. -### `SastCiConfigurationAnalyzersEntityConnection` +Returns [`SnippetConnection`](#snippetconnection). -The connection type for SastCiConfigurationAnalyzersEntity. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[SastCiConfigurationAnalyzersEntityEdge]`](#sastciconfigurationanalyzersentityedge) | A list of edges. | -| `nodes` | [`[SastCiConfigurationAnalyzersEntity]`](#sastciconfigurationanalyzersentity) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +###### Arguments -### `SastCiConfigurationAnalyzersEntityEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectsnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | +| <a id="projectsnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | The visibility of the snippet. | -An edge in a connection. +##### `Project.terraformState` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`SastCiConfigurationAnalyzersEntity`](#sastciconfigurationanalyzersentity) | The item at the end of the edge. | +Find a single Terraform state by name. -### `SastCiConfigurationEntity` +Returns [`TerraformState`](#terraformstate). -Represents an entity in SAST CI configuration. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `defaultValue` | [`String`](#string) | Default value that is used if value is empty. | -| `description` | [`String`](#string) | Entity description that is displayed on the form. | -| `field` | [`String`](#string) | CI keyword of entity. | -| `label` | [`String`](#string) | Label for entity used in the form. | -| `options` | [`SastCiConfigurationOptionsEntityConnection`](#sastciconfigurationoptionsentityconnection) | Different possible values of the field. | -| `size` | [`SastUiComponentSize`](#sastuicomponentsize) | Size of the UI component. | -| `type` | [`String`](#string) | Type of the field value. | -| `value` | [`String`](#string) | Current value of the entity. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectterraformstatename"></a>`name` | [`String!`](#string) | Name of the Terraform state. | -### `SastCiConfigurationEntityConnection` +##### `Project.vulnerabilities` -The connection type for SastCiConfigurationEntity. +Vulnerabilities reported on the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[SastCiConfigurationEntityEdge]`](#sastciconfigurationentityedge) | A list of edges. | -| `nodes` | [`[SastCiConfigurationEntity]`](#sastciconfigurationentity) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Returns [`VulnerabilityConnection`](#vulnerabilityconnection). -### `SastCiConfigurationEntityEdge` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -An edge in a connection. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`SastCiConfigurationEntity`](#sastciconfigurationentity) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectvulnerabilitieshasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have linked issues. | +| <a id="projectvulnerabilitieshasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have been resolved on default branch. | +| <a id="projectvulnerabilitiesprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. | +| <a id="projectvulnerabilitiesreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. | +| <a id="projectvulnerabilitiesscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by VulnerabilityScanner.externalId. | +| <a id="projectvulnerabilitiesscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. | +| <a id="projectvulnerabilitiesseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. | +| <a id="projectvulnerabilitiessort"></a>`sort` | [`VulnerabilitySort`](#vulnerabilitysort) | List vulnerabilities by sort order. | +| <a id="projectvulnerabilitiesstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. | -### `SastCiConfigurationOptionsEntity` +##### `Project.vulnerabilitiesCountByDay` -Represents an entity for options in SAST CI configuration. +Number of vulnerabilities per day for the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `label` | [`String`](#string) | Label of option entity. | -| `value` | [`String`](#string) | Value of option entity. | +Returns [`VulnerabilitiesCountByDayConnection`](#vulnerabilitiescountbydayconnection). -### `SastCiConfigurationOptionsEntityConnection` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -The connection type for SastCiConfigurationOptionsEntity. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[SastCiConfigurationOptionsEntityEdge]`](#sastciconfigurationoptionsentityedge) | A list of edges. | -| `nodes` | [`[SastCiConfigurationOptionsEntity]`](#sastciconfigurationoptionsentity) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectvulnerabilitiescountbydayenddate"></a>`endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. | +| <a id="projectvulnerabilitiescountbydaystartdate"></a>`startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. | -### `SastCiConfigurationOptionsEntityEdge` +##### `Project.vulnerabilitySeveritiesCount` -An edge in a connection. +Counts for each vulnerability severity in the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`SastCiConfigurationOptionsEntity`](#sastciconfigurationoptionsentity) | The item at the end of the edge. | +Returns [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount). -### `Scan` +###### Arguments -Represents the security scan information. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectvulnerabilityseveritiescountprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. | +| <a id="projectvulnerabilityseveritiescountreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. | +| <a id="projectvulnerabilityseveritiescountscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by scanner. | +| <a id="projectvulnerabilityseveritiescountseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. | +| <a id="projectvulnerabilityseveritiescountstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `errors` | [`[String!]!`](#string) | List of errors. | -| `name` | [`String!`](#string) | Name of the scan. | +### `ProjectCiCdSetting` -### `ScanConnection` +#### Fields -The connection type for Scan. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectcicdsettingkeeplatestartifact"></a>`keepLatestArtifact` | [`Boolean`](#boolean) | Whether to keep the latest builds artifacts. | +| <a id="projectcicdsettingmergepipelinesenabled"></a>`mergePipelinesEnabled` | [`Boolean`](#boolean) | Whether merge pipelines are enabled. | +| <a id="projectcicdsettingmergetrainsenabled"></a>`mergeTrainsEnabled` | [`Boolean`](#boolean) | Whether merge trains are enabled. | +| <a id="projectcicdsettingproject"></a>`project` | [`Project`](#project) | Project the CI/CD settings belong to. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ScanEdge]`](#scanedge) | A list of edges. | -| `nodes` | [`[Scan]`](#scan) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `ProjectMember` -### `ScanEdge` +Represents a Project Membership. -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Scan`](#scan) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectmemberaccesslevel"></a>`accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. | +| <a id="projectmembercreatedat"></a>`createdAt` | [`Time`](#time) | Date and time the membership was created. | +| <a id="projectmembercreatedby"></a>`createdBy` | [`UserCore`](#usercore) | User that authorized membership. | +| <a id="projectmemberexpiresat"></a>`expiresAt` | [`Time`](#time) | Date and time the membership expires. | +| <a id="projectmemberid"></a>`id` | [`ID!`](#id) | ID of the member. | +| <a id="projectmemberproject"></a>`project` | [`Project`](#project) | Project that User is a member of. | +| <a id="projectmemberupdatedat"></a>`updatedAt` | [`Time`](#time) | Date and time the membership was last updated. | +| <a id="projectmemberuser"></a>`user` | [`UserCore!`](#usercore) | User that is associated with the member object. | +| <a id="projectmemberuserpermissions"></a>`userPermissions` | [`ProjectPermissions!`](#projectpermissions) | Permissions for the current user on the resource. | -### `ScannedResource` +### `ProjectPermissions` -Represents a resource scanned by a security scan. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `requestMethod` | [`String`](#string) | The HTTP request method used to access the URL. | -| `url` | [`String`](#string) | The URL scanned by the scanner. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectpermissionsadminoperations"></a>`adminOperations` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_operations` on this resource. | +| <a id="projectpermissionsadminpathlocks"></a>`adminPathLocks` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_path_locks` on this resource. | +| <a id="projectpermissionsadminproject"></a>`adminProject` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_project` on this resource. | +| <a id="projectpermissionsadminremotemirror"></a>`adminRemoteMirror` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_remote_mirror` on this resource. | +| <a id="projectpermissionsadminwiki"></a>`adminWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_wiki` on this resource. | +| <a id="projectpermissionsarchiveproject"></a>`archiveProject` | [`Boolean!`](#boolean) | Indicates the user can perform `archive_project` on this resource. | +| <a id="projectpermissionschangenamespace"></a>`changeNamespace` | [`Boolean!`](#boolean) | Indicates the user can perform `change_namespace` on this resource. | +| <a id="projectpermissionschangevisibilitylevel"></a>`changeVisibilityLevel` | [`Boolean!`](#boolean) | Indicates the user can perform `change_visibility_level` on this resource. | +| <a id="projectpermissionscreatedeployment"></a>`createDeployment` | [`Boolean!`](#boolean) | Indicates the user can perform `create_deployment` on this resource. | +| <a id="projectpermissionscreatedesign"></a>`createDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `create_design` on this resource. | +| <a id="projectpermissionscreateissue"></a>`createIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `create_issue` on this resource. | +| <a id="projectpermissionscreatelabel"></a>`createLabel` | [`Boolean!`](#boolean) | Indicates the user can perform `create_label` on this resource. | +| <a id="projectpermissionscreatemergerequestfrom"></a>`createMergeRequestFrom` | [`Boolean!`](#boolean) | Indicates the user can perform `create_merge_request_from` on this resource. | +| <a id="projectpermissionscreatemergerequestin"></a>`createMergeRequestIn` | [`Boolean!`](#boolean) | Indicates the user can perform `create_merge_request_in` on this resource. | +| <a id="projectpermissionscreatepages"></a>`createPages` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pages` on this resource. | +| <a id="projectpermissionscreatepipeline"></a>`createPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pipeline` on this resource. | +| <a id="projectpermissionscreatepipelineschedule"></a>`createPipelineSchedule` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pipeline_schedule` on this resource. | +| <a id="projectpermissionscreatesnippet"></a>`createSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `create_snippet` on this resource. | +| <a id="projectpermissionscreatewiki"></a>`createWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `create_wiki` on this resource. | +| <a id="projectpermissionsdestroydesign"></a>`destroyDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_design` on this resource. | +| <a id="projectpermissionsdestroypages"></a>`destroyPages` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_pages` on this resource. | +| <a id="projectpermissionsdestroywiki"></a>`destroyWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_wiki` on this resource. | +| <a id="projectpermissionsdownloadcode"></a>`downloadCode` | [`Boolean!`](#boolean) | Indicates the user can perform `download_code` on this resource. | +| <a id="projectpermissionsdownloadwikicode"></a>`downloadWikiCode` | [`Boolean!`](#boolean) | Indicates the user can perform `download_wiki_code` on this resource. | +| <a id="projectpermissionsforkproject"></a>`forkProject` | [`Boolean!`](#boolean) | Indicates the user can perform `fork_project` on this resource. | +| <a id="projectpermissionspushcode"></a>`pushCode` | [`Boolean!`](#boolean) | Indicates the user can perform `push_code` on this resource. | +| <a id="projectpermissionspushtodeleteprotectedbranch"></a>`pushToDeleteProtectedBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `push_to_delete_protected_branch` on this resource. | +| <a id="projectpermissionsreadcommitstatus"></a>`readCommitStatus` | [`Boolean!`](#boolean) | Indicates the user can perform `read_commit_status` on this resource. | +| <a id="projectpermissionsreadcycleanalytics"></a>`readCycleAnalytics` | [`Boolean!`](#boolean) | Indicates the user can perform `read_cycle_analytics` on this resource. | +| <a id="projectpermissionsreaddesign"></a>`readDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `read_design` on this resource. | +| <a id="projectpermissionsreadmergerequest"></a>`readMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `read_merge_request` on this resource. | +| <a id="projectpermissionsreadpagescontent"></a>`readPagesContent` | [`Boolean!`](#boolean) | Indicates the user can perform `read_pages_content` on this resource. | +| <a id="projectpermissionsreadproject"></a>`readProject` | [`Boolean!`](#boolean) | Indicates the user can perform `read_project` on this resource. | +| <a id="projectpermissionsreadprojectmember"></a>`readProjectMember` | [`Boolean!`](#boolean) | Indicates the user can perform `read_project_member` on this resource. | +| <a id="projectpermissionsreadwiki"></a>`readWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `read_wiki` on this resource. | +| <a id="projectpermissionsremoveforkproject"></a>`removeForkProject` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_fork_project` on this resource. | +| <a id="projectpermissionsremovepages"></a>`removePages` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_pages` on this resource. | +| <a id="projectpermissionsremoveproject"></a>`removeProject` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_project` on this resource. | +| <a id="projectpermissionsrenameproject"></a>`renameProject` | [`Boolean!`](#boolean) | Indicates the user can perform `rename_project` on this resource. | +| <a id="projectpermissionsrequestaccess"></a>`requestAccess` | [`Boolean!`](#boolean) | Indicates the user can perform `request_access` on this resource. | +| <a id="projectpermissionsupdatepages"></a>`updatePages` | [`Boolean!`](#boolean) | Indicates the user can perform `update_pages` on this resource. | +| <a id="projectpermissionsupdatewiki"></a>`updateWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `update_wiki` on this resource. | +| <a id="projectpermissionsuploadfile"></a>`uploadFile` | [`Boolean!`](#boolean) | Indicates the user can perform `upload_file` on this resource. | -### `ScannedResourceConnection` +### `ProjectStatistics` -The connection type for ScannedResource. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ScannedResourceEdge]`](#scannedresourceedge) | A list of edges. | -| `nodes` | [`[ScannedResource]`](#scannedresource) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="projectstatisticsbuildartifactssize"></a>`buildArtifactsSize` | [`Float!`](#float) | Build artifacts size of the project in bytes. | +| <a id="projectstatisticscommitcount"></a>`commitCount` | [`Float!`](#float) | Commit count of the project. | +| <a id="projectstatisticslfsobjectssize"></a>`lfsObjectsSize` | [`Float!`](#float) | Large File Storage (LFS) object size of the project in bytes. | +| <a id="projectstatisticspackagessize"></a>`packagesSize` | [`Float!`](#float) | Packages size of the project in bytes. | +| <a id="projectstatisticsrepositorysize"></a>`repositorySize` | [`Float!`](#float) | Repository size of the project in bytes. | +| <a id="projectstatisticssnippetssize"></a>`snippetsSize` | [`Float`](#float) | Snippets size of the project in bytes. | +| <a id="projectstatisticsstoragesize"></a>`storageSize` | [`Float!`](#float) | Storage size of the project in bytes. | +| <a id="projectstatisticsuploadssize"></a>`uploadsSize` | [`Float`](#float) | Uploads size of the project in bytes. | +| <a id="projectstatisticswikisize"></a>`wikiSize` | [`Float`](#float) | Wiki size of the project in bytes. | -### `ScannedResourceEdge` +### `PrometheusAlert` -An edge in a connection. +The alert condition for Prometheus. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`ScannedResource`](#scannedresource) | The item at the end of the edge. | +#### Fields -### `SecurityReportSummary` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="prometheusalerthumanizedtext"></a>`humanizedText` | [`String!`](#string) | The human-readable text of the alert condition. | +| <a id="prometheusalertid"></a>`id` | [`ID!`](#id) | ID of the alert condition. | -Represents summary of a security report. +### `PushRules` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `apiFuzzing` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `api_fuzzing` scan. | -| `containerScanning` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `container_scanning` scan. | -| `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. | -| `sast` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `sast` scan. | -| `secretDetection` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `secret_detection` scan. | +Represents rules that commit pushes must follow. -### `SecurityReportSummarySection` +#### Fields -Represents a section of a summary of a security report. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pushrulesrejectunsignedcommits"></a>`rejectUnsignedCommits` | [`Boolean!`](#boolean) | Indicates whether commits not signed through GPG will be rejected. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `scannedResources` | [`ScannedResourceConnection`](#scannedresourceconnection) | A list of the first 20 scanned resources. | -| `scannedResourcesCount` | [`Int`](#int) | Total number of scanned resources. | -| `scannedResourcesCsvPath` | [`String`](#string) | Path to download all the scanned resources in CSV format. | -| `scans` | [`ScanConnection!`](#scanconnection) | List of security scans ran for the type. | -| `vulnerabilitiesCount` | [`Int`](#int) | Total number of vulnerabilities. | +### `RecentFailures` -### `SecurityScanners` +Recent failure history of a test case. -Represents a list of security scanners. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `available` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which are available for the project. | -| `enabled` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which are enabled for the project. | -| `pipelineRun` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which ran successfully in the latest pipeline. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="recentfailuresbasebranch"></a>`baseBranch` | [`String`](#string) | Name of the base branch of the project. | +| <a id="recentfailurescount"></a>`count` | [`Int`](#int) | Number of times the test case has failed in the past 14 days. | -### `SentryDetailedError` +### `Release` -A Sentry error. +Represents a release. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Count of occurrences. | -| `culprit` | [`String!`](#string) | Culprit of the error. | -| `externalBaseUrl` | [`String!`](#string) | External Base URL of the Sentry Instance. | -| `externalUrl` | [`String!`](#string) | External URL of the error. | -| `firstReleaseLastCommit` | [`String`](#string) | Commit the error was first seen. | -| `firstReleaseShortVersion` | [`String`](#string) | Release short version the error was first seen. | -| `firstReleaseVersion` | [`String`](#string) | Release version the error was first seen. | -| `firstSeen` | [`Time!`](#time) | Timestamp when the error was first seen. | -| `frequency` | [`[SentryErrorFrequency!]!`](#sentryerrorfrequency) | Last 24hr stats of the error. | -| `gitlabCommit` | [`String`](#string) | GitLab commit SHA attributed to the Error based on the release version. | -| `gitlabCommitPath` | [`String`](#string) | Path to the GitLab page for the GitLab commit attributed to the error. | -| `gitlabIssuePath` | [`String`](#string) | URL of GitLab Issue. | -| `id` | [`ID!`](#id) | ID (global ID) of the error. | -| `lastReleaseLastCommit` | [`String`](#string) | Commit the error was last seen. | -| `lastReleaseShortVersion` | [`String`](#string) | Release short version the error was last seen. | -| `lastReleaseVersion` | [`String`](#string) | Release version the error was last seen. | -| `lastSeen` | [`Time!`](#time) | Timestamp when the error was last seen. | -| `message` | [`String`](#string) | Sentry metadata message of the error. | -| `sentryId` | [`String!`](#string) | ID (Sentry ID) of the error. | -| `sentryProjectId` | [`ID!`](#id) | ID of the project (Sentry project). | -| `sentryProjectName` | [`String!`](#string) | Name of the project affected by the error. | -| `sentryProjectSlug` | [`String!`](#string) | Slug of the project affected by the error. | -| `shortId` | [`String!`](#string) | Short ID (Sentry ID) of the error. | -| `status` | [`SentryErrorStatus!`](#sentryerrorstatus) | Status of the error. | -| `tags` | [`SentryErrorTags!`](#sentryerrortags) | Tags associated with the Sentry Error. | -| `title` | [`String!`](#string) | Title of the error. | -| `type` | [`String!`](#string) | Type of the error. | -| `userCount` | [`Int!`](#int) | Count of users affected by the error. | +#### Fields -### `SentryError` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseassets"></a>`assets` | [`ReleaseAssets`](#releaseassets) | Assets of the release. | +| <a id="releaseauthor"></a>`author` | [`UserCore`](#usercore) | User that created the release. | +| <a id="releasecommit"></a>`commit` | [`Commit`](#commit) | The commit associated with the release. | +| <a id="releasecreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the release was created. | +| <a id="releasedescription"></a>`description` | [`String`](#string) | Description (also known as "release notes") of the release. | +| <a id="releasedescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="releaseevidences"></a>`evidences` | [`ReleaseEvidenceConnection`](#releaseevidenceconnection) | Evidence for the release. (see [Connections](#connections)) | +| <a id="releaselinks"></a>`links` | [`ReleaseLinks`](#releaselinks) | Links of the release. | +| <a id="releasemilestones"></a>`milestones` | [`MilestoneConnection`](#milestoneconnection) | Milestones associated to the release. (see [Connections](#connections)) | +| <a id="releasename"></a>`name` | [`String`](#string) | Name of the release. | +| <a id="releasereleasedat"></a>`releasedAt` | [`Time`](#time) | Timestamp of when the release was released. | +| <a id="releasetagname"></a>`tagName` | [`String`](#string) | Name of the tag associated with the release. | +| <a id="releasetagpath"></a>`tagPath` | [`String`](#string) | Relative web path to the tag associated with the release. | +| <a id="releaseupcomingrelease"></a>`upcomingRelease` | [`Boolean`](#boolean) | Indicates the release is an upcoming release. | -A Sentry error. A simplified version of SentryDetailedError. +### `ReleaseAssetLink` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Count of occurrences. | -| `culprit` | [`String!`](#string) | Culprit of the error. | -| `externalUrl` | [`String!`](#string) | External URL of the error. | -| `firstSeen` | [`Time!`](#time) | Timestamp when the error was first seen. | -| `frequency` | [`[SentryErrorFrequency!]!`](#sentryerrorfrequency) | Last 24hr stats of the error. | -| `id` | [`ID!`](#id) | ID (global ID) of the error. | -| `lastSeen` | [`Time!`](#time) | Timestamp when the error was last seen. | -| `message` | [`String`](#string) | Sentry metadata message of the error. | -| `sentryId` | [`String!`](#string) | ID (Sentry ID) of the error. | -| `sentryProjectId` | [`ID!`](#id) | ID of the project (Sentry project). | -| `sentryProjectName` | [`String!`](#string) | Name of the project affected by the error. | -| `sentryProjectSlug` | [`String!`](#string) | Slug of the project affected by the error. | -| `shortId` | [`String!`](#string) | Short ID (Sentry ID) of the error. | -| `status` | [`SentryErrorStatus!`](#sentryerrorstatus) | Status of the error. | -| `title` | [`String!`](#string) | Title of the error. | -| `type` | [`String!`](#string) | Type of the error. | -| `userCount` | [`Int!`](#int) | Count of users affected by the error. | +Represents an asset link associated with a release. -### `SentryErrorCollection` +#### Fields -An object containing a collection of Sentry errors, and a detailed error. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseassetlinkdirectasseturl"></a>`directAssetUrl` | [`String`](#string) | Direct asset URL of the link. | +| <a id="releaseassetlinkexternal"></a>`external` | [`Boolean`](#boolean) | Indicates the link points to an external resource. | +| <a id="releaseassetlinkid"></a>`id` | [`ID!`](#id) | ID of the link. | +| <a id="releaseassetlinklinktype"></a>`linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`. | +| <a id="releaseassetlinkname"></a>`name` | [`String`](#string) | Name of the link. | +| <a id="releaseassetlinkurl"></a>`url` | [`String`](#string) | URL of the link. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `detailedError` | [`SentryDetailedError`](#sentrydetailederror) | Detailed version of a Sentry error on the project. | -| `errorStackTrace` | [`SentryErrorStackTrace`](#sentryerrorstacktrace) | Stack Trace of Sentry Error. | -| `errors` | [`SentryErrorConnection`](#sentryerrorconnection) | Collection of Sentry Errors. | -| `externalUrl` | [`String`](#string) | External URL for Sentry. | +### `ReleaseAssets` -### `SentryErrorConnection` +A container for all assets associated with a release. -The connection type for SentryError. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[SentryErrorEdge]`](#sentryerroredge) | A list of edges. | -| `nodes` | [`[SentryError]`](#sentryerror) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseassetscount"></a>`count` | [`Int`](#int) | Number of assets of the release. | +| <a id="releaseassetslinks"></a>`links` | [`ReleaseAssetLinkConnection`](#releaseassetlinkconnection) | Asset links of the release. (see [Connections](#connections)) | +| <a id="releaseassetssources"></a>`sources` | [`ReleaseSourceConnection`](#releasesourceconnection) | Sources of the release. (see [Connections](#connections)) | -### `SentryErrorEdge` +### `ReleaseEvidence` -An edge in a connection. +Evidence for a release. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`SentryError`](#sentryerror) | The item at the end of the edge. | +#### Fields -### `SentryErrorFrequency` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseevidencecollectedat"></a>`collectedAt` | [`Time`](#time) | Timestamp when the evidence was collected. | +| <a id="releaseevidencefilepath"></a>`filepath` | [`String`](#string) | URL from where the evidence can be downloaded. | +| <a id="releaseevidenceid"></a>`id` | [`ID!`](#id) | ID of the evidence. | +| <a id="releaseevidencesha"></a>`sha` | [`String`](#string) | SHA1 ID of the evidence hash. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Count of errors received since the previously recorded time. | -| `time` | [`Time!`](#time) | Time the error frequency stats were recorded. | +### `ReleaseLinks` -### `SentryErrorStackTrace` +#### Fields -An object containing a stack trace entry for a Sentry error. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaselinksclosedissuesurl"></a>`closedIssuesUrl` | [`String`](#string) | HTTP URL of the issues page, filtered by this release and `state=closed`. | +| <a id="releaselinksclosedmergerequestsurl"></a>`closedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page , filtered by this release and `state=closed`. | +| <a id="releaselinksediturl"></a>`editUrl` | [`String`](#string) | HTTP URL of the release's edit page. | +| <a id="releaselinksmergedmergerequestsurl"></a>`mergedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page , filtered by this release and `state=merged`. | +| <a id="releaselinksopenedissuesurl"></a>`openedIssuesUrl` | [`String`](#string) | HTTP URL of the issues page, filtered by this release and `state=open`. | +| <a id="releaselinksopenedmergerequestsurl"></a>`openedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page, filtered by this release and `state=open`. | +| <a id="releaselinksselfurl"></a>`selfUrl` | [`String`](#string) | HTTP URL of the release. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `dateReceived` | [`String!`](#string) | Time the stack trace was received by Sentry. | -| `issueId` | [`String!`](#string) | ID of the Sentry error. | -| `stackTraceEntries` | [`[SentryErrorStackTraceEntry!]!`](#sentryerrorstacktraceentry) | Stack trace entries for the Sentry error. | +### `ReleaseSource` -### `SentryErrorStackTraceContext` +Represents the source code attached to a release in a particular format. -An object context for a Sentry error stack trace. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `code` | [`String!`](#string) | Code number of the context. | -| `line` | [`Int!`](#int) | Line number of the context. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releasesourceformat"></a>`format` | [`String`](#string) | Format of the source. | +| <a id="releasesourceurl"></a>`url` | [`String`](#string) | Download URL of the source. | -### `SentryErrorStackTraceEntry` +### `Repository` -An object containing a stack trace entry for a Sentry error. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `col` | [`String`](#string) | Function in which the Sentry error occurred. | -| `fileName` | [`String`](#string) | File in which the Sentry error occurred. | -| `function` | [`String`](#string) | Function in which the Sentry error occurred. | -| `line` | [`String`](#string) | Function in which the Sentry error occurred. | -| `traceContext` | [`[SentryErrorStackTraceContext!]`](#sentryerrorstacktracecontext) | Context of the Sentry error. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="repositorydiskpath"></a>`diskPath` | [`String`](#string) | Shows a disk path of the repository. | +| <a id="repositoryempty"></a>`empty` | [`Boolean!`](#boolean) | Indicates repository has no visible content. | +| <a id="repositoryexists"></a>`exists` | [`Boolean!`](#boolean) | Indicates a corresponding Git repository exists on disk. | +| <a id="repositoryrootref"></a>`rootRef` | [`String`](#string) | Default branch of the repository. | -### `SentryErrorTags` +#### Fields with arguments -State of a Sentry error. +##### `Repository.blobs` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `level` | [`String`](#string) | Severity level of the Sentry Error. | -| `logger` | [`String`](#string) | Logger of the Sentry Error. | +Blobs contained within the repository. -### `ServiceConnection` +Returns [`RepositoryBlobConnection`](#repositoryblobconnection). -The connection type for Service. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[ServiceEdge]`](#serviceedge) | A list of edges. | -| `nodes` | [`[Service]`](#service) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +###### Arguments -### `ServiceEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="repositoryblobspaths"></a>`paths` | [`[String!]!`](#string) | Array of desired blob paths. | +| <a id="repositoryblobsref"></a>`ref` | [`String`](#string) | The commit ref to get the blobs from. Default value is HEAD. | -An edge in a connection. +##### `Repository.branchNames` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Service`](#service) | The item at the end of the edge. | +Names of branches available in this repository that match the search pattern. -### `Snippet` +Returns [`[String!]`](#string). -Represents a snippet entry. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `author` | [`User`](#user) | The owner of the snippet. | -| `blob` **{warning-solid}** | [`SnippetBlob!`](#snippetblob) | **Deprecated** in 13.3. Use `blobs`. | -| `blobs` | [`SnippetBlobConnection`](#snippetblobconnection) | Snippet blobs. | -| `createdAt` | [`Time!`](#time) | Timestamp this snippet was created. | -| `description` | [`String`](#string) | Description of the snippet. | -| `descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `fileName` | [`String`](#string) | File Name of the snippet. | -| `httpUrlToRepo` | [`String`](#string) | HTTP URL to the snippet repository. | -| `id` | [`SnippetID!`](#snippetid) | ID of the snippet. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `project` | [`Project`](#project) | The project the snippet is associated with. | -| `rawUrl` | [`String!`](#string) | Raw URL of the snippet. | -| `sshUrlToRepo` | [`String`](#string) | SSH URL to the snippet repository. | -| `title` | [`String!`](#string) | Title of the snippet. | -| `updatedAt` | [`Time!`](#time) | Timestamp this snippet was updated. | -| `userPermissions` | [`SnippetPermissions!`](#snippetpermissions) | Permissions for the current user on the resource. | -| `visibilityLevel` | [`VisibilityLevelsEnum!`](#visibilitylevelsenum) | Visibility Level of the snippet. | -| `webUrl` | [`String!`](#string) | Web URL of the snippet. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="repositorybranchnameslimit"></a>`limit` | [`Int!`](#int) | The number of branch names to return. | +| <a id="repositorybranchnamesoffset"></a>`offset` | [`Int!`](#int) | The number of branch names to skip. | +| <a id="repositorybranchnamessearchpattern"></a>`searchPattern` | [`String!`](#string) | The pattern to search for branch names by. | -### `SnippetBlob` +##### `Repository.tree` -Represents the snippet blob. +Tree of the repository. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `binary` | [`Boolean!`](#boolean) | Shows whether the blob is binary. | -| `externalStorage` | [`String`](#string) | Blob external storage. | -| `mode` | [`String`](#string) | Blob mode. | -| `name` | [`String`](#string) | Blob name. | -| `path` | [`String`](#string) | Blob path. | -| `plainData` | [`String`](#string) | Blob plain highlighted data. | -| `rawPath` | [`String!`](#string) | Blob raw content endpoint path. | -| `renderedAsText` | [`Boolean!`](#boolean) | Shows whether the blob is rendered as text. | -| `richData` | [`String`](#string) | Blob highlighted data. | -| `richViewer` | [`SnippetBlobViewer`](#snippetblobviewer) | Blob content rich viewer. | -| `simpleViewer` | [`SnippetBlobViewer!`](#snippetblobviewer) | Blob content simple viewer. | -| `size` | [`Int!`](#int) | Blob size. | +Returns [`Tree`](#tree). -### `SnippetBlobConnection` +###### Arguments -The connection type for SnippetBlob. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="repositorytreepath"></a>`path` | [`String`](#string) | The path to get the tree for. Default value is the root of the repository. | +| <a id="repositorytreerecursive"></a>`recursive` | [`Boolean`](#boolean) | Used to get a recursive tree. Default is false. | +| <a id="repositorytreeref"></a>`ref` | [`String`](#string) | The commit ref to get the tree for. Default value is HEAD. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[SnippetBlobEdge]`](#snippetblobedge) | A list of edges. | -| `nodes` | [`[SnippetBlob]`](#snippetblob) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `RepositoryBlob` -### `SnippetBlobEdge` +#### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="repositoryblobcanmodifyblob"></a>`canModifyBlob` | [`Boolean`](#boolean) | Whether the current user can modify the blob. | +| <a id="repositoryblobeditblobpath"></a>`editBlobPath` | [`String`](#string) | Web path to edit the blob in the old-style editor. | +| <a id="repositoryblobexternalstorageurl"></a>`externalStorageUrl` | [`String`](#string) | Web path to download the raw blob via external storage, if enabled. | +| <a id="repositoryblobfiletype"></a>`fileType` | [`String`](#string) | The expected format of the blob based on the extension. | +| <a id="repositoryblobforkandeditpath"></a>`forkAndEditPath` | [`String`](#string) | Web path to edit this blob using a forked project. | +| <a id="repositoryblobid"></a>`id` | [`ID!`](#id) | ID of the blob. | +| <a id="repositoryblobideeditpath"></a>`ideEditPath` | [`String`](#string) | Web path to edit this blob in the Web IDE. | +| <a id="repositoryblobideforkandeditpath"></a>`ideForkAndEditPath` | [`String`](#string) | Web path to edit this blob in the Web IDE using a forked project. | +| <a id="repositorybloblfsoid"></a>`lfsOid` | [`String`](#string) | LFS OID of the blob. | +| <a id="repositoryblobmode"></a>`mode` | [`String`](#string) | Blob mode. | +| <a id="repositoryblobname"></a>`name` | [`String`](#string) | Blob name. | +| <a id="repositorybloboid"></a>`oid` | [`String!`](#string) | OID of the blob. | +| <a id="repositoryblobpath"></a>`path` | [`String!`](#string) | Path of the blob. | +| <a id="repositoryblobplaindata"></a>`plainData` | [`String`](#string) | Blob plain highlighted data. | +| <a id="repositoryblobrawblob"></a>`rawBlob` | [`String`](#string) | The raw content of the blob. | +| <a id="repositoryblobrawpath"></a>`rawPath` | [`String`](#string) | Web path to download the raw blob. | +| <a id="repositoryblobrawsize"></a>`rawSize` | [`Int`](#int) | Size (in bytes) of the blob, or the blob target if stored externally. | +| <a id="repositoryblobrawtextblob"></a>`rawTextBlob` | [`String`](#string) | The raw content of the blob, if the blob is text data. | +| <a id="repositoryblobreplacepath"></a>`replacePath` | [`String`](#string) | Web path to replace the blob content. | +| <a id="repositoryblobrichviewer"></a>`richViewer` | [`BlobViewer`](#blobviewer) | Blob content rich viewer. | +| <a id="repositoryblobsimpleviewer"></a>`simpleViewer` | [`BlobViewer!`](#blobviewer) | Blob content simple viewer. | +| <a id="repositoryblobsize"></a>`size` | [`Int`](#int) | Size (in bytes) of the blob. | +| <a id="repositoryblobstoredexternally"></a>`storedExternally` | [`Boolean`](#boolean) | Whether the blob's content is stored externally (for instance, in LFS). | +| <a id="repositoryblobwebpath"></a>`webPath` | [`String`](#string) | Web path of the blob. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`SnippetBlob`](#snippetblob) | The item at the end of the edge. | +### `Requirement` -### `SnippetBlobViewer` +Represents a requirement. -Represents how the blob content should be displayed. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `collapsed` | [`Boolean!`](#boolean) | Shows whether the blob should be displayed collapsed. | -| `fileType` | [`String!`](#string) | Content file type. | -| `loadAsync` | [`Boolean!`](#boolean) | Shows whether the blob content is loaded asynchronously. | -| `loadingPartialName` | [`String!`](#string) | Loading partial name. | -| `renderError` | [`String`](#string) | Error rendering the blob content. | -| `tooLarge` | [`Boolean!`](#boolean) | Shows whether the blob too large to be displayed. | -| `type` | [`BlobViewersType!`](#blobviewerstype) | Type of blob viewer. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="requirementauthor"></a>`author` | [`UserCore!`](#usercore) | Author of the requirement. | +| <a id="requirementcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the requirement was created. | +| <a id="requirementdescription"></a>`description` | [`String`](#string) | Description of the requirement. | +| <a id="requirementdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="requirementid"></a>`id` | [`ID!`](#id) | ID of the requirement. | +| <a id="requirementiid"></a>`iid` | [`ID!`](#id) | Internal ID of the requirement. | +| <a id="requirementlasttestreportmanuallycreated"></a>`lastTestReportManuallyCreated` | [`Boolean`](#boolean) | Indicates if latest test report was created by user. | +| <a id="requirementlasttestreportstate"></a>`lastTestReportState` | [`TestReportState`](#testreportstate) | Latest requirement test report state. | +| <a id="requirementproject"></a>`project` | [`Project!`](#project) | Project to which the requirement belongs. | +| <a id="requirementstate"></a>`state` | [`RequirementState!`](#requirementstate) | State of the requirement. | +| <a id="requirementtitle"></a>`title` | [`String`](#string) | Title of the requirement. | +| <a id="requirementtitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. | +| <a id="requirementupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the requirement was last updated. | +| <a id="requirementuserpermissions"></a>`userPermissions` | [`RequirementPermissions!`](#requirementpermissions) | Permissions for the current user on the resource. | -### `SnippetConnection` +#### Fields with arguments -The connection type for Snippet. +##### `Requirement.testReports` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[SnippetEdge]`](#snippetedge) | A list of edges. | -| `nodes` | [`[Snippet]`](#snippet) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Test reports of the requirement. -### `SnippetEdge` +Returns [`TestReportConnection`](#testreportconnection). -An edge in a connection. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Snippet`](#snippet) | The item at the end of the edge. | +###### Arguments -### `SnippetPermissions` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="requirementtestreportssort"></a>`sort` | [`Sort`](#sort) | List test reports by sort order. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_snippet` on this resource. | -| `awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. | -| `createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | -| `readSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `read_snippet` on this resource. | -| `reportSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `report_snippet` on this resource. | -| `updateSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `update_snippet` on this resource. | +### `RequirementPermissions` -### `SnippetRepositoryRegistry` +Check permissions for the current user on a requirement. -Represents the Geo sync and verification state of a snippet repository. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp when the SnippetRepositoryRegistry was created. | -| `id` | [`ID!`](#id) | ID of the SnippetRepositoryRegistry. | -| `lastSyncFailure` | [`String`](#string) | Error message during sync of the SnippetRepositoryRegistry. | -| `lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the SnippetRepositoryRegistry. | -| `retryAt` | [`Time`](#time) | Timestamp after which the SnippetRepositoryRegistry should be resynced. | -| `retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the SnippetRepositoryRegistry. | -| `snippetRepositoryId` | [`ID!`](#id) | ID of the Snippet Repository. | -| `state` | [`RegistryState`](#registrystate) | Sync state of the SnippetRepositoryRegistry. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="requirementpermissionsadminrequirement"></a>`adminRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_requirement` on this resource. | +| <a id="requirementpermissionscreaterequirement"></a>`createRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `create_requirement` on this resource. | +| <a id="requirementpermissionsdestroyrequirement"></a>`destroyRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_requirement` on this resource. | +| <a id="requirementpermissionsreadrequirement"></a>`readRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `read_requirement` on this resource. | +| <a id="requirementpermissionsupdaterequirement"></a>`updateRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `update_requirement` on this resource. | -### `SnippetRepositoryRegistryConnection` +### `RequirementStatesCount` -The connection type for SnippetRepositoryRegistry. +Counts of requirements by their state. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[SnippetRepositoryRegistryEdge]`](#snippetrepositoryregistryedge) | A list of edges. | -| `nodes` | [`[SnippetRepositoryRegistry]`](#snippetrepositoryregistry) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### Fields -### `SnippetRepositoryRegistryEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="requirementstatescountarchived"></a>`archived` | [`Int`](#int) | Number of archived requirements. | +| <a id="requirementstatescountopened"></a>`opened` | [`Int`](#int) | Number of opened requirements. | -An edge in a connection. +### `RootStorageStatistics` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`SnippetRepositoryRegistry`](#snippetrepositoryregistry) | The item at the end of the edge. | +#### Fields -### `StatusAction` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="rootstoragestatisticsbuildartifactssize"></a>`buildArtifactsSize` | [`Float!`](#float) | The CI artifacts size in bytes. | +| <a id="rootstoragestatisticslfsobjectssize"></a>`lfsObjectsSize` | [`Float!`](#float) | The LFS objects size in bytes. | +| <a id="rootstoragestatisticspackagessize"></a>`packagesSize` | [`Float!`](#float) | The packages size in bytes. | +| <a id="rootstoragestatisticspipelineartifactssize"></a>`pipelineArtifactsSize` | [`Float!`](#float) | The CI pipeline artifacts size in bytes. | +| <a id="rootstoragestatisticsrepositorysize"></a>`repositorySize` | [`Float!`](#float) | The Git repository size in bytes. | +| <a id="rootstoragestatisticssnippetssize"></a>`snippetsSize` | [`Float!`](#float) | The snippets size in bytes. | +| <a id="rootstoragestatisticsstoragesize"></a>`storageSize` | [`Float!`](#float) | The total storage in bytes. | +| <a id="rootstoragestatisticsuploadssize"></a>`uploadsSize` | [`Float!`](#float) | The uploads size in bytes. | +| <a id="rootstoragestatisticswikisize"></a>`wikiSize` | [`Float!`](#float) | The wiki size in bytes. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `buttonTitle` | [`String`](#string) | Title for the button, for example: Retry this job. | -| `icon` | [`String`](#string) | Icon used in the action button. | -| `method` | [`String`](#string) | Method for the action, for example: :post. | -| `path` | [`String`](#string) | Path for the action. | -| `title` | [`String`](#string) | Title for the action, for example: Retry. | +### `RunDASTScanPayload` -### `Submodule` +Autogenerated return type of RunDASTScan. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `flatPath` | [`String!`](#string) | Flat path of the entry. | -| `id` | [`ID!`](#id) | ID of the entry. | -| `name` | [`String!`](#string) | Name of the entry. | -| `path` | [`String!`](#string) | Path of the entry. | -| `sha` | [`String!`](#string) | Last commit SHA for the entry. | -| `treeUrl` | [`String`](#string) | Tree URL for the sub-module. | -| `type` | [`EntryType!`](#entrytype) | Type of tree entry. | -| `webUrl` | [`String`](#string) | Web URL for the sub-module. | +#### Fields -### `SubmoduleConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="rundastscanpayloadclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | +| <a id="rundastscanpayloaderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| <a id="rundastscanpayloadpipelineurl"></a>`pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. | -The connection type for Submodule. +### `RunnerArchitecture` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[SubmoduleEdge]`](#submoduleedge) | A list of edges. | -| `nodes` | [`[Submodule]`](#submodule) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### Fields -### `SubmoduleEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="runnerarchitecturedownloadlocation"></a>`downloadLocation` | [`String!`](#string) | Download location for the runner for the platform architecture. | +| <a id="runnerarchitecturename"></a>`name` | [`String!`](#string) | Name of the runner platform architecture. | -An edge in a connection. +### `RunnerPlatform` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Submodule`](#submodule) | The item at the end of the edge. | +#### Fields -### `TaskCompletionStatus` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="runnerplatformarchitectures"></a>`architectures` | [`RunnerArchitectureConnection`](#runnerarchitectureconnection) | Runner architectures supported for the platform. (see [Connections](#connections)) | +| <a id="runnerplatformhumanreadablename"></a>`humanReadableName` | [`String!`](#string) | Human readable name of the runner platform. | +| <a id="runnerplatformname"></a>`name` | [`String!`](#string) | Name slug of the runner platform. | -Completion status of tasks. +### `RunnerSetup` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `completedCount` | [`Int!`](#int) | Number of completed tasks. | -| `count` | [`Int!`](#int) | Number of total tasks. | +#### Fields -### `TerraformState` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="runnersetupinstallinstructions"></a>`installInstructions` | [`String!`](#string) | Instructions for installing the runner on the specified architecture. | +| <a id="runnersetupregisterinstructions"></a>`registerInstructions` | [`String`](#string) | Instructions for registering the runner. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Timestamp the Terraform state was created. | -| `id` | [`ID!`](#id) | ID of the Terraform state. | -| `latestVersion` | [`TerraformStateVersion`](#terraformstateversion) | The latest version of the Terraform state. | -| `lockedAt` | [`Time`](#time) | Timestamp the Terraform state was locked. | -| `lockedByUser` | [`User`](#user) | The user currently holding a lock on the Terraform state. | -| `name` | [`String!`](#string) | Name of the Terraform state. | -| `updatedAt` | [`Time!`](#time) | Timestamp the Terraform state was updated. | +### `SastCiConfiguration` -### `TerraformStateConnection` +Represents a CI configuration of SAST. -The connection type for TerraformState. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[TerraformStateEdge]`](#terraformstateedge) | A list of edges. | -| `nodes` | [`[TerraformState]`](#terraformstate) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationanalyzers"></a>`analyzers` | [`SastCiConfigurationAnalyzersEntityConnection`](#sastciconfigurationanalyzersentityconnection) | List of analyzers entities attached to SAST configuration. (see [Connections](#connections)) | +| <a id="sastciconfigurationglobal"></a>`global` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of global entities related to SAST configuration. (see [Connections](#connections)) | +| <a id="sastciconfigurationpipeline"></a>`pipeline` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of pipeline entities related to SAST configuration. (see [Connections](#connections)) | -### `TerraformStateDeletePayload` +### `SastCiConfigurationAnalyzersEntity` -Autogenerated return type of TerraformStateDelete. +Represents an analyzer entity in SAST CI configuration. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### Fields -### `TerraformStateEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationanalyzersentitydescription"></a>`description` | [`String`](#string) | Analyzer description that is displayed on the form. | +| <a id="sastciconfigurationanalyzersentityenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether an analyzer is enabled. | +| <a id="sastciconfigurationanalyzersentitylabel"></a>`label` | [`String`](#string) | Analyzer label used in the config UI. | +| <a id="sastciconfigurationanalyzersentityname"></a>`name` | [`String`](#string) | Name of the analyzer. | +| <a id="sastciconfigurationanalyzersentityvariables"></a>`variables` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of supported variables. (see [Connections](#connections)) | -An edge in a connection. +### `SastCiConfigurationEntity` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`TerraformState`](#terraformstate) | The item at the end of the edge. | +Represents an entity in SAST CI configuration. -### `TerraformStateLockPayload` +#### Fields -Autogenerated return type of TerraformStateLock. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationentitydefaultvalue"></a>`defaultValue` | [`String`](#string) | Default value that is used if value is empty. | +| <a id="sastciconfigurationentitydescription"></a>`description` | [`String`](#string) | Entity description that is displayed on the form. | +| <a id="sastciconfigurationentityfield"></a>`field` | [`String`](#string) | CI keyword of entity. | +| <a id="sastciconfigurationentitylabel"></a>`label` | [`String`](#string) | Label for entity used in the form. | +| <a id="sastciconfigurationentityoptions"></a>`options` | [`SastCiConfigurationOptionsEntityConnection`](#sastciconfigurationoptionsentityconnection) | Different possible values of the field. (see [Connections](#connections)) | +| <a id="sastciconfigurationentitysize"></a>`size` | [`SastUiComponentSize`](#sastuicomponentsize) | Size of the UI component. | +| <a id="sastciconfigurationentitytype"></a>`type` | [`String`](#string) | Type of the field value. | +| <a id="sastciconfigurationentityvalue"></a>`value` | [`String`](#string) | Current value of the entity. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +### `SastCiConfigurationOptionsEntity` -### `TerraformStateUnlockPayload` +Represents an entity for options in SAST CI configuration. -Autogenerated return type of TerraformStateUnlock. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationoptionsentitylabel"></a>`label` | [`String`](#string) | Label of option entity. | +| <a id="sastciconfigurationoptionsentityvalue"></a>`value` | [`String`](#string) | Value of option entity. | -### `TerraformStateVersion` +### `Scan` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Timestamp the version was created. | -| `createdByUser` | [`User`](#user) | The user that created this version. | -| `downloadPath` | [`String`](#string) | URL for downloading the version's JSON file. | -| `id` | [`ID!`](#id) | ID of the Terraform state version. | -| `job` | [`CiJob`](#cijob) | The job that created this version. | -| `serial` | [`Int`](#int) | Serial number of the version. | -| `updatedAt` | [`Time!`](#time) | Timestamp the version was updated. | +Represents the security scan information. -### `TerraformStateVersionRegistry` +#### Fields -Represents the Geo sync and verification state of a terraform state version. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="scanerrors"></a>`errors` | [`[String!]!`](#string) | List of errors. | +| <a id="scanname"></a>`name` | [`String!`](#string) | Name of the scan. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time`](#time) | Timestamp when the TerraformStateVersionRegistry was created. | -| `id` | [`ID!`](#id) | ID of the TerraformStateVersionRegistry. | -| `lastSyncFailure` | [`String`](#string) | Error message during sync of the TerraformStateVersionRegistry. | -| `lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the TerraformStateVersionRegistry. | -| `retryAt` | [`Time`](#time) | Timestamp after which the TerraformStateVersionRegistry should be resynced. | -| `retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the TerraformStateVersionRegistry. | -| `state` | [`RegistryState`](#registrystate) | Sync state of the TerraformStateVersionRegistry. | -| `terraformStateVersionId` | [`ID!`](#id) | ID of the terraform state version. | +### `ScannedResource` -### `TerraformStateVersionRegistryConnection` +Represents a resource scanned by a security scan. -The connection type for TerraformStateVersionRegistry. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[TerraformStateVersionRegistryEdge]`](#terraformstateversionregistryedge) | A list of edges. | -| `nodes` | [`[TerraformStateVersionRegistry]`](#terraformstateversionregistry) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="scannedresourcerequestmethod"></a>`requestMethod` | [`String`](#string) | The HTTP request method used to access the URL. | +| <a id="scannedresourceurl"></a>`url` | [`String`](#string) | The URL scanned by the scanner. | -### `TerraformStateVersionRegistryEdge` +### `SecurityReportSummary` -An edge in a connection. +Represents summary of a security report. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`TerraformStateVersionRegistry`](#terraformstateversionregistry) | The item at the end of the edge. | +#### Fields -### `TestCase` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="securityreportsummaryapifuzzing"></a>`apiFuzzing` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `api_fuzzing` scan. | +| <a id="securityreportsummarycontainerscanning"></a>`containerScanning` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `container_scanning` scan. | +| <a id="securityreportsummarycoveragefuzzing"></a>`coverageFuzzing` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `coverage_fuzzing` scan. | +| <a id="securityreportsummarydast"></a>`dast` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `dast` scan. | +| <a id="securityreportsummarydependencyscanning"></a>`dependencyScanning` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `dependency_scanning` scan. | +| <a id="securityreportsummarysast"></a>`sast` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `sast` scan. | +| <a id="securityreportsummarysecretdetection"></a>`secretDetection` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `secret_detection` scan. | -Test case in pipeline test report. +### `SecurityReportSummarySection` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `attachmentUrl` | [`String`](#string) | URL of the test case attachment file. | -| `classname` | [`String`](#string) | Classname of the test case. | -| `executionTime` | [`Float`](#float) | Test case execution time in seconds. | -| `file` | [`String`](#string) | Path to the file of the test case. | -| `name` | [`String`](#string) | Name of the test case. | -| `recentFailures` | [`RecentFailures`](#recentfailures) | Recent failure history of the test case on the base branch. | -| `stackTrace` | [`String`](#string) | Stack trace of the test case. | -| `status` | [`TestCaseStatus`](#testcasestatus) | Status of the test case (error, failed, success, skipped). | -| `systemOutput` | [`String`](#string) | System output of the test case. | +Represents a section of a summary of a security report. -### `TestCaseConnection` +#### Fields -The connection type for TestCase. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="securityreportsummarysectionscannedresources"></a>`scannedResources` | [`ScannedResourceConnection`](#scannedresourceconnection) | A list of the first 20 scanned resources. (see [Connections](#connections)) | +| <a id="securityreportsummarysectionscannedresourcescount"></a>`scannedResourcesCount` | [`Int`](#int) | Total number of scanned resources. | +| <a id="securityreportsummarysectionscannedresourcescsvpath"></a>`scannedResourcesCsvPath` | [`String`](#string) | Path to download all the scanned resources in CSV format. | +| <a id="securityreportsummarysectionscans"></a>`scans` | [`ScanConnection!`](#scanconnection) | List of security scans ran for the type. (see [Connections](#connections)) | +| <a id="securityreportsummarysectionvulnerabilitiescount"></a>`vulnerabilitiesCount` | [`Int`](#int) | Total number of vulnerabilities. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[TestCaseEdge]`](#testcaseedge) | A list of edges. | -| `nodes` | [`[TestCase]`](#testcase) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `SecurityScanners` -### `TestCaseEdge` +Represents a list of security scanners. -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`TestCase`](#testcase) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="securityscannersavailable"></a>`available` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which are available for the project. | +| <a id="securityscannersenabled"></a>`enabled` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which are enabled for the project. | +| <a id="securityscannerspipelinerun"></a>`pipelineRun` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which ran successfully in the latest pipeline. | -### `TestReport` +### `SentryDetailedError` -Represents a requirement test report. +A Sentry error. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `author` | [`User`](#user) | Author of the test report. | -| `createdAt` | [`Time!`](#time) | Timestamp of when the test report was created. | -| `id` | [`ID!`](#id) | ID of the test report. | -| `state` | [`TestReportState!`](#testreportstate) | State of the test report. | +#### Fields -### `TestReportConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentrydetailederrorcount"></a>`count` | [`Int!`](#int) | Count of occurrences. | +| <a id="sentrydetailederrorculprit"></a>`culprit` | [`String!`](#string) | Culprit of the error. | +| <a id="sentrydetailederrorexternalbaseurl"></a>`externalBaseUrl` | [`String!`](#string) | External Base URL of the Sentry Instance. | +| <a id="sentrydetailederrorexternalurl"></a>`externalUrl` | [`String!`](#string) | External URL of the error. | +| <a id="sentrydetailederrorfirstreleaselastcommit"></a>`firstReleaseLastCommit` | [`String`](#string) | Commit the error was first seen. | +| <a id="sentrydetailederrorfirstreleaseshortversion"></a>`firstReleaseShortVersion` | [`String`](#string) | Release short version the error was first seen. | +| <a id="sentrydetailederrorfirstreleaseversion"></a>`firstReleaseVersion` | [`String`](#string) | Release version the error was first seen. | +| <a id="sentrydetailederrorfirstseen"></a>`firstSeen` | [`Time!`](#time) | Timestamp when the error was first seen. | +| <a id="sentrydetailederrorfrequency"></a>`frequency` | [`[SentryErrorFrequency!]!`](#sentryerrorfrequency) | Last 24hr stats of the error. | +| <a id="sentrydetailederrorgitlabcommit"></a>`gitlabCommit` | [`String`](#string) | GitLab commit SHA attributed to the Error based on the release version. | +| <a id="sentrydetailederrorgitlabcommitpath"></a>`gitlabCommitPath` | [`String`](#string) | Path to the GitLab page for the GitLab commit attributed to the error. | +| <a id="sentrydetailederrorgitlabissuepath"></a>`gitlabIssuePath` | [`String`](#string) | URL of GitLab Issue. | +| <a id="sentrydetailederrorid"></a>`id` | [`ID!`](#id) | ID (global ID) of the error. | +| <a id="sentrydetailederrorlastreleaselastcommit"></a>`lastReleaseLastCommit` | [`String`](#string) | Commit the error was last seen. | +| <a id="sentrydetailederrorlastreleaseshortversion"></a>`lastReleaseShortVersion` | [`String`](#string) | Release short version the error was last seen. | +| <a id="sentrydetailederrorlastreleaseversion"></a>`lastReleaseVersion` | [`String`](#string) | Release version the error was last seen. | +| <a id="sentrydetailederrorlastseen"></a>`lastSeen` | [`Time!`](#time) | Timestamp when the error was last seen. | +| <a id="sentrydetailederrormessage"></a>`message` | [`String`](#string) | Sentry metadata message of the error. | +| <a id="sentrydetailederrorsentryid"></a>`sentryId` | [`String!`](#string) | ID (Sentry ID) of the error. | +| <a id="sentrydetailederrorsentryprojectid"></a>`sentryProjectId` | [`ID!`](#id) | ID of the project (Sentry project). | +| <a id="sentrydetailederrorsentryprojectname"></a>`sentryProjectName` | [`String!`](#string) | Name of the project affected by the error. | +| <a id="sentrydetailederrorsentryprojectslug"></a>`sentryProjectSlug` | [`String!`](#string) | Slug of the project affected by the error. | +| <a id="sentrydetailederrorshortid"></a>`shortId` | [`String!`](#string) | Short ID (Sentry ID) of the error. | +| <a id="sentrydetailederrorstatus"></a>`status` | [`SentryErrorStatus!`](#sentryerrorstatus) | Status of the error. | +| <a id="sentrydetailederrortags"></a>`tags` | [`SentryErrorTags!`](#sentryerrortags) | Tags associated with the Sentry Error. | +| <a id="sentrydetailederrortitle"></a>`title` | [`String!`](#string) | Title of the error. | +| <a id="sentrydetailederrortype"></a>`type` | [`String!`](#string) | Type of the error. | +| <a id="sentrydetailederrorusercount"></a>`userCount` | [`Int!`](#int) | Count of users affected by the error. | -The connection type for TestReport. +### `SentryError` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[TestReportEdge]`](#testreportedge) | A list of edges. | -| `nodes` | [`[TestReport]`](#testreport) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +A Sentry error. A simplified version of SentryDetailedError. -### `TestReportEdge` +#### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorcount"></a>`count` | [`Int!`](#int) | Count of occurrences. | +| <a id="sentryerrorculprit"></a>`culprit` | [`String!`](#string) | Culprit of the error. | +| <a id="sentryerrorexternalurl"></a>`externalUrl` | [`String!`](#string) | External URL of the error. | +| <a id="sentryerrorfirstseen"></a>`firstSeen` | [`Time!`](#time) | Timestamp when the error was first seen. | +| <a id="sentryerrorfrequency"></a>`frequency` | [`[SentryErrorFrequency!]!`](#sentryerrorfrequency) | Last 24hr stats of the error. | +| <a id="sentryerrorid"></a>`id` | [`ID!`](#id) | ID (global ID) of the error. | +| <a id="sentryerrorlastseen"></a>`lastSeen` | [`Time!`](#time) | Timestamp when the error was last seen. | +| <a id="sentryerrormessage"></a>`message` | [`String`](#string) | Sentry metadata message of the error. | +| <a id="sentryerrorsentryid"></a>`sentryId` | [`String!`](#string) | ID (Sentry ID) of the error. | +| <a id="sentryerrorsentryprojectid"></a>`sentryProjectId` | [`ID!`](#id) | ID of the project (Sentry project). | +| <a id="sentryerrorsentryprojectname"></a>`sentryProjectName` | [`String!`](#string) | Name of the project affected by the error. | +| <a id="sentryerrorsentryprojectslug"></a>`sentryProjectSlug` | [`String!`](#string) | Slug of the project affected by the error. | +| <a id="sentryerrorshortid"></a>`shortId` | [`String!`](#string) | Short ID (Sentry ID) of the error. | +| <a id="sentryerrorstatus"></a>`status` | [`SentryErrorStatus!`](#sentryerrorstatus) | Status of the error. | +| <a id="sentryerrortitle"></a>`title` | [`String!`](#string) | Title of the error. | +| <a id="sentryerrortype"></a>`type` | [`String!`](#string) | Type of the error. | +| <a id="sentryerrorusercount"></a>`userCount` | [`Int!`](#int) | Count of users affected by the error. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`TestReport`](#testreport) | The item at the end of the edge. | +### `SentryErrorCollection` -### `TestReportSummary` +An object containing a collection of Sentry errors, and a detailed error. -Test report for a pipeline. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `testSuites` | [`TestSuiteSummaryConnection!`](#testsuitesummaryconnection) | Test suites belonging to a pipeline test report. | -| `total` | [`TestReportTotal!`](#testreporttotal) | Total report statistics for a pipeline test report. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorcollectionexternalurl"></a>`externalUrl` | [`String`](#string) | External URL for Sentry. | -### `TestReportTotal` +#### Fields with arguments -Total test report statistics. +##### `SentryErrorCollection.detailedError` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int`](#int) | Total number of the test cases. | -| `error` | [`Int`](#int) | Total number of test cases that had an error. | -| `failed` | [`Int`](#int) | Total number of test cases that failed. | -| `skipped` | [`Int`](#int) | Total number of test cases that were skipped. | -| `success` | [`Int`](#int) | Total number of test cases that succeeded. | -| `suiteError` | [`String`](#string) | Test suite error message. | -| `time` | [`Float`](#float) | Total duration of the tests. | +Detailed version of a Sentry error on the project. -### `TestSuite` +Returns [`SentryDetailedError`](#sentrydetailederror). -Test suite in a pipeline test report. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `errorCount` | [`Int`](#int) | Total number of test cases that had an error. | -| `failedCount` | [`Int`](#int) | Total number of test cases that failed in the test suite. | -| `name` | [`String`](#string) | Name of the test suite. | -| `skippedCount` | [`Int`](#int) | Total number of test cases that were skipped in the test suite. | -| `successCount` | [`Int`](#int) | Total number of test cases that succeeded in the test suite. | -| `suiteError` | [`String`](#string) | Test suite error message. | -| `testCases` | [`TestCaseConnection`](#testcaseconnection) | Test cases in the test suite. | -| `totalCount` | [`Int`](#int) | Total number of the test cases in the test suite. | -| `totalTime` | [`Float`](#float) | Total duration of the tests in the test suite. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorcollectiondetailederrorid"></a>`id` | [`GitlabErrorTrackingDetailedErrorID!`](#gitlaberrortrackingdetailederrorid) | ID of the Sentry issue. | -### `TestSuiteSummary` +##### `SentryErrorCollection.errorStackTrace` -Test suite summary in a pipeline test report. +Stack Trace of Sentry Error. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `buildIds` | [`[ID!]`](#id) | IDs of the builds used to run the test suite. | -| `errorCount` | [`Int`](#int) | Total number of test cases that had an error. | -| `failedCount` | [`Int`](#int) | Total number of test cases that failed in the test suite. | -| `name` | [`String`](#string) | Name of the test suite. | -| `skippedCount` | [`Int`](#int) | Total number of test cases that were skipped in the test suite. | -| `successCount` | [`Int`](#int) | Total number of test cases that succeeded in the test suite. | -| `suiteError` | [`String`](#string) | Test suite error message. | -| `totalCount` | [`Int`](#int) | Total number of the test cases in the test suite. | -| `totalTime` | [`Float`](#float) | Total duration of the tests in the test suite. | +Returns [`SentryErrorStackTrace`](#sentryerrorstacktrace). -### `TestSuiteSummaryConnection` +###### Arguments -The connection type for TestSuiteSummary. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorcollectionerrorstacktraceid"></a>`id` | [`GitlabErrorTrackingDetailedErrorID!`](#gitlaberrortrackingdetailederrorid) | ID of the Sentry issue. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Total count of collection. | -| `edges` | [`[TestSuiteSummaryEdge]`](#testsuitesummaryedge) | A list of edges. | -| `nodes` | [`[TestSuiteSummary]`](#testsuitesummary) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +##### `SentryErrorCollection.errors` -### `TestSuiteSummaryEdge` +Collection of Sentry Errors. -An edge in a connection. +Returns [`SentryErrorConnection`](#sentryerrorconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`TestSuiteSummary`](#testsuitesummary) | The item at the end of the edge. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `TimeReportStats` +###### Arguments -Represents the time report stats for timeboxes. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorcollectionerrorssearchterm"></a>`searchTerm` | [`String`](#string) | Search query for the Sentry error details. | +| <a id="sentryerrorcollectionerrorssort"></a>`sort` | [`String`](#string) | Attribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `complete` | [`TimeboxMetrics`](#timeboxmetrics) | Completed issues metrics. | -| `incomplete` | [`TimeboxMetrics`](#timeboxmetrics) | Incomplete issues metrics. | -| `total` | [`TimeboxMetrics`](#timeboxmetrics) | Total issues metrics. | +### `SentryErrorFrequency` -### `TimeboxMetrics` +#### Fields -Represents measured stats metrics for timeboxes. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorfrequencycount"></a>`count` | [`Int!`](#int) | Count of errors received since the previously recorded time. | +| <a id="sentryerrorfrequencytime"></a>`time` | [`Time!`](#time) | Time the error frequency stats were recorded. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | The count metric. | -| `weight` | [`Int!`](#int) | The weight metric. | +### `SentryErrorStackTrace` -### `TimeboxReport` +An object containing a stack trace entry for a Sentry error. -Represents a historically accurate report about the timebox. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `burnupTimeSeries` | [`[BurnupChartDailyTotals!]`](#burnupchartdailytotals) | Daily scope and completed totals for burnup charts. | -| `stats` | [`TimeReportStats`](#timereportstats) | Represents the time report stats for the timebox. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorstacktracedatereceived"></a>`dateReceived` | [`String!`](#string) | Time the stack trace was received by Sentry. | +| <a id="sentryerrorstacktraceissueid"></a>`issueId` | [`String!`](#string) | ID of the Sentry error. | +| <a id="sentryerrorstacktracestacktraceentries"></a>`stackTraceEntries` | [`[SentryErrorStackTraceEntry!]!`](#sentryerrorstacktraceentry) | Stack trace entries for the Sentry error. | -### `Timelog` +### `SentryErrorStackTraceContext` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `issue` | [`Issue`](#issue) | The issue that logged time was added to. | -| `note` | [`Note`](#note) | The note where the quick action to add the logged time was executed. | -| `spentAt` | [`Time`](#time) | Timestamp of when the time tracked was spent at. | -| `timeSpent` | [`Int!`](#int) | The time spent displayed in seconds. | -| `user` | [`User!`](#user) | The user that logged the time. | +An object context for a Sentry error stack trace. -### `TimelogConnection` +#### Fields -The connection type for Timelog. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorstacktracecontextcode"></a>`code` | [`String!`](#string) | Code number of the context. | +| <a id="sentryerrorstacktracecontextline"></a>`line` | [`Int!`](#int) | Line number of the context. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[TimelogEdge]`](#timelogedge) | A list of edges. | -| `nodes` | [`[Timelog]`](#timelog) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `SentryErrorStackTraceEntry` -### `TimelogEdge` +An object containing a stack trace entry for a Sentry error. -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Timelog`](#timelog) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrorstacktraceentrycol"></a>`col` | [`String`](#string) | Function in which the Sentry error occurred. | +| <a id="sentryerrorstacktraceentryfilename"></a>`fileName` | [`String`](#string) | File in which the Sentry error occurred. | +| <a id="sentryerrorstacktraceentryfunction"></a>`function` | [`String`](#string) | Function in which the Sentry error occurred. | +| <a id="sentryerrorstacktraceentryline"></a>`line` | [`String`](#string) | Function in which the Sentry error occurred. | +| <a id="sentryerrorstacktraceentrytracecontext"></a>`traceContext` | [`[SentryErrorStackTraceContext!]`](#sentryerrorstacktracecontext) | Context of the Sentry error. | -### `Todo` +### `SentryErrorTags` -Representing a to-do entry. +State of a Sentry error. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `action` | [`TodoActionEnum!`](#todoactionenum) | Action of the to-do item. | -| `author` | [`User!`](#user) | The author of this to-do item. | -| `body` | [`String!`](#string) | Body of the to-do item. | -| `createdAt` | [`Time!`](#time) | Timestamp this to-do item was created. | -| `group` | [`Group`](#group) | Group this to-do item is associated with. | -| `id` | [`ID!`](#id) | ID of the to-do item. | -| `project` | [`Project`](#project) | The project this to-do item is associated with. | -| `state` | [`TodoStateEnum!`](#todostateenum) | State of the to-do item. | -| `targetType` | [`TodoTargetEnum!`](#todotargetenum) | Target type of the to-do item. | +#### Fields -### `TodoConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sentryerrortagslevel"></a>`level` | [`String`](#string) | Severity level of the Sentry Error. | +| <a id="sentryerrortagslogger"></a>`logger` | [`String`](#string) | Logger of the Sentry Error. | -The connection type for Todo. +### `Snippet` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[TodoEdge]`](#todoedge) | A list of edges. | -| `nodes` | [`[Todo]`](#todo) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +Represents a snippet entry. -### `TodoCreatePayload` +#### Fields -Autogenerated return type of TodoCreate. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetauthor"></a>`author` | [`UserCore`](#usercore) | The owner of the snippet. | +| <a id="snippetblob"></a>`blob` **{warning-solid}** | [`SnippetBlob!`](#snippetblob) | **Deprecated** in 13.3. Use `blobs`. | +| <a id="snippetcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp this snippet was created. | +| <a id="snippetdescription"></a>`description` | [`String`](#string) | Description of the snippet. | +| <a id="snippetdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. | +| <a id="snippetdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="snippetfilename"></a>`fileName` | [`String`](#string) | File Name of the snippet. | +| <a id="snippethttpurltorepo"></a>`httpUrlToRepo` | [`String`](#string) | HTTP URL to the snippet repository. | +| <a id="snippetid"></a>`id` | [`SnippetID!`](#snippetid) | ID of the snippet. | +| <a id="snippetnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="snippetproject"></a>`project` | [`Project`](#project) | The project the snippet is associated with. | +| <a id="snippetrawurl"></a>`rawUrl` | [`String!`](#string) | Raw URL of the snippet. | +| <a id="snippetsshurltorepo"></a>`sshUrlToRepo` | [`String`](#string) | SSH URL to the snippet repository. | +| <a id="snippettitle"></a>`title` | [`String!`](#string) | Title of the snippet. | +| <a id="snippetupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp this snippet was updated. | +| <a id="snippetuserpermissions"></a>`userPermissions` | [`SnippetPermissions!`](#snippetpermissions) | Permissions for the current user on the resource. | +| <a id="snippetvisibilitylevel"></a>`visibilityLevel` | [`VisibilityLevelsEnum!`](#visibilitylevelsenum) | Visibility Level of the snippet. | +| <a id="snippetweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the snippet. | + +#### Fields with arguments + +##### `Snippet.blobs` + +Snippet blobs. + +Returns [`SnippetBlobConnection`](#snippetblobconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `todo` | [`Todo`](#todo) | The to-do item created. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetblobspaths"></a>`paths` | [`[String!]`](#string) | Paths of the blobs. | -### `TodoEdge` +### `SnippetBlob` -An edge in a connection. +Represents the snippet blob. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Todo`](#todo) | The item at the end of the edge. | +#### Fields -### `TodoMarkDonePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetblobbinary"></a>`binary` | [`Boolean!`](#boolean) | Shows whether the blob is binary. | +| <a id="snippetblobexternalstorage"></a>`externalStorage` | [`String`](#string) | Blob external storage. | +| <a id="snippetblobmode"></a>`mode` | [`String`](#string) | Blob mode. | +| <a id="snippetblobname"></a>`name` | [`String`](#string) | Blob name. | +| <a id="snippetblobpath"></a>`path` | [`String`](#string) | Blob path. | +| <a id="snippetblobplaindata"></a>`plainData` | [`String`](#string) | Blob plain highlighted data. | +| <a id="snippetblobrawpath"></a>`rawPath` | [`String!`](#string) | Blob raw content endpoint path. | +| <a id="snippetblobrenderedastext"></a>`renderedAsText` | [`Boolean!`](#boolean) | Shows whether the blob is rendered as text. | +| <a id="snippetblobrichdata"></a>`richData` | [`String`](#string) | Blob highlighted data. | +| <a id="snippetblobrichviewer"></a>`richViewer` | [`SnippetBlobViewer`](#snippetblobviewer) | Blob content rich viewer. | +| <a id="snippetblobsimpleviewer"></a>`simpleViewer` | [`SnippetBlobViewer!`](#snippetblobviewer) | Blob content simple viewer. | +| <a id="snippetblobsize"></a>`size` | [`Int!`](#int) | Blob size. | -Autogenerated return type of TodoMarkDone. +### `SnippetBlobViewer` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `todo` | [`Todo!`](#todo) | The requested to-do item. | +Represents how the blob content should be displayed. -### `TodoRestoreManyPayload` +#### Fields -Autogenerated return type of TodoRestoreMany. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetblobviewercollapsed"></a>`collapsed` | [`Boolean!`](#boolean) | Shows whether the blob should be displayed collapsed. | +| <a id="snippetblobviewerfiletype"></a>`fileType` | [`String!`](#string) | Content file type. | +| <a id="snippetblobviewerloadasync"></a>`loadAsync` | [`Boolean!`](#boolean) | Shows whether the blob content is loaded asynchronously. | +| <a id="snippetblobviewerloadingpartialname"></a>`loadingPartialName` | [`String!`](#string) | Loading partial name. | +| <a id="snippetblobviewerrendererror"></a>`renderError` | [`String`](#string) | Error rendering the blob content. | +| <a id="snippetblobviewertoolarge"></a>`tooLarge` | [`Boolean!`](#boolean) | Shows whether the blob is too large to be displayed. | +| <a id="snippetblobviewertype"></a>`type` | [`BlobViewersType!`](#blobviewerstype) | Type of blob viewer. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `todos` | [`[Todo!]!`](#todo) | Updated to-do items. | -| `updatedIds` **{warning-solid}** | [`[TodoID!]!`](#todoid) | **Deprecated** in 13.2. Use to-do items. | +### `SnippetPermissions` -### `TodoRestorePayload` +#### Fields -Autogenerated return type of TodoRestore. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetpermissionsadminsnippet"></a>`adminSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_snippet` on this resource. | +| <a id="snippetpermissionsawardemoji"></a>`awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. | +| <a id="snippetpermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. | +| <a id="snippetpermissionsreadsnippet"></a>`readSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `read_snippet` on this resource. | +| <a id="snippetpermissionsreportsnippet"></a>`reportSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `report_snippet` on this resource. | +| <a id="snippetpermissionsupdatesnippet"></a>`updateSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `update_snippet` on this resource. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `todo` | [`Todo!`](#todo) | The requested to-do item. | +### `SnippetRepositoryRegistry` -### `TodosMarkAllDonePayload` +Represents the Geo sync and verification state of a snippet repository. -Autogenerated return type of TodosMarkAllDone. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `todos` | [`[Todo!]!`](#todo) | Updated to-do items. | -| `updatedIds` **{warning-solid}** | [`[TodoID!]!`](#todoid) | **Deprecated** in 13.2. Use to-do items. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetrepositoryregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the SnippetRepositoryRegistry was created. | +| <a id="snippetrepositoryregistryid"></a>`id` | [`ID!`](#id) | ID of the SnippetRepositoryRegistry. | +| <a id="snippetrepositoryregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the SnippetRepositoryRegistry. | +| <a id="snippetrepositoryregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the SnippetRepositoryRegistry. | +| <a id="snippetrepositoryregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the SnippetRepositoryRegistry should be resynced. | +| <a id="snippetrepositoryregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the SnippetRepositoryRegistry. | +| <a id="snippetrepositoryregistrysnippetrepositoryid"></a>`snippetRepositoryId` | [`ID!`](#id) | ID of the Snippet Repository. | +| <a id="snippetrepositoryregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the SnippetRepositoryRegistry. | -### `ToggleAwardEmojiPayload` +### `StatusAction` -Autogenerated return type of ToggleAwardEmoji. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `awardEmoji` | [`AwardEmoji`](#awardemoji) | The award emoji after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `toggledOn` | [`Boolean!`](#boolean) | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="statusactionbuttontitle"></a>`buttonTitle` | [`String`](#string) | Title for the button, for example: Retry this job. | +| <a id="statusactionicon"></a>`icon` | [`String`](#string) | Icon used in the action button. | +| <a id="statusactionmethod"></a>`method` | [`String`](#string) | Method for the action, for example: :post. | +| <a id="statusactionpath"></a>`path` | [`String`](#string) | Path for the action. | +| <a id="statusactiontitle"></a>`title` | [`String`](#string) | Title for the action, for example: Retry. | -### `Tree` +### `Submodule` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `blobs` | [`BlobConnection!`](#blobconnection) | Blobs of the tree. | -| `lastCommit` | [`Commit`](#commit) | Last commit for the tree. | -| `submodules` | [`SubmoduleConnection!`](#submoduleconnection) | Sub-modules of the tree. | -| `trees` | [`TreeEntryConnection!`](#treeentryconnection) | Trees of the tree. | +#### Fields -### `TreeEntry` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="submoduleflatpath"></a>`flatPath` | [`String!`](#string) | Flat path of the entry. | +| <a id="submoduleid"></a>`id` | [`ID!`](#id) | ID of the entry. | +| <a id="submodulename"></a>`name` | [`String!`](#string) | Name of the entry. | +| <a id="submodulepath"></a>`path` | [`String!`](#string) | Path of the entry. | +| <a id="submodulesha"></a>`sha` | [`String!`](#string) | Last commit SHA for the entry. | +| <a id="submoduletreeurl"></a>`treeUrl` | [`String`](#string) | Tree URL for the sub-module. | +| <a id="submoduletype"></a>`type` | [`EntryType!`](#entrytype) | Type of tree entry. | +| <a id="submoduleweburl"></a>`webUrl` | [`String`](#string) | Web URL for the sub-module. | -Represents a directory. +### `TaskCompletionStatus` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `flatPath` | [`String!`](#string) | Flat path of the entry. | -| `id` | [`ID!`](#id) | ID of the entry. | -| `name` | [`String!`](#string) | Name of the entry. | -| `path` | [`String!`](#string) | Path of the entry. | -| `sha` | [`String!`](#string) | Last commit SHA for the entry. | -| `type` | [`EntryType!`](#entrytype) | Type of tree entry. | -| `webPath` | [`String`](#string) | Web path for the tree entry (directory). | -| `webUrl` | [`String`](#string) | Web URL for the tree entry (directory). | +Completion status of tasks. -### `TreeEntryConnection` +#### Fields -The connection type for TreeEntry. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="taskcompletionstatuscompletedcount"></a>`completedCount` | [`Int!`](#int) | Number of completed tasks. | +| <a id="taskcompletionstatuscount"></a>`count` | [`Int!`](#int) | Number of total tasks. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[TreeEntryEdge]`](#treeentryedge) | A list of edges. | -| `nodes` | [`[TreeEntry]`](#treeentry) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `TerraformState` -### `TreeEntryEdge` +#### Fields -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="terraformstatecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp the Terraform state was created. | +| <a id="terraformstateid"></a>`id` | [`ID!`](#id) | ID of the Terraform state. | +| <a id="terraformstatelatestversion"></a>`latestVersion` | [`TerraformStateVersion`](#terraformstateversion) | The latest version of the Terraform state. | +| <a id="terraformstatelockedat"></a>`lockedAt` | [`Time`](#time) | Timestamp the Terraform state was locked. | +| <a id="terraformstatelockedbyuser"></a>`lockedByUser` | [`UserCore`](#usercore) | The user currently holding a lock on the Terraform state. | +| <a id="terraformstatename"></a>`name` | [`String!`](#string) | Name of the Terraform state. | +| <a id="terraformstateupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp the Terraform state was updated. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`TreeEntry`](#treeentry) | The item at the end of the edge. | +### `TerraformStateVersion` -### `UpdateAlertStatusPayload` +#### Fields -Autogenerated return type of UpdateAlertStatus. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="terraformstateversioncreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp the version was created. | +| <a id="terraformstateversioncreatedbyuser"></a>`createdByUser` | [`UserCore`](#usercore) | The user that created this version. | +| <a id="terraformstateversiondownloadpath"></a>`downloadPath` | [`String`](#string) | URL for downloading the version's JSON file. | +| <a id="terraformstateversionid"></a>`id` | [`ID!`](#id) | ID of the Terraform state version. | +| <a id="terraformstateversionjob"></a>`job` | [`CiJob`](#cijob) | The job that created this version. | +| <a id="terraformstateversionserial"></a>`serial` | [`Int`](#int) | Serial number of the version. | +| <a id="terraformstateversionupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp the version was updated. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `alert` | [`AlertManagementAlert`](#alertmanagementalert) | The alert after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue created after mutation. | -| `todo` | [`Todo`](#todo) | The to-do item after mutation. | +### `TerraformStateVersionRegistry` -### `UpdateBoardEpicUserPreferencesPayload` +Represents the Geo sync and verification state of a terraform state version. -Autogenerated return type of UpdateBoardEpicUserPreferences. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epicUserPreferences` | [`BoardEpicUserPreferences`](#boardepicuserpreferences) | User preferences for the epic in the board after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="terraformstateversionregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the TerraformStateVersionRegistry was created. | +| <a id="terraformstateversionregistryid"></a>`id` | [`ID!`](#id) | ID of the TerraformStateVersionRegistry. | +| <a id="terraformstateversionregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the TerraformStateVersionRegistry. | +| <a id="terraformstateversionregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the TerraformStateVersionRegistry. | +| <a id="terraformstateversionregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the TerraformStateVersionRegistry should be resynced. | +| <a id="terraformstateversionregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the TerraformStateVersionRegistry. | +| <a id="terraformstateversionregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the TerraformStateVersionRegistry. | +| <a id="terraformstateversionregistryterraformstateversionid"></a>`terraformStateVersionId` | [`ID!`](#id) | ID of the terraform state version. | -### `UpdateBoardListPayload` +### `TestCase` -Autogenerated return type of UpdateBoardList. +Test case in pipeline test report. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `list` | [`BoardList`](#boardlist) | Mutated list. | +#### Fields -### `UpdateBoardPayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testcaseattachmenturl"></a>`attachmentUrl` | [`String`](#string) | URL of the test case attachment file. | +| <a id="testcaseclassname"></a>`classname` | [`String`](#string) | Classname of the test case. | +| <a id="testcaseexecutiontime"></a>`executionTime` | [`Float`](#float) | Test case execution time in seconds. | +| <a id="testcasefile"></a>`file` | [`String`](#string) | Path to the file of the test case. | +| <a id="testcasename"></a>`name` | [`String`](#string) | Name of the test case. | +| <a id="testcaserecentfailures"></a>`recentFailures` | [`RecentFailures`](#recentfailures) | Recent failure history of the test case on the base branch. | +| <a id="testcasestacktrace"></a>`stackTrace` | [`String`](#string) | Stack trace of the test case. | +| <a id="testcasestatus"></a>`status` | [`TestCaseStatus`](#testcasestatus) | Status of the test case (error, failed, success, skipped). | +| <a id="testcasesystemoutput"></a>`systemOutput` | [`String`](#string) | System output of the test case. | -Autogenerated return type of UpdateBoard. +### `TestReport` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `board` | [`Board`](#board) | The board after mutation. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +Represents a requirement test report. -### `UpdateComplianceFrameworkPayload` +#### Fields -Autogenerated return type of UpdateComplianceFramework. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testreportauthor"></a>`author` | [`UserCore`](#usercore) | Author of the test report. | +| <a id="testreportcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the test report was created. | +| <a id="testreportid"></a>`id` | [`ID!`](#id) | ID of the test report. | +| <a id="testreportstate"></a>`state` | [`TestReportState!`](#testreportstate) | State of the test report. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `complianceFramework` | [`ComplianceFramework`](#complianceframework) | The compliance framework after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +### `TestReportSummary` -### `UpdateContainerExpirationPolicyPayload` +Test report for a pipeline. -Autogenerated return type of UpdateContainerExpirationPolicy. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `containerExpirationPolicy` | [`ContainerExpirationPolicy`](#containerexpirationpolicy) | The container expiration policy after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testreportsummarytestsuites"></a>`testSuites` | [`TestSuiteSummaryConnection!`](#testsuitesummaryconnection) | Test suites belonging to a pipeline test report. (see [Connections](#connections)) | +| <a id="testreportsummarytotal"></a>`total` | [`TestReportTotal!`](#testreporttotal) | Total report statistics for a pipeline test report. | -### `UpdateEpicPayload` +### `TestReportTotal` -Autogenerated return type of UpdateEpic. +Total test report statistics. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `epic` | [`Epic`](#epic) | The epic after mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | +#### Fields -### `UpdateImageDiffNotePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testreporttotalcount"></a>`count` | [`Int`](#int) | Total number of the test cases. | +| <a id="testreporttotalerror"></a>`error` | [`Int`](#int) | Total number of test cases that had an error. | +| <a id="testreporttotalfailed"></a>`failed` | [`Int`](#int) | Total number of test cases that failed. | +| <a id="testreporttotalskipped"></a>`skipped` | [`Int`](#int) | Total number of test cases that were skipped. | +| <a id="testreporttotalsuccess"></a>`success` | [`Int`](#int) | Total number of test cases that succeeded. | +| <a id="testreporttotalsuiteerror"></a>`suiteError` | [`String`](#string) | Test suite error message. | +| <a id="testreporttotaltime"></a>`time` | [`Float`](#float) | Total duration of the tests. | -Autogenerated return type of UpdateImageDiffNote. +### `TestSuite` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `note` | [`Note`](#note) | The note after mutation. | +Test suite in a pipeline test report. -### `UpdateIssuePayload` +#### Fields -Autogenerated return type of UpdateIssue. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testsuiteerrorcount"></a>`errorCount` | [`Int`](#int) | Total number of test cases that had an error. | +| <a id="testsuitefailedcount"></a>`failedCount` | [`Int`](#int) | Total number of test cases that failed in the test suite. | +| <a id="testsuitename"></a>`name` | [`String`](#string) | Name of the test suite. | +| <a id="testsuiteskippedcount"></a>`skippedCount` | [`Int`](#int) | Total number of test cases that were skipped in the test suite. | +| <a id="testsuitesuccesscount"></a>`successCount` | [`Int`](#int) | Total number of test cases that succeeded in the test suite. | +| <a id="testsuitesuiteerror"></a>`suiteError` | [`String`](#string) | Test suite error message. | +| <a id="testsuitetestcases"></a>`testCases` | [`TestCaseConnection`](#testcaseconnection) | Test cases in the test suite. (see [Connections](#connections)) | +| <a id="testsuitetotalcount"></a>`totalCount` | [`Int`](#int) | Total number of the test cases in the test suite. | +| <a id="testsuitetotaltime"></a>`totalTime` | [`Float`](#float) | Total duration of the tests in the test suite. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `issue` | [`Issue`](#issue) | The issue after mutation. | +### `TestSuiteSummary` -### `UpdateIterationPayload` +Test suite summary in a pipeline test report. -Autogenerated return type of UpdateIteration. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `iteration` | [`Iteration`](#iteration) | Updated iteration. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="testsuitesummarybuildids"></a>`buildIds` | [`[ID!]`](#id) | IDs of the builds used to run the test suite. | +| <a id="testsuitesummaryerrorcount"></a>`errorCount` | [`Int`](#int) | Total number of test cases that had an error. | +| <a id="testsuitesummaryfailedcount"></a>`failedCount` | [`Int`](#int) | Total number of test cases that failed in the test suite. | +| <a id="testsuitesummaryname"></a>`name` | [`String`](#string) | Name of the test suite. | +| <a id="testsuitesummaryskippedcount"></a>`skippedCount` | [`Int`](#int) | Total number of test cases that were skipped in the test suite. | +| <a id="testsuitesummarysuccesscount"></a>`successCount` | [`Int`](#int) | Total number of test cases that succeeded in the test suite. | +| <a id="testsuitesummarysuiteerror"></a>`suiteError` | [`String`](#string) | Test suite error message. | +| <a id="testsuitesummarytotalcount"></a>`totalCount` | [`Int`](#int) | Total number of the test cases in the test suite. | +| <a id="testsuitesummarytotaltime"></a>`totalTime` | [`Float`](#float) | Total duration of the tests in the test suite. | + +### `TimeReportStats` + +Represents the time report stats for timeboxes. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="timereportstatscomplete"></a>`complete` | [`TimeboxMetrics`](#timeboxmetrics) | Completed issues metrics. | +| <a id="timereportstatsincomplete"></a>`incomplete` | [`TimeboxMetrics`](#timeboxmetrics) | Incomplete issues metrics. | +| <a id="timereportstatstotal"></a>`total` | [`TimeboxMetrics`](#timeboxmetrics) | Total issues metrics. | + +### `TimeboxMetrics` + +Represents measured stats metrics for timeboxes. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="timeboxmetricscount"></a>`count` | [`Int!`](#int) | The count metric. | +| <a id="timeboxmetricsweight"></a>`weight` | [`Int!`](#int) | The weight metric. | + +### `TimeboxReport` -### `UpdateNamespacePackageSettingsPayload` +Represents a historically accurate report about the timebox. + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="timeboxreportburnuptimeseries"></a>`burnupTimeSeries` | [`[BurnupChartDailyTotals!]`](#burnupchartdailytotals) | Daily scope and completed totals for burnup charts. | +| <a id="timeboxreportstats"></a>`stats` | [`TimeReportStats`](#timereportstats) | Represents the time report stats for the timebox. | -Autogenerated return type of UpdateNamespacePackageSettings. +### `Timelog` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="timelogissue"></a>`issue` | [`Issue`](#issue) | The issue that logged time was added to. | +| <a id="timelogmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | The merge request that logged time was added to. | +| <a id="timelognote"></a>`note` | [`Note`](#note) | The note where the quick action to add the logged time was executed. | +| <a id="timelogspentat"></a>`spentAt` | [`Time`](#time) | Timestamp of when the time tracked was spent at. | +| <a id="timelogtimespent"></a>`timeSpent` | [`Int!`](#int) | The time spent displayed in seconds. | +| <a id="timeloguser"></a>`user` | [`UserCore!`](#usercore) | The user that logged the time. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `packageSettings` | [`PackageSettings`](#packagesettings) | The namespace package setting after mutation. | +### `Todo` -### `UpdateNotePayload` +Representing a to-do entry. -Autogenerated return type of UpdateNote. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `note` | [`Note`](#note) | The note after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="todoaction"></a>`action` | [`TodoActionEnum!`](#todoactionenum) | Action of the to-do item. | +| <a id="todoauthor"></a>`author` | [`UserCore!`](#usercore) | The author of this to-do item. | +| <a id="todobody"></a>`body` | [`String!`](#string) | Body of the to-do item. | +| <a id="todocreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp this to-do item was created. | +| <a id="todogroup"></a>`group` | [`Group`](#group) | Group this to-do item is associated with. | +| <a id="todoid"></a>`id` | [`ID!`](#id) | ID of the to-do item. | +| <a id="todoproject"></a>`project` | [`Project`](#project) | The project this to-do item is associated with. | +| <a id="todostate"></a>`state` | [`TodoStateEnum!`](#todostateenum) | State of the to-do item. | +| <a id="todotargettype"></a>`targetType` | [`TodoTargetEnum!`](#todotargetenum) | Target type of the to-do item. | -### `UpdateRequirementPayload` +### `Tree` -Autogenerated return type of UpdateRequirement. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `requirement` | [`Requirement`](#requirement) | Requirement after mutation. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="treeblobs"></a>`blobs` | [`BlobConnection!`](#blobconnection) | Blobs of the tree. (see [Connections](#connections)) | +| <a id="treelastcommit"></a>`lastCommit` | [`Commit`](#commit) | Last commit for the tree. | +| <a id="treesubmodules"></a>`submodules` | [`SubmoduleConnection!`](#submoduleconnection) | Sub-modules of the tree. (see [Connections](#connections)) | +| <a id="treetrees"></a>`trees` | [`TreeEntryConnection!`](#treeentryconnection) | Trees of the tree. (see [Connections](#connections)) | -### `UpdateSnippetPayload` +### `TreeEntry` -Autogenerated return type of UpdateSnippet. +Represents a directory. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `captchaSiteKey` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use spam protection with HTTP headers instead. | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `needsCaptchaResponse` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated** in 13.11. Use spam protection with HTTP headers instead. | -| `snippet` | [`Snippet`](#snippet) | The snippet after mutation. | -| `spam` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated** in 13.11. Use spam protection with HTTP headers instead. | -| `spamLogId` **{warning-solid}** | [`Int`](#int) | **Deprecated** in 13.11. Use spam protection with HTTP headers instead. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="treeentryflatpath"></a>`flatPath` | [`String!`](#string) | Flat path of the entry. | +| <a id="treeentryid"></a>`id` | [`ID!`](#id) | ID of the entry. | +| <a id="treeentryname"></a>`name` | [`String!`](#string) | Name of the entry. | +| <a id="treeentrypath"></a>`path` | [`String!`](#string) | Path of the entry. | +| <a id="treeentrysha"></a>`sha` | [`String!`](#string) | Last commit SHA for the entry. | +| <a id="treeentrytype"></a>`type` | [`EntryType!`](#entrytype) | Type of tree entry. | +| <a id="treeentrywebpath"></a>`webPath` | [`String`](#string) | Web path for the tree entry (directory). | +| <a id="treeentryweburl"></a>`webUrl` | [`String`](#string) | Web URL for the tree entry (directory). | ### `UsageTrendsMeasurement` Represents a recorded measurement (object count) for the Admins. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Object count. | -| `identifier` | [`MeasurementIdentifier!`](#measurementidentifier) | The type of objects being measured. | -| `recordedAt` | [`Time`](#time) | The time the measurement was recorded. | +#### Fields -### `UsageTrendsMeasurementConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usagetrendsmeasurementcount"></a>`count` | [`Int!`](#int) | Object count. | +| <a id="usagetrendsmeasurementidentifier"></a>`identifier` | [`MeasurementIdentifier!`](#measurementidentifier) | The type of objects being measured. | +| <a id="usagetrendsmeasurementrecordedat"></a>`recordedAt` | [`Time`](#time) | The time the measurement was recorded. | -The connection type for UsageTrendsMeasurement. +### `UserCallout` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[UsageTrendsMeasurementEdge]`](#usagetrendsmeasurementedge) | A list of edges. | -| `nodes` | [`[UsageTrendsMeasurement]`](#usagetrendsmeasurement) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### Fields -### `UsageTrendsMeasurementEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercalloutdismissedat"></a>`dismissedAt` | [`Time`](#time) | Date when the callout was dismissed. | +| <a id="usercalloutfeaturename"></a>`featureName` | [`UserCalloutFeatureNameEnum!`](#usercalloutfeaturenameenum) | Name of the feature that the callout is for. | -An edge in a connection. +### `UserCore` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`UsageTrendsMeasurement`](#usagetrendsmeasurement) | The item at the end of the edge. | +Core represention of a GitLab user. -### `User` +#### Fields -Representation of a GitLab user. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercoreavatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. | +| <a id="usercorebot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. | +| <a id="usercorecallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) | +| <a id="usercoreemail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). | +| <a id="usercoregroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. | +| <a id="usercoregroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) | +| <a id="usercoreid"></a>`id` | [`ID!`](#id) | ID of the user. | +| <a id="usercorelocation"></a>`location` | [`String`](#string) | The location of the user. | +| <a id="usercorename"></a>`name` | [`String!`](#string) | Human-readable name of the user. | +| <a id="usercoreprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) | +| <a id="usercorepublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. | +| <a id="usercorestate"></a>`state` | [`UserState!`](#userstate) | State of the user. | +| <a id="usercorestatus"></a>`status` | [`UserStatus`](#userstatus) | User status. | +| <a id="usercoreuserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. | +| <a id="usercoreusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. | +| <a id="usercorewebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. | +| <a id="usercoreweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. | + +#### Fields with arguments + +##### `UserCore.assignedMergeRequests` + +Merge requests assigned to the user. + +Returns [`MergeRequestConnection`](#mergerequestconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `assignedMergeRequests` | [`MergeRequestConnection`](#mergerequestconnection) | Merge requests assigned to the user. | -| `authoredMergeRequests` | [`MergeRequestConnection`](#mergerequestconnection) | Merge requests authored by the user. | -| `avatarUrl` | [`String`](#string) | URL of the user's avatar. | -| `bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. | -| `callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. | -| `email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: `User.publicEmail`. | -| `groupCount` | [`Int`](#int) | Group count for the user. Available only when feature flag `user_group_counts` is enabled. | -| `groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. | -| `id` | [`ID!`](#id) | ID of the user. | -| `location` | [`String`](#string) | The location of the user. | -| `name` | [`String!`](#string) | Human-readable name of the user. | -| `projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. | -| `publicEmail` | [`String`](#string) | User's public email. | -| `reviewRequestedMergeRequests` | [`MergeRequestConnection`](#mergerequestconnection) | Merge requests assigned to the user for review. | -| `snippets` | [`SnippetConnection`](#snippetconnection) | Snippets authored by the user. | -| `starredProjects` | [`ProjectConnection`](#projectconnection) | Projects starred by the user. | -| `state` | [`UserState!`](#userstate) | State of the user. | -| `status` | [`UserStatus`](#userstatus) | User status. | -| `todos` | [`TodoConnection`](#todoconnection) | To-do items of the user. | -| `userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. | -| `username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. | -| `webPath` | [`String!`](#string) | Web path of the user. | -| `webUrl` | [`String!`](#string) | Web URL of the user. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercoreassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="usercoreassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="usercoreassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="usercoreassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="usercoreassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="usercoreassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="usercoreassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="usercoreassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="usercoreassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="usercoreassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="usercoreassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="usercoreassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="usercoreassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="usercoreassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | -### `UserCallout` +##### `UserCore.authoredMergeRequests` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `dismissedAt` | [`Time`](#time) | Date when the callout was dismissed. | -| `featureName` | [`UserCalloutFeatureNameEnum!`](#usercalloutfeaturenameenum) | Name of the feature that the callout is for. | +Merge requests authored by the user. -### `UserCalloutConnection` +Returns [`MergeRequestConnection`](#mergerequestconnection). -The connection type for UserCallout. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[UserCalloutEdge]`](#usercalloutedge) | A list of edges. | -| `nodes` | [`[UserCallout]`](#usercallout) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +###### Arguments -### `UserCalloutCreatePayload` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercoreauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="usercoreauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="usercoreauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="usercoreauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="usercoreauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="usercoreauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="usercoreauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="usercoreauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="usercoreauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="usercoreauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="usercoreauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="usercoreauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="usercoreauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="usercoreauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | -Autogenerated return type of UserCalloutCreate. +##### `UserCore.reviewRequestedMergeRequests` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `userCallout` | [`UserCallout!`](#usercallout) | The user callout dismissed. | +Merge requests assigned to the user for review. -### `UserCalloutEdge` +Returns [`MergeRequestConnection`](#mergerequestconnection). -An edge in a connection. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`UserCallout`](#usercallout) | The item at the end of the edge. | +###### Arguments -### `UserConnection` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercorereviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="usercorereviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="usercorereviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="usercorereviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="usercorereviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="usercorereviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="usercorereviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="usercorereviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="usercorereviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="usercorereviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="usercorereviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="usercorereviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="usercorereviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="usercorereviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | + +##### `UserCore.snippets` + +Snippets authored by the user. -The connection type for User. +Returns [`SnippetConnection`](#snippetconnection). -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[UserEdge]`](#useredge) | A list of edges. | -| `nodes` | [`[User]`](#user) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -### `UserEdge` +###### Arguments -An edge in a connection. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercoresnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | +| <a id="usercoresnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | The type of snippet. | +| <a id="usercoresnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | The visibility of the snippet. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`User`](#user) | The item at the end of the edge. | +##### `UserCore.starredProjects` -### `UserMergeRequestInteraction` +Projects starred by the user. -Information about a merge request given a specific user. +Returns [`ProjectConnection`](#projectconnection). -This object has two parts to its state: a `User` and a `MergeRequest`. All -fields relate to interactions between the two entities. +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `applicableApprovalRules` | [`[ApprovalRule!]`](#approvalrule) | Approval rules that apply to this user for this merge request. | -| `approved` | [`Boolean!`](#boolean) | Whether this user has approved this merge request. | -| `canMerge` | [`Boolean!`](#boolean) | Whether this user can merge this merge request. | -| `canUpdate` | [`Boolean!`](#boolean) | Whether this user can update this merge request. | -| `reviewState` | [`MergeRequestReviewState`](#mergerequestreviewstate) | The state of the review by this user. | -| `reviewed` | [`Boolean!`](#boolean) | Whether this user has provided a review for this merge request. | +###### Arguments -### `UserPermissions` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercorestarredprojectssearch"></a>`search` | [`String`](#string) | Search query. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `create_snippet` on this resource. | +##### `UserCore.todos` -### `UserStatus` +To-do items of the user. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `availability` | [`AvailabilityEnum!`](#availabilityenum) | User availability status. | -| `emoji` | [`String`](#string) | String representation of emoji. | -| `message` | [`String`](#string) | User status message. | -| `messageHtml` | [`String`](#string) | HTML of the user status message. | +Returns [`TodoConnection`](#todoconnection). -### `VulnerabilitiesCountByDay` +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. -Represents the count of vulnerabilities by severity on a particular day. This data is retained for 365 days. +###### Arguments -| Field | Type | Description | -| ----- | ---- | ----------- | -| `critical` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with critical severity. | -| `date` | [`ISO8601Date!`](#iso8601date) | Date for the count. | -| `high` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with high severity. | -| `info` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with info severity. | -| `low` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with low severity. | -| `medium` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with medium severity. | -| `total` | [`Int!`](#int) | Total number of vulnerabilities on a particular day. | -| `unknown` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with unknown severity. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usercoretodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | The action to be filtered. | +| <a id="usercoretodosauthorid"></a>`authorId` | [`[ID!]`](#id) | The ID of an author. | +| <a id="usercoretodosgroupid"></a>`groupId` | [`[ID!]`](#id) | The ID of a group. | +| <a id="usercoretodosprojectid"></a>`projectId` | [`[ID!]`](#id) | The ID of a project. | +| <a id="usercoretodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | The state of the todo. | +| <a id="usercoretodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | The type of the todo. | -### `VulnerabilitiesCountByDayAndSeverity` +### `UserMergeRequestInteraction` -Represents the number of vulnerabilities for a particular severity on a particular day. This data is retained for 365 days. +Information about a merge request given a specific user. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int`](#int) | Number of vulnerabilities. | -| `day` | [`ISO8601Date`](#iso8601date) | Date for the count. | -| `severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the counted vulnerabilities. | +This object has two parts to its state: a `User` and a `MergeRequest`. All +fields relate to interactions between the two entities. -### `VulnerabilitiesCountByDayAndSeverityConnection` +#### Fields -The connection type for VulnerabilitiesCountByDayAndSeverity. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usermergerequestinteractionapplicableapprovalrules"></a>`applicableApprovalRules` | [`[ApprovalRule!]`](#approvalrule) | Approval rules that apply to this user for this merge request. | +| <a id="usermergerequestinteractionapproved"></a>`approved` | [`Boolean!`](#boolean) | Whether this user has approved this merge request. | +| <a id="usermergerequestinteractioncanmerge"></a>`canMerge` | [`Boolean!`](#boolean) | Whether this user can merge this merge request. | +| <a id="usermergerequestinteractioncanupdate"></a>`canUpdate` | [`Boolean!`](#boolean) | Whether this user can update this merge request. | +| <a id="usermergerequestinteractionreviewstate"></a>`reviewState` | [`MergeRequestReviewState`](#mergerequestreviewstate) | The state of the review by this user. | +| <a id="usermergerequestinteractionreviewed"></a>`reviewed` | [`Boolean!`](#boolean) | Whether this user has provided a review for this merge request. | + +### `UserPermissions` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="userpermissionscreatesnippet"></a>`createSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `create_snippet` on this resource. | + +### `UserStatus` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[VulnerabilitiesCountByDayAndSeverityEdge]`](#vulnerabilitiescountbydayandseverityedge) | A list of edges. | -| `nodes` | [`[VulnerabilitiesCountByDayAndSeverity]`](#vulnerabilitiescountbydayandseverity) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### Fields -### `VulnerabilitiesCountByDayAndSeverityEdge` +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="userstatusavailability"></a>`availability` | [`AvailabilityEnum!`](#availabilityenum) | User availability status. | +| <a id="userstatusemoji"></a>`emoji` | [`String`](#string) | String representation of emoji. | +| <a id="userstatusmessage"></a>`message` | [`String`](#string) | User status message. | +| <a id="userstatusmessagehtml"></a>`messageHtml` | [`String`](#string) | HTML of the user status message. | -An edge in a connection. +### `VulnerabilitiesCountByDay` -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`VulnerabilitiesCountByDayAndSeverity`](#vulnerabilitiescountbydayandseverity) | The item at the end of the edge. | +Represents the count of vulnerabilities by severity on a particular day. This data is retained for 365 days. -### `VulnerabilitiesCountByDayConnection` +#### Fields -The connection type for VulnerabilitiesCountByDay. +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitiescountbydaycritical"></a>`critical` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with critical severity. | +| <a id="vulnerabilitiescountbydaydate"></a>`date` | [`ISO8601Date!`](#iso8601date) | Date for the count. | +| <a id="vulnerabilitiescountbydayhigh"></a>`high` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with high severity. | +| <a id="vulnerabilitiescountbydayinfo"></a>`info` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with info severity. | +| <a id="vulnerabilitiescountbydaylow"></a>`low` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with low severity. | +| <a id="vulnerabilitiescountbydaymedium"></a>`medium` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with medium severity. | +| <a id="vulnerabilitiescountbydaytotal"></a>`total` | [`Int!`](#int) | Total number of vulnerabilities on a particular day. | +| <a id="vulnerabilitiescountbydayunknown"></a>`unknown` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with unknown severity. | -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[VulnerabilitiesCountByDayEdge]`](#vulnerabilitiescountbydayedge) | A list of edges. | -| `nodes` | [`[VulnerabilitiesCountByDay]`](#vulnerabilitiescountbyday) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +### `VulnerabilitiesCountByDayAndSeverity` -### `VulnerabilitiesCountByDayEdge` +Represents the number of vulnerabilities for a particular severity on a particular day. This data is retained for 365 days. -An edge in a connection. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`VulnerabilitiesCountByDay`](#vulnerabilitiescountbyday) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitiescountbydayandseveritycount"></a>`count` | [`Int`](#int) | Number of vulnerabilities. | +| <a id="vulnerabilitiescountbydayandseverityday"></a>`day` | [`ISO8601Date`](#iso8601date) | Date for the count. | +| <a id="vulnerabilitiescountbydayandseverityseverity"></a>`severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the counted vulnerabilities. | ### `Vulnerability` Represents a vulnerability. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `confirmedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to confirmed. | -| `confirmedBy` | [`User`](#user) | The user that confirmed the vulnerability. | -| `description` | [`String`](#string) | Description of the vulnerability. | -| `details` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Details of the vulnerability. | -| `detectedAt` | [`Time!`](#time) | Timestamp of when the vulnerability was first detected. | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `dismissedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to dismissed. | -| `dismissedBy` | [`User`](#user) | The user that dismissed the vulnerability. | -| `externalIssueLinks` | [`VulnerabilityExternalIssueLinkConnection!`](#vulnerabilityexternalissuelinkconnection) | List of external issue links related to the vulnerability. | -| `hasSolutions` | [`Boolean`](#boolean) | Indicates whether there is a solution available for this vulnerability. | -| `id` | [`ID!`](#id) | GraphQL ID of the vulnerability. | -| `identifiers` | [`[VulnerabilityIdentifier!]!`](#vulnerabilityidentifier) | Identifiers of the vulnerability. | -| `issueLinks` | [`VulnerabilityIssueLinkConnection!`](#vulnerabilityissuelinkconnection) | List of issue links related to the vulnerability. | -| `location` | [`VulnerabilityLocation`](#vulnerabilitylocation) | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. | -| `mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request that fixes the vulnerability. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | -| `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). `Scan Type` in the UI. | -| `resolvedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to resolved. | -| `resolvedBy` | [`User`](#user) | The user that resolved the vulnerability. | -| `resolvedOnDefaultBranch` | [`Boolean!`](#boolean) | Indicates whether the vulnerability is fixed on the default branch or not. | -| `scanner` | [`VulnerabilityScanner`](#vulnerabilityscanner) | Scanner metadata for the vulnerability. | -| `severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL). | -| `state` | [`VulnerabilityState`](#vulnerabilitystate) | State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED). | -| `title` | [`String`](#string) | Title of the vulnerability. | -| `userNotesCount` | [`Int!`](#int) | Number of user notes attached to the vulnerability. | -| `userPermissions` | [`VulnerabilityPermissions!`](#vulnerabilitypermissions) | Permissions for the current user on the resource. | -| `vulnerabilityPath` | [`String`](#string) | URL to the vulnerability's details page. | - -### `VulnerabilityConfirmPayload` - -Autogenerated return type of VulnerabilityConfirm. - -| Field | 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) | The vulnerability after state change. | - -### `VulnerabilityConnection` - -The connection type for Vulnerability. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[VulnerabilityEdge]`](#vulnerabilityedge) | A list of edges. | -| `nodes` | [`[Vulnerability]`](#vulnerability) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityconfirmedat"></a>`confirmedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to confirmed. | +| <a id="vulnerabilityconfirmedby"></a>`confirmedBy` | [`UserCore`](#usercore) | The user that confirmed the vulnerability. | +| <a id="vulnerabilitydescription"></a>`description` | [`String`](#string) | Description of the vulnerability. | +| <a id="vulnerabilitydetails"></a>`details` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Details of the vulnerability. | +| <a id="vulnerabilitydetectedat"></a>`detectedAt` | [`Time!`](#time) | Timestamp of when the vulnerability was first detected. | +| <a id="vulnerabilitydiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="vulnerabilitydismissedat"></a>`dismissedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to dismissed. | +| <a id="vulnerabilitydismissedby"></a>`dismissedBy` | [`UserCore`](#usercore) | The user that dismissed the vulnerability. | +| <a id="vulnerabilityexternalissuelinks"></a>`externalIssueLinks` | [`VulnerabilityExternalIssueLinkConnection!`](#vulnerabilityexternalissuelinkconnection) | List of external issue links related to the vulnerability. (see [Connections](#connections)) | +| <a id="vulnerabilityhassolutions"></a>`hasSolutions` | [`Boolean`](#boolean) | Indicates whether there is a solution available for this vulnerability. | +| <a id="vulnerabilityid"></a>`id` | [`ID!`](#id) | GraphQL ID of the vulnerability. | +| <a id="vulnerabilityidentifiers"></a>`identifiers` | [`[VulnerabilityIdentifier!]!`](#vulnerabilityidentifier) | Identifiers of the vulnerability. | +| <a id="vulnerabilitylocation"></a>`location` | [`VulnerabilityLocation`](#vulnerabilitylocation) | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. | +| <a id="vulnerabilitymergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request that fixes the vulnerability. | +| <a id="vulnerabilitynotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | +| <a id="vulnerabilityprimaryidentifier"></a>`primaryIdentifier` | [`VulnerabilityIdentifier`](#vulnerabilityidentifier) | Primary identifier of the vulnerability. | +| <a id="vulnerabilityproject"></a>`project` | [`Project`](#project) | The project on which the vulnerability was found. | +| <a id="vulnerabilityreporttype"></a>`reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING). `Scan Type` in the UI. | +| <a id="vulnerabilityresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to resolved. | +| <a id="vulnerabilityresolvedby"></a>`resolvedBy` | [`UserCore`](#usercore) | The user that resolved the vulnerability. | +| <a id="vulnerabilityresolvedondefaultbranch"></a>`resolvedOnDefaultBranch` | [`Boolean!`](#boolean) | Indicates whether the vulnerability is fixed on the default branch or not. | +| <a id="vulnerabilityscanner"></a>`scanner` | [`VulnerabilityScanner`](#vulnerabilityscanner) | Scanner metadata for the vulnerability. | +| <a id="vulnerabilityseverity"></a>`severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL). | +| <a id="vulnerabilitystate"></a>`state` | [`VulnerabilityState`](#vulnerabilitystate) | State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED). | +| <a id="vulnerabilitytitle"></a>`title` | [`String`](#string) | Title of the vulnerability. | +| <a id="vulnerabilityusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes attached to the vulnerability. | +| <a id="vulnerabilityuserpermissions"></a>`userPermissions` | [`VulnerabilityPermissions!`](#vulnerabilitypermissions) | Permissions for the current user on the resource. | +| <a id="vulnerabilityvulnerabilitypath"></a>`vulnerabilityPath` | [`String`](#string) | URL to the vulnerability's details page. | + +#### Fields with arguments + +##### `Vulnerability.issueLinks` + +List of issue links related to the vulnerability. + +Returns [`VulnerabilityIssueLinkConnection!`](#vulnerabilityissuelinkconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityissuelinkslinktype"></a>`linkType` | [`VulnerabilityIssueLinkType`](#vulnerabilityissuelinktype) | Filter issue links by link type. | ### `VulnerabilityDetailBase` Represents the vulnerability details base. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `name` | [`String`](#string) | Name of the field. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailbasedescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailbasefieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailbasename"></a>`name` | [`String`](#string) | Name of the field. | ### `VulnerabilityDetailBoolean` Represents the vulnerability details boolean value. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `name` | [`String`](#string) | Name of the field. | -| `value` | [`Boolean!`](#boolean) | Value of the field. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailbooleandescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailbooleanfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailbooleanname"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailbooleanvalue"></a>`value` | [`Boolean!`](#boolean) | Value of the field. | ### `VulnerabilityDetailCode` Represents the vulnerability details code field. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `lang` | [`String`](#string) | Language of the code. | -| `name` | [`String`](#string) | Name of the field. | -| `value` | [`String!`](#string) | Source code. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailcodedescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailcodefieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailcodelang"></a>`lang` | [`String`](#string) | Language of the code. | +| <a id="vulnerabilitydetailcodename"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailcodevalue"></a>`value` | [`String!`](#string) | Source code. | ### `VulnerabilityDetailCommit` Represents the vulnerability details commit field. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `name` | [`String`](#string) | Name of the field. | -| `value` | [`String!`](#string) | The commit SHA value. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailcommitdescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailcommitfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailcommitname"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailcommitvalue"></a>`value` | [`String!`](#string) | The commit SHA value. | ### `VulnerabilityDetailDiff` Represents the vulnerability details diff field. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `after` | [`String!`](#string) | Value of the field after the change. | -| `before` | [`String!`](#string) | Value of the field before the change. | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `name` | [`String`](#string) | Name of the field. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetaildiffafter"></a>`after` | [`String!`](#string) | Value of the field after the change. | +| <a id="vulnerabilitydetaildiffbefore"></a>`before` | [`String!`](#string) | Value of the field before the change. | +| <a id="vulnerabilitydetaildiffdescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetaildifffieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetaildiffname"></a>`name` | [`String`](#string) | Name of the field. | ### `VulnerabilityDetailFileLocation` Represents the vulnerability details location within a file in the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `fileName` | [`String!`](#string) | File name. | -| `lineEnd` | [`Int!`](#int) | End line number of the file location. | -| `lineStart` | [`Int!`](#int) | Start line number of the file location. | -| `name` | [`String`](#string) | Name of the field. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailfilelocationdescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailfilelocationfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailfilelocationfilename"></a>`fileName` | [`String!`](#string) | File name. | +| <a id="vulnerabilitydetailfilelocationlineend"></a>`lineEnd` | [`Int!`](#int) | End line number of the file location. | +| <a id="vulnerabilitydetailfilelocationlinestart"></a>`lineStart` | [`Int!`](#int) | Start line number of the file location. | +| <a id="vulnerabilitydetailfilelocationname"></a>`name` | [`String`](#string) | Name of the field. | ### `VulnerabilityDetailInt` Represents the vulnerability details integer value. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `name` | [`String`](#string) | Name of the field. | -| `value` | [`Int!`](#int) | Value of the field. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailintdescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailintfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailintname"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailintvalue"></a>`value` | [`Int!`](#int) | Value of the field. | ### `VulnerabilityDetailList` Represents the vulnerability details list value. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `items` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | List of details. | -| `name` | [`String`](#string) | Name of the field. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetaillistdescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetaillistfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetaillistitems"></a>`items` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | List of details. | +| <a id="vulnerabilitydetaillistname"></a>`name` | [`String`](#string) | Name of the field. | ### `VulnerabilityDetailMarkdown` Represents the vulnerability details Markdown field. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `name` | [`String`](#string) | Name of the field. | -| `value` | [`String!`](#string) | Value of the Markdown field. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailmarkdowndescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailmarkdownfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailmarkdownname"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailmarkdownvalue"></a>`value` | [`String!`](#string) | Value of the Markdown field. | ### `VulnerabilityDetailModuleLocation` Represents the vulnerability details location within a file in the project. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `moduleName` | [`String!`](#string) | Module name. | -| `name` | [`String`](#string) | Name of the field. | -| `offset` | [`Int!`](#int) | Offset of the module location. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailmodulelocationdescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailmodulelocationfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailmodulelocationmodulename"></a>`moduleName` | [`String!`](#string) | Module name. | +| <a id="vulnerabilitydetailmodulelocationname"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailmodulelocationoffset"></a>`offset` | [`Int!`](#int) | Offset of the module location. | ### `VulnerabilityDetailTable` Represents the vulnerability details table value. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `headers` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Table headers. | -| `name` | [`String`](#string) | Name of the field. | -| `rows` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Table rows. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailtabledescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailtablefieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailtableheaders"></a>`headers` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Table headers. | +| <a id="vulnerabilitydetailtablename"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailtablerows"></a>`rows` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Table rows. | ### `VulnerabilityDetailText` Represents the vulnerability details text field. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `name` | [`String`](#string) | Name of the field. | -| `value` | [`String!`](#string) | Value of the text field. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailtextdescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailtextfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailtextname"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailtextvalue"></a>`value` | [`String!`](#string) | Value of the text field. | ### `VulnerabilityDetailUrl` Represents the vulnerability details URL field. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `description` | [`String`](#string) | Description of the field. | -| `fieldName` | [`String`](#string) | Name of the field. | -| `href` | [`String!`](#string) | Href of the URL. | -| `name` | [`String`](#string) | Name of the field. | -| `text` | [`String`](#string) | Text of the URL. | - -### `VulnerabilityDismissPayload` - -Autogenerated return type of VulnerabilityDismiss. - -| Field | 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) | The vulnerability after dismissal. | +#### Fields -### `VulnerabilityEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`Vulnerability`](#vulnerability) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitydetailurldescription"></a>`description` | [`String`](#string) | Description of the field. | +| <a id="vulnerabilitydetailurlfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailurlhref"></a>`href` | [`String!`](#string) | Href of the URL. | +| <a id="vulnerabilitydetailurlname"></a>`name` | [`String`](#string) | Name of the field. | +| <a id="vulnerabilitydetailurltext"></a>`text` | [`String`](#string) | Text of the URL. | ### `VulnerabilityExternalIssueLink` Represents an external issue link of a vulnerability. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `externalIssue` | [`ExternalIssue`](#externalissue) | The external issue attached to the issue link. | -| `id` | [`VulnerabilitiesExternalIssueLinkID!`](#vulnerabilitiesexternalissuelinkid) | GraphQL ID of the external issue link. | -| `linkType` | [`VulnerabilityExternalIssueLinkType!`](#vulnerabilityexternalissuelinktype) | Type of the external issue link. | - -### `VulnerabilityExternalIssueLinkConnection` - -The connection type for VulnerabilityExternalIssueLink. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[VulnerabilityExternalIssueLinkEdge]`](#vulnerabilityexternalissuelinkedge) | A list of edges. | -| `nodes` | [`[VulnerabilityExternalIssueLink]`](#vulnerabilityexternalissuelink) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `VulnerabilityExternalIssueLinkCreatePayload` - -Autogenerated return type of VulnerabilityExternalIssueLinkCreate. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | -| `externalIssueLink` | [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink) | The created external issue link. | - -### `VulnerabilityExternalIssueLinkDestroyPayload` - -Autogenerated return type of VulnerabilityExternalIssueLinkDestroy. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. | -| `errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. | - -### `VulnerabilityExternalIssueLinkEdge` +#### Fields -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityexternalissuelinkexternalissue"></a>`externalIssue` | [`ExternalIssue`](#externalissue) | The external issue attached to the issue link. | +| <a id="vulnerabilityexternalissuelinkid"></a>`id` | [`VulnerabilitiesExternalIssueLinkID!`](#vulnerabilitiesexternalissuelinkid) | GraphQL ID of the external issue link. | +| <a id="vulnerabilityexternalissuelinklinktype"></a>`linkType` | [`VulnerabilityExternalIssueLinkType!`](#vulnerabilityexternalissuelinktype) | Type of the external issue link. | ### `VulnerabilityIdentifier` Represents a vulnerability identifier. -| Field | 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. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityidentifierexternalid"></a>`externalId` | [`String`](#string) | External ID of the vulnerability identifier. | +| <a id="vulnerabilityidentifierexternaltype"></a>`externalType` | [`String`](#string) | External type of the vulnerability identifier. | +| <a id="vulnerabilityidentifiername"></a>`name` | [`String`](#string) | Name of the vulnerability identifier. | +| <a id="vulnerabilityidentifierurl"></a>`url` | [`String`](#string) | URL of the vulnerability identifier. | ### `VulnerabilityIssueLink` Represents an issue link of a vulnerability. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `id` | [`ID!`](#id) | GraphQL ID of the vulnerability. | -| `issue` | [`Issue!`](#issue) | The issue attached to issue link. | -| `linkType` | [`VulnerabilityIssueLinkType!`](#vulnerabilityissuelinktype) | Type of the issue link. | - -### `VulnerabilityIssueLinkConnection` - -The connection type for VulnerabilityIssueLink. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[VulnerabilityIssueLinkEdge]`](#vulnerabilityissuelinkedge) | A list of edges. | -| `nodes` | [`[VulnerabilityIssueLink]`](#vulnerabilityissuelink) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `VulnerabilityIssueLinkEdge` +#### Fields -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`VulnerabilityIssueLink`](#vulnerabilityissuelink) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityissuelinkid"></a>`id` | [`ID!`](#id) | GraphQL ID of the vulnerability. | +| <a id="vulnerabilityissuelinkissue"></a>`issue` | [`Issue!`](#issue) | The issue attached to issue link. | +| <a id="vulnerabilityissuelinklinktype"></a>`linkType` | [`VulnerabilityIssueLinkType!`](#vulnerabilityissuelinktype) | Type of the issue link. | ### `VulnerabilityLocationContainerScanning` Represents the location of a vulnerability found by a container security scan. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `dependency` | [`VulnerableDependency`](#vulnerabledependency) | Dependency containing the vulnerability. | -| `image` | [`String`](#string) | Name of the vulnerable container image. | -| `operatingSystem` | [`String`](#string) | Operating system that runs on the vulnerable container image. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitylocationcontainerscanningdependency"></a>`dependency` | [`VulnerableDependency`](#vulnerabledependency) | Dependency containing the vulnerability. | +| <a id="vulnerabilitylocationcontainerscanningimage"></a>`image` | [`String`](#string) | Name of the vulnerable container image. | +| <a id="vulnerabilitylocationcontainerscanningoperatingsystem"></a>`operatingSystem` | [`String`](#string) | Operating system that runs on the vulnerable container image. | ### `VulnerabilityLocationCoverageFuzzing` Represents the location of a vulnerability found by a Coverage Fuzzing scan. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `blobPath` | [`String`](#string) | Blob path to the vulnerable file. | -| `endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. | -| `file` | [`String`](#string) | Path to the vulnerable file. | -| `startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. | -| `vulnerableClass` | [`String`](#string) | Class containing the vulnerability. | -| `vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitylocationcoveragefuzzingblobpath"></a>`blobPath` | [`String`](#string) | Blob path to the vulnerable file. | +| <a id="vulnerabilitylocationcoveragefuzzingendline"></a>`endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. | +| <a id="vulnerabilitylocationcoveragefuzzingfile"></a>`file` | [`String`](#string) | Path to the vulnerable file. | +| <a id="vulnerabilitylocationcoveragefuzzingstartline"></a>`startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. | +| <a id="vulnerabilitylocationcoveragefuzzingvulnerableclass"></a>`vulnerableClass` | [`String`](#string) | Class containing the vulnerability. | +| <a id="vulnerabilitylocationcoveragefuzzingvulnerablemethod"></a>`vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. | ### `VulnerabilityLocationDast` Represents the location of a vulnerability found by a DAST scan. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `hostname` | [`String`](#string) | Domain name of the vulnerable request. | -| `param` | [`String`](#string) | Query parameter for the URL on which the vulnerability occurred. | -| `path` | [`String`](#string) | URL path and query string of the vulnerable request. | -| `requestMethod` | [`String`](#string) | HTTP method of the vulnerable request. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitylocationdasthostname"></a>`hostname` | [`String`](#string) | Domain name of the vulnerable request. | +| <a id="vulnerabilitylocationdastparam"></a>`param` | [`String`](#string) | Query parameter for the URL on which the vulnerability occurred. | +| <a id="vulnerabilitylocationdastpath"></a>`path` | [`String`](#string) | URL path and query string of the vulnerable request. | +| <a id="vulnerabilitylocationdastrequestmethod"></a>`requestMethod` | [`String`](#string) | HTTP method of the vulnerable request. | ### `VulnerabilityLocationDependencyScanning` Represents the location of a vulnerability found by a dependency security scan. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `blobPath` | [`String`](#string) | Blob path to the vulnerable file. | -| `dependency` | [`VulnerableDependency`](#vulnerabledependency) | Dependency containing the vulnerability. | -| `file` | [`String`](#string) | Path to the vulnerable file. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitylocationdependencyscanningblobpath"></a>`blobPath` | [`String`](#string) | Blob path to the vulnerable file. | +| <a id="vulnerabilitylocationdependencyscanningdependency"></a>`dependency` | [`VulnerableDependency`](#vulnerabledependency) | Dependency containing the vulnerability. | +| <a id="vulnerabilitylocationdependencyscanningfile"></a>`file` | [`String`](#string) | Path to the vulnerable file. | ### `VulnerabilityLocationSast` Represents the location of a vulnerability found by a SAST scan. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `blobPath` | [`String`](#string) | Blob path to the vulnerable file. | -| `endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. | -| `file` | [`String`](#string) | Path to the vulnerable file. | -| `startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. | -| `vulnerableClass` | [`String`](#string) | Class containing the vulnerability. | -| `vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitylocationsastblobpath"></a>`blobPath` | [`String`](#string) | Blob path to the vulnerable file. | +| <a id="vulnerabilitylocationsastendline"></a>`endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. | +| <a id="vulnerabilitylocationsastfile"></a>`file` | [`String`](#string) | Path to the vulnerable file. | +| <a id="vulnerabilitylocationsaststartline"></a>`startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. | +| <a id="vulnerabilitylocationsastvulnerableclass"></a>`vulnerableClass` | [`String`](#string) | Class containing the vulnerability. | +| <a id="vulnerabilitylocationsastvulnerablemethod"></a>`vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. | ### `VulnerabilityLocationSecretDetection` Represents the location of a vulnerability found by a secret detection scan. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `blobPath` | [`String`](#string) | Blob path to the vulnerable file. | -| `endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. | -| `file` | [`String`](#string) | Path to the vulnerable file. | -| `startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. | -| `vulnerableClass` | [`String`](#string) | Class containing the vulnerability. | -| `vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitylocationsecretdetectionblobpath"></a>`blobPath` | [`String`](#string) | Blob path to the vulnerable file. | +| <a id="vulnerabilitylocationsecretdetectionendline"></a>`endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. | +| <a id="vulnerabilitylocationsecretdetectionfile"></a>`file` | [`String`](#string) | Path to the vulnerable file. | +| <a id="vulnerabilitylocationsecretdetectionstartline"></a>`startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. | +| <a id="vulnerabilitylocationsecretdetectionvulnerableclass"></a>`vulnerableClass` | [`String`](#string) | Class containing the vulnerability. | +| <a id="vulnerabilitylocationsecretdetectionvulnerablemethod"></a>`vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. | ### `VulnerabilityPermissions` Check permissions for the current user on a vulnerability. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `adminVulnerability` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability` on this resource. | -| `adminVulnerabilityExternalIssueLink` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability_external_issue_link` on this resource. | -| `adminVulnerabilityIssueLink` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability_issue_link` on this resource. | -| `createVulnerability` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability` on this resource. | -| `createVulnerabilityExport` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability_export` on this resource. | -| `createVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability_feedback` on this resource. | -| `destroyVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_vulnerability_feedback` on this resource. | -| `readVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `read_vulnerability_feedback` on this resource. | -| `updateVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `update_vulnerability_feedback` on this resource. | - -### `VulnerabilityResolvePayload` - -Autogenerated return type of VulnerabilityResolve. - -| Field | 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) | The vulnerability after state change. | - -### `VulnerabilityRevertToDetectedPayload` +#### Fields -Autogenerated return type of VulnerabilityRevertToDetected. - -| Field | 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) | The vulnerability after revert. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilitypermissionsadminvulnerability"></a>`adminVulnerability` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability` on this resource. | +| <a id="vulnerabilitypermissionsadminvulnerabilityexternalissuelink"></a>`adminVulnerabilityExternalIssueLink` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability_external_issue_link` on this resource. | +| <a id="vulnerabilitypermissionsadminvulnerabilityissuelink"></a>`adminVulnerabilityIssueLink` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability_issue_link` on this resource. | +| <a id="vulnerabilitypermissionscreatevulnerability"></a>`createVulnerability` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability` on this resource. | +| <a id="vulnerabilitypermissionscreatevulnerabilityexport"></a>`createVulnerabilityExport` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability_export` on this resource. | +| <a id="vulnerabilitypermissionscreatevulnerabilityfeedback"></a>`createVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability_feedback` on this resource. | +| <a id="vulnerabilitypermissionsdestroyvulnerabilityfeedback"></a>`destroyVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_vulnerability_feedback` on this resource. | +| <a id="vulnerabilitypermissionsreadvulnerabilityfeedback"></a>`readVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `read_vulnerability_feedback` on this resource. | +| <a id="vulnerabilitypermissionsupdatevulnerabilityfeedback"></a>`updateVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `update_vulnerability_feedback` on this resource. | ### `VulnerabilityScanner` Represents a vulnerability scanner. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `externalId` | [`String`](#string) | External ID of the vulnerability scanner. | -| `id` | [`ID`](#id) | ID of the scanner. | -| `name` | [`String`](#string) | Name of the vulnerability scanner. | -| `reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the vulnerability report. | -| `vendor` | [`String`](#string) | Vendor of the vulnerability scanner. | - -### `VulnerabilityScannerConnection` - -The connection type for VulnerabilityScanner. +#### Fields -| Field | Type | Description | -| ----- | ---- | ----------- | -| `edges` | [`[VulnerabilityScannerEdge]`](#vulnerabilityscanneredge) | A list of edges. | -| `nodes` | [`[VulnerabilityScanner]`](#vulnerabilityscanner) | A list of nodes. | -| `pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | - -### `VulnerabilityScannerEdge` - -An edge in a connection. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `cursor` | [`String!`](#string) | A cursor for use in pagination. | -| `node` | [`VulnerabilityScanner`](#vulnerabilityscanner) | The item at the end of the edge. | +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityscannerexternalid"></a>`externalId` | [`String`](#string) | External ID of the vulnerability scanner. | +| <a id="vulnerabilityscannerid"></a>`id` | [`ID`](#id) | ID of the scanner. | +| <a id="vulnerabilityscannername"></a>`name` | [`String`](#string) | Name of the vulnerability scanner. | +| <a id="vulnerabilityscannerreporttype"></a>`reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the vulnerability report. | +| <a id="vulnerabilityscannervendor"></a>`vendor` | [`String`](#string) | Vendor of the vulnerability scanner. | ### `VulnerabilitySeveritiesCount` Represents vulnerability counts by severity. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `critical` | [`Int`](#int) | Number of vulnerabilities of CRITICAL severity of the project. | -| `high` | [`Int`](#int) | Number of vulnerabilities of HIGH severity of the project. | -| `info` | [`Int`](#int) | Number of vulnerabilities of INFO severity of the project. | -| `low` | [`Int`](#int) | Number of vulnerabilities of LOW severity of the project. | -| `medium` | [`Int`](#int) | Number of vulnerabilities of MEDIUM severity of the project. | -| `unknown` | [`Int`](#int) | Number of vulnerabilities of UNKNOWN severity of the project. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabilityseveritiescountcritical"></a>`critical` | [`Int`](#int) | Number of vulnerabilities of CRITICAL severity of the project. | +| <a id="vulnerabilityseveritiescounthigh"></a>`high` | [`Int`](#int) | Number of vulnerabilities of HIGH severity of the project. | +| <a id="vulnerabilityseveritiescountinfo"></a>`info` | [`Int`](#int) | Number of vulnerabilities of INFO severity of the project. | +| <a id="vulnerabilityseveritiescountlow"></a>`low` | [`Int`](#int) | Number of vulnerabilities of LOW severity of the project. | +| <a id="vulnerabilityseveritiescountmedium"></a>`medium` | [`Int`](#int) | Number of vulnerabilities of MEDIUM severity of the project. | +| <a id="vulnerabilityseveritiescountunknown"></a>`unknown` | [`Int`](#int) | Number of vulnerabilities of UNKNOWN severity of the project. | ### `VulnerableDependency` Represents a vulnerable dependency. Used in vulnerability location data. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `package` | [`VulnerablePackage`](#vulnerablepackage) | The package associated with the vulnerable dependency. | -| `version` | [`String`](#string) | The version of the vulnerable dependency. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerabledependencypackage"></a>`package` | [`VulnerablePackage`](#vulnerablepackage) | The package associated with the vulnerable dependency. | +| <a id="vulnerabledependencyversion"></a>`version` | [`String`](#string) | The version of the vulnerable dependency. | ### `VulnerablePackage` Represents a vulnerable package. Used in vulnerability dependency data. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `name` | [`String`](#string) | The name of the vulnerable package. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerablepackagename"></a>`name` | [`String`](#string) | The name of the vulnerable package. | ### `VulnerableProjectsByGrade` Represents vulnerability letter grades with associated projects. -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | [`Int!`](#int) | Number of projects within this grade. | -| `grade` | [`VulnerabilityGrade!`](#vulnerabilitygrade) | Grade based on the highest severity vulnerability present. | -| `projects` | [`ProjectConnection!`](#projectconnection) | Projects within this grade. | +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="vulnerableprojectsbygradecount"></a>`count` | [`Int!`](#int) | Number of projects within this grade. | +| <a id="vulnerableprojectsbygradegrade"></a>`grade` | [`VulnerabilityGrade!`](#vulnerabilitygrade) | Grade based on the highest severity vulnerability present. | +| <a id="vulnerableprojectsbygradeprojects"></a>`projects` | [`ProjectConnection!`](#projectconnection) | Projects within this grade. (see [Connections](#connections)) | ## Enumeration types @@ -7573,13 +13505,13 @@ Access level to a resource. | Value | Description | | ----- | ----------- | -| `DEVELOPER` | Developer access. | -| `GUEST` | Guest access. | -| `MAINTAINER` | Maintainer access. | -| `MINIMAL_ACCESS` | Minimal access. | -| `NO_ACCESS` | No access. | -| `OWNER` | Owner access. | -| `REPORTER` | Reporter access. | +| <a id="accesslevelenumdeveloper"></a>`DEVELOPER` | Developer access. | +| <a id="accesslevelenumguest"></a>`GUEST` | Guest access. | +| <a id="accesslevelenummaintainer"></a>`MAINTAINER` | Maintainer access. | +| <a id="accesslevelenumminimal_access"></a>`MINIMAL_ACCESS` | Minimal access. | +| <a id="accesslevelenumno_access"></a>`NO_ACCESS` | No access. | +| <a id="accesslevelenumowner"></a>`OWNER` | Owner access. | +| <a id="accesslevelenumreporter"></a>`REPORTER` | Reporter access. | ### `AlertManagementAlertSort` @@ -7587,28 +13519,28 @@ Values for sorting alerts. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order. | -| `CREATED_DESC` | Created at descending order. | -| `CREATED_TIME_ASC` | Created time by ascending order. | -| `CREATED_TIME_DESC` | Created time by descending order. | -| `ENDED_AT_ASC` | End time by ascending order. | -| `ENDED_AT_DESC` | End time by descending order. | -| `EVENT_COUNT_ASC` | Events count by ascending order. | -| `EVENT_COUNT_DESC` | Events count by descending order. | -| `SEVERITY_ASC` | Severity from less critical to more critical. | -| `SEVERITY_DESC` | Severity from more critical to less critical. | -| `STARTED_AT_ASC` | Start time by ascending order. | -| `STARTED_AT_DESC` | Start time by descending order. | -| `STATUS_ASC` | Status by order: Ignored > Resolved > Acknowledged > Triggered. | -| `STATUS_DESC` | Status by order: Triggered > Acknowledged > Resolved > Ignored. | -| `UPDATED_ASC` | Updated at ascending order. | -| `UPDATED_DESC` | Updated at descending order. | -| `UPDATED_TIME_ASC` | Created time by ascending order. | -| `UPDATED_TIME_DESC` | Created time by descending order. | -| `created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | -| `created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | -| `updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | -| `updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | +| <a id="alertmanagementalertsortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. | +| <a id="alertmanagementalertsortcreated_desc"></a>`CREATED_DESC` | Created at descending order. | +| <a id="alertmanagementalertsortcreated_time_asc"></a>`CREATED_TIME_ASC` | Created time by ascending order. | +| <a id="alertmanagementalertsortcreated_time_desc"></a>`CREATED_TIME_DESC` | Created time by descending order. | +| <a id="alertmanagementalertsortended_at_asc"></a>`ENDED_AT_ASC` | End time by ascending order. | +| <a id="alertmanagementalertsortended_at_desc"></a>`ENDED_AT_DESC` | End time by descending order. | +| <a id="alertmanagementalertsortevent_count_asc"></a>`EVENT_COUNT_ASC` | Events count by ascending order. | +| <a id="alertmanagementalertsortevent_count_desc"></a>`EVENT_COUNT_DESC` | Events count by descending order. | +| <a id="alertmanagementalertsortseverity_asc"></a>`SEVERITY_ASC` | Severity from less critical to more critical. | +| <a id="alertmanagementalertsortseverity_desc"></a>`SEVERITY_DESC` | Severity from more critical to less critical. | +| <a id="alertmanagementalertsortstarted_at_asc"></a>`STARTED_AT_ASC` | Start time by ascending order. | +| <a id="alertmanagementalertsortstarted_at_desc"></a>`STARTED_AT_DESC` | Start time by descending order. | +| <a id="alertmanagementalertsortstatus_asc"></a>`STATUS_ASC` | Status by order: Ignored > Resolved > Acknowledged > Triggered. | +| <a id="alertmanagementalertsortstatus_desc"></a>`STATUS_DESC` | Status by order: Triggered > Acknowledged > Resolved > Ignored. | +| <a id="alertmanagementalertsortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. | +| <a id="alertmanagementalertsortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. | +| <a id="alertmanagementalertsortupdated_time_asc"></a>`UPDATED_TIME_ASC` | Created time by ascending order. | +| <a id="alertmanagementalertsortupdated_time_desc"></a>`UPDATED_TIME_DESC` | Created time by descending order. | +| <a id="alertmanagementalertsortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | +| <a id="alertmanagementalertsortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | +| <a id="alertmanagementalertsortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | +| <a id="alertmanagementalertsortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | ### `AlertManagementDomainFilter` @@ -7616,8 +13548,8 @@ Filters the alerts based on given domain. | Value | Description | | ----- | ----------- | -| `operations` | Alerts for operations domain. | -| `threat_monitoring` | Alerts for threat monitoring domain. | +| <a id="alertmanagementdomainfilteroperations"></a>`operations` | Alerts for operations domain. | +| <a id="alertmanagementdomainfilterthreat_monitoring"></a>`threat_monitoring` | Alerts for threat monitoring domain. | ### `AlertManagementIntegrationType` @@ -7625,8 +13557,8 @@ Values of types of integrations. | Value | Description | | ----- | ----------- | -| `HTTP` | Integration with any monitoring tool. | -| `PROMETHEUS` | Prometheus integration. | +| <a id="alertmanagementintegrationtypehttp"></a>`HTTP` | Integration with any monitoring tool. | +| <a id="alertmanagementintegrationtypeprometheus"></a>`PROMETHEUS` | Prometheus integration. | ### `AlertManagementPayloadAlertFieldName` @@ -7634,16 +13566,16 @@ Values for alert field names used in the custom mapping. | Value | Description | | ----- | ----------- | -| `DESCRIPTION` | A high-level summary of the problem. | -| `END_TIME` | The resolved time of the incident. | -| `FINGERPRINT` | The unique identifier of the alert. This can be used to group occurrences of the same alert. | -| `GITLAB_ENVIRONMENT_NAME` | The name of the associated GitLab environment. | -| `HOSTS` | One or more hosts, as to where this incident occurred. | -| `MONITORING_TOOL` | The name of the associated monitoring tool. | -| `SERVICE` | The affected service. | -| `SEVERITY` | The severity of the alert. | -| `START_TIME` | The time of the incident. | -| `TITLE` | The title of the incident. | +| <a id="alertmanagementpayloadalertfieldnamedescription"></a>`DESCRIPTION` | A high-level summary of the problem. | +| <a id="alertmanagementpayloadalertfieldnameend_time"></a>`END_TIME` | The resolved time of the incident. | +| <a id="alertmanagementpayloadalertfieldnamefingerprint"></a>`FINGERPRINT` | The unique identifier of the alert. This can be used to group occurrences of the same alert. | +| <a id="alertmanagementpayloadalertfieldnamegitlab_environment_name"></a>`GITLAB_ENVIRONMENT_NAME` | The name of the associated GitLab environment. | +| <a id="alertmanagementpayloadalertfieldnamehosts"></a>`HOSTS` | One or more hosts, as to where this incident occurred. | +| <a id="alertmanagementpayloadalertfieldnamemonitoring_tool"></a>`MONITORING_TOOL` | The name of the associated monitoring tool. | +| <a id="alertmanagementpayloadalertfieldnameservice"></a>`SERVICE` | The affected service. | +| <a id="alertmanagementpayloadalertfieldnameseverity"></a>`SEVERITY` | The severity of the alert. | +| <a id="alertmanagementpayloadalertfieldnamestart_time"></a>`START_TIME` | The time of the incident. | +| <a id="alertmanagementpayloadalertfieldnametitle"></a>`TITLE` | The title of the incident. | ### `AlertManagementPayloadAlertFieldType` @@ -7651,9 +13583,9 @@ Values for alert field types used in the custom mapping. | Value | Description | | ----- | ----------- | -| `ARRAY` | Array field type. | -| `DATETIME` | DateTime field type. | -| `STRING` | String field type. | +| <a id="alertmanagementpayloadalertfieldtypearray"></a>`ARRAY` | Array field type. | +| <a id="alertmanagementpayloadalertfieldtypedatetime"></a>`DATETIME` | DateTime field type. | +| <a id="alertmanagementpayloadalertfieldtypestring"></a>`STRING` | String field type. | ### `AlertManagementSeverity` @@ -7661,12 +13593,12 @@ Alert severity values. | Value | Description | | ----- | ----------- | -| `CRITICAL` | Critical severity. | -| `HIGH` | High severity. | -| `INFO` | Info severity. | -| `LOW` | Low severity. | -| `MEDIUM` | Medium severity. | -| `UNKNOWN` | Unknown severity. | +| <a id="alertmanagementseveritycritical"></a>`CRITICAL` | Critical severity. | +| <a id="alertmanagementseverityhigh"></a>`HIGH` | High severity. | +| <a id="alertmanagementseverityinfo"></a>`INFO` | Info severity. | +| <a id="alertmanagementseveritylow"></a>`LOW` | Low severity. | +| <a id="alertmanagementseveritymedium"></a>`MEDIUM` | Medium severity. | +| <a id="alertmanagementseverityunknown"></a>`UNKNOWN` | Unknown severity. | ### `AlertManagementStatus` @@ -7674,10 +13606,10 @@ Alert status values. | Value | Description | | ----- | ----------- | -| `ACKNOWLEDGED` | Acknowledged status. | -| `IGNORED` | Ignored status. | -| `RESOLVED` | Resolved status. | -| `TRIGGERED` | Triggered status. | +| <a id="alertmanagementstatusacknowledged"></a>`ACKNOWLEDGED` | Someone is actively investigating the problem. | +| <a id="alertmanagementstatusignored"></a>`IGNORED` | No action will be taken on the alert. | +| <a id="alertmanagementstatusresolved"></a>`RESOLVED` | No further work is required. | +| <a id="alertmanagementstatustriggered"></a>`TRIGGERED` | Investigation has not started. | ### `ApiFuzzingScanMode` @@ -7685,9 +13617,9 @@ All possible ways to specify the API surface for an API fuzzing scan. | Value | Description | | ----- | ----------- | -| `HAR` | The API surface is specified by a HAR file. | -| `OPENAPI` | The API surface is specified by a OPENAPI file. | -| `POSTMAN` | The API surface is specified by a POSTMAN file. | +| <a id="apifuzzingscanmodehar"></a>`HAR` | The API surface is specified by a HAR file. | +| <a id="apifuzzingscanmodeopenapi"></a>`OPENAPI` | The API surface is specified by a OPENAPI file. | +| <a id="apifuzzingscanmodepostman"></a>`POSTMAN` | The API surface is specified by a POSTMAN file. | ### `ApprovalRuleType` @@ -7695,10 +13627,10 @@ The kind of an approval rule. | Value | Description | | ----- | ----------- | -| `ANY_APPROVER` | A `any_approver` approval rule. | -| `CODE_OWNER` | A `code_owner` approval rule. | -| `REGULAR` | A `regular` approval rule. | -| `REPORT_APPROVER` | A `report_approver` approval rule. | +| <a id="approvalruletypeany_approver"></a>`ANY_APPROVER` | A `any_approver` approval rule. | +| <a id="approvalruletypecode_owner"></a>`CODE_OWNER` | A `code_owner` approval rule. | +| <a id="approvalruletyperegular"></a>`REGULAR` | A `regular` approval rule. | +| <a id="approvalruletypereport_approver"></a>`REPORT_APPROVER` | A `report_approver` approval rule. | ### `AssigneeWildcardId` @@ -7706,8 +13638,8 @@ Assignee ID wildcard values. | Value | Description | | ----- | ----------- | -| `ANY` | An assignee is assigned. | -| `NONE` | No assignee is assigned. | +| <a id="assigneewildcardidany"></a>`ANY` | An assignee is assigned. | +| <a id="assigneewildcardidnone"></a>`NONE` | No assignee is assigned. | ### `AvailabilityEnum` @@ -7715,8 +13647,8 @@ User availability status. | Value | Description | | ----- | ----------- | -| `BUSY` | Busy. | -| `NOT_SET` | Not Set. | +| <a id="availabilityenumbusy"></a>`BUSY` | Busy. | +| <a id="availabilityenumnot_set"></a>`NOT_SET` | Not Set. | ### `BlobViewersType` @@ -7724,9 +13656,9 @@ Types of blob viewers. | Value | Description | | ----- | ----------- | -| `auxiliary` | Auxiliary blob viewers type. | -| `rich` | Rich blob viewers type. | -| `simple` | Simple blob viewers type. | +| <a id="blobviewerstypeauxiliary"></a>`auxiliary` | Auxiliary blob viewers type. | +| <a id="blobviewerstyperich"></a>`rich` | Rich blob viewers type. | +| <a id="blobviewerstypesimple"></a>`simple` | Simple blob viewers type. | ### `CiConfigStatus` @@ -7734,24 +13666,68 @@ Values for YAML processor result. | Value | Description | | ----- | ----------- | -| `INVALID` | The configuration file is not valid. | -| `VALID` | The configuration file is valid. | +| <a id="ciconfigstatusinvalid"></a>`INVALID` | The configuration file is not valid. | +| <a id="ciconfigstatusvalid"></a>`VALID` | The configuration file is valid. | ### `CiJobStatus` | Value | Description | | ----- | ----------- | -| `CANCELED` | A job that is canceled. | -| `CREATED` | A job that is created. | -| `FAILED` | A job that is failed. | -| `MANUAL` | A job that is manual. | -| `PENDING` | A job that is pending. | -| `PREPARING` | A job that is preparing. | -| `RUNNING` | A job that is running. | -| `SCHEDULED` | A job that is scheduled. | -| `SKIPPED` | A job that is skipped. | -| `SUCCESS` | A job that is success. | -| `WAITING_FOR_RESOURCE` | A job that is waiting for resource. | +| <a id="cijobstatuscanceled"></a>`CANCELED` | A job that is canceled. | +| <a id="cijobstatuscreated"></a>`CREATED` | A job that is created. | +| <a id="cijobstatusfailed"></a>`FAILED` | A job that is failed. | +| <a id="cijobstatusmanual"></a>`MANUAL` | A job that is manual. | +| <a id="cijobstatuspending"></a>`PENDING` | A job that is pending. | +| <a id="cijobstatuspreparing"></a>`PREPARING` | A job that is preparing. | +| <a id="cijobstatusrunning"></a>`RUNNING` | A job that is running. | +| <a id="cijobstatusscheduled"></a>`SCHEDULED` | A job that is scheduled. | +| <a id="cijobstatusskipped"></a>`SKIPPED` | A job that is skipped. | +| <a id="cijobstatussuccess"></a>`SUCCESS` | A job that is success. | +| <a id="cijobstatuswaiting_for_resource"></a>`WAITING_FOR_RESOURCE` | A job that is waiting for resource. | + +### `CiRunnerAccessLevel` + +| Value | Description | +| ----- | ----------- | +| <a id="cirunneraccesslevelnot_protected"></a>`NOT_PROTECTED` | A runner that is not protected. | +| <a id="cirunneraccesslevelref_protected"></a>`REF_PROTECTED` | A runner that is ref protected. | + +### `CiRunnerSort` + +Values for sorting runners. + +| Value | Description | +| ----- | ----------- | +| <a id="cirunnersortcontacted_asc"></a>`CONTACTED_ASC` | Ordered by contacted_at in ascending order. | +| <a id="cirunnersortcreated_desc"></a>`CREATED_DESC` | Ordered by created_date in descending order. | + +### `CiRunnerStatus` + +| Value | Description | +| ----- | ----------- | +| <a id="cirunnerstatusactive"></a>`ACTIVE` | A runner that is active. | +| <a id="cirunnerstatusnot_connected"></a>`NOT_CONNECTED` | A runner that is not connected. | +| <a id="cirunnerstatusoffline"></a>`OFFLINE` | A runner that is offline. | +| <a id="cirunnerstatusonline"></a>`ONLINE` | A runner that is online. | +| <a id="cirunnerstatuspaused"></a>`PAUSED` | A runner that is paused. | + +### `CiRunnerType` + +| Value | Description | +| ----- | ----------- | +| <a id="cirunnertypegroup_type"></a>`GROUP_TYPE` | A runner that is group type. | +| <a id="cirunnertypeinstance_type"></a>`INSTANCE_TYPE` | A runner that is instance type. | +| <a id="cirunnertypeproject_type"></a>`PROJECT_TYPE` | A runner that is project type. | + +### `CodeQualityDegradationSeverity` + +| Value | Description | +| ----- | ----------- | +| <a id="codequalitydegradationseverityblocker"></a>`BLOCKER` | Code Quality degradation has a status of blocker. | +| <a id="codequalitydegradationseveritycritical"></a>`CRITICAL` | Code Quality degradation has a status of critical. | +| <a id="codequalitydegradationseverityinfo"></a>`INFO` | Code Quality degradation has a status of info. | +| <a id="codequalitydegradationseveritymajor"></a>`MAJOR` | Code Quality degradation has a status of major. | +| <a id="codequalitydegradationseverityminor"></a>`MINOR` | Code Quality degradation has a status of minor. | ### `CommitActionMode` @@ -7759,18 +13735,18 @@ Mode of a commit action. | Value | Description | | ----- | ----------- | -| `CHMOD` | Chmod command. | -| `CREATE` | Create command. | -| `DELETE` | Delete command. | -| `MOVE` | Move command. | -| `UPDATE` | Update command. | +| <a id="commitactionmodechmod"></a>`CHMOD` | Chmod command. | +| <a id="commitactionmodecreate"></a>`CREATE` | Create command. | +| <a id="commitactionmodedelete"></a>`DELETE` | Delete command. | +| <a id="commitactionmodemove"></a>`MOVE` | Move command. | +| <a id="commitactionmodeupdate"></a>`UPDATE` | Update command. | ### `CommitEncoding` | Value | Description | | ----- | ----------- | -| `BASE64` | Base64 encoding. | -| `TEXT` | Text encoding. | +| <a id="commitencodingbase64"></a>`BASE64` | Base64 encoding. | +| <a id="commitencodingtext"></a>`TEXT` | Text encoding. | ### `ConanMetadatumFileTypeEnum` @@ -7778,38 +13754,38 @@ Conan file types. | Value | Description | | ----- | ----------- | -| `PACKAGE_FILE` | A package file type. | -| `RECIPE_FILE` | A recipe file type. | +| <a id="conanmetadatumfiletypeenumpackage_file"></a>`PACKAGE_FILE` | A package file type. | +| <a id="conanmetadatumfiletypeenumrecipe_file"></a>`RECIPE_FILE` | A recipe file type. | ### `ContainerExpirationPolicyCadenceEnum` | Value | Description | | ----- | ----------- | -| `EVERY_DAY` | Every day. | -| `EVERY_MONTH` | Every month. | -| `EVERY_THREE_MONTHS` | Every three months. | -| `EVERY_TWO_WEEKS` | Every two weeks. | -| `EVERY_WEEK` | Every week. | +| <a id="containerexpirationpolicycadenceenumevery_day"></a>`EVERY_DAY` | Every day. | +| <a id="containerexpirationpolicycadenceenumevery_month"></a>`EVERY_MONTH` | Every month. | +| <a id="containerexpirationpolicycadenceenumevery_three_months"></a>`EVERY_THREE_MONTHS` | Every three months. | +| <a id="containerexpirationpolicycadenceenumevery_two_weeks"></a>`EVERY_TWO_WEEKS` | Every two weeks. | +| <a id="containerexpirationpolicycadenceenumevery_week"></a>`EVERY_WEEK` | Every week. | ### `ContainerExpirationPolicyKeepEnum` | Value | Description | | ----- | ----------- | -| `FIFTY_TAGS` | 50 tags per image name. | -| `FIVE_TAGS` | 5 tags per image name. | -| `ONE_HUNDRED_TAGS` | 100 tags per image name. | -| `ONE_TAG` | 1 tag per image name. | -| `TEN_TAGS` | 10 tags per image name. | -| `TWENTY_FIVE_TAGS` | 25 tags per image name. | +| <a id="containerexpirationpolicykeepenumfifty_tags"></a>`FIFTY_TAGS` | 50 tags per image name. | +| <a id="containerexpirationpolicykeepenumfive_tags"></a>`FIVE_TAGS` | 5 tags per image name. | +| <a id="containerexpirationpolicykeepenumone_hundred_tags"></a>`ONE_HUNDRED_TAGS` | 100 tags per image name. | +| <a id="containerexpirationpolicykeepenumone_tag"></a>`ONE_TAG` | 1 tag per image name. | +| <a id="containerexpirationpolicykeepenumten_tags"></a>`TEN_TAGS` | 10 tags per image name. | +| <a id="containerexpirationpolicykeepenumtwenty_five_tags"></a>`TWENTY_FIVE_TAGS` | 25 tags per image name. | ### `ContainerExpirationPolicyOlderThanEnum` | Value | Description | | ----- | ----------- | -| `FOURTEEN_DAYS` | 14 days until tags are automatically removed. | -| `NINETY_DAYS` | 90 days until tags are automatically removed. | -| `SEVEN_DAYS` | 7 days until tags are automatically removed. | -| `THIRTY_DAYS` | 30 days until tags are automatically removed. | +| <a id="containerexpirationpolicyolderthanenumfourteen_days"></a>`FOURTEEN_DAYS` | 14 days until tags are automatically removed. | +| <a id="containerexpirationpolicyolderthanenumninety_days"></a>`NINETY_DAYS` | 90 days until tags are automatically removed. | +| <a id="containerexpirationpolicyolderthanenumseven_days"></a>`SEVEN_DAYS` | 7 days until tags are automatically removed. | +| <a id="containerexpirationpolicyolderthanenumthirty_days"></a>`THIRTY_DAYS` | 30 days until tags are automatically removed. | ### `ContainerRepositoryCleanupStatus` @@ -7817,10 +13793,10 @@ Status of the tags cleanup of a container repository. | Value | Description | | ----- | ----------- | -| `ONGOING` | The tags cleanup is ongoing. | -| `SCHEDULED` | The tags cleanup is scheduled and is going to be executed shortly. | -| `UNFINISHED` | The tags cleanup has been partially executed. There are still remaining tags to delete. | -| `UNSCHEDULED` | The tags cleanup is not scheduled. This is the default state. | +| <a id="containerrepositorycleanupstatusongoing"></a>`ONGOING` | The tags cleanup is ongoing. | +| <a id="containerrepositorycleanupstatusscheduled"></a>`SCHEDULED` | The tags cleanup is scheduled and is going to be executed shortly. | +| <a id="containerrepositorycleanupstatusunfinished"></a>`UNFINISHED` | The tags cleanup has been partially executed. There are still remaining tags to delete. | +| <a id="containerrepositorycleanupstatusunscheduled"></a>`UNSCHEDULED` | The tags cleanup is not scheduled. This is the default state. | ### `ContainerRepositorySort` @@ -7828,16 +13804,16 @@ Values for sorting container repositories. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order. | -| `CREATED_DESC` | Created at descending order. | -| `NAME_ASC` | Name by ascending order. | -| `NAME_DESC` | Name by descending order. | -| `UPDATED_ASC` | Updated at ascending order. | -| `UPDATED_DESC` | Updated at descending order. | -| `created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | -| `created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | -| `updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | -| `updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | +| <a id="containerrepositorysortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. | +| <a id="containerrepositorysortcreated_desc"></a>`CREATED_DESC` | Created at descending order. | +| <a id="containerrepositorysortname_asc"></a>`NAME_ASC` | Name by ascending order. | +| <a id="containerrepositorysortname_desc"></a>`NAME_DESC` | Name by descending order. | +| <a id="containerrepositorysortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. | +| <a id="containerrepositorysortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. | +| <a id="containerrepositorysortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | +| <a id="containerrepositorysortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | +| <a id="containerrepositorysortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | +| <a id="containerrepositorysortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | ### `ContainerRepositoryStatus` @@ -7845,39 +13821,39 @@ Status of a container repository. | Value | Description | | ----- | ----------- | -| `DELETE_FAILED` | Delete Failed status. | -| `DELETE_SCHEDULED` | Delete Scheduled status. | +| <a id="containerrepositorystatusdelete_failed"></a>`DELETE_FAILED` | Delete Failed status. | +| <a id="containerrepositorystatusdelete_scheduled"></a>`DELETE_SCHEDULED` | Delete Scheduled status. | ### `DastScanTypeEnum` | Value | Description | | ----- | ----------- | -| `ACTIVE` | Active DAST scan. This scan will make active attacks against the target site. | -| `PASSIVE` | Passive DAST scan. This scan will not make active attacks against the target site. | +| <a id="dastscantypeenumactive"></a>`ACTIVE` | Active DAST scan. This scan will make active attacks against the target site. | +| <a id="dastscantypeenumpassive"></a>`PASSIVE` | Passive DAST scan. This scan will not make active attacks against the target site. | ### `DastSiteProfileValidationStatusEnum` | Value | Description | | ----- | ----------- | -| `FAILED_VALIDATION` | Site validation process finished but failed. | -| `INPROGRESS_VALIDATION` | Site validation process is in progress. | -| `NONE` | No site validation exists. | -| `PASSED_VALIDATION` | Site validation process finished successfully. | -| `PENDING_VALIDATION` | Site validation process has not started. | +| <a id="dastsiteprofilevalidationstatusenumfailed_validation"></a>`FAILED_VALIDATION` | Site validation process finished but failed. | +| <a id="dastsiteprofilevalidationstatusenuminprogress_validation"></a>`INPROGRESS_VALIDATION` | Site validation process is in progress. | +| <a id="dastsiteprofilevalidationstatusenumnone"></a>`NONE` | No site validation exists. | +| <a id="dastsiteprofilevalidationstatusenumpassed_validation"></a>`PASSED_VALIDATION` | Site validation process finished successfully. | +| <a id="dastsiteprofilevalidationstatusenumpending_validation"></a>`PENDING_VALIDATION` | Site validation process has not started. | ### `DastSiteValidationStrategyEnum` | Value | Description | | ----- | ----------- | -| `HEADER` | Header validation. | -| `TEXT_FILE` | Text file validation. | +| <a id="dastsitevalidationstrategyenumheader"></a>`HEADER` | Header validation. | +| <a id="dastsitevalidationstrategyenumtext_file"></a>`TEXT_FILE` | Text file validation. | ### `DastTargetTypeEnum` | Value | Description | | ----- | ----------- | -| `API` | API target. | -| `WEBSITE` | Website target. | +| <a id="dasttargettypeenumapi"></a>`API` | API target. | +| <a id="dasttargettypeenumwebsite"></a>`WEBSITE` | Website target. | ### `DataVisualizationColorEnum` @@ -7885,11 +13861,11 @@ Color of the data visualization palette. | Value | Description | | ----- | ----------- | -| `AQUA` | Aqua color. | -| `BLUE` | Blue color. | -| `GREEN` | Green color. | -| `MAGENTA` | Magenta color. | -| `ORANGE` | Orange color. | +| <a id="datavisualizationcolorenumaqua"></a>`AQUA` | Aqua color. | +| <a id="datavisualizationcolorenumblue"></a>`BLUE` | Blue color. | +| <a id="datavisualizationcolorenumgreen"></a>`GREEN` | Green color. | +| <a id="datavisualizationcolorenummagenta"></a>`MAGENTA` | Magenta color. | +| <a id="datavisualizationcolorenumorange"></a>`ORANGE` | Orange color. | ### `DataVisualizationWeightEnum` @@ -7897,17 +13873,17 @@ Weight of the data visualization palette. | Value | Description | | ----- | ----------- | -| `WEIGHT_100` | 100 weight. | -| `WEIGHT_200` | 200 weight. | -| `WEIGHT_300` | 300 weight. | -| `WEIGHT_400` | 400 weight. | -| `WEIGHT_50` | 50 weight. | -| `WEIGHT_500` | 500 weight. | -| `WEIGHT_600` | 600 weight. | -| `WEIGHT_700` | 700 weight. | -| `WEIGHT_800` | 800 weight. | -| `WEIGHT_900` | 900 weight. | -| `WEIGHT_950` | 950 weight. | +| <a id="datavisualizationweightenumweight_100"></a>`WEIGHT_100` | 100 weight. | +| <a id="datavisualizationweightenumweight_200"></a>`WEIGHT_200` | 200 weight. | +| <a id="datavisualizationweightenumweight_300"></a>`WEIGHT_300` | 300 weight. | +| <a id="datavisualizationweightenumweight_400"></a>`WEIGHT_400` | 400 weight. | +| <a id="datavisualizationweightenumweight_50"></a>`WEIGHT_50` | 50 weight. | +| <a id="datavisualizationweightenumweight_500"></a>`WEIGHT_500` | 500 weight. | +| <a id="datavisualizationweightenumweight_600"></a>`WEIGHT_600` | 600 weight. | +| <a id="datavisualizationweightenumweight_700"></a>`WEIGHT_700` | 700 weight. | +| <a id="datavisualizationweightenumweight_800"></a>`WEIGHT_800` | 800 weight. | +| <a id="datavisualizationweightenumweight_900"></a>`WEIGHT_900` | 900 weight. | +| <a id="datavisualizationweightenumweight_950"></a>`WEIGHT_950` | 950 weight. | ### `DesignCollectionCopyState` @@ -7915,9 +13891,9 @@ Copy state of a DesignCollection. | Value | Description | | ----- | ----------- | -| `ERROR` | The DesignCollection encountered an error during a copy. | -| `IN_PROGRESS` | The DesignCollection is being copied. | -| `READY` | The DesignCollection has no copy in progress. | +| <a id="designcollectioncopystateerror"></a>`ERROR` | The DesignCollection encountered an error during a copy. | +| <a id="designcollectioncopystatein_progress"></a>`IN_PROGRESS` | The DesignCollection is being copied. | +| <a id="designcollectioncopystateready"></a>`READY` | The DesignCollection has no copy in progress. | ### `DesignVersionEvent` @@ -7925,10 +13901,10 @@ Mutation event of a design within a version. | Value | Description | | ----- | ----------- | -| `CREATION` | A creation event. | -| `DELETION` | A deletion event. | -| `MODIFICATION` | A modification event. | -| `NONE` | No change. | +| <a id="designversioneventcreation"></a>`CREATION` | A creation event. | +| <a id="designversioneventdeletion"></a>`DELETION` | A deletion event. | +| <a id="designversioneventmodification"></a>`MODIFICATION` | A modification event. | +| <a id="designversioneventnone"></a>`NONE` | No change. | ### `DiffPositionType` @@ -7936,8 +13912,8 @@ Type of file the position refers to. | Value | Description | | ----- | ----------- | -| `image` | An image. | -| `text` | A text file. | +| <a id="diffpositiontypeimage"></a>`image` | An image. | +| <a id="diffpositiontypetext"></a>`text` | A text file. | ### `EntryType` @@ -7945,9 +13921,9 @@ Type of a tree entry. | Value | Description | | ----- | ----------- | -| `blob` | | -| `commit` | | -| `tree` | | +| <a id="entrytypeblob"></a>`blob` | File tree type. | +| <a id="entrytypecommit"></a>`commit` | Commit tree type. | +| <a id="entrytypetree"></a>`tree` | Directory tree type. | ### `EpicSort` @@ -7955,14 +13931,14 @@ Roadmap sort values. | Value | Description | | ----- | ----------- | -| `END_DATE_ASC` | Sort by end date in ascending order. | -| `END_DATE_DESC` | Sort by end date in descending order. | -| `START_DATE_ASC` | Sort by start date in ascending order. | -| `START_DATE_DESC` | Sort by start date in descending order. | -| `end_date_asc` **{warning-solid}** | **Deprecated:** Use END_DATE_ASC. Deprecated in 13.11. | -| `end_date_desc` **{warning-solid}** | **Deprecated:** Use END_DATE_DESC. Deprecated in 13.11. | -| `start_date_asc` **{warning-solid}** | **Deprecated:** Use START_DATE_ASC. Deprecated in 13.11. | -| `start_date_desc` **{warning-solid}** | **Deprecated:** Use START_DATE_DESC. Deprecated in 13.11. | +| <a id="epicsortend_date_asc"></a>`END_DATE_ASC` | Sort by end date in ascending order. | +| <a id="epicsortend_date_desc"></a>`END_DATE_DESC` | Sort by end date in descending order. | +| <a id="epicsortstart_date_asc"></a>`START_DATE_ASC` | Sort by start date in ascending order. | +| <a id="epicsortstart_date_desc"></a>`START_DATE_DESC` | Sort by start date in descending order. | +| <a id="epicsortend_date_asc"></a>`end_date_asc` **{warning-solid}** | **Deprecated:** Use END_DATE_ASC. Deprecated in 13.11. | +| <a id="epicsortend_date_desc"></a>`end_date_desc` **{warning-solid}** | **Deprecated:** Use END_DATE_DESC. Deprecated in 13.11. | +| <a id="epicsortstart_date_asc"></a>`start_date_asc` **{warning-solid}** | **Deprecated:** Use START_DATE_ASC. Deprecated in 13.11. | +| <a id="epicsortstart_date_desc"></a>`start_date_desc` **{warning-solid}** | **Deprecated:** Use START_DATE_DESC. Deprecated in 13.11. | ### `EpicState` @@ -7970,9 +13946,9 @@ State of an epic. | Value | Description | | ----- | ----------- | -| `all` | | -| `closed` | | -| `opened` | | +| <a id="epicstateall"></a>`all` | | +| <a id="epicstateclosed"></a>`closed` | | +| <a id="epicstateopened"></a>`opened` | | ### `EpicStateEvent` @@ -7980,8 +13956,8 @@ State event of an epic. | Value | Description | | ----- | ----------- | -| `CLOSE` | Close the epic. | -| `REOPEN` | Reopen the epic. | +| <a id="epicstateeventclose"></a>`CLOSE` | Close the epic. | +| <a id="epicstateeventreopen"></a>`REOPEN` | Reopen the epic. | ### `EpicWildcardId` @@ -7989,8 +13965,8 @@ Epic ID wildcard values. | Value | Description | | ----- | ----------- | -| `ANY` | Any epic is assigned. | -| `NONE` | No epic is assigned. | +| <a id="epicwildcardidany"></a>`ANY` | Any epic is assigned. | +| <a id="epicwildcardidnone"></a>`NONE` | No epic is assigned. | ### `EventAction` @@ -7998,19 +13974,19 @@ Event action. | Value | Description | | ----- | ----------- | -| `APPROVED` | Approved action. | -| `ARCHIVED` | Archived action. | -| `CLOSED` | Closed action. | -| `COMMENTED` | Commented action. | -| `CREATED` | Created action. | -| `DESTROYED` | Destroyed action. | -| `EXPIRED` | Expired action. | -| `JOINED` | Joined action. | -| `LEFT` | Left action. | -| `MERGED` | Merged action. | -| `PUSHED` | Pushed action. | -| `REOPENED` | Reopened action. | -| `UPDATED` | Updated action. | +| <a id="eventactionapproved"></a>`APPROVED` | Approved action. | +| <a id="eventactionarchived"></a>`ARCHIVED` | Archived action. | +| <a id="eventactionclosed"></a>`CLOSED` | Closed action. | +| <a id="eventactioncommented"></a>`COMMENTED` | Commented action. | +| <a id="eventactioncreated"></a>`CREATED` | Created action. | +| <a id="eventactiondestroyed"></a>`DESTROYED` | Destroyed action. | +| <a id="eventactionexpired"></a>`EXPIRED` | Expired action. | +| <a id="eventactionjoined"></a>`JOINED` | Joined action. | +| <a id="eventactionleft"></a>`LEFT` | Left action. | +| <a id="eventactionmerged"></a>`MERGED` | Merged action. | +| <a id="eventactionpushed"></a>`PUSHED` | Pushed action. | +| <a id="eventactionreopened"></a>`REOPENED` | Reopened action. | +| <a id="eventactionupdated"></a>`UPDATED` | Updated action. | ### `GroupMemberRelation` @@ -8018,9 +13994,9 @@ Group member relation. | Value | Description | | ----- | ----------- | -| `DESCENDANTS` | Descendants members. | -| `DIRECT` | Direct members. | -| `INHERITED` | Inherited members. | +| <a id="groupmemberrelationdescendants"></a>`DESCENDANTS` | Members in the group's subgroups. | +| <a id="groupmemberrelationdirect"></a>`DIRECT` | Members in the group itself. | +| <a id="groupmemberrelationinherited"></a>`INHERITED` | Members in the group's ancestor groups. | ### `HealthStatus` @@ -8028,9 +14004,9 @@ Health status of an issue or epic. | Value | Description | | ----- | ----------- | -| `atRisk` | | -| `needsAttention` | | -| `onTrack` | | +| <a id="healthstatusatrisk"></a>`atRisk` | | +| <a id="healthstatusneedsattention"></a>`needsAttention` | | +| <a id="healthstatusontrack"></a>`onTrack` | | ### `IssuableSeverity` @@ -8038,11 +14014,11 @@ Incident severity. | Value | Description | | ----- | ----------- | -| `CRITICAL` | Critical severity. | -| `HIGH` | High severity. | -| `LOW` | Low severity. | -| `MEDIUM` | Medium severity. | -| `UNKNOWN` | Unknown severity. | +| <a id="issuableseveritycritical"></a>`CRITICAL` | Critical severity. | +| <a id="issuableseverityhigh"></a>`HIGH` | High severity. | +| <a id="issuableseveritylow"></a>`LOW` | Low severity. | +| <a id="issuableseveritymedium"></a>`MEDIUM` | Medium severity. | +| <a id="issuableseverityunknown"></a>`UNKNOWN` | Unknown severity. | ### `IssuableState` @@ -8050,10 +14026,10 @@ State of a GitLab issue or merge request. | Value | Description | | ----- | ----------- | -| `all` | All available. | -| `closed` | In closed state. | -| `locked` | Discussion has been locked. | -| `opened` | In open state. | +| <a id="issuablestateall"></a>`all` | All available. | +| <a id="issuablestateclosed"></a>`closed` | In closed state. | +| <a id="issuablestatelocked"></a>`locked` | Discussion has been locked. | +| <a id="issuablestateopened"></a>`opened` | In open state. | ### `IssueSort` @@ -8061,31 +14037,31 @@ Values for sorting issues. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order. | -| `CREATED_DESC` | Created at descending order. | -| `DUE_DATE_ASC` | Due date by ascending order. | -| `DUE_DATE_DESC` | Due date by descending order. | -| `LABEL_PRIORITY_ASC` | Label priority by ascending order. | -| `LABEL_PRIORITY_DESC` | Label priority by descending order. | -| `MILESTONE_DUE_ASC` | Milestone due date by ascending order. | -| `MILESTONE_DUE_DESC` | Milestone due date by descending order. | -| `PRIORITY_ASC` | Priority by ascending order. | -| `PRIORITY_DESC` | Priority by descending order. | -| `PUBLISHED_ASC` | Published issues shown last. | -| `PUBLISHED_DESC` | Published issues shown first. | -| `RELATIVE_POSITION_ASC` | Relative position by ascending order. | -| `SEVERITY_ASC` | Severity from less critical to more critical. | -| `SEVERITY_DESC` | Severity from more critical to less critical. | -| `SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first. | -| `SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first. | -| `UPDATED_ASC` | Updated at ascending order. | -| `UPDATED_DESC` | Updated at descending order. | -| `WEIGHT_ASC` | Weight by ascending order. | -| `WEIGHT_DESC` | Weight by descending order. | -| `created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | -| `created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | -| `updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | -| `updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | +| <a id="issuesortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. | +| <a id="issuesortcreated_desc"></a>`CREATED_DESC` | Created at descending order. | +| <a id="issuesortdue_date_asc"></a>`DUE_DATE_ASC` | Due date by ascending order. | +| <a id="issuesortdue_date_desc"></a>`DUE_DATE_DESC` | Due date by descending order. | +| <a id="issuesortlabel_priority_asc"></a>`LABEL_PRIORITY_ASC` | Label priority by ascending order. | +| <a id="issuesortlabel_priority_desc"></a>`LABEL_PRIORITY_DESC` | Label priority by descending order. | +| <a id="issuesortmilestone_due_asc"></a>`MILESTONE_DUE_ASC` | Milestone due date by ascending order. | +| <a id="issuesortmilestone_due_desc"></a>`MILESTONE_DUE_DESC` | Milestone due date by descending order. | +| <a id="issuesortpriority_asc"></a>`PRIORITY_ASC` | Priority by ascending order. | +| <a id="issuesortpriority_desc"></a>`PRIORITY_DESC` | Priority by descending order. | +| <a id="issuesortpublished_asc"></a>`PUBLISHED_ASC` | Published issues shown last. | +| <a id="issuesortpublished_desc"></a>`PUBLISHED_DESC` | Published issues shown first. | +| <a id="issuesortrelative_position_asc"></a>`RELATIVE_POSITION_ASC` | Relative position by ascending order. | +| <a id="issuesortseverity_asc"></a>`SEVERITY_ASC` | Severity from less critical to more critical. | +| <a id="issuesortseverity_desc"></a>`SEVERITY_DESC` | Severity from more critical to less critical. | +| <a id="issuesortsla_due_at_asc"></a>`SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first. | +| <a id="issuesortsla_due_at_desc"></a>`SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first. | +| <a id="issuesortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. | +| <a id="issuesortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. | +| <a id="issuesortweight_asc"></a>`WEIGHT_ASC` | Weight by ascending order. | +| <a id="issuesortweight_desc"></a>`WEIGHT_DESC` | Weight by descending order. | +| <a id="issuesortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | +| <a id="issuesortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | +| <a id="issuesortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | +| <a id="issuesortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | ### `IssueState` @@ -8093,10 +14069,10 @@ State of a GitLab issue. | Value | Description | | ----- | ----------- | -| `all` | All available. | -| `closed` | In closed state. | -| `locked` | Discussion has been locked. | -| `opened` | In open state. | +| <a id="issuestateall"></a>`all` | All available. | +| <a id="issuestateclosed"></a>`closed` | In closed state. | +| <a id="issuestatelocked"></a>`locked` | Discussion has been locked. | +| <a id="issuestateopened"></a>`opened` | In open state. | ### `IssueStateEvent` @@ -8104,8 +14080,8 @@ Values for issue state events. | Value | Description | | ----- | ----------- | -| `CLOSE` | Closes the issue. | -| `REOPEN` | Reopens the issue. | +| <a id="issuestateeventclose"></a>`CLOSE` | Closes the issue. | +| <a id="issuestateeventreopen"></a>`REOPEN` | Reopens the issue. | ### `IssueType` @@ -8113,9 +14089,10 @@ Issue type. | Value | Description | | ----- | ----------- | -| `INCIDENT` | Incident issue type. | -| `ISSUE` | Issue issue type. | -| `TEST_CASE` | Test Case issue type. | +| <a id="issuetypeincident"></a>`INCIDENT` | Incident issue type. | +| <a id="issuetypeissue"></a>`ISSUE` | Issue issue type. | +| <a id="issuetyperequirement"></a>`REQUIREMENT` | Requirement issue type. | +| <a id="issuetypetest_case"></a>`TEST_CASE` | Test Case issue type. | ### `IterationState` @@ -8123,11 +14100,11 @@ State of a GitLab iteration. | Value | Description | | ----- | ----------- | -| `all` | | -| `closed` | | -| `opened` | | -| `started` | | -| `upcoming` | | +| <a id="iterationstateall"></a>`all` | | +| <a id="iterationstateclosed"></a>`closed` | | +| <a id="iterationstateopened"></a>`opened` | | +| <a id="iterationstatestarted"></a>`started` | | +| <a id="iterationstateupcoming"></a>`upcoming` | | ### `IterationWildcardId` @@ -8135,41 +14112,41 @@ Iteration ID wildcard values. | Value | Description | | ----- | ----------- | -| `ANY` | An iteration is assigned. | -| `CURRENT` | Current iteration. | -| `NONE` | No iteration is assigned. | +| <a id="iterationwildcardidany"></a>`ANY` | An iteration is assigned. | +| <a id="iterationwildcardidcurrent"></a>`CURRENT` | Current iteration. | +| <a id="iterationwildcardidnone"></a>`NONE` | No iteration is assigned. | ### `JobArtifactFileType` | Value | Description | | ----- | ----------- | -| `ACCESSIBILITY` | ACCESSIBILITY job artifact file type. | -| `API_FUZZING` | API FUZZING job artifact file type. | -| `ARCHIVE` | ARCHIVE job artifact file type. | -| `BROWSER_PERFORMANCE` | BROWSER PERFORMANCE job artifact file type. | -| `CLUSTER_APPLICATIONS` | CLUSTER APPLICATIONS job artifact file type. | -| `COBERTURA` | COBERTURA job artifact file type. | -| `CODEQUALITY` | CODE QUALITY job artifact file type. | -| `CONTAINER_SCANNING` | CONTAINER SCANNING job artifact file type. | -| `COVERAGE_FUZZING` | COVERAGE FUZZING job artifact file type. | -| `DAST` | DAST job artifact file type. | -| `DEPENDENCY_SCANNING` | DEPENDENCY SCANNING job artifact file type. | -| `DOTENV` | DOTENV job artifact file type. | -| `JUNIT` | JUNIT job artifact file type. | -| `LICENSE_MANAGEMENT` | LICENSE MANAGEMENT job artifact file type. | -| `LICENSE_SCANNING` | LICENSE SCANNING job artifact file type. | -| `LOAD_PERFORMANCE` | LOAD PERFORMANCE job artifact file type. | -| `LSIF` | LSIF job artifact file type. | -| `METADATA` | METADATA job artifact file type. | -| `METRICS` | METRICS job artifact file type. | -| `METRICS_REFEREE` | METRICS REFEREE job artifact file type. | -| `NETWORK_REFEREE` | NETWORK REFEREE job artifact file type. | -| `PERFORMANCE` | PERFORMANCE job artifact file type. | -| `REQUIREMENTS` | REQUIREMENTS job artifact file type. | -| `SAST` | SAST job artifact file type. | -| `SECRET_DETECTION` | SECRET DETECTION job artifact file type. | -| `TERRAFORM` | TERRAFORM job artifact file type. | -| `TRACE` | TRACE job artifact file type. | +| <a id="jobartifactfiletypeaccessibility"></a>`ACCESSIBILITY` | ACCESSIBILITY job artifact file type. | +| <a id="jobartifactfiletypeapi_fuzzing"></a>`API_FUZZING` | API FUZZING job artifact file type. | +| <a id="jobartifactfiletypearchive"></a>`ARCHIVE` | ARCHIVE job artifact file type. | +| <a id="jobartifactfiletypebrowser_performance"></a>`BROWSER_PERFORMANCE` | BROWSER PERFORMANCE job artifact file type. | +| <a id="jobartifactfiletypecluster_applications"></a>`CLUSTER_APPLICATIONS` | CLUSTER APPLICATIONS job artifact file type. | +| <a id="jobartifactfiletypecobertura"></a>`COBERTURA` | COBERTURA job artifact file type. | +| <a id="jobartifactfiletypecodequality"></a>`CODEQUALITY` | CODE QUALITY job artifact file type. | +| <a id="jobartifactfiletypecontainer_scanning"></a>`CONTAINER_SCANNING` | CONTAINER SCANNING job artifact file type. | +| <a id="jobartifactfiletypecoverage_fuzzing"></a>`COVERAGE_FUZZING` | COVERAGE FUZZING job artifact file type. | +| <a id="jobartifactfiletypedast"></a>`DAST` | DAST job artifact file type. | +| <a id="jobartifactfiletypedependency_scanning"></a>`DEPENDENCY_SCANNING` | DEPENDENCY SCANNING job artifact file type. | +| <a id="jobartifactfiletypedotenv"></a>`DOTENV` | DOTENV job artifact file type. | +| <a id="jobartifactfiletypejunit"></a>`JUNIT` | JUNIT job artifact file type. | +| <a id="jobartifactfiletypelicense_management"></a>`LICENSE_MANAGEMENT` | LICENSE MANAGEMENT job artifact file type. | +| <a id="jobartifactfiletypelicense_scanning"></a>`LICENSE_SCANNING` | LICENSE SCANNING job artifact file type. | +| <a id="jobartifactfiletypeload_performance"></a>`LOAD_PERFORMANCE` | LOAD PERFORMANCE job artifact file type. | +| <a id="jobartifactfiletypelsif"></a>`LSIF` | LSIF job artifact file type. | +| <a id="jobartifactfiletypemetadata"></a>`METADATA` | METADATA job artifact file type. | +| <a id="jobartifactfiletypemetrics"></a>`METRICS` | METRICS job artifact file type. | +| <a id="jobartifactfiletypemetrics_referee"></a>`METRICS_REFEREE` | METRICS REFEREE job artifact file type. | +| <a id="jobartifactfiletypenetwork_referee"></a>`NETWORK_REFEREE` | NETWORK REFEREE job artifact file type. | +| <a id="jobartifactfiletypeperformance"></a>`PERFORMANCE` | PERFORMANCE job artifact file type. | +| <a id="jobartifactfiletyperequirements"></a>`REQUIREMENTS` | REQUIREMENTS job artifact file type. | +| <a id="jobartifactfiletypesast"></a>`SAST` | SAST job artifact file type. | +| <a id="jobartifactfiletypesecret_detection"></a>`SECRET_DETECTION` | SECRET DETECTION job artifact file type. | +| <a id="jobartifactfiletypeterraform"></a>`TERRAFORM` | TERRAFORM job artifact file type. | +| <a id="jobartifactfiletypetrace"></a>`TRACE` | TRACE job artifact file type. | ### `ListLimitMetric` @@ -8177,9 +14154,9 @@ List limit metric setting. | Value | Description | | ----- | ----------- | -| `all_metrics` | | -| `issue_count` | | -| `issue_weights` | | +| <a id="listlimitmetricall_metrics"></a>`all_metrics` | | +| <a id="listlimitmetricissue_count"></a>`issue_count` | | +| <a id="listlimitmetricissue_weights"></a>`issue_weights` | | ### `MeasurementIdentifier` @@ -8187,16 +14164,16 @@ Possible identifier types for a measurement. | Value | Description | | ----- | ----------- | -| `GROUPS` | Group count. | -| `ISSUES` | Issue count. | -| `MERGE_REQUESTS` | Merge request count. | -| `PIPELINES` | Pipeline count. | -| `PIPELINES_CANCELED` | Pipeline count with canceled status. | -| `PIPELINES_FAILED` | Pipeline count with failed status. | -| `PIPELINES_SKIPPED` | Pipeline count with skipped status. | -| `PIPELINES_SUCCEEDED` | Pipeline count with success status. | -| `PROJECTS` | Project count. | -| `USERS` | User count. | +| <a id="measurementidentifiergroups"></a>`GROUPS` | Group count. | +| <a id="measurementidentifierissues"></a>`ISSUES` | Issue count. | +| <a id="measurementidentifiermerge_requests"></a>`MERGE_REQUESTS` | Merge request count. | +| <a id="measurementidentifierpipelines"></a>`PIPELINES` | Pipeline count. | +| <a id="measurementidentifierpipelines_canceled"></a>`PIPELINES_CANCELED` | Pipeline count with canceled status. | +| <a id="measurementidentifierpipelines_failed"></a>`PIPELINES_FAILED` | Pipeline count with failed status. | +| <a id="measurementidentifierpipelines_skipped"></a>`PIPELINES_SKIPPED` | Pipeline count with skipped status. | +| <a id="measurementidentifierpipelines_succeeded"></a>`PIPELINES_SUCCEEDED` | Pipeline count with success status. | +| <a id="measurementidentifierprojects"></a>`PROJECTS` | Project count. | +| <a id="measurementidentifierusers"></a>`USERS` | User count. | ### `MergeRequestNewState` @@ -8204,8 +14181,8 @@ New state to apply to a merge request. | Value | Description | | ----- | ----------- | -| `CLOSED` | Close the merge request if it is open. | -| `OPEN` | Open the merge request if it is closed. | +| <a id="mergerequestnewstateclosed"></a>`CLOSED` | Close the merge request if it is open. | +| <a id="mergerequestnewstateopen"></a>`OPEN` | Open the merge request if it is closed. | ### `MergeRequestReviewState` @@ -8213,8 +14190,8 @@ State of a review of a GitLab merge request. | Value | Description | | ----- | ----------- | -| `REVIEWED` | The merge request is reviewed. | -| `UNREVIEWED` | The merge request is unreviewed. | +| <a id="mergerequestreviewstatereviewed"></a>`REVIEWED` | The merge request is reviewed. | +| <a id="mergerequestreviewstateunreviewed"></a>`UNREVIEWED` | The merge request is unreviewed. | ### `MergeRequestSort` @@ -8222,22 +14199,22 @@ Values for sorting merge requests. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order. | -| `CREATED_DESC` | Created at descending order. | -| `LABEL_PRIORITY_ASC` | Label priority by ascending order. | -| `LABEL_PRIORITY_DESC` | Label priority by descending order. | -| `MERGED_AT_ASC` | Merge time by ascending order. | -| `MERGED_AT_DESC` | Merge time by descending order. | -| `MILESTONE_DUE_ASC` | Milestone due date by ascending order. | -| `MILESTONE_DUE_DESC` | Milestone due date by descending order. | -| `PRIORITY_ASC` | Priority by ascending order. | -| `PRIORITY_DESC` | Priority by descending order. | -| `UPDATED_ASC` | Updated at ascending order. | -| `UPDATED_DESC` | Updated at descending order. | -| `created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | -| `created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | -| `updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | -| `updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | +| <a id="mergerequestsortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. | +| <a id="mergerequestsortcreated_desc"></a>`CREATED_DESC` | Created at descending order. | +| <a id="mergerequestsortlabel_priority_asc"></a>`LABEL_PRIORITY_ASC` | Label priority by ascending order. | +| <a id="mergerequestsortlabel_priority_desc"></a>`LABEL_PRIORITY_DESC` | Label priority by descending order. | +| <a id="mergerequestsortmerged_at_asc"></a>`MERGED_AT_ASC` | Merge time by ascending order. | +| <a id="mergerequestsortmerged_at_desc"></a>`MERGED_AT_DESC` | Merge time by descending order. | +| <a id="mergerequestsortmilestone_due_asc"></a>`MILESTONE_DUE_ASC` | Milestone due date by ascending order. | +| <a id="mergerequestsortmilestone_due_desc"></a>`MILESTONE_DUE_DESC` | Milestone due date by descending order. | +| <a id="mergerequestsortpriority_asc"></a>`PRIORITY_ASC` | Priority by ascending order. | +| <a id="mergerequestsortpriority_desc"></a>`PRIORITY_DESC` | Priority by descending order. | +| <a id="mergerequestsortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. | +| <a id="mergerequestsortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. | +| <a id="mergerequestsortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | +| <a id="mergerequestsortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | +| <a id="mergerequestsortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | +| <a id="mergerequestsortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | ### `MergeRequestState` @@ -8245,19 +14222,19 @@ State of a GitLab merge request. | Value | Description | | ----- | ----------- | -| `all` | All available. | -| `closed` | In closed state. | -| `locked` | Discussion has been locked. | -| `merged` | Merge request has been merged. | -| `opened` | In open state. | +| <a id="mergerequeststateall"></a>`all` | All available. | +| <a id="mergerequeststateclosed"></a>`closed` | In closed state. | +| <a id="mergerequeststatelocked"></a>`locked` | Discussion has been locked. | +| <a id="mergerequeststatemerged"></a>`merged` | Merge request has been merged. | +| <a id="mergerequeststateopened"></a>`opened` | In open state. | ### `MergeStrategyEnum` | Value | Description | | ----- | ----------- | -| `ADD_TO_MERGE_TRAIN_WHEN_PIPELINE_SUCCEEDS` | Use the add_to_merge_train_when_pipeline_succeeds merge strategy. | -| `MERGE_TRAIN` | Use the merge_train merge strategy. | -| `MERGE_WHEN_PIPELINE_SUCCEEDS` | Use the merge_when_pipeline_succeeds merge strategy. | +| <a id="mergestrategyenumadd_to_merge_train_when_pipeline_succeeds"></a>`ADD_TO_MERGE_TRAIN_WHEN_PIPELINE_SUCCEEDS` | Use the add_to_merge_train_when_pipeline_succeeds merge strategy. | +| <a id="mergestrategyenummerge_train"></a>`MERGE_TRAIN` | Use the merge_train merge strategy. | +| <a id="mergestrategyenummerge_when_pipeline_succeeds"></a>`MERGE_WHEN_PIPELINE_SUCCEEDS` | Use the merge_when_pipeline_succeeds merge strategy. | ### `MilestoneStateEnum` @@ -8265,8 +14242,8 @@ Current state of milestone. | Value | Description | | ----- | ----------- | -| `active` | Milestone is currently active. | -| `closed` | Milestone is closed. | +| <a id="milestonestateenumactive"></a>`active` | Milestone is currently active. | +| <a id="milestonestateenumclosed"></a>`closed` | Milestone is closed. | ### `MoveType` @@ -8274,8 +14251,8 @@ The position to which the adjacent object should be moved. | Value | Description | | ----- | ----------- | -| `after` | The adjacent object will be moved after the object that is being moved. | -| `before` | The adjacent object will be moved before the object that is being moved. | +| <a id="movetypeafter"></a>`after` | The adjacent object will be moved after the object that is being moved. | +| <a id="movetypebefore"></a>`before` | The adjacent object will be moved before the object that is being moved. | ### `MutationOperationMode` @@ -8283,9 +14260,9 @@ Different toggles for changing mutator behavior. | Value | Description | | ----- | ----------- | -| `APPEND` | Performs an append operation. | -| `REMOVE` | Performs a removal operation. | -| `REPLACE` | Performs a replace operation. | +| <a id="mutationoperationmodeappend"></a>`APPEND` | Performs an append operation. | +| <a id="mutationoperationmoderemove"></a>`REMOVE` | Performs a removal operation. | +| <a id="mutationoperationmodereplace"></a>`REPLACE` | Performs a replace operation. | ### `NamespaceProjectSort` @@ -8293,8 +14270,8 @@ Values for sorting projects. | Value | Description | | ----- | ----------- | -| `SIMILARITY` | Most similar to the search query. | -| `STORAGE` | Sort by storage size. | +| <a id="namespaceprojectsortsimilarity"></a>`SIMILARITY` | Most similar to the search query. | +| <a id="namespaceprojectsortstorage"></a>`STORAGE` | Sort by storage size. | ### `NegatedIterationWildcardId` @@ -8302,7 +14279,7 @@ Negated Iteration ID wildcard values. | Value | Description | | ----- | ----------- | -| `CURRENT` | Current iteration. | +| <a id="negatediterationwildcardidcurrent"></a>`CURRENT` | Current iteration. | ### `OncallRotationUnitEnum` @@ -8310,54 +14287,95 @@ Rotation length unit of an on-call rotation. | Value | Description | | ----- | ----------- | -| `DAYS` | Days. | -| `HOURS` | Hours. | -| `WEEKS` | Weeks. | +| <a id="oncallrotationunitenumdays"></a>`DAYS` | Days. | +| <a id="oncallrotationunitenumhours"></a>`HOURS` | Hours. | +| <a id="oncallrotationunitenumweeks"></a>`WEEKS` | Weeks. | + +### `PackageGroupSort` + +Values for sorting group packages. + +| Value | Description | +| ----- | ----------- | +| <a id="packagegroupsortcreated_asc"></a>`CREATED_ASC` | Ordered by created_at in ascending order. | +| <a id="packagegroupsortcreated_desc"></a>`CREATED_DESC` | Ordered by created_at in descending order. | +| <a id="packagegroupsortname_asc"></a>`NAME_ASC` | Ordered by name in ascending order. | +| <a id="packagegroupsortname_desc"></a>`NAME_DESC` | Ordered by name in descending order. | +| <a id="packagegroupsorttype_asc"></a>`TYPE_ASC` | Ordered by type in ascending order. | +| <a id="packagegroupsorttype_desc"></a>`TYPE_DESC` | Ordered by type in descending order. | +| <a id="packagegroupsortversion_asc"></a>`VERSION_ASC` | Ordered by version in ascending order. | +| <a id="packagegroupsortversion_desc"></a>`VERSION_DESC` | Ordered by version in descending order. | + +### `PackageSort` + +Values for sorting package. + +| Value | Description | +| ----- | ----------- | +| <a id="packagesortcreated_asc"></a>`CREATED_ASC` | Ordered by created_at in ascending order. | +| <a id="packagesortcreated_desc"></a>`CREATED_DESC` | Ordered by created_at in descending order. | +| <a id="packagesortname_asc"></a>`NAME_ASC` | Ordered by name in ascending order. | +| <a id="packagesortname_desc"></a>`NAME_DESC` | Ordered by name in descending order. | +| <a id="packagesorttype_asc"></a>`TYPE_ASC` | Ordered by type in ascending order. | +| <a id="packagesorttype_desc"></a>`TYPE_DESC` | Ordered by type in descending order. | +| <a id="packagesortversion_asc"></a>`VERSION_ASC` | Ordered by version in ascending order. | +| <a id="packagesortversion_desc"></a>`VERSION_DESC` | Ordered by version in descending order. | + +### `PackageStatus` + +| Value | Description | +| ----- | ----------- | +| <a id="packagestatusdefault"></a>`DEFAULT` | Packages with a default status. | +| <a id="packagestatuserror"></a>`ERROR` | Packages with a error status. | +| <a id="packagestatushidden"></a>`HIDDEN` | Packages with a hidden status. | +| <a id="packagestatusprocessing"></a>`PROCESSING` | Packages with a processing status. | ### `PackageTypeEnum` | Value | Description | | ----- | ----------- | -| `COMPOSER` | Packages from the Composer package manager. | -| `CONAN` | Packages from the Conan package manager. | -| `DEBIAN` | Packages from the Debian package manager. | -| `GENERIC` | Packages from the Generic package manager. | -| `GOLANG` | Packages from the Golang package manager. | -| `MAVEN` | Packages from the Maven package manager. | -| `NPM` | Packages from the npm package manager. | -| `NUGET` | Packages from the Nuget package manager. | -| `PYPI` | Packages from the PyPI package manager. | -| `RUBYGEMS` | Packages from the Rubygems package manager. | +| <a id="packagetypeenumcomposer"></a>`COMPOSER` | Packages from the Composer package manager. | +| <a id="packagetypeenumconan"></a>`CONAN` | Packages from the Conan package manager. | +| <a id="packagetypeenumdebian"></a>`DEBIAN` | Packages from the Debian package manager. | +| <a id="packagetypeenumgeneric"></a>`GENERIC` | Packages from the Generic package manager. | +| <a id="packagetypeenumgolang"></a>`GOLANG` | Packages from the Golang package manager. | +| <a id="packagetypeenumhelm"></a>`HELM` | Packages from the Helm package manager. | +| <a id="packagetypeenummaven"></a>`MAVEN` | Packages from the Maven package manager. | +| <a id="packagetypeenumnpm"></a>`NPM` | Packages from the npm package manager. | +| <a id="packagetypeenumnuget"></a>`NUGET` | Packages from the Nuget package manager. | +| <a id="packagetypeenumpypi"></a>`PYPI` | Packages from the PyPI package manager. | +| <a id="packagetypeenumrubygems"></a>`RUBYGEMS` | Packages from the Rubygems package manager. | +| <a id="packagetypeenumterraform_module"></a>`TERRAFORM_MODULE` | Packages from the Terraform Module package manager. | ### `PipelineConfigSourceEnum` | Value | Description | | ----- | ----------- | -| `AUTO_DEVOPS_SOURCE` | Auto DevOps source. | -| `BRIDGE_SOURCE` | Bridge source. | -| `COMPLIANCE_SOURCE` | Compliance source. | -| `EXTERNAL_PROJECT_SOURCE` | External project source. | -| `PARAMETER_SOURCE` | Parameter source. | -| `REMOTE_SOURCE` | Remote source. | -| `REPOSITORY_SOURCE` | Repository source. | -| `UNKNOWN_SOURCE` | Unknown source. | -| `WEBIDE_SOURCE` | Webide source. | +| <a id="pipelineconfigsourceenumauto_devops_source"></a>`AUTO_DEVOPS_SOURCE` | Auto DevOps source. | +| <a id="pipelineconfigsourceenumbridge_source"></a>`BRIDGE_SOURCE` | Bridge source. | +| <a id="pipelineconfigsourceenumcompliance_source"></a>`COMPLIANCE_SOURCE` | Compliance source. | +| <a id="pipelineconfigsourceenumexternal_project_source"></a>`EXTERNAL_PROJECT_SOURCE` | External project source. | +| <a id="pipelineconfigsourceenumparameter_source"></a>`PARAMETER_SOURCE` | Parameter source. | +| <a id="pipelineconfigsourceenumremote_source"></a>`REMOTE_SOURCE` | Remote source. | +| <a id="pipelineconfigsourceenumrepository_source"></a>`REPOSITORY_SOURCE` | Repository source. | +| <a id="pipelineconfigsourceenumunknown_source"></a>`UNKNOWN_SOURCE` | Unknown source. | +| <a id="pipelineconfigsourceenumwebide_source"></a>`WEBIDE_SOURCE` | Webide source. | ### `PipelineStatusEnum` | Value | Description | | ----- | ----------- | -| `CANCELED` | Pipeline was canceled before completion. | -| `CREATED` | Pipeline has been created. | -| `FAILED` | At least one stage of the pipeline failed. | -| `MANUAL` | Pipeline needs to be manually started. | -| `PENDING` | Pipeline has not started running yet. | -| `PREPARING` | Pipeline is preparing to run. | -| `RUNNING` | Pipeline is running. | -| `SCHEDULED` | Pipeline is scheduled to run. | -| `SKIPPED` | Pipeline was skipped. | -| `SUCCESS` | Pipeline completed successfully. | -| `WAITING_FOR_RESOURCE` | A resource (for example, a runner) that the pipeline requires to run is unavailable. | +| <a id="pipelinestatusenumcanceled"></a>`CANCELED` | Pipeline was canceled before completion. | +| <a id="pipelinestatusenumcreated"></a>`CREATED` | Pipeline has been created. | +| <a id="pipelinestatusenumfailed"></a>`FAILED` | At least one stage of the pipeline failed. | +| <a id="pipelinestatusenummanual"></a>`MANUAL` | Pipeline needs to be manually started. | +| <a id="pipelinestatusenumpending"></a>`PENDING` | Pipeline has not started running yet. | +| <a id="pipelinestatusenumpreparing"></a>`PREPARING` | Pipeline is preparing to run. | +| <a id="pipelinestatusenumrunning"></a>`RUNNING` | Pipeline is running. | +| <a id="pipelinestatusenumscheduled"></a>`SCHEDULED` | Pipeline is scheduled to run. | +| <a id="pipelinestatusenumskipped"></a>`SKIPPED` | Pipeline was skipped. | +| <a id="pipelinestatusenumsuccess"></a>`SUCCESS` | Pipeline completed successfully. | +| <a id="pipelinestatusenumwaiting_for_resource"></a>`WAITING_FOR_RESOURCE` | A resource (for example, a runner) that the pipeline requires to run is unavailable. | ### `ProjectMemberRelation` @@ -8365,10 +14383,10 @@ Project member relation. | Value | Description | | ----- | ----------- | -| `DESCENDANTS` | Descendants members. | -| `DIRECT` | Direct members. | -| `INHERITED` | Inherited members. | -| `INVITED_GROUPS` | Invited Groups members. | +| <a id="projectmemberrelationdescendants"></a>`DESCENDANTS` | Descendants members. | +| <a id="projectmemberrelationdirect"></a>`DIRECT` | Direct members. | +| <a id="projectmemberrelationinherited"></a>`INHERITED` | Inherited members. | +| <a id="projectmemberrelationinvited_groups"></a>`INVITED_GROUPS` | Invited Groups members. | ### `RegistryState` @@ -8376,10 +14394,10 @@ State of a Geo registry. | Value | Description | | ----- | ----------- | -| `FAILED` | Registry that failed to sync. | -| `PENDING` | Registry waiting to be synced. | -| `STARTED` | Registry currently syncing. | -| `SYNCED` | Registry that is synced. | +| <a id="registrystatefailed"></a>`FAILED` | Registry that failed to sync. | +| <a id="registrystatepending"></a>`PENDING` | Registry waiting to be synced. | +| <a id="registrystatestarted"></a>`STARTED` | Registry currently syncing. | +| <a id="registrystatesynced"></a>`SYNCED` | Registry that is synced. | ### `ReleaseAssetLinkType` @@ -8387,10 +14405,10 @@ Type of the link: `other`, `runbook`, `image`, `package`. | Value | Description | | ----- | ----------- | -| `IMAGE` | Image link type. | -| `OTHER` | Other link type. | -| `PACKAGE` | Package link type. | -| `RUNBOOK` | Runbook link type. | +| <a id="releaseassetlinktypeimage"></a>`IMAGE` | Image link type. | +| <a id="releaseassetlinktypeother"></a>`OTHER` | Other link type. | +| <a id="releaseassetlinktypepackage"></a>`PACKAGE` | Package link type. | +| <a id="releaseassetlinktyperunbook"></a>`RUNBOOK` | Runbook link type. | ### `ReleaseSort` @@ -8398,10 +14416,10 @@ Values for sorting releases. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order. | -| `CREATED_DESC` | Created at descending order. | -| `RELEASED_AT_ASC` | Released at by ascending order. | -| `RELEASED_AT_DESC` | Released at by descending order. | +| <a id="releasesortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. | +| <a id="releasesortcreated_desc"></a>`CREATED_DESC` | Created at descending order. | +| <a id="releasesortreleased_at_asc"></a>`RELEASED_AT_ASC` | Released at by ascending order. | +| <a id="releasesortreleased_at_desc"></a>`RELEASED_AT_DESC` | Released at by descending order. | ### `RequirementState` @@ -8409,8 +14427,8 @@ State of a requirement. | Value | Description | | ----- | ----------- | -| `ARCHIVED` | | -| `OPENED` | | +| <a id="requirementstatearchived"></a>`ARCHIVED` | | +| <a id="requirementstateopened"></a>`OPENED` | | ### `RequirementStatusFilter` @@ -8418,9 +14436,9 @@ Status of a requirement based on last test report. | Value | Description | | ----- | ----------- | -| `FAILED` | | -| `MISSING` | Requirements without any test report. | -| `PASSED` | | +| <a id="requirementstatusfilterfailed"></a>`FAILED` | | +| <a id="requirementstatusfiltermissing"></a>`MISSING` | Requirements without any test report. | +| <a id="requirementstatusfilterpassed"></a>`PASSED` | | ### `SastUiComponentSize` @@ -8428,21 +14446,21 @@ Size of UI component in SAST configuration page. | Value | Description | | ----- | ----------- | -| `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. | +| <a id="sastuicomponentsizelarge"></a>`LARGE` | The size of UI component in SAST configuration page is large. | +| <a id="sastuicomponentsizemedium"></a>`MEDIUM` | The size of UI component in SAST configuration page is medium. | +| <a id="sastuicomponentsizesmall"></a>`SMALL` | The size of UI component in SAST configuration page is small. | ### `SecurityReportTypeEnum` | Value | Description | | ----- | ----------- | -| `API_FUZZING` | API FUZZING scan report. | -| `CONTAINER_SCANNING` | CONTAINER SCANNING scan report. | -| `COVERAGE_FUZZING` | COVERAGE FUZZING scan report. | -| `DAST` | DAST scan report. | -| `DEPENDENCY_SCANNING` | DEPENDENCY SCANNING scan report. | -| `SAST` | SAST scan report. | -| `SECRET_DETECTION` | SECRET DETECTION scan report. | +| <a id="securityreporttypeenumapi_fuzzing"></a>`API_FUZZING` | API FUZZING scan report. | +| <a id="securityreporttypeenumcontainer_scanning"></a>`CONTAINER_SCANNING` | CONTAINER SCANNING scan report. | +| <a id="securityreporttypeenumcoverage_fuzzing"></a>`COVERAGE_FUZZING` | COVERAGE FUZZING scan report. | +| <a id="securityreporttypeenumdast"></a>`DAST` | DAST scan report. | +| <a id="securityreporttypeenumdependency_scanning"></a>`DEPENDENCY_SCANNING` | DEPENDENCY SCANNING scan report. | +| <a id="securityreporttypeenumsast"></a>`SAST` | SAST scan report. | +| <a id="securityreporttypeenumsecret_detection"></a>`SECRET_DETECTION` | SECRET DETECTION scan report. | ### `SecurityScannerType` @@ -8450,13 +14468,13 @@ The type of the security scanner. | Value | Description | | ----- | ----------- | -| `API_FUZZING` | | -| `CONTAINER_SCANNING` | | -| `COVERAGE_FUZZING` | | -| `DAST` | | -| `DEPENDENCY_SCANNING` | | -| `SAST` | | -| `SECRET_DETECTION` | | +| <a id="securityscannertypeapi_fuzzing"></a>`API_FUZZING` | | +| <a id="securityscannertypecontainer_scanning"></a>`CONTAINER_SCANNING` | | +| <a id="securityscannertypecoverage_fuzzing"></a>`COVERAGE_FUZZING` | | +| <a id="securityscannertypedast"></a>`DAST` | | +| <a id="securityscannertypedependency_scanning"></a>`DEPENDENCY_SCANNING` | | +| <a id="securityscannertypesast"></a>`SAST` | | +| <a id="securityscannertypesecret_detection"></a>`SECRET_DETECTION` | | ### `SentryErrorStatus` @@ -8464,50 +14482,50 @@ State of a Sentry error. | Value | Description | | ----- | ----------- | -| `IGNORED` | Error has been ignored. | -| `RESOLVED` | Error has been resolved. | -| `RESOLVED_IN_NEXT_RELEASE` | Error has been ignored until next release. | -| `UNRESOLVED` | Error is unresolved. | +| <a id="sentryerrorstatusignored"></a>`IGNORED` | Error has been ignored. | +| <a id="sentryerrorstatusresolved"></a>`RESOLVED` | Error has been resolved. | +| <a id="sentryerrorstatusresolved_in_next_release"></a>`RESOLVED_IN_NEXT_RELEASE` | Error has been ignored until next release. | +| <a id="sentryerrorstatusunresolved"></a>`UNRESOLVED` | Error is unresolved. | ### `ServiceType` | Value | Description | | ----- | ----------- | -| `ASANA_SERVICE` | AsanaService type. | -| `ASSEMBLA_SERVICE` | AssemblaService type. | -| `BAMBOO_SERVICE` | BambooService type. | -| `BUGZILLA_SERVICE` | BugzillaService type. | -| `BUILDKITE_SERVICE` | BuildkiteService type. | -| `CAMPFIRE_SERVICE` | CampfireService type. | -| `CONFLUENCE_SERVICE` | ConfluenceService type. | -| `CUSTOM_ISSUE_TRACKER_SERVICE` | CustomIssueTrackerService type. | -| `DATADOG_SERVICE` | DatadogService type. | -| `DISCORD_SERVICE` | DiscordService type. | -| `DRONE_CI_SERVICE` | DroneCiService type. | -| `EMAILS_ON_PUSH_SERVICE` | EmailsOnPushService type. | -| `EWM_SERVICE` | EwmService type. | -| `EXTERNAL_WIKI_SERVICE` | ExternalWikiService type. | -| `FLOWDOCK_SERVICE` | FlowdockService type. | -| `GITHUB_SERVICE` | GithubService type. | -| `HANGOUTS_CHAT_SERVICE` | HangoutsChatService type. | -| `IRKER_SERVICE` | IrkerService type. | -| `JENKINS_SERVICE` | JenkinsService type. | -| `JIRA_SERVICE` | JiraService type. | -| `MATTERMOST_SERVICE` | MattermostService type. | -| `MATTERMOST_SLASH_COMMANDS_SERVICE` | MattermostSlashCommandsService type. | -| `MICROSOFT_TEAMS_SERVICE` | MicrosoftTeamsService type. | -| `PACKAGIST_SERVICE` | PackagistService type. | -| `PIPELINES_EMAIL_SERVICE` | PipelinesEmailService type. | -| `PIVOTALTRACKER_SERVICE` | PivotaltrackerService type. | -| `PROMETHEUS_SERVICE` | PrometheusService type. | -| `PUSHOVER_SERVICE` | PushoverService type. | -| `REDMINE_SERVICE` | RedmineService type. | -| `SLACK_SERVICE` | SlackService type. | -| `SLACK_SLASH_COMMANDS_SERVICE` | SlackSlashCommandsService type. | -| `TEAMCITY_SERVICE` | TeamcityService type. | -| `UNIFY_CIRCUIT_SERVICE` | UnifyCircuitService type. | -| `WEBEX_TEAMS_SERVICE` | WebexTeamsService type. | -| `YOUTRACK_SERVICE` | YoutrackService type. | +| <a id="servicetypeasana_service"></a>`ASANA_SERVICE` | AsanaService type. | +| <a id="servicetypeassembla_service"></a>`ASSEMBLA_SERVICE` | AssemblaService type. | +| <a id="servicetypebamboo_service"></a>`BAMBOO_SERVICE` | BambooService type. | +| <a id="servicetypebugzilla_service"></a>`BUGZILLA_SERVICE` | BugzillaService type. | +| <a id="servicetypebuildkite_service"></a>`BUILDKITE_SERVICE` | BuildkiteService type. | +| <a id="servicetypecampfire_service"></a>`CAMPFIRE_SERVICE` | CampfireService type. | +| <a id="servicetypeconfluence_service"></a>`CONFLUENCE_SERVICE` | ConfluenceService type. | +| <a id="servicetypecustom_issue_tracker_service"></a>`CUSTOM_ISSUE_TRACKER_SERVICE` | CustomIssueTrackerService type. | +| <a id="servicetypedatadog_service"></a>`DATADOG_SERVICE` | DatadogService type. | +| <a id="servicetypediscord_service"></a>`DISCORD_SERVICE` | DiscordService type. | +| <a id="servicetypedrone_ci_service"></a>`DRONE_CI_SERVICE` | DroneCiService type. | +| <a id="servicetypeemails_on_push_service"></a>`EMAILS_ON_PUSH_SERVICE` | EmailsOnPushService type. | +| <a id="servicetypeewm_service"></a>`EWM_SERVICE` | EwmService type. | +| <a id="servicetypeexternal_wiki_service"></a>`EXTERNAL_WIKI_SERVICE` | ExternalWikiService type. | +| <a id="servicetypeflowdock_service"></a>`FLOWDOCK_SERVICE` | FlowdockService type. | +| <a id="servicetypegithub_service"></a>`GITHUB_SERVICE` | GithubService type. | +| <a id="servicetypehangouts_chat_service"></a>`HANGOUTS_CHAT_SERVICE` | HangoutsChatService type. | +| <a id="servicetypeirker_service"></a>`IRKER_SERVICE` | IrkerService type. | +| <a id="servicetypejenkins_service"></a>`JENKINS_SERVICE` | JenkinsService type. | +| <a id="servicetypejira_service"></a>`JIRA_SERVICE` | JiraService type. | +| <a id="servicetypemattermost_service"></a>`MATTERMOST_SERVICE` | MattermostService type. | +| <a id="servicetypemattermost_slash_commands_service"></a>`MATTERMOST_SLASH_COMMANDS_SERVICE` | MattermostSlashCommandsService type. | +| <a id="servicetypemicrosoft_teams_service"></a>`MICROSOFT_TEAMS_SERVICE` | MicrosoftTeamsService type. | +| <a id="servicetypepackagist_service"></a>`PACKAGIST_SERVICE` | PackagistService type. | +| <a id="servicetypepipelines_email_service"></a>`PIPELINES_EMAIL_SERVICE` | PipelinesEmailService type. | +| <a id="servicetypepivotaltracker_service"></a>`PIVOTALTRACKER_SERVICE` | PivotaltrackerService type. | +| <a id="servicetypeprometheus_service"></a>`PROMETHEUS_SERVICE` | PrometheusService type. | +| <a id="servicetypepushover_service"></a>`PUSHOVER_SERVICE` | PushoverService type. | +| <a id="servicetyperedmine_service"></a>`REDMINE_SERVICE` | RedmineService type. | +| <a id="servicetypeslack_service"></a>`SLACK_SERVICE` | SlackService type. | +| <a id="servicetypeslack_slash_commands_service"></a>`SLACK_SLASH_COMMANDS_SERVICE` | SlackSlashCommandsService type. | +| <a id="servicetypeteamcity_service"></a>`TEAMCITY_SERVICE` | TeamcityService type. | +| <a id="servicetypeunify_circuit_service"></a>`UNIFY_CIRCUIT_SERVICE` | UnifyCircuitService type. | +| <a id="servicetypewebex_teams_service"></a>`WEBEX_TEAMS_SERVICE` | WebexTeamsService type. | +| <a id="servicetypeyoutrack_service"></a>`YOUTRACK_SERVICE` | YoutrackService type. | ### `SnippetBlobActionEnum` @@ -8515,10 +14533,10 @@ Type of a snippet blob input action. | Value | Description | | ----- | ----------- | -| `create` | | -| `delete` | | -| `move` | | -| `update` | | +| <a id="snippetblobactionenumcreate"></a>`create` | | +| <a id="snippetblobactionenumdelete"></a>`delete` | | +| <a id="snippetblobactionenummove"></a>`move` | | +| <a id="snippetblobactionenumupdate"></a>`update` | | ### `Sort` @@ -8526,23 +14544,23 @@ Common sort values. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order. | -| `CREATED_DESC` | Created at descending order. | -| `UPDATED_ASC` | Updated at ascending order. | -| `UPDATED_DESC` | Updated at descending order. | -| `created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | -| `created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | -| `updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | -| `updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | +| <a id="sortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. | +| <a id="sortcreated_desc"></a>`CREATED_DESC` | Created at descending order. | +| <a id="sortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. | +| <a id="sortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. | +| <a id="sortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_ASC`. Deprecated in 13.5. | +| <a id="sortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `CREATED_DESC`. Deprecated in 13.5. | +| <a id="sortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_ASC`. Deprecated in 13.5. | +| <a id="sortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated:** This was renamed. Please use `UPDATED_DESC`. Deprecated in 13.5. | ### `TestCaseStatus` | Value | Description | | ----- | ----------- | -| `error` | Test case that has a status of error. | -| `failed` | Test case that has a status of failed. | -| `skipped` | Test case that has a status of skipped. | -| `success` | Test case that has a status of success. | +| <a id="testcasestatuserror"></a>`error` | Test case that has a status of error. | +| <a id="testcasestatusfailed"></a>`failed` | Test case that has a status of failed. | +| <a id="testcasestatusskipped"></a>`skipped` | Test case that has a status of skipped. | +| <a id="testcasestatussuccess"></a>`success` | Test case that has a status of success. | ### `TestReportState` @@ -8550,47 +14568,47 @@ State of a test report. | Value | Description | | ----- | ----------- | -| `FAILED` | | -| `PASSED` | | +| <a id="testreportstatefailed"></a>`FAILED` | | +| <a id="testreportstatepassed"></a>`PASSED` | | ### `TodoActionEnum` | Value | Description | | ----- | ----------- | -| `approval_required` | User was set as an approver. | -| `assigned` | User was assigned. | -| `build_failed` | Build triggered by the user failed. | -| `directly_addressed` | User was directly addressed. | -| `marked` | User added a TODO. | -| `mentioned` | User was mentioned. | -| `merge_train_removed` | Merge request authored by the user was removed from the merge train. | -| `review_requested` | Review was requested from the user. | -| `unmergeable` | Merge request authored by the user could not be merged. | +| <a id="todoactionenumapproval_required"></a>`approval_required` | User was set as an approver. | +| <a id="todoactionenumassigned"></a>`assigned` | User was assigned. | +| <a id="todoactionenumbuild_failed"></a>`build_failed` | Build triggered by the user failed. | +| <a id="todoactionenumdirectly_addressed"></a>`directly_addressed` | User was directly addressed. | +| <a id="todoactionenummarked"></a>`marked` | User added a TODO. | +| <a id="todoactionenummentioned"></a>`mentioned` | User was mentioned. | +| <a id="todoactionenummerge_train_removed"></a>`merge_train_removed` | Merge request authored by the user was removed from the merge train. | +| <a id="todoactionenumreview_requested"></a>`review_requested` | Review was requested from the user. | +| <a id="todoactionenumunmergeable"></a>`unmergeable` | Merge request authored by the user could not be merged. | ### `TodoStateEnum` | Value | Description | | ----- | ----------- | -| `done` | The state of the todo is done. | -| `pending` | The state of the todo is pending. | +| <a id="todostateenumdone"></a>`done` | The state of the todo is done. | +| <a id="todostateenumpending"></a>`pending` | The state of the todo is pending. | ### `TodoTargetEnum` | Value | Description | | ----- | ----------- | -| `ALERT` | An Alert. | -| `COMMIT` | A Commit. | -| `DESIGN` | A Design. | -| `EPIC` | An Epic. | -| `ISSUE` | An Issue. | -| `MERGEREQUEST` | A MergeRequest. | +| <a id="todotargetenumalert"></a>`ALERT` | An Alert. | +| <a id="todotargetenumcommit"></a>`COMMIT` | A Commit. | +| <a id="todotargetenumdesign"></a>`DESIGN` | A Design. | +| <a id="todotargetenumepic"></a>`EPIC` | An Epic. | +| <a id="todotargetenumissue"></a>`ISSUE` | An Issue. | +| <a id="todotargetenummergerequest"></a>`MERGEREQUEST` | A MergeRequest. | ### `TypeEnum` | Value | Description | | ----- | ----------- | -| `personal` | | -| `project` | | +| <a id="typeenumpersonal"></a>`personal` | Snippet created independent of any project. | +| <a id="typeenumproject"></a>`project` | Snippet related to a specific project. | ### `UserCalloutFeatureNameEnum` @@ -8598,33 +14616,35 @@ Name of the feature that the callout is for. | Value | Description | | ----- | ----------- | -| `ACCOUNT_RECOVERY_REGULAR_CHECK` | Callout feature name for account_recovery_regular_check. | -| `ACTIVE_USER_COUNT_THRESHOLD` | Callout feature name for active_user_count_threshold. | -| `ADMIN_INTEGRATIONS_MOVED` | Callout feature name for admin_integrations_moved. | -| `BUY_PIPELINE_MINUTES_NOTIFICATION_DOT` | Callout feature name for buy_pipeline_minutes_notification_dot. | -| `CANARY_DEPLOYMENT` | Callout feature name for canary_deployment. | -| `CLUSTER_SECURITY_WARNING` | Callout feature name for cluster_security_warning. | -| `CUSTOMIZE_HOMEPAGE` | Callout feature name for customize_homepage. | -| `EOA_BRONZE_PLAN_BANNER` | Callout feature name for eoa_bronze_plan_banner. | -| `FEATURE_FLAGS_NEW_VERSION` | Callout feature name for feature_flags_new_version. | -| `GCP_SIGNUP_OFFER` | Callout feature name for gcp_signup_offer. | -| `GEO_ENABLE_HASHED_STORAGE` | Callout feature name for geo_enable_hashed_storage. | -| `GEO_MIGRATE_HASHED_STORAGE` | Callout feature name for geo_migrate_hashed_storage. | -| `GKE_CLUSTER_INTEGRATION` | Callout feature name for gke_cluster_integration. | -| `GOLD_TRIAL_BILLINGS` | Callout feature name for gold_trial_billings. | -| `NEW_USER_SIGNUPS_CAP_REACHED` | Callout feature name for new_user_signups_cap_reached. | -| `PERSONAL_ACCESS_TOKEN_EXPIRY` | Callout feature name for personal_access_token_expiry. | -| `PIPELINE_NEEDS_BANNER` | Callout feature name for pipeline_needs_banner. | -| `REGISTRATION_ENABLED_CALLOUT` | Callout feature name for registration_enabled_callout. | -| `SERVICE_TEMPLATES_DEPRECATED_CALLOUT` | Callout feature name for service_templates_deprecated_callout. | -| `SUGGEST_PIPELINE` | Callout feature name for suggest_pipeline. | -| `SUGGEST_POPOVER_DISMISSED` | Callout feature name for suggest_popover_dismissed. | -| `TABS_POSITION_HIGHLIGHT` | Callout feature name for tabs_position_highlight. | -| `THREAT_MONITORING_INFO` | Callout feature name for threat_monitoring_info. | -| `ULTIMATE_TRIAL` | Callout feature name for ultimate_trial. | -| `UNFINISHED_TAG_CLEANUP_CALLOUT` | Callout feature name for unfinished_tag_cleanup_callout. | -| `WEBHOOKS_MOVED` | Callout feature name for webhooks_moved. | -| `WEB_IDE_ALERT_DISMISSED` | Callout feature name for web_ide_alert_dismissed. | +| <a id="usercalloutfeaturenameenumaccount_recovery_regular_check"></a>`ACCOUNT_RECOVERY_REGULAR_CHECK` | Callout feature name for account_recovery_regular_check. | +| <a id="usercalloutfeaturenameenumactive_user_count_threshold"></a>`ACTIVE_USER_COUNT_THRESHOLD` | Callout feature name for active_user_count_threshold. | +| <a id="usercalloutfeaturenameenumadmin_integrations_moved"></a>`ADMIN_INTEGRATIONS_MOVED` | Callout feature name for admin_integrations_moved. | +| <a id="usercalloutfeaturenameenumbuy_pipeline_minutes_notification_dot"></a>`BUY_PIPELINE_MINUTES_NOTIFICATION_DOT` | Callout feature name for buy_pipeline_minutes_notification_dot. | +| <a id="usercalloutfeaturenameenumcanary_deployment"></a>`CANARY_DEPLOYMENT` | Callout feature name for canary_deployment. | +| <a id="usercalloutfeaturenameenumcluster_security_warning"></a>`CLUSTER_SECURITY_WARNING` | Callout feature name for cluster_security_warning. | +| <a id="usercalloutfeaturenameenumcustomize_homepage"></a>`CUSTOMIZE_HOMEPAGE` | Callout feature name for customize_homepage. | +| <a id="usercalloutfeaturenameenumeoa_bronze_plan_banner"></a>`EOA_BRONZE_PLAN_BANNER` | Callout feature name for eoa_bronze_plan_banner. | +| <a id="usercalloutfeaturenameenumfeature_flags_new_version"></a>`FEATURE_FLAGS_NEW_VERSION` | Callout feature name for feature_flags_new_version. | +| <a id="usercalloutfeaturenameenumgcp_signup_offer"></a>`GCP_SIGNUP_OFFER` | Callout feature name for gcp_signup_offer. | +| <a id="usercalloutfeaturenameenumgeo_enable_hashed_storage"></a>`GEO_ENABLE_HASHED_STORAGE` | Callout feature name for geo_enable_hashed_storage. | +| <a id="usercalloutfeaturenameenumgeo_migrate_hashed_storage"></a>`GEO_MIGRATE_HASHED_STORAGE` | Callout feature name for geo_migrate_hashed_storage. | +| <a id="usercalloutfeaturenameenumgke_cluster_integration"></a>`GKE_CLUSTER_INTEGRATION` | Callout feature name for gke_cluster_integration. | +| <a id="usercalloutfeaturenameenumgold_trial_billings"></a>`GOLD_TRIAL_BILLINGS` | Callout feature name for gold_trial_billings. | +| <a id="usercalloutfeaturenameenumnew_user_signups_cap_reached"></a>`NEW_USER_SIGNUPS_CAP_REACHED` | Callout feature name for new_user_signups_cap_reached. | +| <a id="usercalloutfeaturenameenumpersonal_access_token_expiry"></a>`PERSONAL_ACCESS_TOKEN_EXPIRY` | Callout feature name for personal_access_token_expiry. | +| <a id="usercalloutfeaturenameenumpipeline_needs_banner"></a>`PIPELINE_NEEDS_BANNER` | Callout feature name for pipeline_needs_banner. | +| <a id="usercalloutfeaturenameenumpipeline_needs_hover_tip"></a>`PIPELINE_NEEDS_HOVER_TIP` | Callout feature name for pipeline_needs_hover_tip. | +| <a id="usercalloutfeaturenameenumregistration_enabled_callout"></a>`REGISTRATION_ENABLED_CALLOUT` | Callout feature name for registration_enabled_callout. | +| <a id="usercalloutfeaturenameenumservice_templates_deprecated_callout"></a>`SERVICE_TEMPLATES_DEPRECATED_CALLOUT` | Callout feature name for service_templates_deprecated_callout. | +| <a id="usercalloutfeaturenameenumsuggest_pipeline"></a>`SUGGEST_PIPELINE` | Callout feature name for suggest_pipeline. | +| <a id="usercalloutfeaturenameenumsuggest_popover_dismissed"></a>`SUGGEST_POPOVER_DISMISSED` | Callout feature name for suggest_popover_dismissed. | +| <a id="usercalloutfeaturenameenumtabs_position_highlight"></a>`TABS_POSITION_HIGHLIGHT` | Callout feature name for tabs_position_highlight. | +| <a id="usercalloutfeaturenameenumthreat_monitoring_info"></a>`THREAT_MONITORING_INFO` | Callout feature name for threat_monitoring_info. | +| <a id="usercalloutfeaturenameenumultimate_trial"></a>`ULTIMATE_TRIAL` | Callout feature name for ultimate_trial. | +| <a id="usercalloutfeaturenameenumunfinished_tag_cleanup_callout"></a>`UNFINISHED_TAG_CLEANUP_CALLOUT` | Callout feature name for unfinished_tag_cleanup_callout. | +| <a id="usercalloutfeaturenameenumwebhooks_moved"></a>`WEBHOOKS_MOVED` | Callout feature name for webhooks_moved. | +| <a id="usercalloutfeaturenameenumweb_ide_alert_dismissed"></a>`WEB_IDE_ALERT_DISMISSED` | Callout feature name for web_ide_alert_dismissed. | +| <a id="usercalloutfeaturenameenumweb_ide_ci_environments_guidance"></a>`WEB_IDE_CI_ENVIRONMENTS_GUIDANCE` | Callout feature name for web_ide_ci_environments_guidance. | ### `UserState` @@ -8632,25 +14652,25 @@ Possible states of a user. | Value | Description | | ----- | ----------- | -| `active` | The user is active and is able to use the system. | -| `blocked` | The user has been blocked and is prevented from using the system. | -| `deactivated` | The user is no longer active and is unable to use the system. | +| <a id="userstateactive"></a>`active` | The user is active and is able to use the system. | +| <a id="userstateblocked"></a>`blocked` | The user has been blocked and is prevented from using the system. | +| <a id="userstatedeactivated"></a>`deactivated` | The user is no longer active and is unable to use the system. | ### `VisibilityLevelsEnum` | Value | Description | | ----- | ----------- | -| `internal` | Internal visibility level. | -| `private` | Private visibility level. | -| `public` | Public visibility level. | +| <a id="visibilitylevelsenuminternal"></a>`internal` | Internal visibility level. | +| <a id="visibilitylevelsenumprivate"></a>`private` | Private visibility level. | +| <a id="visibilitylevelsenumpublic"></a>`public` | Public visibility level. | ### `VisibilityScopesEnum` | Value | Description | | ----- | ----------- | -| `internal` | | -| `private` | | -| `public` | | +| <a id="visibilityscopesenuminternal"></a>`internal` | | +| <a id="visibilityscopesenumprivate"></a>`private` | | +| <a id="visibilityscopesenumpublic"></a>`public` | | ### `VulnerabilityDismissalReason` @@ -8658,11 +14678,11 @@ The dismissal reason of the Vulnerability. | Value | Description | | ----- | ----------- | -| `ACCEPTABLE_RISK` | The vulnerability is known, and has not been remediated or mitigated, but is considered to be an acceptable business risk. | -| `FALSE_POSITIVE` | An error in reporting in which a test result incorrectly indicates the presence of a vulnerability in a system when the vulnerability is not present. | -| `MITIGATING_CONTROL` | A management, operational, or technical control (that is, safeguard or countermeasure) employed by an organization that provides equivalent or comparable protection for an information system. | -| `NOT_APPLICABLE` | The vulnerability is known, and has not been remediated or mitigated, but is considered to be in a part of the application that will not be updated. | -| `USED_IN_TESTS` | The finding is not a vulnerability because it is part of a test or is test data. | +| <a id="vulnerabilitydismissalreasonacceptable_risk"></a>`ACCEPTABLE_RISK` | The vulnerability is known, and has not been remediated or mitigated, but is considered to be an acceptable business risk. | +| <a id="vulnerabilitydismissalreasonfalse_positive"></a>`FALSE_POSITIVE` | An error in reporting in which a test result incorrectly indicates the presence of a vulnerability in a system when the vulnerability is not present. | +| <a id="vulnerabilitydismissalreasonmitigating_control"></a>`MITIGATING_CONTROL` | A management, operational, or technical control (that is, safeguard or countermeasure) employed by an organization that provides equivalent or comparable protection for an information system. | +| <a id="vulnerabilitydismissalreasonnot_applicable"></a>`NOT_APPLICABLE` | The vulnerability is known, and has not been remediated or mitigated, but is considered to be in a part of the application that will not be updated. | +| <a id="vulnerabilitydismissalreasonused_in_tests"></a>`USED_IN_TESTS` | The finding is not a vulnerability because it is part of a test or is test data. | ### `VulnerabilityExternalIssueLinkExternalTracker` @@ -8670,7 +14690,7 @@ The external tracker of the external issue link related to a vulnerability. | Value | Description | | ----- | ----------- | -| `JIRA` | Jira external tracker. | +| <a id="vulnerabilityexternalissuelinkexternaltrackerjira"></a>`JIRA` | Jira external tracker. | ### `VulnerabilityExternalIssueLinkType` @@ -8678,7 +14698,7 @@ The type of the external issue link related to a vulnerability. | Value | Description | | ----- | ----------- | -| `CREATED` | Created link type. | +| <a id="vulnerabilityexternalissuelinktypecreated"></a>`CREATED` | Created link type. | ### `VulnerabilityGrade` @@ -8686,11 +14706,11 @@ The grade of the vulnerable project. | Value | Description | | ----- | ----------- | -| `A` | | -| `B` | | -| `C` | | -| `D` | | -| `F` | | +| <a id="vulnerabilitygradea"></a>`A` | | +| <a id="vulnerabilitygradeb"></a>`B` | | +| <a id="vulnerabilitygradec"></a>`C` | | +| <a id="vulnerabilitygraded"></a>`D` | | +| <a id="vulnerabilitygradef"></a>`F` | | ### `VulnerabilityIssueLinkType` @@ -8698,8 +14718,8 @@ The type of the issue link related to a vulnerability. | Value | Description | | ----- | ----------- | -| `CREATED` | | -| `RELATED` | | +| <a id="vulnerabilityissuelinktypecreated"></a>`CREATED` | | +| <a id="vulnerabilityissuelinktyperelated"></a>`RELATED` | | ### `VulnerabilityReportType` @@ -8707,13 +14727,13 @@ The type of the security scan that found the vulnerability. | Value | Description | | ----- | ----------- | -| `API_FUZZING` | | -| `CONTAINER_SCANNING` | | -| `COVERAGE_FUZZING` | | -| `DAST` | | -| `DEPENDENCY_SCANNING` | | -| `SAST` | | -| `SECRET_DETECTION` | | +| <a id="vulnerabilityreporttypeapi_fuzzing"></a>`API_FUZZING` | | +| <a id="vulnerabilityreporttypecontainer_scanning"></a>`CONTAINER_SCANNING` | | +| <a id="vulnerabilityreporttypecoverage_fuzzing"></a>`COVERAGE_FUZZING` | | +| <a id="vulnerabilityreporttypedast"></a>`DAST` | | +| <a id="vulnerabilityreporttypedependency_scanning"></a>`DEPENDENCY_SCANNING` | | +| <a id="vulnerabilityreporttypesast"></a>`SAST` | | +| <a id="vulnerabilityreporttypesecret_detection"></a>`SECRET_DETECTION` | | ### `VulnerabilitySeverity` @@ -8721,12 +14741,12 @@ The severity of the vulnerability. | Value | Description | | ----- | ----------- | -| `CRITICAL` | | -| `HIGH` | | -| `INFO` | | -| `LOW` | | -| `MEDIUM` | | -| `UNKNOWN` | | +| <a id="vulnerabilityseveritycritical"></a>`CRITICAL` | | +| <a id="vulnerabilityseverityhigh"></a>`HIGH` | | +| <a id="vulnerabilityseverityinfo"></a>`INFO` | | +| <a id="vulnerabilityseveritylow"></a>`LOW` | | +| <a id="vulnerabilityseveritymedium"></a>`MEDIUM` | | +| <a id="vulnerabilityseverityunknown"></a>`UNKNOWN` | | ### `VulnerabilitySort` @@ -8734,16 +14754,16 @@ Vulnerability sort values. | Value | Description | | ----- | ----------- | -| `detected_asc` | Detection timestamp in ascending order. | -| `detected_desc` | Detection timestamp in descending order. | -| `report_type_asc` | Report Type in ascending order. | -| `report_type_desc` | Report Type in descending order. | -| `severity_asc` | Severity in ascending order. | -| `severity_desc` | Severity in descending order. | -| `state_asc` | State in ascending order. | -| `state_desc` | State in descending order. | -| `title_asc` | Title in ascending order. | -| `title_desc` | Title in descending order. | +| <a id="vulnerabilitysortdetected_asc"></a>`detected_asc` | Detection timestamp in ascending order. | +| <a id="vulnerabilitysortdetected_desc"></a>`detected_desc` | Detection timestamp in descending order. | +| <a id="vulnerabilitysortreport_type_asc"></a>`report_type_asc` | Report Type in ascending order. | +| <a id="vulnerabilitysortreport_type_desc"></a>`report_type_desc` | Report Type in descending order. | +| <a id="vulnerabilitysortseverity_asc"></a>`severity_asc` | Severity in ascending order. | +| <a id="vulnerabilitysortseverity_desc"></a>`severity_desc` | Severity in descending order. | +| <a id="vulnerabilitysortstate_asc"></a>`state_asc` | State in ascending order. | +| <a id="vulnerabilitysortstate_desc"></a>`state_desc` | State in descending order. | +| <a id="vulnerabilitysorttitle_asc"></a>`title_asc` | Title in ascending order. | +| <a id="vulnerabilitysorttitle_desc"></a>`title_desc` | Title in descending order. | ### `VulnerabilityState` @@ -8751,10 +14771,19 @@ The state of the vulnerability. | Value | Description | | ----- | ----------- | -| `CONFIRMED` | | -| `DETECTED` | | -| `DISMISSED` | | -| `RESOLVED` | | +| <a id="vulnerabilitystateconfirmed"></a>`CONFIRMED` | | +| <a id="vulnerabilitystatedetected"></a>`DETECTED` | | +| <a id="vulnerabilitystatedismissed"></a>`DISMISSED` | | +| <a id="vulnerabilitystateresolved"></a>`RESOLVED` | | + +### `WeightWildcardId` + +Weight ID wildcard values. + +| Value | Description | +| ----- | ----------- | +| <a id="weightwildcardidany"></a>`ANY` | Weight is assigned. | +| <a id="weightwildcardidnone"></a>`NONE` | No weight is assigned. | ## Scalar types @@ -8811,12 +14840,24 @@ An example `BoardsEpicListID` is: `"gid://gitlab/Boards::EpicList/1"`. Represents `true` or `false` values. +### `CiBuildID` + +A `CiBuildID` is a global ID. It is encoded as a string. + +An example `CiBuildID` is: `"gid://gitlab/Ci::Build/1"`. + ### `CiPipelineID` A `CiPipelineID` is a global ID. It is encoded as a string. An example `CiPipelineID` is: `"gid://gitlab/Ci::Pipeline/1"`. +### `CiRunnerID` + +A `CiRunnerID` is a global ID. It is encoded as a string. + +An example `CiRunnerID` is: `"gid://gitlab/Ci::Runner/1"`. + ### `ClustersAgentID` A `ClustersAgentID` is a global ID. It is encoded as a string. @@ -8917,6 +14958,12 @@ A `DiscussionID` is a global ID. It is encoded as a string. An example `DiscussionID` is: `"gid://gitlab/Discussion/1"`. +### `Duration` + +Duration between two instants, represented as a fractional number of seconds. + +For example: 12.3334. + ### `EnvironmentID` A `EnvironmentID` is a global ID. It is encoded as a string. @@ -8984,6 +15031,12 @@ An example `IncidentManagementOncallRotationID` is: `"gid://gitlab/IncidentManag Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. +### `IssuableID` + +A `IssuableID` is a global ID. It is encoded as a string. + +An example `IssuableID` is: `"gid://gitlab/Issuable/1"`. + ### `IssueID` A `IssueID` is a global ID. It is encoded as a string. @@ -9076,6 +15129,18 @@ A `PackagesConanMetadatumID` is a global ID. It is encoded as a string. An example `PackagesConanMetadatumID` is: `"gid://gitlab/Packages::Conan::Metadatum/1"`. +### `PackagesMavenMetadatumID` + +A `PackagesMavenMetadatumID` is a global ID. It is encoded as a string. + +An example `PackagesMavenMetadatumID` is: `"gid://gitlab/Packages::Maven::Metadatum/1"`. + +### `PackagesNugetMetadatumID` + +A `PackagesNugetMetadatumID` is a global ID. It is encoded as a string. + +An example `PackagesNugetMetadatumID` is: `"gid://gitlab/Packages::Nuget::Metadatum/1"`. + ### `PackagesPackageFileID` A `PackagesPackageFileID` is a global ID. It is encoded as a string. @@ -9088,6 +15153,12 @@ A `PackagesPackageID` is a global ID. It is encoded as a string. An example `PackagesPackageID` is: `"gid://gitlab/Packages::Package/1"`. +### `PathLockID` + +A `PathLockID` is a global ID. It is encoded as a string. + +An example `PathLockID` is: `"gid://gitlab/PathLock/1"`. + ### `PayloadAlertFieldPathSegment` String or integer. @@ -9193,6 +15264,16 @@ abstract types. ### Unions +#### `Issuable` + +Represents an issuable. + +One of: + +- [`Epic`](#epic) +- [`Issue`](#issue) +- [`MergeRequest`](#mergerequest) + #### `PackageMetadata` Represents metadata associated with a Package. @@ -9201,6 +15282,8 @@ One of: - [`ComposerMetadata`](#composermetadata) - [`ConanMetadata`](#conanmetadata) +- [`MavenMetadata`](#mavenmetadata) +- [`NugetMetadata`](#nugetmetadata) #### `VulnerabilityDetail` @@ -9244,15 +15327,17 @@ Implementations: - [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) - [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. | -| `apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | -| `id` | [`ID!`](#id) | ID of the integration. | -| `name` | [`String`](#string) | Name of the integration. | -| `token` | [`String`](#string) | Token used to authenticate alert notification requests. | -| `type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. | -| `url` | [`String`](#string) | Endpoint which accepts alert notifications. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementintegrationactive"></a>`active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. | +| <a id="alertmanagementintegrationapiurl"></a>`apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | +| <a id="alertmanagementintegrationid"></a>`id` | [`ID!`](#id) | ID of the integration. | +| <a id="alertmanagementintegrationname"></a>`name` | [`String`](#string) | Name of the integration. | +| <a id="alertmanagementintegrationtoken"></a>`token` | [`String`](#string) | Token used to authenticate alert notification requests. | +| <a id="alertmanagementintegrationtype"></a>`type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. | +| <a id="alertmanagementintegrationurl"></a>`url` | [`String`](#string) | Endpoint which accepts alert notifications. | #### `CurrentUserTodos` @@ -9265,9 +15350,23 @@ Implementations: - [`Issue`](#issue) - [`MergeRequest`](#mergerequest) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `currentUserTodos` | [`TodoConnection!`](#todoconnection) | To-do items for the current user. | +##### Fields with arguments + +###### `CurrentUserTodos.currentUserTodos` + +To-do items for the current user. + +Returns [`TodoConnection!`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +####### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="currentusertodoscurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. | #### `DesignFields` @@ -9276,18 +15375,20 @@ Implementations: - [`Design`](#design) - [`DesignAtVersion`](#designatversion) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `diffRefs` | [`DiffRefs!`](#diffrefs) | The diff refs for this design. | -| `event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. | -| `filename` | [`String!`](#string) | The filename of the design. | -| `fullPath` | [`String!`](#string) | The full path to the design file. | -| `id` | [`ID!`](#id) | The ID of this design. | -| `image` | [`String!`](#string) | The URL of the full-sized image. | -| `imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. | -| `issue` | [`Issue!`](#issue) | The issue the design belongs to. | -| `notesCount` | [`Int!`](#int) | The total count of user-created notes for this design. | -| `project` | [`Project!`](#project) | The project the design belongs to. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="designfieldsdiffrefs"></a>`diffRefs` | [`DiffRefs!`](#diffrefs) | The diff refs for this design. | +| <a id="designfieldsevent"></a>`event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. | +| <a id="designfieldsfilename"></a>`filename` | [`String!`](#string) | The filename of the design. | +| <a id="designfieldsfullpath"></a>`fullPath` | [`String!`](#string) | The full path to the design file. | +| <a id="designfieldsid"></a>`id` | [`ID!`](#id) | The ID of this design. | +| <a id="designfieldsimage"></a>`image` | [`String!`](#string) | The URL of the full-sized image. | +| <a id="designfieldsimagev432x230"></a>`imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. | +| <a id="designfieldsissue"></a>`issue` | [`Issue!`](#issue) | The issue the design belongs to. | +| <a id="designfieldsnotescount"></a>`notesCount` | [`Int!`](#int) | The total count of user-created notes for this design. | +| <a id="designfieldsproject"></a>`project` | [`Project!`](#project) | The project the design belongs to. | #### `Entry` @@ -9297,14 +15398,16 @@ Implementations: - [`Submodule`](#submodule) - [`TreeEntry`](#treeentry) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `flatPath` | [`String!`](#string) | Flat path of the entry. | -| `id` | [`ID!`](#id) | ID of the entry. | -| `name` | [`String!`](#string) | Name of the entry. | -| `path` | [`String!`](#string) | Path of the entry. | -| `sha` | [`String!`](#string) | Last commit SHA for the entry. | -| `type` | [`EntryType!`](#entrytype) | Type of tree entry. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="entryflatpath"></a>`flatPath` | [`String!`](#string) | Flat path of the entry. | +| <a id="entryid"></a>`id` | [`ID!`](#id) | ID of the entry. | +| <a id="entryname"></a>`name` | [`String!`](#string) | Name of the entry. | +| <a id="entrypath"></a>`path` | [`String!`](#string) | Path of the entry. | +| <a id="entrysha"></a>`sha` | [`String!`](#string) | Last commit SHA for the entry. | +| <a id="entrytype"></a>`type` | [`EntryType!`](#entrytype) | Type of tree entry. | #### `Eventable` @@ -9313,9 +15416,11 @@ Implementations: - [`BoardEpic`](#boardepic) - [`Epic`](#epic) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `events` | [`EventConnection`](#eventconnection) | A list of events associated with the object. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="eventableevents"></a>`events` | [`EventConnection`](#eventconnection) | A list of events associated with the object. (see [Connections](#connections)) | #### `MemberInterface` @@ -9324,15 +15429,17 @@ Implementations: - [`GroupMember`](#groupmember) - [`ProjectMember`](#projectmember) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. | -| `createdAt` | [`Time`](#time) | Date and time the membership was created. | -| `createdBy` | [`User`](#user) | User that authorized membership. | -| `expiresAt` | [`Time`](#time) | Date and time the membership expires. | -| `id` | [`ID!`](#id) | ID of the member. | -| `updatedAt` | [`Time`](#time) | Date and time the membership was last updated. | -| `user` | [`User!`](#user) | User that is associated with the member object. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="memberinterfaceaccesslevel"></a>`accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. | +| <a id="memberinterfacecreatedat"></a>`createdAt` | [`Time`](#time) | Date and time the membership was created. | +| <a id="memberinterfacecreatedby"></a>`createdBy` | [`UserCore`](#usercore) | User that authorized membership. | +| <a id="memberinterfaceexpiresat"></a>`expiresAt` | [`Time`](#time) | Date and time the membership expires. | +| <a id="memberinterfaceid"></a>`id` | [`ID!`](#id) | ID of the member. | +| <a id="memberinterfaceupdatedat"></a>`updatedAt` | [`Time`](#time) | Date and time the membership was last updated. | +| <a id="memberinterfaceuser"></a>`user` | [`UserCore!`](#usercore) | User that is associated with the member object. | #### `Noteable` @@ -9348,10 +15455,12 @@ Implementations: - [`Snippet`](#snippet) - [`Vulnerability`](#vulnerability) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. | -| `notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="noteablediscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) | +| <a id="noteablenotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) | #### `PackageFileMetadata` @@ -9361,10 +15470,12 @@ Implementations: - [`ConanFileMetadata`](#conanfilemetadata) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `createdAt` | [`Time!`](#time) | Date of creation. | -| `updatedAt` | [`Time!`](#time) | Date of most recent update. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="packagefilemetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. | +| <a id="packagefilemetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. | #### `ResolvableInterface` @@ -9373,12 +15484,14 @@ Implementations: - [`Discussion`](#discussion) - [`Note`](#note) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. | -| `resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. | -| `resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. | -| `resolvedBy` | [`User`](#user) | User who resolved the object. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="resolvableinterfaceresolvable"></a>`resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. | +| <a id="resolvableinterfaceresolved"></a>`resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. | +| <a id="resolvableinterfaceresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. | +| <a id="resolvableinterfaceresolvedby"></a>`resolvedBy` | [`UserCore`](#usercore) | User who resolved the object. | #### `Service` @@ -9387,10 +15500,12 @@ Implementations: - [`BaseService`](#baseservice) - [`JiraService`](#jiraservice) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `active` | [`Boolean`](#boolean) | Indicates if the service is active. | -| `type` | [`String`](#string) | Class name of the service. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="serviceactive"></a>`active` | [`Boolean`](#boolean) | Indicates if the service is active. | +| <a id="servicetype"></a>`type` | [`String`](#string) | Class name of the service. | #### `TimeboxReportInterface` @@ -9399,6 +15514,533 @@ Implementations: - [`Iteration`](#iteration) - [`Milestone`](#milestone) -| Field | Type | Description | -| ----- | ---- | ----------- | -| `report` | [`TimeboxReport`](#timeboxreport) | Historically accurate report about the timebox. | +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="timeboxreportinterfacereport"></a>`report` | [`TimeboxReport`](#timeboxreport) | Historically accurate report about the timebox. | + +#### `User` + +Representation of a GitLab user. + +Implementations: + +- [`MergeRequestAssignee`](#mergerequestassignee) +- [`MergeRequestReviewer`](#mergerequestreviewer) +- [`UserCore`](#usercore) + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="useravatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. | +| <a id="userbot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. | +| <a id="usercallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) | +| <a id="useremail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). | +| <a id="usergroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. | +| <a id="usergroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) | +| <a id="userid"></a>`id` | [`ID!`](#id) | ID of the user. | +| <a id="userlocation"></a>`location` | [`String`](#string) | The location of the user. | +| <a id="username"></a>`name` | [`String!`](#string) | Human-readable name of the user. | +| <a id="userprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) | +| <a id="userpublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. | +| <a id="userstate"></a>`state` | [`UserState!`](#userstate) | State of the user. | +| <a id="userstatus"></a>`status` | [`UserStatus`](#userstatus) | User status. | +| <a id="useruserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. | +| <a id="userusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. | +| <a id="userwebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. | +| <a id="userweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. | + +##### Fields with arguments + +###### `User.assignedMergeRequests` + +Merge requests assigned to the user. + +Returns [`MergeRequestConnection`](#mergerequestconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +####### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="userassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="userassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="userassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="userassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="userassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="userassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="userassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="userassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="userassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="userassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="userassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="userassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="userassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="userassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | + +###### `User.authoredMergeRequests` + +Merge requests authored by the user. + +Returns [`MergeRequestConnection`](#mergerequestconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +####### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="userauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="userauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="userauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="userauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="userauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="userauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="userauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="userauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="userauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="userauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. | +| <a id="userauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="userauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="userauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="userauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | + +###### `User.reviewRequestedMergeRequests` + +Merge requests assigned to the user for review. + +Returns [`MergeRequestConnection`](#mergerequestconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +####### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="userreviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. | +| <a id="userreviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. | +| <a id="userreviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. | +| <a id="userreviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. | +| <a id="userreviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. | +| <a id="userreviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. | +| <a id="userreviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | +| <a id="userreviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. | +| <a id="userreviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. | +| <a id="userreviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. | +| <a id="userreviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. | +| <a id="userreviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. | +| <a id="userreviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | A merge request state. If provided, all resolved merge requests will have this state. | +| <a id="userreviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. | + +###### `User.snippets` + +Snippets authored by the user. + +Returns [`SnippetConnection`](#snippetconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +####### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usersnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | +| <a id="usersnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | The type of snippet. | +| <a id="usersnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | The visibility of the snippet. | + +###### `User.starredProjects` + +Projects starred by the user. + +Returns [`ProjectConnection`](#projectconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +####### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="userstarredprojectssearch"></a>`search` | [`String`](#string) | Search query. | + +###### `User.todos` + +To-do items of the user. + +Returns [`TodoConnection`](#todoconnection). + +This field returns a [connection](#connections). It accepts the +four standard [pagination arguments](#connection-pagination-arguments): +`before: String`, `after: String`, `first: Int`, `last: Int`. + +####### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="usertodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | The action to be filtered. | +| <a id="usertodosauthorid"></a>`authorId` | [`[ID!]`](#id) | The ID of an author. | +| <a id="usertodosgroupid"></a>`groupId` | [`[ID!]`](#id) | The ID of a group. | +| <a id="usertodosprojectid"></a>`projectId` | [`[ID!]`](#id) | The ID of a project. | +| <a id="usertodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | The state of the todo. | +| <a id="usertodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | The type of the todo. | + +## Input types + +Types that may be used as arguments (all scalar types may also +be used as arguments). + +Only general use input types are listed here. For mutation input types, +see the associated mutation type above. + +### `AlertManagementPayloadAlertFieldInput` + +Field that are available while modifying the custom mapping attributes for an HTTP integration. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="alertmanagementpayloadalertfieldinputfieldname"></a>`fieldName` | [`AlertManagementPayloadAlertFieldName!`](#alertmanagementpayloadalertfieldname) | A GitLab alert field name. | +| <a id="alertmanagementpayloadalertfieldinputlabel"></a>`label` | [`String`](#string) | Human-readable label of the payload path. | +| <a id="alertmanagementpayloadalertfieldinputpath"></a>`path` | [`[PayloadAlertFieldPathSegment!]!`](#payloadalertfieldpathsegment) | Path to value inside payload JSON. | +| <a id="alertmanagementpayloadalertfieldinputtype"></a>`type` | [`AlertManagementPayloadAlertFieldType!`](#alertmanagementpayloadalertfieldtype) | Type of the parsed value. | + +### `BoardIssueInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="boardissueinputassigneeusername"></a>`assigneeUsername` | [`[String]`](#string) | Filter by assignee username. | +| <a id="boardissueinputassigneewildcardid"></a>`assigneeWildcardId` | [`AssigneeWildcardId`](#assigneewildcardid) | Filter by assignee wildcard. Incompatible with assigneeUsername. | +| <a id="boardissueinputauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. | +| <a id="boardissueinputepicid"></a>`epicId` | [`EpicID`](#epicid) | Filter by epic ID. Incompatible with epicWildcardId. | +| <a id="boardissueinputepicwildcardid"></a>`epicWildcardId` | [`EpicWildcardId`](#epicwildcardid) | Filter by epic ID wildcard. Incompatible with epicId. | +| <a id="boardissueinputiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example ["1", "2"]. | +| <a id="boardissueinputiterationid"></a>`iterationId` | [`[IterationID!]`](#iterationid) | Filter by a list of iteration IDs. Incompatible with iterationWildcardId. | +| <a id="boardissueinputiterationtitle"></a>`iterationTitle` | [`String`](#string) | Filter by iteration title. | +| <a id="boardissueinputiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by iteration ID wildcard. | +| <a id="boardissueinputlabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. | +| <a id="boardissueinputmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter by milestone title. | +| <a id="boardissueinputmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. | +| <a id="boardissueinputnot"></a>`not` | [`NegatedBoardIssueInput`](#negatedboardissueinput) | List of negated arguments. | +| <a id="boardissueinputreleasetag"></a>`releaseTag` | [`String`](#string) | Filter by release tag. | +| <a id="boardissueinputsearch"></a>`search` | [`String`](#string) | Search query for issue title or description. | +| <a id="boardissueinputweight"></a>`weight` | [`String`](#string) | Filter by weight. | +| <a id="boardissueinputweightwildcardid"></a>`weightWildcardId` | [`WeightWildcardId`](#weightwildcardid) | Filter by weight ID wildcard. Incompatible with weight. | + +### `CommitAction` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="commitactionaction"></a>`action` | [`CommitActionMode!`](#commitactionmode) | The action to perform, create, delete, move, update, chmod. | +| <a id="commitactioncontent"></a>`content` | [`String`](#string) | Content of the file. | +| <a id="commitactionencoding"></a>`encoding` | [`CommitEncoding`](#commitencoding) | Encoding of the file. Default is text. | +| <a id="commitactionexecutefilemode"></a>`executeFilemode` | [`Boolean`](#boolean) | Enables/disables the execute flag on the file. | +| <a id="commitactionfilepath"></a>`filePath` | [`String!`](#string) | Full path to the file. | +| <a id="commitactionlastcommitid"></a>`lastCommitId` | [`String`](#string) | Last known file commit ID. | +| <a id="commitactionpreviouspath"></a>`previousPath` | [`String`](#string) | Original full path to the file being moved. | + +### `ComplianceFrameworkInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="complianceframeworkinputcolor"></a>`color` | [`String`](#string) | New color representation of the compliance framework in hex format. e.g. #FCA121. | +| <a id="complianceframeworkinputdescription"></a>`description` | [`String`](#string) | New description for the compliance framework. | +| <a id="complianceframeworkinputname"></a>`name` | [`String`](#string) | New name for the compliance framework. | +| <a id="complianceframeworkinputpipelineconfigurationfullpath"></a>`pipelineConfigurationFullPath` | [`String`](#string) | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. | + +### `DastSiteProfileAuthInput` + +Input type for DastSiteProfile authentication. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="dastsiteprofileauthinputenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether authentication is enabled. | +| <a id="dastsiteprofileauthinputpassword"></a>`password` | [`String`](#string) | The password to authenticate with on the target website. | +| <a id="dastsiteprofileauthinputpasswordfield"></a>`passwordField` | [`String`](#string) | The name of password field at the sign-in HTML form. | +| <a id="dastsiteprofileauthinputurl"></a>`url` | [`String`](#string) | The URL of the page containing the sign-in HTML form on the target website. | +| <a id="dastsiteprofileauthinputusername"></a>`username` | [`String`](#string) | The username to authenticate with on the target website. | +| <a id="dastsiteprofileauthinputusernamefield"></a>`usernameField` | [`String`](#string) | The name of username field at the sign-in HTML form. | + +### `DiffImagePositionInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="diffimagepositioninputbasesha"></a>`baseSha` | [`String`](#string) | Merge base of the branch the comment was made on. | +| <a id="diffimagepositioninputheadsha"></a>`headSha` | [`String!`](#string) | SHA of the HEAD at the time the comment was made. | +| <a id="diffimagepositioninputheight"></a>`height` | [`Int!`](#int) | Total height of the image. | +| <a id="diffimagepositioninputpaths"></a>`paths` | [`DiffPathsInput!`](#diffpathsinput) | The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required. | +| <a id="diffimagepositioninputstartsha"></a>`startSha` | [`String!`](#string) | SHA of the branch being compared against. | +| <a id="diffimagepositioninputwidth"></a>`width` | [`Int!`](#int) | Total width of the image. | +| <a id="diffimagepositioninputx"></a>`x` | [`Int!`](#int) | X position of the note. | +| <a id="diffimagepositioninputy"></a>`y` | [`Int!`](#int) | Y position of the note. | + +### `DiffPathsInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="diffpathsinputnewpath"></a>`newPath` | [`String`](#string) | The path of the file on the head sha. | +| <a id="diffpathsinputoldpath"></a>`oldPath` | [`String`](#string) | The path of the file on the start sha. | + +### `DiffPositionInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="diffpositioninputbasesha"></a>`baseSha` | [`String`](#string) | Merge base of the branch the comment was made on. | +| <a id="diffpositioninputheadsha"></a>`headSha` | [`String!`](#string) | SHA of the HEAD at the time the comment was made. | +| <a id="diffpositioninputnewline"></a>`newLine` | [`Int`](#int) | Line on HEAD SHA that was changed. | +| <a id="diffpositioninputoldline"></a>`oldLine` | [`Int`](#int) | Line on start SHA that was changed. | +| <a id="diffpositioninputpaths"></a>`paths` | [`DiffPathsInput!`](#diffpathsinput) | The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required. | +| <a id="diffpositioninputstartsha"></a>`startSha` | [`String!`](#string) | SHA of the branch being compared against. | + +### `EpicFilters` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epicfiltersauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. | +| <a id="epicfilterslabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. | +| <a id="epicfiltersmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. | +| <a id="epicfiltersnot"></a>`not` | [`NegatedEpicBoardIssueInput`](#negatedepicboardissueinput) | Negated epic arguments. | +| <a id="epicfilterssearch"></a>`search` | [`String`](#string) | Search query for epic title or description. | + +### `EpicTreeNodeFieldsInputType` + +A node of an epic tree. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="epictreenodefieldsinputtypeadjacentreferenceid"></a>`adjacentReferenceId` | [`EpicTreeSortingID`](#epictreesortingid) | The ID of the epic_issue or issue that the actual epic or issue is switched with. | +| <a id="epictreenodefieldsinputtypeid"></a>`id` | [`EpicTreeSortingID!`](#epictreesortingid) | The ID of the epic_issue or epic that is being moved. | +| <a id="epictreenodefieldsinputtypenewparentid"></a>`newParentId` | [`EpicID`](#epicid) | ID of the new parent epic. | +| <a id="epictreenodefieldsinputtyperelativeposition"></a>`relativePosition` | [`MoveType`](#movetype) | The type of the switch, after or before allowed. | + +### `JiraUsersMappingInputType` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jirausersmappinginputtypegitlabid"></a>`gitlabId` | [`Int`](#int) | ID of the GitLab user. | +| <a id="jirausersmappinginputtypejiraaccountid"></a>`jiraAccountId` | [`String!`](#string) | Jira account ID of the user. | + +### `MergeRequestsResolverNegatedParams` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="mergerequestsresolvernegatedparamslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will not have these labels. | +| <a id="mergerequestsresolvernegatedparamsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. | + +### `NegatedBoardIssueInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="negatedboardissueinputassigneeusername"></a>`assigneeUsername` | [`[String]`](#string) | Filter by assignee username. | +| <a id="negatedboardissueinputauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. | +| <a id="negatedboardissueinputepicid"></a>`epicId` | [`EpicID`](#epicid) | Filter by epic ID. Incompatible with epicWildcardId. | +| <a id="negatedboardissueinputiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example ["1", "2"]. | +| <a id="negatedboardissueinputiterationid"></a>`iterationId` | [`[IterationID!]`](#iterationid) | Filter by a list of iteration IDs. Incompatible with iterationWildcardId. | +| <a id="negatedboardissueinputiterationtitle"></a>`iterationTitle` | [`String`](#string) | Filter by iteration title. | +| <a id="negatedboardissueinputiterationwildcardid"></a>`iterationWildcardId` | [`NegatedIterationWildcardId`](#negatediterationwildcardid) | Filter by iteration ID wildcard. | +| <a id="negatedboardissueinputlabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. | +| <a id="negatedboardissueinputmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter by milestone title. | +| <a id="negatedboardissueinputmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. | +| <a id="negatedboardissueinputreleasetag"></a>`releaseTag` | [`String`](#string) | Filter by release tag. | +| <a id="negatedboardissueinputweight"></a>`weight` | [`String`](#string) | Filter by weight. | + +### `NegatedEpicBoardIssueInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="negatedepicboardissueinputauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. | +| <a id="negatedepicboardissueinputlabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. | +| <a id="negatedepicboardissueinputmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. | + +### `NegatedIssueFilterInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="negatedissuefilterinputassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user not assigned to the issues. | +| <a id="negatedissuefilterinputassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users not assigned to the issue. | +| <a id="negatedissuefilterinputepicid"></a>`epicId` | [`String`](#string) | ID of an epic not associated with the issues. | +| <a id="negatedissuefilterinputiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues to exclude. For example, [1, 2]. | +| <a id="negatedissuefilterinputiterationid"></a>`iterationId` | [`[ID!]`](#id) | List of iteration Global IDs not applied to the issue. | +| <a id="negatedissuefilterinputiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by negated iteration ID wildcard. | +| <a id="negatedissuefilterinputlabelname"></a>`labelName` | [`[String!]`](#string) | Labels not applied to this issue. | +| <a id="negatedissuefilterinputmilestonetitle"></a>`milestoneTitle` | [`[String!]`](#string) | Milestone not applied to this issue. | +| <a id="negatedissuefilterinputweight"></a>`weight` | [`String`](#string) | Weight not applied to the issue. | + +### `OncallRotationActivePeriodInputType` + +Active period time range for on-call rotation. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="oncallrotationactiveperiodinputtypeendtime"></a>`endTime` | [`String!`](#string) | The end of the rotation active period in 24 hour format, for example "18:30". | +| <a id="oncallrotationactiveperiodinputtypestarttime"></a>`startTime` | [`String!`](#string) | The start of the rotation active period in 24 hour format, for example "18:30". | + +### `OncallRotationDateInputType` + +Date input type for on-call rotation. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="oncallrotationdateinputtypedate"></a>`date` | [`String!`](#string) | The date component of the date in YYYY-MM-DD format. | +| <a id="oncallrotationdateinputtypetime"></a>`time` | [`String!`](#string) | The time component of the date in 24hr HH:MM format. | + +### `OncallRotationLengthInputType` + +The rotation length of the on-call rotation. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="oncallrotationlengthinputtypelength"></a>`length` | [`Int!`](#int) | The rotation length of the on-call rotation. | +| <a id="oncallrotationlengthinputtypeunit"></a>`unit` | [`OncallRotationUnitEnum!`](#oncallrotationunitenum) | The unit of the rotation length of the on-call rotation. | + +### `OncallUserInputType` + +The rotation user and color palette. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="oncalluserinputtypecolorpalette"></a>`colorPalette` | [`DataVisualizationColorEnum`](#datavisualizationcolorenum) | A value of DataVisualizationColorEnum. The color from the palette to assign to the on-call user. | +| <a id="oncalluserinputtypecolorweight"></a>`colorWeight` | [`DataVisualizationWeightEnum`](#datavisualizationweightenum) | A value of DataVisualizationWeightEnum. The color weight to assign to for the on-call user. Note: To view on-call schedules in GitLab, do not provide a value below 500. A value between 500 and 950 ensures sufficient contrast. | +| <a id="oncalluserinputtypeusername"></a>`username` | [`String!`](#string) | The username of the user to participate in the on-call rotation, such as `user_one`. | + +### `ReleaseAssetLinkInput` + +Fields that are available when modifying a release asset link. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseassetlinkinputdirectassetpath"></a>`directAssetPath` | [`String`](#string) | Relative path for a direct asset link. | +| <a id="releaseassetlinkinputlinktype"></a>`linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | The type of the asset link. | +| <a id="releaseassetlinkinputname"></a>`name` | [`String!`](#string) | Name of the asset link. | +| <a id="releaseassetlinkinputurl"></a>`url` | [`String!`](#string) | URL of the asset link. | + +### `ReleaseAssetsInput` + +Fields that are available when modifying release assets. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="releaseassetsinputlinks"></a>`links` | [`[ReleaseAssetLinkInput!]`](#releaseassetlinkinput) | A list of asset links to associate to the release. | + +### `SastCiConfigurationAnalyzersEntityInput` + +Represents the analyzers entity in SAST CI configuration. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationanalyzersentityinputenabled"></a>`enabled` | [`Boolean!`](#boolean) | State of the analyzer. | +| <a id="sastciconfigurationanalyzersentityinputname"></a>`name` | [`String!`](#string) | Name of analyzer. | +| <a id="sastciconfigurationanalyzersentityinputvariables"></a>`variables` | [`[SastCiConfigurationEntityInput!]`](#sastciconfigurationentityinput) | List of variables for the analyzer. | + +### `SastCiConfigurationEntityInput` + +Represents an entity in SAST CI configuration. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationentityinputdefaultvalue"></a>`defaultValue` | [`String!`](#string) | Default value that is used if value is empty. | +| <a id="sastciconfigurationentityinputfield"></a>`field` | [`String!`](#string) | CI keyword of entity. | +| <a id="sastciconfigurationentityinputvalue"></a>`value` | [`String!`](#string) | Current value of the entity. | + +### `SastCiConfigurationInput` + +Represents a CI configuration of SAST. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="sastciconfigurationinputanalyzers"></a>`analyzers` | [`[SastCiConfigurationAnalyzersEntityInput!]`](#sastciconfigurationanalyzersentityinput) | List of analyzers and related variables for the SAST configuration. | +| <a id="sastciconfigurationinputglobal"></a>`global` | [`[SastCiConfigurationEntityInput!]`](#sastciconfigurationentityinput) | List of global entities related to SAST configuration. | +| <a id="sastciconfigurationinputpipeline"></a>`pipeline` | [`[SastCiConfigurationEntityInput!]`](#sastciconfigurationentityinput) | List of pipeline entities related to SAST configuration. | + +### `SnippetBlobActionInputType` + +Represents an action to perform over a snippet file. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="snippetblobactioninputtypeaction"></a>`action` | [`SnippetBlobActionEnum!`](#snippetblobactionenum) | Type of input action. | +| <a id="snippetblobactioninputtypecontent"></a>`content` | [`String`](#string) | Snippet file content. | +| <a id="snippetblobactioninputtypefilepath"></a>`filePath` | [`String!`](#string) | Path of the snippet file. | +| <a id="snippetblobactioninputtypepreviouspath"></a>`previousPath` | [`String`](#string) | Previous path of the snippet file. | + +### `Timeframe` + +A time-frame defined as a closed inclusive range of two dates. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="timeframeend"></a>`end` | [`Date!`](#date) | The end of the range. | +| <a id="timeframestart"></a>`start` | [`Date!`](#date) | The start of the range. | + +### `UpdateDiffImagePositionInput` + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="updatediffimagepositioninputheight"></a>`height` | [`Int`](#int) | Total height of the image. | +| <a id="updatediffimagepositioninputwidth"></a>`width` | [`Int`](#int) | Total width of the image. | +| <a id="updatediffimagepositioninputx"></a>`x` | [`Int`](#int) | X position of the note. | +| <a id="updatediffimagepositioninputy"></a>`y` | [`Int`](#int) | Y position of the note. | diff --git a/doc/api/graphql/sample_issue_boards.md b/doc/api/graphql/sample_issue_boards.md index bddf1ea9a7e..86881465ed6 100644 --- a/doc/api/graphql/sample_issue_boards.md +++ b/doc/api/graphql/sample_issue_boards.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Plan +group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/graphql/users_example.md b/doc/api/graphql/users_example.md index e4a697d11fd..1222cd8ee8e 100644 --- a/doc/api/graphql/users_example.md +++ b/doc/api/graphql/users_example.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -68,7 +68,7 @@ explorer. GraphiQL explorer is available for: } } } - } + } ``` 1. Open the [GraphiQL explorer tool](https://gitlab.com/-/graphql-explorer). diff --git a/doc/api/group_badges.md b/doc/api/group_badges.md index e3fcaa3db37..848d5735096 100644 --- a/doc/api/group_badges.md +++ b/doc/api/group_badges.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -192,6 +192,6 @@ Example response: "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}", "image_url": "https://shields.io/my/badge", "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master", - "rendered_image_url": "https://shields.io/my/badge", + "rendered_image_url": "https://shields.io/my/badge" } ``` diff --git a/doc/api/group_clusters.md b/doc/api/group_clusters.md index 69b54591d0a..ea7c13637c4 100644 --- a/doc/api/group_clusters.md +++ b/doc/api/group_clusters.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30213) in GitLab 12.1. -Similar to [project-level](../user/project/clusters/index.md) and +Similarly to [project-level](../user/project/clusters/index.md) and [instance-level](../user/instance/clusters/index.md) Kubernetes clusters, group-level Kubernetes clusters allow you to connect a Kubernetes cluster to your group, enabling you to use the same cluster across multiple projects. diff --git a/doc/api/group_level_variables.md b/doc/api/group_level_variables.md index 500d5a60c9c..b548372b02d 100644 --- a/doc/api/group_level_variables.md +++ b/doc/api/group_level_variables.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Verify +group: Continuous Integration info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/group_relations_export.md b/doc/api/group_relations_export.md new file mode 100644 index 00000000000..bb19f7f0923 --- /dev/null +++ b/doc/api/group_relations_export.md @@ -0,0 +1,101 @@ +--- +stage: Manage +group: Import +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + +# Group Relations Export API + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/59978) in GitLab 13.12. + +With the Group Relations Export API, you can partially export group structure. This API is similar +to [group export](group_import_export.md), +but it exports each top-level relation (for example, milestones/boards/labels) as a separate file +instead of one archive. The group relations export API is primarily used in [group migration](../user/group/index.md). + +## Schedule new export + +Start a new group relations export: + +```plaintext +POST /groups/:id/export_relations +``` + +| Attribute | Type | Required | Description | +| --------- | -------------- | -------- | ---------------------------------------- | +| `id` | integer/string | yes | ID of the group owned by the authenticated user. | + +```shell +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/export_relations" +``` + +```json +{ + "message": "202 Accepted" +} +``` + +## Export status + +View the status of the relations export: + +```plaintext +GET /groups/:id/export_relations/status +``` + +| Attribute | Type | Required | Description | +| --------- | -------------- | -------- | ---------------------------------------- | +| `id` | integer/string | yes | ID of the group owned by the authenticated user. | + +```shell +curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/export_relations/status" +``` + +The status can be one of the following: + +- `0`: `started` +- `1`: `finished` +- `-1`: `failed` + +- `0` - `started` +- `1` - `finished` +- `-1` - `failed` + +```json +[ + { + "relation": "badges", + "status": 1, + "error": null, + "updated_at": "2021-05-04T11:25:20.423Z" + }, + { + "relation": "boards", + "status": 1, + "error": null, + "updated_at": "2021-05-04T11:25:20.085Z" + } +] +``` + +## Export download + +Download the finished relations export: + +```plaintext +GET /groups/:id/export_relations/download +``` + +| Attribute | Type | Required | Description | +| --------------- | -------------- | -------- | ---------------------------------------- | +| `id` | integer/string | yes | ID of the group owned by the authenticated user. | +| `relation` | string | yes | Name of the group top-level relation to download. | + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" --remote-header-name --remote-name "https://gitlab.example.com/api/v4/groups/1/export_relations/download?relation=labels" +``` + +```shell +ls labels.ndjson.gz +labels.ndjson.gz +``` diff --git a/doc/api/groups.md b/doc/api/groups.md index 6c01b2cf2a6..cbead18ff90 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -101,7 +101,7 @@ GET /groups?statistics=true "lfs_objects_size" : 123, "job_artifacts_size" : 57, "packages_size": 0, - "snippets_size" : 50, + "snippets_size" : 50 } } ] @@ -756,7 +756,7 @@ Parameters: | `two_factor_grace_period` | integer | no | Time before Two-factor authentication is enforced (in hours). | | `project_creation_level` | string | no | Determine if developers can create projects in the group. Can be `noone` (No one), `maintainer` (Maintainers), or `developer` (Developers + Maintainers). | | `auto_devops_enabled` | boolean | no | Default to Auto DevOps pipeline for all projects within this group. | -| `subgroup_creation_level` | string | no | Allowed to create subgroups. Can be `owner` (Owners), or `maintainer` (Maintainers). | +| `subgroup_creation_level` | string | no | Allowed to [create subgroups](../user/group/subgroups/index.md#creating-a-subgroup). Can be `owner` (Owners), or `maintainer` (Maintainers). | | `emails_disabled` | boolean | no | Disable email notifications | | `avatar` | mixed | no | Image file for avatar of the group. [Introduced in GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/-/issues/36681) | | `mentions_disabled` | boolean | no | Disable the capability of a group from getting mentioned | @@ -830,7 +830,7 @@ PUT /groups/:id | `two_factor_grace_period` | integer | no | Time before Two-factor authentication is enforced (in hours). | | `project_creation_level` | string | no | Determine if developers can create projects in the group. Can be `noone` (No one), `maintainer` (Maintainers), or `developer` (Developers + Maintainers). | | `auto_devops_enabled` | boolean | no | Default to Auto DevOps pipeline for all projects within this group. | -| `subgroup_creation_level` | string | no | Allowed to create subgroups. Can be `owner` (Owners), or `maintainer` (Maintainers). | +| `subgroup_creation_level` | string | no | Allowed to [create subgroups](../user/group/subgroups/index.md#creating-a-subgroup). Can be `owner` (Owners), or `maintainer` (Maintainers). | | `emails_disabled` | boolean | no | Disable email notifications | | `avatar` | mixed | no | Image file for avatar of the group. [Introduced in GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/-/issues/36681) | | `mentions_disabled` | boolean | no | Disable the capability of a group from getting mentioned | @@ -1087,7 +1087,7 @@ POST /groups/:id/hooks | `confidential_note_events` | boolean | no | Trigger hook on confidential note events | | `job_events` | boolean | no | Trigger hook on job events | | `pipeline_events` | boolean | no | Trigger hook on pipeline events | -| `wiki_page_events` | boolean | no | Trigger hook on wiki events | +| `wiki_page_events` | boolean | no | Trigger hook on wiki page events | | `deployment_events` | boolean | no | Trigger hook on deployment events | | `releases_events` | boolean | no | Trigger hook on release events | | `subgroup_events` | boolean | no | Trigger hook on subgroup events | @@ -1116,7 +1116,7 @@ PUT /groups/:id/hooks/:hook_id | `confidential_note_events` | boolean | no | Trigger hook on confidential note events | | `job_events` | boolean | no | Trigger hook on job events | | `pipeline_events` | boolean | no | Trigger hook on pipeline events | -| `wiki_events` | boolean | no | Trigger hook on wiki events | +| `wiki_page_events` | boolean | no | Trigger hook on wiki page events | | `deployment_events` | boolean | no | Trigger hook on deployment events | | `releases_events` | boolean | no | Trigger hook on release events | | `subgroup_events` | boolean | no | Trigger hook on subgroup events | @@ -1257,7 +1257,9 @@ Read more in the [Group Badges](group_badges.md) documentation. ## Group Import/Export -Read more in the [Group Import/Export](group_import_export.md) documentation. +Read more in the [Group Import/Export](group_import_export.md) +and [Group Relations Export](group_relations_export.md) +documentation. ## Share Groups with Groups diff --git a/doc/api/import.md b/doc/api/import.md index 2d978b7b6dd..e1585d02ae3 100644 --- a/doc/api/import.md +++ b/doc/api/import.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Import info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/instance_clusters.md b/doc/api/instance_clusters.md index 99717ba939d..1c4996975f7 100644 --- a/doc/api/instance_clusters.md +++ b/doc/api/instance_clusters.md @@ -84,7 +84,7 @@ Example response: }, "provider_gcp": null, "management_project": null - } + }, { "id": 11, "name": "cluster-3", diff --git a/doc/api/issue_links.md b/doc/api/issue_links.md index db65662c9cf..4dfa9b2f532 100644 --- a/doc/api/issue_links.md +++ b/doc/api/issue_links.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Plan +group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -30,7 +30,7 @@ Parameters: { "id" : 84, "iid" : 14, - "issue_link_id": 1 + "issue_link_id": 1, "project_id" : 4, "created_at" : "2016-01-07T12:44:33.959Z", "title" : "Issues with auth", @@ -51,7 +51,6 @@ Parameters: "description" : null, "updated_at" : "2016-01-07T12:44:33.959Z", "milestone" : null, - "subscribed" : true, "user_notes_count": 0, "due_date": null, "web_url": "http://example.com/example/example/issues/14", @@ -117,7 +116,7 @@ Example response: "due_date": null, "web_url": "http://example.com/example/example/issues/11", "confidential": false, - "weight": null, + "weight": null }, "target_issue" : { "id" : 84, @@ -147,7 +146,7 @@ Example response: "due_date": null, "web_url": "http://example.com/example/example/issues/14", "confidential": false, - "weight": null, + "weight": null }, "link_type": "relates_to" } @@ -198,7 +197,7 @@ DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id "due_date": null, "web_url": "http://example.com/example/example/issues/11", "confidential": false, - "weight": null, + "weight": null }, "target_issue" : { "id" : 84, @@ -228,7 +227,7 @@ DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id "due_date": null, "web_url": "http://example.com/example/example/issues/14", "confidential": false, - "weight": null, + "weight": null }, "link_type": "relates_to" } diff --git a/doc/api/issues.md b/doc/api/issues.md index 23028b44169..acfca50cb5e 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -27,6 +27,8 @@ When requested across groups or projects, it's expected to be the same as the `f ## List issues +> The `weight` property moved to GitLab Premium in 13.9. + Get all issues the authenticated user has access to. By default it returns only issues created by the current user. To get all issues, use parameter `scope=all`. @@ -60,6 +62,7 @@ GET /issues?state=opened | `due_date` | string | no | Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month. Accepts: `0` (no due date), `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`. _(Introduced in [GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/233420))_ | | `iids[]` | integer array | no | Return only the issues having the given `iid` | | `in` | string | no | Modify the scope of the `search` attribute. `title`, `description`, or a string joining them with comma. Default is `title,description` | +| `issue_type` | string | no | Filter to a given type of issue. One of `issue`, `incident`, or `test_case`. _(Introduced in [GitLab 13.12](https://gitlab.com/gitlab-org/gitlab/-/issues/260375))_ | | `iteration_id` **(PREMIUM)** | integer | no | Return issues assigned to the given iteration ID. `None` returns issues that do not belong to an iteration. `Any` returns issues that belong to an iteration. Mutually exclusive with `iteration_title`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)_ | | `iteration_title` **(PREMIUM)** | string | no | Return issues assigned to the iteration with the given title. Similar to `iteration_id` and mutually exclusive with `iteration_id`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)_ | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | @@ -75,7 +78,7 @@ GET /issues?state=opened | `state` | string | no | Return `all` issues or just those that are `opened` or `closed` | | `updated_after` | datetime | no | Return issues updated on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `updated_before` | datetime | no | Return issues updated on or before the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | +| `weight` **(PREMIUM)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `with_labels_details` | boolean | no | If `true`, the response returns more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413)| ```shell @@ -125,6 +128,7 @@ Example response: "avatar_url" : null, "username" : "root" }, + "type" : "ISSUE", "updated_at" : "2016-01-04T15:31:51.081Z", "closed_at" : null, "closed_by" : null, @@ -155,6 +159,7 @@ Example response: "task_status": "10 of 15 tasks completed", "confidential": false, "discussion_locked": false, + "issue_type": "issue", "_links":{ "self":"http://gitlab.example.com/api/v4/projects/1/issues/76", "notes":"http://gitlab.example.com/api/v4/projects/1/issues/76/notes", @@ -169,8 +174,7 @@ Example response: ] ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json [ @@ -183,8 +187,25 @@ the `weight` parameter: ] ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -201,6 +222,10 @@ WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account @@ -208,6 +233,8 @@ that closed the issue still exists. ## List group issues +> The `weight` property moved to GitLab Premium in 13.9. + Get a list of a group's issues. If the group is private, credentials need to be provided for authorization. @@ -242,6 +269,9 @@ GET /groups/:id/issues?state=opened | `due_date` | string | no | Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month. Accepts: `0` (no due date), `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`. _(Introduced in [GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/233420))_ | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `iids[]` | integer array | no | Return only the issues having the given `iid` | +| `issue_type` | string | no | Filter to a given type of issue. One of `issue`, `incident`, or `test_case`. _(Introduced in [GitLab 13.12](https://gitlab.com/gitlab-org/gitlab/-/issues/260375))_ | +| `iteration_id` **(PREMIUM)** | integer | no | Return issues assigned to the given iteration ID. `None` returns issues that do not belong to an iteration. `Any` returns issues that belong to an iteration. Mutually exclusive with `iteration_title`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)_ | +| `iteration_title` **(PREMIUM)** | string | no | Return issues assigned to the iteration with the given title. Similar to `iteration_id` and mutually exclusive with `iteration_id`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)_ | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0)_ | @@ -254,7 +284,7 @@ GET /groups/:id/issues?state=opened | `state` | string | no | Return all issues or just those that are `opened` or `closed` | | `updated_after` | datetime | no | Return issues updated on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `updated_before` | datetime | no | Return issues updated on or before the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | +| `weight` **(PREMIUM)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `with_labels_details` | boolean | no | If `true`, the response returns more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | ```shell @@ -305,6 +335,7 @@ Example response: "id" : 9, "name" : "Dr. Luella Kovacek" }, + "type" : "ISSUE", "labels" : ["foo", "bar"], "upvotes": 4, "downvotes": 0, @@ -333,6 +364,7 @@ Example response: "task_status": "10 of 15 tasks completed", "confidential": false, "discussion_locked": false, + "issue_type": "issue", "_links":{ "self":"http://gitlab.example.com/api/v4/projects/4/issues/41", "notes":"http://gitlab.example.com/api/v4/projects/4/issues/41/notes", @@ -347,8 +379,7 @@ Example response: ] ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json [ @@ -361,8 +392,25 @@ the `weight` parameter: ] ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -378,6 +426,10 @@ the `health_status` parameter: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed @@ -385,6 +437,8 @@ the issue still exists. ## List project issues +> The `weight` property moved to GitLab Premium in 13.9. + Get a list of a project's issues. If the project is private, you need to provide credentials to authorize. @@ -419,6 +473,9 @@ GET /projects/:id/issues?state=opened | `due_date` | string | no | Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month. Accepts: `0` (no due date), `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`. _(Introduced in [GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/233420))_ | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `iids[]` | integer array | no | Return only the issues having the given `iid` | +| `issue_type` | string | no | Filter to a given type of issue. One of `issue`, `incident`, or `test_case`. _(Introduced in [GitLab 13.12](https://gitlab.com/gitlab-org/gitlab/-/issues/260375))_ | +| `iteration_id` **(PREMIUM)** | integer | no | Return issues assigned to the given iteration ID. `None` returns issues that do not belong to an iteration. `Any` returns issues that belong to an iteration. Mutually exclusive with `iteration_title`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)_ | +| `iteration_title` **(PREMIUM)** | string | no | Return issues assigned to the iteration with the given title. Similar to `iteration_id` and mutually exclusive with `iteration_id`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)_ | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0)_ | @@ -430,7 +487,7 @@ GET /projects/:id/issues?state=opened | `state` | string | no | Return all issues or just those that are `opened` or `closed` | | `updated_after` | datetime | no | Return issues updated on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `updated_before` | datetime | no | Return issues updated on or before the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | +| `weight` **(PREMIUM)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `with_labels_details` | boolean | no | If `true`, the response returns more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. `description_html` was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | ```shell @@ -481,6 +538,7 @@ Example response: "id" : 9, "name" : "Dr. Luella Kovacek" }, + "type" : "ISSUE", "labels" : ["foo", "bar"], "upvotes": 4, "downvotes": 0, @@ -516,6 +574,7 @@ Example response: "task_status": "10 of 15 tasks completed", "confidential": false, "discussion_locked": false, + "issue_type": "issue", "_links":{ "self":"http://gitlab.example.com/api/v4/projects/4/issues/41", "notes":"http://gitlab.example.com/api/v4/projects/4/issues/41/notes", @@ -530,8 +589,7 @@ Example response: ] ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json [ @@ -544,8 +602,25 @@ the `weight` parameter: ] ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -561,6 +636,10 @@ the `health_status` parameter: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. @@ -587,83 +666,81 @@ Example response: ```json { - "id" : 1, - "milestone" : { - "due_date" : null, - "project_id" : 4, - "state" : "closed", - "description" : "Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.", - "iid" : 3, - "id" : 11, - "title" : "v3.0", - "created_at" : "2016-01-04T15:31:39.788Z", - "updated_at" : "2016-01-04T15:31:39.788Z", - "closed_at" : "2016-01-05T15:31:46.176Z" - }, - "author" : { - "state" : "active", - "web_url" : "https://gitlab.example.com/root", - "avatar_url" : null, - "username" : "root", - "id" : 1, - "name" : "Administrator" - }, - "description" : "Omnis vero earum sunt corporis dolor et placeat.", - "state" : "closed", - "iid" : 1, - "assignees" : [{ - "avatar_url" : null, - "web_url" : "https://gitlab.example.com/lennie", - "state" : "active", - "username" : "lennie", - "id" : 9, - "name" : "Dr. Luella Kovacek" - }], - "assignee" : { - "avatar_url" : null, - "web_url" : "https://gitlab.example.com/lennie", - "state" : "active", - "username" : "lennie", - "id" : 9, - "name" : "Dr. Luella Kovacek" - }, - "labels" : [], - "upvotes": 4, - "downvotes": 0, - "merge_requests_count": 0, - "title" : "Ut commodi ullam eos dolores perferendis nihil sunt.", - "updated_at" : "2016-01-04T15:31:46.176Z", - "created_at" : "2016-01-04T15:31:46.176Z", - "closed_at" : null, - "closed_by" : null, - "subscribed": false, - "user_notes_count": 1, - "due_date": null, - "web_url": "http://example.com/my-group/my-project/issues/1", - "references": { - "short": "#1", - "relative": "#1", - "full": "my-group/my-project#1" - }, - "time_stats": { - "time_estimate": 0, - "total_time_spent": 0, - "human_time_estimate": null, - "human_total_time_spent": null - }, - "confidential": false, - "discussion_locked": false, - "_links": { - "self": "http://example.com/api/v4/projects/1/issues/2", - "notes": "http://example.com/api/v4/projects/1/issues/2/notes", - "award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji", - "project": "http://example.com/api/v4/projects/1" - }, - "task_completion_status":{ - "count":0, - "completed_count":0 - }, - "weight": null, + "id": 1, + "milestone": { + "due_date": null, + "project_id": 4, + "state": "closed", + "description": "Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.", + "iid": 3, + "id": 11, + "title": "v3.0", + "created_at": "2016-01-04T15:31:39.788Z", + "updated_at": "2016-01-04T15:31:39.788Z", + "closed_at": "2016-01-05T15:31:46.176Z" + }, + "author": { + "state": "active", + "web_url": "https://gitlab.example.com/root", + "avatar_url": null, + "username": "root", + "id": 1, + "name": "Administrator" + }, + "description": "Omnis vero earum sunt corporis dolor et placeat.", + "state": "closed", + "iid": 1, + "assignees": [ + { + "avatar_url": null, + "web_url": "https://gitlab.example.com/lennie", + "state": "active", + "username": "lennie", + "id": 9, + "name": "Dr. Luella Kovacek" + } + ], + "assignee": { + "avatar_url": null, + "web_url": "https://gitlab.example.com/lennie", + "state": "active", + "username": "lennie", + "id": 9, + "name": "Dr. Luella Kovacek" + }, + "type": "ISSUE", + "labels": [], + "upvotes": 4, + "downvotes": 0, + "merge_requests_count": 0, + "title": "Ut commodi ullam eos dolores perferendis nihil sunt.", + "updated_at": "2016-01-04T15:31:46.176Z", + "created_at": "2016-01-04T15:31:46.176Z", + "closed_at": null, + "closed_by": null, + "subscribed": false, + "user_notes_count": 1, + "due_date": null, + "web_url": "http://example.com/my-group/my-project/issues/1", + "references": { + "short": "#1", + "relative": "#1", + "full": "my-group/my-project#1" + }, + "time_stats": { + "time_estimate": 0, + "total_time_spent": 0, + "human_time_estimate": null, + "human_total_time_spent": null + }, + "confidential": false, + "discussion_locked": false, + "issue_type": "issue", + "task_completion_status": { + "count": 0, + "completed_count": 0 + }, + "weight": null, "has_tasks": false, "_links": { "self": "http://gitlab.example:3000/api/v4/projects/1/issues/1", @@ -671,21 +748,12 @@ Example response: "award_emoji": "http://gitlab.example:3000/api/v4/projects/1/issues/1/award_emoji", "project": "http://gitlab.example:3000/api/v4/projects/1" }, - "references": { - "short": "#1", - "relative": "#1", - "full": "gitlab-org/gitlab-test#1" - }, - "subscribed": true, "moved_to_id": null, - "service_desk_reply_to": "service.desk@gitlab.com", - "epic_iid": null, - "epic": null + "service_desk_reply_to": "service.desk@gitlab.com" } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -696,10 +764,9 @@ the `weight` parameter: } ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `epic` property: +Issues created by users on GitLab Premium or higher include the `epic` property: -```javascript +```json { "project_id" : 4, "description" : "Omnis vero earum sunt corporis dolor et placeat.", @@ -712,10 +779,24 @@ the `epic` property: "url" : "/groups/h5bp/-/epics/5", "group_id": 8 }, - // ... + ... } ``` +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` +property: + +```json +[ + { + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "health_status": "on_track", + ... + } +] +``` + WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. @@ -793,6 +874,7 @@ Example response: "id" : 9, "name" : "Dr. Luella Kovacek" }, + "type" : "ISSUE", "labels" : [], "upvotes": 4, "downvotes": 0, @@ -820,6 +902,7 @@ Example response: }, "confidential": false, "discussion_locked": false, + "issue_type": "issue", "_links": { "self": "http://gitlab.example.com/api/v4/projects/1/issues/2", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes", @@ -833,8 +916,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -845,10 +927,9 @@ the `weight` parameter: } ``` -Users of [GitLab Premium](https://about.gitlab.com/pricing/) can also see -the `epic` property: +Issues created by users on GitLab Premium or higher include the `epic` property: -```javascript +```json { "project_id" : 4, "description" : "Omnis vero earum sunt corporis dolor et placeat.", @@ -860,7 +941,7 @@ the `epic` property: "url" : "/groups/h5bp/-/epics/5", "group_id": 8 }, - // ... + ... } ``` @@ -891,6 +972,8 @@ the issue still exists. ## New issue +> The `weight` property moved to GitLab Premium in 13.9. + Creates a new project issue. ```plaintext @@ -899,7 +982,8 @@ POST /projects/:id/issues | Attribute | Type | Required | Description | |-------------------------------------------|----------------|----------|--------------| -| `assignee_ids` | integer array | no | The ID of the user(s) to assign the issue to. | +| `assignee_id` | integer | no | The ID of the user to assign the issue to. Only appears on GitLab Free. | +| `assignee_ids` **(PREMIUM)** | integer array | no | The IDs of the users to assign the issue to. | | `confidential` | boolean | no | Set an issue to be confidential. Default is `false`. | | `created_at` | string | no | When the issue was created. Date time string, ISO 8601 formatted, for example `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | | `description` | string | no | The description of an issue. Limited to 1,048,576 characters. | @@ -909,11 +993,12 @@ POST /projects/:id/issues | `epic_iid` **(PREMIUM)** | integer | no | IID of the epic to add the issue to. Valid values are greater than or equal to 0. (deprecated, [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157)) | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `iid` | integer/string | no | The internal ID of the project's issue (requires administrator or project owner rights) | +| `issue_type` | string | no | The type of issue. One of `issue`, `incident`, or `test_case`. Default is `issue`. | | `labels` | string | no | Comma-separated label names for an issue | | `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This fills out the issue with a default description and mark all discussions as resolved. When passing a description or title, these values take precedence over the default values.| | `milestone_id` | integer | no | The global ID of a milestone to assign issue | | `title` | string | yes | The title of an issue | -| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. | +| `weight` **(PREMIUM)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues?title=Issues%20with%20auth&labels=bug" @@ -931,6 +1016,7 @@ Example response: "state" : "opened", "assignees" : [], "assignee" : null, + "type" : "ISSUE", "labels" : [ "bug" ], @@ -967,6 +1053,7 @@ Example response: }, "confidential": false, "discussion_locked": false, + "issue_type": "issue", "_links": { "self": "http://gitlab.example.com/api/v4/projects/1/issues/2", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes", @@ -980,8 +1067,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -992,8 +1078,25 @@ the `weight` parameter: } ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -1009,6 +1112,10 @@ the `health_status` parameter: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. @@ -1020,6 +1127,8 @@ See [Issues rate limits](../user/admin_area/settings/rate_limit_on_issues_creati ## Edit issue +> The `weight` property moved to GitLab Premium in 13.9. + Updates an existing project issue. This call is also used to mark an issue as closed. @@ -1032,6 +1141,7 @@ At least one of the following parameters is required for the request to be succe - `:description` - `:discussion_locked` - `:due_date` +- `:issue_type` - `:labels` - `:milestone_id` - `:state_event` @@ -1053,13 +1163,14 @@ PUT /projects/:id/issues/:issue_iid | `epic_iid` **(PREMIUM)** | integer | no | IID of the epic to add the issue to. Valid values are greater than or equal to 0. (deprecated, [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157)) | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `issue_iid` | integer | yes | The internal ID of a project's issue | +| `issue_type` | string | no | Updates the type of issue. One of `issue`, `incident`, or `test_case`. | | `labels` | string | no | Comma-separated label names for an issue. Set to an empty string to unassign all labels. | | `milestone_id` | integer | no | The global ID of a milestone to assign the issue to. Set to `0` or provide an empty value to unassign a milestone.| | `remove_labels`| string | no | Comma-separated label names to remove from an issue. | | `state_event` | string | no | The state event of an issue. Set `close` to close the issue and `reopen` to reopen it | | `title` | string | no | The title of an issue | | `updated_at` | string | no | When the issue was updated. Date time string, ISO 8601 formatted, for example `2016-03-11T03:45:40Z` (requires administrator or project owner rights). Empty string or null values are not accepted.| -| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 | +| `weight` **(PREMIUM)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 | ```shell curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues/85?state_event=close" @@ -1120,6 +1231,7 @@ Example response: }, "confidential": false, "discussion_locked": false, + "issue_type": "issue", "_links": { "self": "http://gitlab.example.com/api/v4/projects/1/issues/2", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes", @@ -1133,8 +1245,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -1145,8 +1256,25 @@ the `weight` parameter: } ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -1164,6 +1292,10 @@ The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/git the issue still exists. WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + +WARNING: `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. ## Delete an issue @@ -1262,6 +1394,7 @@ Example response: "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }, + "type" : "ISSUE", "author": { "name": "Kris Steuber", "username": "solon.cremin", @@ -1285,6 +1418,7 @@ Example response: }, "confidential": false, "discussion_locked": false, + "issue_type": "issue", "_links": { "self": "http://gitlab.example.com/api/v4/projects/1/issues/2", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes", @@ -1298,8 +1432,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -1310,8 +1443,25 @@ the `weight` parameter: } ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -1327,6 +1477,10 @@ the `health_status` parameter: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. @@ -1385,6 +1539,7 @@ Example response: "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }, + "type" : "ISSUE", "author": { "name": "Kris Steuber", "username": "solon.cremin", @@ -1408,6 +1563,7 @@ Example response: }, "confidential": false, "discussion_locked": false, + "issue_type": "issue", "_links": { "self": "http://gitlab.example.com/api/v4/projects/1/issues/2", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes", @@ -1421,8 +1577,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -1433,9 +1588,44 @@ the `weight` parameter: } ``` +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: + +```json +[ + { + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "health_status": "on_track", + ... + } +] +``` + WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. @@ -1484,6 +1674,7 @@ Example response: "avatar_url": "http://www.gravatar.com/avatar/3e6f06a86cf27fa8b56f3f74f7615987?s=80&d=identicon", "web_url": "https://gitlab.example.com/keyon" }, + "type" : "ISSUE", "closed_at": null, "closed_by": null, "author": { @@ -1504,6 +1695,7 @@ Example response: }, "confidential": false, "discussion_locked": false, + "issue_type": "issue", "task_completion_status":{ "count":0, "completed_count":0 @@ -1589,6 +1781,7 @@ Example response: "avatar_url": "http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon", "web_url": "https://gitlab.example.com/francisca" }, + "type" : "ISSUE", "author": { "name": "Maxie Medhurst", "username": "craig_rutherford", @@ -1611,6 +1804,7 @@ Example response: }, "confidential": false, "discussion_locked": false, + "issue_type": "issue", "task_completion_status":{ "count":0, "completed_count":0 @@ -1836,7 +2030,7 @@ If the project is private or the issue is confidential, you need to provide cred The preferred way to do this, is by using [personal access tokens](../user/profile/personal_access_tokens.md). ```plaintext -GET /projects/:id/issues/:issue_id/related_merge_requests +GET /projects/:id/issues/:issue_iid/related_merge_requests ``` | Attribute | Type | Required | Description | diff --git a/doc/api/issues_statistics.md b/doc/api/issues_statistics.md index 20f405774d5..de5f26141f5 100644 --- a/doc/api/issues_statistics.md +++ b/doc/api/issues_statistics.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Plan +group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/jobs.md b/doc/api/jobs.md index 78af6b881aa..6647b53bcb4 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -43,6 +43,7 @@ Example of response "started_at": "2015-12-24T17:54:27.722Z", "finished_at": "2015-12-24T17:54:27.895Z", "duration": 0.173, + "queued_duration": 0.010, "artifacts_file": { "filename": "artifacts.zip", "size": 1000 @@ -67,7 +68,6 @@ Example of response "status": "pending" }, "ref": "master", - "artifacts": [], "runner": null, "stage": "test", "status": "failed", @@ -107,6 +107,7 @@ Example of response "started_at": "2015-12-24T17:54:24.729Z", "finished_at": "2015-12-24T17:54:24.921Z", "duration": 0.192, + "queued_duration": 0.023, "artifacts_expire_at": "2016-01-23T17:54:24.921Z", "tag_list": [ "docker runner", "win10-2004" @@ -159,7 +160,7 @@ GET /projects/:id/pipelines/:pipeline_id/jobs | Attribute | Type | Required | Description | |-------------------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `pipeline_id` | integer | yes | ID of a pipeline. | +| `pipeline_id` | integer | yes | ID of a pipeline. Can also be obtained in CI jobs via the [predefined CI variable](../ci/variables/predefined_variables.md) `CI_PIPELINE_ID`. | | `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. | | `include_retried` | boolean | no | Include retried jobs in the response. Defaults to `false`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/272627) in GitLab 13.9. | @@ -187,6 +188,7 @@ Example of response "started_at": "2015-12-24T17:54:24.729Z", "finished_at": "2015-12-24T17:54:24.921Z", "duration": 0.192, + "queued_duration": 0.023, "artifacts_expire_at": "2016-01-23T17:54:24.921Z", "tag_list": [ "docker runner", "ubuntu18" @@ -241,6 +243,7 @@ Example of response "started_at": "2015-12-24T17:54:27.722Z", "finished_at": "2015-12-24T17:54:27.895Z", "duration": 0.173, + "queued_duration": 0.023, "artifacts_file": { "filename": "artifacts.zip", "size": 1000 @@ -339,6 +342,7 @@ Example of response "started_at": "2015-12-24T17:54:27.722Z", "finished_at": "2015-12-24T17:58:27.895Z", "duration": 240, + "queued_duration": 0.123, "id": 7, "name": "teaspoon", "pipeline": { @@ -422,6 +426,7 @@ Example of response "started_at": "2015-12-24T17:54:30.733Z", "finished_at": "2015-12-24T17:54:31.198Z", "duration": 0.465, + "queued_duration": 0.123, "artifacts_expire_at": "2016-01-23T17:54:31.198Z", "id": 8, "name": "rubocop", @@ -575,6 +580,7 @@ Example of response "started_at": "2015-12-24T17:54:30.733Z", "finished_at": "2015-12-24T17:54:31.198Z", "duration": 0.465, + "queued_duration": 0.010, "artifacts_expire_at": "2016-01-23T17:54:31.198Z", "tag_list": [ "docker runner", "macos-10.15" @@ -675,6 +681,7 @@ Example of response "started_at": "2016-01-11T10:14:09.526Z", "finished_at": null, "duration": 8, + "queued_duration": 0.010, "id": 42, "name": "rubocop", "ref": "master", @@ -724,6 +731,7 @@ Example of response "started_at": null, "finished_at": null, "duration": null, + "queued_duration": 0.010, "id": 42, "name": "rubocop", "ref": "master", @@ -784,6 +792,7 @@ Example of response "started_at": "2016-01-11T10:13:33.506Z", "finished_at": "2016-01-11T10:15:10.506Z", "duration": 97.0, + "queued_duration": 0.010, "status": "failed", "tag": false, "web_url": "https://example.com/foo/bar/-/jobs/42", @@ -827,13 +836,14 @@ Example of response "started_at": null, "finished_at": null, "duration": null, + "queued_duration": 0.010, "id": 42, "name": "rubocop", "ref": "master", "artifacts": [], "runner": null, "stage": "test", - "status": "started", + "status": "pending", "tag": false, "web_url": "https://example.com/foo/bar/-/jobs/42", "user": null diff --git a/doc/api/keys.md b/doc/api/keys.md index 98159bcf027..99c9745d8f2 100644 --- a/doc/api/keys.md +++ b/doc/api/keys.md @@ -31,7 +31,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a "title": "Sample key 25", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt1256k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", "created_at": "2015-09-03T07:24:44.627Z", - "expires_at": "2020-05-05T00:00:00.000Z" + "expires_at": "2020-05-05T00:00:00.000Z", "user": { "name": "John Smith", "username": "john_smith", @@ -59,7 +59,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a "identities": [], "can_create_group": true, "can_create_project": true, - "two_factor_enabled": false + "two_factor_enabled": false, "external": false, "private_profile": null } @@ -100,7 +100,7 @@ Example response: "title": "Sample key 1", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt1016k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", "created_at": "2019-11-14T15:11:13.222Z", - "expires_at": "2020-05-05T00:00:00.000Z" + "expires_at": "2020-05-05T00:00:00.000Z", "user": { "id": 1, "name": "Administrator", diff --git a/doc/api/labels.md b/doc/api/labels.md index 963d320a384..a9f2698a270 100644 --- a/doc/api/labels.md +++ b/doc/api/labels.md @@ -46,7 +46,8 @@ Example response: "open_merge_requests_count": 1, "subscribed": false, "priority": 10, - "is_project_label": true + "is_project_label": true, + "remove_on_close": false }, { "id" : 4, @@ -60,7 +61,8 @@ Example response: "open_merge_requests_count": 0, "subscribed": false, "priority": null, - "is_project_label": true + "is_project_label": true, + "remove_on_close": false }, { "id" : 7, @@ -74,7 +76,8 @@ Example response: "open_merge_requests_count": 1, "subscribed": false, "priority": null, - "is_project_label": true + "is_project_label": true, + "remove_on_close": true }, { "id" : 8, @@ -88,7 +91,8 @@ Example response: "open_merge_requests_count": 2, "subscribed": false, "priority": null, - "is_project_label": false + "is_project_label": false, + "remove_on_close": false }, { "id" : 9, @@ -102,7 +106,8 @@ Example response: "open_merge_requests_count": 1, "subscribed": true, "priority": null, - "is_project_label": true + "is_project_label": true, + "remove_on_close": false } ] ``` @@ -140,7 +145,8 @@ Example response: "open_merge_requests_count": 1, "subscribed": false, "priority": 10, - "is_project_label": true + "is_project_label": true, + "remove_on_close": true } ``` @@ -159,6 +165,7 @@ POST /projects/:id/labels | `color` | string | yes | The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the [CSS color names](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Color_keywords) | | `description` | string | no | The description of the label | | `priority` | integer | no | The priority of the label. Must be greater or equal than zero or `null` to remove the priority. | +| `remove_on_close` | boolean | no | Whether the label should be removed from an issue when the issue is closed. _([Introduced in GitLab 13.12](https://gitlab.com/gitlab-org/gitlab/-/issues/17461))_ | ```shell curl --data "name=feature&color=#5843AD" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels" @@ -179,7 +186,8 @@ Example response: "open_merge_requests_count": 0, "subscribed": false, "priority": null, - "is_project_label": true + "is_project_label": true, + "remove_on_close": true } ``` @@ -220,6 +228,7 @@ PUT /projects/:id/labels/:label_id | `color` | string | yes if `new_name` is not provided | The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the [CSS color names](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Color_keywords) | | `description` | string | no | The new description of the label | | `priority` | integer | no | The new priority of the label. Must be greater or equal than zero or `null` to remove the priority. | +| `remove_on_close` | boolean | no | Boolean option specifying whether the label should be removed from issues when they are closed. | ```shell curl --request PUT --data "new_name=docs&color=#8E44AD&description=Documentation" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/documentation" @@ -240,7 +249,8 @@ Example response: "open_merge_requests_count": 2, "subscribed": false, "priority": null, - "is_project_label": true + "is_project_label": true, + "remove_on_close": true } ``` @@ -281,7 +291,8 @@ Example response: "open_issues_count": 1, "closed_issues_count": 0, "open_merge_requests_count": 2, - "subscribed": false + "subscribed": false, + "remove_on_close": true } ``` @@ -322,7 +333,8 @@ Example response: "open_merge_requests_count": 1, "subscribed": true, "priority": null, - "is_project_label": true + "is_project_label": true, + "remove_on_close": true } ``` diff --git a/doc/api/license.md b/doc/api/license.md index 7aa00335933..b69a5e81ea6 100644 --- a/doc/api/license.md +++ b/doc/api/license.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Growth +group: Activation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -80,7 +80,7 @@ GET /licenses "Name": "Doe John" }, "add_ons": { - "GitLab_FileLocks": 1, + "GitLab_FileLocks": 1 } } ] diff --git a/doc/api/managed_licenses.md b/doc/api/managed_licenses.md index d0944aefd64..68a19b9912f 100644 --- a/doc/api/managed_licenses.md +++ b/doc/api/managed_licenses.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Growth +group: Activation info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/members.md b/doc/api/members.md index adfe2df8f30..2a70e35b287 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -136,7 +136,7 @@ Example response: "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "web_url": "http://192.168.1.8:3000/root", "expires_at": "2012-10-22T14:13:35Z", - "access_level": 30 + "access_level": 30, "email": "john@example.com", "group_saml_identity": { "extern_uid":"ABC-1234567890", @@ -288,7 +288,9 @@ Example response: "state": "active", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "web_url": "http://192.168.1.8:3000/root", - "last_activity_on": "2021-01-27" + "last_activity_on": "2021-01-27", + "membership_type": "group_member", + "removable": true }, { "id": 2, @@ -298,7 +300,9 @@ Example response: "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "web_url": "http://192.168.1.8:3000/root", "email": "john@example.com", - "last_activity_on": "2021-01-25" + "last_activity_on": "2021-01-25", + "membership_type": "group_member", + "removable": true }, { "id": 3, @@ -307,7 +311,9 @@ Example response: "state": "active", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "web_url": "http://192.168.1.8:3000/root", - "last_activity_on": "2021-01-20" + "last_activity_on": "2021-01-20", + "membership_type": "group_invite", + "removable": false } ] ``` diff --git a/doc/api/merge_request_approvals.md b/doc/api/merge_request_approvals.md index be973518d89..978cbff625c 100644 --- a/doc/api/merge_request_approvals.md +++ b/doc/api/merge_request_approvals.md @@ -8,7 +8,7 @@ type: reference, api # Merge request approvals API **(PREMIUM)** Configuration for -[approvals on all merge requests](../user/project/merge_requests/merge_request_approvals.md) +[approvals on all merge requests](../user/project/merge_requests/approvals/index.md) in the project. Must be authenticated for all endpoints. ## Project-level MR approvals @@ -664,7 +664,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/approvals "web_url": "http://localhost:3000/root" } } - ], + ] } ``` @@ -1068,7 +1068,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/approve | `id` | integer | yes | The ID of a project | | `merge_request_iid` | integer | yes | The IID of MR | | `sha` | string | no | The HEAD of the MR | -| `approval_password` **(PREMIUM)** | string | no | Current user's password. Required if [**Require user password to approve**](../user/project/merge_requests/merge_request_approvals.md#require-authentication-when-approving-a-merge-request) is enabled in the project settings. | +| `approval_password` **(PREMIUM)** | string | no | Current user's password. Required if [**Require user password to approve**](../user/project/merge_requests/approvals/settings.md#require-authentication-for-approvals) is enabled in the project settings. | The `sha` parameter works in the same way as when [accepting a merge request](merge_requests.md#accept-mr): if it is passed, then it must @@ -1109,7 +1109,7 @@ does not match, the response code is `409`. "web_url": "http://localhost:3000/ryley" } } - ], + ] } ``` diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index d28c7d8e8a7..c4cb7753fc9 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -457,7 +457,7 @@ Parameters: | `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5)_. | | `author_username` | string | no | Returns merge requests created by the given `username`. Mutually exclusive with `author_id`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 12.10)_. | | `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5)_. | -| `approver_ids` **(PREMIUM))** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | +| `approver_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | | `approved_by_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | | `reviewer_id` | integer | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`. | | `reviewer_username` | string | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. | @@ -2319,7 +2319,7 @@ Example response: "short": "!1", "relative": "!1", "full": "my-group/my-project!1" - }, + } }, "target_url": "https://gitlab.example.com/gitlab-org/gitlab-ci/merge_requests/7", "body": "Et voluptas laudantium minus nihil recusandae ut accusamus earum aut non.", diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index c3e88532430..50b28e67c0a 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/notes.md b/doc/api/notes.md index 8a443d57682..0fb13e56f78 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -4,7 +4,7 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Notes API +# Notes API **(FREE)** Notes are comments on: @@ -19,15 +19,15 @@ assignee changes, GitLab posts a system note). ## Resource events > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/38096) in GitLab 13.3 for state, milestone, and weight events. -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/40850) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.4 for iteration events. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/40850) in GitLab 13.4 for iteration events. Some system notes are not part of this API, but are recorded as separate events: - [Resource label events](resource_label_events.md) - [Resource state events](resource_state_events.md) - [Resource milestone events](resource_milestone_events.md) -- [Resource weight events](resource_weight_events.md) **(STARTER)** -- [Resource iteration events](resource_iteration_events.md) **(STARTER)** +- [Resource weight events](resource_weight_events.md) +- [Resource iteration events](resource_iteration_events.md) ## Notes pagination @@ -507,7 +507,7 @@ Parameters: | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | ```shell -curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note" +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/11/notes?body=note" ``` ### Modify existing epic note @@ -528,7 +528,7 @@ Parameters: | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | ```shell -curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note" +curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/11/notes?body=note" ``` ### Delete an epic note diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index 57eac61de46..298c0ead8c1 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Plan +group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -176,7 +176,9 @@ Example responses: { "level": "watch" } +``` +```json { "level": "custom", "events": { diff --git a/doc/api/oauth2.md b/doc/api/oauth2.md index 2bcf86a031c..dfb91283b50 100644 --- a/doc/api/oauth2.md +++ b/doc/api/oauth2.md @@ -41,7 +41,7 @@ how all those flows work and pick the right one for your use case. Both **authorization code** (with or without PKCE) and **implicit grant** flows require `application` to be registered first via the `/profile/applications` page in your user's account. During registration, by enabling proper scopes, you can limit the range of -resources which the `application` can access. Upon creation, you'll obtain the +resources which the `application` can access. Upon creation, you obtain the `application` credentials: _Application ID_ and _Client Secret_ - **keep them secure**. ### Prevent CSRF attacks @@ -63,7 +63,7 @@ and the [OAuth 2.0 Threat Model RFC](https://tools.ietf.org/html/rfc6819#section These factors are particularly important when using the [Implicit grant flow](#implicit-grant-flow), where actual credentials are included in the `redirect_uri`. -In the following sections you will find detailed instructions on how to obtain +In the following sections you can find detailed instructions on how to obtain authorization with each flow. ### Authorization code with Proof Key for Code Exchange (PKCE) @@ -213,12 +213,12 @@ To request the access token, you should redirect the user to the https://gitlab.example.com/oauth/authorize?client_id=APP_ID&redirect_uri=REDIRECT_URI&response_type=token&state=YOUR_UNIQUE_STATE_HASH&scope=REQUESTED_SCOPES ``` -This will ask the user to approve the applications access to their account +This prompts the user to approve the applications access to their account based on the scopes specified in `REQUESTED_SCOPES` and then redirect back to the `REDIRECT_URI` you provided. The [scope parameter](https://github.com/doorkeeper-gem/doorkeeper/wiki/Using-Scopes#requesting-particular-scopes) is a space separated list of scopes you want to have access to (e.g. `scope=read_user+profile` would request `read_user` and `profile` scopes). The redirect -will include a fragment with `access_token` as well as token details in GET +includes a fragment with `access_token` as well as token details in GET parameters, for example: ```plaintext @@ -285,7 +285,7 @@ echo 'grant_type=password&username=<your_username>&password=<your_password>' > a curl --data "@auth.txt" --user client_id:client_secret --request POST "https://gitlab.example.com/oauth/token" ``` -Then, you'll receive the access token back in the response: +Then, you receive a response containing the access token: ```json { @@ -358,7 +358,7 @@ The fields `scopes` and `expires_in_seconds` are included in the response. These are aliases for `scope` and `expires_in` respectively, and have been included to prevent breaking changes introduced in [doorkeeper 5.0.2](https://github.com/doorkeeper-gem/doorkeeper/wiki/Migration-from-old-versions#from-4x-to-5x). -Don't rely on these fields as they will be removed in a later release. +Don't rely on these fields as they are slated for removal in a later release. ## OAuth2 tokens and GitLab registries diff --git a/doc/api/openapi/openapi.yaml b/doc/api/openapi/openapi.yaml index 1a80daf304c..46267129b32 100644 --- a/doc/api/openapi/openapi.yaml +++ b/doc/api/openapi/openapi.yaml @@ -4,6 +4,8 @@ tags: description: Version - name: access_requests description: Access requests for projects and groups + - name: access_tokens + description: Access tokens for projects info: description: | An OpenAPI definition for the GitLab REST API. @@ -16,7 +18,8 @@ info: The feature uses the current [GitLab session cookie](https://docs.gitlab.com/ee/api/README.html#session-cookie), so each request is made using your account. - Read more at <https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html>. + Instructions for using this tool can be found in [Interactive API Documentation](openapi_interactive.md). + version: v4 title: GitLab API termsOfService: 'https://about.gitlab.com/terms/' @@ -57,6 +60,12 @@ paths: /v4/groups/{id}/access_requests/{user_id}/approve: $ref: 'v4/access_requests.yaml#/accessRequestsGroupsApprove' - /v4/groupss/{id}/access_requests/{user_id}: + /v4/groups/{id}/access_requests/{user_id}: $ref: 'v4/access_requests.yaml#/accessRequestsGroupsDeny' + # ACCESS REQUESTS (PROJECTS) + /v4/projects/{id}/access_tokens: + $ref: 'v4/access_tokens.yaml#/accessTokens' + + /v4/projects/{id}/access_tokens/{token_id}: + $ref: 'v4/access_tokens.yaml#/accessTokensRevoke'
\ No newline at end of file diff --git a/doc/api/openapi/openapi_interactive.md b/doc/api/openapi/openapi_interactive.md index e34b003e32c..05fd7b20b75 100644 --- a/doc/api/openapi/openapi_interactive.md +++ b/doc/api/openapi/openapi_interactive.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/openapi/v4/access_tokens.yaml b/doc/api/openapi/v4/access_tokens.yaml new file mode 100644 index 00000000000..9a1a6960eea --- /dev/null +++ b/doc/api/openapi/v4/access_tokens.yaml @@ -0,0 +1,170 @@ +# Markdown documentation: https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/resource_access_tokens.md + +#/v4/projects/{id}/access_tokens +accessTokens: + get: + description: Lists access tokens for a project + summary: List access tokens for a project + operationId: accessTokens_get + tags: + - access_tokens + parameters: + - name: id + in: path + description: The ID or URL-encoded path of the project + required: true + schema: + oneOf: + - type: integer + - type: string + responses: + '404': + description: Not Found + '401': + description: Unauthorized operation + '200': + description: Successful operation + content: + application/json: + schema: + title: AccessTokenList + type: object + properties: + user_id: + type: integer + scopes: + type: array + name: + type: string + expires_at: + type: date + id: + type: integer + active: + type: boolean + created_at: + type: date + revoked: + type: boolean + example: + "user_id": 141 + "scopes" : ["api"] + "name": "token" + "expires_at": "2022-01-31" + "id": 42 + "active": true + "created_at": "2021-01-20T14:13:35Z" + "revoked" : false + post: + description: Creates an access token for a project + summary: Creates an access token for a project + operationId: accessTokens_post + tags: + - access_tokens + parameters: + - name: id + in: path + description: The ID or URL-encoded path of the project + required: true + schema: + oneOf: + - type: integer + - type: string + - name: name + in: query + description: The name of the project access token + required: true + schema: + type: string + - name: scopes + in: query + description: Defines read and write permissions for the token + required: true + schema: + type: array + items: + type: string + enum: ["api", "read_api", "read_registry", "write_registry", "read_repository", "write_repository"] + - name: expires_at + in: query + description: Date when the token expires. Time of day is Midnight UTC of that date. + required: false + schema: + type: date + responses: + '404': + description: Not Found + '401': + description: Unauthorized operation + '200': + description: Successful operation + content: + application/json: + schema: + title: AccessTokenList + type: object + properties: + user_id: + type: integer + scopes: + type: array + name: + type: string + expires_at: + type: date + id: + type: integer + active: + type: boolean + created_at: + type: date + revoked: + type: boolean + token: + type: string + example: + "user_id": 166 + "scopes" : [ + "api", + "read_repository" + ] + "name": "test" + "expires_at": "2022-01-31" + "id": 58 + "active": true + "created_at": "2021-01-20T14:13:35Z" + "revoked" : false + "token" : "D4y...Wzr" + +#/v4/projects/{id}/access_tokens/{token_id} +accessTokensRevoke: + delete: + description: Revokes an access token + summary: Revokes an access token + operationId: accessTokens_delete + tags: + - access_tokens + parameters: + - name: id + in: path + description: The ID or URL-encoded path of the project + required: true + schema: + oneOf: + - type: integer + - type: string + - name: token_id + in: path + description: The ID of the project access token + required: true + schema: + oneOf: + - type: integer + - type: string + responses: + '400': + description: Bad Request + '404': + description: Not Found + '204': + description: No content if successfully revoked diff --git a/doc/api/packages.md b/doc/api/packages.md index 112c7ef2e61..c257105f72e 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -287,6 +287,7 @@ Example response: "size": 2421, "file_md5": "58e6a45a629910c6ff99145a688971ac", "file_sha1": "ebd193463d3915d7e22219f52740056dfd26cbfe", + "file_sha256": "a903393463d3915d7e22219f52740056dfd26cbfeff321b", "pipelines": [ { "id": 123, @@ -310,7 +311,8 @@ Example response: "file_name": "my-app-1.5-20181107.152550-1.pom", "size": 1122, "file_md5": "d90f11d851e17c5513586b4a7e98f1b2", - "file_sha1": "9608d068fe88aff85781811a42f32d97feb440b5" + "file_sha1": "9608d068fe88aff85781811a42f32d97feb440b5", + "file_sha256": "2987d068fe88aff85781811a42f32d97feb4f092a399" }, { "id": 27, @@ -319,7 +321,8 @@ Example response: "file_name": "maven-metadata.xml", "size": 767, "file_md5": "6dfd0cce1203145a927fef5e3a1c650c", - "file_sha1": "d25932de56052d320a8ac156f745ece73f6a8cd2" + "file_sha1": "d25932de56052d320a8ac156f745ece73f6a8cd2", + "file_sha256": "ac849d002e56052d320a8ac156f745ece73f6a8cd2f3e82" } ] ``` @@ -349,3 +352,33 @@ Can return the following status codes: - `204 No Content`, if the package was deleted successfully. - `404 Not Found`, if the package was not found. + +## Delete a package file + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32107) in GitLab 13.12. + +WARNING: +Deleting a package file may corrupt your package making it unusable or unpullable from your package +manager client. When deleting a package file, be sure that you understand what you're doing. + +Delete a package file: + +```plaintext +DELETE /projects/:id/packages/:package_id/package_files/:package_file_id +``` + +| Attribute | Type | Required | Description | +| ----------------- | -------------- | -------- | ----------- | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | +| `package_id` | integer | yes | ID of a package. | +| `package_file_id` | integer | yes | ID of a package file. | + +```shell +curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id/package_files/:package_file_id" +``` + +Can return the following status codes: + +- `204 No Content`: The package was deleted successfully. +- `403 Forbidden`: The user does not have permission to delete the file. +- `404 Not Found`: The package or package file was not found. diff --git a/doc/api/packages/npm.md b/doc/api/packages/npm.md new file mode 100644 index 00000000000..3992a042915 --- /dev/null +++ b/doc/api/packages/npm.md @@ -0,0 +1,269 @@ +--- +stage: Package +group: Package +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.example/handbook/engineering/ux/technical-writing/#assignments +--- + +# npm API + +This is the API documentation for [npm Packages](../../user/packages/npm_registry/index.md). + +WARNING: +This API is used by the [npm package manager client](https://docs.npmjs.com/) +and is not meant for manual consumption. + +For instructions on how to upload and install npm packages from the GitLab +package registry, see the [npm package registry documentation](../../user/packages/npm_registry/index.md). + +NOTE: +These endpoints do not adhere to the standard API authentication methods. +See the [npm package registry documentation](../../user/packages/npm_registry/index.md) +for details on which headers and token types are supported. + +## Download a package + +> Introduced in GitLab 11.8. + +Downloads the npm package. This URL is provided by the [metadata endpoint](#metadata). + +```plaintext +GET projects/:id/packages/npm/:package_name/-/:file_name +``` + +| Attribute | Type | Required | Description | +| ----------------- | ------ | -------- | ----------- | +| `id` | string | yes | The ID or full path of the project. | +| `package_name` | string | yes | The name of the package. | +| `file_name` | string | yes | The name of the package file. | + +```shell +curl --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg/-/@my-scope/my-pkg-0.0.1.tgz" +``` + +Write the output to a file: + +```shell +curl --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg/-/@my-scope/my-pkg-0.0.1.tgz" >> @myscope/my-pkg-0.0.1.tgz +``` + +This writes the downloaded file to `@myscope/my-pkg-0.0.1.tgz` in the current directory. + +## Upload a package file + +> Introduced in GitLab 11.8. + +Upload a package. + +```plaintext +PUT projects/:id/packages/npm/:package_name +``` + +| Attribute | Type | Required | Description | +| ----------------- | ------ | -------- | ----------- | +| `id` | string | yes | The ID or full path of the project. | +| `package_name` | string | yes | The name of the package. | +| `versions` | string | yes | Package version info. | + +```shell +curl --request PUT + --header "Content-Type: application/json" + --data @./path/to/metadata/file.json + --header "Authorization: Bearer <personal_access_token>" \ + "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg" +``` + +The metadata file content is generated by npm, but looks something like this: + +```json +{ + "_attachments": { + "@myscope/my-pkg-1.3.7.tgz": { + "content_type": "application/octet-stream", + "data": "H4sIAAAAAAAAE+1TQUvDMBjdeb/iI4edZEldV2dPwhARPIjiyXlI26zN1iYhSeeK7L+bNJtednMg4l4OKe+9PF7DF0XzNS0ZVmEfr4wUgxODEJLEMRzjPRJyCYPJNCFRlCTE+dzH1PvJqYscQ2ss1a7KT3PCv8DX/kfwMQRAgjYMpYBuIoIzKtwy6MILG6YNl8Jr0XgyvgpswUyuubJ75TGMDuSaUcsKyDooa1C6De6G8t7GRcG2br4CGxKME3wDR1hmrLexvJKwQLdaS52CkOAFMIrlfMlZsUAwGgHbcgsRcid3fdqade9SFz7u9a1naGsrqX3gHbcPNINDyydWcmN1By+W19x2oU7NcyZMfwn3z/PAqTaruanmUix5+V3UXVKq9yEoRZW1yqQYl9zWNBvnssFUcbyJsdJyxXJrcHQdz8gsTg6PzGChGty3H+6Gvz0BZ5xxxn/FJ1EDRNIACAAA", + "length": 354 + } + }, + "_id": "@myscope/my-pkg", + "description": "Package created by me", + "dist-tags": { + "latest": "1.3.7" + }, + "name": "@myscope/my-pkg", + "readme": "ERROR: No README data found!", + "versions": { + "1.3.7": { + "_id": "@myscope/my-pkg@1.3.7", + "_nodeVersion": "12.18.4", + "_npmVersion": "6.14.6", + "author": { + "name": "GitLab Package Registry Utility" + }, + "description": "Package created by me", + "dist": { + "integrity": "sha512-loy16p+Dtw2S43lBmD3Nye+t+Vwv7Tbhv143UN2mwcjaHJyBfGZdNCTXnma3gJCUSE/AR4FPGWEyCOOTJ+ev9g==", + "shasum": "4a9dbd94ca6093feda03d909f3d7e6bd89d9d4bf", + "tarball": "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg/-/@myscope/my-pkg-1.3.7.tgz" + }, + "keywords": [], + "license": "ISC", + "main": "index.js", + "name": "@myscope/my-pkg", + "publishConfig": { + "@myscope:registry": "https://gitlab.example.com/api/v4/projects/1/packages/npm" + }, + "readme": "ERROR: No README data found!", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "version": "1.3.7" + } + } +} +``` + +## Route prefix + +For the remaining routes, there are two sets of identical routes that each make requests in +different scopes: + +- Use the instance-level prefix to make requests in the scope of the entire instance. +- Use the project-level prefix to make requests in a single project's scope. + +The examples in this document all use the project-level prefix. + +### Instance-level + +```plaintext + /packages/npm` +``` + +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | string | yes | The group ID or full group path. | + +### Project-level + +```plaintext + /projects/:id/packages/npm` +``` + +| Attribute | Type | Required | Description | +| --------- | ------ | -------- | ----------- | +| `id` | string | yes | The project ID or full project path. | + +## Metadata + +> Introduced in GitLab 11.8. + +Returns the metadata for a given package. + +```plaintext +GET <route-prefix>/:package_name +``` + +| Attribute | Type | Required | Description | +| -------------- | ------ | -------- | ----------- | +| `package_name` | string | yes | The name of the package. | + +```shell +curl --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg" +``` + +Example response: + +```json +{ + "name": "@myscope/my-pkg", + "versions": { + "0.0.2": { + "name": "@myscope/my-pkg", + "version": "0.0.1", + "dist": { + "shasum": "93abb605b1110c0e3cca0a5b805e5cb01ac4ca9b", + "tarball": "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg/-/@myscope/my-pkg-0.0.1.tgz" + } + } + }, + "dist-tags": { + "latest": "0.0.1" + } +} +``` + +The URLs in the response have the same route prefix used to request them. If you request them with +the instance-level route, the returned URLs contain `/api/v4/packages/npm`. + +## Dist-Tags + +### List tags + +> Introduced in GitLab 12.7. + +Lists the dist-tags for the package. + +```plaintext +GET <route-prefix>/-/package/:package_name/dist-tags +``` + +| Attribute | Type | Required | Description | +| -------------- | ------ | -------- | ----------- | +| `package_name` | string | yes | The name of the package. | + +```shell +curl --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/-/package/@myscope/my-pkg/dist-tags" +``` + +Example response: + +```json +{ + "latest": "2.1.1", + "stable": "1.0.0" +} +``` + +The URLs in the response have the same route prefix used to request them. If you request them with +the instance-level route, the returned URLs contain `/api/v4/packages/npm`. + +### Create or update a tag + +> Introduced in GitLab 12.7. + +Create or update a dist-tag. + +```plaintext +PUT <route-prefix>/-/package/:package_name/dist-tags/:tag +``` + +| Attribute | Type | Required | Description | +| -------------- | ------ | -------- | ----------- | +| `package_name` | string | yes | The name of the package. | +| `tag` | string | yes | The tag to be created or updated. | +| `version` | string | yes | The version to be tagged. | + +```shell +curl --request PUT --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/-/package/@myscope/my-pkg/dist-tags/stable" +``` + +This endpoint responds successfully with `204 No Content`. + +### Delete a tag + +> Introduced in GitLab 12.7. + +Delete a dist-tag. + +```plaintext +DELETE <route-prefix>/-/package/:package_name/dist-tags/:tag +``` + +| Attribute | Type | Required | Description | +| -------------- | ------ | -------- | ----------- | +| `package_name` | string | yes | The name of the package. | +| `tag` | string | yes | The tag to be created or updated. | + +```shell +curl --request DELETE --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/-/package/@myscope/my-pkg/dist-tags/stable" +``` + +This endpoint responds successfully with `204 No Content`. diff --git a/doc/api/pipeline_schedules.md b/doc/api/pipeline_schedules.md index 67529adee93..6b3b6f4f36b 100644 --- a/doc/api/pipeline_schedules.md +++ b/doc/api/pipeline_schedules.md @@ -370,8 +370,8 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "value=u ```json { "key": "NEW_VARIABLE", - "value": "updated value" - "variable_type": "env_var", + "value": "updated value", + "variable_type": "env_var" } ``` diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 975c4a5746f..497c70b19ba 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -60,7 +60,7 @@ Example of response "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", "web_url": "https://example.com/foo/bar/pipelines/47", "created_at": "2016-08-11T11:28:34.085Z", - "updated_at": "2016-08-11T11:32:35.169Z", + "updated_at": "2016-08-11T11:32:35.169Z" }, { "id": 48, @@ -70,7 +70,7 @@ Example of response "sha": "eb94b618fb5865b26e80fdd8ae531b7a63ad851a", "web_url": "https://example.com/foo/bar/pipelines/48", "created_at": "2016-08-12T10:06:04.561Z", - "updated_at": "2016-08-12T10:09:56.223Z", + "updated_at": "2016-08-12T10:09:56.223Z" } ] ``` @@ -117,7 +117,8 @@ Example of response "started_at": null, "finished_at": "2016-08-11T11:32:35.145Z", "committed_at": null, - "duration": null, + "duration": 123.65, + "queued_duration": 0.010, "coverage": "30.0", "web_url": "https://example.com/foo/bar/pipelines/46" } @@ -254,6 +255,7 @@ Example of response "finished_at": null, "committed_at": null, "duration": null, + "queued_duration": 0.010, "coverage": null, "web_url": "https://example.com/foo/bar/pipelines/61" } @@ -302,6 +304,7 @@ Response: "finished_at": "2016-08-11T11:32:35.145Z", "committed_at": null, "duration": null, + "queued_duration": 0.010, "coverage": null, "web_url": "https://example.com/foo/bar/pipelines/46" } @@ -350,6 +353,7 @@ Response: "finished_at": "2016-08-11T11:32:35.145Z", "committed_at": null, "duration": null, + "queued_duration": 0.010, "coverage": null, "web_url": "https://example.com/foo/bar/pipelines/46" } diff --git a/doc/api/project_analytics.md b/doc/api/project_analytics.md deleted file mode 100644 index d89c173dd3e..00000000000 --- a/doc/api/project_analytics.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -redirect_to: 'dora4_project_analytics.md' ---- - -This document was moved to [another location](dora4_project_analytics.md). - -<!-- This redirect file can be deleted after <2021-04-25>. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index 58f5b000958..a17f7d15e76 100644 --- a/doc/api/project_badges.md +++ b/doc/api/project_badges.md @@ -59,7 +59,7 @@ Example response: "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master", "rendered_image_url": "https://shields.io/my/badge", "kind": "group" - }, + } ] ``` @@ -202,6 +202,6 @@ Example response: "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}", "image_url": "https://shields.io/my/badge", "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master", - "rendered_image_url": "https://shields.io/my/badge", + "rendered_image_url": "https://shields.io/my/badge" } ``` diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index c895a7c4155..a4ad496b667 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -104,7 +104,7 @@ an email notifying the user to download the file, uploading the exported file to "export_status": "finished", "_links": { "api_url": "https://gitlab.example.com/api/v4/projects/1/export/download", - "web_url": "https://gitlab.example.com/gitlab-org/gitlab-test/download_export", + "web_url": "https://gitlab.example.com/gitlab-org/gitlab-test/download_export" } } ``` @@ -196,6 +196,65 @@ NOTE: The maximum import file size can be set by the Administrator, default is `0` (unlimited).. As an administrator, you can modify the maximum import file size. To do so, use the `max_import_size` option in the [Application settings API](settings.md#change-application-settings) or the [Admin UI](../user/admin_area/settings/account_and_limit_settings.md). Default [modified](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50MB to 0 in GitLab 13.8. +## Import a file from a remote object storage + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/282503) in GitLab 13.12 in [Beta](https://about.gitlab.com/handbook/product/gitlab-the-product/#beta). + +This endpoint is behind a feature flag that is disabled by default. + +To enable this endpoint: + +```ruby +Feature.enable(:import_project_from_remote_file) +``` + +To disable this endpoint: + +```ruby +Feature.disable(:import_project_from_remote_file) +``` + +```plaintext +POST /projects/remote-import +``` + +| Attribute | Type | Required | Description | +| ----------------- | -------------- | -------- | ---------------------------------------- | +| `namespace` | integer/string | no | The ID or path of the namespace to import the project to. Defaults to the current user's namespace. | +| `name` | string | no | The name of the project to import. If not provided, defaults to the path of the project. | +| `url` | string | yes | URL for the file to import. | +| `path` | string | yes | Name and path for the new project. | +| `overwrite` | boolean | no | Whether to overwrite a project with the same path when importing. Defaults to `false`. | +| `override_params` | Hash | no | Supports all fields defined in the [Project API](projects.md). | + +The passed override parameters take precedence over all values defined in the export file. + +```shell +curl --request POST \ + --header "PRIVATE-TOKEN: <your_access_token>" \ + --url "https://gitlab.example.com/api/v4/projects/remote-import" \ + --data '{"url":"https://remoteobject/file?token=123123","path":"remote-project"}' +``` + +```json +{ + "id": 1, + "description": null, + "name": "remote-project", + "name_with_namespace": "Administrator / remote-project", + "path": "remote-project", + "path_with_namespace": "root/remote-project", + "created_at": "2018-02-13T09:05:58.023Z", + "import_status": "scheduled", + "correlation_id": "mezklWso3Za", + "failed_relations": [], + "import_error": null +} +``` + +The `ContentType` header must return a valid number. The maximum file size is 10 gigabytes. +The `ContentLength` header must be `application/gzip`. + ## Import status Get the status of an import. diff --git a/doc/api/project_repository_storage_moves.md b/doc/api/project_repository_storage_moves.md index 94aeb665c7f..dd8954f2f0f 100644 --- a/doc/api/project_repository_storage_moves.md +++ b/doc/api/project_repository_storage_moves.md @@ -68,6 +68,7 @@ Example response: "path": "project1", "path_with_namespace": "namespace1/project1", "created_at": "2020-05-07T04:27:17.016Z" + } } ] ``` @@ -111,6 +112,7 @@ Example response: "path": "project1", "path_with_namespace": "namespace1/project1", "created_at": "2020-05-07T04:27:17.016Z" + } } ] ``` @@ -150,6 +152,7 @@ Example response: "path": "project1", "path_with_namespace": "namespace1/project1", "created_at": "2020-05-07T04:27:17.016Z" + } } ``` @@ -189,6 +192,7 @@ Example response: "path": "project1", "path_with_namespace": "namespace1/project1", "created_at": "2020-05-07T04:27:17.016Z" + } } ``` @@ -237,6 +241,7 @@ Example response: "path": "project1", "path_with_namespace": "namespace1/project1", "created_at": "2020-05-07T04:27:17.016Z" + } } ``` diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index fc8882be283..070429eafd5 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -114,7 +114,7 @@ curl --request POST "https://gitlab.com/api/v4/projects/:id/snippets" \ "files": [ { "file_path": "example.txt", - "content" : "source code \n with multiple lines\n", + "content" : "source code \n with multiple lines\n" } ] } diff --git a/doc/api/projects.md b/doc/api/projects.md index d9aabfbc337..b686d17a4a1 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -59,6 +59,7 @@ GET /projects | `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. | | `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. | | `statistics` | boolean | **{dotted-circle}** No | Include project statistics. | +| `topic` | string | **{dotted-circle}** No | Comma-separated topic names. Limit results to projects that match all of given topics. See `tag_list` attribute. | | `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. | | `wiki_checksum_failed` **(PREMIUM)** | boolean | **{dotted-circle}** No | Limit projects where the wiki checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2). | | `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(admins only)_ | @@ -93,7 +94,7 @@ When `simple=true` or the user is unauthenticated this returns something like: "last_activity_at": "2013-09-30T13:46:02Z", "forks_count": 0, "avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png", - "star_count": 0, + "star_count": 0 }, { "id": 6, @@ -188,7 +189,7 @@ When the user is authenticated and `simple` is not set this returns something li "labels": "http://example.com/api/v4/projects/1/labels", "events": "http://example.com/api/v4/projects/1/events", "members": "http://example.com/api/v4/projects/1/members" - }, + } }, { "id": 6, @@ -901,7 +902,6 @@ GET /projects/:id "merge_method": "merge", "auto_devops_enabled": true, "auto_devops_deploy_strategy": "continuous", - "repository_storage": "default", "approvals_before_merge": 0, "mirror": false, "mirror_user_id": 45, @@ -985,7 +985,7 @@ If the project is a fork, and you provide a valid token to authenticate, the "name": "MIT License", "nickname": null, "html_url": "http://choosealicense.com/licenses/mit/", - "source_url": "https://opensource.org/licenses/MIT", + "source_url": "https://opensource.org/licenses/MIT" }, "star_count":3812, "forks_count":3561, @@ -1072,6 +1072,7 @@ GET /projects/:id/groups | `skip_groups` | array of integers | **{dotted-circle}** No | Skip the group IDs passed. | | `with_shared` | boolean | **{dotted-circle}** No | Include projects shared with this group. Default is `false`. | | `shared_min_access_level` | integer | **{dotted-circle}** No | Limit to shared groups with at least this [access level](members.md#valid-access-levels). | +| `shared_visible_only` | boolean | **{dotted-circle}** No | Limit to shared groups user has access to. | ```json [ @@ -1112,6 +1113,8 @@ POST /projects | Attribute | Type | Required | Description | |-------------------------------------------------------------|---------|------------------------|-------------| +| `name` | string | **{check-circle}** Yes (if path isn't provided) | The name of the new project. Equals path if not provided. | +| `path` | string | **{check-circle}** Yes (if name isn't provided) | Repository name for new project. Generated based on name if not provided (generated as lowercase with dashes). | | `allow_merge_on_skipped_pipeline` | boolean | **{dotted-circle}** No | Set whether or not merge requests can be merged with skipped jobs. | | `analytics_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private` or `enabled` | | `approvals_before_merge` **(PREMIUM)** | integer | **{dotted-circle}** No | How many approvers should approve merge requests by default. | @@ -1144,7 +1147,6 @@ POST /projects | `merge_requests_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable merge requests for this project. Use `merge_requests_access_level` instead. | | `mirror_trigger_builds` **(PREMIUM)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. | | `mirror` **(PREMIUM)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. | -| `name` | string | **{check-circle}** Yes (if path isn't provided) | The name of the new project. Equals path if not provided. | | `namespace_id` | integer | **{dotted-circle}** No | Namespace for the new project (defaults to the current user's namespace). | | `operations_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `only_allow_merge_if_all_discussions_are_resolved` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged when all the discussions are resolved. | @@ -1152,7 +1154,6 @@ POST /projects | `packages_enabled` | boolean | **{dotted-circle}** No | Enable or disable packages repository feature. | | `pages_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled`, or `public`. | | `requirements_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled` or `public` | -| `path` | string | **{check-circle}** Yes (if name isn't provided) | Repository name for new project. Generated based on name if not provided (generated as lowercase with dashes). | | `printing_merge_request_link_enabled` | boolean | **{dotted-circle}** No | Show link to create/view merge request when pushing from the command line. | | `public_builds` | boolean | **{dotted-circle}** No | If `true`, jobs can be viewed by non-project members. | | `remove_source_branch_after_merge` | boolean | **{dotted-circle}** No | Enable `Delete source branch` option by default for all new merge requests. | @@ -1186,6 +1187,8 @@ POST /projects/user/:user_id | Attribute | Type | Required | Description | |-------------------------------------------------------------|---------|------------------------|-------------| +| `user_id` | integer | **{check-circle}** Yes | The user ID of the project owner. | +| `name` | string | **{check-circle}** Yes | The name of the new project. | | `allow_merge_on_skipped_pipeline` | boolean | **{dotted-circle}** No | Set whether or not merge requests can be merged with skipped jobs. | | `analytics_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private` or `enabled` | | `approvals_before_merge` **(PREMIUM)** | integer | **{dotted-circle}** No | How many approvers should approve merge requests by default. | @@ -1216,7 +1219,6 @@ POST /projects/user/:user_id | `merge_requests_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable merge requests for this project. Use `merge_requests_access_level` instead. | | `mirror_trigger_builds` **(PREMIUM)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. | | `mirror` **(PREMIUM)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. | -| `name` | string | **{check-circle}** Yes | The name of the new project. | | `namespace_id` | integer | **{dotted-circle}** No | Namespace for the new project (defaults to the current user's namespace). | | `operations_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `only_allow_merge_if_all_discussions_are_resolved` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged when all the discussions are resolved. | @@ -1240,7 +1242,6 @@ POST /projects/user/:user_id | `tag_list` | array | **{dotted-circle}** No | The list of tags for a project; put array of tags, that should be finally assigned to a project. | | `template_name` | string | **{dotted-circle}** No | When used without `use_custom_template`, name of a [built-in project template](../user/project/working_with_projects.md#built-in-templates). When used with `use_custom_template`, name of a custom project template. | | `use_custom_template` **(PREMIUM)** | boolean | **{dotted-circle}** No | Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template. | -| `user_id` | integer | **{check-circle}** Yes | The user ID of the project owner. | | `visibility` | string | **{dotted-circle}** No | See [project visibility level](#project-visibility-level). | | `wiki_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `wiki_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable wiki for this project. Use `wiki_access_level` instead. | @@ -1660,26 +1661,26 @@ Example responses: [ { "starred_since": "2019-01-28T14:47:30.642Z", - "user": - { + "user": { "id": 1, "username": "jane_smith", "name": "Jane Smith", "state": "active", "avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg", "web_url": "http://localhost:3000/jane_smith" - } + } }, + { "starred_since": "2018-01-02T11:40:26.570Z", - "user": - { - "id": 2, - "username": "janine_smith", - "name": "Janine Smith", - "state": "blocked", - "avatar_url": "http://gravatar.com/../e32131cd8.jpeg", - "web_url": "http://localhost:3000/janine_smith" - } + "user": { + "id": 2, + "username": "janine_smith", + "name": "Janine Smith", + "state": "blocked", + "avatar_url": "http://gravatar.com/../e32131cd8.jpeg", + "web_url": "http://localhost:3000/janine_smith" + } + } ] ``` @@ -2221,7 +2222,7 @@ PUT /projects/:id/hooks/:hook_id | `tag_push_events` | boolean | **{dotted-circle}** No | Trigger hook on tag push events. | | `token` | string | **{dotted-circle}** No | Secret token to validate received payloads; this isn't returned in the response. | | `url` | string | **{check-circle}** Yes | The hook URL. | -| `wiki_events` | boolean | **{dotted-circle}** No | Trigger hook on wiki events. | +| `wiki_page_events` | boolean | **{dotted-circle}** No | Trigger hook on wiki page events. | | `releases_events` | boolean | **{dotted-circle}** No | Trigger hook on release events. | ### Delete project hook diff --git a/doc/api/releases/img/upcoming_release_v12_1.png b/doc/api/releases/img/upcoming_release_v12_1.png Binary files differdeleted file mode 100644 index cc3070fd19d..00000000000 --- a/doc/api/releases/img/upcoming_release_v12_1.png +++ /dev/null diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index 67e441ee7e4..b2dc562ad27 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -10,6 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w > - Using this API you can manipulate GitLab [Release](../../user/project/releases/index.md) entries. > - For manipulating links as a release asset, see [Release Links API](links.md). > - Release Evidences were [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/26019) in GitLab 12.5. +> - `description_html` field was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/299447) in GitLab 13.12. ## List Releases @@ -39,7 +40,6 @@ Example response: "tag_name":"v0.2", "description":"## CHANGELOG\r\n\r\n- Escape label and milestone titles to prevent XSS in GFM autocomplete. !2740\r\n- Prevent private snippets from being embeddable.\r\n- Add subresources removal to member destroy service.", "name":"Awesome app v0.2 beta", - "description_html":"\u003ch2 dir=\"auto\"\u003e\n\u003ca id=\"user-content-changelog\" class=\"anchor\" href=\"#changelog\" aria-hidden=\"true\"\u003e\u003c/a\u003eCHANGELOG\u003c/h2\u003e\n\u003cul dir=\"auto\"\u003e\n\u003cli\u003eEscape label and milestone titles to prevent XSS in GFM autocomplete. !2740\u003c/li\u003e\n\u003cli\u003ePrevent private snippets from being embeddable.\u003c/li\u003e\n\u003cli\u003eAdd subresources removal to member destroy service.\u003c/li\u003e\n\u003c/ul\u003e", "created_at":"2019-01-03T01:56:19.539Z", "released_at":"2019-01-03T01:56:19.539Z", "author":{ @@ -144,9 +144,9 @@ Example response: }, "evidences":[ { - sha: "760d6cdfb0879c3ffedec13af470e0f71cf52c6cde4d", - filepath: "https://gitlab.example.com/root/awesome-app/-/releases/v0.2/evidence.json", - collected_at: "2019-01-03T01:56:19.539Z" + "sha": "760d6cdfb0879c3ffedec13af470e0f71cf52c6cde4d", + "filepath": "https://gitlab.example.com/root/awesome-app/-/releases/v0.2/evidence.json", + "collected_at": "2019-01-03T01:56:19.539Z" } ] }, @@ -154,7 +154,6 @@ Example response: "tag_name":"v0.1", "description":"## CHANGELOG\r\n\r\n-Remove limit of 100 when searching repository code. !8671\r\n- Show error message when attempting to reopen an MR and there is an open MR for the same branch. !16447 (Akos Gyimesi)\r\n- Fix a bug where internal email pattern wasn't respected. !22516", "name":"Awesome app v0.1 alpha", - "description_html":"\u003ch2 dir=\"auto\"\u003e\n\u003ca id=\"user-content-changelog\" class=\"anchor\" href=\"#changelog\" aria-hidden=\"true\"\u003e\u003c/a\u003eCHANGELOG\u003c/h2\u003e\n\u003cul dir=\"auto\"\u003e\n\u003cli\u003eRemove limit of 100 when searching repository code. !8671\u003c/li\u003e\n\u003cli\u003eShow error message when attempting to reopen an MR and there is an open MR for the same branch. !16447 (Akos Gyimesi)\u003c/li\u003e\n\u003cli\u003eFix a bug where internal email pattern wasn't respected. !22516\u003c/li\u003e\n\u003c/ul\u003e", "created_at":"2019-01-03T01:55:18.203Z", "released_at":"2019-01-03T01:55:18.203Z", "author":{ @@ -208,9 +207,9 @@ Example response: }, "evidences":[ { - sha: "c3ffedec13af470e760d6cdfb08790f71cf52c6cde4d", - filepath: "https://gitlab.example.com/root/awesome-app/-/releases/v0.1/evidence.json", - collected_at: "2019-01-03T01:55:18.203Z" + "sha": "c3ffedec13af470e760d6cdfb08790f71cf52c6cde4d", + "filepath": "https://gitlab.example.com/root/awesome-app/-/releases/v0.1/evidence.json", + "collected_at": "2019-01-03T01:55:18.203Z" } ] } @@ -243,7 +242,6 @@ Example response: "tag_name":"v0.1", "description":"## CHANGELOG\r\n\r\n- Remove limit of 100 when searching repository code. !8671\r\n- Show error message when attempting to reopen an MR and there is an open MR for the same branch. !16447 (Akos Gyimesi)\r\n- Fix a bug where internal email pattern wasn't respected. !22516", "name":"Awesome app v0.1 alpha", - "description_html":"\u003ch2 dir=\"auto\"\u003e\n\u003ca id=\"user-content-changelog\" class=\"anchor\" href=\"#changelog\" aria-hidden=\"true\"\u003e\u003c/a\u003eCHANGELOG\u003c/h2\u003e\n\u003cul dir=\"auto\"\u003e\n\u003cli\u003eRemove limit of 100 when searching repository code. !8671\u003c/li\u003e\n\u003cli\u003eShow error message when attempting to reopen an MR and there is an open MR for the same branch. !16447 (Akos Gyimesi)\u003c/li\u003e\n\u003cli\u003eFix a bug where internal email pattern wasn't respected. !22516\u003c/li\u003e\n\u003c/ul\u003e", "created_at":"2019-01-03T01:55:18.203Z", "released_at":"2019-01-03T01:55:18.203Z", "author":{ @@ -340,9 +338,9 @@ Example response: }, "evidences":[ { - sha: "760d6cdfb0879c3ffedec13af470e0f71cf52c6cde4d", - filepath: "https://gitlab.example.com/root/awesome-app/-/releases/v0.1/evidence.json", - collected_at: "2019-07-16T14:00:12.256Z" + "sha": "760d6cdfb0879c3ffedec13af470e0f71cf52c6cde4d", + "filepath": "https://gitlab.example.com/root/awesome-app/-/releases/v0.1/evidence.json", + "collected_at": "2019-07-16T14:00:12.256Z" } ] } @@ -386,7 +384,6 @@ Example response: "tag_name":"v0.3", "description":"Super nice release", "name":"New release", - "description_html":"\u003cp dir=\"auto\"\u003eSuper nice release\u003c/p\u003e", "created_at":"2019-01-03T02:22:45.118Z", "released_at":"2019-01-03T02:22:45.118Z", "author":{ @@ -482,7 +479,7 @@ Example response: } ], "evidence_file_path":"https://gitlab.example.com/root/awesome-app/-/releases/v0.3/evidence.json" - }, + } } ``` @@ -552,7 +549,6 @@ Example response: "tag_name":"v0.1", "description":"## CHANGELOG\r\n\r\n- Remove limit of 100 when searching repository code. !8671\r\n- Show error message when attempting to reopen an MR and there is an open MR for the same branch. !16447 (Akos Gyimesi)\r\n- Fix a bug where internal email pattern wasn't respected. !22516", "name":"new name", - "description_html":"\u003ch2 dir=\"auto\"\u003e\n\u003ca id=\"user-content-changelog\" class=\"anchor\" href=\"#changelog\" aria-hidden=\"true\"\u003e\u003c/a\u003eCHANGELOG\u003c/h2\u003e\n\u003cul dir=\"auto\"\u003e\n\u003cli\u003eRemove limit of 100 when searching repository code. !8671\u003c/li\u003e\n\u003cli\u003eShow error message when attempting to reopen an MR and there is an open MR for the same branch. !16447 (Akos Gyimesi)\u003c/li\u003e\n\u003cli\u003eFix a bug where internal email pattern wasn't respected. !22516\u003c/li\u003e\n\u003c/ul\u003e", "created_at":"2019-01-03T01:55:18.203Z", "released_at":"2019-01-03T01:55:18.203Z", "author":{ @@ -625,7 +621,7 @@ Example response: ], "evidence_file_path":"https://gitlab.example.com/root/awesome-app/-/releases/v0.1/evidence.json" - }, + } } ``` @@ -655,7 +651,6 @@ Example response: "tag_name":"v0.1", "description":"## CHANGELOG\r\n\r\n- Remove limit of 100 when searching repository code. !8671\r\n- Show error message when attempting to reopen an MR and there is an open MR for the same branch. !16447 (Akos Gyimesi)\r\n- Fix a bug where internal email pattern wasn't respected. !22516", "name":"new name", - "description_html":"\u003ch2 dir=\"auto\"\u003e\n\u003ca id=\"user-content-changelog\" class=\"anchor\" href=\"#changelog\" aria-hidden=\"true\"\u003e\u003c/a\u003eCHANGELOG\u003c/h2\u003e\n\u003cul dir=\"auto\"\u003e\n\u003cli\u003eRemove limit of 100 when searching repository code. !8671\u003c/li\u003e\n\u003cli\u003eShow error message when attempting to reopen an MR and there is an open MR for the same branch. !16447 (Akos Gyimesi)\u003c/li\u003e\n\u003cli\u003eFix a bug where internal email pattern wasn't respected. !22516\u003c/li\u003e\n\u003c/ul\u003e", "created_at":"2019-01-03T01:55:18.203Z", "released_at":"2019-01-03T01:55:18.203Z", "author":{ @@ -709,7 +704,7 @@ Example response: ], "evidence_file_path":"https://gitlab.example.com/root/awesome-app/-/releases/v0.1/evidence.json" - }, + } } ``` @@ -717,6 +712,5 @@ Example response: > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38105) in GitLab 12.1. -A release with a `released_at` attribute set to a future date is labeled an **Upcoming Release** in the UI: - - +A release with a `released_at` attribute set to a future date is labeled +as an **Upcoming Release** [in the UI](../../user/project/releases/index.md#upcoming-releases). diff --git a/doc/api/resource_access_tokens.md b/doc/api/resource_access_tokens.md index 2b6400a6f0d..ecc5b3bf172 100644 --- a/doc/api/resource_access_tokens.md +++ b/doc/api/resource_access_tokens.md @@ -55,6 +55,7 @@ POST projects/:id/access_tokens | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| +| `id` | integer/string | yes | The ID of the project | | `name` | String | yes | The name of the project access token | | `scopes` | Array\[String] | yes | [List of scopes](../user/project/settings/project_access_tokens.md#limiting-scopes-of-a-project-access-token) | | `expires_at` | Date | no | The token expires at midnight UTC on that date | diff --git a/doc/api/resource_label_events.md b/doc/api/resource_label_events.md index 6b682eac29c..0c1735c0664 100644 --- a/doc/api/resource_label_events.md +++ b/doc/api/resource_label_events.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Compilance info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/runners.md b/doc/api/runners.md index c96ff1b0360..1f0209c3cae 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -126,7 +126,7 @@ Example response: "ip_address": "127.0.0.1", "is_shared": true, "name": null, - "online": false + "online": false, "status": "offline" }, { @@ -136,7 +136,7 @@ Example response: "ip_address": "127.0.0.1", "is_shared": false, "name": null, - "online": true + "online": true, "status": "paused" }, { @@ -156,7 +156,7 @@ Example response: Get details of a runner. -[Maintainer access or higher](../user/permissions.md) is required to get runner details at the project and group level. +[Maintainer access or higher](../user/permissions.md) is required to get runner details at the project and group level. Instance-level runner details via this endpoint are available to all signed in users. @@ -428,7 +428,7 @@ Example response: "ip_address": "127.0.0.1", "is_shared": true, "name": null, - "online": true + "online": true, "status": "paused" } ] diff --git a/doc/api/services.md b/doc/api/services.md index 0b840d907f8..e658c51f7e6 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Services API **(FREE)** NOTE: -This API requires an access token with Maintainer or Owner permissions +This API requires an access token with Maintainer or Owner permissions. ## List all active services @@ -42,7 +42,7 @@ Example response: "wiki_page_events": true, "job_events": true, "comment_on_event_enabled": true - } + }, { "id": 76, "title": "Alerts endpoint", @@ -572,7 +572,9 @@ GET /projects/:id/services/external-wiki ## Flowdock -Flowdock is a collaboration web app for technical teams. +Flowdock is a ChatOps application for collaboration in software engineering +companies. You can send notifications from GitLab events to Flowdock flows. +For integration instructions, see the [Flowdock documentation](https://www.flowdock.com/help/gitlab). ### Create/Edit Flowdock service @@ -1251,7 +1253,7 @@ Parameters: | `confidential_issue_channel` | string | false | The name of the channel to receive confidential issues events notifications | | `merge_request_channel` | string | false | The name of the channel to receive merge request events notifications | | `note_channel` | string | false | The name of the channel to receive note events notifications | -| `confidential_note_channel` | boolean | The name of the channel to receive confidential note events notifications | +| `confidential_note_channel` | string | false | The name of the channel to receive confidential note events notifications | | `tag_push_channel` | string | false | The name of the channel to receive tag push events notifications | | `pipeline_channel` | string | false | The name of the channel to receive pipeline events notifications | | `wiki_page_channel` | string | false | The name of the channel to receive wiki page events notifications | @@ -1326,10 +1328,15 @@ PUT /projects/:id/services/jenkins Parameters: -- `jenkins_url` (**required**) - Jenkins URL like `http://jenkins.example.com` -- `project_name` (**required**) - The URL-friendly project name. Example: my_project_name -- `username` (optional) - A user with access to the Jenkins server, if applicable -- `password` (optional) - The password of the user +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `jenkins_url` | string | true | Jenkins URL like `http://jenkins.example.com`. | +| `project_name` | string | true | The URL-friendly project name. Example: `my_project_name`. | +| `username` | string | false | Username for authentication with the Jenkins server, if authentication is required by the server. | +| `password` | string | false | Password for authentication with the Jenkins server, if authentication is required by the server. | +| `push_events` | boolean | false | Enable notifications for push events. | +| `merge_requests_events` | boolean | false | Enable notifications for merge request events. | +| `tag_push_events` | boolean | false | Enable notifications for tag push events. | ### Delete Jenkins CI service diff --git a/doc/api/settings.md b/doc/api/settings.md index 6322f14442c..ada1d0e7fc4 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -88,6 +88,7 @@ Example response: "rate_limiting_response_text": null, "keep_latest_artifact": true, "admin_mode": false, + "floc_enabled": false, "external_pipeline_validation_service_timeout": null, "external_pipeline_validation_service_token": null, "external_pipeline_validation_service_url": null @@ -216,17 +217,17 @@ listed in the descriptions of the relevant settings. | Attribute | Type | Required | Description | |------------------------------------------|------------------|:------------------------------------:|-------------| -| `admin_mode` | boolean | no | Require admins to enable Admin Mode by re-authenticating for administrative tasks. | -| `admin_notification_email` | string | no | Deprecated: Use `abuse_notification_email` instead. If set, [abuse reports](../user/admin_area/abuse_reports.md) are sent to this address. Abuse reports are always available in the Admin Area. | -| `abuse_notification_email` | string | no | If set, [abuse reports](../user/admin_area/abuse_reports.md) are sent to this address. Abuse reports are always available in the Admin Area. | +| `admin_mode` | boolean | no | Require administrators to enable Admin Mode by re-authenticating for administrative tasks. | +| `admin_notification_email` | string | no | Deprecated: Use `abuse_notification_email` instead. If set, [abuse reports](../user/admin_area/review_abuse_reports.md) are sent to this address. Abuse reports are always available in the Admin Area. | +| `abuse_notification_email` | string | no | If set, [abuse reports](../user/admin_area/review_abuse_reports.md) are sent to this address. Abuse reports are always available in the Admin Area. | | `after_sign_out_path` | string | no | Where to redirect users after logout. | -| `after_sign_up_text` | string | no | Text shown to the user after signing up | +| `after_sign_up_text` | string | no | Text shown to the user after signing up. | | `akismet_api_key` | string | required by: `akismet_enabled` | API key for Akismet spam protection. | | `akismet_enabled` | boolean | no | (**If enabled, requires:** `akismet_api_key`) Enable or disable Akismet spam protection. | -| `allow_group_owners_to_manage_ldap` | boolean | no | **(PREMIUM)** Set to `true` to allow group owners to manage LDAP | +| `allow_group_owners_to_manage_ldap` | boolean | no | **(PREMIUM)** Set to `true` to allow group owners to manage LDAP. | | `allow_local_requests_from_hooks_and_services` | boolean | no | (Deprecated: Use `allow_local_requests_from_web_hooks_and_services` instead) Allow requests to the local network from hooks and services. | -| `allow_local_requests_from_system_hooks` | boolean | no | Allow requests to the local network from system hooks. | -| `allow_local_requests_from_web_hooks_and_services` | boolean | no | Allow requests to the local network from web hooks and services. | +| `allow_local_requests_from_system_hooks` | boolean | no | Allow requests to the local network from system hooks. | +| `allow_local_requests_from_web_hooks_and_services` | boolean | no | Allow requests to the local network from web hooks and services. | | `archive_builds_in_human_readable` | string | no | Set the duration for which the jobs are considered as old and expired. After that time passes, the jobs are archived and no longer able to be retried. Make it empty to never expire jobs. It has to be no less than 1 day, for example: <code>15 days</code>, <code>1 month</code>, <code>2 years</code>. | | `asset_proxy_enabled` | boolean | no | (**If enabled, requires:** `asset_proxy_url`) Enable proxying of assets. GitLab restart is required to apply changes. | | `asset_proxy_secret_key` | string | no | Shared secret with the asset proxy server. GitLab restart is required to apply changes. | @@ -242,7 +243,7 @@ listed in the descriptions of the relevant settings. | `container_registry_token_expire_delay` | integer | no | Container Registry token duration in minutes. | | `default_artifacts_expire_in` | string | no | Set the default expiration time for each job's artifacts. | | `default_branch_protection` | integer | no | Determine if developers can push to the default branch. Can take: `0` _(not protected, both developers and maintainers can push new commits, force push, or delete the branch)_, `1` _(partially protected, developers and maintainers can push new commits, but cannot force push, or delete, the branch)_ or `2` _(fully protected, developers cannot push new commits, but maintainers can; no-one can force push or delete the branch)_ as a parameter. Default is `2`. | -| `default_ci_config_path` | string | no | Default CI configuration path for new projects (`.gitlab-ci.yml` if not set). | +| `default_ci_config_path` | string | no | Default CI configuration path for new projects (`.gitlab-ci.yml` if not set). | | `default_group_visibility` | string | no | What visibility level new groups receive. Can take `private`, `internal` and `public` as a parameter. Default is `private`. | | `default_project_creation` | integer | no | Default project creation protection. Can take: `0` _(No one)_, `1` _(Maintainers)_ or `2` _(Developers + Maintainers)_| | `default_project_visibility` | string | no | What visibility level new projects receive. Can take `private`, `internal` and `public` as a parameter. Default is `private`. | @@ -259,41 +260,43 @@ listed in the descriptions of the relevant settings. | `dsa_key_restriction` | integer | no | The minimum allowed bit length of an uploaded DSA key. Default is `0` (no restriction). `-1` disables DSA keys. | | `ecdsa_key_restriction` | integer | no | The minimum allowed curve size (in bits) of an uploaded ECDSA key. Default is `0` (no restriction). `-1` disables ECDSA keys. | | `ed25519_key_restriction` | integer | no | The minimum allowed curve size (in bits) of an uploaded ED25519 key. Default is `0` (no restriction). `-1` disables ED25519 keys. | -| `eks_access_key_id` | string | no | AWS IAM access key ID | -| `eks_account_id` | string | no | Amazon account ID | -| `eks_integration_enabled` | boolean | no | Enable integration with Amazon EKS | -| `eks_secret_access_key` | string | no | AWS IAM secret access key | -| `elasticsearch_aws_access_key` | string | no | **(PREMIUM)** AWS IAM access key | -| `elasticsearch_aws_region` | string | no | **(PREMIUM)** The AWS region the Elasticsearch domain is configured | -| `elasticsearch_aws_secret_access_key` | string | no | **(PREMIUM)** AWS IAM secret access key | -| `elasticsearch_aws` | boolean | no | **(PREMIUM)** Enable the use of AWS hosted Elasticsearch | -| `elasticsearch_indexed_field_length_limit` | integer | no | **(PREMIUM)** Maximum size of text fields to index by Elasticsearch. 0 value means no limit. This does not apply to repository and wiki indexing. | -| `elasticsearch_indexed_file_size_limit_kb` | integer | no | **(PREMIUM)** Maximum size of repository and wiki files that are indexed by Elasticsearch. | -| `elasticsearch_indexing` | boolean | no | **(PREMIUM)** Enable Elasticsearch indexing | -| `elasticsearch_limit_indexing` | boolean | no | **(PREMIUM)** Limit Elasticsearch to index certain namespaces and projects | -| `elasticsearch_max_bulk_concurrency` | integer | no | **(PREMIUM)** Maximum concurrency of Elasticsearch bulk requests per indexing operation. This only applies to repository indexing operations. | -| `elasticsearch_max_bulk_size_mb` | integer | no | **(PREMIUM)** Maximum size of Elasticsearch bulk indexing requests in MB. This only applies to repository indexing operations. | +| `eks_access_key_id` | string | no | AWS IAM access key ID. | +| `eks_account_id` | string | no | Amazon account ID. | +| `eks_integration_enabled` | boolean | no | Enable integration with Amazon EKS. | +| `eks_secret_access_key` | string | no | AWS IAM secret access key. | +| `elasticsearch_aws_access_key` | string | no | **(PREMIUM)** AWS IAM access key. | +| `elasticsearch_aws_region` | string | no | **(PREMIUM)** The AWS region the Elasticsearch domain is configured. | +| `elasticsearch_aws_secret_access_key` | string | no | **(PREMIUM)** AWS IAM secret access key. | +| `elasticsearch_aws` | boolean | no | **(PREMIUM)** Enable the use of AWS hosted Elasticsearch. | +| `elasticsearch_indexed_field_length_limit` | integer | no | **(PREMIUM)** Maximum size of text fields to index by Elasticsearch. 0 value means no limit. This does not apply to repository and wiki indexing. | +| `elasticsearch_indexed_file_size_limit_kb` | integer | no | **(PREMIUM)** Maximum size of repository and wiki files that are indexed by Elasticsearch. | +| `elasticsearch_indexing` | boolean | no | **(PREMIUM)** Enable Elasticsearch indexing. | +| `elasticsearch_limit_indexing` | boolean | no | **(PREMIUM)** Limit Elasticsearch to index certain namespaces and projects. | +| `elasticsearch_max_bulk_concurrency` | integer | no | **(PREMIUM)** Maximum concurrency of Elasticsearch bulk requests per indexing operation. This only applies to repository indexing operations. | +| `elasticsearch_max_bulk_size_mb` | integer | no | **(PREMIUM)** Maximum size of Elasticsearch bulk indexing requests in MB. This only applies to repository indexing operations. | | `elasticsearch_namespace_ids` | array of integers | no | **(PREMIUM)** The namespaces to index via Elasticsearch if `elasticsearch_limit_indexing` is enabled. | | `elasticsearch_project_ids` | array of integers | no | **(PREMIUM)** The projects to index via Elasticsearch if `elasticsearch_limit_indexing` is enabled. | -| `elasticsearch_search` | boolean | no | **(PREMIUM)** Enable Elasticsearch search | -| `elasticsearch_url` | string | no | **(PREMIUM)** The URL to use for connecting to Elasticsearch. Use a comma-separated list to support cluster (for example, `http://localhost:9200, http://localhost:9201"`). If your Elasticsearch instance is password protected, pass the `username:password` in the URL (for example, `http://<username>:<password>@<elastic_host>:9200/`). | -| `email_additional_text` | string | no | **(PREMIUM)** Additional text added to the bottom of every email for legal/auditing/compliance reasons | +| `elasticsearch_search` | boolean | no | **(PREMIUM)** Enable Elasticsearch search. | +| `elasticsearch_url` | string | no | **(PREMIUM)** The URL to use for connecting to Elasticsearch. Use a comma-separated list to support cluster (for example, `http://localhost:9200, http://localhost:9201"`). | +| `elasticsearch_username` | string | no | **(PREMIUM)** The `username` of your Elasticsearch instance. | +| `elasticsearch_password` | string | no | **(PREMIUM)** The password of your Elasticsearch instance. | +| `email_additional_text` | string | no | **(PREMIUM)** Additional text added to the bottom of every email for legal/auditing/compliance reasons. | | `email_author_in_body` | boolean | no | Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead. | | `enabled_git_access_protocol` | string | no | Enabled protocols for Git access. Allowed values are: `ssh`, `http`, and `nil` to allow both protocols. | | `enforce_namespace_storage_limit` | boolean | no | Enabling this permits enforcement of namespace storage limits. | | `enforce_terms` | boolean | no | (**If enabled, requires:** `terms`) Enforce application ToS to all users. | -| `external_auth_client_cert` | string | no | (**If enabled, requires:** `external_auth_client_key`) The certificate to use to authenticate with the external authorization service | -| `external_auth_client_key_pass` | string | no | Passphrase to use for the private key when authenticating with the external service this is encrypted when stored | -| `external_auth_client_key` | string | required by: `external_auth_client_cert` | Private key for the certificate when authentication is required for the external authorization service, this is encrypted when stored | +| `external_auth_client_cert` | string | no | (**If enabled, requires:** `external_auth_client_key`) The certificate to use to authenticate with the external authorization service. | +| `external_auth_client_key_pass` | string | no | Passphrase to use for the private key when authenticating with the external service this is encrypted when stored. | +| `external_auth_client_key` | string | required by: `external_auth_client_cert` | Private key for the certificate when authentication is required for the external authorization service, this is encrypted when stored. | | `external_authorization_service_default_label` | string | required by:<br>`external_authorization_service_enabled` | The default classification label to use when requesting authorization and no classification label has been specified on the project. | -| `external_authorization_service_enabled` | boolean | no | (**If enabled, requires:** `external_authorization_service_default_label`, `external_authorization_service_timeout` and `external_authorization_service_url`) Enable using an external authorization service for accessing projects | -| `external_authorization_service_timeout` | float | required by:<br>`external_authorization_service_enabled` | The timeout after which an authorization request is aborted, in seconds. When a request times out, access is denied to the user. (min: 0.001, max: 10, step: 0.001). | +| `external_authorization_service_enabled` | boolean | no | (**If enabled, requires:** `external_authorization_service_default_label`, `external_authorization_service_timeout` and `external_authorization_service_url`) Enable using an external authorization service for accessing projects. | +| `external_authorization_service_timeout` | float | required by:<br>`external_authorization_service_enabled` | The timeout after which an authorization request is aborted, in seconds. When a request times out, access is denied to the user. (min: 0.001, max: 10, step: 0.001). | | `external_authorization_service_url` | string | required by:<br>`external_authorization_service_enabled` | URL to which authorization requests are directed. | -| `external_pipeline_validation_service_url` | string | no | URL to which pipeline validation requests are directed. | -| `external_pipeline_validation_service_token` | string | no | An optional token to include as the `X-Gitlab-Token` header in requests to the URL in external_pipeline_validation_service_url. | -| `external_pipeline_validation_service_timeout` | integer | no | How long to wait for a response from the pipeline validation service before giving up and assuming 'OK'. | -| `file_template_project_id` | integer | no | **(PREMIUM)** The ID of a project to load custom file templates from | -| `first_day_of_week` | integer | no | Start day of the week for calendar views and date pickers. Valid values are `0` (default) for Sunday, `1` for Monday, and `6` for Saturday. | +| `external_pipeline_validation_service_url` | string | no | URL to use for pipeline validation requests. | +| `external_pipeline_validation_service_token` | string | no | (Optional) Token to include as the `X-Gitlab-Token` header in requests to the URL in `external_pipeline_validation_service_url`. | +| `external_pipeline_validation_service_timeout` | integer | no | How long to wait for a response from the pipeline validation service. Assumes `OK` if it times out. | +| `file_template_project_id` | integer | no | **(PREMIUM)** The ID of a project to load custom file templates from. | +| `first_day_of_week` | integer | no | Start day of the week for calendar views and date pickers. Valid values are `0` (default) for Sunday, `1` for Monday, and `6` for Saturday. | | `geo_node_allowed_ips` | string | yes | **(PREMIUM)** Comma-separated list of IPs and CIDRs of allowed secondary nodes. For example, `1.1.1.1, 2.2.2.0/24`. | | `geo_status_timeout` | integer | no | **(PREMIUM)** The amount of seconds after which a request to get a secondary node status times out. | | `git_two_factor_session_expiry` | integer | no | **(PREMIUM)** Maximum duration (in minutes) of a session for Git operations when 2FA is enabled. | @@ -307,7 +310,7 @@ listed in the descriptions of the relevant settings. | `help_page_hide_commercial_content` | boolean | no | Hide marketing-related entries from help. | | `help_page_support_url` | string | no | Alternate support URL for help page and help dropdown. | | `help_page_text` | string | no | Custom text displayed on the help page. | -| `help_text` | string | no | **(PREMIUM)** GitLab server administrator information | +| `help_text` | string | no | **(PREMIUM)** GitLab server administrator information. | | `hide_third_party_offers` | boolean | no | Do not display offers from third parties in GitLab. | | `home_page_url` | string | no | Redirect to this URL when not logged in. | | `housekeeping_bitmaps_enabled` | boolean | required by: `housekeeping_enabled` | Enable Git pack file bitmap creation. | @@ -322,27 +325,27 @@ listed in the descriptions of the relevant settings. | `issues_create_limit` | integer | no | Max number of issue creation requests per minute per user. Disabled by default.| | `keep_latest_artifact` | boolean | no | Prevent the deletion of the artifacts from the most recent successful jobs, regardless of the expiry time. Enabled by default. | | `local_markdown_version` | integer | no | Increase this value when any cached Markdown should be invalidated. | -| `maintenance_mode_message` | string | no | **(PREMIUM)** Message displayed when instance is in maintenance mode | -| `maintenance_mode` | boolean | no | **(PREMIUM)** When instance is in maintenance mode, non-administrative users can sign in with read-only access and make read-only API requests | -| `max_artifacts_size` | integer | no | Maximum artifacts size in MB | -| `max_attachment_size` | integer | no | Limit attachment size in MB | +| `maintenance_mode_message` | string | no | **(PREMIUM)** Message displayed when instance is in maintenance mode. | +| `maintenance_mode` | boolean | no | **(PREMIUM)** When instance is in maintenance mode, non-administrative users can sign in with read-only access and make read-only API requests. | +| `max_artifacts_size` | integer | no | Maximum artifacts size in MB. | +| `max_attachment_size` | integer | no | Limit attachment size in MB. | | `max_import_size` | integer | no | Maximum import size in MB. 0 for unlimited. Default = 0 (unlimited) [Modified](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50MB to 0 in GitLab 13.8. | -| `max_pages_size` | integer | no | Maximum size of pages repositories in MB | -| `max_personal_access_token_lifetime` | integer | no | **(ULTIMATE SELF)** Maximum allowable lifetime for personal access tokens in days | +| `max_pages_size` | integer | no | Maximum size of pages repositories in MB. | +| `max_personal_access_token_lifetime` | integer | no | **(ULTIMATE SELF)** Maximum allowable lifetime for personal access tokens in days. | | `metrics_method_call_threshold` | integer | no | A method call is only tracked when it takes longer than the given amount of milliseconds. | | `mirror_available` | boolean | no | Allow repository mirroring to configured by project Maintainers. If disabled, only Administrators can configure repository mirroring. | -| `mirror_capacity_threshold` | integer | no | **(PREMIUM)** Minimum capacity to be available before scheduling more mirrors preemptively | +| `mirror_capacity_threshold` | integer | no | **(PREMIUM)** Minimum capacity to be available before scheduling more mirrors preemptively. | | `mirror_max_capacity` | integer | no | **(PREMIUM)** Maximum number of mirrors that can be synchronizing at the same time. | | `mirror_max_delay` | integer | no | **(PREMIUM)** Maximum time (in minutes) between updates that a mirror can have when scheduled to synchronize. | -| `npm_package_requests_forwarding` | boolean | no | **(PREMIUM)** Use npmjs.org as a default remote repository when the package is not found in the GitLab Package Registry for npm | +| `npm_package_requests_forwarding` | boolean | no | **(PREMIUM)** Use npmjs.org as a default remote repository when the package is not found in the GitLab Package Registry for npm. | | `outbound_local_requests_whitelist` | array of strings | no | Define a list of trusted domains or IP addresses to which local requests are allowed when local requests for hooks and services are disabled. -| `pages_domain_verification_enabled` | boolean | no | Require users to prove ownership of custom domains. Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled. | +| `pages_domain_verification_enabled` | boolean | no | Require users to prove ownership of custom domains. Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled. | | `password_authentication_enabled_for_git` | boolean | no | Enable authentication for Git over HTTP(S) via a GitLab account password. Default is `true`. | | `password_authentication_enabled_for_web` | boolean | no | Enable authentication for the web interface via a GitLab account password. Default is `true`. | | `performance_bar_allowed_group_id` | string | no | (Deprecated: Use `performance_bar_allowed_group_path` instead) Path of the group that is allowed to toggle the performance bar. | | `performance_bar_allowed_group_path` | string | no | Path of the group that is allowed to toggle the performance bar. | | `performance_bar_enabled` | boolean | no | (Deprecated: Pass `performance_bar_allowed_group_path: nil` instead) Allow enabling the performance bar. | -| `personal_access_token_prefix` | string | no | Prefix for all generated personal access tokens. | +| `personal_access_token_prefix` | string | no | Prefix for all generated personal access tokens. | | `plantuml_enabled` | boolean | no | (**If enabled, requires:** `plantuml_url`) Enable PlantUML integration. Default is `false`. | | `plantuml_url` | string | required by: `plantuml_enabled` | The PlantUML instance URL for integration. | | `polling_interval_multiplier` | decimal | no | Interval multiplier used by endpoints that perform polling. Set to `0` to disable polling. | @@ -362,12 +365,12 @@ listed in the descriptions of the relevant settings. | `repository_size_limit` | integer | no | **(PREMIUM)** Size limit per repository (MB) | | `repository_storages_weighted` | hash of strings to integers | no | (GitLab 13.1 and later) Hash of names of taken from `gitlab.yml` to [weights](../administration/repository_storage_paths.md#configure-where-new-repositories-are-stored). New projects are created in one of these stores, chosen by a weighted random selection. | | `repository_storages` | array of strings | no | (GitLab 13.0 and earlier) List of names of enabled storage paths, taken from `gitlab.yml`. New projects are created in one of these stores, chosen at random. | -| `require_admin_approval_after_user_signup` | boolean | no | When enabled, any user that signs up for an account using the registration form is placed under a **Pending approval** state and has to be explicitly [approved](../user/admin_area/approving_users.md) by an administrator. | +| `require_admin_approval_after_user_signup` | boolean | no | When enabled, any user that signs up for an account using the registration form is placed under a **Pending approval** state and has to be explicitly [approved](../user/admin_area/approving_users.md) by an administrator. | | `require_two_factor_authentication` | boolean | no | (**If enabled, requires:** `two_factor_grace_period`) Require all users to set up Two-factor authentication. | | `restricted_visibility_levels` | array of strings | no | Selected levels cannot be used by non-Administrator users for groups, projects or snippets. Can take `private`, `internal` and `public` as a parameter. Default is `null` which means there is no restriction. | | `rsa_key_restriction` | integer | no | The minimum allowed bit length of an uploaded RSA key. Default is `0` (no restriction). `-1` disables RSA keys. | -| `send_user_confirmation_email` | boolean | no | Send confirmation email on sign-up. | -| `session_expire_delay` | integer | no | Session duration in minutes. GitLab restart is required to apply changes | +| `send_user_confirmation_email` | boolean | no | Send confirmation email on sign-up. | +| `session_expire_delay` | integer | no | Session duration in minutes. GitLab restart is required to apply changes. | | `shared_runners_enabled` | boolean | no | (**If enabled, requires:** `shared_runners_text` and `shared_runners_minutes`) Enable shared runners for new projects. | | `shared_runners_minutes` | integer | required by: `shared_runners_enabled` | **(PREMIUM)** Set the maximum number of pipeline minutes that a group can use on shared runners per month. | | `shared_runners_text` | string | required by: `shared_runners_enabled` | Shared runners text. | @@ -375,29 +378,30 @@ listed in the descriptions of the relevant settings. | `signin_enabled` | string | no | (Deprecated: Use `password_authentication_enabled_for_web` instead) Flag indicating if password authentication is enabled for the web interface. | | `signup_enabled` | boolean | no | Enable registration. Default is `true`. | | `slack_app_enabled` | boolean | no | **(PREMIUM)** (**If enabled, requires:** `slack_app_id`, `slack_app_secret` and `slack_app_secret`) Enable Slack app. | -| `slack_app_id` | string | required by: `slack_app_enabled` | **(PREMIUM)** The app ID of the Slack-app. | -| `slack_app_secret` | string | required by: `slack_app_enabled` | **(PREMIUM)** The app secret of the Slack-app. | -| `slack_app_verification_token` | string | required by: `slack_app_enabled` | **(PREMIUM)** The verification token of the Slack-app. | +| `slack_app_id` | string | required by: `slack_app_enabled` | **(PREMIUM)** The app ID of the Slack-app. | +| `slack_app_secret` | string | required by: `slack_app_enabled` | **(PREMIUM)** The app secret of the Slack-app. | +| `slack_app_verification_token` | string | required by: `slack_app_enabled` | **(PREMIUM)** The verification token of the Slack-app. | | `snippet_size_limit` | integer | no | Max snippet content size in **bytes**. Default: 52428800 Bytes (50MB).| | `snowplow_app_id` | string | no | The Snowplow site name / application ID. (for example, `gitlab`) | | `snowplow_collector_hostname` | string | required by: `snowplow_enabled` | The Snowplow collector hostname. (for example, `snowplow.trx.gitlab.net`) | | `snowplow_cookie_domain` | string | no | The Snowplow cookie domain. (for example, `.gitlab.com`) | | `snowplow_enabled` | boolean | no | Enable snowplow tracking. | -| `sourcegraph_enabled` | boolean | no | Enables Sourcegraph integration. Default is `false`. **If enabled, requires** `sourcegraph_url`. | +| `sourcegraph_enabled` | boolean | no | Enables Sourcegraph integration. Default is `false`. **If enabled, requires** `sourcegraph_url`. | | `sourcegraph_public_only` | boolean | no | Blocks Sourcegraph from being loaded on private and internal projects. Default is `true`. | -| `sourcegraph_url` | string | required by: `sourcegraph_enabled` | The Sourcegraph instance URL for integration. | +| `sourcegraph_url` | string | required by: `sourcegraph_enabled` | The Sourcegraph instance URL for integration. | | `spam_check_endpoint_enabled` | boolean | no | Enables Spam Check via external API endpoint. Default is `false`. | | `spam_check_endpoint_url` | string | no | URL of the external Spam Check service endpoint. | +| `spam_check_api_key` | string | no | The API key used by GitLab for accessing the Spam Check service endpoint. | | `terminal_max_session_time` | integer | no | Maximum time for web terminal websocket connection (in seconds). Set to `0` for unlimited time. | | `terms` | text | required by: `enforce_terms` | (**Required by:** `enforce_terms`) Markdown content for the ToS. | | `throttle_authenticated_api_enabled` | boolean | no | (**If enabled, requires:** `throttle_authenticated_api_period_in_seconds` and `throttle_authenticated_api_requests_per_period`) Enable authenticated API request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots). | -| `throttle_authenticated_api_period_in_seconds` | integer | required by:<br>`throttle_authenticated_api_enabled` | Rate limit period in seconds. | +| `throttle_authenticated_api_period_in_seconds` | integer | required by:<br>`throttle_authenticated_api_enabled` | Rate limit period in seconds. | | `throttle_authenticated_api_requests_per_period` | integer | required by:<br>`throttle_authenticated_api_enabled` | Max requests per period per user. | | `throttle_authenticated_web_enabled` | boolean | no | (**If enabled, requires:** `throttle_authenticated_web_period_in_seconds` and `throttle_authenticated_web_requests_per_period`) Enable authenticated web request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots). | | `throttle_authenticated_web_period_in_seconds` | integer | required by:<br>`throttle_authenticated_web_enabled` | Rate limit period in seconds. | | `throttle_authenticated_web_requests_per_period` | integer | required by:<br>`throttle_authenticated_web_enabled` | Max requests per period per user. | | `throttle_unauthenticated_enabled` | boolean | no | (**If enabled, requires:** `throttle_unauthenticated_period_in_seconds` and `throttle_unauthenticated_requests_per_period`) Enable unauthenticated request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots). | -| `throttle_unauthenticated_period_in_seconds` | integer | required by:<br>`throttle_unauthenticated_enabled` | Rate limit period in seconds. | +| `throttle_unauthenticated_period_in_seconds` | integer | required by:<br>`throttle_unauthenticated_enabled` | Rate limit period in seconds. | | `throttle_unauthenticated_requests_per_period` | integer | required by:<br>`throttle_unauthenticated_enabled` | Max requests per period per IP. | | `time_tracking_limit_to_hours` | boolean | no | Limit display of time tracking units to hours. Default is `false`. | | `two_factor_grace_period` | integer | required by: `require_two_factor_authentication` | Amount of time (in hours) that users are allowed to skip forced configuration of two-factor authentication. | @@ -408,8 +412,9 @@ listed in the descriptions of the relevant settings. | `user_default_external` | boolean | no | Newly registered users are external by default. | | `user_default_internal_regex` | string | no | Specify an e-mail address regex pattern to identify default internal users. | | `user_oauth_applications` | boolean | no | Allow users to register any application to use GitLab as an OAuth provider. | -| `user_show_add_ssh_key_message` | boolean | no | When set to `false` disable the "You won't be able to pull or push project code via SSH" warning shown to users with no uploaded SSH key. | +| `user_show_add_ssh_key_message` | boolean | no | When set to `false` disable the `You won't be able to pull or push project code via SSH` warning shown to users with no uploaded SSH key. | | `version_check_enabled` | boolean | no | Let GitLab inform you when an update is available. | +| `whats_new_variant` | string | no | What's new variant, possible values: `all_tiers`, `current_tier`, and `disabled`. | | `web_ide_clientside_preview_enabled` | boolean | no | Live Preview (allow live previews of JavaScript projects in the Web IDE using CodeSandbox Live Preview). | | `wiki_page_max_content_bytes` | integer | no | Maximum wiki page content size in **bytes**. Default: 52428800 Bytes (50 MB). The minimum value is 1024 bytes. | diff --git a/doc/api/sidekiq_metrics.md b/doc/api/sidekiq_metrics.md index 4791f066cd2..bcb59a6dad3 100644 --- a/doc/api/sidekiq_metrics.md +++ b/doc/api/sidekiq_metrics.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Enablement +group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/statistics.md b/doc/api/statistics.md index 3899d5bde76..a57838e6496 100644 --- a/doc/api/statistics.md +++ b/doc/api/statistics.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md index 3348157129d..101769e6323 100644 --- a/doc/api/system_hooks.md +++ b/doc/api/system_hooks.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/templates/gitignores.md b/doc/api/templates/gitignores.md index 6f2e5a83903..f1bf8120574 100644 --- a/doc/api/templates/gitignores.md +++ b/doc/api/templates/gitignores.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments type: reference --- diff --git a/doc/api/templates/licenses.md b/doc/api/templates/licenses.md index fb76bd81e50..e7eaa6eb3e0 100644 --- a/doc/api/templates/licenses.md +++ b/doc/api/templates/licenses.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Secure +group: Composition Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments type: reference --- diff --git a/doc/api/todos.md b/doc/api/todos.md index 3b2e3acb38b..864f87f988e 100644 --- a/doc/api/todos.md +++ b/doc/api/todos.md @@ -102,7 +102,6 @@ Example Response: }, "merge_when_pipeline_succeeds": false, "merge_status": "cannot_be_merged", - "subscribed": true, "user_notes_count": 7 }, "target_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/merge_requests/7", @@ -176,7 +175,6 @@ Example Response: }, "merge_when_pipeline_succeeds": false, "merge_status": "cannot_be_merged", - "subscribed": true, "user_notes_count": 7 }, "target_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/merge_requests/7", diff --git a/doc/api/users.md b/doc/api/users.md index 0e4012935f9..ac8fbe8492f 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -190,7 +190,7 @@ GET /users ] ``` -Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit`, and `using_license_seat` parameters. +Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit`, `is_auditor`, and `using_license_seat` parameters. ```json [ @@ -199,6 +199,7 @@ Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see ... "shared_runners_minutes_limit": 133, "extra_shared_runners_minutes_limit": 133, + "is_auditor": false, "using_license_seat": true ... } @@ -359,12 +360,13 @@ NOTE: The `plan` and `trial` parameters are only available on GitLab Enterprise Edition. Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see -the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` parameters. +the `shared_runners_minutes_limit`, `is_auditor`, and `extra_shared_runners_minutes_limit` parameters. ```json { "id": 1, "username": "john_smith", + "is_auditor": false, "shared_runners_minutes_limit": 133, "extra_shared_runners_minutes_limit": 133, ... @@ -628,6 +630,8 @@ GET /user } ``` +Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit`, `is_auditor`, and `using_license_seat` parameters. + ## User status Get the status of the currently signed in user. @@ -1762,6 +1766,6 @@ Example response: "source_name": "Group three", "source_type": "Namespace", "access_level": "20" - }, + } ] ``` diff --git a/doc/api/v3_to_v4.md b/doc/api/v3_to_v4.md index c63a04228a5..c6d883371a3 100644 --- a/doc/api/v3_to_v4.md +++ b/doc/api/v3_to_v4.md @@ -1,92 +1,18 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # API V3 to API V4 -In GitLab 9.0 and later, API V4 is the preferred version to be used. +WARNING: +The GitLab API v3 was removed in [GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/36819). -API V3 was unsupported from GitLab 9.5, released on August -22, 2017. API v3 was removed in [GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/36819). -The V3 API documentation is still -[available](https://gitlab.com/gitlab-org/gitlab-foss/blob/8-16-stable/doc/api/README.md). +For information about the current version of the GitLab API, read the [API documentation](README.md). -Below are the changes made between V3 and V4. +## Related links -## 8.17 - -- Removed `GET /projects/:search` (use: `GET /projects?search=x`) [!8877](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8877) -- `iid` filter has been removed from `GET /projects/:id/issues` [!8967](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8967) -- `GET /projects/:id/merge_requests?iid[]=x&iid[]=y` array filter has been renamed to `iids` [!8793](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8793) -- Endpoints under `GET /projects/merge_request/:id` have been removed (use: `GET /projects/merge_requests/:id`) [!8793](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8793) -- Project snippets do not return deprecated field `expires_at` [!8723](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8723) -- Endpoints under `GET /projects/:id/keys` have been removed (use `GET /projects/:id/deploy_keys`) [!8716](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8716) - -## 9.0 - -- Status 409 returned for `POST /projects/:id/members` when a member already exists [!9093](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9093) -- Moved `DELETE /projects/:id/star` to `POST /projects/:id/unstar` [!9328](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9328) -- Removed the following deprecated Templates endpoints (these are still accessible with `/templates` prefix) [!8853](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8853) - - `/licenses` - - `/licenses/:key` - - `/gitignores` - - `/gitlab_ci_ymls` - - `/dockerfiles` - - `/gitignores/:key` - - `/gitlab_ci_ymls/:key` - - `/dockerfiles/:key` -- Moved `POST /projects/fork/:id` to `POST /projects/:id/fork` [!8940](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8940) -- Moved `DELETE /todos` to `POST /todos/mark_as_done` and `DELETE /todos/:todo_id` to `POST /todos/:todo_id/mark_as_done` [!9410](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9410) -- Project filters are no longer available as `GET /projects/foo`, but as `GET /projects?foo=true` instead [!8962](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8962) - - `GET /projects/visible` & `GET /projects/all` are consolidated into `GET /projects` and can be used with or without authorization - - `GET /projects/owned` moved to `GET /projects?owned=true` - - `GET /projects/starred` moved to `GET /projects?starred=true` -- `GET /projects` returns all projects visible to current user, even if the user is not a member [!9674](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9674) - - To get projects the user is a member of, use `GET /projects?membership=true` -- Return pagination headers for all endpoints that return an array [!8606](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8606) -- Added `POST /environments/:environment_id/stop` to stop an environment [!8808](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8808) -- Removed `DELETE /projects/:id/deploy_keys/:key_id/disable`. Use `DELETE /projects/:id/deploy_keys/:key_id` instead [!9366](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9366) -- Moved `PUT /users/:id/(block|unblock)` to `POST /users/:id/(block|unblock)` [!9371](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9371) -- Make subscription API more RESTful. Use `POST /projects/:id/:subscribable_type/:subscribable_id/subscribe` to subscribe and `POST /projects/:id/:subscribable_type/:subscribable_id/unsubscribe` to unsubscribe from a resource. [!9325](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9325) -- Labels filter on `GET /projects/:id/issues` and `GET /issues` now matches only issues containing all labels (i.e.: Logical AND, not OR) [!8849](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8849) -- Renamed parameter `branch_name` to `branch` on the following endpoints [!8936](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8936) - - `POST /projects/:id/repository/branches` - - `POST /projects/:id/repository/commits` - - `POST/PUT/DELETE :id/repository/files` -- Renamed the `merge_when_build_succeeds` parameter to `merge_when_pipeline_succeeds` on the following endpoints: [!9335](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/) - - `PUT /projects/:id/merge_requests/:merge_request_id/merge` - - `POST /projects/:id/merge_requests/:merge_request_id/cancel_merge_when_pipeline_succeeds` - - `POST /projects` - - `POST /projects/user/:user_id` - - `PUT /projects/:id` -- Renamed `branch_name` to `branch` on `DELETE /projects/:id/repository/branches/:branch` response [!8936](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8936) -- Remove `public` parameter from create and edit actions of projects [!8736](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8736) -- Remove `subscribed` field from responses returning list of issues or merge - requests. Fetch individual issues or merge requests to obtain the value - of `subscribed` - [!9661](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9661) -- Use `visibility` as string parameter everywhere [!9337](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9337) -- Notes do not return deprecated field `upvote` and `downvote` [!9384](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9384) -- Return HTTP status code `400` for all validation errors when creating or updating a member instead of sometimes `422` error. [!9523](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9523) -- Remove `GET /groups/owned`. Use `GET /groups?owned=true` instead [!9505](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9505) -- Return 202 with JSON body on asynchronous removals on V4 API (`DELETE /projects/:id/repository/merged_branches` and `DELETE /projects/:id`) [!9449](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9449) -- `GET /projects/:id/milestones?iid[]=x&iid[]=y` array filter has been renamed to `iids` [!9096](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9096) -- Return basic information about pipeline in `GET /projects/:id/pipelines` [!8875](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8875) -- Renamed all `build` references to `job` [!9463](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9463) -- Drop `GET /projects/:id/repository/commits/:sha/jobs` [!9463](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9463) -- Rename Build Triggers to be Pipeline Triggers API [!9713](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9713) - - `POST /projects/:id/trigger/builds` to `POST /projects/:id/trigger/pipeline` - - Require description when creating a new trigger `POST /projects/:id/triggers` -- Simplify project payload exposed on Environment endpoints [!9675](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9675) -- API uses merge request `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the merge requests, award emoji, to-dos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9530) -- API uses issue `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the issues, award emoji, to-dos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9530) -- Change initial page from `0` to `1` on `GET /projects/:id/repository/commits` (like on the rest of the API) [!9679](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9679) -- Return correct `Link` header data for `GET /projects/:id/repository/commits` [!9679](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9679) -- Update endpoints for repository files [!9637](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9637) - - Moved `GET /projects/:id/repository/files?file_path=:file_path` to `GET /projects/:id/repository/files/:file_path` (`:file_path` should be URL-encoded) - - `GET /projects/:id/repository/blobs/:sha` now returns JSON attributes for the blob identified by `:sha`, instead of finding the commit identified by `:sha` and returning the raw content of the blob in that commit identified by the required `?filepath=:filepath` - - Moved `GET /projects/:id/repository/commits/:sha/blob?file_path=:file_path` and `GET /projects/:id/repository/blobs/:sha?file_path=:file_path` to `GET /projects/:id/repository/files/:file_path/raw?ref=:sha` - - `GET /projects/:id/repository/tree` parameter `ref_name` has been renamed to `ref` for consistency -- `confirm` parameter for `POST /users` has been deprecated in favor of `skip_confirmation` parameter +- [GitLab v3 API documentation](https://gitlab.com/gitlab-org/gitlab-foss/-/blob/8-16-stable/doc/api/README.md) +- [Migration guide](https://gitlab.com/gitlab-org/gitlab-foss/-/blob/11-0-stable/doc/api/v3_to_v4.md) from + v3 to v4 diff --git a/doc/api/version.md b/doc/api/version.md index 83b05dff1c8..313ba4da7d4 100644 --- a/doc/api/version.md +++ b/doc/api/version.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Create +group: Ecosystem info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- diff --git a/doc/api/vulnerabilities.md b/doc/api/vulnerabilities.md index a7412ca97f1..5ec769df08c 100644 --- a/doc/api/vulnerabilities.md +++ b/doc/api/vulnerabilities.md @@ -18,7 +18,7 @@ WARNING: This API is in the process of being deprecated and considered unstable. The response payload may be subject to change or breakage across GitLab releases. Please use the -[GraphQL API](graphql/reference/index.md#vulnerabilities) +[GraphQL API](graphql/reference/index.md#queryvulnerabilities) instead. Every API call to vulnerabilities must be [authenticated](README.md#authentication). |
