diff options
Diffstat (limited to 'doc/api/graphql/reference/index.md')
| -rw-r--r-- | doc/api/graphql/reference/index.md | 1994 |
1 files changed, 1289 insertions, 705 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index f49a12568ed..df5d082df77 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -21,11 +21,345 @@ fields and methods on a model are available via GraphQL. WARNING: Fields that are deprecated are marked with **{warning-solid}**. -Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-process) can be found +Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-and-removal-process) can be found in [Removed Items](../removed_items.md). <!-- vale gitlab.Spelling = NO --> +## `Query` type + +The `Query` type contains the API's top-level entry points for all executable queries. + +### `ciApplicationSettings` + +CI related settings that apply to the entire instance. + +### `ciConfig` + +Get linted and processed contents of a CI config. Should not be requested more than once per request. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `content` | String! | Contents of `.gitlab-ci.yml`. | +| `dryRun` | Boolean | Run pipeline creation simulation, or only do static check. | +| `projectPath` | ID! | The project of the CI config. | + +### `containerRepository` + +Find a container repository. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | ContainerRepositoryID! | The global ID of the container repository. | + +### `currentUser` + +Get information about current user. + +### `designManagement` + +Fields related to design management. + +### `devopsAdoptionSegments` + +Get configured DevOps adoption segments on the instance. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `last` | Int | Returns the last _n_ elements from the list. | + +### `echo` + +Text to echo back. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `text` | String! | Text to echo back. | + +### `geoNode` + +Find a Geo node. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `name` | String | The name of the Geo node. Defaults to the current Geo node name. | + +### `group` + +Find a group. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | + +### `instanceSecurityDashboard` + +Fields related to Instance Security Dashboard. + +### `instanceStatisticsMeasurements` + +Get statistics on the instance. Deprecated in 13.10: This field was renamed. Use the `usageTrendsMeasurements` field instead. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `identifier` | MeasurementIdentifier! | The type of measurement/statistics to retrieve. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `recordedAfter` | Time | Measurement recorded after this date. | +| `recordedBefore` | Time | Measurement recorded before this date. | + +### `issue` + +Find an Issue. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | IssueID! | The global ID of the Issue. | + +### `iteration` + +Find an iteration. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | IterationID! | Find an iteration by its ID. | + +### `metadata` + +Metadata about GitLab. + +### `milestone` + +Find a milestone. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | MilestoneID! | Find a milestone by its ID. | + +### `namespace` + +Find a namespace. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | + +### `package` + +Find a package. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | PackagesPackageID! | The global ID of the package. | + +### `project` + +Find a project. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | + +### `projects` + +Find projects visible to the current user. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `ids` | ID! => Array | Filter projects by IDs. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `membership` | Boolean | Limit projects that the current user is a member of. | +| `search` | String | Search query for project name, path, or description. | +| `searchNamespaces` | Boolean | Include namespace in project search. | +| `sort` | String | Sort order of results. | + +### `runnerPlatforms` + +Supported runner platforms. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `last` | Int | Returns the last _n_ elements from the list. | + +### `runnerSetup` + +Get runner setup instructions. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `architecture` | String! | Architecture to generate the instructions for. | +| `groupId` | GroupID | Group to register the runner for. | +| `platform` | String! | Platform to generate the instructions for. | +| `projectId` | ProjectID | Project to register the runner for. | + +### `snippets` + +Find Snippets visible to the current user. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `authorId` | UserID | The ID of an author. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `explore` | Boolean | Explore personal snippets. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `ids` | SnippetID! => Array | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `projectId` | ProjectID | The ID of a project. | +| `type` | TypeEnum | The type of snippet. | +| `visibility` | VisibilityScopesEnum | The visibility of the snippet. | + +### `usageTrendsMeasurements` + +Get statistics on the instance. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `identifier` | MeasurementIdentifier! | The type of measurement/statistics to retrieve. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `recordedAfter` | Time | Measurement recorded after this date. | +| `recordedBefore` | Time | Measurement recorded before this date. | + +### `user` + +Find a user. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | UserID | ID of the User. | +| `username` | String | Username of the User. | + +### `users` + +Find users. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `admins` | Boolean | Return only admin users. | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `ids` | ID! => Array | List of user Global IDs. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `search` | String | Query to search users by name, username, or primary email. | +| `sort` | Sort | Sort users by this criteria. | +| `usernames` | String! => Array | List of usernames. | + +### `vulnerabilities` + +Vulnerabilities reported on projects on the current user's instance security dashboard. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `hasIssues` | Boolean | Returns only the vulnerabilities which have linked issues. | +| `hasResolution` | Boolean | Returns only the vulnerabilities which have been resolved on default branch. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `projectId` | ID! => Array | Filter vulnerabilities by project. | +| `reportType` | VulnerabilityReportType! => Array | Filter vulnerabilities by report type. | +| `scanner` | String! => Array | Filter vulnerabilities by VulnerabilityScanner.externalId. | +| `severity` | VulnerabilitySeverity! => Array | Filter vulnerabilities by severity. | +| `sort` | VulnerabilitySort | List vulnerabilities by sort order. | +| `state` | VulnerabilityState! => Array | Filter vulnerabilities by state. | + +### `vulnerabilitiesCountByDay` + +Number of vulnerabilities per day for the projects on the current user's instance security dashboard. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `endDate` | ISO8601Date! | Last day for which to fetch vulnerability history. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `startDate` | ISO8601Date! | First day for which to fetch vulnerability history. | + +### `vulnerabilitiesCountByDayAndSeverity` + +Number of vulnerabilities per severity level, per day, for the projects on the current user's instance security dashboard. Deprecated in 13.3: Use `vulnerabilitiesCountByDay`. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `endDate` | ISO8601Date! | Last day for which to fetch vulnerability history. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `startDate` | ISO8601Date! | First day for which to fetch vulnerability history. | + +### `vulnerability` + +Find a vulnerability. + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | VulnerabilityID! | The Global ID of the Vulnerability. | + ## Object types Object types represent the resources that the GitLab GraphQL API can return. @@ -37,7 +371,7 @@ For more information, see [Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields) on `graphql.org`. -### AccessLevel +### `AccessLevel` Represents the access level of a relationship between a User and object that it is related to. @@ -46,7 +380,7 @@ Represents the access level of a relationship between a User and object that it | `integerValue` | Int | Integer representation of access level. | | `stringValue` | AccessLevelEnum | String representation of access level. | -### AddAwardEmojiPayload +### `AddAwardEmojiPayload` Autogenerated return type of AddAwardEmoji. @@ -56,7 +390,7 @@ Autogenerated return type of AddAwardEmoji. | `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. @@ -66,7 +400,7 @@ Autogenerated return type of AddProjectToSecurityDashboard. | `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. @@ -76,7 +410,7 @@ Autogenerated return type of AdminSidekiqQueuesDeleteJobs. | `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. @@ -93,7 +427,8 @@ Describes an alert from the project's Alert Management. | `eventCount` | Int | Number of events of this alert. | | `hosts` | String! => Array | List of hosts the alert came from. | | `iid` | ID! | Internal ID of the alert. | -| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert. | +| `issue` | Issue | Issue attached to the alert. | +| `issueIid` **{warning-solid}** | ID | **Deprecated:** Use issue field. Deprecated in 13.10. | | `metricsDashboardUrl` | String | URL for metrics embed for the alert. | | `monitoringTool` | String | Monitoring tool the alert came from. | | `notes` | NoteConnection! | All notes on this noteable. | @@ -107,7 +442,7 @@ Describes an alert from the project's Alert Management. | `todos` | TodoConnection | To-do items of the current user for the alert. | | `updatedAt` | Time | Timestamp the alert was last updated. | -### AlertManagementAlertStatusCountsType +### `AlertManagementAlertStatusCountsType` Represents total number of alerts for the represented categories. @@ -120,7 +455,7 @@ 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 | -### AlertManagementHttpIntegration +### `AlertManagementHttpIntegration` An endpoint and credentials used to accept alerts for a project. @@ -130,11 +465,14 @@ An endpoint and credentials used to accept alerts for a project. | `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | | `id` | ID! | ID of the integration. | | `name` | String | Name of the integration. | +| `payloadAlertFields` | AlertManagementPayloadAlertField! => Array | Extract alert fields from payload example for custom mapping. | +| `payloadAttributeMappings` | AlertManagementPayloadAlertMappingField! => Array | The custom mapping of GitLab alert attributes to fields from the payload_example. | +| `payloadExample` | JsonString | The example of an alert payload. | | `token` | String | Token used to authenticate alert notification requests. | | `type` | AlertManagementIntegrationType! | Type of integration. | | `url` | String | Endpoint which accepts alert notifications. | -### AlertManagementPayloadAlertField +### `AlertManagementPayloadAlertField` Parsed field from an alert used for custom mappings. @@ -144,7 +482,18 @@ Parsed field from an alert used for custom mappings. | `path` | String! => Array | Path to value inside payload JSON. | | `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. | -### AlertManagementPrometheusIntegration +### `AlertManagementPayloadAlertMappingField` + +Parsed field (with its name) from an alert used for custom mappings. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `fieldName` | AlertManagementPayloadAlertFieldName | A GitLab alert field name. | +| `label` | String | Human-readable label of the payload path. | +| `path` | String! => Array | Path to value inside payload JSON. | +| `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. | + +### `AlertManagementPrometheusIntegration` An endpoint and credentials used to accept Prometheus alerts for a project. @@ -158,7 +507,7 @@ An endpoint and credentials used to accept Prometheus alerts for a project. | `type` | AlertManagementIntegrationType! | Type of integration. | | `url` | String | Endpoint which accepts alert notifications. | -### AlertSetAssigneesPayload +### `AlertSetAssigneesPayload` Autogenerated return type of AlertSetAssignees. @@ -170,7 +519,7 @@ Autogenerated return type of AlertSetAssignees. | `issue` | Issue | The issue created after mutation. | | `todo` | Todo | The to-do item after mutation. | -### AlertTodoCreatePayload +### `AlertTodoCreatePayload` Autogenerated return type of AlertTodoCreate. @@ -182,7 +531,7 @@ Autogenerated return type of AlertTodoCreate. | `issue` | Issue | The issue created after mutation. | | `todo` | Todo | The to-do item after mutation. | -### ApiFuzzingCiConfiguration +### `ApiFuzzingCiConfiguration` Data associated with configuring API fuzzing scans in GitLab CI. @@ -191,7 +540,7 @@ Data associated with configuring API fuzzing scans in GitLab CI. | `scanModes` | ApiFuzzingScanMode! => Array | All available scan modes. | | `scanProfiles` | ApiFuzzingScanProfile! => Array | All default scan profiles. | -### ApiFuzzingCiConfigurationCreatePayload +### `ApiFuzzingCiConfigurationCreatePayload` Autogenerated return type of ApiFuzzingCiConfigurationCreate. @@ -202,9 +551,9 @@ Autogenerated return type of ApiFuzzingCiConfigurationCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `gitlabCiYamlEditPath` | String | The location at which the project's `.gitlab-ci.yml` file can be edited in the browser. | -### ApiFuzzingScanProfile +### `ApiFuzzingScanProfile` -An API Fuzzing scan profile.. +An API Fuzzing scan profile. | Field | Type | Description | | ----- | ---- | ----------- | @@ -212,7 +561,7 @@ An API Fuzzing scan profile.. | `name` | String | The unique name of the profile. | | `yaml` | String | A syntax highlit HTML representation of the YAML. | -### AwardEmoji +### `AwardEmoji` An emoji awarded by a user. @@ -225,7 +574,7 @@ 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. @@ -235,7 +584,7 @@ Autogenerated return type of AwardEmojiAdd. | `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. @@ -245,7 +594,7 @@ Autogenerated return type of AwardEmojiRemove. | `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. @@ -256,14 +605,14 @@ Autogenerated return type of AwardEmojiToggle. | `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` | Field | Type | Description | | ----- | ---- | ----------- | | `active` | Boolean | Indicates if the service is active. | | `type` | String | Class name of the service. | -### Blob +### `Blob` | Field | Type | Description | | ----- | ---- | ----------- | @@ -278,9 +627,9 @@ 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 issue board. | Field | Type | Description | | ----- | ---- | ----------- | @@ -298,7 +647,7 @@ Represents a project or group board. | `webUrl` | String! | Web URL of the board. | | `weight` | Int | Weight of the board. | -### BoardEpic +### `BoardEpic` Represents an epic on an issue board. @@ -352,7 +701,7 @@ Represents an epic on an issue board. | `webPath` | String! | Web path of the epic. | | `webUrl` | String! | Web URL of the epic. | -### BoardEpicUserPreferences +### `BoardEpicUserPreferences` Represents user preferences for a board epic. @@ -360,14 +709,14 @@ Represents user preferences for a board epic. | ----- | ---- | ----------- | | `collapsed` | Boolean! | Indicates epic should be displayed as collapsed. | -### BoardList +### `BoardList` Represents a list for an issue board. | Field | Type | Description | | ----- | ---- | ----------- | | `assignee` | User | Assignee in the list. | -| `collapsed` | Boolean | Indicates if list is collapsed for this user. | +| `collapsed` | Boolean | Indicates if the list is collapsed for this user. | | `id` | ID! | ID (global ID) of the list. | | `issues` | IssueConnection | Board issues. | | `issuesCount` | Int | Count of issues in the list. | @@ -382,7 +731,7 @@ 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. @@ -392,7 +741,7 @@ Autogenerated return type of BoardListCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `list` | BoardList | Issue list in the issue board. | -### BoardListUpdateLimitMetricsPayload +### `BoardListUpdateLimitMetricsPayload` Autogenerated return type of BoardListUpdateLimitMetrics. @@ -402,14 +751,24 @@ Autogenerated return type of BoardListUpdateLimitMetrics. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `list` | BoardList | The updated list. | -### Branch +### `Branch` | Field | Type | Description | | ----- | ---- | ----------- | | `commit` | Commit | Commit for the branch. | | `name` | String! | Name of the branch. | -### BurnupChartDailyTotals +### `BulkFindOrCreateDevopsAdoptionSegmentsPayload` + +Autogenerated return type of BulkFindOrCreateDevopsAdoptionSegments. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `segments` | DevopsAdoptionSegment! => Array | Created segments after mutation. | + +### `BurnupChartDailyTotals` Represents the total number of issues and their weights for a particular day. @@ -421,19 +780,19 @@ Represents the total number of issues and their weights for a particular day. | `scopeCount` | Int! | Number of issues as of this day. | | `scopeWeight` | Int! | Total weight of issues as of this day. | -### CiApplicationSettings +### `CiApplicationSettings` | Field | Type | Description | | ----- | ---- | ----------- | | `keepLatestArtifact` | Boolean | Whether to keep the latest jobs artifacts. | -### CiBuildNeed +### `CiBuildNeed` | Field | Type | Description | | ----- | ---- | ----------- | | `name` | String | Name of the job we need to complete. | -### CiCdSettingsUpdatePayload +### `CiCdSettingsUpdatePayload` Autogenerated return type of CiCdSettingsUpdate. @@ -442,7 +801,7 @@ Autogenerated return type of CiCdSettingsUpdate. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### CiConfig +### `CiConfig` | Field | Type | Description | | ----- | ---- | ----------- | @@ -451,7 +810,7 @@ Autogenerated return type of CiCdSettingsUpdate. | `stages` | CiConfigStageConnection | Stages of the pipeline. | | `status` | CiConfigStatus | Status of linting, can be either valid or invalid. | -### CiConfigGroup +### `CiConfigGroup` | Field | Type | Description | | ----- | ---- | ----------- | @@ -459,7 +818,7 @@ Autogenerated return type of CiCdSettingsUpdate. | `name` | String | Name of the job group. | | `size` | Int | Size of the job group. | -### CiConfigJob +### `CiConfigJob` | Field | Type | Description | | ----- | ---- | ----------- | @@ -477,26 +836,26 @@ Autogenerated return type of CiCdSettingsUpdate. | `tags` | String! => Array | List of tags that are used to select a runner. | | `when` | String | When to run the job. | -### CiConfigJobRestriction +### `CiConfigJobRestriction` | Field | Type | Description | | ----- | ---- | ----------- | | `refs` | String! => Array | The Git refs the job restriction applies to. | -### CiConfigNeed +### `CiConfigNeed` | Field | Type | Description | | ----- | ---- | ----------- | | `name` | String | Name of the need. | -### CiConfigStage +### `CiConfigStage` | Field | Type | Description | | ----- | ---- | ----------- | | `groups` | CiConfigGroupConnection | Groups of jobs for the stage. | | `name` | String | Name of the stage. | -### CiGroup +### `CiGroup` | Field | Type | Description | | ----- | ---- | ----------- | @@ -505,25 +864,27 @@ Autogenerated return type of CiCdSettingsUpdate. | `name` | String | Name of the job group. | | `size` | Int | Size of the group. | -### CiJob +### `CiJob` | Field | Type | Description | | ----- | ---- | ----------- | | `artifacts` | CiJobArtifactConnection | Artifacts generated by the job. | | `detailedStatus` | DetailedStatus | Detailed status of the job. | +| `duration` | Int | Duration of the job in seconds. | +| `finishedAt` | Time | When a job has finished running. | | `name` | String | Name of the job. | | `needs` | CiBuildNeedConnection | References to builds that must complete before the jobs run. | | `pipeline` | Pipeline | Pipeline the job belongs to. | | `scheduledAt` | Time | Schedule for the build. | -### CiJobArtifact +### `CiJobArtifact` | Field | Type | Description | | ----- | ---- | ----------- | | `downloadPath` | String | URL for downloading the artifact's file. | | `fileType` | JobArtifactFileType | File type of the artifact. | -### CiStage +### `CiStage` | Field | Type | Description | | ----- | ---- | ----------- | @@ -531,7 +892,7 @@ Autogenerated return type of CiCdSettingsUpdate. | `groups` | CiGroupConnection | Group of jobs for the stage. | | `name` | String | Name of the stage. | -### ClusterAgent +### `ClusterAgent` | Field | Type | Description | | ----- | ---- | ----------- | @@ -542,8 +903,9 @@ Autogenerated return type of CiCdSettingsUpdate. | `project` | Project | The project this cluster agent is associated with. | | `tokens` | ClusterAgentTokenConnection | Tokens associated with the cluster agent. | | `updatedAt` | Time | Timestamp the cluster agent was updated. | +| `webPath` | String | Web path of the cluster agent. | -### ClusterAgentDeletePayload +### `ClusterAgentDeletePayload` Autogenerated return type of ClusterAgentDelete. @@ -552,16 +914,18 @@ Autogenerated return type of ClusterAgentDelete. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### ClusterAgentToken +### `ClusterAgentToken` | Field | Type | Description | | ----- | ---- | ----------- | | `clusterAgent` | ClusterAgent | Cluster agent this token is associated with. | | `createdAt` | Time | Timestamp the token was created. | | `createdByUser` | User | The user who created the token. | +| `description` | String | Description of the token. | | `id` | ClustersAgentTokenID! | Global ID of the token. | +| `name` | String | Name given to the token. | -### ClusterAgentTokenCreatePayload +### `ClusterAgentTokenCreatePayload` Autogenerated return type of ClusterAgentTokenCreate. @@ -572,7 +936,7 @@ Autogenerated return type of ClusterAgentTokenCreate. | `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 +### `ClusterAgentTokenDeletePayload` Autogenerated return type of ClusterAgentTokenDelete. @@ -581,7 +945,7 @@ Autogenerated return type of ClusterAgentTokenDelete. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### CodeCoverageActivity +### `CodeCoverageActivity` Represents the code coverage activity for a group. @@ -592,7 +956,7 @@ Represents the code coverage activity for a group. | `date` | Date! | Date when the code coverage was created. | | `projectCount` | Int | Number of projects with code coverage results for the group. | -### CodeCoverageSummary +### `CodeCoverageSummary` Represents the code coverage summary for a project. @@ -602,7 +966,7 @@ Represents the code coverage summary for a project. | `coverageCount` | Int | Number of different code coverage results available. | | `lastUpdatedOn` | Date | Latest date when the code coverage was created for the project. | -### Commit +### `Commit` | Field | Type | Description | | ----- | ---- | ----------- | @@ -623,7 +987,7 @@ Represents the code coverage summary for a project. | `webPath` | String! | Web path of the commit. | | `webUrl` | String! | Web URL of the commit. | -### CommitCreatePayload +### `CommitCreatePayload` Autogenerated return type of CommitCreate. @@ -633,7 +997,7 @@ Autogenerated return type of CommitCreate. | `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. @@ -643,9 +1007,9 @@ Represents a ComplianceFramework associated with a Project. | `description` | String! | Description of the compliance framework. | | `id` | ID! | Compliance framework ID. | | `name` | String! | Name of the compliance framework. | -| `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hippa`. | +| `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. | -### ComposerMetadata +### `ComposerMetadata` Composer metadata. @@ -654,7 +1018,7 @@ Composer metadata. | `composerJson` | PackageComposerJsonType! | Data of the Composer JSON file. | | `targetSha` | String! | Target SHA of the package. | -### ConfigureSastPayload +### `ConfigureSastPayload` Autogenerated return type of ConfigureSast. @@ -665,7 +1029,7 @@ Autogenerated return type of ConfigureSast. | `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. @@ -681,7 +1045,7 @@ 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. | -### ContainerRepository +### `ContainerRepository` A container repository. @@ -700,7 +1064,7 @@ A container repository. | `tagsCount` | Int! | Number of tags associated with this image. | | `updatedAt` | Time! | Timestamp when the container repository was updated. | -### ContainerRepositoryDetails +### `ContainerRepositoryDetails` Details of a container repository. @@ -720,7 +1084,7 @@ Details of a container repository. | `tagsCount` | Int! | Number of tags associated with this image. | | `updatedAt` | Time! | Timestamp when the container repository was updated. | -### ContainerRepositoryTag +### `ContainerRepositoryTag` A tag from a container repository. @@ -736,7 +1100,7 @@ A tag from a container repository. | `shortRevision` | String | Short revision of the tag. | | `totalSize` | BigInt | The size of the tag. | -### CreateAlertIssuePayload +### `CreateAlertIssuePayload` Autogenerated return type of CreateAlertIssue. @@ -748,7 +1112,7 @@ Autogenerated return type of CreateAlertIssue. | `issue` | Issue | The issue created after mutation. | | `todo` | Todo | The to-do item after mutation. | -### CreateAnnotationPayload +### `CreateAnnotationPayload` Autogenerated return type of CreateAnnotation. @@ -758,7 +1122,7 @@ Autogenerated return type of CreateAnnotation. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### CreateBoardPayload +### `CreateBoardPayload` Autogenerated return type of CreateBoard. @@ -768,7 +1132,7 @@ Autogenerated return type of CreateBoard. | `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. @@ -778,7 +1142,7 @@ Autogenerated return type of CreateBranch. | `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. @@ -788,7 +1152,7 @@ Autogenerated return type of CreateClusterAgent. | `clusterAgent` | ClusterAgent | Cluster agent created after mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### CreateComplianceFrameworkPayload +### `CreateComplianceFrameworkPayload` Autogenerated return type of CreateComplianceFramework. @@ -798,7 +1162,7 @@ Autogenerated return type of CreateComplianceFramework. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `framework` | ComplianceFramework | The created compliance framework. | -### CreateCustomEmojiPayload +### `CreateCustomEmojiPayload` Autogenerated return type of CreateCustomEmoji. @@ -808,7 +1172,7 @@ Autogenerated return type of CreateCustomEmoji. | `customEmoji` | CustomEmoji | The new custom emoji. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### CreateDevopsAdoptionSegmentPayload +### `CreateDevopsAdoptionSegmentPayload` Autogenerated return type of CreateDevopsAdoptionSegment. @@ -818,7 +1182,7 @@ Autogenerated return type of CreateDevopsAdoptionSegment. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `segment` | DevopsAdoptionSegment | The segment after mutation. | -### CreateDiffNotePayload +### `CreateDiffNotePayload` Autogenerated return type of CreateDiffNote. @@ -828,7 +1192,7 @@ Autogenerated return type of CreateDiffNote. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation. | -### CreateEpicPayload +### `CreateEpicPayload` Autogenerated return type of CreateEpic. @@ -838,7 +1202,7 @@ Autogenerated return type of CreateEpic. | `epic` | Epic | The created epic. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### CreateImageDiffNotePayload +### `CreateImageDiffNotePayload` Autogenerated return type of CreateImageDiffNote. @@ -848,7 +1212,7 @@ Autogenerated return type of CreateImageDiffNote. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation. | -### CreateIssuePayload +### `CreateIssuePayload` Autogenerated return type of CreateIssue. @@ -858,7 +1222,7 @@ Autogenerated return type of CreateIssue. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### CreateIterationPayload +### `CreateIterationPayload` Autogenerated return type of CreateIteration. @@ -868,7 +1232,7 @@ Autogenerated return type of CreateIteration. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `iteration` | Iteration | The created iteration. | -### CreateNotePayload +### `CreateNotePayload` Autogenerated return type of CreateNote. @@ -878,7 +1242,7 @@ Autogenerated return type of CreateNote. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation. | -### CreateRequirementPayload +### `CreateRequirementPayload` Autogenerated return type of CreateRequirement. @@ -888,7 +1252,7 @@ Autogenerated return type of CreateRequirement. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `requirement` | Requirement | Requirement after mutation. | -### CreateSnippetPayload +### `CreateSnippetPayload` Autogenerated return type of CreateSnippet. @@ -902,7 +1266,7 @@ Autogenerated return type of CreateSnippet. | `spam` | Boolean | Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response. | | `spamLogId` | Int | The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | -### CreateTestCasePayload +### `CreateTestCasePayload` Autogenerated return type of CreateTestCase. @@ -912,7 +1276,7 @@ Autogenerated return type of CreateTestCase. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `testCase` | Issue | The test case created. | -### CustomEmoji +### `CustomEmoji` A custom emoji uploaded by user. @@ -923,7 +1287,7 @@ A custom emoji uploaded by user. | `name` | String! | The name of the emoji. | | `url` | String! | The link to file of the emoji. | -### DastOnDemandScanCreatePayload +### `DastOnDemandScanCreatePayload` Autogenerated return type of DastOnDemandScanCreate. @@ -933,12 +1297,13 @@ Autogenerated return type of DastOnDemandScanCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipelineUrl` | String | URL of the pipeline that was created. | -### DastProfile +### `DastProfile` Represents a DAST Profile. | Field | Type | Description | | ----- | ---- | ----------- | +| `branch` | DastProfileBranch | The associated branch. Will always return `null` if `dast_branch_selection` feature flag is disabled. | | `dastScannerProfile` | DastScannerProfile | The associated scanner profile. | | `dastSiteProfile` | DastSiteProfile | The associated site profile. | | `description` | String | The description of the scan. | @@ -946,7 +1311,16 @@ Represents a DAST Profile. | `id` | DastProfileID! | ID of the profile. | | `name` | String | The name of the profile. | -### DastProfileCreatePayload +### `DastProfileBranch` + +Represents a DAST Profile Branch. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `exists` | Boolean | Indicates whether or not the branch exists. | +| `name` | String | The name of the branch. | + +### `DastProfileCreatePayload` Autogenerated return type of DastProfileCreate. @@ -957,7 +1331,7 @@ Autogenerated return type of DastProfileCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipelineUrl` | String | The URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`. | -### DastProfileDeletePayload +### `DastProfileDeletePayload` Autogenerated return type of DastProfileDelete. @@ -966,7 +1340,7 @@ Autogenerated return type of DastProfileDelete. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DastProfileRunPayload +### `DastProfileRunPayload` Autogenerated return type of DastProfileRun. @@ -976,7 +1350,7 @@ Autogenerated return type of DastProfileRun. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipelineUrl` | String | URL of the pipeline that was created. | -### DastProfileUpdatePayload +### `DastProfileUpdatePayload` Autogenerated return type of DastProfileUpdate. @@ -987,7 +1361,7 @@ Autogenerated return type of DastProfileUpdate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipelineUrl` | String | The URL of the pipeline that was created. Requires the input argument `runAfterUpdate` to be set to `true` when calling the mutation, otherwise no pipeline will be created. | -### DastScannerProfile +### `DastScannerProfile` Represents a DAST scanner profile. @@ -997,13 +1371,14 @@ Represents a DAST scanner profile. | `globalId` **{warning-solid}** | DastScannerProfileID! | **Deprecated:** Use `id`. Deprecated in 13.6. | | `id` | DastScannerProfileID! | ID of the DAST scanner profile. | | `profileName` | String | Name of the DAST scanner profile. | +| `referencedInSecurityPolicies` | String! => Array | List of security policy names that are referencing given project. | | `scanType` | DastScanTypeEnum | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. | | `showDebugMessages` | Boolean! | Indicates if debug messages should be included in DAST console output. True to include the debug messages. | | `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. | | `useAjaxSpider` | Boolean! | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. | -### DastScannerProfileCreatePayload +### `DastScannerProfileCreatePayload` Autogenerated return type of DastScannerProfileCreate. @@ -1014,7 +1389,7 @@ Autogenerated return type of DastScannerProfileCreate. | `globalId` **{warning-solid}** | DastScannerProfileID | **Deprecated:** Use `id`. Deprecated in 13.6. | | `id` | DastScannerProfileID | ID of the scanner profile. | -### DastScannerProfileDeletePayload +### `DastScannerProfileDeletePayload` Autogenerated return type of DastScannerProfileDelete. @@ -1023,7 +1398,7 @@ Autogenerated return type of DastScannerProfileDelete. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DastScannerProfileUpdatePayload +### `DastScannerProfileUpdatePayload` Autogenerated return type of DastScannerProfileUpdate. @@ -1033,7 +1408,7 @@ Autogenerated return type of DastScannerProfileUpdate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `id` | DastScannerProfileID | ID of the scanner profile. | -### DastSiteProfile +### `DastSiteProfile` Represents a DAST Site Profile. @@ -1043,11 +1418,12 @@ Represents a DAST Site Profile. | `id` | DastSiteProfileID! | ID of the site profile. | | `normalizedTargetUrl` | String | Normalized URL of the target to be scanned. | | `profileName` | String | The name of the site profile. | +| `referencedInSecurityPolicies` | String! => Array | List of security policy names that are referencing given project. | | `targetUrl` | String | The URL of the target to be scanned. | | `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. @@ -1057,7 +1433,7 @@ Autogenerated return type of DastSiteProfileCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `id` | DastSiteProfileID | ID of the site profile. | -### DastSiteProfileDeletePayload +### `DastSiteProfileDeletePayload` Autogenerated return type of DastSiteProfileDelete. @@ -1066,7 +1442,7 @@ Autogenerated return type of DastSiteProfileDelete. | `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. @@ -1074,7 +1450,7 @@ Check permissions for the current user on site profile. | ----- | ---- | ----------- | | `createOnDemandDastScan` | Boolean! | Indicates the user can perform `create_on_demand_dast_scan` on this resource | -### DastSiteProfileUpdatePayload +### `DastSiteProfileUpdatePayload` Autogenerated return type of DastSiteProfileUpdate. @@ -1084,7 +1460,7 @@ Autogenerated return type of DastSiteProfileUpdate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `id` | DastSiteProfileID | ID of the site profile. | -### DastSiteTokenCreatePayload +### `DastSiteTokenCreatePayload` Autogenerated return type of DastSiteTokenCreate. @@ -1096,7 +1472,7 @@ Autogenerated return type of DastSiteTokenCreate. | `status` | DastSiteProfileValidationStatusEnum | The current validation status of the target. | | `token` | String | Token string. | -### DastSiteValidation +### `DastSiteValidation` Represents a DAST Site Validation. @@ -1106,7 +1482,7 @@ Represents a DAST Site Validation. | `normalizedTargetUrl` | String | Normalized URL of the target to be validated. | | `status` | DastSiteProfileValidationStatusEnum! | Status of the site validation. | -### DastSiteValidationCreatePayload +### `DastSiteValidationCreatePayload` Autogenerated return type of DastSiteValidationCreate. @@ -1117,7 +1493,7 @@ Autogenerated return type of DastSiteValidationCreate. | `id` | DastSiteValidationID | ID of the site validation. | | `status` | DastSiteProfileValidationStatusEnum | The current validation status. | -### DastSiteValidationRevokePayload +### `DastSiteValidationRevokePayload` Autogenerated return type of DastSiteValidationRevoke. @@ -1126,7 +1502,7 @@ Autogenerated return type of DastSiteValidationRevoke. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DeleteAnnotationPayload +### `DeleteAnnotationPayload` Autogenerated return type of DeleteAnnotation. @@ -1135,7 +1511,7 @@ Autogenerated return type of DeleteAnnotation. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DeleteDevopsAdoptionSegmentPayload +### `DeleteDevopsAdoptionSegmentPayload` Autogenerated return type of DeleteDevopsAdoptionSegment. @@ -1144,7 +1520,7 @@ Autogenerated return type of DeleteDevopsAdoptionSegment. | `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. @@ -1154,7 +1530,7 @@ The response from the AdminSidekiqQueuesDeleteJobs mutation. | `deletedJobs` | Int | The number of matching jobs deleted. | | `queueSize` | Int | The queue size after processing. | -### Design +### `Design` A single design. @@ -1175,7 +1551,7 @@ A single design. | `project` | Project! | The project the design belongs to. | | `versions` | DesignVersionConnection! | All versions related to this design ordered newest first. | -### DesignAtVersion +### `DesignAtVersion` A design pinned to a specific version. The image field reflects the design as of the associated version. @@ -1194,7 +1570,7 @@ 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. @@ -1209,14 +1585,14 @@ A collection of designs. | `version` | DesignVersion | A specific version. | | `versions` | DesignVersionConnection! | All versions related to all designs, ordered newest first. | -### DesignManagement +### `DesignManagement` | Field | Type | Description | | ----- | ---- | ----------- | | `designAtVersion` | DesignAtVersion | Find a design as of a version. | | `version` | DesignVersion | Find a version. | -### DesignManagementDeletePayload +### `DesignManagementDeletePayload` Autogenerated return type of DesignManagementDelete. @@ -1226,7 +1602,7 @@ Autogenerated return type of DesignManagementDelete. | `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. @@ -1236,7 +1612,7 @@ Autogenerated return type of DesignManagementMove. | `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. @@ -1247,7 +1623,7 @@ Autogenerated return type of DesignManagementUpload. | `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. @@ -1259,7 +1635,7 @@ A specific version in which designs were added, modified or deleted. | `id` | ID! | ID of the design version. | | `sha` | ID! | SHA of the design version. | -### DestroyBoardListPayload +### `DestroyBoardListPayload` Autogenerated return type of DestroyBoardList. @@ -1269,7 +1645,7 @@ Autogenerated return type of DestroyBoardList. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `list` | BoardList | The list after mutation. | -### DestroyBoardPayload +### `DestroyBoardPayload` Autogenerated return type of DestroyBoard. @@ -1279,7 +1655,7 @@ Autogenerated return type of DestroyBoard. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DestroyComplianceFrameworkPayload +### `DestroyComplianceFrameworkPayload` Autogenerated return type of DestroyComplianceFramework. @@ -1288,7 +1664,7 @@ Autogenerated return type of DestroyComplianceFramework. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DestroyContainerRepositoryPayload +### `DestroyContainerRepositoryPayload` Autogenerated return type of DestroyContainerRepository. @@ -1298,7 +1674,7 @@ Autogenerated return type of DestroyContainerRepository. | `containerRepository` | ContainerRepository! | The container repository policy after scheduling the deletion. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DestroyContainerRepositoryTagsPayload +### `DestroyContainerRepositoryTagsPayload` Autogenerated return type of DestroyContainerRepositoryTags. @@ -1308,7 +1684,7 @@ Autogenerated return type of DestroyContainerRepositoryTags. | `deletedTagNames` | String! => Array | Deleted container repository tags. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DestroyNotePayload +### `DestroyNotePayload` Autogenerated return type of DestroyNote. @@ -1318,7 +1694,7 @@ Autogenerated return type of DestroyNote. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation. | -### DestroySnippetPayload +### `DestroySnippetPayload` Autogenerated return type of DestroySnippet. @@ -1328,7 +1704,7 @@ Autogenerated return type of DestroySnippet. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `snippet` | Snippet | The snippet after mutation. | -### DetailedStatus +### `DetailedStatus` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1342,7 +1718,7 @@ Autogenerated return type of DestroySnippet. | `text` | String | Text of the status. | | `tooltip` | String | Tooltip associated with the status. | -### DevopsAdoptionSegment +### `DevopsAdoptionSegment` Segment. @@ -1352,7 +1728,7 @@ Segment. | `latestSnapshot` | DevopsAdoptionSnapshot | The latest adoption metrics for the segment. | | `namespace` | Namespace | Segment namespace. | -### DevopsAdoptionSnapshot +### `DevopsAdoptionSnapshot` Snapshot. @@ -1369,7 +1745,7 @@ Snapshot. | `securityScanSucceeded` | Boolean! | At least one security scan succeeded. | | `startTime` | Time! | The start time for the snapshot where the data points were collected. | -### DiffPosition +### `DiffPosition` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1385,7 +1761,7 @@ Snapshot. | `x` | Int | X position of the note. | | `y` | Int | Y position of the note. | -### DiffRefs +### `DiffRefs` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1393,7 +1769,7 @@ Snapshot. | `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. @@ -1403,7 +1779,7 @@ Changes to a single file. | `deletions` | Int! | Number of lines deleted from this file. | | `path` | String! | File path, relative to repository root. | -### DiffStatsSummary +### `DiffStatsSummary` Aggregated summary of changes. @@ -1414,7 +1790,7 @@ Aggregated summary of changes. | `deletions` | Int! | Number of lines deleted. | | `fileCount` | Int! | Number of files changed. | -### Discussion +### `Discussion` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1427,7 +1803,7 @@ 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. @@ -1437,7 +1813,7 @@ Autogenerated return type of DiscussionToggleResolve. | `discussion` | Discussion | The discussion after mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### DismissVulnerabilityPayload +### `DismissVulnerabilityPayload` Autogenerated return type of DismissVulnerability. @@ -1447,7 +1823,7 @@ Autogenerated return type of DismissVulnerability. | `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. @@ -1460,7 +1836,7 @@ Describes where code is deployed for a project. | `path` | String! | The path to the environment. | | `state` | String! | State of the environment, for example: available/stopped. | -### EnvironmentsCanaryIngressUpdatePayload +### `EnvironmentsCanaryIngressUpdatePayload` Autogenerated return type of EnvironmentsCanaryIngressUpdate. @@ -1469,7 +1845,7 @@ Autogenerated return type of EnvironmentsCanaryIngressUpdate. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### Epic +### `Epic` Represents an epic. @@ -1522,7 +1898,7 @@ Represents an epic. | `webPath` | String! | Web path of the epic. | | `webUrl` | String! | Web URL of the epic. | -### EpicAddIssuePayload +### `EpicAddIssuePayload` Autogenerated return type of EpicAddIssue. @@ -1533,17 +1909,22 @@ Autogenerated return type of EpicAddIssue. | `epicIssue` | EpicIssue | The epic-issue relation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### EpicBoard +### `EpicBoard` Represents an epic board. | Field | Type | Description | | ----- | ---- | ----------- | -| `id` | BoardsEpicBoardID! | Global ID of the board. | +| `hideBacklogList` | Boolean | Whether or not backlog list is hidden. | +| `hideClosedList` | Boolean | Whether or not closed list is hidden. | +| `id` | BoardsEpicBoardID! | Global ID of the epic board. | +| `labels` | LabelConnection | Labels of the board. | | `lists` | EpicListConnection | Epic board lists. | -| `name` | String | Name of the board. | +| `name` | String | Name of the epic board. | +| `webPath` | String! | Web path of the epic board. | +| `webUrl` | String! | Web URL of the epic board. | -### EpicBoardCreatePayload +### `EpicBoardCreatePayload` Autogenerated return type of EpicBoardCreate. @@ -1553,7 +1934,7 @@ Autogenerated return type of EpicBoardCreate. | `epicBoard` | EpicBoard | The created epic board. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### EpicBoardListCreatePayload +### `EpicBoardListCreatePayload` Autogenerated return type of EpicBoardListCreate. @@ -1563,7 +1944,17 @@ Autogenerated return type of EpicBoardListCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `list` | EpicList | Epic list in the epic board. | -### EpicDescendantCount +### `EpicBoardUpdatePayload` + +Autogenerated return type of EpicBoardUpdate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `epicBoard` | EpicBoard | The updated epic board. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + +### `EpicDescendantCount` Counts of descendent epics. @@ -1574,7 +1965,7 @@ Counts of descendent epics. | `openedEpics` | Int | Number of opened child epics. | | `openedIssues` | Int | Number of opened epic issues. | -### EpicDescendantWeights +### `EpicDescendantWeights` Total weight of open and closed descendant issues. @@ -1583,7 +1974,7 @@ Total weight of open and closed descendant issues. | `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. @@ -1593,7 +1984,7 @@ Health status of child issues. | `issuesNeedingAttention` | Int | Number of issues that need attention. | | `issuesOnTrack` | Int | Number of issues on track. | -### EpicIssue +### `EpicIssue` Relationship between an epic and an issue. @@ -1604,6 +1995,7 @@ Relationship between an epic and an issue. | `author` | User! | User that created the issue. | | `blocked` | Boolean! | Indicates the issue is blocked. | | `blockedByCount` | Int | Count of issues blocking this issue. | +| `blockedByIssues` | IssueConnection | Issues blocking this issue. | | `closedAt` | Time | Timestamp of when the issue was closed. | | `confidential` | Boolean! | Indicates the issue is confidential. | | `createNoteEmail` | String | User specific email address for the issue. | @@ -1656,20 +2048,31 @@ Relationship between an epic and an issue. | `webUrl` | String! | Web URL of the issue. | | `weight` | Int | Weight of the issue. | -### EpicList +### `EpicList` Represents an epic board list. | Field | Type | Description | | ----- | ---- | ----------- | +| `collapsed` | Boolean | Indicates if this list is collapsed for this user. | | `epics` | EpicConnection | List epics. | +| `epicsCount` | Int | Count of epics in the list. | | `id` | BoardsEpicListID! | Global ID of the board list. | | `label` | Label | Label of the list. | | `listType` | String! | Type of the list. | | `position` | Int | Position of the list within the board. | | `title` | String! | Title of the list. | -### EpicPermissions +### `EpicMoveListPayload` + +Autogenerated return type of EpicMoveList. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + +### `EpicPermissions` Check permissions for the current user on an epic. @@ -1684,7 +2087,7 @@ 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. @@ -1694,7 +2097,7 @@ Autogenerated return type of EpicSetSubscription. | `epic` | Epic | The epic after mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### EpicTreeReorderPayload +### `EpicTreeReorderPayload` Autogenerated return type of EpicTreeReorder. @@ -1703,7 +2106,7 @@ Autogenerated return type of EpicTreeReorder. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### Event +### `Event` Representing an event. @@ -1715,7 +2118,7 @@ Representing an event. | `id` | ID! | ID of the event. | | `updatedAt` | Time! | When this event was updated. | -### ExportRequirementsPayload +### `ExportRequirementsPayload` Autogenerated return type of ExportRequirements. @@ -1724,7 +2127,7 @@ Autogenerated return type of ExportRequirements. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### ExternalIssue +### `ExternalIssue` Represents an external issue. @@ -1738,13 +2141,14 @@ Represents an external issue. | `updatedAt` | Time | Timestamp of when the issue was updated. | | `webUrl` | String | URL to the issue in the external tracker. | -### GeoNode +### `GeoNode` | 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. | +| `groupWikiRepositoryRegistries` | GroupWikiRepositoryRegistryConnection | Find group wiki repository registries on this Geo node. Available only when feature flag `geo_group_wiki_repository_replication` is enabled. | | `id` | ID! | ID of this GeoNode. | | `internalUrl` | String | The URL defined on the primary node that secondary nodes should use to contact it. | | `mergeRequestDiffRegistries` | MergeRequestDiffRegistryConnection | Find merge request diff registries on this Geo node. | @@ -1762,7 +2166,7 @@ Represents an external issue. | `url` | String | The user-facing URL for this Geo node. | | `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node. | -### GitlabSubscriptionActivatePayload +### `GitlabSubscriptionActivatePayload` Autogenerated return type of GitlabSubscriptionActivate. @@ -1771,7 +2175,7 @@ Autogenerated return type of GitlabSubscriptionActivate. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### GrafanaIntegration +### `GrafanaIntegration` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1781,7 +2185,7 @@ Autogenerated return type of GitlabSubscriptionActivate. | `id` | ID! | Internal ID of the Grafana integration. | | `updatedAt` | Time! | Timestamp of the issue's last activity. | -### Group +### `Group` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1821,6 +2225,7 @@ Autogenerated return type of GitlabSubscriptionActivate. | `milestones` | MilestoneConnection | Milestones of the group. | | `name` | String! | Name of the namespace. | | `packageSettings` | PackageSettings | The package settings for the namespace. | +| `packages` | PackageConnection | Packages of the group. | | `parent` | Group | Parent group. | | `path` | String! | Path of the namespace. | | `projectCreationLevel` | String | The permission level required to create projects in the group. | @@ -1848,7 +2253,7 @@ Autogenerated return type of GitlabSubscriptionActivate. | `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 Membership. @@ -1864,13 +2269,13 @@ Represents a Group Membership. | `user` | User! | User that is associated with the member object. | | `userPermissions` | GroupPermissions! | Permissions for the current user on the resource | -### GroupPermissions +### `GroupPermissions` | Field | Type | Description | | ----- | ---- | ----------- | | `readGroup` | Boolean! | Indicates the user can perform `read_group` on this resource | -### GroupReleaseStats +### `GroupReleaseStats` Contains release-related statistics about a group. @@ -1879,7 +2284,7 @@ Contains release-related statistics about a group. | `releasesCount` | Int | Total number of releases in all descendant projects of the group. Will always return `null` if `group_level_release_statistics` feature flag is disabled | | `releasesPercentage` | Int | Percentage of the group's descendant projects that have at least one release. Will always return `null` if `group_level_release_statistics` feature flag is disabled | -### GroupStats +### `GroupStats` Contains statistics about a group. @@ -1887,7 +2292,22 @@ Contains statistics about a group. | ----- | ---- | ----------- | | `releaseStats` | GroupReleaseStats | Statistics related to releases within the group. | -### HttpIntegrationCreatePayload +### `GroupWikiRepositoryRegistry` + +Represents the Geo sync and verification state of a group wiki repository. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `createdAt` | Time | Timestamp when the GroupWikiRepositoryRegistry was created | +| `groupWikiRepositoryId` | ID! | ID of the Group Wiki Repository. | +| `id` | ID! | ID of the GroupWikiRepositoryRegistry | +| `lastSyncFailure` | String | Error message during sync of the GroupWikiRepositoryRegistry | +| `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the GroupWikiRepositoryRegistry | +| `retryAt` | Time | Timestamp after which the GroupWikiRepositoryRegistry should be resynced | +| `retryCount` | Int | Number of consecutive failed sync attempts of the GroupWikiRepositoryRegistry | +| `state` | RegistryState | Sync state of the GroupWikiRepositoryRegistry | + +### `HttpIntegrationCreatePayload` Autogenerated return type of HttpIntegrationCreate. @@ -1897,7 +2317,7 @@ Autogenerated return type of HttpIntegrationCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `integration` | AlertManagementHttpIntegration | The HTTP integration. | -### HttpIntegrationDestroyPayload +### `HttpIntegrationDestroyPayload` Autogenerated return type of HttpIntegrationDestroy. @@ -1907,7 +2327,7 @@ Autogenerated return type of HttpIntegrationDestroy. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `integration` | AlertManagementHttpIntegration | The HTTP integration. | -### HttpIntegrationResetTokenPayload +### `HttpIntegrationResetTokenPayload` Autogenerated return type of HttpIntegrationResetToken. @@ -1917,7 +2337,7 @@ Autogenerated return type of HttpIntegrationResetToken. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `integration` | AlertManagementHttpIntegration | The HTTP integration. | -### HttpIntegrationUpdatePayload +### `HttpIntegrationUpdatePayload` Autogenerated return type of HttpIntegrationUpdate. @@ -1927,12 +2347,14 @@ Autogenerated return type of HttpIntegrationUpdate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `integration` | AlertManagementHttpIntegration | The HTTP integration. | -### IncidentManagementOncallRotation +### `IncidentManagementOncallRotation` Describes an incident management on-call rotation. | Field | Type | Description | | ----- | ---- | ----------- | +| `activePeriod` | OncallRotationActivePeriodType | Active period for the on-call rotation. | +| `endsAt` | Time | End date and time of the on-call rotation. | | `id` | IncidentManagementOncallRotationID! | ID of the on-call rotation. | | `length` | Int | Length of the on-call schedule, in the units specified by lengthUnit. | | `lengthUnit` | OncallRotationUnitEnum | Unit of the on-call rotation length. | @@ -1941,7 +2363,7 @@ Describes an incident management on-call rotation. | `shifts` | IncidentManagementOncallShiftConnection | Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. | | `startsAt` | Time | Start date of the on-call rotation. | -### IncidentManagementOncallSchedule +### `IncidentManagementOncallSchedule` Describes an incident management on-call schedule. @@ -1953,9 +2375,9 @@ Describes an incident management on-call schedule. | `rotations` | IncidentManagementOncallRotationConnection! | On-call rotations for the on-call schedule. | | `timezone` | String! | Time zone of the on-call schedule. | -### IncidentManagementOncallShift +### `IncidentManagementOncallShift` -A block of time for which a participant is on-call.. +A block of time for which a participant is on-call. | Field | Type | Description | | ----- | ---- | ----------- | @@ -1963,7 +2385,7 @@ A block of time for which a participant is on-call.. | `participant` | OncallParticipantType | Participant assigned to the on-call shift. | | `startsAt` | Time | Start time of the on-call shift. | -### InstanceSecurityDashboard +### `InstanceSecurityDashboard` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1972,17 +2394,7 @@ A block of time for which a participant is on-call.. | `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. | | `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard. | -### InstanceStatisticsMeasurement - -Represents a recorded measurement (object count) for the Admins. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `count` | Int! | Object count. | -| `identifier` | MeasurementIdentifier! | The type of objects being measured. | -| `recordedAt` | Time | The time the measurement was recorded. | - -### Issue +### `Issue` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1991,6 +2403,7 @@ Represents a recorded measurement (object count) for the Admins. | `author` | User! | User that created the issue. | | `blocked` | Boolean! | Indicates the issue is blocked. | | `blockedByCount` | Int | Count of issues blocking this issue. | +| `blockedByIssues` | IssueConnection | Issues blocking this issue. | | `closedAt` | Time | Timestamp of when the issue was closed. | | `confidential` | Boolean! | Indicates the issue is confidential. | | `createNoteEmail` | String | User specific email address for the issue. | @@ -2041,7 +2454,7 @@ Represents a recorded measurement (object count) for the Admins. | `webUrl` | String! | Web URL of the issue. | | `weight` | Int | Weight of the issue. | -### IssueMoveListPayload +### `IssueMoveListPayload` Autogenerated return type of IssueMoveList. @@ -2051,7 +2464,7 @@ Autogenerated return type of IssueMoveList. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueMovePayload +### `IssueMovePayload` Autogenerated return type of IssueMove. @@ -2061,7 +2474,7 @@ Autogenerated return type of IssueMove. | `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. @@ -2076,7 +2489,7 @@ 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. @@ -2086,7 +2499,7 @@ Autogenerated return type of IssueSetAssignees. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueSetConfidentialPayload +### `IssueSetConfidentialPayload` Autogenerated return type of IssueSetConfidential. @@ -2096,7 +2509,7 @@ Autogenerated return type of IssueSetConfidential. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueSetDueDatePayload +### `IssueSetDueDatePayload` Autogenerated return type of IssueSetDueDate. @@ -2106,7 +2519,7 @@ Autogenerated return type of IssueSetDueDate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueSetEpicPayload +### `IssueSetEpicPayload` Autogenerated return type of IssueSetEpic. @@ -2116,7 +2529,7 @@ Autogenerated return type of IssueSetEpic. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueSetIterationPayload +### `IssueSetIterationPayload` Autogenerated return type of IssueSetIteration. @@ -2126,7 +2539,7 @@ Autogenerated return type of IssueSetIteration. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueSetLockedPayload +### `IssueSetLockedPayload` Autogenerated return type of IssueSetLocked. @@ -2136,7 +2549,7 @@ Autogenerated return type of IssueSetLocked. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueSetSeverityPayload +### `IssueSetSeverityPayload` Autogenerated return type of IssueSetSeverity. @@ -2146,7 +2559,7 @@ Autogenerated return type of IssueSetSeverity. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueSetSubscriptionPayload +### `IssueSetSubscriptionPayload` Autogenerated return type of IssueSetSubscription. @@ -2156,7 +2569,7 @@ Autogenerated return type of IssueSetSubscription. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### IssueSetWeightPayload +### `IssueSetWeightPayload` Autogenerated return type of IssueSetWeight. @@ -2166,7 +2579,7 @@ Autogenerated return type of IssueSetWeight. | `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. @@ -2176,7 +2589,7 @@ Represents total number of issues for the represented statuses. | `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. @@ -2198,7 +2611,31 @@ Represents an iteration object. | `webPath` | String! | Web path of the iteration. | | `webUrl` | String! | Web URL of the iteration. | -### JiraImport +### `IterationCadence` + +Represents an iteration cadence. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `active` | Boolean | Whether the iteration cadence is active. | +| `automatic` | Boolean | Whether the iteration cadence should automatically generate future iterations. | +| `durationInWeeks` | Int! | Duration in weeks of the iterations within this cadence. | +| `id` | IterationsCadenceID! | Global ID of the iteration cadence. | +| `iterationsInAdvance` | Int! | Future iterations to be created when iteration cadence is set to automatic. | +| `startDate` | Time | Timestamp of the iteration cadence start date. | +| `title` | String! | Title of the iteration cadence. | + +### `IterationCadenceCreatePayload` + +Autogenerated return type of IterationCadenceCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `iterationCadence` | IterationCadence | The created iteration cadence. | + +### `JiraImport` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2210,7 +2647,7 @@ 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. @@ -2220,7 +2657,7 @@ Autogenerated return type of JiraImportStart. | `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. @@ -2230,7 +2667,7 @@ Autogenerated return type of JiraImportUsers. | `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` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2238,7 +2675,7 @@ Autogenerated return type of JiraImportUsers. | `name` | String | Name of the Jira project. | | `projectId` | Int! | ID of the Jira project. | -### JiraService +### `JiraService` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2246,7 +2683,7 @@ Autogenerated return type of JiraImportUsers. | `projects` | JiraProjectConnection | List of all Jira projects fetched through Jira REST API. | | `type` | String | Class name of the service. | -### JiraUser +### `JiraUser` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2257,18 +2694,20 @@ Autogenerated return type of JiraImportUsers. | `jiraDisplayName` | String! | Display name of the Jira user. | | `jiraEmail` | String | Email of the Jira user, returned only for users with public emails. | -### Label +### `Label` | Field | Type | Description | | ----- | ---- | ----------- | | `color` | String! | Background color of the label. | +| `createdAt` | Time! | When this label was created. | | `description` | String | Description of the label (Markdown rendered as HTML for caching). | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `id` | ID! | Label ID. | | `textColor` | String! | Text color of the label. | | `title` | String! | Content of the label. | +| `updatedAt` | Time! | When this label was last updated. | -### LabelCreatePayload +### `LabelCreatePayload` Autogenerated return type of LabelCreate. @@ -2278,7 +2717,7 @@ Autogenerated return type of LabelCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `label` | Label | The label after mutation. | -### MarkAsSpamSnippetPayload +### `MarkAsSpamSnippetPayload` Autogenerated return type of MarkAsSpamSnippet. @@ -2288,7 +2727,7 @@ Autogenerated return type of MarkAsSpamSnippet. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `snippet` | Snippet | The snippet after mutation. | -### MergeRequest +### `MergeRequest` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2318,6 +2757,7 @@ Autogenerated return type of MarkAsSpamSnippet. | `diffStatsSummary` | DiffStatsSummary | Summary of which files were changed in this merge request. | | `discussionLocked` | Boolean! | Indicates if comments on the merge request are locked to members only. | | `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `divergedFromTargetBranch` | Boolean! | Indicates if the source branch is behind the target branch. | | `downvotes` | Int! | Number of downvotes for the merge request. | | `forceRemoveSourceBranch` | Boolean | Indicates if the project settings will lead to source branch deletion after merge. | | `hasCi` | Boolean! | Indicates if the merge request has CI. | @@ -2348,6 +2788,7 @@ Autogenerated return type of MarkAsSpamSnippet. | `reference` | String! | Internal reference of the merge request. Returned in shortened format by default. | | `reviewers` | UserConnection | Users from whom a review has been requested. | | `securityAutoFix` | Boolean | Indicates if the merge request is created by @GitLab-Security-Bot. | +| `securityReportsUpToDateOnTargetBranch` | Boolean! | Indicates if the target branch security reports are out of date. | | `shouldBeRebased` | Boolean! | Indicates if the merge request will be rebased. | | `shouldRemoveSourceBranch` | Boolean | Indicates if the source branch of the merge request will be deleted after merge. | | `sourceBranch` | String! | Source branch of the merge request. | @@ -2374,9 +2815,19 @@ Autogenerated return type of MarkAsSpamSnippet. | `userNotesCount` | Int | User notes count of the merge request. | | `userPermissions` | MergeRequestPermissions! | Permissions for the current user on the resource | | `webUrl` | String | Web URL of the merge request. | -| `workInProgress` | Boolean! | Indicates if the merge request is a work in progress (WIP). | +| `workInProgress` | Boolean! | Indicates if the merge request is a draft. | + +### `MergeRequestAcceptPayload` + +Autogenerated return type of MergeRequestAccept. + +| 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. | -### MergeRequestCreatePayload +### `MergeRequestCreatePayload` Autogenerated return type of MergeRequestCreate. @@ -2386,7 +2837,7 @@ Autogenerated return type of MergeRequestCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### MergeRequestDiffRegistry +### `MergeRequestDiffRegistry` Represents the Geo sync and verification state of a Merge Request diff. @@ -2401,7 +2852,7 @@ Represents the Geo sync and verification state of a Merge Request diff. | `retryCount` | Int | Number of consecutive failed sync attempts of the MergeRequestDiffRegistry | | `state` | RegistryState | Sync state of the MergeRequestDiffRegistry | -### MergeRequestPermissions +### `MergeRequestPermissions` Check permissions for the current user on a merge request. @@ -2417,7 +2868,7 @@ 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 | -### MergeRequestReviewerRereviewPayload +### `MergeRequestReviewerRereviewPayload` Autogenerated return type of MergeRequestReviewerRereview. @@ -2427,7 +2878,7 @@ Autogenerated return type of MergeRequestReviewerRereview. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### MergeRequestSetAssigneesPayload +### `MergeRequestSetAssigneesPayload` Autogenerated return type of MergeRequestSetAssignees. @@ -2437,7 +2888,7 @@ Autogenerated return type of MergeRequestSetAssignees. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### MergeRequestSetLabelsPayload +### `MergeRequestSetLabelsPayload` Autogenerated return type of MergeRequestSetLabels. @@ -2447,7 +2898,7 @@ Autogenerated return type of MergeRequestSetLabels. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### MergeRequestSetLockedPayload +### `MergeRequestSetLockedPayload` Autogenerated return type of MergeRequestSetLocked. @@ -2457,7 +2908,7 @@ Autogenerated return type of MergeRequestSetLocked. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### MergeRequestSetMilestonePayload +### `MergeRequestSetMilestonePayload` Autogenerated return type of MergeRequestSetMilestone. @@ -2467,7 +2918,7 @@ Autogenerated return type of MergeRequestSetMilestone. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### MergeRequestSetSubscriptionPayload +### `MergeRequestSetSubscriptionPayload` Autogenerated return type of MergeRequestSetSubscription. @@ -2477,7 +2928,7 @@ Autogenerated return type of MergeRequestSetSubscription. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### MergeRequestSetWipPayload +### `MergeRequestSetWipPayload` Autogenerated return type of MergeRequestSetWip. @@ -2487,7 +2938,7 @@ Autogenerated return type of MergeRequestSetWip. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### MergeRequestUpdatePayload +### `MergeRequestUpdatePayload` Autogenerated return type of MergeRequestUpdate. @@ -2497,14 +2948,14 @@ Autogenerated return type of MergeRequestUpdate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation. | -### Metadata +### `Metadata` | Field | Type | Description | | ----- | ---- | ----------- | | `revision` | String! | Revision. | | `version` | String! | Version. | -### MetricImage +### `MetricImage` Represents a metric image upload. @@ -2516,7 +2967,7 @@ Represents a metric image upload. | `iid` | ID! | Internal ID of the metric upload. | | `url` | String! | URL of the metric source. | -### MetricsDashboard +### `MetricsDashboard` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2524,7 +2975,7 @@ Represents a metric image upload. | `path` | String | Path to a file with the dashboard definition. | | `schemaValidationWarnings` | String! => Array | Dashboard schema validation warnings. | -### MetricsDashboardAnnotation +### `MetricsDashboardAnnotation` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2534,7 +2985,7 @@ Represents a metric image upload. | `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. @@ -2555,7 +3006,7 @@ Represents a milestone. | `updatedAt` | Time! | Timestamp of last milestone update. | | `webPath` | String! | Web path of the milestone. | -### MilestoneStats +### `MilestoneStats` Contains statistics about a milestone. @@ -2564,7 +3015,7 @@ Contains statistics about a milestone. | `closedIssuesCount` | Int | Number of closed issues associated with the milestone. | | `totalIssuesCount` | Int | Total number of issues associated with the milestone. | -### Namespace +### `Namespace` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2592,7 +3043,7 @@ Contains statistics about a milestone. | `totalRepositorySizeExcess` | Float | Total excess repository size of all projects in the root namespace in bytes. | | `visibility` | String | Visibility of the namespace. | -### NamespaceIncreaseStorageTemporarilyPayload +### `NamespaceIncreaseStorageTemporarilyPayload` Autogenerated return type of NamespaceIncreaseStorageTemporarily. @@ -2602,7 +3053,7 @@ Autogenerated return type of NamespaceIncreaseStorageTemporarily. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `namespace` | Namespace | The namespace after mutation. | -### Note +### `Note` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2625,7 +3076,7 @@ Autogenerated return type of NamespaceIncreaseStorageTemporarily. | `url` | String | URL to view this Note in the Web UI. | | `userPermissions` | NotePermissions! | Permissions for the current user on the resource | -### NotePermissions +### `NotePermissions` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2636,7 +3087,7 @@ Autogenerated return type of NamespaceIncreaseStorageTemporarily. | `repositionNote` | Boolean! | Indicates the user can perform `reposition_note` on this resource | | `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource | -### OncallParticipantType +### `OncallParticipantType` The rotation participant and color palette. @@ -2647,7 +3098,16 @@ The rotation participant and color palette. | `id` | IncidentManagementOncallParticipantID! | ID of the on-call participant. | | `user` | User! | The user who is participating. | -### OncallRotationCreatePayload +### `OncallRotationActivePeriodType` + +Active period time range for on-call rotation. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `endTime` | String | The end of the rotation active period. | +| `startTime` | String | The start of the rotation active period. | + +### `OncallRotationCreatePayload` Autogenerated return type of OncallRotationCreate. @@ -2657,7 +3117,7 @@ Autogenerated return type of OncallRotationCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation. | -### OncallRotationDestroyPayload +### `OncallRotationDestroyPayload` Autogenerated return type of OncallRotationDestroy. @@ -2667,7 +3127,7 @@ Autogenerated return type of OncallRotationDestroy. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation. | -### OncallScheduleCreatePayload +### `OncallScheduleCreatePayload` Autogenerated return type of OncallScheduleCreate. @@ -2677,7 +3137,7 @@ Autogenerated return type of OncallScheduleCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. | -### OncallScheduleDestroyPayload +### `OncallScheduleDestroyPayload` Autogenerated return type of OncallScheduleDestroy. @@ -2687,7 +3147,7 @@ Autogenerated return type of OncallScheduleDestroy. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. | -### OncallScheduleUpdatePayload +### `OncallScheduleUpdatePayload` Autogenerated return type of OncallScheduleUpdate. @@ -2697,7 +3157,7 @@ Autogenerated return type of OncallScheduleUpdate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. | -### Package +### `Package` Represents a package in the Package Registry. @@ -2715,7 +3175,7 @@ Represents a package in the Package Registry. | `version` | String | Version string. | | `versions` | PackageWithoutVersionsConnection | The other versions of the package. | -### PackageComposerJsonType +### `PackageComposerJsonType` Represents a composer JSON file. @@ -2726,7 +3186,7 @@ Represents a composer JSON file. | `type` | String | The type set in the Composer JSON file. | | `version` | String | The version set in the Composer JSON file. | -### PackageFileRegistry +### `PackageFileRegistry` Represents the Geo sync and verification state of a package file. @@ -2741,7 +3201,7 @@ Represents the Geo 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 | -### PackageSettings +### `PackageSettings` Namespace-level Package Registry settings. @@ -2750,7 +3210,7 @@ Namespace-level Package Registry settings. | `mavenDuplicateExceptionRegex` | UntrustedRegexp | When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. | | `mavenDuplicatesAllowed` | Boolean! | Indicates whether duplicate Maven packages are allowed for this namespace. | -### PackageTag +### `PackageTag` Represents a package tag. @@ -2761,7 +3221,7 @@ Represents a package tag. | `name` | String! | The name of the tag. | | `updatedAt` | Time! | The updated date. | -### PackageWithoutVersions +### `PackageWithoutVersions` Represents a version of a package in the Package Registry. @@ -2778,9 +3238,9 @@ Represents a version of a package in the Package Registry. | `updatedAt` | Time! | Date of most recent update. | | `version` | String | Version string. | -### PageInfo +### `PageInfo` -Information about pagination in a connection.. +Information about pagination in a connection. | Field | Type | Description | | ----- | ---- | ----------- | @@ -2789,13 +3249,14 @@ Information about pagination in a connection.. | `hasPreviousPage` | Boolean! | When paginating backwards, are there more items? | | `startCursor` | String | When paginating backwards, the cursor to continue. | -### Pipeline +### `Pipeline` | Field | Type | Description | | ----- | ---- | ----------- | | `active` | Boolean! | Indicates if the pipeline is active. | | `beforeSha` | String | Base SHA of the source branch. | | `cancelable` | Boolean! | Specifies if a pipeline can be canceled. | +| `commitPath` | String | Path to the commit that triggered the pipeline. | | `committedAt` | Time | Timestamp of the pipeline's commit. | | `configSource` | PipelineConfigSourceEnum | Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE) | | `coverage` | Float | Coverage percentage. | @@ -2810,6 +3271,7 @@ Information about pagination in a connection.. | `path` | String | Relative path to the pipeline's page. | | `project` | Project | Project the pipeline belongs to. | | `retryable` | Boolean! | Specifies if a pipeline can be retried. | +| `securityReportFindings` | PipelineSecurityReportFindingConnection | Vulnerability findings reported on the pipeline. | | `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline. | | `sha` | String! | SHA of the pipeline's commit. | | `sourceJob` | CiJob | Job where pipeline was triggered from. | @@ -2822,7 +3284,7 @@ Information about pagination in a connection.. | `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource | | `warnings` | Boolean! | Indicates if a pipeline has warnings. | -### PipelineAnalytics +### `PipelineAnalytics` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2838,7 +3300,7 @@ Information about pagination in a connection.. | `yearPipelinesSuccessful` | Int! => Array | Total yearly successful pipeline count. | | `yearPipelinesTotals` | Int! => Array | Total yearly pipeline count. | -### PipelineCancelPayload +### `PipelineCancelPayload` Autogenerated return type of PipelineCancel. @@ -2847,7 +3309,7 @@ Autogenerated return type of PipelineCancel. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### PipelineDestroyPayload +### `PipelineDestroyPayload` Autogenerated return type of PipelineDestroy. @@ -2856,7 +3318,7 @@ Autogenerated return type of PipelineDestroy. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### PipelinePermissions +### `PipelinePermissions` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2864,7 +3326,7 @@ Autogenerated return type of PipelineDestroy. | `destroyPipeline` | Boolean! | Indicates the user can perform `destroy_pipeline` on this resource | | `updatePipeline` | Boolean! | Indicates the user can perform `update_pipeline` on this resource | -### PipelineRetryPayload +### `PipelineRetryPayload` Autogenerated return type of PipelineRetry. @@ -2874,7 +3336,26 @@ Autogenerated return type of PipelineRetry. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipeline` | Pipeline | The pipeline after mutation. | -### Project +### `PipelineSecurityReportFinding` + +Represents vulnerability finding of a security report on the pipeline. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `confidence` | String | Type of the security report that found the vulnerability. | +| `description` | String | Description of the vulnerability finding. | +| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerabilit finding. | +| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. | +| `name` | String | Name of the vulnerability finding. | +| `project` | Project | The project on which the vulnerability finding was found. | +| `projectFingerprint` | String | Name of the vulnerability finding. | +| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability finding. | +| `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. | +| `severity` | VulnerabilitySeverity | Severity of the vulnerability finding. | +| `solution` | String | URL to the vulnerability's details page. | +| `uuid` | String | Name of the vulnerability finding. | + +### `Project` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2882,6 +3363,7 @@ Autogenerated return type of PipelineRetry. | `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project. | | `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project. | | `alertManagementAlerts` | AlertManagementAlertConnection | Alert Management alerts of the project. | +| `alertManagementHttpIntegrations` | AlertManagementHttpIntegrationConnection | HTTP Integrations which can receive alerts for the project. | | `alertManagementIntegrations` | AlertManagementIntegrationConnection | Integrations which can receive alerts for the project. | | `alertManagementPayloadFields` | AlertManagementPayloadAlertField! => Array | Extract alert fields from payload for custom mapping. | | `allowMergeOnSkippedPipeline` | Boolean | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs. | @@ -2905,7 +3387,7 @@ Autogenerated return type of PipelineRetry. | `dastScannerProfiles` | DastScannerProfileConnection | The DAST scanner profiles associated with the project. | | `dastSiteProfile` | DastSiteProfile | DAST Site Profile associated with the project. | | `dastSiteProfiles` | DastSiteProfileConnection | DAST Site Profiles associated with the project. | -| `dastSiteValidations` | DastSiteValidationConnection | DAST Site Validations associated with the project. Always returns no nodes if `security_on_demand_scans_site_validation` is disabled. | +| `dastSiteValidations` | DastSiteValidationConnection | DAST Site Validations 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. | @@ -2949,6 +3431,7 @@ Autogenerated return type of PipelineRetry. | `printingMergeRequestLinkEnabled` | Boolean | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line. | | `projectMembers` | MemberInterfaceConnection | Members of the project. | | `publicJobs` | Boolean | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. | +| `pushRules` | PushRules | The project's push rules settings. | | `release` | Release | A single release of the project. | | `releases` | ReleaseConnection | Releases of the project. | | `removeSourceBranchAfterMerge` | Boolean | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project. | @@ -2986,7 +3469,7 @@ Autogenerated return type of PipelineRetry. | `webUrl` | String | Web URL of the project. | | `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user | -### ProjectCiCdSetting +### `ProjectCiCdSetting` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2995,7 +3478,7 @@ Autogenerated return type of PipelineRetry. | `mergeTrainsEnabled` | Boolean | Whether merge trains are enabled. | | `project` | Project | Project the CI/CD settings belong to. | -### ProjectMember +### `ProjectMember` Represents a Project Membership. @@ -3011,7 +3494,7 @@ Represents a Project Membership. | `user` | User! | User that is associated with the member object. | | `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource | -### ProjectPermissions +### `ProjectPermissions` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3058,7 +3541,7 @@ Represents a Project Membership. | `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` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3072,7 +3555,7 @@ Represents a Project Membership. | `uploadsSize` | Float | Uploads size of the project in bytes. | | `wikiSize` | Float | Wiki size of the project in bytes. | -### PrometheusAlert +### `PrometheusAlert` The alert condition for Prometheus. @@ -3081,7 +3564,7 @@ The alert condition for Prometheus. | `humanizedText` | String! | The human-readable text of the alert condition. | | `id` | ID! | ID of the alert condition. | -### PrometheusIntegrationCreatePayload +### `PrometheusIntegrationCreatePayload` Autogenerated return type of PrometheusIntegrationCreate. @@ -3091,7 +3574,7 @@ Autogenerated return type of PrometheusIntegrationCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `integration` | AlertManagementPrometheusIntegration | The newly created integration. | -### PrometheusIntegrationResetTokenPayload +### `PrometheusIntegrationResetTokenPayload` Autogenerated return type of PrometheusIntegrationResetToken. @@ -3101,7 +3584,7 @@ Autogenerated return type of PrometheusIntegrationResetToken. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `integration` | AlertManagementPrometheusIntegration | The newly created integration. | -### PrometheusIntegrationUpdatePayload +### `PrometheusIntegrationUpdatePayload` Autogenerated return type of PrometheusIntegrationUpdate. @@ -3111,7 +3594,7 @@ Autogenerated return type of PrometheusIntegrationUpdate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `integration` | AlertManagementPrometheusIntegration | The newly created integration. | -### PromoteToEpicPayload +### `PromoteToEpicPayload` Autogenerated return type of PromoteToEpic. @@ -3122,7 +3605,15 @@ Autogenerated return type of PromoteToEpic. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### Release +### `PushRules` + +Represents rules that commit pushes must follow. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `rejectUnsignedCommits` | Boolean! | Indicates whether commits not signed through GPG will be rejected. | + +### `Release` Represents a release. @@ -3143,7 +3634,7 @@ Represents a 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. @@ -3156,7 +3647,17 @@ Represents an asset link associated with a release. | `name` | String | Name of the link. | | `url` | String | URL of the link. | -### ReleaseAssets +### `ReleaseAssetLinkCreatePayload` + +Autogenerated return type of ReleaseAssetLinkCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `link` | ReleaseAssetLink | The asset link after mutation. | + +### `ReleaseAssets` A container for all assets associated with a release. @@ -3166,7 +3667,7 @@ A container for all assets associated with a release. | `links` | ReleaseAssetLinkConnection | Asset links of the release. | | `sources` | ReleaseSourceConnection | Sources of the release. | -### ReleaseCreatePayload +### `ReleaseCreatePayload` Autogenerated return type of ReleaseCreate. @@ -3176,7 +3677,7 @@ Autogenerated return type of ReleaseCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `release` | Release | The release after mutation. | -### ReleaseDeletePayload +### `ReleaseDeletePayload` Autogenerated return type of ReleaseDelete. @@ -3186,7 +3687,7 @@ Autogenerated return type of ReleaseDelete. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `release` | Release | The deleted release. | -### ReleaseEvidence +### `ReleaseEvidence` Evidence for a release. @@ -3197,7 +3698,7 @@ Evidence for a release. | `id` | ID! | ID of the evidence. | | `sha` | String | SHA1 ID of the evidence hash. | -### ReleaseLinks +### `ReleaseLinks` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3209,7 +3710,7 @@ Evidence for a release. | `openedMergeRequestsUrl` | String | HTTP URL of the merge request page, filtered by this release and `state=open`. | | `selfUrl` | String | HTTP URL of the release. | -### ReleaseSource +### `ReleaseSource` Represents the source code attached to a release in a particular format. @@ -3218,7 +3719,7 @@ Represents the source code attached to a release in a particular format. | `format` | String | Format of the source. | | `url` | String | Download URL of the source. | -### ReleaseUpdatePayload +### `ReleaseUpdatePayload` Autogenerated return type of ReleaseUpdate. @@ -3228,7 +3729,7 @@ Autogenerated return type of ReleaseUpdate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `release` | Release | The release after mutation. | -### RemoveAwardEmojiPayload +### `RemoveAwardEmojiPayload` Autogenerated return type of RemoveAwardEmoji. @@ -3238,7 +3739,7 @@ Autogenerated return type of RemoveAwardEmoji. | `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. @@ -3247,7 +3748,7 @@ Autogenerated return type of RemoveProjectFromSecurityDashboard. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### RepositionImageDiffNotePayload +### `RepositionImageDiffNotePayload` Autogenerated return type of RepositionImageDiffNote. @@ -3257,7 +3758,7 @@ Autogenerated return type of RepositionImageDiffNote. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation. | -### Repository +### `Repository` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3266,7 +3767,7 @@ Autogenerated return type of RepositionImageDiffNote. | `rootRef` | String | Default branch of the repository. | | `tree` | Tree | Tree of the repository. | -### Requirement +### `Requirement` Represents a requirement. @@ -3288,7 +3789,7 @@ Represents a 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. @@ -3300,7 +3801,7 @@ Check permissions for the current user on a requirement. | `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. @@ -3309,7 +3810,7 @@ Counts of requirements by their state. | `archived` | Int | Number of archived requirements. | | `opened` | Int | Number of opened requirements. | -### RevertVulnerabilityToDetectedPayload +### `RevertVulnerabilityToDetectedPayload` Autogenerated return type of RevertVulnerabilityToDetected. @@ -3319,7 +3820,7 @@ Autogenerated return type of RevertVulnerabilityToDetected. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `vulnerability` | Vulnerability | The vulnerability after revert. | -### RootStorageStatistics +### `RootStorageStatistics` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3333,7 +3834,7 @@ Autogenerated return type of RevertVulnerabilityToDetected. | `uploadsSize` | Float! | The uploads size in bytes. | | `wikiSize` | Float! | The wiki size in bytes. | -### RunDASTScanPayload +### `RunDASTScanPayload` Autogenerated return type of RunDASTScan. @@ -3343,14 +3844,14 @@ Autogenerated return type of RunDASTScan. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipelineUrl` | String | URL of the pipeline that was created. | -### RunnerArchitecture +### `RunnerArchitecture` | Field | Type | Description | | ----- | ---- | ----------- | | `downloadLocation` | String! | Download location for the runner for the platform architecture. | | `name` | String! | Name of the runner platform architecture. | -### RunnerPlatform +### `RunnerPlatform` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3358,14 +3859,14 @@ Autogenerated return type of RunDASTScan. | `humanReadableName` | String! | Human readable name of the runner platform. | | `name` | String! | Name slug of the runner platform. | -### RunnerSetup +### `RunnerSetup` | Field | Type | Description | | ----- | ---- | ----------- | | `installInstructions` | String! | Instructions for installing the runner on the specified architecture. | | `registerInstructions` | String | Instructions for registering the runner. | -### SastCiConfiguration +### `SastCiConfiguration` Represents a CI configuration of SAST. @@ -3375,7 +3876,7 @@ Represents a CI configuration of SAST. | `global` | SastCiConfigurationEntityConnection | List of global entities related to SAST configuration. | | `pipeline` | SastCiConfigurationEntityConnection | List of pipeline entities related to SAST configuration. | -### SastCiConfigurationAnalyzersEntity +### `SastCiConfigurationAnalyzersEntity` Represents an analyzer entity in SAST CI configuration. @@ -3387,7 +3888,7 @@ Represents an analyzer entity in SAST CI configuration. | `name` | String | Name of the analyzer. | | `variables` | SastCiConfigurationEntityConnection | List of supported variables. | -### SastCiConfigurationEntity +### `SastCiConfigurationEntity` Represents an entity in SAST CI configuration. @@ -3402,7 +3903,7 @@ 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. @@ -3411,7 +3912,7 @@ Represents an entity for options in SAST CI configuration. | `label` | String | Label of option entity. | | `value` | String | Value of option entity. | -### ScannedResource +### `ScannedResource` Represents a resource scanned by a security scan. @@ -3420,7 +3921,7 @@ Represents a resource scanned by a security scan. | `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. @@ -3434,7 +3935,7 @@ 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. @@ -3445,7 +3946,7 @@ Represents a section of a summary of a security report. | `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. @@ -3455,7 +3956,7 @@ Represents a list of security scanners. | `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. @@ -3490,7 +3991,7 @@ 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. @@ -3514,7 +4015,7 @@ 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. @@ -3525,14 +4026,14 @@ An object containing a collection of Sentry errors, and a detailed error. | `errors` | SentryErrorConnection | Collection of Sentry Errors. | | `externalUrl` | String | External URL for Sentry. | -### SentryErrorFrequency +### `SentryErrorFrequency` | 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. @@ -3542,7 +4043,7 @@ An object containing a stack trace entry for a Sentry error. | `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. @@ -3551,7 +4052,7 @@ An object context for a Sentry error stack trace. | `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. @@ -3563,7 +4064,7 @@ An object containing a stack trace entry for a Sentry error. | `line` | String | Function in which the Sentry error occurred. | | `traceContext` | SentryErrorStackTraceContext! => Array | Context of the Sentry error. | -### SentryErrorTags +### `SentryErrorTags` State of a Sentry error. @@ -3572,7 +4073,7 @@ State of a Sentry error. | `level` | String | Severity level of the Sentry Error. | | `logger` | String | Logger of the Sentry Error. | -### Snippet +### `Snippet` Represents a snippet entry. @@ -3598,7 +4099,7 @@ Represents a snippet entry. | `visibilityLevel` | VisibilityLevelsEnum! | Visibility Level of the snippet. | | `webUrl` | String! | Web URL of the snippet. | -### SnippetBlob +### `SnippetBlob` Represents the snippet blob. @@ -3617,7 +4118,7 @@ Represents the snippet blob. | `simpleViewer` | SnippetBlobViewer! | Blob content simple viewer. | | `size` | Int! | Blob size. | -### SnippetBlobViewer +### `SnippetBlobViewer` Represents how the blob content should be displayed. @@ -3631,7 +4132,7 @@ 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` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3642,7 +4143,7 @@ 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 | -### SnippetRepositoryRegistry +### `SnippetRepositoryRegistry` Represents the Geo sync and verification state of a snippet repository. @@ -3657,7 +4158,7 @@ Represents the Geo sync and verification state of a snippet repository. | `snippetRepositoryId` | ID! | ID of the Snippet Repository. | | `state` | RegistryState | Sync state of the SnippetRepositoryRegistry | -### StatusAction +### `StatusAction` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3667,7 +4168,7 @@ Represents the Geo sync and verification state of a snippet repository. | `path` | String | Path for the action. | | `title` | String | Title for the action, for example: Retry. | -### Submodule +### `Submodule` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3680,7 +4181,7 @@ Represents the Geo sync and verification state of a snippet repository. | `type` | EntryType! | Type of tree entry. | | `webUrl` | String | Web URL for the sub-module. | -### TaskCompletionStatus +### `TaskCompletionStatus` Completion status of tasks. @@ -3689,7 +4190,7 @@ Completion status of tasks. | `completedCount` | Int! | Number of completed tasks. | | `count` | Int! | Number of total tasks. | -### TerraformState +### `TerraformState` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3701,7 +4202,7 @@ Completion status of tasks. | `name` | String! | Name of the Terraform state. | | `updatedAt` | Time! | Timestamp the Terraform state was updated. | -### TerraformStateDeletePayload +### `TerraformStateDeletePayload` Autogenerated return type of TerraformStateDelete. @@ -3710,7 +4211,7 @@ Autogenerated return type of TerraformStateDelete. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### TerraformStateLockPayload +### `TerraformStateLockPayload` Autogenerated return type of TerraformStateLock. @@ -3719,7 +4220,7 @@ Autogenerated return type of TerraformStateLock. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### TerraformStateUnlockPayload +### `TerraformStateUnlockPayload` Autogenerated return type of TerraformStateUnlock. @@ -3728,7 +4229,7 @@ Autogenerated return type of TerraformStateUnlock. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### TerraformStateVersion +### `TerraformStateVersion` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3740,7 +4241,7 @@ Autogenerated return type of TerraformStateUnlock. | `serial` | Int | Serial number of the version. | | `updatedAt` | Time! | Timestamp the version was updated. | -### TerraformStateVersionRegistry +### `TerraformStateVersionRegistry` Represents the Geo sync and verification state of a terraform state version. @@ -3755,7 +4256,7 @@ Represents the Geo sync and verification state of a terraform state version. | `state` | RegistryState | Sync state of the TerraformStateVersionRegistry | | `terraformStateVersionId` | ID! | ID of the terraform state version. | -### TestReport +### `TestReport` Represents a requirement test report. @@ -3766,7 +4267,7 @@ Represents a requirement test report. | `id` | ID! | ID of the test report. | | `state` | TestReportState! | State of the test report. | -### TimeReportStats +### `TimeReportStats` Represents the time report stats for timeboxes. @@ -3776,7 +4277,7 @@ Represents the time report stats for timeboxes. | `incomplete` | TimeboxMetrics | Incomplete issues metrics. | | `total` | TimeboxMetrics | Total issues metrics. | -### TimeboxMetrics +### `TimeboxMetrics` Represents measured stats metrics for timeboxes. @@ -3785,7 +4286,7 @@ Represents measured stats metrics for timeboxes. | `count` | Int! | The count metric. | | `weight` | Int! | The weight metric. | -### TimeboxReport +### `TimeboxReport` Represents a historically accurate report about the timebox. @@ -3794,7 +4295,7 @@ Represents a historically accurate report about the timebox. | `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts. | | `stats` | TimeReportStats | Represents the time report stats for the timebox. | -### Timelog +### `Timelog` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3804,7 +4305,7 @@ Represents a historically accurate report about the timebox. | `timeSpent` | Int! | The time spent displayed in seconds. | | `user` | User! | The user that logged the time. | -### Todo +### `Todo` Representing a to-do entry. @@ -3820,7 +4321,7 @@ Representing a to-do entry. | `state` | TodoStateEnum! | State of the to-do item. | | `targetType` | TodoTargetEnum! | Target type of the to-do item. | -### TodoCreatePayload +### `TodoCreatePayload` Autogenerated return type of TodoCreate. @@ -3830,7 +4331,7 @@ Autogenerated return type of TodoCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `todo` | Todo | The to-do item created. | -### TodoMarkDonePayload +### `TodoMarkDonePayload` Autogenerated return type of TodoMarkDone. @@ -3840,7 +4341,7 @@ Autogenerated return type of TodoMarkDone. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `todo` | Todo! | The requested to-do item. | -### TodoRestoreManyPayload +### `TodoRestoreManyPayload` Autogenerated return type of TodoRestoreMany. @@ -3851,7 +4352,7 @@ Autogenerated return type of TodoRestoreMany. | `todos` | Todo! => Array | Updated to-do items. | | `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. | -### TodoRestorePayload +### `TodoRestorePayload` Autogenerated return type of TodoRestore. @@ -3861,7 +4362,7 @@ Autogenerated return type of TodoRestore. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `todo` | Todo! | The requested to-do item. | -### TodosMarkAllDonePayload +### `TodosMarkAllDonePayload` Autogenerated return type of TodosMarkAllDone. @@ -3872,7 +4373,7 @@ Autogenerated return type of TodosMarkAllDone. | `todos` | Todo! => Array | Updated to-do items. | | `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. | -### ToggleAwardEmojiPayload +### `ToggleAwardEmojiPayload` Autogenerated return type of ToggleAwardEmoji. @@ -3883,7 +4384,7 @@ Autogenerated return type of ToggleAwardEmoji. | `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` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3892,7 +4393,7 @@ Autogenerated return type of ToggleAwardEmoji. | `submodules` | SubmoduleConnection! | Sub-modules of the tree. | | `trees` | TreeEntryConnection! | Trees of the tree. | -### TreeEntry +### `TreeEntry` Represents a directory. @@ -3907,7 +4408,7 @@ 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. @@ -3919,7 +4420,7 @@ Autogenerated return type of UpdateAlertStatus. | `issue` | Issue | The issue created after mutation. | | `todo` | Todo | The to-do item after mutation. | -### UpdateBoardEpicUserPreferencesPayload +### `UpdateBoardEpicUserPreferencesPayload` Autogenerated return type of UpdateBoardEpicUserPreferences. @@ -3929,7 +4430,7 @@ Autogenerated return type of UpdateBoardEpicUserPreferences. | `epicUserPreferences` | BoardEpicUserPreferences | User preferences for the epic in the board after mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### UpdateBoardListPayload +### `UpdateBoardListPayload` Autogenerated return type of UpdateBoardList. @@ -3939,7 +4440,7 @@ Autogenerated return type of UpdateBoardList. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `list` | BoardList | Mutated list. | -### UpdateBoardPayload +### `UpdateBoardPayload` Autogenerated return type of UpdateBoard. @@ -3949,7 +4450,7 @@ Autogenerated return type of UpdateBoard. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### UpdateComplianceFrameworkPayload +### `UpdateComplianceFrameworkPayload` Autogenerated return type of UpdateComplianceFramework. @@ -3959,7 +4460,7 @@ Autogenerated return type of UpdateComplianceFramework. | `complianceFramework` | ComplianceFramework | The compliance framework after mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### UpdateContainerExpirationPolicyPayload +### `UpdateContainerExpirationPolicyPayload` Autogenerated return type of UpdateContainerExpirationPolicy. @@ -3969,7 +4470,7 @@ Autogenerated return type of UpdateContainerExpirationPolicy. | `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. @@ -3979,7 +4480,7 @@ Autogenerated return type of UpdateEpic. | `epic` | Epic | The epic after mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### UpdateImageDiffNotePayload +### `UpdateImageDiffNotePayload` Autogenerated return type of UpdateImageDiffNote. @@ -3989,7 +4490,7 @@ Autogenerated return type of UpdateImageDiffNote. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation. | -### UpdateIssuePayload +### `UpdateIssuePayload` Autogenerated return type of UpdateIssue. @@ -3999,7 +4500,7 @@ Autogenerated return type of UpdateIssue. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### UpdateIterationPayload +### `UpdateIterationPayload` Autogenerated return type of UpdateIteration. @@ -4009,7 +4510,7 @@ Autogenerated return type of UpdateIteration. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `iteration` | Iteration | Updated iteration. | -### UpdateNamespacePackageSettingsPayload +### `UpdateNamespacePackageSettingsPayload` Autogenerated return type of UpdateNamespacePackageSettings. @@ -4019,7 +4520,7 @@ Autogenerated return type of UpdateNamespacePackageSettings. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `packageSettings` | PackageSettings | The namespace package setting after mutation. | -### UpdateNotePayload +### `UpdateNotePayload` Autogenerated return type of UpdateNote. @@ -4029,7 +4530,7 @@ Autogenerated return type of UpdateNote. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation. | -### UpdateRequirementPayload +### `UpdateRequirementPayload` Autogenerated return type of UpdateRequirement. @@ -4039,7 +4540,7 @@ Autogenerated return type of UpdateRequirement. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `requirement` | Requirement | Requirement after mutation. | -### UpdateSnippetPayload +### `UpdateSnippetPayload` Autogenerated return type of UpdateSnippet. @@ -4053,7 +4554,17 @@ Autogenerated return type of UpdateSnippet. | `spam` | Boolean | Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response. | | `spamLogId` | Int | The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | -### User +### `UsageTrendsMeasurement` + +Represents a recorded measurement (object count) for the Admins. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `count` | Int! | Object count. | +| `identifier` | MeasurementIdentifier! | The type of objects being measured. | +| `recordedAt` | Time | The time the measurement was recorded. | + +### `User` | Field | Type | Description | | ----- | ---- | ----------- | @@ -4061,6 +4572,7 @@ Autogenerated return type of UpdateSnippet. | `authoredMergeRequests` | MergeRequestConnection | Merge Requests authored by the user. | | `avatarUrl` | String | URL of the user's avatar. | | `bot` | Boolean! | Indicates if the user is a bot. | +| `callouts` | UserCalloutConnection | User callouts that belong to the user. | | `email` **{warning-solid}** | String | **Deprecated:** Use public_email. Deprecated in 13.7. | | `groupCount` | Int | Group count for the user. Available only when feature flag `user_group_counts` is enabled. | | `groupMemberships` | GroupMemberConnection | Group memberships of the user. | @@ -4080,13 +4592,30 @@ Autogenerated return type of UpdateSnippet. | `webPath` | String! | Web path of the user. | | `webUrl` | String! | Web URL of the user. | -### UserPermissions +### `UserCallout` + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `dismissedAt` | Time | Date when the callout was dismissed. | +| `featureName` | UserCalloutFeatureNameEnum! | Name of the feature that the callout is for. | + +### `UserCalloutCreatePayload` + +Autogenerated return type of UserCalloutCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `userCallout` | UserCallout! | The user callout dismissed. | + +### `UserPermissions` | Field | Type | Description | | ----- | ---- | ----------- | | `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource | -### UserStatus +### `UserStatus` | Field | Type | Description | | ----- | ---- | ----------- | @@ -4095,7 +4624,7 @@ Autogenerated return type of UpdateSnippet. | `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. This data is retained for 365 days. @@ -4110,7 +4639,7 @@ Represents the count of vulnerabilities by severity on a particular day. This da | `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. This data is retained for 365 days. @@ -4120,7 +4649,7 @@ Represents the number of vulnerabilities for a particular severity on a particul | `day` | ISO8601Date | Date for the count. | | `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities. | -### Vulnerability +### `Vulnerability` Represents a vulnerability. @@ -4144,7 +4673,7 @@ Represents a vulnerability. | `notes` | NoteConnection! | All notes on this noteable. | | `primaryIdentifier` | VulnerabilityIdentifier | Primary identifier of the vulnerability. | | `project` | Project | The project on which the vulnerability was found. | -| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING) | +| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING). `Scan Type` in the UI. | | `resolvedAt` | Time | Timestamp of when the vulnerability state was changed to resolved. | | `resolvedBy` | User | The user that resolved the vulnerability. | | `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not. | @@ -4156,7 +4685,7 @@ Represents a vulnerability. | `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource | | `vulnerabilityPath` | String | URL to the vulnerability's details page. | -### VulnerabilityConfirmPayload +### `VulnerabilityConfirmPayload` Autogenerated return type of VulnerabilityConfirm. @@ -4166,51 +4695,51 @@ Autogenerated return type of VulnerabilityConfirm. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `vulnerability` | Vulnerability | The vulnerability after state change. | -### VulnerabilityDetailBase +### `VulnerabilityDetailBase` Represents the vulnerability details base. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | -### VulnerabilityDetailBoolean +### `VulnerabilityDetailBoolean` Represents the vulnerability details boolean value. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | Boolean! | Value of the field. | -### VulnerabilityDetailCode +### `VulnerabilityDetailCode` Represents the vulnerability details code field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `lang` | String | Language of the code. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | String! | Source code. | -### VulnerabilityDetailCommit +### `VulnerabilityDetailCommit` Represents the vulnerability details commit field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | String! | The commit SHA value. | -### VulnerabilityDetailDiff +### `VulnerabilityDetailDiff` Represents the vulnerability details diff field. @@ -4218,104 +4747,104 @@ Represents the vulnerability details diff field. | ----- | ---- | ----------- | | `after` | String! | Value of the field after the change. | | `before` | String! | Value of the field before the change. | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | -### VulnerabilityDetailFileLocation +### `VulnerabilityDetailFileLocation` Represents the vulnerability details location within a file in the project. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `fileName` | String! | File name. | | `lineEnd` | Int! | End line number of the file location. | | `lineStart` | Int! | Start line number of the file location. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | -### VulnerabilityDetailInt +### `VulnerabilityDetailInt` Represents the vulnerability details integer value. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | Int! | Value of the field. | -### VulnerabilityDetailList +### `VulnerabilityDetailList` Represents the vulnerability details list value. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `items` | VulnerabilityDetail! => Array | List of details. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | -### VulnerabilityDetailMarkdown +### `VulnerabilityDetailMarkdown` Represents the vulnerability details Markdown field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | String! | Value of the Markdown field. | -### VulnerabilityDetailModuleLocation +### `VulnerabilityDetailModuleLocation` Represents the vulnerability details location within a file in the project. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `moduleName` | String! | Module name. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `offset` | Int! | Offset of the module location. | -### VulnerabilityDetailTable +### `VulnerabilityDetailTable` Represents the vulnerability details table value. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `headers` | VulnerabilityDetail! => Array | Table headers. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `rows` | VulnerabilityDetail! => Array | Table rows. | -### VulnerabilityDetailText +### `VulnerabilityDetailText` Represents the vulnerability details text field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `value` | String! | Value of the text field. | -### VulnerabilityDetailUrl +### `VulnerabilityDetailUrl` Represents the vulnerability details URL field. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | Description of the field. | +| `description` | String | Description of the field. | | `fieldName` | String | Name of the field. | | `href` | String! | Href of the URL. | -| `name` | String! | Name of the field. | +| `name` | String | Name of the field. | | `text` | String | Text of the URL. | -### VulnerabilityDismissPayload +### `VulnerabilityDismissPayload` Autogenerated return type of VulnerabilityDismiss. @@ -4325,7 +4854,7 @@ Autogenerated return type of VulnerabilityDismiss. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `vulnerability` | Vulnerability | The vulnerability after dismissal. | -### VulnerabilityExternalIssueLink +### `VulnerabilityExternalIssueLink` Represents an external issue link of a vulnerability. @@ -4335,7 +4864,7 @@ Represents an external issue link of a vulnerability. | `id` | VulnerabilitiesExternalIssueLinkID! | GraphQL ID of the external issue link. | | `linkType` | VulnerabilityExternalIssueLinkType! | Type of the external issue link. | -### VulnerabilityExternalIssueLinkCreatePayload +### `VulnerabilityExternalIssueLinkCreatePayload` Autogenerated return type of VulnerabilityExternalIssueLinkCreate. @@ -4345,7 +4874,7 @@ Autogenerated return type of VulnerabilityExternalIssueLinkCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `externalIssueLink` | VulnerabilityExternalIssueLink | The created external issue link. | -### VulnerabilityExternalIssueLinkDestroyPayload +### `VulnerabilityExternalIssueLinkDestroyPayload` Autogenerated return type of VulnerabilityExternalIssueLinkDestroy. @@ -4354,7 +4883,7 @@ Autogenerated return type of VulnerabilityExternalIssueLinkDestroy. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### VulnerabilityIdentifier +### `VulnerabilityIdentifier` Represents a vulnerability identifier. @@ -4365,7 +4894,7 @@ Represents a 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. @@ -4375,7 +4904,7 @@ Represents an issue link of a 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. @@ -4385,7 +4914,7 @@ Represents the location of a vulnerability found by a container security scan. | `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. @@ -4398,7 +4927,7 @@ Represents the location of a vulnerability found by a Coverage Fuzzing scan. | `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. @@ -4409,7 +4938,7 @@ Represents the location of a vulnerability found by a DAST scan. | `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. @@ -4419,7 +4948,7 @@ Represents the location of a vulnerability found by a dependency security scan. | `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. @@ -4432,7 +4961,7 @@ Represents the location of a vulnerability found by a SAST scan. | `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. @@ -4445,7 +4974,7 @@ Represents the location of a vulnerability found by a secret detection scan. | `vulnerableClass` | String | Class containing the vulnerability. | | `vulnerableMethod` | String | Method containing the vulnerability. | -### VulnerabilityPermissions +### `VulnerabilityPermissions` Check permissions for the current user on a vulnerability. @@ -4461,7 +4990,7 @@ 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 | -### VulnerabilityResolvePayload +### `VulnerabilityResolvePayload` Autogenerated return type of VulnerabilityResolve. @@ -4471,7 +5000,7 @@ Autogenerated return type of VulnerabilityResolve. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `vulnerability` | Vulnerability | The vulnerability after state change. | -### VulnerabilityRevertToDetectedPayload +### `VulnerabilityRevertToDetectedPayload` Autogenerated return type of VulnerabilityRevertToDetected. @@ -4481,7 +5010,7 @@ Autogenerated return type of VulnerabilityRevertToDetected. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `vulnerability` | Vulnerability | The vulnerability after revert. | -### VulnerabilityScanner +### `VulnerabilityScanner` Represents a vulnerability scanner. @@ -4492,7 +5021,7 @@ Represents a vulnerability scanner. | `reportType` | VulnerabilityReportType | Type of the vulnerability report. | | `vendor` | String | Vendor of the vulnerability scanner. | -### VulnerabilitySeveritiesCount +### `VulnerabilitySeveritiesCount` Represents vulnerability counts by severity. @@ -4505,7 +5034,7 @@ 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. @@ -4514,7 +5043,7 @@ Represents a vulnerable dependency. Used in vulnerability location data. | `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. @@ -4522,7 +5051,7 @@ Represents a vulnerable package. Used in vulnerability dependency data. | ----- | ---- | ----------- | | `name` | String | The name of the vulnerable package. | -### VulnerableProjectsByGrade +### `VulnerableProjectsByGrade` Represents vulnerability letter grades with associated projects. @@ -4541,67 +5070,68 @@ For more information, see [Enumeration Types](https://graphql.org/learn/schema/#enumeration-types) on `graphql.org`. -### AccessLevelEnum +### `AccessLevelEnum` Access level to a resource. | Value | Description | | ----- | ----------- | -| `DEVELOPER` | | -| `GUEST` | | -| `MAINTAINER` | | -| `NO_ACCESS` | | -| `OWNER` | | -| `REPORTER` | | +| `DEVELOPER` | Developer access | +| `GUEST` | Guest access | +| `MAINTAINER` | Maintainer access | +| `MINIMAL_ACCESS` | Minimal access | +| `NO_ACCESS` | No access | +| `OWNER` | Owner access | +| `REPORTER` | Reporter access | -### AlertManagementAlertSort +### `AlertManagementAlertSort` Values for sorting alerts. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `CREATED_TIME_ASC` | Created time by ascending order | -| `CREATED_TIME_DESC` | Created time by descending order | -| `ENDED_AT_ASC` | End time by ascending order | -| `ENDED_AT_DESC` | End time by descending order | -| `EVENT_COUNT_ASC` | Events count by ascending order | -| `EVENT_COUNT_DESC` | Events count by descending order | -| `SEVERITY_ASC` | Severity from less critical to more critical | -| `SEVERITY_DESC` | Severity from more critical to less critical | -| `STARTED_AT_ASC` | Start time by ascending order | -| `STARTED_AT_DESC` | Start time by descending order | -| `STATUS_ASC` | Status by order: Ignored > Resolved > Acknowledged > Triggered | -| `STATUS_DESC` | Status by order: Triggered > Acknowledged > Resolved > Ignored | -| `UPDATED_ASC` | Updated at ascending order | -| `UPDATED_DESC` | Updated at descending order | -| `UPDATED_TIME_ASC` | Created time by ascending order | -| `UPDATED_TIME_DESC` | Created time by descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `CREATED_TIME_ASC` | Created time by ascending order. | +| `CREATED_TIME_DESC` | Created time by descending order. | +| `ENDED_AT_ASC` | End time by ascending order. | +| `ENDED_AT_DESC` | End time by descending order. | +| `EVENT_COUNT_ASC` | Events count by ascending order. | +| `EVENT_COUNT_DESC` | Events count by descending order. | +| `SEVERITY_ASC` | Severity from less critical to more critical. | +| `SEVERITY_DESC` | Severity from more critical to less critical. | +| `STARTED_AT_ASC` | Start time by ascending order. | +| `STARTED_AT_DESC` | Start time by descending order. | +| `STATUS_ASC` | Status by order: Ignored > Resolved > Acknowledged > Triggered. | +| `STATUS_DESC` | Status by order: Triggered > Acknowledged > Resolved > Ignored. | +| `UPDATED_ASC` | Updated at ascending order. | +| `UPDATED_DESC` | Updated at descending order. | +| `UPDATED_TIME_ASC` | Created time by ascending order. | +| `UPDATED_TIME_DESC` | Created time by descending order. | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. | -### AlertManagementDomainFilter +### `AlertManagementDomainFilter` Filters the alerts based on given domain. | Value | Description | | ----- | ----------- | -| `operations` | Alerts for operations domain | -| `threat_monitoring` | Alerts for threat monitoring domain | +| `operations` | Alerts for operations domain. | +| `threat_monitoring` | Alerts for threat monitoring domain. | -### AlertManagementIntegrationType +### `AlertManagementIntegrationType` Values of types of integrations. | Value | Description | | ----- | ----------- | -| `HTTP` | Integration with any monitoring tool | -| `PROMETHEUS` | Prometheus integration | +| `HTTP` | Integration with any monitoring tool. | +| `PROMETHEUS` | Prometheus integration. | -### AlertManagementPayloadAlertFieldName +### `AlertManagementPayloadAlertFieldName` Values for alert field names used in the custom mapping. @@ -4618,17 +5148,17 @@ Values for alert field names used in the custom mapping. | `START_TIME` | The time of the incident. | | `TITLE` | The title of the incident. | -### AlertManagementPayloadAlertFieldType +### `AlertManagementPayloadAlertFieldType` Values for alert field types used in the custom mapping. | Value | Description | | ----- | ----------- | -| `ARRAY` | Array field type | -| `DATETIME` | DateTime field type | -| `STRING` | String field type | +| `ARRAY` | Array field type. | +| `DATETIME` | DateTime field type. | +| `STRING` | String field type. | -### AlertManagementSeverity +### `AlertManagementSeverity` Alert severity values. @@ -4641,7 +5171,7 @@ Alert severity values. | `MEDIUM` | Medium severity | | `UNKNOWN` | Unknown severity | -### AlertManagementStatus +### `AlertManagementStatus` Alert status values. @@ -4652,7 +5182,7 @@ Alert status values. | `RESOLVED` | Resolved status | | `TRIGGERED` | Triggered status | -### ApiFuzzingScanMode +### `ApiFuzzingScanMode` All possible ways to specify the API surface for an API fuzzing scan. @@ -4660,8 +5190,9 @@ All possible ways to specify the API surface for an API fuzzing scan. | ----- | ----------- | | `HAR` | The API surface is specified by a HAR file. | | `OPENAPI` | The API surface is specified by a OPENAPI file. | +| `POSTMAN` | The API surface is specified by a POSTMAN file. | -### AvailabilityEnum +### `AvailabilityEnum` User availability status. @@ -4670,45 +5201,45 @@ User availability status. | `BUSY` | Busy | | `NOT_SET` | Not Set | -### BlobViewersType +### `BlobViewersType` Types of blob viewers. | Value | Description | | ----- | ----------- | -| `auxiliary` | | -| `rich` | | -| `simple` | | +| `auxiliary` | Auxiliary blob viewers type. | +| `rich` | Rich blob viewers type. | +| `simple` | Simple blob viewers type. | -### CiConfigStatus +### `CiConfigStatus` Values for YAML processor result. | Value | Description | | ----- | ----------- | -| `INVALID` | The configuration file is not valid | -| `VALID` | The configuration file is valid | +| `INVALID` | The configuration file is not valid. | +| `VALID` | The configuration file is valid. | -### CommitActionMode +### `CommitActionMode` Mode of a commit action. | Value | Description | | ----- | ----------- | -| `CHMOD` | Chmod command | -| `CREATE` | Create command | -| `DELETE` | Delete command | -| `MOVE` | Move command | -| `UPDATE` | Update command | +| `CHMOD` | Chmod command. | +| `CREATE` | Create command. | +| `DELETE` | Delete command. | +| `MOVE` | Move command. | +| `UPDATE` | Update command. | -### CommitEncoding +### `CommitEncoding` | Value | Description | | ----- | ----------- | -| `BASE64` | Base64 encoding | -| `TEXT` | Text encoding | +| `BASE64` | Base64 encoding. | +| `TEXT` | Text encoding. | -### ContainerExpirationPolicyCadenceEnum +### `ContainerExpirationPolicyCadenceEnum` | Value | Description | | ----- | ----------- | @@ -4718,7 +5249,7 @@ Mode of a commit action. | `EVERY_TWO_WEEKS` | Every two weeks | | `EVERY_WEEK` | Every week | -### ContainerExpirationPolicyKeepEnum +### `ContainerExpirationPolicyKeepEnum` | Value | Description | | ----- | ----------- | @@ -4729,7 +5260,7 @@ Mode of a commit action. | `TEN_TAGS` | 10 tags per image name | | `TWENTY_FIVE_TAGS` | 25 tags per image name | -### ContainerExpirationPolicyOlderThanEnum +### `ContainerExpirationPolicyOlderThanEnum` | Value | Description | | ----- | ----------- | @@ -4738,7 +5269,7 @@ Mode of a commit action. | `SEVEN_DAYS` | 7 days until tags are automatically removed | | `THIRTY_DAYS` | 30 days until tags are automatically removed | -### ContainerRepositoryCleanupStatus +### `ContainerRepositoryCleanupStatus` Status of the tags cleanup of a container repository. @@ -4749,24 +5280,24 @@ Status of the tags cleanup of a container repository. | `UNFINISHED` | The tags cleanup has been partially executed. There are still remaining tags to delete. | | `UNSCHEDULED` | The tags cleanup is not scheduled. This is the default state. | -### ContainerRepositorySort +### `ContainerRepositorySort` Values for sorting container repositories. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `NAME_ASC` | Name by ascending order | -| `NAME_DESC` | Name by descending order | -| `UPDATED_ASC` | Updated at ascending order | -| `UPDATED_DESC` | Updated at descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `NAME_ASC` | Name by ascending order. | +| `NAME_DESC` | Name by descending order. | +| `UPDATED_ASC` | Updated at ascending order. | +| `UPDATED_DESC` | Updated at descending order. | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. | -### ContainerRepositoryStatus +### `ContainerRepositoryStatus` Status of a container repository. @@ -4775,31 +5306,31 @@ Status of a container repository. | `DELETE_FAILED` | Delete Failed status. | | `DELETE_SCHEDULED` | Delete Scheduled status. | -### DastScanTypeEnum +### `DastScanTypeEnum` | Value | Description | | ----- | ----------- | | `ACTIVE` | Active DAST scan. This scan will make active attacks against the target site. | | `PASSIVE` | Passive DAST scan. This scan will not make active attacks against the target site. | -### DastSiteProfileValidationStatusEnum +### `DastSiteProfileValidationStatusEnum` | Value | Description | | ----- | ----------- | -| `FAILED_VALIDATION` | Site validation process finished but failed | -| `INPROGRESS_VALIDATION` | Site validation process is in progress | -| `NONE` | No site validation exists | -| `PASSED_VALIDATION` | Site validation process finished successfully | -| `PENDING_VALIDATION` | Site validation process has not started | +| `FAILED_VALIDATION` | Site validation process finished but failed. | +| `INPROGRESS_VALIDATION` | Site validation process is in progress. | +| `NONE` | No site validation exists. | +| `PASSED_VALIDATION` | Site validation process finished successfully. | +| `PENDING_VALIDATION` | Site validation process has not started. | -### DastSiteValidationStrategyEnum +### `DastSiteValidationStrategyEnum` | Value | Description | | ----- | ----------- | -| `HEADER` | Header validation | -| `TEXT_FILE` | Text file validation | +| `HEADER` | Header validation. | +| `TEXT_FILE` | Text file validation. | -### DataVisualizationColorEnum +### `DataVisualizationColorEnum` Color of the data visualization palette. @@ -4811,7 +5342,7 @@ Color of the data visualization palette. | `MAGENTA` | Magenta color | | `ORANGE` | Orange color | -### DataVisualizationWeightEnum +### `DataVisualizationWeightEnum` Weight of the data visualization palette. @@ -4829,7 +5360,7 @@ Weight of the data visualization palette. | `WEIGHT_900` | 900 weight | | `WEIGHT_950` | 950 weight | -### DesignCollectionCopyState +### `DesignCollectionCopyState` Copy state of a DesignCollection. @@ -4839,7 +5370,7 @@ Copy state of a DesignCollection. | `IN_PROGRESS` | The DesignCollection is being copied | | `READY` | The DesignCollection has no copy in progress | -### DesignVersionEvent +### `DesignVersionEvent` Mutation event of a design within a version. @@ -4848,18 +5379,18 @@ Mutation event of a design within a version. | `CREATION` | A creation event | | `DELETION` | A deletion event | | `MODIFICATION` | A modification event | -| `NONE` | No change | +| `NONE` | No change. | -### DiffPositionType +### `DiffPositionType` Type of file the position refers to. | Value | Description | | ----- | ----------- | -| `image` | | -| `text` | | +| `image` | An image | +| `text` | A text file | -### EntryType +### `EntryType` Type of a tree entry. @@ -4869,18 +5400,18 @@ Type of a tree entry. | `commit` | | | `tree` | | -### EpicSort +### `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 | +| `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 +### `EpicState` State of an epic. @@ -4890,25 +5421,25 @@ State of an epic. | `closed` | | | `opened` | | -### EpicStateEvent +### `EpicStateEvent` State event of an epic. | Value | Description | | ----- | ----------- | -| `CLOSE` | Close the epic | -| `REOPEN` | Reopen the epic | +| `CLOSE` | Close the epic. | +| `REOPEN` | Reopen the epic. | -### EpicWildcardId +### `EpicWildcardId` Epic ID wildcard values. | Value | Description | | ----- | ----------- | -| `ANY` | Any epic is assigned | -| `NONE` | No epic is assigned | +| `ANY` | Any epic is assigned. | +| `NONE` | No epic is assigned. | -### EventAction +### `EventAction` Event action. @@ -4928,7 +5459,7 @@ Event action. | `REOPENED` | Reopened action | | `UPDATED` | Updated action | -### GroupMemberRelation +### `GroupMemberRelation` Group member relation. @@ -4938,7 +5469,7 @@ Group member relation. | `DIRECT` | Direct members | | `INHERITED` | Inherited members | -### HealthStatus +### `HealthStatus` Health status of an issue or epic. @@ -4948,7 +5479,7 @@ Health status of an issue or epic. | `needsAttention` | | | `onTrack` | | -### IssuableSeverity +### `IssuableSeverity` Incident severity. @@ -4960,70 +5491,70 @@ Incident severity. | `MEDIUM` | Medium severity | | `UNKNOWN` | Unknown severity | -### IssuableState +### `IssuableState` State of a GitLab issue or merge request. | Value | Description | | ----- | ----------- | -| `all` | | -| `closed` | | -| `locked` | | -| `opened` | | +| `all` | All available. | +| `closed` | In closed state. | +| `locked` | Discussion has been locked. | +| `opened` | In open state. | -### IssueSort +### `IssueSort` Values for sorting issues. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `DUE_DATE_ASC` | Due date by ascending order | -| `DUE_DATE_DESC` | Due date by descending order | -| `LABEL_PRIORITY_ASC` | Label priority by ascending order | -| `LABEL_PRIORITY_DESC` | Label priority by descending order | -| `MILESTONE_DUE_ASC` | Milestone due date by ascending order | -| `MILESTONE_DUE_DESC` | Milestone due date by descending order | -| `PRIORITY_ASC` | Priority by ascending order | -| `PRIORITY_DESC` | Priority by descending order | -| `PUBLISHED_ASC` | Published issues shown last | -| `PUBLISHED_DESC` | Published issues shown first | -| `RELATIVE_POSITION_ASC` | Relative position by ascending order | -| `SEVERITY_ASC` | Severity from less critical to more critical | -| `SEVERITY_DESC` | Severity from more critical to less critical | -| `SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first | -| `SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first | -| `UPDATED_ASC` | Updated at ascending order | -| `UPDATED_DESC` | Updated at descending order | -| `WEIGHT_ASC` | Weight by ascending order | -| `WEIGHT_DESC` | Weight by descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `DUE_DATE_ASC` | Due date by ascending order. | +| `DUE_DATE_DESC` | Due date by descending order. | +| `LABEL_PRIORITY_ASC` | Label priority by ascending order. | +| `LABEL_PRIORITY_DESC` | Label priority by descending order. | +| `MILESTONE_DUE_ASC` | Milestone due date by ascending order. | +| `MILESTONE_DUE_DESC` | Milestone due date by descending order. | +| `PRIORITY_ASC` | Priority by ascending order. | +| `PRIORITY_DESC` | Priority by descending order. | +| `PUBLISHED_ASC` | Published issues shown last. | +| `PUBLISHED_DESC` | Published issues shown first. | +| `RELATIVE_POSITION_ASC` | Relative position by ascending order. | +| `SEVERITY_ASC` | Severity from less critical to more critical. | +| `SEVERITY_DESC` | Severity from more critical to less critical. | +| `SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first. | +| `SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first. | +| `UPDATED_ASC` | Updated at ascending order. | +| `UPDATED_DESC` | Updated at descending order. | +| `WEIGHT_ASC` | Weight by ascending order. | +| `WEIGHT_DESC` | Weight by descending order. | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. | -### IssueState +### `IssueState` State of a GitLab issue. | Value | Description | | ----- | ----------- | -| `all` | | -| `closed` | | -| `locked` | | -| `opened` | | +| `all` | All available. | +| `closed` | In closed state. | +| `locked` | Discussion has been locked. | +| `opened` | In open state. | -### IssueStateEvent +### `IssueStateEvent` Values for issue state events. | Value | Description | | ----- | ----------- | -| `CLOSE` | Closes the issue | -| `REOPEN` | Reopens the issue | +| `CLOSE` | Closes the issue. | +| `REOPEN` | Reopens the issue. | -### IssueType +### `IssueType` Issue type. @@ -5033,7 +5564,7 @@ Issue type. | `ISSUE` | Issue issue type | | `TEST_CASE` | Test Case issue type | -### IterationState +### `IterationState` State of a GitLab iteration. @@ -5045,49 +5576,49 @@ State of a GitLab iteration. | `started` | | | `upcoming` | | -### IterationWildcardId +### `IterationWildcardId` Iteration ID wildcard values. | Value | Description | | ----- | ----------- | -| `ANY` | An iteration is assigned | -| `CURRENT` | Current iteration | -| `NONE` | No iteration is assigned | +| `ANY` | An iteration is assigned. | +| `CURRENT` | Current iteration. | +| `NONE` | No iteration is assigned. | -### JobArtifactFileType +### `JobArtifactFileType` | Value | Description | | ----- | ----------- | -| `ACCESSIBILITY` | | -| `API_FUZZING` | | -| `ARCHIVE` | | -| `BROWSER_PERFORMANCE` | | -| `CLUSTER_APPLICATIONS` | | -| `COBERTURA` | | -| `CODEQUALITY` | | -| `CONTAINER_SCANNING` | | -| `COVERAGE_FUZZING` | | -| `DAST` | | -| `DEPENDENCY_SCANNING` | | -| `DOTENV` | | -| `JUNIT` | | -| `LICENSE_MANAGEMENT` | | -| `LICENSE_SCANNING` | | -| `LOAD_PERFORMANCE` | | -| `LSIF` | | -| `METADATA` | | -| `METRICS` | | -| `METRICS_REFEREE` | | -| `NETWORK_REFEREE` | | -| `PERFORMANCE` | | -| `REQUIREMENTS` | | -| `SAST` | | -| `SECRET_DETECTION` | | -| `TERRAFORM` | | -| `TRACE` | | - -### ListLimitMetric +| `ACCESSIBILITY` | ACCESSIBILITY job artifact file type. | +| `API_FUZZING` | API FUZZING job artifact file type. | +| `ARCHIVE` | ARCHIVE job artifact file type. | +| `BROWSER_PERFORMANCE` | BROWSER PERFORMANCE job artifact file type. | +| `CLUSTER_APPLICATIONS` | CLUSTER APPLICATIONS job artifact file type. | +| `COBERTURA` | COBERTURA job artifact file type. | +| `CODEQUALITY` | CODE QUALITY job artifact file type. | +| `CONTAINER_SCANNING` | CONTAINER SCANNING job artifact file type. | +| `COVERAGE_FUZZING` | COVERAGE FUZZING job artifact file type. | +| `DAST` | DAST job artifact file type. | +| `DEPENDENCY_SCANNING` | DEPENDENCY SCANNING job artifact file type. | +| `DOTENV` | DOTENV job artifact file type. | +| `JUNIT` | JUNIT job artifact file type. | +| `LICENSE_MANAGEMENT` | LICENSE MANAGEMENT job artifact file type. | +| `LICENSE_SCANNING` | LICENSE SCANNING job artifact file type. | +| `LOAD_PERFORMANCE` | LOAD PERFORMANCE job artifact file type. | +| `LSIF` | LSIF job artifact file type. | +| `METADATA` | METADATA job artifact file type. | +| `METRICS` | METRICS job artifact file type. | +| `METRICS_REFEREE` | METRICS REFEREE job artifact file type. | +| `NETWORK_REFEREE` | NETWORK REFEREE job artifact file type. | +| `PERFORMANCE` | PERFORMANCE job artifact file type. | +| `REQUIREMENTS` | REQUIREMENTS job artifact file type. | +| `SAST` | SAST job artifact file type. | +| `SECRET_DETECTION` | SECRET DETECTION job artifact file type. | +| `TERRAFORM` | TERRAFORM job artifact file type. | +| `TRACE` | TRACE job artifact file type. | + +### `ListLimitMetric` List limit metric setting. @@ -5097,105 +5628,113 @@ List limit metric setting. | `issue_count` | | | `issue_weights` | | -### MeasurementIdentifier +### `MeasurementIdentifier` Possible identifier types for a measurement. | Value | Description | | ----- | ----------- | -| `GROUPS` | Group count | -| `ISSUES` | Issue count | -| `MERGE_REQUESTS` | Merge request count | -| `PIPELINES` | Pipeline count | -| `PIPELINES_CANCELED` | Pipeline count with canceled status | -| `PIPELINES_FAILED` | Pipeline count with failed status | -| `PIPELINES_SKIPPED` | Pipeline count with skipped status | -| `PIPELINES_SUCCEEDED` | Pipeline count with success status | -| `PROJECTS` | Project count | -| `USERS` | User count | +| `GROUPS` | Group count. | +| `ISSUES` | Issue count. | +| `MERGE_REQUESTS` | Merge request count. | +| `PIPELINES` | Pipeline count. | +| `PIPELINES_CANCELED` | Pipeline count with canceled status. | +| `PIPELINES_FAILED` | Pipeline count with failed status. | +| `PIPELINES_SKIPPED` | Pipeline count with skipped status. | +| `PIPELINES_SUCCEEDED` | Pipeline count with success status. | +| `PROJECTS` | Project count. | +| `USERS` | User count. | -### MergeRequestNewState +### `MergeRequestNewState` -New state to apply to a merge request.. +New state to apply to a merge request. | Value | Description | | ----- | ----------- | | `CLOSED` | Close the merge request if it is open. | | `OPEN` | Open the merge request if it is closed. | -### MergeRequestSort +### `MergeRequestSort` Values for sorting merge requests. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `LABEL_PRIORITY_ASC` | Label priority by ascending order | -| `LABEL_PRIORITY_DESC` | Label priority by descending order | -| `MERGED_AT_ASC` | Merge time by ascending order | -| `MERGED_AT_DESC` | Merge time by descending order | -| `MILESTONE_DUE_ASC` | Milestone due date by ascending order | -| `MILESTONE_DUE_DESC` | Milestone due date by descending order | -| `PRIORITY_ASC` | Priority by ascending order | -| `PRIORITY_DESC` | Priority by descending order | -| `UPDATED_ASC` | Updated at ascending order | -| `UPDATED_DESC` | Updated at descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `LABEL_PRIORITY_ASC` | Label priority by ascending order. | +| `LABEL_PRIORITY_DESC` | Label priority by descending order. | +| `MERGED_AT_ASC` | Merge time by ascending order. | +| `MERGED_AT_DESC` | Merge time by descending order. | +| `MILESTONE_DUE_ASC` | Milestone due date by ascending order. | +| `MILESTONE_DUE_DESC` | Milestone due date by descending order. | +| `PRIORITY_ASC` | Priority by ascending order. | +| `PRIORITY_DESC` | Priority by descending order. | +| `UPDATED_ASC` | Updated at ascending order. | +| `UPDATED_DESC` | Updated at descending order. | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. | -### MergeRequestState +### `MergeRequestState` State of a GitLab merge request. | Value | Description | | ----- | ----------- | -| `all` | | -| `closed` | | -| `locked` | | -| `merged` | Merge Request has been merged | -| `opened` | | +| `all` | All available. | +| `closed` | In closed state. | +| `locked` | Discussion has been locked. | +| `merged` | Merge Request has been merged. | +| `opened` | In open state. | + +### `MergeStrategyEnum` + +| Value | Description | +| ----- | ----------- | +| `ADD_TO_MERGE_TRAIN_WHEN_PIPELINE_SUCCEEDS` | Use the add_to_merge_train_when_pipeline_succeeds merge strategy. | +| `MERGE_TRAIN` | Use the merge_train merge strategy. | +| `MERGE_WHEN_PIPELINE_SUCCEEDS` | Use the merge_when_pipeline_succeeds merge strategy. | -### MilestoneStateEnum +### `MilestoneStateEnum` Current state of milestone. | Value | Description | | ----- | ----------- | -| `active` | Milestone is currently active | -| `closed` | Milestone is closed | +| `active` | Milestone is currently active. | +| `closed` | Milestone is closed. | -### MoveType +### `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 | +| `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 +### `MutationOperationMode` Different toggles for changing mutator behavior. | Value | Description | | ----- | ----------- | -| `APPEND` | Performs an append operation | -| `REMOVE` | Performs a removal operation | -| `REPLACE` | Performs a replace operation | +| `APPEND` | Performs an append operation. | +| `REMOVE` | Performs a removal operation. | +| `REPLACE` | Performs a replace operation. | -### NamespaceProjectSort +### `NamespaceProjectSort` Values for sorting projects. | Value | Description | | ----- | ----------- | -| `SIMILARITY` | Most similar to the search query | -| `STORAGE` | Sort by storage size | +| `SIMILARITY` | Most similar to the search query. | +| `STORAGE` | Sort by storage size. | -### OncallRotationUnitEnum +### `OncallRotationUnitEnum` Rotation length unit of an on-call rotation. @@ -5205,7 +5744,7 @@ Rotation length unit of an on-call rotation. | `HOURS` | Hours | | `WEEKS` | Weeks | -### PackageTypeEnum +### `PackageTypeEnum` | Value | Description | | ----- | ----------- | @@ -5220,7 +5759,7 @@ Rotation length unit of an on-call rotation. | `PYPI` | Packages from the PyPI package manager | | `RUBYGEMS` | Packages from the Rubygems package manager | -### PipelineConfigSourceEnum +### `PipelineConfigSourceEnum` | Value | Description | | ----- | ----------- | @@ -5234,7 +5773,7 @@ Rotation length unit of an on-call rotation. | `UNKNOWN_SOURCE` | | | `WEBIDE_SOURCE` | | -### PipelineStatusEnum +### `PipelineStatusEnum` | Value | Description | | ----- | ----------- | @@ -5250,7 +5789,7 @@ Rotation length unit of an on-call rotation. | `SUCCESS` | | | `WAITING_FOR_RESOURCE` | | -### ProjectMemberRelation +### `ProjectMemberRelation` Project member relation. @@ -5261,18 +5800,18 @@ Project member relation. | `INHERITED` | Inherited members | | `INVITED_GROUPS` | Invited Groups members | -### RegistryState +### `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 | +| `FAILED` | Registry that failed to sync. | +| `PENDING` | Registry waiting to be synced. | +| `STARTED` | Registry currently syncing. | +| `SYNCED` | Registry that is synced. | -### ReleaseAssetLinkType +### `ReleaseAssetLinkType` Type of the link: `other`, `runbook`, `image`, `package`. @@ -5283,18 +5822,18 @@ Type of the link: `other`, `runbook`, `image`, `package`. | `PACKAGE` | Package link type | | `RUNBOOK` | Runbook link type | -### ReleaseSort +### `ReleaseSort` Values for sorting releases. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `RELEASED_AT_ASC` | Released at by ascending order | -| `RELEASED_AT_DESC` | Released at by descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `RELEASED_AT_ASC` | Released at by ascending order. | +| `RELEASED_AT_DESC` | Released at by descending order. | -### RequirementState +### `RequirementState` State of a requirement. @@ -5303,17 +5842,27 @@ State of a requirement. | `ARCHIVED` | | | `OPENED` | | -### SastUiComponentSize +### `RequirementStatusFilter` + +Status of a requirement based on last test report. + +| Value | Description | +| ----- | ----------- | +| `FAILED` | | +| `MISSING` | Requirements without any test report. | +| `PASSED` | | + +### `SastUiComponentSize` Size of UI component in SAST configuration page. | Value | Description | | ----- | ----------- | -| `LARGE` | | -| `MEDIUM` | | -| `SMALL` | | +| `LARGE` | The size of UI component in SAST configuration page is large. | +| `MEDIUM` | The size of UI component in SAST configuration page is medium. | +| `SMALL` | The size of UI component in SAST configuration page is small. | -### SecurityReportTypeEnum +### `SecurityReportTypeEnum` | Value | Description | | ----- | ----------- | @@ -5325,7 +5874,7 @@ Size of UI component in SAST configuration page. | `SAST` | SAST scan report | | `SECRET_DETECTION` | SECRET DETECTION scan report | -### SecurityScannerType +### `SecurityScannerType` The type of the security scanner. @@ -5339,18 +5888,18 @@ The type of the security scanner. | `SAST` | | | `SECRET_DETECTION` | | -### SentryErrorStatus +### `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 | +| `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 +### `ServiceType` | Value | Description | | ----- | ----------- | @@ -5391,7 +5940,7 @@ State of a Sentry error. | `WEBEX_TEAMS_SERVICE` | WebexTeamsService type | | `YOUTRACK_SERVICE` | YoutrackService type | -### SnippetBlobActionEnum +### `SnippetBlobActionEnum` Type of a snippet blob input action. @@ -5402,22 +5951,22 @@ Type of a snippet blob input action. | `move` | | | `update` | | -### Sort +### `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 | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `UPDATED_ASC` | Updated at ascending order. | +| `UPDATED_DESC` | Updated at descending order. | | `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. | | `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. | | `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. | | `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. | -### TestReportState +### `TestReportState` State of a test report. @@ -5426,62 +5975,97 @@ State of a test report. | `FAILED` | | | `PASSED` | | -### TodoActionEnum +### `TodoActionEnum` | Value | Description | | ----- | ----------- | -| `approval_required` | | -| `assigned` | | -| `build_failed` | | -| `directly_addressed` | | -| `marked` | | -| `mentioned` | | -| `unmergeable` | | - -### TodoStateEnum +| `approval_required` | User was set as an approver. | +| `assigned` | User was assigned. | +| `build_failed` | Build triggered by the user failed. | +| `directly_addressed` | User was directly addressed. | +| `marked` | User added a TODO. | +| `mentioned` | User was mentioned. | +| `merge_train_removed` | Merge request authored by the user was removed from the merge train. | +| `review_requested` | Review was requested from the user. | +| `unmergeable` | Merge request authored by the user could not be merged. | + +### `TodoStateEnum` | Value | Description | | ----- | ----------- | -| `done` | | -| `pending` | | +| `done` | The state of the todo is done. | +| `pending` | The state of the todo is pending. | -### TodoTargetEnum +### `TodoTargetEnum` | Value | Description | | ----- | ----------- | -| `ALERT` | An Alert | -| `COMMIT` | A Commit | -| `DESIGN` | A Design | -| `EPIC` | An Epic | -| `ISSUE` | An Issue | -| `MERGEREQUEST` | A MergeRequest | +| `ALERT` | An Alert. | +| `COMMIT` | A Commit. | +| `DESIGN` | A Design. | +| `EPIC` | An Epic. | +| `ISSUE` | An Issue. | +| `MERGEREQUEST` | A MergeRequest. | -### TypeEnum +### `TypeEnum` | Value | Description | | ----- | ----------- | | `personal` | | | `project` | | -### UserState +### `UserCalloutFeatureNameEnum` + +Name of the feature that the callout is for. + +| Value | Description | +| ----- | ----------- | +| `ACCOUNT_RECOVERY_REGULAR_CHECK` | Callout feature name for account_recovery_regular_check. | +| `ACTIVE_USER_COUNT_THRESHOLD` | Callout feature name for active_user_count_threshold. | +| `ADMIN_INTEGRATIONS_MOVED` | Callout feature name for admin_integrations_moved. | +| `BUY_PIPELINE_MINUTES_NOTIFICATION_DOT` | Callout feature name for buy_pipeline_minutes_notification_dot. | +| `CANARY_DEPLOYMENT` | Callout feature name for canary_deployment. | +| `CLUSTER_SECURITY_WARNING` | Callout feature name for cluster_security_warning. | +| `CUSTOMIZE_HOMEPAGE` | Callout feature name for customize_homepage. | +| `EOA_BRONZE_PLAN_BANNER` | Callout feature name for eoa_bronze_plan_banner. | +| `FEATURE_FLAGS_NEW_VERSION` | Callout feature name for feature_flags_new_version. | +| `GCP_SIGNUP_OFFER` | Callout feature name for gcp_signup_offer. | +| `GEO_ENABLE_HASHED_STORAGE` | Callout feature name for geo_enable_hashed_storage. | +| `GEO_MIGRATE_HASHED_STORAGE` | Callout feature name for geo_migrate_hashed_storage. | +| `GKE_CLUSTER_INTEGRATION` | Callout feature name for gke_cluster_integration. | +| `GOLD_TRIAL_BILLINGS` | Callout feature name for gold_trial_billings. | +| `NEW_USER_SIGNUPS_CAP_REACHED` | Callout feature name for new_user_signups_cap_reached. | +| `PERSONAL_ACCESS_TOKEN_EXPIRY` | Callout feature name for personal_access_token_expiry. | +| `REGISTRATION_ENABLED_CALLOUT` | Callout feature name for registration_enabled_callout. | +| `SERVICE_TEMPLATES_DEPRECATED` | Callout feature name for service_templates_deprecated. | +| `SUGGEST_PIPELINE` | Callout feature name for suggest_pipeline. | +| `SUGGEST_POPOVER_DISMISSED` | Callout feature name for suggest_popover_dismissed. | +| `TABS_POSITION_HIGHLIGHT` | Callout feature name for tabs_position_highlight. | +| `THREAT_MONITORING_INFO` | Callout feature name for threat_monitoring_info. | +| `ULTIMATE_TRIAL` | Callout feature name for ultimate_trial. | +| `UNFINISHED_TAG_CLEANUP_CALLOUT` | Callout feature name for unfinished_tag_cleanup_callout. | +| `WEBHOOKS_MOVED` | Callout feature name for webhooks_moved. | +| `WEB_IDE_ALERT_DISMISSED` | Callout feature name for web_ide_alert_dismissed. | + +### `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 | +| `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 +### `VisibilityLevelsEnum` | Value | Description | | ----- | ----------- | -| `internal` | | -| `private` | | -| `public` | | +| `internal` | Internal visibility level. | +| `private` | Private visibility level. | +| `public` | Public visibility level. | -### VisibilityScopesEnum +### `VisibilityScopesEnum` | Value | Description | | ----- | ----------- | @@ -5489,7 +6073,7 @@ Possible states of a user. | `private` | | | `public` | | -### VulnerabilityDismissalReason +### `VulnerabilityDismissalReason` The dismissal reason of the Vulnerability. @@ -5501,7 +6085,7 @@ The dismissal reason of the Vulnerability. | `NOT_APPLICABLE` | Other reasons for dismissal | | `USED_IN_TESTS` | The Vulnerability is used in tests and does not pose an actual risk | -### VulnerabilityExternalIssueLinkExternalTracker +### `VulnerabilityExternalIssueLinkExternalTracker` The external tracker of the external issue link related to a vulnerability. @@ -5509,7 +6093,7 @@ The external tracker of the external issue link related to a vulnerability. | ----- | ----------- | | `JIRA` | Jira external tracker | -### VulnerabilityExternalIssueLinkType +### `VulnerabilityExternalIssueLinkType` The type of the external issue link related to a vulnerability. @@ -5517,7 +6101,7 @@ The type of the external issue link related to a vulnerability. | ----- | ----------- | | `CREATED` | Created link type | -### VulnerabilityGrade +### `VulnerabilityGrade` The grade of the vulnerable project. @@ -5529,7 +6113,7 @@ The grade of the vulnerable project. | `D` | | | `F` | | -### VulnerabilityIssueLinkType +### `VulnerabilityIssueLinkType` The type of the issue link related to a vulnerability. @@ -5538,7 +6122,7 @@ The type of the issue link related to a vulnerability. | `CREATED` | | | `RELATED` | | -### VulnerabilityReportType +### `VulnerabilityReportType` The type of the security scan that found the vulnerability. @@ -5552,7 +6136,7 @@ The type of the security scan that found the vulnerability. | `SAST` | | | `SECRET_DETECTION` | | -### VulnerabilitySeverity +### `VulnerabilitySeverity` The severity of the vulnerability. @@ -5565,24 +6149,24 @@ The severity of the vulnerability. | `MEDIUM` | | | `UNKNOWN` | | -### VulnerabilitySort +### `VulnerabilitySort` Vulnerability sort values. | Value | Description | | ----- | ----------- | -| `detected_asc` | Detection timestamp in ascending order | -| `detected_desc` | Detection timestamp in descending order | -| `report_type_asc` | Report Type in ascending order | -| `report_type_desc` | Report Type in descending order | -| `severity_asc` | Severity in ascending order | -| `severity_desc` | Severity in descending order | -| `state_asc` | State in ascending order | -| `state_desc` | State in descending order | -| `title_asc` | Title in ascending order | -| `title_desc` | Title in descending order | - -### VulnerabilityState +| `detected_asc` | Detection timestamp in ascending order. | +| `detected_desc` | Detection timestamp in descending order. | +| `report_type_asc` | Report Type in ascending order. | +| `report_type_desc` | Report Type in descending order. | +| `severity_asc` | Severity in ascending order. | +| `severity_desc` | Severity in descending order. | +| `state_asc` | State in ascending order. | +| `state_desc` | State in descending order. | +| `title_asc` | Title in ascending order. | +| `title_desc` | Title in descending order. | + +### `VulnerabilityState` The state of the vulnerability. |