summaryrefslogtreecommitdiff
path: root/doc/api/graphql/reference/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/graphql/reference/index.md')
-rw-r--r--doc/api/graphql/reference/index.md2471
1 files changed, 1691 insertions, 780 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md
index 8ba1862b009..fc27298aff2 100644
--- a/doc/api/graphql/reference/index.md
+++ b/doc/api/graphql/reference/index.md
@@ -16,51 +16,62 @@ fields and methods on a model are available via GraphQL.
CAUTION: **Caution:**
Fields that are deprecated are marked with **{warning-solid}**.
-## AccessLevel
+## Object types
-Represents the access level of a relationship between a User and object that it is related to
+Object types represent the resources that GitLab's 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.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+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.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `integerValue` | Int | Integer representation of access level |
| `stringValue` | AccessLevelEnum | String representation of access level |
-## AddAwardEmojiPayload
+### AddAwardEmojiPayload
-Autogenerated return type of AddAwardEmoji
+Autogenerated return type of AddAwardEmoji.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## AddProjectToSecurityDashboardPayload
+### AddProjectToSecurityDashboardPayload
-Autogenerated return type of AddProjectToSecurityDashboard
+Autogenerated return type of AddProjectToSecurityDashboard.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `project` | Project | Project that was added to the Instance Security Dashboard |
-## AdminSidekiqQueuesDeleteJobsPayload
+### AdminSidekiqQueuesDeleteJobsPayload
-Autogenerated return type of AdminSidekiqQueuesDeleteJobs
+Autogenerated return type of AdminSidekiqQueuesDeleteJobs.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `result` | DeleteJobsResponse | Information about the status of the deletion request |
-## AlertManagementAlert
+### AlertManagementAlert
-Describes an alert from the project's Alert Management
+Describes an alert from the project's Alert Management.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createdAt` | Time | Timestamp the alert was created |
| `description` | String | Description of the alert |
| `details` | JSON | Alert details |
@@ -81,12 +92,12 @@ Describes an alert from the project's Alert Management
| `title` | String | Title of the alert |
| `updatedAt` | Time | Timestamp the alert was last updated |
-## AlertManagementAlertStatusCountsType
+### AlertManagementAlertStatusCountsType
-Represents total number of alerts for the represented categories
+Represents total number of alerts for the represented categories.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `acknowledged` | Int | Number of alerts with status ACKNOWLEDGED for the project |
| `all` | Int | Total number of alerts for the project |
| `ignored` | Int | Number of alerts with status IGNORED for the project |
@@ -94,36 +105,36 @@ Represents total number of alerts for the represented categories
| `resolved` | Int | Number of alerts with status RESOLVED for the project |
| `triggered` | Int | Number of alerts with status TRIGGERED for the project |
-## AlertSetAssigneesPayload
+### AlertSetAssigneesPayload
-Autogenerated return type of AlertSetAssignees
+Autogenerated return type of AlertSetAssignees.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `alert` | AlertManagementAlert | The alert after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation |
| `todo` | Todo | The todo after mutation |
-## AlertTodoCreatePayload
+### AlertTodoCreatePayload
-Autogenerated return type of AlertTodoCreate
+Autogenerated return type of AlertTodoCreate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `alert` | AlertManagementAlert | The alert after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation |
| `todo` | Todo | The todo after mutation |
-## AwardEmoji
+### AwardEmoji
An emoji awarded by a user.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `description` | String! | The emoji description |
| `emoji` | String! | The emoji as an icon |
| `name` | String! | The emoji name |
@@ -131,48 +142,48 @@ An emoji awarded by a user.
| `unicodeVersion` | String! | The unicode version for this emoji |
| `user` | User! | The user who awarded the emoji |
-## AwardEmojiAddPayload
+### AwardEmojiAddPayload
-Autogenerated return type of AwardEmojiAdd
+Autogenerated return type of AwardEmojiAdd.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## AwardEmojiRemovePayload
+### AwardEmojiRemovePayload
-Autogenerated return type of AwardEmojiRemove
+Autogenerated return type of AwardEmojiRemove.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## AwardEmojiTogglePayload
+### AwardEmojiTogglePayload
-Autogenerated return type of AwardEmojiToggle
+Autogenerated return type of AwardEmojiToggle.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `toggledOn` | Boolean! | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. |
-## BaseService
+### BaseService
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `active` | Boolean | Indicates if the service is active |
| `type` | String | Class name of the service |
-## Blob
+### Blob
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `flatPath` | String! | Flat path of the entry |
| `id` | ID! | ID of the entry |
| `lfsOid` | String | LFS ID of the blob |
@@ -184,12 +195,12 @@ Autogenerated return type of AwardEmojiToggle
| `webPath` | String | Web path of the blob |
| `webUrl` | String | Web URL of the blob |
-## Board
+### Board
-Represents a project or group board
+Represents a project or group board.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `assignee` | User | The board assignee. |
| `hideBacklogList` | Boolean | Whether or not backlog list is hidden. |
| `hideClosedList` | Boolean | Whether or not closed list is hidden. |
@@ -198,12 +209,12 @@ Represents a project or group board
| `name` | String | Name of the board |
| `weight` | Int | Weight of the board. |
-## BoardList
+### BoardList
-Represents a list for an issue board
+Represents a list for an issue board.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `assignee` | User | Assignee in the list |
| `collapsed` | Boolean | Indicates if list is collapsed for this user |
| `id` | ID! | ID (global ID) of the list |
@@ -218,66 +229,115 @@ Represents a list for an issue board
| `title` | String! | Title of the list |
| `totalWeight` | Int | Total weight of all issues in the list |
-## BoardListCreatePayload
+### BoardListCreatePayload
-Autogenerated return type of BoardListCreate
+Autogenerated return type of BoardListCreate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `list` | BoardList | List of the issue board |
-## BoardListUpdateLimitMetricsPayload
+### BoardListUpdateLimitMetricsPayload
-Autogenerated return type of BoardListUpdateLimitMetrics
+Autogenerated return type of BoardListUpdateLimitMetrics.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `list` | BoardList | The updated list |
-## Branch
+### Branch
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `commit` | Commit | Commit for the branch |
| `name` | String! | Name of the branch |
-## CiGroup
+### BurnupChartDailyTotals
+
+Represents the total number of issues and their weights for a particular day.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `completedCount` | Int! | Number of closed issues as of this day |
+| `completedWeight` | Int! | Total weight of closed issues as of this day |
+| `date` | ISO8601Date! | Date for burnup totals |
+| `scopeCount` | Int! | Number of issues as of this day |
+| `scopeWeight` | Int! | Total weight of issues as of this day |
-| Name | Type | Description |
-| --- | ---- | ---------- |
+### CiGroup
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `name` | String | Name of the job group |
| `size` | Int | Size of the group |
-## CiJob
+### CiJob
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `name` | String | Name of the job |
-## CiStage
+### CiStage
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `name` | String | Name of the stage |
-## ClusterAgent
+### ClusterAgent
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createdAt` | Time | Timestamp the cluster agent was created |
| `id` | ID! | ID of the cluster agent |
| `name` | String | Name of the cluster agent |
| `project` | Project | The project this cluster agent is associated with |
| `updatedAt` | Time | Timestamp the cluster agent was updated |
-## Commit
+### ClusterAgentDeletePayload
+
+Autogenerated return type of ClusterAgentDelete.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+
+### ClusterAgentToken
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clusterAgent` | ClusterAgent | Cluster agent this token is associated with |
+| `createdAt` | Time | Timestamp the token was created |
+| `id` | ClustersAgentTokenID! | Global ID of the token |
+
+### ClusterAgentTokenCreatePayload
+
+Autogenerated return type of ClusterAgentTokenCreate.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+| `secret` | String | Token secret value. Make sure you save it - you won't be able to access it again |
+| `token` | ClusterAgentToken | Token created after mutation |
+
+### ClusterAgentTokenDeletePayload
-| Name | Type | Description |
-| --- | ---- | ---------- |
+Autogenerated return type of ClusterAgentTokenDelete.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+
+### Commit
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `author` | User | Author of the commit |
| `authorGravatar` | String | Commit authors gravatar |
| `authorName` | String | Commit authors name |
@@ -294,40 +354,41 @@ Autogenerated return type of BoardListUpdateLimitMetrics
| `webPath` | String! | Web path of the commit |
| `webUrl` | String! | Web URL of the commit |
-## CommitCreatePayload
+### CommitCreatePayload
-Autogenerated return type of CommitCreate
+Autogenerated return type of CommitCreate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `commit` | Commit | The commit after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## ComplianceFramework
+### ComplianceFramework
-Represents a ComplianceFramework associated with a Project
+Represents a ComplianceFramework associated with a Project.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `name` | ProjectSettingEnum! | Name of the compliance framework |
-## ConfigureSastPayload
+### ConfigureSastPayload
-Autogenerated return type of ConfigureSast
+Autogenerated return type of ConfigureSast.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-| `result` | JSON | JSON containing the status of MR creation. |
+| `status` | String! | Status of creating the commit for the supplied SAST CI configuration |
+| `successPath` | String | Redirect path to use when the response is successful |
-## ContainerExpirationPolicy
+### ContainerExpirationPolicy
-A tag expiration policy designed to keep only the images that matter most
+A tag expiration policy designed to keep only the images that matter most.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `cadence` | ContainerExpirationPolicyCadenceEnum! | This container expiration policy schedule |
| `createdAt` | Time! | Timestamp of when the container expiration policy was created |
| `enabled` | Boolean! | Indicates whether this container expiration policy is enabled |
@@ -338,155 +399,187 @@ A tag expiration policy designed to keep only the images that matter most
| `olderThan` | ContainerExpirationPolicyOlderThanEnum | Tags older that this will expire |
| `updatedAt` | Time! | Timestamp of when the container expiration policy was updated |
-## CreateAlertIssuePayload
+### CreateAlertIssuePayload
-Autogenerated return type of CreateAlertIssue
+Autogenerated return type of CreateAlertIssue.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `alert` | AlertManagementAlert | The alert after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation |
| `todo` | Todo | The todo after mutation |
-## CreateAnnotationPayload
+### CreateAnnotationPayload
-Autogenerated return type of CreateAnnotation
+Autogenerated return type of CreateAnnotation.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `annotation` | MetricsDashboardAnnotation | The created annotation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## CreateBranchPayload
+### CreateBranchPayload
-Autogenerated return type of CreateBranch
+Autogenerated return type of CreateBranch.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `branch` | Branch | Branch after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## CreateClusterAgentPayload
+### CreateClusterAgentPayload
-Autogenerated return type of CreateClusterAgent
+Autogenerated return type of CreateClusterAgent.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `clusterAgent` | ClusterAgent | Cluster agent created after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## CreateDiffNotePayload
+### CreateDiffNotePayload
-Autogenerated return type of CreateDiffNote
+Autogenerated return type of CreateDiffNote.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `note` | Note | The note after mutation |
-## CreateEpicPayload
+### CreateEpicPayload
-Autogenerated return type of CreateEpic
+Autogenerated return type of CreateEpic.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The created epic |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## CreateImageDiffNotePayload
+### CreateImageDiffNotePayload
-Autogenerated return type of CreateImageDiffNote
+Autogenerated return type of CreateImageDiffNote.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `note` | Note | The note after mutation |
-## CreateIterationPayload
+### CreateIterationPayload
-Autogenerated return type of CreateIteration
+Autogenerated return type of CreateIteration.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `iteration` | Iteration | The created iteration |
-## CreateNotePayload
+### CreateNotePayload
-Autogenerated return type of CreateNote
+Autogenerated return type of CreateNote.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `note` | Note | The note after mutation |
-## CreateRequirementPayload
+### CreateRequirementPayload
-Autogenerated return type of CreateRequirement
+Autogenerated return type of CreateRequirement.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `requirement` | Requirement | The requirement after mutation |
-## CreateSnippetPayload
+### CreateSnippetPayload
-Autogenerated return type of CreateSnippet
+Autogenerated return type of CreateSnippet.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `snippet` | Snippet | The snippet after mutation |
-## DastOnDemandScanCreatePayload
+### CreateTestCasePayload
+
+Autogenerated return type of CreateTestCase.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+| `testCase` | Issue | The test case created |
+
+### DastOnDemandScanCreatePayload
-Autogenerated return type of DastOnDemandScanCreate
+Autogenerated return type of DastOnDemandScanCreate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `pipelineUrl` | String | URL of the pipeline that was created. |
-## DastScannerProfile
+### DastScannerProfile
Represents a DAST scanner profile.
-| Name | Type | Description |
-| --- | ---- | ---------- |
-| `id` | ID! | ID of the DAST scanner profile |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `editPath` | String | Relative web path to the edit page of a scanner profile |
+| `globalId` | DastScannerProfileID! | ID of the DAST scanner profile |
+| `id` **{warning-solid}** | ID! | **Deprecated:** Use `global_id`. Deprecated in 13.4 |
| `profileName` | String | Name of the DAST scanner profile |
-| `spiderTimeout` | Int | The maximum number of seconds allowed for the spider to traverse the site |
+| `spiderTimeout` | Int | The maximum number of minutes allowed for the spider to traverse the site |
| `targetTimeout` | Int | The maximum number of seconds allowed for the site under test to respond to a request |
-## DastScannerProfileCreatePayload
+### DastScannerProfileCreatePayload
-Autogenerated return type of DastScannerProfileCreate
+Autogenerated return type of DastScannerProfileCreate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-| `id` | ID | ID of the scanner profile. |
+| `globalId` | DastScannerProfileID | ID of the scanner profile. |
+| `id` **{warning-solid}** | ID | **Deprecated:** Use `global_id`. Deprecated in 13.4 |
-## DastSiteProfile
+### DastScannerProfileDeletePayload
+
+Autogenerated return type of DastScannerProfileDelete.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+
+### DastScannerProfileUpdatePayload
+
+Autogenerated return type of DastScannerProfileUpdate.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+| `id` | DastScannerProfileID | ID of the scanner profile. |
+
+### DastSiteProfile
Represents a DAST Site Profile.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `editPath` | String | Relative web path to the edit page of a site profile |
| `id` | DastSiteProfileID! | ID of the site profile |
| `profileName` | String | The name of the site profile |
@@ -494,68 +587,68 @@ Represents a DAST Site Profile.
| `userPermissions` | DastSiteProfilePermissions! | Permissions for the current user on the resource |
| `validationStatus` | DastSiteProfileValidationStatusEnum | The current validation status of the site profile |
-## DastSiteProfileCreatePayload
+### DastSiteProfileCreatePayload
-Autogenerated return type of DastSiteProfileCreate
+Autogenerated return type of DastSiteProfileCreate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `id` | DastSiteProfileID | ID of the site profile. |
-## DastSiteProfileDeletePayload
+### DastSiteProfileDeletePayload
-Autogenerated return type of DastSiteProfileDelete
+Autogenerated return type of DastSiteProfileDelete.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## DastSiteProfilePermissions
+### DastSiteProfilePermissions
-Check permissions for the current user on site profile
+Check permissions for the current user on site profile.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createOnDemandDastScan` | Boolean! | Indicates the user can perform `create_on_demand_dast_scan` on this resource |
-## DastSiteProfileUpdatePayload
+### DastSiteProfileUpdatePayload
-Autogenerated return type of DastSiteProfileUpdate
+Autogenerated return type of DastSiteProfileUpdate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `id` | DastSiteProfileID | ID of the site profile. |
-## DeleteAnnotationPayload
+### DeleteAnnotationPayload
-Autogenerated return type of DeleteAnnotation
+Autogenerated return type of DeleteAnnotation.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## DeleteJobsResponse
+### DeleteJobsResponse
The response from the AdminSidekiqQueuesDeleteJobs mutation.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `completed` | Boolean | Whether or not the entire queue was processed in time; if not, retrying the same request is safe |
| `deletedJobs` | Int | The number of matching jobs deleted |
| `queueSize` | Int | The queue size after processing |
-## Design
+### Design
-A single design
+A single design.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `diffRefs` | DiffRefs! | The diff refs for this design |
| `event` | DesignVersionEvent! | How this design was changed in the current version |
| `filename` | String! | The filename of the design |
@@ -567,13 +660,13 @@ A single design
| `notesCount` | Int! | The total count of user-created notes for this design |
| `project` | Project! | The project the design belongs to |
-## DesignAtVersion
+### DesignAtVersion
A design pinned to a specific version. The image field reflects the design as of the associated version.
-| Name | Type | Description |
-| --- | ---- | ---------- |
-| `design` | Design! | The underlying design. |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `design` | Design! | The underlying design |
| `diffRefs` | DiffRefs! | The diff refs for this design |
| `event` | DesignVersionEvent! | How this design was changed in the current version |
| `filename` | String! | The filename of the design |
@@ -586,90 +679,100 @@ A design pinned to a specific version. The image field reflects the design as of
| `project` | Project! | The project the design belongs to |
| `version` | DesignVersion! | The version this design-at-versions is pinned to |
-## DesignCollection
+### DesignCollection
A collection of designs.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `design` | Design | Find a specific design |
| `designAtVersion` | DesignAtVersion | Find a design as of a version |
| `issue` | Issue! | Issue associated with the design collection |
| `project` | Project! | Project associated with the design collection |
| `version` | DesignVersion | A specific version |
-## DesignManagement
+### DesignManagement
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `designAtVersion` | DesignAtVersion | Find a design as of a version |
| `version` | DesignVersion | Find a version |
-## DesignManagementDeletePayload
+### DesignManagementDeletePayload
-Autogenerated return type of DesignManagementDelete
+Autogenerated return type of DesignManagementDelete.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `version` | DesignVersion | The new version in which the designs are deleted |
-## DesignManagementMovePayload
+### DesignManagementMovePayload
-Autogenerated return type of DesignManagementMove
+Autogenerated return type of DesignManagementMove.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `designCollection` | DesignCollection | The current state of the collection |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## DesignManagementUploadPayload
+### DesignManagementUploadPayload
-Autogenerated return type of DesignManagementUpload
+Autogenerated return type of DesignManagementUpload.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `designs` | Design! => Array | The designs that were uploaded by the mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `skippedDesigns` | Design! => Array | Any designs that were skipped from the upload due to there being no change to their content since their last version |
-## DesignVersion
+### DesignVersion
-A specific version in which designs were added, modified or deleted
+A specific version in which designs were added, modified or deleted.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version |
| `id` | ID! | ID of the design version |
| `sha` | ID! | SHA of the design version |
-## DestroyNotePayload
+### DestroyBoardPayload
+
+Autogenerated return type of DestroyBoard.
-Autogenerated return type of DestroyNote
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `board` | Board | The board after mutation |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+
+### DestroyNotePayload
-| Name | Type | Description |
-| --- | ---- | ---------- |
+Autogenerated return type of DestroyNote.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `note` | Note | The note after mutation |
-## DestroySnippetPayload
+### DestroySnippetPayload
-Autogenerated return type of DestroySnippet
+Autogenerated return type of DestroySnippet.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `snippet` | Snippet | The snippet after mutation |
-## DetailedStatus
+### DetailedStatus
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `detailsPath` | String! | Path of the details for the pipeline status |
| `favicon` | String! | Favicon of the pipeline status |
| `group` | String! | Group of the pipeline status |
@@ -679,10 +782,10 @@ Autogenerated return type of DestroySnippet
| `text` | String! | Text of the pipeline status |
| `tooltip` | String! | Tooltip associated with the pipeline status |
-## DiffPosition
+### DiffPosition
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `diffRefs` | DiffRefs! | Information about the branch, HEAD, and base at the time of commenting |
| `filePath` | String! | Path of the file that was changed |
| `height` | Int | Total height of the image |
@@ -695,39 +798,39 @@ Autogenerated return type of DestroySnippet
| `x` | Int | X position of the note |
| `y` | Int | Y position of the note |
-## DiffRefs
+### DiffRefs
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `baseSha` | String | Merge base of the branch the comment was made on |
| `headSha` | String! | SHA of the HEAD at the time the comment was made |
| `startSha` | String! | SHA of the branch being compared against |
-## DiffStats
+### DiffStats
-Changes to a single file
+Changes to a single file.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `additions` | Int! | Number of lines added to this file |
| `deletions` | Int! | Number of lines deleted from this file |
| `path` | String! | File path, relative to repository root |
-## DiffStatsSummary
+### DiffStatsSummary
-Aggregated summary of changes
+Aggregated summary of changes.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `additions` | Int! | Number of lines added |
| `changes` | Int! | Number of lines changed |
| `deletions` | Int! | Number of lines deleted |
| `fileCount` | Int! | Number of files changed |
-## Discussion
+### Discussion
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createdAt` | Time! | Timestamp of the discussion's creation |
| `id` | ID! | ID of this discussion |
| `replyId` | ID! | ID used to reply to this discussion |
@@ -736,44 +839,44 @@ Aggregated summary of changes
| `resolvedAt` | Time | Timestamp of when the object was resolved |
| `resolvedBy` | User | User who resolved the object |
-## DiscussionToggleResolvePayload
+### DiscussionToggleResolvePayload
-Autogenerated return type of DiscussionToggleResolve
+Autogenerated return type of DiscussionToggleResolve.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `discussion` | Discussion | The discussion after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## DismissVulnerabilityPayload
+### DismissVulnerabilityPayload
-Autogenerated return type of DismissVulnerability
+Autogenerated return type of DismissVulnerability.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after dismissal |
-## Environment
+### Environment
-Describes where code is deployed for a project
+Describes where code is deployed for a project.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `id` | ID! | ID of the environment |
| `latestOpenedMostSevereAlert` | AlertManagementAlert | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. |
| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment |
| `name` | String! | Human-readable name of the environment |
| `state` | String! | State of the environment, for example: available/stopped |
-## Epic
+### Epic
Represents an epic.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `author` | User! | Author of the epic |
| `closedAt` | Time | Timestamp of the epic's closure |
| `confidential` | Boolean | Indicates if the epic is confidential |
@@ -810,53 +913,54 @@ Represents an epic.
| `webPath` | String! | Web path of the epic |
| `webUrl` | String! | Web URL of the epic |
-## EpicAddIssuePayload
+### EpicAddIssuePayload
-Autogenerated return type of EpicAddIssue
+Autogenerated return type of EpicAddIssue.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
| `epicIssue` | EpicIssue | The epic-issue relation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## EpicDescendantCount
+### EpicDescendantCount
Counts of descendent epics.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `closedEpics` | Int | Number of closed child epics |
| `closedIssues` | Int | Number of closed epic issues |
| `openedEpics` | Int | Number of opened child epics |
| `openedIssues` | Int | Number of opened epic issues |
-## EpicDescendantWeights
+### EpicDescendantWeights
-Total weight of open and closed descendant issues
+Total weight of open and closed descendant issues.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `closedIssues` | Int | Total weight of completed (closed) issues in this epic, including epic descendants |
| `openedIssues` | Int | Total weight of opened issues in this epic, including epic descendants |
-## EpicHealthStatus
+### EpicHealthStatus
-Health status of child issues
+Health status of child issues.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `issuesAtRisk` | Int | Number of issues at risk |
| `issuesNeedingAttention` | Int | Number of issues that need attention |
| `issuesOnTrack` | Int | Number of issues on track |
-## EpicIssue
+### EpicIssue
-Relationship between an epic and an issue
+Relationship between an epic and an issue.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue |
| `author` | User! | User that created the issue |
| `blocked` | Boolean! | Indicates the issue is blocked |
| `closedAt` | Time | Timestamp of when the issue was closed |
@@ -879,6 +983,7 @@ Relationship between an epic and an issue
| `reference` | String! | Internal reference of the issue. Returned in shortened format by default |
| `relationPath` | String | URI path of the epic-issue relation |
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) |
+| `severity` | IssuableSeverity | Severity level of the incident |
| `state` | IssueState! | State of the issue |
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page |
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue |
@@ -896,12 +1001,12 @@ Relationship between an epic and an issue
| `webUrl` | String! | Web URL of the issue |
| `weight` | Int | Weight of the issue |
-## EpicPermissions
+### EpicPermissions
-Check permissions for the current user on an epic
+Check permissions for the current user on an epic.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminEpic` | Boolean! | Indicates the user can perform `admin_epic` on this resource |
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
| `createEpic` | Boolean! | Indicates the user can perform `create_epic` on this resource |
@@ -911,29 +1016,29 @@ Check permissions for the current user on an epic
| `readEpicIid` | Boolean! | Indicates the user can perform `read_epic_iid` on this resource |
| `updateEpic` | Boolean! | Indicates the user can perform `update_epic` on this resource |
-## EpicSetSubscriptionPayload
+### EpicSetSubscriptionPayload
-Autogenerated return type of EpicSetSubscription
+Autogenerated return type of EpicSetSubscription.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## EpicTreeReorderPayload
+### EpicTreeReorderPayload
-Autogenerated return type of EpicTreeReorder
+Autogenerated return type of EpicTreeReorder.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## GeoNode
+### GeoNode
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `containerRepositoriesMaxCapacity` | Int | The maximum concurrency of container repository sync for this secondary node |
| `enabled` | Boolean | Indicates whether this Geo node is enabled |
| `filesMaxCapacity` | Int | The maximum concurrency of LFS/attachment backfill for this secondary node |
@@ -949,10 +1054,10 @@ Autogenerated return type of EpicTreeReorder
| `url` | String | The user-facing URL for this Geo node |
| `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node |
-## GrafanaIntegration
+### GrafanaIntegration
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createdAt` | Time! | Timestamp of the issue's creation |
| `enabled` | Boolean! | Indicates whether Grafana integration is enabled |
| `grafanaUrl` | String! | URL for the Grafana host for the Grafana integration |
@@ -960,10 +1065,10 @@ Autogenerated return type of EpicTreeReorder
| `token` **{warning-solid}** | String! | **Deprecated:** Plain text token has been masked for security reasons. Deprecated in 12.7 |
| `updatedAt` | Time! | Timestamp of the issue's last activity |
-## Group
+### Group
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `autoDevopsEnabled` | Boolean | Indicates whether Auto DevOps is enabled for all projects within this group |
| `avatarUrl` | String | Avatar URL of the group |
| `board` | Board | A single board of the group |
@@ -995,38 +1100,53 @@ Autogenerated return type of EpicTreeReorder
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |
| `visibility` | String | Visibility of the namespace |
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade |
+| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the group and its subgroups |
| `webUrl` | String! | Web URL of the group |
-## GroupMember
+### GroupMember
-Represents a Group Member
+Represents a Group Membership.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `accessLevel` | AccessLevel | GitLab::Access level |
| `createdAt` | Time | Date and time the membership was created |
| `createdBy` | User | User that authorized membership |
| `expiresAt` | Time | Date and time the membership expires |
| `group` | Group | Group that a User is a member of |
+| `id` | ID! | ID of the member |
| `updatedAt` | Time | Date and time the membership was last updated |
+| `user` | User! | User that is associated with the member object |
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |
-## GroupPermissions
+### GroupPermissions
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `readGroup` | Boolean! | Indicates the user can perform `read_group` on this resource |
-## InstanceSecurityDashboard
+### InstanceSecurityDashboard
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade |
+| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard |
+
+### InstanceStatisticsMeasurement
+
+Represents a recorded measurement (object count) for the Admins.
-## Issue
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `count` | Int! | Object count |
+| `identifier` | MeasurementIdentifier! | The type of objects being measured |
+| `recordedAt` | Time | The time the measurement was recorded |
-| Name | Type | Description |
-| --- | ---- | ---------- |
+### Issue
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue |
| `author` | User! | User that created the issue |
| `blocked` | Boolean! | Indicates the issue is blocked |
| `closedAt` | Time | Timestamp of when the issue was closed |
@@ -1047,6 +1167,7 @@ Represents a Group Member
| `milestone` | Milestone | Milestone of the issue |
| `reference` | String! | Internal reference of the issue. Returned in shortened format by default |
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) |
+| `severity` | IssuableSeverity | Severity level of the incident |
| `state` | IssueState! | State of the issue |
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page |
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue |
@@ -1064,22 +1185,22 @@ Represents a Group Member
| `webUrl` | String! | Web URL of the issue |
| `weight` | Int | Weight of the issue |
-## IssueMoveListPayload
+### IssueMoveListPayload
-Autogenerated return type of IssueMoveList
+Autogenerated return type of IssueMoveList.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssuePermissions
+### IssuePermissions
-Check permissions for the current user on a issue
+Check permissions for the current user on a issue.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminIssue` | Boolean! | Indicates the user can perform `admin_issue` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
@@ -1089,102 +1210,113 @@ Check permissions for the current user on a issue
| `reopenIssue` | Boolean! | Indicates the user can perform `reopen_issue` on this resource |
| `updateIssue` | Boolean! | Indicates the user can perform `update_issue` on this resource |
-## IssueSetAssigneesPayload
+### IssueSetAssigneesPayload
+
+Autogenerated return type of IssueSetAssignees.
-Autogenerated return type of IssueSetAssignees
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+| `issue` | Issue | The issue after mutation |
+
+### IssueSetConfidentialPayload
+
+Autogenerated return type of IssueSetConfidential.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssueSetConfidentialPayload
+### IssueSetDueDatePayload
-Autogenerated return type of IssueSetConfidential
+Autogenerated return type of IssueSetDueDate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssueSetDueDatePayload
+### IssueSetEpicPayload
-Autogenerated return type of IssueSetDueDate
+Autogenerated return type of IssueSetEpic.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssueSetEpicPayload
+### IssueSetIterationPayload
-Autogenerated return type of IssueSetEpic
+Autogenerated return type of IssueSetIteration.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssueSetIterationPayload
+### IssueSetLockedPayload
-Autogenerated return type of IssueSetIteration
+Autogenerated return type of IssueSetLocked.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssueSetLockedPayload
+### IssueSetSeverityPayload
-Autogenerated return type of IssueSetLocked
+Autogenerated return type of IssueSetSeverity.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssueSetSubscriptionPayload
+### IssueSetSubscriptionPayload
-Autogenerated return type of IssueSetSubscription
+Autogenerated return type of IssueSetSubscription.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssueSetWeightPayload
+### IssueSetWeightPayload
-Autogenerated return type of IssueSetWeight
+Autogenerated return type of IssueSetWeight.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## IssueStatusCountsType
+### IssueStatusCountsType
Represents total number of issues for the represented statuses.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `all` | Int | Number of issues with status ALL for the project |
| `closed` | Int | Number of issues with status CLOSED for the project |
| `opened` | Int | Number of issues with status OPENED for the project |
-## Iteration
+### Iteration
Represents an iteration object.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts |
| `createdAt` | Time! | Timestamp of iteration creation |
| `description` | String | Description of the iteration |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
@@ -1200,10 +1332,10 @@ Represents an iteration object.
| `webPath` | String! | Web path of the iteration |
| `webUrl` | String! | Web URL of the iteration |
-## JiraImport
+### JiraImport
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createdAt` | Time | Timestamp of when the Jira import was created |
| `failedToImportCount` | Int! | Count of issues that failed to import |
| `importedIssuesCount` | Int! | Count of issues that were successfully imported |
@@ -1212,56 +1344,56 @@ Represents an iteration object.
| `scheduledBy` | User | User that started the Jira import |
| `totalIssueCount` | Int! | Total count of issues that were attempted to import |
-## JiraImportStartPayload
+### JiraImportStartPayload
-Autogenerated return type of JiraImportStart
+Autogenerated return type of JiraImportStart.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `jiraImport` | JiraImport | The Jira import data after mutation |
-## JiraImportUsersPayload
+### JiraImportUsersPayload
-Autogenerated return type of JiraImportUsers
+Autogenerated return type of JiraImportUsers.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `jiraUsers` | JiraUser! => Array | Users returned from Jira, matched by email and name if possible. |
-## JiraProject
+### JiraProject
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `key` | String! | Key of the Jira project |
| `name` | String | Name of the Jira project |
| `projectId` | Int! | ID of the Jira project |
-## JiraService
+### JiraService
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `active` | Boolean | Indicates if the service is active |
| `type` | String | Class name of the service |
-## JiraUser
+### JiraUser
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `gitlabId` | Int | ID of the matched GitLab user |
| `gitlabName` | String | Name of the matched GitLab user |
| `gitlabUsername` | String | Username of the matched GitLab user |
-| `jiraAccountId` | String! | Account id of the Jira user |
+| `jiraAccountId` | String! | Account ID of the Jira user |
| `jiraDisplayName` | String! | Display name of the Jira user |
| `jiraEmail` | String | Email of the Jira user, returned only for users with public emails |
-## Label
+### Label
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `color` | String! | Background color of the label |
| `description` | String | Description of the label (Markdown rendered as HTML for caching) |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
@@ -1269,23 +1401,28 @@ Autogenerated return type of JiraImportUsers
| `textColor` | String! | Text color of the label |
| `title` | String! | Content of the label |
-## MarkAsSpamSnippetPayload
+### MarkAsSpamSnippetPayload
-Autogenerated return type of MarkAsSpamSnippet
+Autogenerated return type of MarkAsSpamSnippet.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `snippet` | Snippet | The snippet after mutation |
-## MergeRequest
+### MergeRequest
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `allowCollaboration` | Boolean | Indicates if members of the target project can push to the fork |
+| `approvalsLeft` | Int | Number of approvals left |
+| `approvalsRequired` | Int | Number of approvals required |
+| `approved` | Boolean! | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. |
| `author` | User | User who created this merge request |
+| `autoMergeEnabled` | Boolean! | Indicates if auto merge is enabled for the merge request |
| `commitCount` | Int | Number of commits in the merge request |
+| `conflicts` | Boolean! | Indicates if the merge request has conflicts |
| `createdAt` | Time! | Timestamp of when the merge request was created |
| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request |
| `description` | String | Description of the merge request (Markdown rendered as HTML for caching) |
@@ -1339,23 +1476,24 @@ Autogenerated return type of MarkAsSpamSnippet
| `webUrl` | String | Web URL of the merge request |
| `workInProgress` | Boolean! | Indicates if the merge request is a work in progress (WIP) |
-## MergeRequestCreatePayload
+### MergeRequestCreatePayload
-Autogenerated return type of MergeRequestCreate
+Autogenerated return type of MergeRequestCreate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |
-## MergeRequestPermissions
+### MergeRequestPermissions
-Check permissions for the current user on a merge request
+Check permissions for the current user on a merge request.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminMergeRequest` | Boolean! | Indicates the user can perform `admin_merge_request` on this resource |
+| `canMerge` | Boolean! | Indicates the user can perform `can_merge` on this resource |
| `cherryPickOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource |
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
| `pushToSourceBranch` | Boolean! | Indicates the user can perform `push_to_source_branch` on this resource |
@@ -1364,106 +1502,107 @@ Check permissions for the current user on a merge request
| `revertOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `revert_on_current_merge_request` on this resource |
| `updateMergeRequest` | Boolean! | Indicates the user can perform `update_merge_request` on this resource |
-## MergeRequestSetAssigneesPayload
+### MergeRequestSetAssigneesPayload
-Autogenerated return type of MergeRequestSetAssignees
+Autogenerated return type of MergeRequestSetAssignees.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |
-## MergeRequestSetLabelsPayload
+### MergeRequestSetLabelsPayload
-Autogenerated return type of MergeRequestSetLabels
+Autogenerated return type of MergeRequestSetLabels.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |
-## MergeRequestSetLockedPayload
+### MergeRequestSetLockedPayload
-Autogenerated return type of MergeRequestSetLocked
+Autogenerated return type of MergeRequestSetLocked.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |
-## MergeRequestSetMilestonePayload
+### MergeRequestSetMilestonePayload
-Autogenerated return type of MergeRequestSetMilestone
+Autogenerated return type of MergeRequestSetMilestone.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |
-## MergeRequestSetSubscriptionPayload
+### MergeRequestSetSubscriptionPayload
-Autogenerated return type of MergeRequestSetSubscription
+Autogenerated return type of MergeRequestSetSubscription.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |
-## MergeRequestSetWipPayload
+### MergeRequestSetWipPayload
-Autogenerated return type of MergeRequestSetWip
+Autogenerated return type of MergeRequestSetWip.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |
-## MergeRequestUpdatePayload
+### MergeRequestUpdatePayload
-Autogenerated return type of MergeRequestUpdate
+Autogenerated return type of MergeRequestUpdate.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |
-## Metadata
+### Metadata
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `revision` | String! | Revision |
| `version` | String! | Version |
-## MetricsDashboard
+### MetricsDashboard
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `path` | String | Path to a file with the dashboard definition |
| `schemaValidationWarnings` | String! => Array | Dashboard schema validation warnings |
-## MetricsDashboardAnnotation
+### MetricsDashboardAnnotation
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `description` | String | Description of the annotation |
| `endingAt` | Time | Timestamp marking end of annotated time span |
| `id` | ID! | ID of the annotation |
| `panelId` | String | ID of a dashboard panel to which the annotation should be scoped |
| `startingAt` | Time | Timestamp marking start of annotated time span |
-## Milestone
+### Milestone
Represents a milestone.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts |
| `createdAt` | Time! | Timestamp of milestone creation |
| `description` | String | Description of the milestone |
| `dueDate` | Time | Timestamp of the milestone due date |
@@ -1478,19 +1617,19 @@ Represents a milestone.
| `updatedAt` | Time! | Timestamp of last milestone update |
| `webPath` | String! | Web path of the milestone |
-## MilestoneStats
+### MilestoneStats
-Contains statistics about a milestone
+Contains statistics about a milestone.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `closedIssuesCount` | Int | Number of closed issues associated with the milestone |
| `totalIssuesCount` | Int | Total number of issues associated with the milestone |
-## Namespace
+### Namespace
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `description` | String | Description of the namespace |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `fullName` | String! | Full name of the namespace |
@@ -1506,20 +1645,20 @@ Contains statistics about a milestone
| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active |
| `visibility` | String | Visibility of the namespace |
-## NamespaceIncreaseStorageTemporarilyPayload
+### NamespaceIncreaseStorageTemporarilyPayload
-Autogenerated return type of NamespaceIncreaseStorageTemporarily
+Autogenerated return type of NamespaceIncreaseStorageTemporarily.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `namespace` | Namespace | The namespace after mutation |
-## Note
+### Note
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `author` | User! | User who wrote this note |
| `body` | String! | Content of the note |
| `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` |
@@ -1538,22 +1677,22 @@ Autogenerated return type of NamespaceIncreaseStorageTemporarily
| `updatedAt` | Time! | Timestamp of the note's last activity |
| `userPermissions` | NotePermissions! | Permissions for the current user on the resource |
-## NotePermissions
+### NotePermissions
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminNote` | Boolean! | Indicates the user can perform `admin_note` on this resource |
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
| `readNote` | Boolean! | Indicates the user can perform `read_note` on this resource |
| `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource |
-## Package
+### Package
-Represents a package
+Represents a package.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createdAt` | Time! | The created date |
| `id` | ID! | The ID of the package |
| `name` | String! | The name of the package |
@@ -1561,12 +1700,12 @@ Represents a package
| `updatedAt` | Time! | The update date |
| `version` | String | The version of the package |
-## PackageFileRegistry
+### PackageFileRegistry
-Represents the sync and verification state of a package file
+Represents the sync and verification state of a package file.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createdAt` | Time | Timestamp when the PackageFileRegistry was created |
| `id` | ID! | ID of the PackageFileRegistry |
| `lastSyncFailure` | String | Error message during sync of the PackageFileRegistry |
@@ -1576,22 +1715,23 @@ Represents the sync and verification state of a package file
| `retryCount` | Int | Number of consecutive failed sync attempts of the PackageFileRegistry |
| `state` | RegistryState | Sync state of the PackageFileRegistry |
-## PageInfo
+### PageInfo
-Information about pagination in a connection.
+Information about pagination in a connection..
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `endCursor` | String | When paginating forwards, the cursor to continue. |
| `hasNextPage` | Boolean! | When paginating forwards, are there more items? |
| `hasPreviousPage` | Boolean! | When paginating backwards, are there more items? |
| `startCursor` | String | When paginating backwards, the cursor to continue. |
-## Pipeline
+### Pipeline
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `beforeSha` | String | Base SHA of the source branch |
+| `cancelable` | Boolean! | Specifies if a pipeline can be canceled |
| `committedAt` | Time | Timestamp of the pipeline's commit |
| `configSource` | PipelineConfigSourceEnum | Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE) |
| `coverage` | Float | Coverage percentage |
@@ -1601,6 +1741,7 @@ Information about pagination in a connection.
| `finishedAt` | Time | Timestamp of the pipeline's completion |
| `id` | ID! | ID of the pipeline |
| `iid` | String! | Internal ID of the pipeline |
+| `retryable` | Boolean! | Specifies if a pipeline can be retried |
| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline |
| `sha` | String! | SHA of the pipeline's commit |
| `startedAt` | Time | Timestamp when the pipeline was started |
@@ -1609,18 +1750,46 @@ Information about pagination in a connection.
| `user` | User | Pipeline user |
| `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource |
-## PipelinePermissions
+### PipelineCancelPayload
+
+Autogenerated return type of PipelineCancel.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+
+### PipelineDestroyPayload
-| Name | Type | Description |
-| --- | ---- | ---------- |
+Autogenerated return type of PipelineDestroy.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+
+### PipelinePermissions
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminPipeline` | Boolean! | Indicates the user can perform `admin_pipeline` on this resource |
| `destroyPipeline` | Boolean! | Indicates the user can perform `destroy_pipeline` on this resource |
| `updatePipeline` | Boolean! | Indicates the user can perform `update_pipeline` on this resource |
-## Project
+### PipelineRetryPayload
+
+Autogenerated return type of PipelineRetry.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+| `pipeline` | Pipeline | The pipeline after mutation |
+
+### Project
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project |
| `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project |
| `allowMergeOnSkippedPipeline` | Boolean | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs |
@@ -1628,9 +1797,11 @@ Information about pagination in a connection.
| `autocloseReferencedIssues` | Boolean | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically |
| `avatarUrl` | String | URL to avatar image file of the project |
| `board` | Board | A single board of the project |
+| `clusterAgent` | ClusterAgent | Find a single cluster agent by name |
| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy of the project |
| `containerRegistryEnabled` | Boolean | Indicates if the project stores Docker container images in a container registry |
| `createdAt` | Time | Timestamp of the project creation |
+| `dastSiteProfile` | DastSiteProfile | DAST Site Profile associated with the project |
| `description` | String | Short description of the project |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `environment` | Environment | A single environment of the project |
@@ -1675,7 +1846,7 @@ Information about pagination in a connection.
| `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project |
| `serviceDeskAddress` | String | E-mail address of the service desk. |
| `serviceDeskEnabled` | Boolean | Indicates if the project has service desk enabled. |
-| `sharedRunnersEnabled` | Boolean | Indicates if Shared Runners are enabled for the project |
+| `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project |
| `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user |
| `sshUrlToRepo` | String | URL to connect to the project via SSH |
| `starCount` | Int! | Number of times the project has been starred |
@@ -1684,16 +1855,16 @@ Information about pagination in a connection.
| `tagList` | String | List of project topics (not Git tags) |
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
| `visibility` | String | Visibility of the project |
-| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each severity of vulnerability of the project |
+| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the project |
| `webUrl` | String | Web URL of the project |
| `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user |
-## ProjectMember
+### ProjectMember
-Represents a Project Member
+Represents a Project Membership.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `accessLevel` | AccessLevel | GitLab::Access level |
| `createdAt` | Time | Date and time the membership was created |
| `createdBy` | User | User that authorized membership |
@@ -1704,10 +1875,10 @@ Represents a Project Member
| `user` | User! | User that is associated with the member object |
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
-## ProjectPermissions
+### ProjectPermissions
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminOperations` | Boolean! | Indicates the user can perform `admin_operations` on this resource |
| `adminProject` | Boolean! | Indicates the user can perform `admin_project` on this resource |
| `adminRemoteMirror` | Boolean! | Indicates the user can perform `admin_remote_mirror` on this resource |
@@ -1751,10 +1922,10 @@ Represents a Project Member
| `updateWiki` | Boolean! | Indicates the user can perform `update_wiki` on this resource |
| `uploadFile` | Boolean! | Indicates the user can perform `upload_file` on this resource |
-## ProjectStatistics
+### ProjectStatistics
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `buildArtifactsSize` | Float! | Build artifacts size of the project |
| `commitCount` | Float! | Commit count of the project |
| `lfsObjectsSize` | Float! | Large File Storage (LFS) object size of the project |
@@ -1764,21 +1935,21 @@ Represents a Project Member
| `storageSize` | Float! | Storage size of the project |
| `wikiSize` | Float | Wiki size of the project |
-## PrometheusAlert
+### PrometheusAlert
-The alert condition for Prometheus
+The alert condition for Prometheus.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `humanizedText` | String! | The human-readable text of the alert condition |
| `id` | ID! | ID of the alert condition |
-## Release
+### Release
-Represents a release
+Represents a release.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `assets` | ReleaseAssets | Assets of the release |
| `author` | User | User that created the release |
| `commit` | Commit | The commit associated with the release |
@@ -1790,125 +1961,128 @@ Represents a release
| `releasedAt` | Time | Timestamp of when the release was released |
| `tagName` | String | Name of the tag associated with the release |
| `tagPath` | String | Relative web path to the tag associated with the release |
+| `upcomingRelease` | Boolean | Indicates the release is an upcoming release |
-## ReleaseAssetLink
+### ReleaseAssetLink
-Represents an asset link associated with a release
+Represents an asset link associated with a release.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `directAssetUrl` | String | Direct asset URL of the link |
| `external` | Boolean | Indicates the link points to an external resource |
| `id` | ID! | ID of the link |
| `linkType` | ReleaseAssetLinkType | Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other` |
| `name` | String | Name of the link |
| `url` | String | URL of the link |
-## ReleaseAssets
+### ReleaseAssets
-A container for all assets associated with a release
+A container for all assets associated with a release.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `count` | Int | Number of assets of the release |
-## ReleaseEvidence
+### ReleaseEvidence
-Evidence for a release
+Evidence for a release.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `collectedAt` | Time | Timestamp when the evidence was collected |
| `filepath` | String | URL from where the evidence can be downloaded |
| `id` | ID! | ID of the evidence |
| `sha` | String | SHA1 ID of the evidence hash |
-## ReleaseLinks
+### ReleaseLinks
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `editUrl` | String | HTTP URL of the release's edit page |
| `issuesUrl` | String | HTTP URL of the issues page filtered by this release |
| `mergeRequestsUrl` | String | HTTP URL of the merge request page filtered by this release |
| `selfUrl` | String | HTTP URL of the release |
-## ReleaseSource
+### ReleaseSource
-Represents the source code attached to a release in a particular format
+Represents the source code attached to a release in a particular format.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `format` | String | Format of the source |
| `url` | String | Download URL of the source |
-## RemoveAwardEmojiPayload
+### RemoveAwardEmojiPayload
-Autogenerated return type of RemoveAwardEmoji
+Autogenerated return type of RemoveAwardEmoji.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## RemoveProjectFromSecurityDashboardPayload
+### RemoveProjectFromSecurityDashboardPayload
-Autogenerated return type of RemoveProjectFromSecurityDashboard
+Autogenerated return type of RemoveProjectFromSecurityDashboard.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## Repository
+### Repository
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `empty` | Boolean! | Indicates repository has no visible content |
| `exists` | Boolean! | Indicates a corresponding Git repository exists on disk |
| `rootRef` | String | Default branch of the repository |
| `tree` | Tree | Tree of the repository |
-## Requirement
+### Requirement
-Represents a requirement
+Represents a requirement.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `author` | User! | Author of the requirement |
| `createdAt` | Time! | Timestamp of when the requirement was created |
| `id` | ID! | ID of the requirement |
| `iid` | ID! | Internal ID of the requirement |
+| `lastTestReportState` | TestReportState | Latest requirement test report state |
| `project` | Project! | Project to which the requirement belongs |
| `state` | RequirementState! | State of the requirement |
| `title` | String | Title of the requirement |
| `updatedAt` | Time! | Timestamp of when the requirement was last updated |
| `userPermissions` | RequirementPermissions! | Permissions for the current user on the resource |
-## RequirementPermissions
+### RequirementPermissions
-Check permissions for the current user on a requirement
+Check permissions for the current user on a requirement.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminRequirement` | Boolean! | Indicates the user can perform `admin_requirement` on this resource |
| `createRequirement` | Boolean! | Indicates the user can perform `create_requirement` on this resource |
| `destroyRequirement` | Boolean! | Indicates the user can perform `destroy_requirement` on this resource |
| `readRequirement` | Boolean! | Indicates the user can perform `read_requirement` on this resource |
| `updateRequirement` | Boolean! | Indicates the user can perform `update_requirement` on this resource |
-## RequirementStatesCount
+### RequirementStatesCount
Counts of requirements by their state.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `archived` | Int | Number of archived requirements |
| `opened` | Int | Number of opened requirements |
-## RootStorageStatistics
+### RootStorageStatistics
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `buildArtifactsSize` | Float! | The CI artifacts size in bytes |
| `lfsObjectsSize` | Float! | The LFS objects size in bytes |
| `packagesSize` | Float! | The packages size in bytes |
@@ -1917,33 +2091,33 @@ Counts of requirements by their state.
| `storageSize` | Float! | The total storage in bytes |
| `wikiSize` | Float! | The wiki size in bytes |
-## RunDASTScanPayload
+### RunDASTScanPayload
-Autogenerated return type of RunDASTScan
+Autogenerated return type of RunDASTScan.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `pipelineUrl` | String | URL of the pipeline that was created. |
-## SastCiConfigurationAnalyzersEntity
+### SastCiConfigurationAnalyzersEntity
-Represents an analyzer entity in SAST CI configuration
+Represents an analyzer entity in SAST CI configuration.
-| Name | Type | Description |
-| --- | ---- | ---------- |
-| `description` | String | Analyzer description that is displayed on the form. |
-| `enabled` | Boolean | Indicates whether an analyzer is enabled. |
-| `label` | String | Analyzer label used in the config UI. |
-| `name` | String | Name of the analyzer. |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `description` | String | Analyzer description that is displayed on the form |
+| `enabled` | Boolean | Indicates whether an analyzer is enabled |
+| `label` | String | Analyzer label used in the config UI |
+| `name` | String | Name of the analyzer |
-## SastCiConfigurationEntity
+### SastCiConfigurationEntity
-Represents an entity in SAST CI configuration
+Represents an entity in SAST CI configuration.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `defaultValue` | String | Default value that is used if value is empty. |
| `description` | String | Entity description that is displayed on the form. |
| `field` | String | CI keyword of entity. |
@@ -1952,30 +2126,30 @@ Represents an entity in SAST CI configuration
| `type` | String | Type of the field value. |
| `value` | String | Current value of the entity. |
-## SastCiConfigurationOptionsEntity
+### SastCiConfigurationOptionsEntity
-Represents an entity for options in SAST CI configuration
+Represents an entity for options in SAST CI configuration.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `label` | String | Label of option entity. |
| `value` | String | Value of option entity. |
-## ScannedResource
+### ScannedResource
-Represents a resource scanned by a security scan
+Represents a resource scanned by a security scan.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `requestMethod` | String | The HTTP request method used to access the URL |
| `url` | String | The URL scanned by the scanner |
-## SecurityReportSummary
+### SecurityReportSummary
-Represents summary of a security report
+Represents summary of a security report.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `containerScanning` | SecurityReportSummarySection | Aggregated counts for the container_scanning scan |
| `coverageFuzzing` | SecurityReportSummarySection | Aggregated counts for the coverage_fuzzing scan |
| `dast` | SecurityReportSummarySection | Aggregated counts for the dast scan |
@@ -1983,32 +2157,32 @@ Represents summary of a security report
| `sast` | SecurityReportSummarySection | Aggregated counts for the sast scan |
| `secretDetection` | SecurityReportSummarySection | Aggregated counts for the secret_detection scan |
-## SecurityReportSummarySection
+### SecurityReportSummarySection
-Represents a section of a summary of a security report
+Represents a section of a summary of a security report.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `scannedResourcesCount` | Int | Total number of scanned resources |
| `scannedResourcesCsvPath` | String | Path to download all the scanned resources in CSV format |
| `vulnerabilitiesCount` | Int | Total number of vulnerabilities |
-## SecurityScanners
+### SecurityScanners
-Represents a list of security scanners
+Represents a list of security scanners.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `available` | SecurityScannerType! => Array | List of analyzers which are available for the project. |
| `enabled` | SecurityScannerType! => Array | List of analyzers which are enabled for the project. |
| `pipelineRun` | SecurityScannerType! => Array | List of analyzers which ran successfully in the latest pipeline. |
-## SentryDetailedError
+### SentryDetailedError
A Sentry error.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `count` | Int! | Count of occurrences |
| `culprit` | String! | Culprit of the error |
| `externalBaseUrl` | String! | External Base URL of the Sentry Instance |
@@ -2038,12 +2212,12 @@ A Sentry error.
| `type` | String! | Type of the error |
| `userCount` | Int! | Count of users affected by the error |
-## SentryError
+### SentryError
A Sentry error. A simplified version of SentryDetailedError.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `count` | Int! | Count of occurrences |
| `culprit` | String! | Culprit of the error |
| `externalUrl` | String! | External URL of the error |
@@ -2062,70 +2236,70 @@ A Sentry error. A simplified version of SentryDetailedError.
| `type` | String! | Type of the error |
| `userCount` | Int! | Count of users affected by the error |
-## SentryErrorCollection
+### SentryErrorCollection
An object containing a collection of Sentry errors, and a detailed error.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `detailedError` | SentryDetailedError | Detailed version of a Sentry error on the project |
| `errorStackTrace` | SentryErrorStackTrace | Stack Trace of Sentry Error |
| `errors` | SentryErrorConnection | Collection of Sentry Errors |
| `externalUrl` | String | External URL for Sentry |
-## SentryErrorFrequency
+### SentryErrorFrequency
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `count` | Int! | Count of errors received since the previously recorded time |
| `time` | Time! | Time the error frequency stats were recorded |
-## SentryErrorStackTrace
+### SentryErrorStackTrace
An object containing a stack trace entry for a Sentry error.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `dateReceived` | String! | Time the stack trace was received by Sentry |
| `issueId` | String! | ID of the Sentry error |
| `stackTraceEntries` | SentryErrorStackTraceEntry! => Array | Stack trace entries for the Sentry error |
-## SentryErrorStackTraceContext
+### SentryErrorStackTraceContext
-An object context for a Sentry error stack trace
+An object context for a Sentry error stack trace.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `code` | String! | Code number of the context |
| `line` | Int! | Line number of the context |
-## SentryErrorStackTraceEntry
+### SentryErrorStackTraceEntry
An object containing a stack trace entry for a Sentry error.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `col` | String | Function in which the Sentry error occurred |
| `fileName` | String | File in which the Sentry error occurred |
| `function` | String | Function in which the Sentry error occurred |
| `line` | String | Function in which the Sentry error occurred |
| `traceContext` | SentryErrorStackTraceContext! => Array | Context of the Sentry error |
-## SentryErrorTags
+### SentryErrorTags
-State of a Sentry error
+State of a Sentry error.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `level` | String | Severity level of the Sentry Error |
| `logger` | String | Logger of the Sentry Error |
-## Snippet
+### Snippet
-Represents a snippet entry
+Represents a snippet entry.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `author` | User | The owner of the snippet |
| `blob` **{warning-solid}** | SnippetBlob! | **Deprecated:** Use `blobs`. Deprecated in 13.3 |
| `blobs` | SnippetBlob! => Array | Snippet blobs |
@@ -2144,12 +2318,12 @@ Represents a snippet entry
| `visibilityLevel` | VisibilityLevelsEnum! | Visibility Level of the snippet |
| `webUrl` | String! | Web URL of the snippet |
-## SnippetBlob
+### SnippetBlob
-Represents the snippet blob
+Represents the snippet blob.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `binary` | Boolean! | Shows whether the blob is binary |
| `externalStorage` | String | Blob external storage |
| `mode` | String | Blob mode |
@@ -2163,12 +2337,12 @@ Represents the snippet blob
| `simpleViewer` | SnippetBlobViewer! | Blob content simple viewer |
| `size` | Int! | Blob size |
-## SnippetBlobViewer
+### SnippetBlobViewer
-Represents how the blob content should be displayed
+Represents how the blob content should be displayed.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `collapsed` | Boolean! | Shows whether the blob should be displayed collapsed |
| `fileType` | String! | Content file type |
| `loadAsync` | Boolean! | Shows whether the blob content is loaded async |
@@ -2177,10 +2351,10 @@ Represents how the blob content should be displayed
| `tooLarge` | Boolean! | Shows whether the blob too large to be displayed |
| `type` | BlobViewersType! | Type of blob viewer |
-## SnippetPermissions
+### SnippetPermissions
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminSnippet` | Boolean! | Indicates the user can perform `admin_snippet` on this resource |
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
@@ -2188,10 +2362,10 @@ Represents how the blob content should be displayed
| `reportSnippet` | Boolean! | Indicates the user can perform `report_snippet` on this resource |
| `updateSnippet` | Boolean! | Indicates the user can perform `update_snippet` on this resource |
-## Submodule
+### Submodule
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `flatPath` | String! | Flat path of the entry |
| `id` | ID! | ID of the entry |
| `name` | String! | Name of the entry |
@@ -2201,44 +2375,60 @@ Represents how the blob content should be displayed
| `type` | EntryType! | Type of tree entry |
| `webUrl` | String | Web URL for the sub-module |
-## TaskCompletionStatus
+### TaskCompletionStatus
-Completion status of tasks
+Completion status of tasks.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `completedCount` | Int! | Number of completed tasks |
| `count` | Int! | Number of total tasks |
-## TestReport
+### TerraformStateRegistry
+
+Represents the sync and verification state of a terraform state.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `createdAt` | Time | Timestamp when the TerraformStateRegistry was created |
+| `id` | ID! | ID of the TerraformStateRegistry |
+| `lastSyncFailure` | String | Error message during sync of the TerraformStateRegistry |
+| `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the TerraformStateRegistry |
+| `retryAt` | Time | Timestamp after which the TerraformStateRegistry should be resynced |
+| `retryCount` | Int | Number of consecutive failed sync attempts of the TerraformStateRegistry |
+| `state` | RegistryState | Sync state of the TerraformStateRegistry |
+| `terraformStateId` | ID! | ID of the TerraformState |
+
+### TestReport
Represents a requirement test report.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `author` | User | Author of the test report |
| `createdAt` | Time! | Timestamp of when the test report was created |
| `id` | ID! | ID of the test report |
| `state` | TestReportState! | State of the test report |
-## Timelog
+### Timelog
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `date` **{warning-solid}** | Time! | **Deprecated:** Use `spentAt`. Deprecated in 12.10 |
| `issue` | Issue | The issue that logged time was added to |
+| `note` | Note | The note where the quick action to add the logged time was executed |
| `spentAt` | Time | Timestamp of when the time tracked was spent at |
| `timeSpent` | Int! | The time spent displayed in seconds |
| `user` | User! | The user that logged the time |
-## Todo
+### Todo
-Representing a todo entry
+Representing a todo entry.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `action` | TodoActionEnum! | Action of the todo |
-| `author` | User! | The owner of this todo |
+| `author` | User! | The author of this todo |
| `body` | String! | Body of the todo |
| `createdAt` | Time! | Timestamp this todo was created |
| `group` | Group | Group this todo is associated with |
@@ -2247,71 +2437,71 @@ Representing a todo entry
| `state` | TodoStateEnum! | State of the todo |
| `targetType` | TodoTargetEnum! | Target type of the todo |
-## TodoMarkDonePayload
+### TodoMarkDonePayload
-Autogenerated return type of TodoMarkDone
+Autogenerated return type of TodoMarkDone.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todo` | Todo! | The requested todo |
-## TodoRestoreManyPayload
+### TodoRestoreManyPayload
-Autogenerated return type of TodoRestoreMany
+Autogenerated return type of TodoRestoreMany.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todos` | Todo! => Array | Updated todos |
| `updatedIds` **{warning-solid}** | ID! => Array | **Deprecated:** Use todos. Deprecated in 13.2 |
-## TodoRestorePayload
+### TodoRestorePayload
-Autogenerated return type of TodoRestore
+Autogenerated return type of TodoRestore.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todo` | Todo! | The requested todo |
-## TodosMarkAllDonePayload
+### TodosMarkAllDonePayload
-Autogenerated return type of TodosMarkAllDone
+Autogenerated return type of TodosMarkAllDone.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todos` | Todo! => Array | Updated todos |
| `updatedIds` **{warning-solid}** | ID! => Array | **Deprecated:** Use todos. Deprecated in 13.2 |
-## ToggleAwardEmojiPayload
+### ToggleAwardEmojiPayload
-Autogenerated return type of ToggleAwardEmoji
+Autogenerated return type of ToggleAwardEmoji.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `toggledOn` | Boolean! | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. |
-## Tree
+### Tree
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `lastCommit` | Commit | Last commit for the tree |
-## TreeEntry
+### TreeEntry
-Represents a directory
+Represents a directory.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `flatPath` | String! | Flat path of the entry |
| `id` | ID! | ID of the entry |
| `name` | String! | Name of the entry |
@@ -2321,122 +2511,122 @@ Represents a directory
| `webPath` | String | Web path for the tree entry (directory) |
| `webUrl` | String | Web URL for the tree entry (directory) |
-## UpdateAlertStatusPayload
+### UpdateAlertStatusPayload
-Autogenerated return type of UpdateAlertStatus
+Autogenerated return type of UpdateAlertStatus.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `alert` | AlertManagementAlert | The alert after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation |
| `todo` | Todo | The todo after mutation |
-## UpdateBoardListPayload
+### UpdateBoardListPayload
-Autogenerated return type of UpdateBoardList
+Autogenerated return type of UpdateBoardList.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `list` | BoardList | Mutated list |
-## UpdateBoardPayload
+### UpdateBoardPayload
-Autogenerated return type of UpdateBoard
+Autogenerated return type of UpdateBoard.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `board` | Board | The board after mutation. |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## UpdateContainerExpirationPolicyPayload
+### UpdateContainerExpirationPolicyPayload
-Autogenerated return type of UpdateContainerExpirationPolicy
+Autogenerated return type of UpdateContainerExpirationPolicy.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## UpdateEpicPayload
+### UpdateEpicPayload
-Autogenerated return type of UpdateEpic
+Autogenerated return type of UpdateEpic.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
-## UpdateImageDiffNotePayload
+### UpdateImageDiffNotePayload
-Autogenerated return type of UpdateImageDiffNote
+Autogenerated return type of UpdateImageDiffNote.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `note` | Note | The note after mutation |
-## UpdateIssuePayload
+### UpdateIssuePayload
-Autogenerated return type of UpdateIssue
+Autogenerated return type of UpdateIssue.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |
-## UpdateIterationPayload
+### UpdateIterationPayload
-Autogenerated return type of UpdateIteration
+Autogenerated return type of UpdateIteration.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `iteration` | Iteration | The updated iteration |
-## UpdateNotePayload
+### UpdateNotePayload
-Autogenerated return type of UpdateNote
+Autogenerated return type of UpdateNote.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `note` | Note | The note after mutation |
-## UpdateRequirementPayload
+### UpdateRequirementPayload
-Autogenerated return type of UpdateRequirement
+Autogenerated return type of UpdateRequirement.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `requirement` | Requirement | The requirement after mutation |
-## UpdateSnippetPayload
+### UpdateSnippetPayload
-Autogenerated return type of UpdateSnippet
+Autogenerated return type of UpdateSnippet.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `snippet` | Snippet | The snippet after mutation |
-## User
+### User
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `avatarUrl` | String | URL of the user's avatar |
| `email` | String | User email |
| `id` | ID! | ID of the user |
@@ -2448,26 +2638,26 @@ Autogenerated return type of UpdateSnippet
| `webPath` | String! | Web path of the user |
| `webUrl` | String! | Web URL of the user |
-## UserPermissions
+### UserPermissions
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
-## UserStatus
+### UserStatus
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `emoji` | String | String representation of emoji |
| `message` | String | User status message |
| `messageHtml` | String | HTML of the user status message |
-## VulnerabilitiesCountByDay
+### VulnerabilitiesCountByDay
-Represents the count of vulnerabilities by severity on a particular day
+Represents the count of vulnerabilities by severity on a particular day.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `critical` | Int! | Total number of vulnerabilities on a particular day with critical severity |
| `date` | ISO8601Date! | Date for the count |
| `high` | Int! | Total number of vulnerabilities on a particular day with high severity |
@@ -2477,23 +2667,24 @@ Represents the count of vulnerabilities by severity on a particular day
| `total` | Int! | Total number of vulnerabilities on a particular day |
| `unknown` | Int! | Total number of vulnerabilities on a particular day with unknown severity |
-## VulnerabilitiesCountByDayAndSeverity
+### VulnerabilitiesCountByDayAndSeverity
-Represents the number of vulnerabilities for a particular severity on a particular day
+Represents the number of vulnerabilities for a particular severity on a particular day.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `count` | Int | Number of vulnerabilities |
| `day` | ISO8601Date | Date for the count |
| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities |
-## Vulnerability
+### Vulnerability
Represents a vulnerability.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `description` | String | Description of the vulnerability |
+| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected |
| `id` | ID! | GraphQL ID of the vulnerability |
| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerability. |
| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability |
@@ -2509,99 +2700,99 @@ Represents a vulnerability.
| `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource |
| `vulnerabilityPath` | String | URL to the vulnerability's details page |
-## VulnerabilityIdentifier
+### VulnerabilityIdentifier
Represents a vulnerability identifier.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `externalId` | String | External ID of the vulnerability identifier |
| `externalType` | String | External type of the vulnerability identifier |
| `name` | String | Name of the vulnerability identifier |
| `url` | String | URL of the vulnerability identifier |
-## VulnerabilityIssueLink
+### VulnerabilityIssueLink
Represents an issue link of a vulnerability.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `id` | ID! | GraphQL ID of the vulnerability |
| `issue` | Issue! | The issue attached to issue link |
| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link |
-## VulnerabilityLocationContainerScanning
+### VulnerabilityLocationContainerScanning
-Represents the location of a vulnerability found by a container security scan
+Represents the location of a vulnerability found by a container security scan.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `dependency` | VulnerableDependency | Dependency containing the vulnerability |
| `image` | String | Name of the vulnerable container image |
| `operatingSystem` | String | Operating system that runs on the vulnerable container image |
-## VulnerabilityLocationCoverageFuzzing
+### VulnerabilityLocationCoverageFuzzing
-Represents the location of a vulnerability found by a Coverage Fuzzing scan
+Represents the location of a vulnerability found by a Coverage Fuzzing scan.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `endLine` | String | Number of the last relevant line in the vulnerable file |
| `file` | String | Path to the vulnerable file |
| `startLine` | String | Number of the first relevant line in the vulnerable file |
| `vulnerableClass` | String | Class containing the vulnerability |
| `vulnerableMethod` | String | Method containing the vulnerability |
-## VulnerabilityLocationDast
+### VulnerabilityLocationDast
-Represents the location of a vulnerability found by a DAST scan
+Represents the location of a vulnerability found by a DAST scan.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `hostname` | String | Domain name of the vulnerable request |
| `param` | String | Query parameter for the URL on which the vulnerability occurred |
| `path` | String | URL path and query string of the vulnerable request |
| `requestMethod` | String | HTTP method of the vulnerable request |
-## VulnerabilityLocationDependencyScanning
+### VulnerabilityLocationDependencyScanning
-Represents the location of a vulnerability found by a dependency security scan
+Represents the location of a vulnerability found by a dependency security scan.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `dependency` | VulnerableDependency | Dependency containing the vulnerability |
| `file` | String | Path to the vulnerable file |
-## VulnerabilityLocationSast
+### VulnerabilityLocationSast
-Represents the location of a vulnerability found by a SAST scan
+Represents the location of a vulnerability found by a SAST scan.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `endLine` | String | Number of the last relevant line in the vulnerable file |
| `file` | String | Path to the vulnerable file |
| `startLine` | String | Number of the first relevant line in the vulnerable file |
| `vulnerableClass` | String | Class containing the vulnerability |
| `vulnerableMethod` | String | Method containing the vulnerability |
-## VulnerabilityLocationSecretDetection
+### VulnerabilityLocationSecretDetection
-Represents the location of a vulnerability found by a secret detection scan
+Represents the location of a vulnerability found by a secret detection scan.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `endLine` | String | Number of the last relevant line in the vulnerable file |
| `file` | String | Path to the vulnerable file |
| `startLine` | String | Number of the first relevant line in the vulnerable file |
| `vulnerableClass` | String | Class containing the vulnerability |
| `vulnerableMethod` | String | Method containing the vulnerability |
-## VulnerabilityPermissions
+### VulnerabilityPermissions
-Check permissions for the current user on a vulnerability
+Check permissions for the current user on a vulnerability.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `adminVulnerability` | Boolean! | Indicates the user can perform `admin_vulnerability` on this resource |
| `adminVulnerabilityIssueLink` | Boolean! | Indicates the user can perform `admin_vulnerability_issue_link` on this resource |
| `createVulnerability` | Boolean! | Indicates the user can perform `create_vulnerability` on this resource |
@@ -2611,23 +2802,33 @@ Check permissions for the current user on a vulnerability
| `readVulnerabilityFeedback` | Boolean! | Indicates the user can perform `read_vulnerability_feedback` on this resource |
| `updateVulnerabilityFeedback` | Boolean! | Indicates the user can perform `update_vulnerability_feedback` on this resource |
-## VulnerabilityScanner
+### VulnerabilityResolvePayload
+
+Autogenerated return type of VulnerabilityResolve.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+| `vulnerability` | Vulnerability | The vulnerability after state change |
+
+### VulnerabilityScanner
Represents a vulnerability scanner.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `externalId` | String | External ID of the vulnerability scanner |
| `name` | String | Name of the vulnerability scanner |
| `reportType` | VulnerabilityReportType | Type of the vulnerability report |
| `vendor` | String | Vendor of the vulnerability scanner |
-## VulnerabilitySeveritiesCount
+### VulnerabilitySeveritiesCount
-Represents vulnerability counts by severity
+Represents vulnerability counts by severity.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `critical` | Int | Number of vulnerabilities of CRITICAL severity of the project |
| `high` | Int | Number of vulnerabilities of HIGH severity of the project |
| `info` | Int | Number of vulnerabilities of INFO severity of the project |
@@ -2635,28 +2836,738 @@ Represents vulnerability counts by severity
| `medium` | Int | Number of vulnerabilities of MEDIUM severity of the project |
| `unknown` | Int | Number of vulnerabilities of UNKNOWN severity of the project |
-## VulnerableDependency
+### VulnerableDependency
-Represents a vulnerable dependency. Used in vulnerability location data
+Represents a vulnerable dependency. Used in vulnerability location data.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `package` | VulnerablePackage | The package associated with the vulnerable dependency |
| `version` | String | The version of the vulnerable dependency |
-## VulnerablePackage
+### VulnerablePackage
-Represents a vulnerable package. Used in vulnerability dependency data
+Represents a vulnerable package. Used in vulnerability dependency data.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `name` | String | The name of the vulnerable package |
-## VulnerableProjectsByGrade
+### VulnerableProjectsByGrade
-Represents vulnerability letter grades with associated projects
+Represents vulnerability letter grades with associated projects.
-| Name | Type | Description |
-| --- | ---- | ---------- |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
| `count` | Int! | Number of projects within this grade |
| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present |
+
+## Enumeration types
+
+Also called _Enums_, enumeration types are a special kind of scalar that
+is restricted to a particular set of allowed values.
+
+For more information, see
+[Enumeration Types](https://graphql.org/learn/schema/#enumeration-types)
+on `graphql.org`.
+
+### AccessLevelEnum
+
+Access level to a resource.
+
+| Value | Description |
+| ----- | ----------- |
+| `DEVELOPER` | |
+| `GUEST` | |
+| `MAINTAINER` | |
+| `NO_ACCESS` | |
+| `OWNER` | |
+| `REPORTER` | |
+
+### AlertManagementAlertSort
+
+Values for sorting alerts.
+
+| Value | Description |
+| ----- | ----------- |
+| `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_TIME_ASC` | Created time by ascending order |
+| `UPDATED_TIME_DESC` | Created time by descending order |
+| `created_asc` | Created at ascending order |
+| `created_desc` | Created at descending order |
+| `updated_asc` | Updated at ascending order |
+| `updated_desc` | Updated at descending order |
+
+### AlertManagementSeverity
+
+Alert severity values.
+
+| Value | Description |
+| ----- | ----------- |
+| `CRITICAL` | Critical severity |
+| `HIGH` | High severity |
+| `INFO` | Info severity |
+| `LOW` | Low severity |
+| `MEDIUM` | Medium severity |
+| `UNKNOWN` | Unknown severity |
+
+### AlertManagementStatus
+
+Alert status values.
+
+| Value | Description |
+| ----- | ----------- |
+| `ACKNOWLEDGED` | Acknowledged status |
+| `IGNORED` | Ignored status |
+| `RESOLVED` | Resolved status |
+| `TRIGGERED` | Triggered status |
+
+### BlobViewersType
+
+Types of blob viewers.
+
+| Value | Description |
+| ----- | ----------- |
+| `auxiliary` | |
+| `rich` | |
+| `simple` | |
+
+### CommitActionMode
+
+Mode of a commit action.
+
+| Value | Description |
+| ----- | ----------- |
+| `CHMOD` | Chmod command |
+| `CREATE` | Create command |
+| `DELETE` | Delete command |
+| `MOVE` | Move command |
+| `UPDATE` | Update command |
+
+### CommitEncoding
+
+| Value | Description |
+| ----- | ----------- |
+| `BASE64` | Base64 encoding |
+| `TEXT` | Text encoding |
+
+### 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 |
+
+### 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 |
+
+### 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 |
+
+### DastScanTypeEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `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 |
+| `PASSED_VALIDATION` | Site validation process finished successfully |
+| `PENDING_VALIDATION` | Site validation process has not started |
+
+### DesignVersionEvent
+
+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 |
+
+### DiffPositionType
+
+Type of file the position refers to.
+
+| Value | Description |
+| ----- | ----------- |
+| `image` | |
+| `text` | |
+
+### EntryType
+
+Type of a tree entry.
+
+| Value | Description |
+| ----- | ----------- |
+| `blob` | |
+| `commit` | |
+| `tree` | |
+
+### EpicSort
+
+Roadmap sort values.
+
+| Value | Description |
+| ----- | ----------- |
+| `end_date_asc` | End date at ascending order |
+| `end_date_desc` | End date at descending order |
+| `start_date_asc` | Start date at ascending order |
+| `start_date_desc` | Start date at descending order |
+
+### EpicState
+
+State of an epic.
+
+| Value | Description |
+| ----- | ----------- |
+| `all` | |
+| `closed` | |
+| `opened` | |
+
+### EpicStateEvent
+
+State event of an epic.
+
+| Value | Description |
+| ----- | ----------- |
+| `CLOSE` | Close the epic |
+| `REOPEN` | Reopen the epic |
+
+### EpicWildcardId
+
+Epic ID wildcard values.
+
+| Value | Description |
+| ----- | ----------- |
+| `ANY` | Any epic is assigned |
+| `NONE` | No epic is assigned |
+
+### HealthStatus
+
+Health status of an issue or epic.
+
+| Value | Description |
+| ----- | ----------- |
+| `atRisk` | |
+| `needsAttention` | |
+| `onTrack` | |
+
+### IssuableSeverity
+
+Incident severity.
+
+| Value | Description |
+| ----- | ----------- |
+| `CRITICAL` | Critical severity |
+| `HIGH` | High severity |
+| `LOW` | Low severity |
+| `MEDIUM` | Medium severity |
+| `UNKNOWN` | Unknown severity |
+
+### IssuableState
+
+State of a GitLab issue or merge request.
+
+| Value | Description |
+| ----- | ----------- |
+| `all` | |
+| `closed` | |
+| `locked` | |
+| `opened` | |
+
+### IssueSort
+
+Values for sorting issues.
+
+| Value | Description |
+| ----- | ----------- |
+| `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 |
+| `RELATIVE_POSITION_ASC` | Relative position by ascending order |
+| `WEIGHT_ASC` | Weight by ascending order |
+| `WEIGHT_DESC` | Weight by descending order |
+| `created_asc` | Created at ascending order |
+| `created_desc` | Created at descending order |
+| `updated_asc` | Updated at ascending order |
+| `updated_desc` | Updated at descending order |
+
+### IssueState
+
+State of a GitLab issue.
+
+| Value | Description |
+| ----- | ----------- |
+| `all` | |
+| `closed` | |
+| `locked` | |
+| `opened` | |
+
+### IssueType
+
+Issue type.
+
+| Value | Description |
+| ----- | ----------- |
+| `INCIDENT` | Incident issue type |
+| `ISSUE` | Issue issue type |
+| `TEST_CASE` | Test Case issue type |
+
+### IterationState
+
+State of a GitLab iteration.
+
+| Value | Description |
+| ----- | ----------- |
+| `all` | |
+| `closed` | |
+| `opened` | |
+| `started` | |
+| `upcoming` | |
+
+### ListLimitMetric
+
+List limit metric setting.
+
+| Value | Description |
+| ----- | ----------- |
+| `all_metrics` | |
+| `issue_count` | |
+| `issue_weights` | |
+
+### MeasurementIdentifier
+
+Possible identifier types for a measurement.
+
+| Value | Description |
+| ----- | ----------- |
+| `GROUPS` | Group count |
+| `ISSUES` | Issue count |
+| `MERGE_REQUESTS` | Merge request count |
+| `PIPELINES` | Pipeline count |
+| `PROJECTS` | Project count |
+| `USERS` | User count |
+
+### MergeRequestSort
+
+Values for sorting merge requests.
+
+| Value | Description |
+| ----- | ----------- |
+| `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 |
+| `created_asc` | Created at ascending order |
+| `created_desc` | Created at descending order |
+| `updated_asc` | Updated at ascending order |
+| `updated_desc` | Updated at descending order |
+
+### MergeRequestState
+
+State of a GitLab merge request.
+
+| Value | Description |
+| ----- | ----------- |
+| `all` | |
+| `closed` | |
+| `locked` | |
+| `merged` | |
+| `opened` | |
+
+### MilestoneStateEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `active` | |
+| `closed` | |
+
+### MoveType
+
+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 |
+
+### MutationOperationMode
+
+Different toggles for changing mutator behavior.
+
+| Value | Description |
+| ----- | ----------- |
+| `APPEND` | Performs an append operation |
+| `REMOVE` | Performs a removal operation |
+| `REPLACE` | Performs a replace operation |
+
+### NamespaceProjectSort
+
+Values for sorting projects.
+
+| Value | Description |
+| ----- | ----------- |
+| `SIMILARITY` | Most similar to the search query |
+
+### PackageTypeEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `COMPOSER` | Packages from the composer package manager |
+| `CONAN` | Packages from the conan package manager |
+| `GENERIC` | Packages from the generic 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 |
+
+### PipelineConfigSourceEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `AUTO_DEVOPS_SOURCE` | |
+| `BRIDGE_SOURCE` | |
+| `EXTERNAL_PROJECT_SOURCE` | |
+| `PARAMETER_SOURCE` | |
+| `REMOTE_SOURCE` | |
+| `REPOSITORY_SOURCE` | |
+| `UNKNOWN_SOURCE` | |
+| `WEBIDE_SOURCE` | |
+
+### PipelineStatusEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `CANCELED` | |
+| `CREATED` | |
+| `FAILED` | |
+| `MANUAL` | |
+| `PENDING` | |
+| `PREPARING` | |
+| `RUNNING` | |
+| `SCHEDULED` | |
+| `SKIPPED` | |
+| `SUCCESS` | |
+| `WAITING_FOR_RESOURCE` | |
+
+### ProjectSettingEnum
+
+Names of compliance frameworks that can be assigned to a Project.
+
+| Value | Description |
+| ----- | ----------- |
+| `gdpr` | |
+| `hipaa` | |
+| `pci_dss` | |
+| `soc_2` | |
+| `sox` | |
+
+### RegistryState
+
+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 |
+
+### ReleaseAssetLinkType
+
+Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`.
+
+| Value | Description |
+| ----- | ----------- |
+| `IMAGE` | Image link type |
+| `OTHER` | Other link type |
+| `PACKAGE` | Package link type |
+| `RUNBOOK` | Runbook link type |
+
+### RequirementState
+
+State of a requirement.
+
+| Value | Description |
+| ----- | ----------- |
+| `ARCHIVED` | |
+| `OPENED` | |
+
+### SastUiComponentSize
+
+Size of UI component in SAST configuration page.
+
+| Value | Description |
+| ----- | ----------- |
+| `LARGE` | |
+| `MEDIUM` | |
+| `SMALL` | |
+
+### SecurityScannerType
+
+The type of the security scanner.
+
+| Value | Description |
+| ----- | ----------- |
+| `CONTAINER_SCANNING` | |
+| `COVERAGE_FUZZING` | |
+| `DAST` | |
+| `DEPENDENCY_SCANNING` | |
+| `SAST` | |
+| `SECRET_DETECTION` | |
+
+### SentryErrorStatus
+
+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 |
+
+### ServiceType
+
+| Value | Description |
+| ----- | ----------- |
+| `ALERTS_SERVICE` | |
+| `ASANA_SERVICE` | |
+| `ASSEMBLA_SERVICE` | |
+| `BAMBOO_SERVICE` | |
+| `BUGZILLA_SERVICE` | |
+| `BUILDKITE_SERVICE` | |
+| `CAMPFIRE_SERVICE` | |
+| `CONFLUENCE_SERVICE` | |
+| `CUSTOM_ISSUE_TRACKER_SERVICE` | |
+| `DISCORD_SERVICE` | |
+| `DRONE_CI_SERVICE` | |
+| `EMAILS_ON_PUSH_SERVICE` | |
+| `EWM_SERVICE` | |
+| `EXTERNAL_WIKI_SERVICE` | |
+| `FLOWDOCK_SERVICE` | |
+| `GITHUB_SERVICE` | |
+| `HANGOUTS_CHAT_SERVICE` | |
+| `HIPCHAT_SERVICE` | |
+| `IRKER_SERVICE` | |
+| `JENKINS_SERVICE` | |
+| `JIRA_SERVICE` | |
+| `MATTERMOST_SERVICE` | |
+| `MATTERMOST_SLASH_COMMANDS_SERVICE` | |
+| `MICROSOFT_TEAMS_SERVICE` | |
+| `PACKAGIST_SERVICE` | |
+| `PIPELINES_EMAIL_SERVICE` | |
+| `PIVOTALTRACKER_SERVICE` | |
+| `PROMETHEUS_SERVICE` | |
+| `PUSHOVER_SERVICE` | |
+| `REDMINE_SERVICE` | |
+| `SLACK_SERVICE` | |
+| `SLACK_SLASH_COMMANDS_SERVICE` | |
+| `TEAMCITY_SERVICE` | |
+| `UNIFY_CIRCUIT_SERVICE` | |
+| `WEBEX_TEAMS_SERVICE` | |
+| `YOUTRACK_SERVICE` | |
+
+### SnippetBlobActionEnum
+
+Type of a snippet blob input action.
+
+| Value | Description |
+| ----- | ----------- |
+| `create` | |
+| `delete` | |
+| `move` | |
+| `update` | |
+
+### Sort
+
+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 |
+
+### TestReportState
+
+State of a test report.
+
+| Value | Description |
+| ----- | ----------- |
+| `FAILED` | |
+| `PASSED` | |
+
+### TodoActionEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `approval_required` | |
+| `assigned` | |
+| `build_failed` | |
+| `directly_addressed` | |
+| `marked` | |
+| `mentioned` | |
+| `unmergeable` | |
+
+### TodoStateEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `done` | |
+| `pending` | |
+
+### TodoTargetEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `ALERT` | An Alert |
+| `COMMIT` | A Commit |
+| `DESIGN` | A Design |
+| `EPIC` | An Epic |
+| `ISSUE` | An Issue |
+| `MERGEREQUEST` | A MergeRequest |
+
+### TypeEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `personal` | |
+| `project` | |
+
+### UserState
+
+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 |
+
+### VisibilityLevelsEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `internal` | |
+| `private` | |
+| `public` | |
+
+### VisibilityScopesEnum
+
+| Value | Description |
+| ----- | ----------- |
+| `internal` | |
+| `private` | |
+| `public` | |
+
+### VulnerabilityGrade
+
+The grade of the vulnerable project.
+
+| Value | Description |
+| ----- | ----------- |
+| `A` | |
+| `B` | |
+| `C` | |
+| `D` | |
+| `F` | |
+
+### VulnerabilityIssueLinkType
+
+The type of the issue link related to a vulnerability.
+
+| Value | Description |
+| ----- | ----------- |
+| `CREATED` | |
+| `RELATED` | |
+
+### VulnerabilityReportType
+
+The type of the security scan that found the vulnerability.
+
+| Value | Description |
+| ----- | ----------- |
+| `CONTAINER_SCANNING` | |
+| `COVERAGE_FUZZING` | |
+| `DAST` | |
+| `DEPENDENCY_SCANNING` | |
+| `SAST` | |
+| `SECRET_DETECTION` | |
+
+### VulnerabilitySeverity
+
+The severity of the vulnerability.
+
+| Value | Description |
+| ----- | ----------- |
+| `CRITICAL` | |
+| `HIGH` | |
+| `INFO` | |
+| `LOW` | |
+| `MEDIUM` | |
+| `UNKNOWN` | |
+
+### VulnerabilitySort
+
+Vulnerability sort values.
+
+| Value | Description |
+| ----- | ----------- |
+| `severity_asc` | Severity in ascending order |
+| `severity_desc` | Severity in descending order |
+
+### VulnerabilityState
+
+The state of the vulnerability.
+
+| Value | Description |
+| ----- | ----------- |
+| `CONFIRMED` | |
+| `DETECTED` | |
+| `DISMISSED` | |
+| `RESOLVED` | |