diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-05 09:09:26 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-05 09:09:26 +0300 |
commit | 5092e9b37cf208ec604470afd4ebb62b1b58673e (patch) | |
tree | 63791ca37fcf888cadfcd24ce2708d745d5fcf44 /doc | |
parent | 4b4d338d32fa30c7dcbf0ed54e99c00a56d66ff3 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/geo/replication/datatypes.md | 2 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 953 | ||||
-rw-r--r-- | doc/api/projects.md | 4 | ||||
-rw-r--r-- | doc/ci/yaml/README.md | 57 | ||||
-rw-r--r-- | doc/development/export_csv.md | 2 | ||||
-rw-r--r-- | doc/subscriptions/bronze_starter.md | 2 | ||||
-rw-r--r-- | doc/user/admin_area/settings/visibility_and_access_controls.md | 2 | ||||
-rw-r--r-- | doc/user/application_security/vulnerability_report/index.md | 130 | ||||
-rw-r--r-- | doc/user/group/img/create_new_project_from_group_v13_6.png | bin | 40062 -> 0 bytes | |||
-rw-r--r-- | doc/user/group/img/group_file_template_dropdown.png | bin | 9516 -> 0 bytes | |||
-rw-r--r-- | doc/user/group/img/member_lock.png | bin | 3168 -> 0 bytes | |||
-rw-r--r-- | doc/user/group/img/select_group_dropdown.png | bin | 64359 -> 0 bytes | |||
-rw-r--r-- | doc/user/group/img/select_group_dropdown_13_10.png | bin | 0 -> 37009 bytes | |||
-rw-r--r-- | doc/user/group/img/share_with_group_lock.png | bin | 7493 -> 0 bytes | |||
-rw-r--r-- | doc/user/group/index.md | 387 | ||||
-rw-r--r-- | doc/user/project/settings/index.md | 2 | ||||
-rw-r--r-- | doc/user/project/working_with_projects.md | 2 |
17 files changed, 783 insertions, 760 deletions
diff --git a/doc/administration/geo/replication/datatypes.md b/doc/administration/geo/replication/datatypes.md index 74937b2c8c6..37633ee0f18 100644 --- a/doc/administration/geo/replication/datatypes.md +++ b/doc/administration/geo/replication/datatypes.md @@ -201,4 +201,4 @@ successfully, you must replicate their data using some other means. | [GitLab Pages](../../pages/index.md) | [No](https://gitlab.com/groups/gitlab-org/-/epics/589) | No | No | | | [CI Pipeline Artifacts](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/models/ci/pipeline_artifact.rb) | [No](https://gitlab.com/gitlab-org/gitlab/-/issues/238464) | No | Via Object Storage provider if supported. Native Geo support (Beta). | Persists additional artifacts after a pipeline completes | | [Dependency proxy images](../../../user/packages/dependency_proxy/index.md) | [No](https://gitlab.com/gitlab-org/gitlab/-/issues/259694) | No | No | Blocked on [Geo: Secondary Mimicry](https://gitlab.com/groups/gitlab-org/-/epics/1528). Note that replication of this cache is not needed for Disaster Recovery purposes because it can be recreated from external sources. | -| [Vulnerability Export](../../../user/application_security/vulnerability_report/#export-vulnerabilities) | [Not planned](https://gitlab.com/groups/gitlab-org/-/epics/3111) | No | Via Object Storage provider if supported. Native Geo support (Beta). | Not planned because they are ephemeral and sensitive. They can be regenerated on demand. | +| [Vulnerability Export](../../../user/application_security/vulnerability_report/#export-vulnerability-details) | [Not planned](https://gitlab.com/groups/gitlab-org/-/epics/3111) | No | Via Object Storage provider if supported. Native Geo support (Beta). | Not planned because they are ephemeral and sensitive. They can be regenerated on demand. | diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 2291a7be381..2ad097c7e43 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -30,11 +30,11 @@ in [Removed Items](../removed_items.md). The `Query` type contains the API's top-level entry points for all executable queries. -### ciApplicationSettings +### `ciApplicationSettings` CI related settings that apply to the entire instance. -### ciConfig +### `ciConfig` Get linted and processed contents of a CI config. Should not be requested more than once per request. @@ -46,7 +46,7 @@ Get linted and processed contents of a CI config. Should not be requested more t | `dryRun` | Boolean | Run pipeline creation simulation, or only do static check. | | `projectPath` | ID! | The project of the CI config. | -### containerRepository +### `containerRepository` Find a container repository. @@ -56,15 +56,15 @@ Find a container repository. | ---- | ---- | ----------- | | `id` | ContainerRepositoryID! | The global ID of the container repository. | -### currentUser +### `currentUser` Get information about current user. -### designManagement +### `designManagement` Fields related to design management. -### devopsAdoptionSegments +### `devopsAdoptionSegments` Get configured DevOps adoption segments on the instance. @@ -77,7 +77,7 @@ Get configured DevOps adoption segments on the instance. | `first` | Int | Returns the first _n_ elements from the list. | | `last` | Int | Returns the last _n_ elements from the list. | -### echo +### `echo` Text to echo back. @@ -87,7 +87,7 @@ Text to echo back. | ---- | ---- | ----------- | | `text` | String! | Text to echo back. | -### geoNode +### `geoNode` Find a Geo node. @@ -97,7 +97,7 @@ Find a Geo node. | ---- | ---- | ----------- | | `name` | String | The name of the Geo node. Defaults to the current Geo node name. | -### group +### `group` Find a group. @@ -107,11 +107,11 @@ Find a group. | ---- | ---- | ----------- | | `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | -### instanceSecurityDashboard +### `instanceSecurityDashboard` Fields related to Instance Security Dashboard. -### instanceStatisticsMeasurements +### `instanceStatisticsMeasurements` Get statistics on the instance. Deprecated in 13.10: This field was renamed. Use the `usageTrendsMeasurements` field instead. @@ -127,7 +127,7 @@ Get statistics on the instance. Deprecated in 13.10: This field was renamed. Use | `recordedAfter` | Time | Measurement recorded after this date. | | `recordedBefore` | Time | Measurement recorded before this date. | -### issue +### `issue` Find an Issue. @@ -137,7 +137,7 @@ Find an Issue. | ---- | ---- | ----------- | | `id` | IssueID! | The global ID of the Issue. | -### iteration +### `iteration` Find an iteration. @@ -147,11 +147,11 @@ Find an iteration. | ---- | ---- | ----------- | | `id` | IterationID! | Find an iteration by its ID. | -### metadata +### `metadata` Metadata about GitLab. -### milestone +### `milestone` Find a milestone. @@ -161,7 +161,7 @@ Find a milestone. | ---- | ---- | ----------- | | `id` | MilestoneID! | Find a milestone by its ID. | -### namespace +### `namespace` Find a namespace. @@ -171,7 +171,7 @@ Find a namespace. | ---- | ---- | ----------- | | `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | -### package +### `package` Find a package. @@ -181,7 +181,7 @@ Find a package. | ---- | ---- | ----------- | | `id` | PackagesPackageID! | The global ID of the package. | -### project +### `project` Find a project. @@ -191,7 +191,7 @@ Find a project. | ---- | ---- | ----------- | | `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | -### projects +### `projects` Find projects visible to the current user. @@ -209,7 +209,7 @@ Find projects visible to the current user. | `searchNamespaces` | Boolean | Include namespace in project search. | | `sort` | String | Sort order of results. | -### runnerPlatforms +### `runnerPlatforms` Supported runner platforms. @@ -222,7 +222,7 @@ Supported runner platforms. | `first` | Int | Returns the first _n_ elements from the list. | | `last` | Int | Returns the last _n_ elements from the list. | -### runnerSetup +### `runnerSetup` Get runner setup instructions. @@ -235,7 +235,7 @@ Get runner setup instructions. | `platform` | String! | Platform to generate the instructions for. | | `projectId` | ProjectID | Project to register the runner for. | -### snippets +### `snippets` Find Snippets visible to the current user. @@ -254,7 +254,7 @@ Find Snippets visible to the current user. | `type` | TypeEnum | The type of snippet. | | `visibility` | VisibilityScopesEnum | The visibility of the snippet. | -### usageTrendsMeasurements +### `usageTrendsMeasurements` Get statistics on the instance. @@ -270,7 +270,7 @@ Get statistics on the instance. | `recordedAfter` | Time | Measurement recorded after this date. | | `recordedBefore` | Time | Measurement recorded before this date. | -### user +### `user` Find a user. @@ -281,7 +281,7 @@ Find a user. | `id` | UserID | ID of the User. | | `username` | String | Username of the User. | -### users +### `users` Find users. @@ -299,7 +299,7 @@ Find users. | `sort` | Sort | Sort users by this criteria. | | `usernames` | String! => Array | List of usernames. | -### vulnerabilities +### `vulnerabilities` Vulnerabilities reported on projects on the current user's instance security dashboard. @@ -320,7 +320,7 @@ Vulnerabilities reported on projects on the current user's instance security das | `sort` | VulnerabilitySort | List vulnerabilities by sort order. | | `state` | VulnerabilityState! => Array | Filter vulnerabilities by state. | -### vulnerabilitiesCountByDay +### `vulnerabilitiesCountByDay` Number of vulnerabilities per day for the projects on the current user's instance security dashboard. @@ -335,7 +335,7 @@ Number of vulnerabilities per day for the projects on the current user's instanc | `last` | Int | Returns the last _n_ elements from the list. | | `startDate` | ISO8601Date! | First day for which to fetch vulnerability history. | -### vulnerabilitiesCountByDayAndSeverity +### `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`. @@ -350,7 +350,7 @@ Number of vulnerabilities per severity level, per day, for the projects on the c | `last` | Int | Returns the last _n_ elements from the list. | | `startDate` | ISO8601Date! | First day for which to fetch vulnerability history. | -### vulnerability +### `vulnerability` Find a vulnerability. @@ -371,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. @@ -380,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. @@ -390,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. @@ -400,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. @@ -410,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. @@ -442,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. @@ -455,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. @@ -472,7 +472,7 @@ An endpoint and credentials used to accept alerts for a project. | `type` | AlertManagementIntegrationType! | Type of integration. | | `url` | String | Endpoint which accepts alert notifications. | -### AlertManagementPayloadAlertField +### `AlertManagementPayloadAlertField` Parsed field from an alert used for custom mappings. @@ -482,7 +482,7 @@ Parsed field from an alert used for custom mappings. | `path` | String! => Array | Path to value inside payload JSON. | | `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. | -### AlertManagementPayloadAlertMappingField +### `AlertManagementPayloadAlertMappingField` Parsed field (with its name) from an alert used for custom mappings. @@ -493,7 +493,7 @@ Parsed field (with its name) from an alert used for custom mappings. | `path` | String! => Array | Path to value inside payload JSON. | | `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. | -### AlertManagementPrometheusIntegration +### `AlertManagementPrometheusIntegration` An endpoint and credentials used to accept Prometheus alerts for a project. @@ -507,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. @@ -519,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. @@ -531,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. @@ -540,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. @@ -551,7 +551,7 @@ 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. @@ -561,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. @@ -574,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. @@ -584,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. @@ -594,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. @@ -605,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 | | ----- | ---- | ----------- | @@ -627,7 +627,7 @@ 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 issue board. @@ -647,7 +647,7 @@ Represents a project or group issue board. | `webUrl` | String! | Web URL of the board. | | `weight` | Int | Weight of the board. | -### BoardEpic +### `BoardEpic` Represents an epic on an issue board. @@ -701,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. @@ -709,7 +709,7 @@ 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. @@ -731,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. @@ -741,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. @@ -751,14 +751,14 @@ 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. | -### BulkFindOrCreateDevopsAdoptionSegmentsPayload +### `BulkFindOrCreateDevopsAdoptionSegmentsPayload` Autogenerated return type of BulkFindOrCreateDevopsAdoptionSegments. @@ -768,7 +768,7 @@ Autogenerated return type of BulkFindOrCreateDevopsAdoptionSegments. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `segments` | DevopsAdoptionSegment! => Array | Created segments after mutation. | -### BurnupChartDailyTotals +### `BurnupChartDailyTotals` Represents the total number of issues and their weights for a particular day. @@ -780,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. @@ -801,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 | | ----- | ---- | ----------- | @@ -810,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 | | ----- | ---- | ----------- | @@ -818,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 | | ----- | ---- | ----------- | @@ -836,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 | | ----- | ---- | ----------- | @@ -864,7 +864,7 @@ Autogenerated return type of CiCdSettingsUpdate. | `name` | String | Name of the job group. | | `size` | Int | Size of the group. | -### CiJob +### `CiJob` | Field | Type | Description | | ----- | ---- | ----------- | @@ -877,14 +877,14 @@ Autogenerated return type of CiCdSettingsUpdate. | `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 | | ----- | ---- | ----------- | @@ -892,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 | | ----- | ---- | ----------- | @@ -905,7 +905,7 @@ Autogenerated return type of CiCdSettingsUpdate. | `updatedAt` | Time | Timestamp the cluster agent was updated. | | `webPath` | String | Web path of the cluster agent. | -### ClusterAgentDeletePayload +### `ClusterAgentDeletePayload` Autogenerated return type of ClusterAgentDelete. @@ -914,7 +914,7 @@ 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 | | ----- | ---- | ----------- | @@ -925,7 +925,7 @@ Autogenerated return type of ClusterAgentDelete. | `id` | ClustersAgentTokenID! | Global ID of the token. | | `name` | String | Name given to the token. | -### ClusterAgentTokenCreatePayload +### `ClusterAgentTokenCreatePayload` Autogenerated return type of ClusterAgentTokenCreate. @@ -936,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. @@ -945,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. @@ -956,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. @@ -966,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 | | ----- | ---- | ----------- | @@ -987,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. @@ -997,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. @@ -1009,7 +1009,7 @@ Represents a ComplianceFramework associated with a Project. | `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/hipaa` **(ULTIMATE)**. | -### ComposerMetadata +### `ComposerMetadata` Composer metadata. @@ -1018,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. @@ -1029,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. @@ -1045,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. @@ -1064,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. @@ -1084,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. @@ -1100,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. @@ -1112,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. @@ -1122,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. @@ -1132,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. @@ -1142,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. @@ -1152,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. @@ -1162,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. @@ -1172,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. @@ -1182,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. @@ -1192,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. @@ -1202,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. @@ -1212,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. @@ -1222,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. @@ -1232,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. @@ -1242,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. @@ -1252,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. @@ -1266,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. @@ -1276,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. @@ -1287,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. @@ -1297,7 +1297,7 @@ 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. @@ -1311,7 +1311,7 @@ Represents a DAST Profile. | `id` | DastProfileID! | ID of the profile. | | `name` | String | The name of the profile. | -### DastProfileBranch +### `DastProfileBranch` Represents a DAST Profile Branch. @@ -1320,7 +1320,7 @@ Represents a DAST Profile Branch. | `exists` | Boolean | Indicates whether or not the branch exists. | | `name` | String | The name of the branch. | -### DastProfileCreatePayload +### `DastProfileCreatePayload` Autogenerated return type of DastProfileCreate. @@ -1331,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. @@ -1340,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. @@ -1350,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. @@ -1361,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. @@ -1378,7 +1378,7 @@ Represents a DAST scanner profile. | `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. @@ -1389,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. @@ -1398,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. @@ -1408,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. @@ -1423,7 +1423,7 @@ Represents a DAST Site Profile. | `userPermissions` | DastSiteProfilePermissions! | Permissions for the current user on the resource | | `validationStatus` | DastSiteProfileValidationStatusEnum | The current validation status of the site profile. | -### DastSiteProfileCreatePayload +### `DastSiteProfileCreatePayload` Autogenerated return type of DastSiteProfileCreate. @@ -1433,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. @@ -1442,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. @@ -1450,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. @@ -1460,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. @@ -1472,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. @@ -1482,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. @@ -1493,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. @@ -1502,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. @@ -1511,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. @@ -1520,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. @@ -1530,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. @@ -1551,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. @@ -1570,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. @@ -1585,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. @@ -1602,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. @@ -1612,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. @@ -1623,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. @@ -1635,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. @@ -1645,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. @@ -1655,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. @@ -1664,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. @@ -1674,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. @@ -1684,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. @@ -1694,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. @@ -1704,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 | | ----- | ---- | ----------- | @@ -1718,7 +1718,7 @@ Autogenerated return type of DestroySnippet. | `text` | String | Text of the status. | | `tooltip` | String | Tooltip associated with the status. | -### DevopsAdoptionSegment +### `DevopsAdoptionSegment` Segment. @@ -1728,7 +1728,7 @@ Segment. | `latestSnapshot` | DevopsAdoptionSnapshot | The latest adoption metrics for the segment. | | `namespace` | Namespace | Segment namespace. | -### DevopsAdoptionSnapshot +### `DevopsAdoptionSnapshot` Snapshot. @@ -1745,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 | | ----- | ---- | ----------- | @@ -1761,7 +1761,7 @@ Snapshot. | `x` | Int | X position of the note. | | `y` | Int | Y position of the note. | -### DiffRefs +### `DiffRefs` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1769,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. @@ -1779,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. @@ -1790,7 +1790,7 @@ Aggregated summary of changes. | `deletions` | Int! | Number of lines deleted. | | `fileCount` | Int! | Number of files changed. | -### Discussion +### `Discussion` | Field | Type | Description | | ----- | ---- | ----------- | @@ -1803,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. @@ -1813,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. @@ -1823,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. @@ -1836,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. @@ -1845,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. @@ -1898,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. @@ -1909,7 +1909,7 @@ 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. @@ -1924,7 +1924,7 @@ Represents an 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. @@ -1934,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. @@ -1944,7 +1944,7 @@ Autogenerated return type of EpicBoardListCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `list` | EpicList | Epic list in the epic board. | -### EpicBoardUpdatePayload +### `EpicBoardUpdatePayload` Autogenerated return type of EpicBoardUpdate. @@ -1954,7 +1954,7 @@ Autogenerated return type of EpicBoardUpdate. | `epicBoard` | EpicBoard | The updated epic board. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### EpicDescendantCount +### `EpicDescendantCount` Counts of descendent epics. @@ -1965,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. @@ -1974,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. @@ -1984,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. @@ -2048,7 +2048,7 @@ 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. @@ -2063,7 +2063,7 @@ Represents an epic board list. | `position` | Int | Position of the list within the board. | | `title` | String! | Title of the list. | -### EpicPermissions +### `EpicPermissions` Check permissions for the current user on an epic. @@ -2078,7 +2078,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. @@ -2088,7 +2088,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. @@ -2097,7 +2097,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. @@ -2109,7 +2109,7 @@ Representing an event. | `id` | ID! | ID of the event. | | `updatedAt` | Time! | When this event was updated. | -### ExportRequirementsPayload +### `ExportRequirementsPayload` Autogenerated return type of ExportRequirements. @@ -2118,7 +2118,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. @@ -2132,7 +2132,7 @@ 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 | | ----- | ---- | ----------- | @@ -2156,7 +2156,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. @@ -2165,7 +2165,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 | | ----- | ---- | ----------- | @@ -2175,7 +2175,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 | | ----- | ---- | ----------- | @@ -2242,7 +2242,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. @@ -2258,13 +2258,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. @@ -2273,7 +2273,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. @@ -2281,7 +2281,7 @@ Contains statistics about a group. | ----- | ---- | ----------- | | `releaseStats` | GroupReleaseStats | Statistics related to releases within the group. | -### HttpIntegrationCreatePayload +### `HttpIntegrationCreatePayload` Autogenerated return type of HttpIntegrationCreate. @@ -2291,7 +2291,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. @@ -2301,7 +2301,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. @@ -2311,7 +2311,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. @@ -2321,7 +2321,7 @@ 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. @@ -2337,7 +2337,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. @@ -2349,7 +2349,7 @@ 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. @@ -2359,7 +2359,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 | | ----- | ---- | ----------- | @@ -2368,7 +2368,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. | -### Issue +### `Issue` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2428,7 +2428,7 @@ A block of time for which a participant is on-call. | `webUrl` | String! | Web URL of the issue. | | `weight` | Int | Weight of the issue. | -### IssueMoveListPayload +### `IssueMoveListPayload` Autogenerated return type of IssueMoveList. @@ -2438,7 +2438,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. @@ -2448,7 +2448,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. @@ -2463,7 +2463,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. @@ -2473,7 +2473,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. @@ -2483,7 +2483,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. @@ -2493,7 +2493,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. @@ -2503,7 +2503,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. @@ -2513,7 +2513,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. @@ -2523,7 +2523,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. @@ -2533,7 +2533,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. @@ -2543,7 +2543,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. @@ -2553,7 +2553,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. @@ -2563,7 +2563,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. @@ -2585,7 +2585,7 @@ Represents an iteration object. | `webPath` | String! | Web path of the iteration. | | `webUrl` | String! | Web URL of the iteration. | -### JiraImport +### `JiraImport` | Field | Type | Description | | ----- | ---- | ----------- | @@ -2597,7 +2597,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. @@ -2607,7 +2607,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. @@ -2617,7 +2617,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 | | ----- | ---- | ----------- | @@ -2625,7 +2625,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 | | ----- | ---- | ----------- | @@ -2633,7 +2633,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 | | ----- | ---- | ----------- | @@ -2644,7 +2644,7 @@ 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 | | ----- | ---- | ----------- | @@ -2657,7 +2657,7 @@ Autogenerated return type of JiraImportUsers. | `title` | String! | Content of the label. | | `updatedAt` | Time! | When this label was last updated. | -### LabelCreatePayload +### `LabelCreatePayload` Autogenerated return type of LabelCreate. @@ -2667,7 +2667,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. @@ -2677,7 +2677,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 | | ----- | ---- | ----------- | @@ -2767,7 +2767,7 @@ Autogenerated return type of MarkAsSpamSnippet. | `webUrl` | String | Web URL of the merge request. | | `workInProgress` | Boolean! | Indicates if the merge request is a draft. | -### MergeRequestCreatePayload +### `MergeRequestCreatePayload` Autogenerated return type of MergeRequestCreate. @@ -2777,7 +2777,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. @@ -2792,7 +2792,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. @@ -2808,7 +2808,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. @@ -2818,7 +2818,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. @@ -2828,7 +2828,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. @@ -2838,7 +2838,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. @@ -2848,7 +2848,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. @@ -2858,7 +2858,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. @@ -2868,7 +2868,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. @@ -2878,7 +2878,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. @@ -2888,14 +2888,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. @@ -2907,7 +2907,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 | | ----- | ---- | ----------- | @@ -2915,7 +2915,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 | | ----- | ---- | ----------- | @@ -2925,7 +2925,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. @@ -2946,7 +2946,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. @@ -2955,7 +2955,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 | | ----- | ---- | ----------- | @@ -2983,7 +2983,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. @@ -2993,7 +2993,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 | | ----- | ---- | ----------- | @@ -3016,7 +3016,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 | | ----- | ---- | ----------- | @@ -3027,7 +3027,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. @@ -3038,7 +3038,7 @@ The rotation participant and color palette. | `id` | IncidentManagementOncallParticipantID! | ID of the on-call participant. | | `user` | User! | The user who is participating. | -### OncallRotationActivePeriodType +### `OncallRotationActivePeriodType` Active period time range for on-call rotation. @@ -3047,7 +3047,7 @@ Active period time range for on-call rotation. | `endTime` | String | The end of the rotation active period. | | `startTime` | String | The start of the rotation active period. | -### OncallRotationCreatePayload +### `OncallRotationCreatePayload` Autogenerated return type of OncallRotationCreate. @@ -3057,7 +3057,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. @@ -3067,7 +3067,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. @@ -3077,7 +3077,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. @@ -3087,7 +3087,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. @@ -3097,7 +3097,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. @@ -3115,7 +3115,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. @@ -3126,7 +3126,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. @@ -3141,7 +3141,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. @@ -3150,7 +3150,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. @@ -3161,7 +3161,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. @@ -3178,7 +3178,7 @@ 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. @@ -3189,13 +3189,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. | @@ -3223,7 +3224,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 | | ----- | ---- | ----------- | @@ -3239,7 +3240,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. @@ -3248,7 +3249,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. @@ -3257,7 +3258,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 | | ----- | ---- | ----------- | @@ -3265,7 +3266,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. @@ -3275,7 +3276,7 @@ Autogenerated return type of PipelineRetry. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipeline` | Pipeline | The pipeline after mutation. | -### PipelineSecurityReportFinding +### `PipelineSecurityReportFinding` Represents vulnerability finding of a security report on the pipeline. @@ -3294,7 +3295,7 @@ Represents vulnerability finding of a security report on the pipeline. | `solution` | String | URL to the vulnerability's details page. | | `uuid` | String | Name of the vulnerability finding. | -### Project +### `Project` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3407,7 +3408,7 @@ Represents vulnerability finding of a security report on the pipeline. | `webUrl` | String | Web URL of the project. | | `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user | -### ProjectCiCdSetting +### `ProjectCiCdSetting` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3416,7 +3417,7 @@ Represents vulnerability finding of a security report on the pipeline. | `mergeTrainsEnabled` | Boolean | Whether merge trains are enabled. | | `project` | Project | Project the CI/CD settings belong to. | -### ProjectMember +### `ProjectMember` Represents a Project Membership. @@ -3432,7 +3433,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 | | ----- | ---- | ----------- | @@ -3479,7 +3480,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 | | ----- | ---- | ----------- | @@ -3493,7 +3494,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. @@ -3502,7 +3503,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. @@ -3512,7 +3513,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. @@ -3522,7 +3523,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. @@ -3532,7 +3533,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. @@ -3543,7 +3544,7 @@ Autogenerated return type of PromoteToEpic. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation. | -### Release +### `Release` Represents a release. @@ -3564,7 +3565,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. @@ -3577,7 +3578,7 @@ Represents an asset link associated with a release. | `name` | String | Name of the link. | | `url` | String | URL of the link. | -### ReleaseAssetLinkCreatePayload +### `ReleaseAssetLinkCreatePayload` Autogenerated return type of ReleaseAssetLinkCreate. @@ -3587,7 +3588,7 @@ Autogenerated return type of ReleaseAssetLinkCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `link` | ReleaseAssetLink | The asset link after mutation. | -### ReleaseAssets +### `ReleaseAssets` A container for all assets associated with a release. @@ -3597,7 +3598,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. @@ -3607,7 +3608,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. @@ -3617,7 +3618,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. @@ -3628,7 +3629,7 @@ Evidence for a release. | `id` | ID! | ID of the evidence. | | `sha` | String | SHA1 ID of the evidence hash. | -### ReleaseLinks +### `ReleaseLinks` | Field | Type | Description | | ----- | ---- | ----------- | @@ -3640,7 +3641,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. @@ -3649,7 +3650,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. @@ -3659,7 +3660,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. @@ -3669,7 +3670,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. @@ -3678,7 +3679,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. @@ -3688,7 +3689,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 | | ----- | ---- | ----------- | @@ -3697,7 +3698,7 @@ Autogenerated return type of RepositionImageDiffNote. | `rootRef` | String | Default branch of the repository. | | `tree` | Tree | Tree of the repository. | -### Requirement +### `Requirement` Represents a requirement. @@ -3719,7 +3720,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. @@ -3731,7 +3732,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. @@ -3740,7 +3741,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. @@ -3750,7 +3751,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 | | ----- | ---- | ----------- | @@ -3764,7 +3765,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. @@ -3774,14 +3775,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 | | ----- | ---- | ----------- | @@ -3789,14 +3790,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. @@ -3806,7 +3807,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. @@ -3818,7 +3819,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. @@ -3833,7 +3834,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. @@ -3842,7 +3843,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. @@ -3851,7 +3852,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. @@ -3865,7 +3866,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. @@ -3876,7 +3877,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. @@ -3886,7 +3887,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. @@ -3921,7 +3922,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. @@ -3945,7 +3946,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. @@ -3956,14 +3957,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. @@ -3973,7 +3974,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. @@ -3982,7 +3983,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. @@ -3994,7 +3995,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. @@ -4003,7 +4004,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. @@ -4029,7 +4030,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. @@ -4048,7 +4049,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. @@ -4062,7 +4063,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 | | ----- | ---- | ----------- | @@ -4073,7 +4074,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. @@ -4088,7 +4089,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 | | ----- | ---- | ----------- | @@ -4098,7 +4099,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 | | ----- | ---- | ----------- | @@ -4111,7 +4112,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. @@ -4120,7 +4121,7 @@ Completion status of tasks. | `completedCount` | Int! | Number of completed tasks. | | `count` | Int! | Number of total tasks. | -### TerraformState +### `TerraformState` | Field | Type | Description | | ----- | ---- | ----------- | @@ -4132,7 +4133,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. @@ -4141,7 +4142,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. @@ -4150,7 +4151,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. @@ -4159,7 +4160,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 | | ----- | ---- | ----------- | @@ -4171,7 +4172,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. @@ -4186,7 +4187,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. @@ -4197,7 +4198,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. @@ -4207,7 +4208,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. @@ -4216,7 +4217,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. @@ -4225,7 +4226,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 | | ----- | ---- | ----------- | @@ -4235,7 +4236,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. @@ -4251,7 +4252,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. @@ -4261,7 +4262,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. @@ -4271,7 +4272,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. @@ -4282,7 +4283,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. @@ -4292,7 +4293,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. @@ -4303,7 +4304,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. @@ -4314,7 +4315,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 | | ----- | ---- | ----------- | @@ -4323,7 +4324,7 @@ Autogenerated return type of ToggleAwardEmoji. | `submodules` | SubmoduleConnection! | Sub-modules of the tree. | | `trees` | TreeEntryConnection! | Trees of the tree. | -### TreeEntry +### `TreeEntry` Represents a directory. @@ -4338,7 +4339,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. @@ -4350,7 +4351,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. @@ -4360,7 +4361,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. @@ -4370,7 +4371,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. @@ -4380,7 +4381,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. @@ -4390,7 +4391,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. @@ -4400,7 +4401,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. @@ -4410,7 +4411,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. @@ -4420,7 +4421,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. @@ -4430,7 +4431,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. @@ -4440,7 +4441,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. @@ -4450,7 +4451,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. @@ -4460,7 +4461,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. @@ -4470,7 +4471,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. @@ -4484,7 +4485,7 @@ Autogenerated return type of UpdateSnippet. | `spam` | Boolean | Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response. | | `spamLogId` | Int | The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | -### UsageTrendsMeasurement +### `UsageTrendsMeasurement` Represents a recorded measurement (object count) for the Admins. @@ -4494,7 +4495,7 @@ Represents a recorded measurement (object count) for the Admins. | `identifier` | MeasurementIdentifier! | The type of objects being measured. | | `recordedAt` | Time | The time the measurement was recorded. | -### User +### `User` | Field | Type | Description | | ----- | ---- | ----------- | @@ -4521,13 +4522,13 @@ Represents a recorded measurement (object count) for the Admins. | `webPath` | String! | Web path of the user. | | `webUrl` | String! | Web URL of the user. | -### UserPermissions +### `UserPermissions` | Field | Type | Description | | ----- | ---- | ----------- | | `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource | -### UserStatus +### `UserStatus` | Field | Type | Description | | ----- | ---- | ----------- | @@ -4536,7 +4537,7 @@ Represents a recorded measurement (object count) for the Admins. | `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. @@ -4551,7 +4552,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. @@ -4561,7 +4562,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. @@ -4597,7 +4598,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. @@ -4607,7 +4608,7 @@ 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. @@ -4617,7 +4618,7 @@ Represents the vulnerability details base. | `fieldName` | String | Name of the field. | | `name` | String | Name of the field. | -### VulnerabilityDetailBoolean +### `VulnerabilityDetailBoolean` Represents the vulnerability details boolean value. @@ -4628,7 +4629,7 @@ Represents the vulnerability details boolean value. | `name` | String | Name of the field. | | `value` | Boolean! | Value of the field. | -### VulnerabilityDetailCode +### `VulnerabilityDetailCode` Represents the vulnerability details code field. @@ -4640,7 +4641,7 @@ Represents the vulnerability details code field. | `name` | String | Name of the field. | | `value` | String! | Source code. | -### VulnerabilityDetailCommit +### `VulnerabilityDetailCommit` Represents the vulnerability details commit field. @@ -4651,7 +4652,7 @@ Represents the vulnerability details commit field. | `name` | String | Name of the field. | | `value` | String! | The commit SHA value. | -### VulnerabilityDetailDiff +### `VulnerabilityDetailDiff` Represents the vulnerability details diff field. @@ -4663,7 +4664,7 @@ Represents the vulnerability details diff field. | `fieldName` | String | Name of the field. | | `name` | String | Name of the field. | -### VulnerabilityDetailFileLocation +### `VulnerabilityDetailFileLocation` Represents the vulnerability details location within a file in the project. @@ -4676,7 +4677,7 @@ Represents the vulnerability details location within a file in the project. | `lineStart` | Int! | Start line number of the file location. | | `name` | String | Name of the field. | -### VulnerabilityDetailInt +### `VulnerabilityDetailInt` Represents the vulnerability details integer value. @@ -4687,7 +4688,7 @@ Represents the vulnerability details integer value. | `name` | String | Name of the field. | | `value` | Int! | Value of the field. | -### VulnerabilityDetailList +### `VulnerabilityDetailList` Represents the vulnerability details list value. @@ -4698,7 +4699,7 @@ Represents the vulnerability details list value. | `items` | VulnerabilityDetail! => Array | List of details. | | `name` | String | Name of the field. | -### VulnerabilityDetailMarkdown +### `VulnerabilityDetailMarkdown` Represents the vulnerability details Markdown field. @@ -4709,7 +4710,7 @@ Represents the vulnerability details Markdown 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. @@ -4721,7 +4722,7 @@ Represents the vulnerability details location within a file in the project. | `name` | String | Name of the field. | | `offset` | Int! | Offset of the module location. | -### VulnerabilityDetailTable +### `VulnerabilityDetailTable` Represents the vulnerability details table value. @@ -4733,7 +4734,7 @@ Represents the vulnerability details table value. | `name` | String | Name of the field. | | `rows` | VulnerabilityDetail! => Array | Table rows. | -### VulnerabilityDetailText +### `VulnerabilityDetailText` Represents the vulnerability details text field. @@ -4744,7 +4745,7 @@ Represents the vulnerability details text field. | `name` | String | Name of the field. | | `value` | String! | Value of the text field. | -### VulnerabilityDetailUrl +### `VulnerabilityDetailUrl` Represents the vulnerability details URL field. @@ -4756,7 +4757,7 @@ Represents the vulnerability details URL field. | `name` | String | Name of the field. | | `text` | String | Text of the URL. | -### VulnerabilityDismissPayload +### `VulnerabilityDismissPayload` Autogenerated return type of VulnerabilityDismiss. @@ -4766,7 +4767,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. @@ -4776,7 +4777,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. @@ -4786,7 +4787,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. @@ -4795,7 +4796,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. @@ -4806,7 +4807,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. @@ -4816,7 +4817,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. @@ -4826,7 +4827,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. @@ -4839,7 +4840,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. @@ -4850,7 +4851,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. @@ -4860,7 +4861,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. @@ -4873,7 +4874,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. @@ -4886,7 +4887,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. @@ -4902,7 +4903,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. @@ -4912,7 +4913,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. @@ -4922,7 +4923,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. @@ -4933,7 +4934,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. @@ -4946,7 +4947,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. @@ -4955,7 +4956,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. @@ -4963,7 +4964,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. @@ -4982,7 +4983,7 @@ For more information, see [Enumeration Types](https://graphql.org/learn/schema/#enumeration-types) on `graphql.org`. -### AccessLevelEnum +### `AccessLevelEnum` Access level to a resource. @@ -4996,7 +4997,7 @@ Access level to a resource. | `OWNER` | Owner access | | `REPORTER` | Reporter access | -### AlertManagementAlertSort +### `AlertManagementAlertSort` Values for sorting alerts. @@ -5025,7 +5026,7 @@ Values for sorting alerts. | `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. @@ -5034,7 +5035,7 @@ Filters the alerts based on given domain. | `operations` | Alerts for operations domain. | | `threat_monitoring` | Alerts for threat monitoring domain. | -### AlertManagementIntegrationType +### `AlertManagementIntegrationType` Values of types of integrations. @@ -5043,7 +5044,7 @@ Values of types of integrations. | `HTTP` | Integration with any monitoring tool. | | `PROMETHEUS` | Prometheus integration. | -### AlertManagementPayloadAlertFieldName +### `AlertManagementPayloadAlertFieldName` Values for alert field names used in the custom mapping. @@ -5060,7 +5061,7 @@ 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. @@ -5070,7 +5071,7 @@ Values for alert field types used in the custom mapping. | `DATETIME` | DateTime field type. | | `STRING` | String field type. | -### AlertManagementSeverity +### `AlertManagementSeverity` Alert severity values. @@ -5083,7 +5084,7 @@ Alert severity values. | `MEDIUM` | Medium severity | | `UNKNOWN` | Unknown severity | -### AlertManagementStatus +### `AlertManagementStatus` Alert status values. @@ -5094,7 +5095,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. @@ -5103,7 +5104,7 @@ 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. | -### AvailabilityEnum +### `AvailabilityEnum` User availability status. @@ -5112,7 +5113,7 @@ User availability status. | `BUSY` | Busy | | `NOT_SET` | Not Set | -### BlobViewersType +### `BlobViewersType` Types of blob viewers. @@ -5122,7 +5123,7 @@ Types of blob viewers. | `rich` | Rich blob viewers type. | | `simple` | Simple blob viewers type. | -### CiConfigStatus +### `CiConfigStatus` Values for YAML processor result. @@ -5131,7 +5132,7 @@ Values for YAML processor result. | `INVALID` | The configuration file is not valid. | | `VALID` | The configuration file is valid. | -### CommitActionMode +### `CommitActionMode` Mode of a commit action. @@ -5143,14 +5144,14 @@ Mode of a commit action. | `MOVE` | Move command. | | `UPDATE` | Update command. | -### CommitEncoding +### `CommitEncoding` | Value | Description | | ----- | ----------- | | `BASE64` | Base64 encoding. | | `TEXT` | Text encoding. | -### ContainerExpirationPolicyCadenceEnum +### `ContainerExpirationPolicyCadenceEnum` | Value | Description | | ----- | ----------- | @@ -5160,7 +5161,7 @@ Mode of a commit action. | `EVERY_TWO_WEEKS` | Every two weeks | | `EVERY_WEEK` | Every week | -### ContainerExpirationPolicyKeepEnum +### `ContainerExpirationPolicyKeepEnum` | Value | Description | | ----- | ----------- | @@ -5171,7 +5172,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 | | ----- | ----------- | @@ -5180,7 +5181,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. @@ -5191,7 +5192,7 @@ 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. @@ -5208,7 +5209,7 @@ Values for sorting container repositories. | `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. @@ -5217,14 +5218,14 @@ 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 | | ----- | ----------- | @@ -5234,14 +5235,14 @@ Status of a container repository. | `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. | -### DataVisualizationColorEnum +### `DataVisualizationColorEnum` Color of the data visualization palette. @@ -5253,7 +5254,7 @@ Color of the data visualization palette. | `MAGENTA` | Magenta color | | `ORANGE` | Orange color | -### DataVisualizationWeightEnum +### `DataVisualizationWeightEnum` Weight of the data visualization palette. @@ -5271,7 +5272,7 @@ Weight of the data visualization palette. | `WEIGHT_900` | 900 weight | | `WEIGHT_950` | 950 weight | -### DesignCollectionCopyState +### `DesignCollectionCopyState` Copy state of a DesignCollection. @@ -5281,7 +5282,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. @@ -5292,7 +5293,7 @@ Mutation event of a design within a version. | `MODIFICATION` | A modification event | | `NONE` | No change. | -### DiffPositionType +### `DiffPositionType` Type of file the position refers to. @@ -5301,7 +5302,7 @@ Type of file the position refers to. | `image` | | | `text` | | -### EntryType +### `EntryType` Type of a tree entry. @@ -5311,7 +5312,7 @@ Type of a tree entry. | `commit` | | | `tree` | | -### EpicSort +### `EpicSort` Roadmap sort values. @@ -5322,7 +5323,7 @@ Roadmap sort values. | `start_date_asc` | Start date at ascending order. | | `start_date_desc` | Start date at descending order. | -### EpicState +### `EpicState` State of an epic. @@ -5332,7 +5333,7 @@ State of an epic. | `closed` | | | `opened` | | -### EpicStateEvent +### `EpicStateEvent` State event of an epic. @@ -5341,7 +5342,7 @@ State event of an epic. | `CLOSE` | Close the epic. | | `REOPEN` | Reopen the epic. | -### EpicWildcardId +### `EpicWildcardId` Epic ID wildcard values. @@ -5350,7 +5351,7 @@ Epic ID wildcard values. | `ANY` | Any epic is assigned. | | `NONE` | No epic is assigned. | -### EventAction +### `EventAction` Event action. @@ -5370,7 +5371,7 @@ Event action. | `REOPENED` | Reopened action | | `UPDATED` | Updated action | -### GroupMemberRelation +### `GroupMemberRelation` Group member relation. @@ -5380,7 +5381,7 @@ Group member relation. | `DIRECT` | Direct members | | `INHERITED` | Inherited members | -### HealthStatus +### `HealthStatus` Health status of an issue or epic. @@ -5390,7 +5391,7 @@ Health status of an issue or epic. | `needsAttention` | | | `onTrack` | | -### IssuableSeverity +### `IssuableSeverity` Incident severity. @@ -5402,7 +5403,7 @@ Incident severity. | `MEDIUM` | Medium severity | | `UNKNOWN` | Unknown severity | -### IssuableState +### `IssuableState` State of a GitLab issue or merge request. @@ -5413,7 +5414,7 @@ State of a GitLab issue or merge request. | `locked` | Discussion has been locked. | | `opened` | In open state. | -### IssueSort +### `IssueSort` Values for sorting issues. @@ -5445,7 +5446,7 @@ Values for sorting issues. | `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. @@ -5456,7 +5457,7 @@ State of a GitLab issue. | `locked` | Discussion has been locked. | | `opened` | In open state. | -### IssueStateEvent +### `IssueStateEvent` Values for issue state events. @@ -5465,7 +5466,7 @@ Values for issue state events. | `CLOSE` | Closes the issue. | | `REOPEN` | Reopens the issue. | -### IssueType +### `IssueType` Issue type. @@ -5475,7 +5476,7 @@ Issue type. | `ISSUE` | Issue issue type | | `TEST_CASE` | Test Case issue type | -### IterationState +### `IterationState` State of a GitLab iteration. @@ -5487,7 +5488,7 @@ State of a GitLab iteration. | `started` | | | `upcoming` | | -### IterationWildcardId +### `IterationWildcardId` Iteration ID wildcard values. @@ -5497,7 +5498,7 @@ Iteration ID wildcard values. | `CURRENT` | Current iteration. | | `NONE` | No iteration is assigned. | -### JobArtifactFileType +### `JobArtifactFileType` | Value | Description | | ----- | ----------- | @@ -5529,7 +5530,7 @@ Iteration ID wildcard values. | `TERRAFORM` | TERRAFORM job artifact file type. | | `TRACE` | TRACE job artifact file type. | -### ListLimitMetric +### `ListLimitMetric` List limit metric setting. @@ -5539,7 +5540,7 @@ List limit metric setting. | `issue_count` | | | `issue_weights` | | -### MeasurementIdentifier +### `MeasurementIdentifier` Possible identifier types for a measurement. @@ -5556,7 +5557,7 @@ Possible identifier types for a measurement. | `PROJECTS` | Project count. | | `USERS` | User count. | -### MergeRequestNewState +### `MergeRequestNewState` New state to apply to a merge request. @@ -5565,7 +5566,7 @@ New state to apply to a merge request. | `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. @@ -5588,7 +5589,7 @@ Values for sorting merge requests. | `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. @@ -5600,7 +5601,7 @@ State of a GitLab merge request. | `merged` | Merge Request has been merged. | | `opened` | In open state. | -### MilestoneStateEnum +### `MilestoneStateEnum` Current state of milestone. @@ -5609,7 +5610,7 @@ Current state of milestone. | `active` | Milestone is currently active. | | `closed` | Milestone is closed. | -### MoveType +### `MoveType` The position to which the adjacent object should be moved. @@ -5618,7 +5619,7 @@ The position to which the adjacent object should be 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. @@ -5628,7 +5629,7 @@ Different toggles for changing mutator behavior. | `REMOVE` | Performs a removal operation. | | `REPLACE` | Performs a replace operation. | -### NamespaceProjectSort +### `NamespaceProjectSort` Values for sorting projects. @@ -5637,7 +5638,7 @@ Values for sorting projects. | `SIMILARITY` | Most similar to the search query. | | `STORAGE` | Sort by storage size. | -### OncallRotationUnitEnum +### `OncallRotationUnitEnum` Rotation length unit of an on-call rotation. @@ -5647,7 +5648,7 @@ Rotation length unit of an on-call rotation. | `HOURS` | Hours | | `WEEKS` | Weeks | -### PackageTypeEnum +### `PackageTypeEnum` | Value | Description | | ----- | ----------- | @@ -5662,7 +5663,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 | | ----- | ----------- | @@ -5676,7 +5677,7 @@ Rotation length unit of an on-call rotation. | `UNKNOWN_SOURCE` | | | `WEBIDE_SOURCE` | | -### PipelineStatusEnum +### `PipelineStatusEnum` | Value | Description | | ----- | ----------- | @@ -5692,7 +5693,7 @@ Rotation length unit of an on-call rotation. | `SUCCESS` | | | `WAITING_FOR_RESOURCE` | | -### ProjectMemberRelation +### `ProjectMemberRelation` Project member relation. @@ -5703,7 +5704,7 @@ Project member relation. | `INHERITED` | Inherited members | | `INVITED_GROUPS` | Invited Groups members | -### RegistryState +### `RegistryState` State of a Geo registry. @@ -5714,7 +5715,7 @@ State of a Geo registry. | `STARTED` | Registry currently syncing. | | `SYNCED` | Registry that is synced. | -### ReleaseAssetLinkType +### `ReleaseAssetLinkType` Type of the link: `other`, `runbook`, `image`, `package`. @@ -5725,7 +5726,7 @@ Type of the link: `other`, `runbook`, `image`, `package`. | `PACKAGE` | Package link type | | `RUNBOOK` | Runbook link type | -### ReleaseSort +### `ReleaseSort` Values for sorting releases. @@ -5736,7 +5737,7 @@ Values for sorting releases. | `RELEASED_AT_ASC` | Released at by ascending order. | | `RELEASED_AT_DESC` | Released at by descending order. | -### RequirementState +### `RequirementState` State of a requirement. @@ -5745,7 +5746,7 @@ State of a requirement. | `ARCHIVED` | | | `OPENED` | | -### RequirementStatusFilter +### `RequirementStatusFilter` Status of a requirement based on last test report. @@ -5755,7 +5756,7 @@ Status of a requirement based on last test report. | `MISSING` | Requirements without any test report. | | `PASSED` | | -### SastUiComponentSize +### `SastUiComponentSize` Size of UI component in SAST configuration page. @@ -5765,7 +5766,7 @@ Size of UI component in SAST configuration page. | `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 | | ----- | ----------- | @@ -5777,7 +5778,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. @@ -5791,7 +5792,7 @@ The type of the security scanner. | `SAST` | | | `SECRET_DETECTION` | | -### SentryErrorStatus +### `SentryErrorStatus` State of a Sentry error. @@ -5802,7 +5803,7 @@ State of a Sentry error. | `RESOLVED_IN_NEXT_RELEASE` | Error has been ignored until next release. | | `UNRESOLVED` | Error is unresolved. | -### ServiceType +### `ServiceType` | Value | Description | | ----- | ----------- | @@ -5843,7 +5844,7 @@ State of a Sentry error. | `WEBEX_TEAMS_SERVICE` | WebexTeamsService type | | `YOUTRACK_SERVICE` | YoutrackService type | -### SnippetBlobActionEnum +### `SnippetBlobActionEnum` Type of a snippet blob input action. @@ -5854,7 +5855,7 @@ Type of a snippet blob input action. | `move` | | | `update` | | -### Sort +### `Sort` Common sort values. @@ -5869,7 +5870,7 @@ Common sort values. | `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. @@ -5878,7 +5879,7 @@ State of a test report. | `FAILED` | | | `PASSED` | | -### TodoActionEnum +### `TodoActionEnum` | Value | Description | | ----- | ----------- | @@ -5892,14 +5893,14 @@ State of a test report. | `review_requested` | Review was requested from the user. | | `unmergeable` | Merge request authored by the user could not be merged. | -### TodoStateEnum +### `TodoStateEnum` | Value | Description | | ----- | ----------- | | `done` | The state of the todo is done. | | `pending` | The state of the todo is pending. | -### TodoTargetEnum +### `TodoTargetEnum` | Value | Description | | ----- | ----------- | @@ -5910,14 +5911,14 @@ State of a test report. | `ISSUE` | An Issue. | | `MERGEREQUEST` | A MergeRequest. | -### TypeEnum +### `TypeEnum` | Value | Description | | ----- | ----------- | | `personal` | | | `project` | | -### UserState +### `UserState` Possible states of a user. @@ -5927,7 +5928,7 @@ Possible states of a user. | `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 | | ----- | ----------- | @@ -5935,7 +5936,7 @@ Possible states of a user. | `private` | Private visibility level. | | `public` | Public visibility level. | -### VisibilityScopesEnum +### `VisibilityScopesEnum` | Value | Description | | ----- | ----------- | @@ -5943,7 +5944,7 @@ Possible states of a user. | `private` | | | `public` | | -### VulnerabilityDismissalReason +### `VulnerabilityDismissalReason` The dismissal reason of the Vulnerability. @@ -5955,7 +5956,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. @@ -5963,7 +5964,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. @@ -5971,7 +5972,7 @@ The type of the external issue link related to a vulnerability. | ----- | ----------- | | `CREATED` | Created link type | -### VulnerabilityGrade +### `VulnerabilityGrade` The grade of the vulnerable project. @@ -5983,7 +5984,7 @@ The grade of the vulnerable project. | `D` | | | `F` | | -### VulnerabilityIssueLinkType +### `VulnerabilityIssueLinkType` The type of the issue link related to a vulnerability. @@ -5992,7 +5993,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. @@ -6006,7 +6007,7 @@ The type of the security scan that found the vulnerability. | `SAST` | | | `SECRET_DETECTION` | | -### VulnerabilitySeverity +### `VulnerabilitySeverity` The severity of the vulnerability. @@ -6019,7 +6020,7 @@ The severity of the vulnerability. | `MEDIUM` | | | `UNKNOWN` | | -### VulnerabilitySort +### `VulnerabilitySort` Vulnerability sort values. @@ -6036,7 +6037,7 @@ Vulnerability sort values. | `title_asc` | Title in ascending order. | | `title_desc` | Title in descending order. | -### VulnerabilityState +### `VulnerabilityState` The state of the vulnerability. diff --git a/doc/api/projects.md b/doc/api/projects.md index da883d376b0..4e65e416613 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1890,7 +1890,7 @@ This endpoint: merge requests). - From [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) on [Premium or higher](https://about.gitlab.com/pricing/) tiers, group - admins can [configure](../user/group/index.md#enabling-delayed-project-removal) + admins can [configure](../user/group/index.md#enable-delayed-project-removal) projects within a group to be deleted after a delayed period. When enabled, actual deletion happens after the number of days specified in the [default deletion delay](../user/admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). @@ -1898,7 +1898,7 @@ This endpoint: WARNING: The default behavior of [Delayed Project deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/32935) in GitLab 12.6 was changed to [Immediate deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) -in GitLab 13.2, as discussed in [Enabling delayed project removal](../user/group/index.md#enabling-delayed-project-removal). +in GitLab 13.2, as discussed in [Enable delayed project removal](../user/group/index.md#enable-delayed-project-removal). ```plaintext DELETE /projects/:id diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index ed829b7f0ce..d2af9cf7308 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -2754,7 +2754,62 @@ URI-encoded `%2F`. A value made only of dots (`.`, `%2E`) is also forbidden. You can specify a [fallback cache key](#fallback-cache-key) to use if the specified `cache:key` is not found. -##### Fallback cache key +##### Multiple caches + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32814) in GitLab 13.10. +> - It's [deployed behind a feature flag](../../user/feature_flags.md), disabled by default. +> - It's disabled on GitLab.com. +> - It's not recommended for production use. +> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-multiple-caches). **(FREE SELF)** + +WARNING: +This feature might not be available to you. Check the **version history** note above for details. + +You can have a maximum of four caches: + +```yaml +test-job: + stage: build + cache: + - key: + files: + - Gemfile.lock + paths: + - vendor/ruby + - key: + files: + - yarn.lock + paths: + - .yarn-cache/ + script: + - bundle install --path=vendor + - yarn install --cache-folder .yarn-cache + - echo Run tests... +``` + +If multiple caches are combined with a [Fallback cache key](#fallback-cache-key), +the fallback is fetched multiple times if multiple caches are not found. + +##### Enable or disable multiple caches **(FREE SELF)** + +The multiple caches feature is under development and not ready for production use. +It is deployed behind a feature flag that is **disabled by default**. +[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) +can enable it. + +To enable it: + +```ruby +Feature.enable(:multiple_cache_per_job) +``` + +To disable it: + +```ruby +Feature.disable(:multiple_cache_per_job) +``` + +#### Fallback cache key > [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/1534) in GitLab Runner 13.4. diff --git a/doc/development/export_csv.md b/doc/development/export_csv.md index 0bf12149779..c301b6b9d66 100644 --- a/doc/development/export_csv.md +++ b/doc/development/export_csv.md @@ -14,7 +14,7 @@ This document lists the different implementations of CSV export in GitLab codeba | Downloading | - Query and write data in batches to a temporary file.<br>- Loads the file into memory.<br>- Sends the file to the client. | - Report available immediately. | - Large amount of data might cause request timeout.<br>- Memory intensive.<br>- Request expires when user navigates to a different page. | [Export Chain of Custody Report](../user/compliance/compliance_dashboard/#chain-of-custody-report) | | As email attachment | - Asynchronously process the query with background job.<br>- Email uses the export as an attachment. | - Asynchronous processing. | - Requires users use a different app (email) to download the CSV.<br>- Email providers may limit attachment size. | - [Export Issues](../user/project/issues/csv_export.md)<br>- [Export Merge Requests](../user/project/merge_requests/csv_export.md) | | As downloadable link in email (*) | - Asynchronously process the query with background job.<br>- Email uses an export link. | - Asynchronous processing.<br>- Bypasses email provider attachment size limit. | - Requires users use a different app (email).<br>- Requires additional storage and cleanup. | [Export User Permissions](https://gitlab.com/gitlab-org/gitlab/-/issues/1772) | -| Polling (non-persistent state) | - Asynchronously processes the query with the background job.<br>- Frontend(FE) polls every few seconds to check if CSV file is ready. | - Asynchronous processing.<br>- Automatically downloads to local machine on completion.<br>- In-app solution. | - Non-persistable request - request expires when user navigates to a different page.<br>- API is processed for each polling request. | [Export Vulnerabilities](../user/application_security/vulnerability_report/#export-vulnerabilities) | +| Polling (non-persistent state) | - Asynchronously processes the query with the background job.<br>- Frontend(FE) polls every few seconds to check if CSV file is ready. | - Asynchronous processing.<br>- Automatically downloads to local machine on completion.<br>- In-app solution. | - Non-persistable request - request expires when user navigates to a different page.<br>- API is processed for each polling request. | [Export Vulnerabilities](../user/application_security/vulnerability_report/#export-vulnerability-details) | | Polling (persistent state) (*) | - Asynchronously processes the query with background job.<br>- Backend (BE) maintains the export state<br>- FE polls every few seconds to check status.<br>- FE shows 'Download link' when export is ready.<br>- User can download or regenerate a new report. | - Asynchronous processing.<br>- No database calls made during the polling requests (HTTP 304 status is returned until export status changes).<br>- Does not require user to stay on page until export is complete.<br>- In-app solution.<br>- Can be expanded into a generic CSV feature (such as dashboard / CSV API). | - Requires to maintain export states in DB.<br>- Does not automatically download the CSV export to local machine, requires users to click 'Download' button. | [Export Merge Commits Report](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43055) | NOTE: diff --git a/doc/subscriptions/bronze_starter.md b/doc/subscriptions/bronze_starter.md index 7f0b106978c..303f734bc24 100644 --- a/doc/subscriptions/bronze_starter.md +++ b/doc/subscriptions/bronze_starter.md @@ -28,7 +28,7 @@ the tiers are no longer mentioned in GitLab documentation: - [Managing group memberships via LDAP](../user/group/index.md#manage-group-memberships-via-ldap) - [Member locking](../user/group/index.md#prevent-members-from-being-added-to-a-group) - [Overriding user permissions](../user/group/index.md#override-user-permissions) - - [User contribution analysis](../user/group/index.md#user-contribution-analysis) + - [User contribution analytics](../user/group/contribution_analytics/index.md) - [Kerberos integration](../integration/kerberos.md) - Issue Boards: - [Configurable issue boards](../user/project/issue_board.md#configurable-issue-boards) diff --git a/doc/user/admin_area/settings/visibility_and_access_controls.md b/doc/user/admin_area/settings/visibility_and_access_controls.md index 00a49f1b974..e335a9031d5 100644 --- a/doc/user/admin_area/settings/visibility_and_access_controls.md +++ b/doc/user/admin_area/settings/visibility_and_access_controls.md @@ -79,7 +79,7 @@ The default behavior of [Delayed Project deletion](https://gitlab.com/gitlab-org [Immediate deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) in GitLab 13.2. Projects in a group (but not a personal namespace) can be deleted after a delayed period, by -[configuring in Group Settings](../../group/index.md#enabling-delayed-project-removal). +[configuring in Group Settings](../../group/index.md#enable-delayed-project-removal). The default period is seven days, and can be changed. Setting this period to `0` enables immediate removal of projects or groups. diff --git a/doc/user/application_security/vulnerability_report/index.md b/doc/user/application_security/vulnerability_report/index.md index b1435543101..33d92f5e461 100644 --- a/doc/user/application_security/vulnerability_report/index.md +++ b/doc/user/application_security/vulnerability_report/index.md @@ -5,42 +5,80 @@ group: Threat Insights info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# GitLab Vulnerability Reports **(ULTIMATE)** +# Vulnerability Report **(ULTIMATE)** -Each vulnerability report contains vulnerabilities from the scans of the most recent branch merged into the default branch. +The Vulnerability Report provides information about vulnerabilities from scans of the branch most +recently merged into the default branch. It is available at the instance, group, and project level. -The vulnerability reports display the total number of vulnerabilities by severity (for example, -Critical, High, Medium, Low, Info, Unknown). Below this, a table shows each vulnerability's detected date, status, severity, description, identifier, the scanner where it was detected, and activity (including related issues or available solutions). By default, the vulnerability report is filtered to display all detected and confirmed vulnerabilities. +The Vulnerability Report contains: -![Vulnerability Report](img/group_vulnerability_report_v13_9.png) +- Totals of vulnerabilities per severity level. +- Filters for common vulnerability attributes. +- Details of each vulnerability, presented in tabular layout. -Clicking any vulnerability in the table takes you to its -[vulnerability details](../vulnerabilities) page to see more information on that vulnerability. +The project-level Vulnerability Report also contains: -The **Activity** column indicates the number of issues that have been created for the vulnerability. -Hover over an **Activity** entry and select a link go to that issue. +- A time stamp showing when it was updated, including a link to the latest pipeline. +- The number of failures that occurred in the most recent pipeline. Select the failure + notification to view the **Failed jobs** tab of the pipeline's page. -![Display attached issues](img/vulnerability_list_table_v13_9.png) +![Vulnerability Report](img/group_vulnerability_report_v13_9.png) -## Filter options +From the Vulnerability Report you can: -You can filter which vulnerabilities display by: +- [Filter the list of vulnerabilities](#filter-the-list-of-vulnerabilities). +- [View more details about a vulnerability](#view-details-of-a-vulnerability). +- [View an issue raised for a vulnerability](#view-issues-raised-for-a-vulnerability). +- [Change the status of vulnerabilities](#change-status-of-vulnerabilities). +- [Export details of vulnerabilities](#export-vulnerability-details). -| Filter | Available options | +## Vulnerability filters + +You can filter the vulnerabilities table by: + +| Filter | Available options | |:---------|:------------------| -| Status | Detected, Confirmed, Dismissed, Resolved | -| Severity | Critical, High, Medium, Low, Info, Unknown | +| Status | Detected, Confirmed, Dismissed, Resolved. | +| Severity | Critical, High, Medium, Low, Info, Unknown. | | Scanner | [Available scanners](../index.md#security-scanning-tools). | -| Project | Projects configured in the Security Center settings, or all projects in the group for the group level report. This filter is not displayed on the project level vulnerability report. | -| Activity | Vulnerabilities with issues and vulnerabilities that are no longer detected in the default branch. | +| Project | For more details, see [Project filter](#project-filter). | +| Activity | For more details, see [Activity filter](#activity-filter). | + +### Filter the list of vulnerabilities + +To filter the list of vulnerabilities: + +1. Select a filter. +1. Select values from the dropdown. +1. Repeat the above steps for each desired filter. + +The vulnerability table is applied immediately. The vulnerability severity totals are also updated. + +The filters' criteria are combined to show only vulnerabilities matching all criteria. +An exception to this behavior is the Activity filter. For more details about how it works, see +[Activity filter](#activity-filter). + +### Project filter + +The content of the Project filter depends on the current level: + +| Level | Content of the Project filter | +|:---------------|:------------------------------| +| Instance level | Only projects you've [added to the instance-level Security Center](../security_dashboard/index.md#adding-projects-to-the-security-center). | +| Group level | All projects in the group. | +| Project level | Not applicable. | ### Activity filter > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/259255) in GitLab 13.9 -The Activity filter behaves differently from the other Vulnerability Report filters. The other filter options all OR together to show results from any vulnerability matching one of the filter criteria. With the Activity filter, the selected values form mutually exclusive sets to allow for precisely locating the desired vulnerability records. Additionally, not all options can be selected in combination. Selection behavior when using the Activity filter: +The Activity filter behaves differently from the other filters. The selected values form mutually +exclusive sets to allow for precisely locating the desired vulnerability records. Additionally, not +all options can be selected in combination. + +Selection behavior when using the Activity filter: -| Activity Selection | Results Displayed | +| Activity selection | Results displayed | |:------------------------------------|:------------------| | All | Vulnerabilities with any Activity status (same as ignoring this filter). Selecting this will deselect any other Activity filter options. | | No activity | Only vulnerabilities without either an associated Issue or that are no longer detected. Selecting this will deselect any other Activity filter options. | @@ -48,9 +86,21 @@ The Activity filter behaves differently from the other Vulnerability Report filt | No longer detected | Only vulnerabilities that are no longer detected in the latest pipeline scan of the `default` branch. Does not include vulnerabilities with one or more associated issues. | | With issues and No longer detected | Only vulnerabilities that have one or more associated issues and also are no longer detected in the latest pipeline scan of the `default` branch. | -Contents of the unfiltered vulnerability report can be exported using our [export feature](#export-vulnerabilities). +## View details of a vulnerability -You can also change the status of vulnerabilities in the table: +To view more details of a vulnerability, select the vulnerability's **Description**. The +[vulnerability's details](../vulnerabilities) page is opened. + +## View issues raised for a vulnerability + +The **Activity** column indicates the number of issues that have been created for the vulnerability. +Hover over an **Activity** entry and select a link go to that issue. + +![Display attached issues](img/vulnerability_list_table_v13_9.png) + +## Change status of vulnerabilities + +To change the status of vulnerabilities in the table: 1. Select the checkbox for each vulnerability you want to update the status of. 1. In the dropdown that appears select the desired status, then select **Change status**. @@ -72,31 +122,37 @@ the **Failed jobs** tab of the pipeline page. ![Project Vulnerability Report](img/project_security_dashboard_v13_9.png) -## Export vulnerabilities +## Export vulnerability details > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213014) in the Security Center (previously known as the Instance Security Dashboard) and project-level Vulnerability Report (previously known as the Project Security Dashboard) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.0. > - [Added](https://gitlab.com/gitlab-org/gitlab/-/issues/213013) to the group-level Vulnerability Report in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1. -You can export all your vulnerabilities in CSV (comma separated values) format by clicking the -**{upload}** **Export** button located at top right of the Security Dashboard. When the report is -ready, the CSV report downloads to your local machine. The report contains all vulnerabilities for -the projects defined in the Security Dashboard, as filters don't apply to the export function. +You can export details of the vulnerabilities listed in the Vulnerability Report. The export format +is CSV (comma separated values). Note that all vulnerabilities are included because filters don't +apply to the export. -NOTE: -It may take several minutes for the download to start if your project contains -thousands of vulnerabilities. Don't close the page until the download finishes. +Fields included are: -The fields in the export include: - -- Group Name -- Project Name -- Scanner Type -- Scanner Name +- Group name +- Project name +- Scanner type +- Scanner name - Status - Vulnerability - Details -- Additional Information +- Additional information - Severity - [CVE](https://cve.mitre.org/) (Common Vulnerabilities and Exposures) - [CWE](https://cwe.mitre.org/) (Common Weakness Enumeration) -- Other Identifiers +- Other identifiers + +### Export details in CSV format + +To export details of all vulnerabilities listed in the Vulnerability Report, select **Export**. + +The details are retrieved from the database, then the CSV file is downloaded to your local +computer. + +NOTE: +It may take several minutes for the download to start if your project contains +thousands of vulnerabilities. Don't close the page until the download finishes. diff --git a/doc/user/group/img/create_new_project_from_group_v13_6.png b/doc/user/group/img/create_new_project_from_group_v13_6.png Binary files differdeleted file mode 100644 index 72d19817686..00000000000 --- a/doc/user/group/img/create_new_project_from_group_v13_6.png +++ /dev/null diff --git a/doc/user/group/img/group_file_template_dropdown.png b/doc/user/group/img/group_file_template_dropdown.png Binary files differdeleted file mode 100644 index f0586772218..00000000000 --- a/doc/user/group/img/group_file_template_dropdown.png +++ /dev/null diff --git a/doc/user/group/img/member_lock.png b/doc/user/group/img/member_lock.png Binary files differdeleted file mode 100644 index 3f1382e76c6..00000000000 --- a/doc/user/group/img/member_lock.png +++ /dev/null diff --git a/doc/user/group/img/select_group_dropdown.png b/doc/user/group/img/select_group_dropdown.png Binary files differdeleted file mode 100644 index 4948cefb65f..00000000000 --- a/doc/user/group/img/select_group_dropdown.png +++ /dev/null diff --git a/doc/user/group/img/select_group_dropdown_13_10.png b/doc/user/group/img/select_group_dropdown_13_10.png Binary files differnew file mode 100644 index 00000000000..d2cbfe83028 --- /dev/null +++ b/doc/user/group/img/select_group_dropdown_13_10.png diff --git a/doc/user/group/img/share_with_group_lock.png b/doc/user/group/img/share_with_group_lock.png Binary files differdeleted file mode 100644 index 77b00d8a248..00000000000 --- a/doc/user/group/img/share_with_group_lock.png +++ /dev/null diff --git a/doc/user/group/index.md b/doc/user/group/index.md index 99451b7fec4..68ee85cd502 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -59,7 +59,7 @@ To create a group: - Alphanumeric characters - Emojis - Underscores - - Dashes, dots, spaces and parenthesis (however, it cannot start with any of these characters) + - Dashes, dots, spaces, and parentheses (however, it cannot start with any of these characters) For a list of words that cannot be used as group names, see [reserved names](../reserved_names.md). @@ -214,13 +214,9 @@ In [GitLab Premium or higher](https://about.gitlab.com/pricing/), GitLab adminis There are two different ways to add a new project to a group: - Select a group, and then click **New project**. You can then continue [creating your project](../../user/project/working_with_projects.md#create-a-project). +- While you are creating a project, select a group from the dropdown menu. - ![New project](img/create_new_project_from_group_v13_6.png) - -- While you are creating a project, select a group namespace - you've already created from the dropdown menu. - - ![Select group](img/select_group_dropdown.png) + ![Select group](img/select_group_dropdown_13_10.png) ### Specify who can add projects to a group @@ -261,22 +257,11 @@ You can view the most recent actions taken in a group. To view the activity feed in Atom format, select the **RSS** (**{rss}**) icon. -## Transfer projects into groups - -Learn how to [transfer a project into a group](../project/settings/index.md#transferring-an-existing-project-into-another-namespace). - -## Share a project with a group - -You can [share your projects with a group](../project/members/share_project_with_groups.md) -and give all group members access to the project at once. - -Alternatively, you can [lock the sharing with group feature](#prevent-a-project-from-being-shared-with-groups). - ## Share a group with another group > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18328) in GitLab 12.7. -Similar to how you [share a project with a group](#share-a-project-with-a-group), +Similar to how you [share a project with a group](../project/members/share_project_with_groups.md), you can share a group with another group. Members get direct access to the shared group. This is not valid for inherited members. @@ -301,7 +286,7 @@ Group links can be created by using either a CN or a filter. To create these gro For more information on the administration of LDAP and group sync, refer to the [main LDAP documentation](../../administration/auth/ldap/index.md#group-sync). NOTE: -If an LDAP user is a group member when LDAP Synchronization is added, and they are not part of the LDAP group, they are removed from the group. +When you add LDAP synchronization, if an LDAP user is a group member and they are not part of the LDAP group, they are removed from the group. ### Create group links via CN **(PREMIUM SELF)** @@ -311,7 +296,7 @@ To create group links via CN: 1. Select the **LDAP Server** for the link. 1. As the **Sync method**, select `LDAP Group cn`. -1. In the **LDAP Group cn** text input box, begin typing the CN of the group. There is a dropdown menu with matching CNs within the configured `group_base`. Select your CN from this list. +1. In the **LDAP Group cn** field, begin typing the CN of the group. There is a dropdown menu with matching CNs in the configured `group_base`. Select your CN from this list. 1. In the **LDAP Access** section, select the [permission level](../permissions.md) for users synced in this group. 1. Select the **Add Synchronization** button. @@ -329,7 +314,7 @@ To create group links via filter: ### Override user permissions **(PREMIUM SELF)** -LDAP user permissions can be manually overridden by an admin user. To override a user's permissions: +LDAP user permissions can be manually overridden by an administrator. To override a user's permissions: 1. Go to your group's **Members** page. 1. In the row for the user you are editing, select the pencil (**{pencil}**) icon. @@ -337,28 +322,16 @@ LDAP user permissions can be manually overridden by an admin user. To override a Now you can edit the user's permissions from the **Members** page. -## Epics **(ULTIMATE)** - -> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.2. - -Epics let you manage your portfolio of projects more efficiently and with less -effort by tracking groups of issues that share a theme, across projects and -milestones. - -[Learn more about Epics.](epics/index.md) - ## Group wikis **(PREMIUM)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13195) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5. -Group wikis work the same way as [project wikis](../project/wiki/index.md), please refer to those docs for details on usage. +Group wikis work the same way as [project wikis](../project/wiki/index.md). Group wikis can be edited by members with [Developer permissions](../../user/permissions.md#group-members-permissions) and above. -Group wiki repositories can be moved through the [Group repository storage moves API](../../api/group_repository_storage_moves.md). - -### Group wikis limitations +You can move group wiki repositories by using the [Group repository storage moves API](../../api/group_repository_storage_moves.md). There are a few limitations compared to project wikis: @@ -366,29 +339,7 @@ There are a few limitations compared to project wikis: - Group wikis are not included in global search and Geo replication. - Changes to group wikis don't show up in the group's activity feed. -For updates, you can follow: - -- [The epic tracking feature parity with project wikis](https://gitlab.com/groups/gitlab-org/-/epics/2782). - -## Group Security Dashboard **(ULTIMATE)** - -Get an overview of the vulnerabilities of all the projects in a group and its subgroups. - -[Learn more about the Group Security Dashboard.](../application_security/security_dashboard/index.md) - -## Insights **(ULTIMATE)** - -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/725) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.0. - -Configure the Insights that matter for your groups or projects, allowing users -to explore data such as: - -- Triage hygiene -- Issues created/closed per a given period -- Average time for merge requests to be merged -- Much more - -[Learn more about Insights](insights/index.md). +For updates, follow [the epic that tracks feature parity with project wikis](https://gitlab.com/groups/gitlab-org/-/epics/2782). ## Transfer a group @@ -403,66 +354,66 @@ When transferring groups, note: - Changing a group's parent can have unintended side effects. See [Redirects when changing repository paths](../project/repository/index.md#redirects-when-changing-repository-paths). - You can only transfer groups to groups you manage. - You must update your local repositories to point to the new location. -- If the immediate parent group's visibility is lower than the group's current visibility, visibility levels for subgroups and projects will change to match the new parent group's visibility. +- If the immediate parent group's visibility is lower than the group's current visibility, visibility levels for subgroups and projects change to match the new parent group's visibility. - Only explicit group membership is transferred, not inherited membership. If the group's owners have only inherited membership, this leaves the group without an owner. In this case, the user transferring the group becomes the group's owner. -- Transfers will fail if [packages](../packages/index.md) exist in any of the projects within the group, or in any of its subgroups. +- Transfers fail if [packages](../packages/index.md) exist in any of the projects in the group, or in any of its subgroups. ## Change a group's path Changing a group's path (group URL) can have unintended side effects. Read -[how redirects will behave](../project/repository/index.md#redirects-when-changing-repository-paths) -before proceeding. +[how redirects behave](../project/repository/index.md#redirects-when-changing-repository-paths) +before you proceed. -If you are vacating the path so it can be claimed by another group or user, -you may need to rename the group too, since both names and paths must +If you are changing the path so it can be claimed by another group or user, +you may need to rename the group too. Both names and paths must be unique. +To retain ownership of the original namespace and protect the URL redirects, +create a new group and transfer projects to it instead. + To change your group path (group URL): -1. Navigate to your group's **Settings > General** page. +1. Go to your group's **Settings > General** page. 1. Expand the **Path, transfer, remove** section. -1. Enter a new name under **Change group URL**. -1. Click **Change group URL**. +1. Under **Change group URL**, enter a new name. +1. Select **Change group URL**. WARNING: -It is currently not possible to rename a namespace if it contains a +It is not possible to rename a namespace if it contains a project with [Container Registry](../packages/container_registry/index.md) tags, because the project cannot be moved. -NOTE: -If you want to retain ownership over the original namespace and -protect the URL redirects, then instead of changing a group's path or renaming a -username, you can create a new group and transfer projects to it. - ## Use a custom name for the initial branch > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43290) in GitLab 13.6. By default, when you create a new project in GitLab, the initial branch is called `master`. For groups, a group owner can customize the initial branch name to something -else. This way, every new project created under that group from then on will start from the custom branch name rather than `master`. To do so: +else. This way, every new project created under that group from then on starts from the custom branch name rather than `master`. -1. Go to the **Group page > Settings > Repository** and expand **Default initial - branch name**. +To use a custom name for the initial branch: + +1. Go to the group's **Settings > Repository** page. +1. Expand the **Default initial branch name** section. 1. Change the default initial branch to a custom name of your choice. -1. **Save Changes**. +1. Select **Save changes**. ## Remove a group To remove a group and its contents: -1. Navigate to your group's **Settings > General** page. +1. Go to your group's **Settings > General** page. 1. Expand the **Path, transfer, remove** section. -1. In the Remove group section, click the **Remove group** button. -1. Confirm the action when asked to. +1. In the Remove group section, select **Remove group**. +1. Confirm the action. -This action either: +This action removes the group. It also adds a background job to delete all projects in the group. -- Removes the group, and also queues a background job to delete all projects in that group. -- Since [GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/33257), on [Premium](https://about.gitlab.com/pricing/premium/) or higher tiers, this action adds a background job to mark a group for deletion. By default, the job schedules the deletion 7 days in the future. You can modify this waiting period through the [instance settings](../admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). +Specifically: -Since [GitLab 13.6](https://gitlab.com/gitlab-org/gitlab/-/issues/39504), if the user who sets up the deletion leaves or is otherwise removed from the group before the -actual deletion happens, the job is cancelled, and the group is no longer scheduled for deletion. +- In [GitLab 12.8 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/33257), on [Premium](https://about.gitlab.com/pricing/premium/) or higher tiers, this action adds a background job to mark a group for deletion. By default, the job schedules the deletion 7 days in the future. You can modify this waiting period through the [instance settings](../admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). +- In [GitLab 13.6 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/39504), if the user who sets up the deletion is removed from the group before the +deletion happens, the job is cancelled, and the group is no longer scheduled for deletion. ## Restore a group **(PREMIUM)** @@ -470,15 +421,9 @@ actual deletion happens, the job is cancelled, and the group is no longer schedu To restore a group that is marked for deletion: -1. Navigate to your group's **Settings > General** page. +1. Go to your group's **Settings > General** page. 1. Expand the **Path, transfer, remove** section. -1. In the Restore group section, click the **Restore group** button. - -## Enforce two-factor authentication for group members - -Add a security layer to your group by -[enforcing two-factor authentication (2FA)](../../security/two_factor_authentication.md#enforcing-2fa-for-all-users-in-a-group) -for all group members. +1. In the Restore group section, select **Restore group**. ## Prevent a project from being shared with groups @@ -486,34 +431,33 @@ Prevent projects in a group from [sharing a project with another group](../project/members/share_project_with_groups.md) to enable tighter control over project access. For example, let's say you have two distinct teams (Group A and Group B) working together in a project, and to inherit the group membership, you share the project between the -two groups A and B. **Share with group lock** prevents any project within +two groups A and B. **Share with group lock** prevents any project in the group from being shared with another group, guaranteeing that only the right group members have access to those projects. -To enable this feature, navigate to the group settings page. Select -**Share with group lock** and **Save the group**. +To prevent a project from being shared with groups: -![Checkbox for share with group lock](img/share_with_group_lock.png) +1. Go to the group's **Settings > General** page. +1. Select **Share with group lock**. +1. Select **Save the group**. ## Prevent members from being added to a group **(PREMIUM)** Member lock lets a group owner prevent any new project membership to all of the -projects within a group, allowing tighter control over project membership. +projects in a group, allowing tighter control over project membership. For example, if you want to lock the group for an [Audit Event](../../administration/audit_events.md), -enable Member lock to guarantee that project membership cannot be modified during that audit. +enable member lock to guarantee that project membership cannot be modified during the audit. -To enable this feature: +To prevent members from being added to a group: -1. Navigate to the group's **Settings > General** page. -1. Expand the **Permissions, LFS, 2FA** section, and select **Member lock**. -1. Click **Save changes**. - -![Checkbox for membership lock](img/member_lock.png) +1. Go to the group's **Settings > General** page. +1. Expand the **Permissions, LFS, 2FA** section. +1. Select **Member lock**. +1. Select **Save changes**. -This will disable the option for all users who previously had permissions to -operate project memberships, so no new users can be added. Furthermore, any -request to add a new user to a project through API will not be possible. +All users who previously had permissions can no longer add members to a group. +API requests to add a new user to a project are not possible. ## Restrict group access by IP address **(PREMIUM)** @@ -521,13 +465,12 @@ request to add a new user to a project through API will not be possible. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/215410) to [GitLab Premium](https://about.gitlab.com/pricing/) in 13.1. NOTE: -IP Access Restrictions are currently not functioning as expected on GitLab.com. If enabled, -users cannot perform Git operations through SSH, or access projects via the UI. Please -review the [following bug report](https://gitlab.com/gitlab-org/gitlab/-/issues/271673) for -more information. +IP access restrictions are not functioning as expected on GitLab.com. If enabled, +users cannot perform Git operations through SSH, or access projects in the UI. +For more information, [see this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/271673). -To make sure only people from within your organization can access particular -resources, you have the option to restrict access to groups and their +To ensure only people from your organization can access particular +resources, you can restrict access to groups and their underlying subgroups, projects, issues, and so on, by IP address. This can help ensure that particular content doesn't leave the premises, while not blocking off access to the entire instance. IP access restrictions can only be configured at the group level. @@ -545,55 +488,48 @@ Restriction currently applies to: To avoid accidental lock-out, admins and group owners are able to access the group regardless of the IP restriction. -To enable this feature: +To restrict group access by IP address: -1. Navigate to the group’s **Settings > General** page. -1. Expand the **Permissions, LFS, 2FA** section, and enter IP address ranges into **Allow access to the following IP addresses** field. -1. Click **Save changes**. +1. Go to the group’s **Settings > General** page. +1. Expand the **Permissions, LFS, 2FA** section. +1. In the **Allow access to the following IP addresses** field, enter IP address ranges. +1. Select **Save changes**. ![Domain restriction by IP address](img/restrict-by-ip.gif) ## Restrict group access by domain **(PREMIUM)** >- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7297) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.2. ->- Support for specifying multiple email domains [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33143) in GitLab 13.1 +>- Support for specifying multiple email domains [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33143) added in GitLab 13.1. -You can restrict access to groups by allowing only users with email addresses in particular domains to be added to the group. +You can prevent users with email addresses in specific domains from being added to a group. -Add email domains you want to allow and users with emails from different domains won't be allowed to be added to this group. +To restrict group access by domain: -Some domains cannot be restricted. These are the most popular public email domains, such as: - -- `gmail.com` -- `yahoo.com` -- `hotmail.com` -- `aol.com` -- `msn.com` -- `hotmail.co.uk` -- `hotmail.fr` -- `live.com` -- `outlook.com` -- `icloud.com` - -To enable this feature: - -1. Navigate to the group's **Settings > General** page. -1. Expand the **Permissions, LFS, 2FA** section, and enter the domain names into **Restrict membership by email** field. -1. Click **Save changes**. +1. Go to the group's **Settings > General** page. +1. Expand the **Permissions, LFS, 2FA** section. +1. In the **Restrict membership by email** field, enter the domain names. +1. Select **Save changes**. ![Domain restriction by email](img/restrict-by-email.gif) -This will enable the domain-checking for all new users added to the group from this moment on. +Any time you attempt to add a new user, they are compared against this list. + +Some domains cannot be restricted. These are the most popular public email domains, such as: + +- `gmail.com`, `yahoo.com`, `aol.com`, `icloud.com` +- `hotmail.com`, `hotmail.co.uk`, `hotmail.fr` +- `msn.com`, `live.com`, `outlook.com` NOTE: -Domain restrictions only apply to groups and do not prevent users from being added as members of projects owned by the restricted group. +Domain restrictions apply to groups only. They do not prevent users from being added as members of projects owned by the restricted group. ## Group file templates **(PREMIUM)** -Group file templates allow you to share a set of templates for common file +Use group file templates to share a set of templates for common file types with every project in a group. It is analogous to the -[instance template repository](../admin_area/settings/instance_template_repository.md) -feature, and the selected project should follow the same naming conventions as +[instance template repository](../admin_area/settings/instance_template_repository.md). +The selected project should follow the same naming conventions as are documented on that page. You can only choose projects in the group as the template source. @@ -601,18 +537,17 @@ This includes projects shared with the group, but it **excludes** projects in subgroups or parent groups of the group being configured. You can configure this feature for both subgroups and immediate parent groups. A project -in a subgroup will have access to the templates for that subgroup, as well as +in a subgroup has access to the templates for that subgroup, as well as any immediate parent groups. -![Group file template dropdown](img/group_file_template_dropdown.png) - -To enable this feature, navigate to the group settings page, expand the -**Templates** section, choose a project to act as the template repository, and -**Save group**. +To enable group file templates: -![Group file template settings](img/group_file_template_settings.png) +1. Go to the group settings page. +1. Expand the **Templates** section. +1. Choose a project to act as the template repository. +1. Select **Save group**. -To learn how to create templates for issues and merge requests, visit +To learn how to create templates for issues and merge requests, see [Description templates](../project/description_templates.md). ### Group-level project templates **(PREMIUM)** @@ -620,19 +555,20 @@ To learn how to create templates for issues and merge requests, visit Define project templates at a group level by setting a group as the template source. [Learn more about group-level project templates](custom_project_templates.md). -## Disabling email notifications +## Disable email notifications > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23585) in GitLab 12.2. You can disable all email notifications related to the group, which includes its subgroups and projects. -To enable this feature: +To disable email notifications: -1. Navigate to the group's **Settings > General** page. -1. Expand the **Permissions, LFS, 2FA** section, and select **Disable email notifications**. -1. Click **Save changes**. +1. Go to the group's **Settings > General** page. +1. Expand the **Permissions, LFS, 2FA** section. +1. Select **Disable email notifications**. +1. Select **Save changes**. -## Disabling group mentions +## Disable group mentions > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21301) in GitLab 12.6. @@ -643,28 +579,30 @@ Groups with disabled mentions are visualized accordingly in the autocompletion d This is particularly helpful for groups with a large number of users. -To enable this feature: +To disable group mentions: -1. Navigate to the group's **Settings > General** page. -1. Expand the **Permissions, LFS, 2FA** section, and select **Disable group mentions**. -1. Click **Save changes**. +1. Go to the group's **Settings > General** page. +1. Expand the **Permissions, LFS, 2FA** section. +1. Select **Disable group mentions**. +1. Select **Save changes**. -## Enabling delayed project removal **(PREMIUM)** +## Enable delayed project removal **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) in GitLab 13.2. -By default, projects within a group are deleted immediately. +By default, projects in a group are deleted immediately. Optionally, on [Premium](https://about.gitlab.com/pricing/) or higher tiers, -you can configure the projects within a group to be deleted after a delayed interval. +you can configure the projects in a group to be deleted after a delayed interval. -During this interval period, the projects will be in a read-only state and can be restored, if required. -The interval period defaults to 7 days, and can be modified by an admin in the [instance settings](../admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). +During this interval period, the projects are in a read-only state and can be restored, if required. +The interval period defaults to 7 days, and can be modified by an administrator in the [instance settings](../admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). To enable delayed deletion of projects: -1. Navigate to the group's **Settings > General** page. -1. Expand the **Permissions, LFS, 2FA** section, and check **Enable delayed project removal**. -1. Click **Save changes**. +1. Go to the group's **Settings > General** page. +1. Expand the **Permissions, LFS, 2FA** section. +1. Check **Enable delayed project removal**. +1. Select **Save changes**. NOTE: The group setting for delayed deletion is not inherited by subgroups and has to be individually defined for each group. @@ -673,29 +611,19 @@ The group setting for delayed deletion is not inherited by subgroups and has to > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216987) in GitLab 13.3. -By default, projects within a group can be forked. +By default, projects in a group can be forked. Optionally, on [Premium](https://about.gitlab.com/pricing/) or higher tiers, -you can prevent the projects within a group from being forked outside of the current top-level group. +you can prevent the projects in a group from being forked outside of the current top-level group. Previously this setting was available only for groups enforcing group managed account. This setting will be removed from SAML setting page and migrated to group setting, but in the interim period of changes both of those settings will be taken into consideration, if even one is set to `true` then it will be assumed group does not allow forking projects outside. To enable prevent project forking: -1. Navigate to the top-level group's **Settings > General** page. -1. Expand the **Permissions, LFS, 2FA** section, and check **Prevent project forking outside current group**. -1. Click **Save changes**. - -## Advanced settings - -- **Projects**: View all projects within that group, add members to each project, - access each project's settings, and remove any project, all from the same screen. -- **Webhooks**: Configure [webhooks](../project/integrations/webhooks.md) for your group. -- **Kubernetes cluster integration**: Connect your GitLab group with [Kubernetes clusters](clusters/index.md). -- **Audit Events**: View [Audit Events](../../administration/audit_events.md#group-events) - for the group. -- **Pipelines quota**: Keep track of the [pipeline quota](../admin_area/settings/continuous_integration.md) for the group. -- **Integrations**: Configure [integrations](../admin_area/settings/project_integration_management.md) for your group. +1. Go to the top-level group's **Settings > General** page. +1. Expand the **Permissions, LFS, 2FA** section. +1. Check **Prevent project forking outside current group**. +1. Select **Save changes**. ## Group push rules **(PREMIUM)** @@ -703,60 +631,43 @@ To enable prevent project forking: > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/224129) in GitLab 13.4. Group push rules allow group maintainers to set -[push rules](../../push_rules/push_rules.md) for newly created projects within the specific group. +[push rules](../../push_rules/push_rules.md) for newly created projects in the specific group. + +To configure push rules for a group: -To configure push rules for a group, navigate to **{push-rules}** on the group's -sidebar. +1. Go to the groups's **Push Rules** page. +1. Select the settings you want. +1. Select **Save Push Rules**. -When set, new subgroups have push rules set for them based on either: +The group's new subgroups have push rules set for them based on either: - The closest parent group with push rules defined. - Push rules set at the instance level, if no parent groups have push rules defined. -## Maximum artifacts size **(FREE SELF)** - -For information about setting a maximum artifact size for a group, see -[Maximum artifacts size](../admin_area/settings/continuous_integration.md#maximum-artifacts-size). - -## User contribution analysis **(PREMIUM)** - -With [GitLab Contribution Analytics](contribution_analytics/index.md), -you have an overview of the contributions (pushes, merge requests, -and issues) performed by your group members. - -## Issue analytics **(PREMIUM)** - -With [GitLab Issue Analytics](issues_analytics/index.md), you can see a bar chart of the number of issues created each month in your groups. - -## Repositories analytics **(PREMIUM)** - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263478) in GitLab 13.6. -> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/276003) in GitLab 13.7. - -With [GitLab Repositories Analytics](repositories_analytics/index.md), you can view overall activity of all projects with code coverage. - -## Dependency Proxy - -Use GitLab as a [dependency proxy](../packages/dependency_proxy/index.md) for upstream Docker images. - -<!-- ## Troubleshooting - -Include any troubleshooting steps that you can foresee. If you know beforehand what issues -one might have when setting this up, or when something is changed, or on upgrading, it's -important to describe those, too. Think of things that may go wrong and include them here. -This is important to minimize requests for support, and to avoid doc comments with -questions that you know someone might ask. - -Each scenario can be a third-level heading, e.g. `### Getting error message X`. -If you have none to add when creating a doc, leave this section in place -but commented out to help encourage others to add to it in the future. --> - -## DORA4 analytics overview **(ULTIMATE ONLY)** - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291747) in GitLab [Ultimate](https://about.gitlab.com/pricing/) 13.9 as a [Beta feature](https://about.gitlab.com/handbook/product/gitlab-the-product/#beta). - -Group details include the following analytics: - -- Deployment Frequency - -For more information, see [DORA4 Project Analytics API](../../api/dora4_group_analytics.md). +## Related topics + +- [Maximum artifacts size](../admin_area/settings/continuous_integration.md#maximum-artifacts-size). **(FREE SELF)** +- [Repositories analytics](repositories_analytics/index.md): View overall activity of all projects with code coverage. + [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/263478) in GitLab 13.6. **(PREMIUM)** +- [Contribution analytics](contribution_analytics/index.md): View the contributions (pushes, merge requests, + and issues) of group members. **(PREMIUM)** +- [Issue analytics](issues_analytics/index.md): View a bar chart of your group's number of issues per month. **(PREMIUM)** +- Use GitLab as a [dependency proxy](../packages/dependency_proxy/index.md) for upstream Docker images. +- [DORA4 Project Analytics API](../../api/dora4_group_analytics.md): View deployment frequency analytics. + [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291747) in GitLab Ultimate 13.9 as a + [Beta feature](https://about.gitlab.com/handbook/product/gitlab-the-product/#beta). **(ULTIMATE SELF)** +- [Epics](epics/index.md): Track groups of issues that share a theme. **(ULTIMATE)** +- [Security Dashboard](../application_security/security_dashboard/index.md): View the vulnerabilities of all + the projects in a group and its subgroups. **(ULTIMATE)** +- [Insights](insights/index.md): Configure insights like triage hygiene, issues created/closed per a given period, and + average time for merge requests to be merged. **(ULTIMATE)** +- [Webhooks](../project/integrations/webhooks.md). +- [Kubernetes cluster integration](clusters/index.md). +- [Audit Events](../../administration/audit_events.md#group-events). **(PREMIUM)** +- [Pipelines quota](../admin_area/settings/continuous_integration.md): Keep track of the pipeline quota for the group. +- [Integrations](../admin_area/settings/project_integration_management.md). +- [Transfer a project into a group](../project/settings/index.md#transferring-an-existing-project-into-another-namespace). +- [Share a project with a group](../project/members/share_project_with_groups.md): Give all group members access to the project at once. +- [Lock the sharing with group feature](#prevent-a-project-from-being-shared-with-groups). +- [Enforce two-factor authentication (2FA)](../../security/two_factor_authentication.md#enforcing-2fa-for-all-users-in-a-group): Enforce 2FA + for all group members. diff --git a/doc/user/project/settings/index.md b/doc/user/project/settings/index.md index 8ab82fe7296..246818f32c5 100644 --- a/doc/user/project/settings/index.md +++ b/doc/user/project/settings/index.md @@ -266,7 +266,7 @@ This action: - Deletes a project including all associated resources (issues, merge requests etc). - From [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) on [Premium](https://about.gitlab.com/pricing/) or higher tiers, -group owners can [configure](../../group/index.md#enabling-delayed-project-removal) projects within a group +group owners can [configure](../../group/index.md#enable-delayed-project-removal) projects within a group to be deleted after a delayed period. When enabled, actual deletion happens after number of days specified in [instance settings](../../admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). diff --git a/doc/user/project/working_with_projects.md b/doc/user/project/working_with_projects.md index 04d2cf07068..43df1cce70f 100644 --- a/doc/user/project/working_with_projects.md +++ b/doc/user/project/working_with_projects.md @@ -212,7 +212,7 @@ To delete a project, first navigate to the home page for that project. 1. Click **Delete project** 1. Confirm this action by typing in the expected text. -Projects in personal namespaces are deleted immediately on request. For information on delayed deletion of projects in a group, please see [Enabling delayed project removal](../group/index.md#enabling-delayed-project-removal). +Projects in personal namespaces are deleted immediately on request. For information on delayed deletion of projects in a group, please see [Enable delayed project removal](../group/index.md#enable-delayed-project-removal). ## Project settings |