21532 lines
1.2 MiB
21532 lines
1.2 MiB
---
|
|
stage: Ecosystem
|
|
group: Integrations
|
|
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
|
|
---
|
|
|
|
<!---
|
|
This documentation is auto generated by a script.
|
|
|
|
Please do not edit this file directly, check compile_docs task on lib/tasks/gitlab/graphql.rake.
|
|
--->
|
|
|
|
# GraphQL API Resources
|
|
|
|
This documentation is self-generated based on GitLab current GraphQL schema.
|
|
|
|
The API can be explored interactively using the [GraphiQL IDE](../index.md#graphiql).
|
|
|
|
Each table below documents a GraphQL type. Types match loosely to models, but not all
|
|
fields and methods on a model are available via GraphQL.
|
|
|
|
WARNING:
|
|
Fields that are deprecated are marked with **{warning-solid}**.
|
|
Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-and-removal-process) can be found
|
|
in [Removed Items](../removed_items.md).
|
|
|
|
<!-- vale off -->
|
|
<!-- Vale linting disabled after this line. -->
|
|
<!-- See https://docs.gitlab.com/ee/development/documentation/testing.html#disable-vale-tests -->
|
|
|
|
<!-- markdownlint-disable MD044 -->
|
|
<!-- MD044/proper-names test disabled after this line to make page compatible with markdownlint-cli 0.29.0. -->
|
|
<!-- See https://docs.gitlab.com/ee/development/documentation/testing.html#disable-markdownlint-tests -->
|
|
|
|
## `Query` type
|
|
|
|
The `Query` type contains the API's top-level entry points for all executable queries.
|
|
|
|
### `Query.boardList`
|
|
|
|
Find an issue board list.
|
|
|
|
Returns [`BoardList`](#boardlist).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryboardlistid"></a>`id` | [`ListID!`](#listid) | Global ID of the list. |
|
|
| <a id="queryboardlistissuefilters"></a>`issueFilters` | [`BoardIssueInput`](#boardissueinput) | Filters applied when getting issue metadata in the board list. |
|
|
|
|
### `Query.ciApplicationSettings`
|
|
|
|
CI related settings that apply to the entire instance.
|
|
|
|
Returns [`CiApplicationSettings`](#ciapplicationsettings).
|
|
|
|
### `Query.ciConfig`
|
|
|
|
Linted and processed contents of a CI config.
|
|
Should not be requested more than once per request.
|
|
|
|
Returns [`CiConfig`](#ciconfig).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryciconfigcontent"></a>`content` | [`String!`](#string) | Contents of `.gitlab-ci.yml`. |
|
|
| <a id="queryciconfigdryrun"></a>`dryRun` | [`Boolean`](#boolean) | Run pipeline creation simulation, or only do static check. |
|
|
| <a id="queryciconfigprojectpath"></a>`projectPath` | [`ID!`](#id) | Project of the CI config. |
|
|
| <a id="queryciconfigsha"></a>`sha` | [`String`](#string) | Sha for the pipeline. |
|
|
|
|
### `Query.ciMinutesUsage`
|
|
|
|
CI/CD minutes usage data for a namespace.
|
|
|
|
Returns [`CiMinutesNamespaceMonthlyUsageConnection`](#ciminutesnamespacemonthlyusageconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryciminutesusagenamespaceid"></a>`namespaceId` | [`NamespaceID`](#namespaceid) | Global ID of the Namespace for the monthly CI/CD minutes usage. |
|
|
|
|
### `Query.containerRepository`
|
|
|
|
Find a container repository.
|
|
|
|
Returns [`ContainerRepositoryDetails`](#containerrepositorydetails).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querycontainerrepositoryid"></a>`id` | [`ContainerRepositoryID!`](#containerrepositoryid) | Global ID of the container repository. |
|
|
|
|
### `Query.currentLicense`
|
|
|
|
Fields related to the current license.
|
|
|
|
Returns [`CurrentLicense`](#currentlicense).
|
|
|
|
### `Query.currentUser`
|
|
|
|
Get information about current user.
|
|
|
|
Returns [`UserCore`](#usercore).
|
|
|
|
### `Query.designManagement`
|
|
|
|
Fields related to design management.
|
|
|
|
Returns [`DesignManagement!`](#designmanagement).
|
|
|
|
### `Query.devopsAdoptionEnabledNamespaces`
|
|
|
|
Get configured DevOps adoption namespaces. **BETA** This endpoint is subject to change without notice.
|
|
|
|
Returns [`DevopsAdoptionEnabledNamespaceConnection`](#devopsadoptionenablednamespaceconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querydevopsadoptionenablednamespacesdisplaynamespaceid"></a>`displayNamespaceId` | [`NamespaceID`](#namespaceid) | Filter by display namespace. |
|
|
|
|
### `Query.echo`
|
|
|
|
Testing endpoint to validate the API with.
|
|
|
|
Returns [`String!`](#string).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryechotext"></a>`text` | [`String!`](#string) | Text to echo back. |
|
|
|
|
### `Query.epicBoardList`
|
|
|
|
Returns [`EpicList`](#epiclist).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryepicboardlistepicfilters"></a>`epicFilters` | [`EpicFilters`](#epicfilters) | Filters applied when getting epic metadata in the epic board list. |
|
|
| <a id="queryepicboardlistid"></a>`id` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the list. |
|
|
|
|
### `Query.geoNode`
|
|
|
|
Find a Geo node.
|
|
|
|
Returns [`GeoNode`](#geonode).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querygeonodename"></a>`name` | [`String`](#string) | Name of the Geo node. Defaults to the current Geo node name. |
|
|
|
|
### `Query.gitpodEnabled`
|
|
|
|
Whether Gitpod is enabled in application settings.
|
|
|
|
Returns [`Boolean`](#boolean).
|
|
|
|
### `Query.group`
|
|
|
|
Find a group.
|
|
|
|
Returns [`Group`](#group).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querygroupfullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the project, group, or namespace. For example, `gitlab-org/gitlab-foss`. |
|
|
|
|
### `Query.instanceSecurityDashboard`
|
|
|
|
Fields related to Instance Security Dashboard.
|
|
|
|
Returns [`InstanceSecurityDashboard`](#instancesecuritydashboard).
|
|
|
|
### `Query.issue`
|
|
|
|
Find an issue.
|
|
|
|
Returns [`Issue`](#issue).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryissueid"></a>`id` | [`IssueID!`](#issueid) | Global ID of the issue. |
|
|
|
|
### `Query.iteration`
|
|
|
|
Find an iteration.
|
|
|
|
Returns [`Iteration`](#iteration).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryiterationid"></a>`id` | [`IterationID!`](#iterationid) | Find an iteration by its ID. |
|
|
|
|
### `Query.licenseHistoryEntries`
|
|
|
|
Fields related to entries in the license history.
|
|
|
|
Returns [`LicenseHistoryEntryConnection`](#licensehistoryentryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
### `Query.mergeRequest`
|
|
|
|
Find a merge request.
|
|
|
|
Returns [`MergeRequest`](#mergerequest).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querymergerequestid"></a>`id` | [`MergeRequestID!`](#mergerequestid) | Global ID of the merge request. |
|
|
|
|
### `Query.metadata`
|
|
|
|
Metadata about GitLab.
|
|
|
|
Returns [`Metadata`](#metadata).
|
|
|
|
### `Query.milestone`
|
|
|
|
Find a milestone.
|
|
|
|
Returns [`Milestone`](#milestone).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querymilestoneid"></a>`id` | [`MilestoneID!`](#milestoneid) | Find a milestone by its ID. |
|
|
|
|
### `Query.namespace`
|
|
|
|
Find a namespace.
|
|
|
|
Returns [`Namespace`](#namespace).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querynamespacefullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the project, group, or namespace. For example, `gitlab-org/gitlab-foss`. |
|
|
|
|
### `Query.package`
|
|
|
|
Find a package.
|
|
|
|
Returns [`PackageDetailsType`](#packagedetailstype).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querypackageid"></a>`id` | [`PackagesPackageID!`](#packagespackageid) | Global ID of the package. |
|
|
|
|
### `Query.project`
|
|
|
|
Find a project.
|
|
|
|
Returns [`Project`](#project).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryprojectfullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the project, group, or namespace. For example, `gitlab-org/gitlab-foss`. |
|
|
|
|
### `Query.projects`
|
|
|
|
Find projects visible to the current user.
|
|
|
|
Returns [`ProjectConnection`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryprojectsids"></a>`ids` | [`[ID!]`](#id) | Filter projects by IDs. |
|
|
| <a id="queryprojectsmembership"></a>`membership` | [`Boolean`](#boolean) | Limit projects that the current user is a member of. |
|
|
| <a id="queryprojectssearch"></a>`search` | [`String`](#string) | Search query for project name, path, or description. |
|
|
| <a id="queryprojectssearchnamespaces"></a>`searchNamespaces` | [`Boolean`](#boolean) | Include namespace in project search. |
|
|
| <a id="queryprojectssort"></a>`sort` | [`String`](#string) | Sort order of results. |
|
|
| <a id="queryprojectstopics"></a>`topics` | [`[String!]`](#string) | Filters projects by topics. |
|
|
|
|
### `Query.queryComplexity`
|
|
|
|
Information about the complexity of the GraphQL query.
|
|
|
|
Returns [`QueryComplexity`](#querycomplexity).
|
|
|
|
### `Query.runner`
|
|
|
|
Find a runner.
|
|
|
|
Returns [`CiRunner`](#cirunner).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryrunnerid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | Runner ID. |
|
|
|
|
### `Query.runnerPlatforms`
|
|
|
|
Supported runner platforms.
|
|
|
|
Returns [`RunnerPlatformConnection`](#runnerplatformconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
### `Query.runnerSetup`
|
|
|
|
Runner setup instructions.
|
|
|
|
Returns [`RunnerSetup`](#runnersetup).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryrunnersetuparchitecture"></a>`architecture` | [`String!`](#string) | Architecture to generate the instructions for. |
|
|
| <a id="queryrunnersetupgroupid"></a>`groupId` **{warning-solid}** | [`GroupID`](#groupid) | **Deprecated** in 13.11. No longer used. |
|
|
| <a id="queryrunnersetupplatform"></a>`platform` | [`String!`](#string) | Platform to generate the instructions for. |
|
|
| <a id="queryrunnersetupprojectid"></a>`projectId` **{warning-solid}** | [`ProjectID`](#projectid) | **Deprecated** in 13.11. No longer used. |
|
|
|
|
### `Query.runners`
|
|
|
|
Find runners visible to the current user.
|
|
|
|
Returns [`CiRunnerConnection`](#cirunnerconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryrunnersactive"></a>`active` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated** in 14.8. This was renamed. Use: `paused`. |
|
|
| <a id="queryrunnerspaused"></a>`paused` | [`Boolean`](#boolean) | Filter runners by `paused` (true) or `active` (false) status. |
|
|
| <a id="queryrunnerssearch"></a>`search` | [`String`](#string) | Filter by full token or partial text in description field. |
|
|
| <a id="queryrunnerssort"></a>`sort` | [`CiRunnerSort`](#cirunnersort) | Sort order of results. |
|
|
| <a id="queryrunnersstatus"></a>`status` | [`CiRunnerStatus`](#cirunnerstatus) | Filter runners by status. |
|
|
| <a id="queryrunnerstaglist"></a>`tagList` | [`[String!]`](#string) | Filter by tags associated with the runner (comma-separated or array). |
|
|
| <a id="queryrunnerstype"></a>`type` | [`CiRunnerType`](#cirunnertype) | Filter runners by type. |
|
|
|
|
### `Query.snippets`
|
|
|
|
Find Snippets visible to the current user.
|
|
|
|
Returns [`SnippetConnection`](#snippetconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querysnippetsauthorid"></a>`authorId` | [`UserID`](#userid) | ID of an author. |
|
|
| <a id="querysnippetsexplore"></a>`explore` | [`Boolean`](#boolean) | Explore personal snippets. |
|
|
| <a id="querysnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. |
|
|
| <a id="querysnippetsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | ID of a project. |
|
|
| <a id="querysnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | Type of snippet. |
|
|
| <a id="querysnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. |
|
|
|
|
### `Query.subscriptionFutureEntries`
|
|
|
|
Fields related to entries in future subscriptions.
|
|
|
|
Returns [`SubscriptionFutureEntryConnection`](#subscriptionfutureentryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
### `Query.timelogs`
|
|
|
|
Find timelogs visible to the current user.
|
|
|
|
Returns [`TimelogConnection`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querytimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="querytimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="querytimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="querytimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="querytimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="querytimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="querytimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
### `Query.topics`
|
|
|
|
Find project topics.
|
|
|
|
Returns [`TopicConnection`](#topicconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querytopicssearch"></a>`search` | [`String`](#string) | Search query for topic name. |
|
|
|
|
### `Query.usageTrendsMeasurements`
|
|
|
|
Get statistics on the instance.
|
|
|
|
Returns [`UsageTrendsMeasurementConnection`](#usagetrendsmeasurementconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryusagetrendsmeasurementsidentifier"></a>`identifier` | [`MeasurementIdentifier!`](#measurementidentifier) | Type of measurement or statistics to retrieve. |
|
|
| <a id="queryusagetrendsmeasurementsrecordedafter"></a>`recordedAfter` | [`Time`](#time) | Measurement recorded after this date. |
|
|
| <a id="queryusagetrendsmeasurementsrecordedbefore"></a>`recordedBefore` | [`Time`](#time) | Measurement recorded before this date. |
|
|
|
|
### `Query.user`
|
|
|
|
Find a user.
|
|
|
|
Returns [`UserCore`](#usercore).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryuserid"></a>`id` | [`UserID`](#userid) | ID of the User. |
|
|
| <a id="queryuserusername"></a>`username` | [`String`](#string) | Username of the User. |
|
|
|
|
### `Query.users`
|
|
|
|
Find users.
|
|
|
|
Returns [`UserCoreConnection`](#usercoreconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryusersadmins"></a>`admins` | [`Boolean`](#boolean) | Return only admin users. |
|
|
| <a id="queryusersids"></a>`ids` | [`[ID!]`](#id) | List of user Global IDs. |
|
|
| <a id="queryuserssearch"></a>`search` | [`String`](#string) | Query to search users by name, username, or primary email. |
|
|
| <a id="queryuserssort"></a>`sort` | [`Sort`](#sort) | Sort users by this criteria. |
|
|
| <a id="queryusersusernames"></a>`usernames` | [`[String!]`](#string) | List of usernames. |
|
|
|
|
### `Query.vulnerabilities`
|
|
|
|
Vulnerabilities reported on projects on the current user's instance security dashboard.
|
|
|
|
Returns [`VulnerabilityConnection`](#vulnerabilityconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryvulnerabilitiesclusteragentid"></a>`clusterAgentId` | [`[ClustersAgentID!]`](#clustersagentid) | Filter vulnerabilities by `cluster_agent_id`. Vulnerabilities with a `reportType` of `cluster_image_scanning` are only included with this filter. |
|
|
| <a id="queryvulnerabilitiesclusterid"></a>`clusterId` | [`[ClustersClusterID!]`](#clustersclusterid) | Filter vulnerabilities by `cluster_id`. Vulnerabilities with a `reportType` of `cluster_image_scanning` are only included with this filter. |
|
|
| <a id="queryvulnerabilitieshasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have linked issues. |
|
|
| <a id="queryvulnerabilitieshasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have been resolved on default branch. |
|
|
| <a id="queryvulnerabilitiesimage"></a>`image` | [`[String!]`](#string) | Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a `reportType` that includes `container_scanning`, `cluster_image_scanning`. |
|
|
| <a id="queryvulnerabilitiesprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. |
|
|
| <a id="queryvulnerabilitiesreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. |
|
|
| <a id="queryvulnerabilitiesscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by VulnerabilityScanner.externalId. |
|
|
| <a id="queryvulnerabilitiesscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. |
|
|
| <a id="queryvulnerabilitiesseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. |
|
|
| <a id="queryvulnerabilitiessort"></a>`sort` | [`VulnerabilitySort`](#vulnerabilitysort) | List vulnerabilities by sort order. |
|
|
| <a id="queryvulnerabilitiesstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. |
|
|
|
|
### `Query.vulnerabilitiesCountByDay`
|
|
|
|
The historical number of vulnerabilities per day for the projects on the current user's instance security dashboard.
|
|
|
|
Returns [`VulnerabilitiesCountByDayConnection`](#vulnerabilitiescountbydayconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryvulnerabilitiescountbydayenddate"></a>`endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. |
|
|
| <a id="queryvulnerabilitiescountbydaystartdate"></a>`startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. |
|
|
|
|
### `Query.vulnerability`
|
|
|
|
Find a vulnerability.
|
|
|
|
Returns [`Vulnerability`](#vulnerability).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryvulnerabilityid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | Global ID of the Vulnerability. |
|
|
|
|
### `Query.workItem`
|
|
|
|
Find a work item. Returns `null` if `work_items` feature flag is disabled.
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.1.
|
|
This feature is in Alpha, and can be removed or changed at any point.
|
|
|
|
Returns [`WorkItem`](#workitem).
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="queryworkitemid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the work item. |
|
|
|
|
## `Mutation` type
|
|
|
|
The `Mutation` type contains all the mutations you can execute.
|
|
|
|
All mutations receive their arguments in a single input object named `input`, and all mutations
|
|
support at least a return field `errors` containing a list of error messages.
|
|
|
|
All input objects may have a `clientMutationId: String` field, identifying the mutation.
|
|
|
|
For example:
|
|
|
|
```graphql
|
|
mutation($id: NoteableID!, $body: String!) {
|
|
createNote(input: { noteableId: $id, body: $body }) {
|
|
errors
|
|
}
|
|
}
|
|
```
|
|
|
|
### `Mutation.addProjectToSecurityDashboard`
|
|
|
|
Input type: `AddProjectToSecurityDashboardInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationaddprojecttosecuritydashboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationaddprojecttosecuritydashboardid"></a>`id` | [`ProjectID!`](#projectid) | ID of the project to be added to Instance Security Dashboard. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationaddprojecttosecuritydashboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationaddprojecttosecuritydashboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationaddprojecttosecuritydashboardproject"></a>`project` | [`Project`](#project) | Project that was added to the Instance Security Dashboard. |
|
|
|
|
### `Mutation.adminSidekiqQueuesDeleteJobs`
|
|
|
|
Input type: `AdminSidekiqQueuesDeleteJobsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsartifactsize"></a>`artifactSize` | [`String`](#string) | Delete jobs matching artifact_size in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobscallerid"></a>`callerId` | [`String`](#string) | Delete jobs matching caller_id in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsclientid"></a>`clientId` | [`String`](#string) | Delete jobs matching client_id in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsfeaturecategory"></a>`featureCategory` | [`String`](#string) | Delete jobs matching feature_category in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsjobid"></a>`jobId` | [`String`](#string) | Delete jobs matching job_id in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobspipelineid"></a>`pipelineId` | [`String`](#string) | Delete jobs matching pipeline_id in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsproject"></a>`project` | [`String`](#string) | Delete jobs matching project in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsqueuename"></a>`queueName` | [`String!`](#string) | Name of the queue to delete jobs from. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsrelatedclass"></a>`relatedClass` | [`String`](#string) | Delete jobs matching related_class in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsremoteip"></a>`remoteIp` | [`String`](#string) | Delete jobs matching remote_ip in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsrootcallerid"></a>`rootCallerId` | [`String`](#string) | Delete jobs matching root_caller_id in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsrootnamespace"></a>`rootNamespace` | [`String`](#string) | Delete jobs matching root_namespace in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobssubscriptionplan"></a>`subscriptionPlan` | [`String`](#string) | Delete jobs matching subscription_plan in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsuser"></a>`user` | [`String`](#string) | Delete jobs matching user in the context metadata. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsworkerclass"></a>`workerClass` | [`String`](#string) | Delete jobs with the given worker class. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationadminsidekiqqueuesdeletejobsresult"></a>`result` | [`DeleteJobsResponse`](#deletejobsresponse) | Information about the status of the deletion request. |
|
|
|
|
### `Mutation.alertSetAssignees`
|
|
|
|
Input type: `AlertSetAssigneesInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationalertsetassigneesassigneeusernames"></a>`assigneeUsernames` | [`[String!]!`](#string) | Usernames to assign to the alert. Replaces existing assignees by default. |
|
|
| <a id="mutationalertsetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationalertsetassigneesiid"></a>`iid` | [`String!`](#string) | IID of the alert to mutate. |
|
|
| <a id="mutationalertsetassigneesoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | Operation to perform. Defaults to REPLACE. |
|
|
| <a id="mutationalertsetassigneesprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the alert to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationalertsetassigneesalert"></a>`alert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert after mutation. |
|
|
| <a id="mutationalertsetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationalertsetassigneeserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationalertsetassigneesissue"></a>`issue` | [`Issue`](#issue) | Issue created after mutation. |
|
|
| <a id="mutationalertsetassigneestodo"></a>`todo` | [`Todo`](#todo) | To-do item after mutation. |
|
|
|
|
### `Mutation.alertTodoCreate`
|
|
|
|
Input type: `AlertTodoCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationalerttodocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationalerttodocreateiid"></a>`iid` | [`String!`](#string) | IID of the alert to mutate. |
|
|
| <a id="mutationalerttodocreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the alert to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationalerttodocreatealert"></a>`alert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert after mutation. |
|
|
| <a id="mutationalerttodocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationalerttodocreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationalerttodocreateissue"></a>`issue` | [`Issue`](#issue) | Issue created after mutation. |
|
|
| <a id="mutationalerttodocreatetodo"></a>`todo` | [`Todo`](#todo) | To-do item after mutation. |
|
|
|
|
### `Mutation.apiFuzzingCiConfigurationCreate`
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.1.
|
|
The configuration snippet is now generated client-side.
|
|
|
|
Input type: `ApiFuzzingCiConfigurationCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationapifuzzingciconfigurationcreateapispecificationfile"></a>`apiSpecificationFile` | [`String!`](#string) | File path or URL to the file that defines the API surface for scanning. Must be in the format specified by the `scanMode` argument. |
|
|
| <a id="mutationapifuzzingciconfigurationcreateauthpassword"></a>`authPassword` | [`String`](#string) | CI variable containing the password for authenticating with the target API. |
|
|
| <a id="mutationapifuzzingciconfigurationcreateauthusername"></a>`authUsername` | [`String`](#string) | CI variable containing the username for authenticating with the target API. |
|
|
| <a id="mutationapifuzzingciconfigurationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationapifuzzingciconfigurationcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. |
|
|
| <a id="mutationapifuzzingciconfigurationcreatescanmode"></a>`scanMode` | [`ApiFuzzingScanMode!`](#apifuzzingscanmode) | Mode for API fuzzing scans. |
|
|
| <a id="mutationapifuzzingciconfigurationcreatescanprofile"></a>`scanProfile` | [`String`](#string) | Name of a default profile to use for scanning. Ex: Quick-10. |
|
|
| <a id="mutationapifuzzingciconfigurationcreatetarget"></a>`target` | [`String!`](#string) | URL for the target of API fuzzing scans. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationapifuzzingciconfigurationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationapifuzzingciconfigurationcreateconfigurationyaml"></a>`configurationYaml` **{warning-solid}** | [`String`](#string) | **Deprecated:** The configuration snippet is now generated client-side. Deprecated in 14.6. |
|
|
| <a id="mutationapifuzzingciconfigurationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationapifuzzingciconfigurationcreategitlabciyamleditpath"></a>`gitlabCiYamlEditPath` **{warning-solid}** | [`String`](#string) | **Deprecated:** The configuration snippet is now generated client-side. Deprecated in 14.6. |
|
|
|
|
### `Mutation.awardEmojiAdd`
|
|
|
|
Input type: `AwardEmojiAddInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationawardemojiaddawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | Global ID of the awardable resource. |
|
|
| <a id="mutationawardemojiaddclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationawardemojiaddname"></a>`name` | [`String!`](#string) | Emoji name. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationawardemojiaddawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | Award emoji after mutation. |
|
|
| <a id="mutationawardemojiaddclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationawardemojiadderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.awardEmojiRemove`
|
|
|
|
Input type: `AwardEmojiRemoveInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationawardemojiremoveawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | Global ID of the awardable resource. |
|
|
| <a id="mutationawardemojiremoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationawardemojiremovename"></a>`name` | [`String!`](#string) | Emoji name. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationawardemojiremoveawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | Award emoji after mutation. |
|
|
| <a id="mutationawardemojiremoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationawardemojiremoveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.awardEmojiToggle`
|
|
|
|
Input type: `AwardEmojiToggleInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationawardemojitoggleawardableid"></a>`awardableId` | [`AwardableID!`](#awardableid) | Global ID of the awardable resource. |
|
|
| <a id="mutationawardemojitoggleclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationawardemojitogglename"></a>`name` | [`String!`](#string) | Emoji name. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationawardemojitoggleawardemoji"></a>`awardEmoji` | [`AwardEmoji`](#awardemoji) | Award emoji after mutation. |
|
|
| <a id="mutationawardemojitoggleclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationawardemojitoggleerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationawardemojitoggletoggledon"></a>`toggledOn` | [`Boolean!`](#boolean) | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. |
|
|
|
|
### `Mutation.boardEpicCreate`
|
|
|
|
Input type: `BoardEpicCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationboardepiccreateboardid"></a>`boardId` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the board that the epic is in. |
|
|
| <a id="mutationboardepiccreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationboardepiccreategrouppath"></a>`groupPath` | [`ID!`](#id) | Group the epic to create is in. |
|
|
| <a id="mutationboardepiccreatelistid"></a>`listId` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the epic board list in which epic will be created. |
|
|
| <a id="mutationboardepiccreatetitle"></a>`title` | [`String!`](#string) | Title of the epic. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationboardepiccreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationboardepiccreateepic"></a>`epic` | [`Epic`](#epic) | Epic after creation. |
|
|
| <a id="mutationboardepiccreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.boardListCreate`
|
|
|
|
Input type: `BoardListCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationboardlistcreateassigneeid"></a>`assigneeId` | [`UserID`](#userid) | Global ID of an existing user. |
|
|
| <a id="mutationboardlistcreatebacklog"></a>`backlog` | [`Boolean`](#boolean) | Create the backlog list. |
|
|
| <a id="mutationboardlistcreateboardid"></a>`boardId` | [`BoardID!`](#boardid) | Global ID of the issue board to mutate. |
|
|
| <a id="mutationboardlistcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationboardlistcreateiterationid"></a>`iterationId` | [`IterationID`](#iterationid) | Global ID of an existing iteration. |
|
|
| <a id="mutationboardlistcreatelabelid"></a>`labelId` | [`LabelID`](#labelid) | Global ID of an existing label. |
|
|
| <a id="mutationboardlistcreatemilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | Global ID of an existing milestone. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationboardlistcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationboardlistcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationboardlistcreatelist"></a>`list` | [`BoardList`](#boardlist) | Issue list in the issue board. |
|
|
|
|
### `Mutation.boardListUpdateLimitMetrics`
|
|
|
|
Input type: `BoardListUpdateLimitMetricsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationboardlistupdatelimitmetricsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationboardlistupdatelimitmetricslimitmetric"></a>`limitMetric` | [`ListLimitMetric`](#listlimitmetric) | New limit metric type for the list. |
|
|
| <a id="mutationboardlistupdatelimitmetricslistid"></a>`listId` | [`ListID!`](#listid) | Global ID of the list. |
|
|
| <a id="mutationboardlistupdatelimitmetricsmaxissuecount"></a>`maxIssueCount` | [`Int`](#int) | New maximum issue count limit. |
|
|
| <a id="mutationboardlistupdatelimitmetricsmaxissueweight"></a>`maxIssueWeight` | [`Int`](#int) | New maximum issue weight limit. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationboardlistupdatelimitmetricsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationboardlistupdatelimitmetricserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationboardlistupdatelimitmetricslist"></a>`list` | [`BoardList`](#boardlist) | Updated list. |
|
|
|
|
### `Mutation.bulkEnableDevopsAdoptionNamespaces`
|
|
|
|
**BETA** This endpoint is subject to change without notice.
|
|
|
|
Input type: `BulkEnableDevopsAdoptionNamespacesInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationbulkenabledevopsadoptionnamespacesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationbulkenabledevopsadoptionnamespacesdisplaynamespaceid"></a>`displayNamespaceId` | [`NamespaceID`](#namespaceid) | Display namespace ID. |
|
|
| <a id="mutationbulkenabledevopsadoptionnamespacesnamespaceids"></a>`namespaceIds` | [`[NamespaceID!]!`](#namespaceid) | List of Namespace IDs. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationbulkenabledevopsadoptionnamespacesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationbulkenabledevopsadoptionnamespacesenablednamespaces"></a>`enabledNamespaces` | [`[DevopsAdoptionEnabledNamespace!]`](#devopsadoptionenablednamespace) | Enabled namespaces after mutation. |
|
|
| <a id="mutationbulkenabledevopsadoptionnamespaceserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.ciCdSettingsUpdate`
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.0.
|
|
This was renamed.
|
|
Use: `ProjectCiCdSettingsUpdate`.
|
|
|
|
Input type: `CiCdSettingsUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcicdsettingsupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcicdsettingsupdatefullpath"></a>`fullPath` | [`ID!`](#id) | Full Path of the project the settings belong to. |
|
|
| <a id="mutationcicdsettingsupdatejobtokenscopeenabled"></a>`jobTokenScopeEnabled` | [`Boolean`](#boolean) | Indicates CI job tokens generated in this project have restricted access to resources. |
|
|
| <a id="mutationcicdsettingsupdatekeeplatestartifact"></a>`keepLatestArtifact` | [`Boolean`](#boolean) | Indicates if the latest artifact should be kept for this project. |
|
|
| <a id="mutationcicdsettingsupdatemergepipelinesenabled"></a>`mergePipelinesEnabled` | [`Boolean`](#boolean) | Indicates if merge pipelines are enabled for the project. |
|
|
| <a id="mutationcicdsettingsupdatemergetrainsenabled"></a>`mergeTrainsEnabled` | [`Boolean`](#boolean) | Indicates if merge trains are enabled for the project. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcicdsettingsupdatecicdsettings"></a>`ciCdSettings` | [`ProjectCiCdSetting!`](#projectcicdsetting) | CI/CD settings after mutation. |
|
|
| <a id="mutationcicdsettingsupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcicdsettingsupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.ciJobTokenScopeAddProject`
|
|
|
|
Input type: `CiJobTokenScopeAddProjectInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcijobtokenscopeaddprojectclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcijobtokenscopeaddprojectprojectpath"></a>`projectPath` | [`ID!`](#id) | Project that the CI job token scope belongs to. |
|
|
| <a id="mutationcijobtokenscopeaddprojecttargetprojectpath"></a>`targetProjectPath` | [`ID!`](#id) | Project to be added to the CI job token scope. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcijobtokenscopeaddprojectcijobtokenscope"></a>`ciJobTokenScope` | [`CiJobTokenScopeType`](#cijobtokenscopetype) | CI job token's scope of access. |
|
|
| <a id="mutationcijobtokenscopeaddprojectclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcijobtokenscopeaddprojecterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.ciJobTokenScopeRemoveProject`
|
|
|
|
Input type: `CiJobTokenScopeRemoveProjectInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcijobtokenscoperemoveprojectclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcijobtokenscoperemoveprojectprojectpath"></a>`projectPath` | [`ID!`](#id) | Project that the CI job token scope belongs to. |
|
|
| <a id="mutationcijobtokenscoperemoveprojecttargetprojectpath"></a>`targetProjectPath` | [`ID!`](#id) | Project to be removed from the CI job token scope. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcijobtokenscoperemoveprojectcijobtokenscope"></a>`ciJobTokenScope` | [`CiJobTokenScopeType`](#cijobtokenscopetype) | CI job token's scope of access. |
|
|
| <a id="mutationcijobtokenscoperemoveprojectclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcijobtokenscoperemoveprojecterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.clusterAgentDelete`
|
|
|
|
Input type: `ClusterAgentDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationclusteragentdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationclusteragentdeleteid"></a>`id` | [`ClustersAgentID!`](#clustersagentid) | Global ID of the cluster agent that will be deleted. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationclusteragentdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationclusteragentdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.clusterAgentTokenCreate`
|
|
|
|
Input type: `ClusterAgentTokenCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationclusteragenttokencreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationclusteragenttokencreateclusteragentid"></a>`clusterAgentId` | [`ClustersAgentID!`](#clustersagentid) | Global ID of the cluster agent that will be associated with the new token. |
|
|
| <a id="mutationclusteragenttokencreatedescription"></a>`description` | [`String`](#string) | Description of the token. |
|
|
| <a id="mutationclusteragenttokencreatename"></a>`name` | [`String!`](#string) | Name of the token. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationclusteragenttokencreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationclusteragenttokencreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationclusteragenttokencreatesecret"></a>`secret` | [`String`](#string) | Token secret value. Make sure you save it - you won't be able to access it again. |
|
|
| <a id="mutationclusteragenttokencreatetoken"></a>`token` | [`ClusterAgentToken`](#clusteragenttoken) | Token created after mutation. |
|
|
|
|
### `Mutation.clusterAgentTokenRevoke`
|
|
|
|
Input type: `ClusterAgentTokenRevokeInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationclusteragenttokenrevokeclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationclusteragenttokenrevokeid"></a>`id` | [`ClustersAgentTokenID!`](#clustersagenttokenid) | Global ID of the agent token that will be revoked. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationclusteragenttokenrevokeclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationclusteragenttokenrevokeerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.commitCreate`
|
|
|
|
Input type: `CommitCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcommitcreateactions"></a>`actions` | [`[CommitAction!]!`](#commitaction) | Array of action hashes to commit as a batch. |
|
|
| <a id="mutationcommitcreatebranch"></a>`branch` | [`String!`](#string) | Name of the branch to commit into, it can be a new branch. |
|
|
| <a id="mutationcommitcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcommitcreatemessage"></a>`message` | [`String!`](#string) | Raw commit message. |
|
|
| <a id="mutationcommitcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path the branch is associated with. |
|
|
| <a id="mutationcommitcreatestartbranch"></a>`startBranch` | [`String`](#string) | If on a new branch, name of the original branch. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcommitcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcommitcreatecommit"></a>`commit` | [`Commit`](#commit) | Commit after mutation. |
|
|
| <a id="mutationcommitcreatecommitpipelinepath"></a>`commitPipelinePath` | [`String`](#string) | ETag path for the commit's pipeline. |
|
|
| <a id="mutationcommitcreatecontent"></a>`content` | [`[String!]`](#string) | Contents of the commit. |
|
|
| <a id="mutationcommitcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.configureContainerScanning`
|
|
|
|
Configure Container Scanning for a project by enabling Container Scanning in a new or modified
|
|
`.gitlab-ci.yml` file in a new branch. The new branch and a URL to
|
|
create a merge request are part of the response.
|
|
|
|
Input type: `ConfigureContainerScanningInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfigurecontainerscanningclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfigurecontainerscanningprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfigurecontainerscanningbranch"></a>`branch` | [`String`](#string) | Branch that has the new/modified `.gitlab-ci.yml` file. |
|
|
| <a id="mutationconfigurecontainerscanningclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfigurecontainerscanningerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationconfigurecontainerscanningsuccesspath"></a>`successPath` | [`String`](#string) | Redirect path to use when the response is successful. |
|
|
|
|
### `Mutation.configureDependencyScanning`
|
|
|
|
Configure Dependency Scanning for a project by enabling Dependency Scanning in a new or modified
|
|
`.gitlab-ci.yml` file in a new branch. The new branch and a URL to
|
|
create a Merge Request are a part of the response.
|
|
|
|
Input type: `ConfigureDependencyScanningInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfiguredependencyscanningclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfiguredependencyscanningprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfiguredependencyscanningbranch"></a>`branch` | [`String`](#string) | Branch that has the new/modified `.gitlab-ci.yml` file. |
|
|
| <a id="mutationconfiguredependencyscanningclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfiguredependencyscanningerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationconfiguredependencyscanningsuccesspath"></a>`successPath` | [`String`](#string) | Redirect path to use when the response is successful. |
|
|
|
|
### `Mutation.configureSast`
|
|
|
|
Configure SAST for a project by enabling SAST in a new or modified
|
|
`.gitlab-ci.yml` file in a new branch. The new branch and a URL to
|
|
create a Merge Request are a part of the response.
|
|
|
|
Input type: `ConfigureSastInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfiguresastclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfiguresastconfiguration"></a>`configuration` | [`SastCiConfigurationInput!`](#sastciconfigurationinput) | SAST CI configuration for the project. |
|
|
| <a id="mutationconfiguresastprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfiguresastbranch"></a>`branch` | [`String`](#string) | Branch that has the new/modified `.gitlab-ci.yml` file. |
|
|
| <a id="mutationconfiguresastclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfiguresasterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationconfiguresastsuccesspath"></a>`successPath` | [`String`](#string) | Redirect path to use when the response is successful. |
|
|
|
|
### `Mutation.configureSastIac`
|
|
|
|
Enable SAST IaC for a project in a new or
|
|
modified `.gitlab-ci.yml` file in a new branch. The new
|
|
branch and a URL to create a merge request are a part of the
|
|
response.
|
|
|
|
Input type: `ConfigureSastIacInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfiguresastiacclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfiguresastiacprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfiguresastiacbranch"></a>`branch` | [`String`](#string) | Branch that has the new/modified `.gitlab-ci.yml` file. |
|
|
| <a id="mutationconfiguresastiacclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfiguresastiacerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationconfiguresastiacsuccesspath"></a>`successPath` | [`String`](#string) | Redirect path to use when the response is successful. |
|
|
|
|
### `Mutation.configureSecretDetection`
|
|
|
|
Configure Secret Detection for a project by enabling Secret Detection
|
|
in a new or modified `.gitlab-ci.yml` file in a new branch. The new
|
|
branch and a URL to create a Merge Request are a part of the
|
|
response.
|
|
|
|
Input type: `ConfigureSecretDetectionInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfiguresecretdetectionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfiguresecretdetectionprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationconfiguresecretdetectionbranch"></a>`branch` | [`String`](#string) | Branch that has the new/modified `.gitlab-ci.yml` file. |
|
|
| <a id="mutationconfiguresecretdetectionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationconfiguresecretdetectionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationconfiguresecretdetectionsuccesspath"></a>`successPath` | [`String`](#string) | Redirect path to use when the response is successful. |
|
|
|
|
### `Mutation.corpusCreate`
|
|
|
|
Input type: `CorpusCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcorpuscreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcorpuscreatefullpath"></a>`fullPath` | [`ID!`](#id) | Project the corpus belongs to. |
|
|
| <a id="mutationcorpuscreatepackageid"></a>`packageId` | [`PackagesPackageID!`](#packagespackageid) | ID of the corpus package. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcorpuscreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcorpuscreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.createAlertIssue`
|
|
|
|
Input type: `CreateAlertIssueInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatealertissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatealertissueiid"></a>`iid` | [`String!`](#string) | IID of the alert to mutate. |
|
|
| <a id="mutationcreatealertissueprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the alert to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatealertissuealert"></a>`alert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert after mutation. |
|
|
| <a id="mutationcreatealertissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatealertissueerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreatealertissueissue"></a>`issue` | [`Issue`](#issue) | Issue created after mutation. |
|
|
| <a id="mutationcreatealertissuetodo"></a>`todo` | [`Todo`](#todo) | To-do item after mutation. |
|
|
|
|
### `Mutation.createAnnotation`
|
|
|
|
Input type: `CreateAnnotationInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateannotationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateannotationclusterid"></a>`clusterId` | [`ClustersClusterID`](#clustersclusterid) | Global ID of the cluster to add an annotation to. |
|
|
| <a id="mutationcreateannotationdashboardpath"></a>`dashboardPath` | [`String!`](#string) | Path to a file defining the dashboard on which the annotation should be added. |
|
|
| <a id="mutationcreateannotationdescription"></a>`description` | [`String!`](#string) | Description of the annotation. |
|
|
| <a id="mutationcreateannotationendingat"></a>`endingAt` | [`Time`](#time) | Timestamp indicating ending moment to which the annotation relates. |
|
|
| <a id="mutationcreateannotationenvironmentid"></a>`environmentId` | [`EnvironmentID`](#environmentid) | Global ID of the environment to add an annotation to. |
|
|
| <a id="mutationcreateannotationstartingat"></a>`startingAt` | [`Time!`](#time) | Timestamp indicating starting moment to which the annotation relates. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateannotationannotation"></a>`annotation` | [`MetricsDashboardAnnotation`](#metricsdashboardannotation) | Created annotation. |
|
|
| <a id="mutationcreateannotationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateannotationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.createBoard`
|
|
|
|
Input type: `CreateBoardInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateboardassigneeid"></a>`assigneeId` | [`UserID`](#userid) | ID of user to be assigned to the board. |
|
|
| <a id="mutationcreateboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateboardgrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. |
|
|
| <a id="mutationcreateboardhidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. |
|
|
| <a id="mutationcreateboardhideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. |
|
|
| <a id="mutationcreateboarditerationcadenceid"></a>`iterationCadenceId` | [`IterationsCadenceID`](#iterationscadenceid) | ID of iteration cadence to be assigned to the board. |
|
|
| <a id="mutationcreateboarditerationid"></a>`iterationId` | [`IterationID`](#iterationid) | ID of iteration to be assigned to the board. |
|
|
| <a id="mutationcreateboardlabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the board. |
|
|
| <a id="mutationcreateboardlabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. |
|
|
| <a id="mutationcreateboardmilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | ID of milestone to be assigned to the board. |
|
|
| <a id="mutationcreateboardname"></a>`name` | [`String`](#string) | Board name. |
|
|
| <a id="mutationcreateboardprojectpath"></a>`projectPath` | [`ID`](#id) | Full path of the project with which the resource is associated. |
|
|
| <a id="mutationcreateboardweight"></a>`weight` | [`Int`](#int) | Weight value to be assigned to the board. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateboardboard"></a>`board` | [`Board`](#board) | Board after mutation. |
|
|
| <a id="mutationcreateboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.createBranch`
|
|
|
|
Input type: `CreateBranchInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatebranchclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatebranchname"></a>`name` | [`String!`](#string) | Name of the branch. |
|
|
| <a id="mutationcreatebranchprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path the branch is associated with. |
|
|
| <a id="mutationcreatebranchref"></a>`ref` | [`String!`](#string) | Branch name or commit SHA to create branch from. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatebranchbranch"></a>`branch` | [`Branch`](#branch) | Branch after mutation. |
|
|
| <a id="mutationcreatebranchclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatebrancherrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.createClusterAgent`
|
|
|
|
Input type: `CreateClusterAgentInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateclusteragentclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateclusteragentname"></a>`name` | [`String!`](#string) | Name of the cluster agent. |
|
|
| <a id="mutationcreateclusteragentprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the associated project for this cluster agent. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateclusteragentclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateclusteragentclusteragent"></a>`clusterAgent` | [`ClusterAgent`](#clusteragent) | Cluster agent created after mutation. |
|
|
| <a id="mutationcreateclusteragenterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.createComplianceFramework`
|
|
|
|
Input type: `CreateComplianceFrameworkInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatecomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatecomplianceframeworknamespacepath"></a>`namespacePath` | [`ID!`](#id) | Full path of the namespace to add the compliance framework to. |
|
|
| <a id="mutationcreatecomplianceframeworkparams"></a>`params` | [`ComplianceFrameworkInput!`](#complianceframeworkinput) | Parameters to update the compliance framework with. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatecomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatecomplianceframeworkerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreatecomplianceframeworkframework"></a>`framework` | [`ComplianceFramework`](#complianceframework) | Created compliance framework. |
|
|
|
|
### `Mutation.createCustomEmoji`
|
|
|
|
Available only when feature flag `custom_emoji` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
|
|
|
|
Input type: `CreateCustomEmojiInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatecustomemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatecustomemojigrouppath"></a>`groupPath` | [`ID!`](#id) | Namespace full path the emoji is associated with. |
|
|
| <a id="mutationcreatecustomemojiname"></a>`name` | [`String!`](#string) | Name of the emoji. |
|
|
| <a id="mutationcreatecustomemojiurl"></a>`url` | [`String!`](#string) | Location of the emoji file. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatecustomemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatecustomemojicustomemoji"></a>`customEmoji` | [`CustomEmoji`](#customemoji) | New custom emoji. |
|
|
| <a id="mutationcreatecustomemojierrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.createDiffNote`
|
|
|
|
Input type: `CreateDiffNoteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatediffnotebody"></a>`body` | [`String!`](#string) | Content of the note. |
|
|
| <a id="mutationcreatediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatediffnoteconfidential"></a>`confidential` | [`Boolean`](#boolean) | Confidentiality flag of a note. Default is false. |
|
|
| <a id="mutationcreatediffnotenoteableid"></a>`noteableId` | [`NoteableID!`](#noteableid) | Global ID of the resource to add a note to. |
|
|
| <a id="mutationcreatediffnoteposition"></a>`position` | [`DiffPositionInput!`](#diffpositioninput) | Position of this note on a diff. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatediffnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreatediffnotenote"></a>`note` | [`Note`](#note) | Note after mutation. |
|
|
|
|
### `Mutation.createEpic`
|
|
|
|
Input type: `CreateEpicInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateepicaddlabelids"></a>`addLabelIds` | [`[ID!]`](#id) | IDs of labels to be added to the epic. |
|
|
| <a id="mutationcreateepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateepiccolor"></a>`color` | [`Color`](#color) | Color of the epic. Available only when feature flag `epic_color_highlight` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
|
|
| <a id="mutationcreateepicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. |
|
|
| <a id="mutationcreateepicdescription"></a>`description` | [`String`](#string) | Description of the epic. |
|
|
| <a id="mutationcreateepicduedatefixed"></a>`dueDateFixed` | [`String`](#string) | End date of the epic. |
|
|
| <a id="mutationcreateepicduedateisfixed"></a>`dueDateIsFixed` | [`Boolean`](#boolean) | Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
|
|
| <a id="mutationcreateepicgrouppath"></a>`groupPath` | [`ID!`](#id) | Group the epic to mutate is in. |
|
|
| <a id="mutationcreateepicremovelabelids"></a>`removeLabelIds` | [`[ID!]`](#id) | IDs of labels to be removed from the epic. |
|
|
| <a id="mutationcreateepicstartdatefixed"></a>`startDateFixed` | [`String`](#string) | Start date of the epic. |
|
|
| <a id="mutationcreateepicstartdateisfixed"></a>`startDateIsFixed` | [`Boolean`](#boolean) | Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
|
|
| <a id="mutationcreateepictitle"></a>`title` | [`String`](#string) | Title of the epic. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateepicepic"></a>`epic` | [`Epic`](#epic) | Created epic. |
|
|
| <a id="mutationcreateepicerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.createImageDiffNote`
|
|
|
|
Input type: `CreateImageDiffNoteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateimagediffnotebody"></a>`body` | [`String!`](#string) | Content of the note. |
|
|
| <a id="mutationcreateimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateimagediffnoteconfidential"></a>`confidential` | [`Boolean`](#boolean) | Confidentiality flag of a note. Default is false. |
|
|
| <a id="mutationcreateimagediffnotenoteableid"></a>`noteableId` | [`NoteableID!`](#noteableid) | Global ID of the resource to add a note to. |
|
|
| <a id="mutationcreateimagediffnoteposition"></a>`position` | [`DiffImagePositionInput!`](#diffimagepositioninput) | Position of this note on a diff. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateimagediffnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreateimagediffnotenote"></a>`note` | [`Note`](#note) | Note after mutation. |
|
|
|
|
### `Mutation.createIssue`
|
|
|
|
Input type: `CreateIssueInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateissueassigneeids"></a>`assigneeIds` | [`[UserID!]`](#userid) | Array of user IDs to assign to the issue. |
|
|
| <a id="mutationcreateissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateissueconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates the issue is confidential. |
|
|
| <a id="mutationcreateissuecreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the issue was created. Available only for admins and project owners. |
|
|
| <a id="mutationcreateissuedescription"></a>`description` | [`String`](#string) | Description of the issue. |
|
|
| <a id="mutationcreateissuediscussiontoresolve"></a>`discussionToResolve` | [`String`](#string) | ID of a discussion to resolve. Also pass `merge_request_to_resolve_discussions_of`. |
|
|
| <a id="mutationcreateissueduedate"></a>`dueDate` | [`ISO8601Date`](#iso8601date) | Due date of the issue. |
|
|
| <a id="mutationcreateissueepicid"></a>`epicId` | [`EpicID`](#epicid) | ID of an epic to associate the issue with. |
|
|
| <a id="mutationcreateissuehealthstatus"></a>`healthStatus` | [`HealthStatus`](#healthstatus) | Desired health status. |
|
|
| <a id="mutationcreateissueiid"></a>`iid` | [`Int`](#int) | IID (internal ID) of a project issue. Only admins and project owners can modify. |
|
|
| <a id="mutationcreateissueiterationcadenceid"></a>`iterationCadenceId` | [`IterationsCadenceID`](#iterationscadenceid) | Global iteration cadence ID. Required when `iterationWildcardId` is provided. |
|
|
| <a id="mutationcreateissueiterationid"></a>`iterationId` | [`IterationID`](#iterationid) | Global iteration ID. Mutually exlusive argument with `iterationWildcardId`. |
|
|
| <a id="mutationcreateissueiterationwildcardid"></a>`iterationWildcardId` | [`IssueCreationIterationWildcardId`](#issuecreationiterationwildcardid) | Iteration wildcard ID. Supported values are: `CURRENT`. Mutually exclusive argument with `iterationId`. iterationCadenceId also required when this argument is provided. |
|
|
| <a id="mutationcreateissuelabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the issue. |
|
|
| <a id="mutationcreateissuelabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. |
|
|
| <a id="mutationcreateissuelocked"></a>`locked` | [`Boolean`](#boolean) | Indicates discussion is locked on the issue. |
|
|
| <a id="mutationcreateissuemergerequesttoresolvediscussionsof"></a>`mergeRequestToResolveDiscussionsOf` | [`MergeRequestID`](#mergerequestid) | IID of a merge request for which to resolve discussions. |
|
|
| <a id="mutationcreateissuemilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | ID of the milestone to assign to the issue. On update milestone will be removed if set to null. |
|
|
| <a id="mutationcreateissuemoveafterid"></a>`moveAfterId` | [`IssueID`](#issueid) | Global ID of issue that should be placed after the current issue. |
|
|
| <a id="mutationcreateissuemovebeforeid"></a>`moveBeforeId` | [`IssueID`](#issueid) | Global ID of issue that should be placed before the current issue. |
|
|
| <a id="mutationcreateissueprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path the issue is associated with. |
|
|
| <a id="mutationcreateissuetitle"></a>`title` | [`String!`](#string) | Title of the issue. |
|
|
| <a id="mutationcreateissuetype"></a>`type` | [`IssueType`](#issuetype) | Type of the issue. |
|
|
| <a id="mutationcreateissueweight"></a>`weight` | [`Int`](#int) | Weight of the issue. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateissueerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreateissueissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.createIteration`
|
|
|
|
WARNING:
|
|
**Deprecated** in 14.0.
|
|
Manual iteration management is deprecated. Only automatic iteration cadences will be supported in the future.
|
|
|
|
Input type: `CreateIterationInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateiterationdescription"></a>`description` | [`String`](#string) | Description of the iteration. |
|
|
| <a id="mutationcreateiterationduedate"></a>`dueDate` | [`String`](#string) | End date of the iteration. |
|
|
| <a id="mutationcreateiterationgrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. |
|
|
| <a id="mutationcreateiterationiterationscadenceid"></a>`iterationsCadenceId` **{warning-solid}** | [`IterationsCadenceID`](#iterationscadenceid) | **Deprecated:** `iterationCadenceId` is deprecated and will be removed in the future. This argument is ignored, because you can't create an iteration in a specific cadence. In the future only automatic iteration cadences will be allowed. Deprecated in 14.10. |
|
|
| <a id="mutationcreateiterationprojectpath"></a>`projectPath` | [`ID`](#id) | Full path of the project with which the resource is associated. |
|
|
| <a id="mutationcreateiterationstartdate"></a>`startDate` | [`String`](#string) | Start date of the iteration. |
|
|
| <a id="mutationcreateiterationtitle"></a>`title` | [`String`](#string) | Title of the iteration. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreateiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreateiterationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreateiterationiteration"></a>`iteration` | [`Iteration`](#iteration) | Created iteration. |
|
|
|
|
### `Mutation.createNote`
|
|
|
|
Creates a Note.
|
|
If the body of the Note contains only quick actions,
|
|
the Note will be destroyed during an update, and no Note will be
|
|
returned.
|
|
|
|
Input type: `CreateNoteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatenotebody"></a>`body` | [`String!`](#string) | Content of the note. |
|
|
| <a id="mutationcreatenoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatenoteconfidential"></a>`confidential` | [`Boolean`](#boolean) | Confidentiality flag of a note. Default is false. |
|
|
| <a id="mutationcreatenotediscussionid"></a>`discussionId` | [`DiscussionID`](#discussionid) | Global ID of the discussion this note is in reply to. |
|
|
| <a id="mutationcreatenotemergerequestdiffheadsha"></a>`mergeRequestDiffHeadSha` | [`String`](#string) | SHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent. |
|
|
| <a id="mutationcreatenotenoteableid"></a>`noteableId` | [`NoteableID!`](#noteableid) | Global ID of the resource to add a note to. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatenoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatenoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreatenotenote"></a>`note` | [`Note`](#note) | Note after mutation. |
|
|
|
|
### `Mutation.createRequirement`
|
|
|
|
Input type: `CreateRequirementInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreaterequirementclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreaterequirementdescription"></a>`description` | [`String`](#string) | Description of the requirement. |
|
|
| <a id="mutationcreaterequirementprojectpath"></a>`projectPath` | [`ID!`](#id) | Full project path the requirement is associated with. |
|
|
| <a id="mutationcreaterequirementtitle"></a>`title` | [`String`](#string) | Title of the requirement. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreaterequirementclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreaterequirementerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreaterequirementrequirement"></a>`requirement` | [`Requirement`](#requirement) | Requirement after mutation. |
|
|
|
|
### `Mutation.createSnippet`
|
|
|
|
Input type: `CreateSnippetInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatesnippetblobactions"></a>`blobActions` | [`[SnippetBlobActionInputType!]`](#snippetblobactioninputtype) | Actions to perform over the snippet repository and blobs. |
|
|
| <a id="mutationcreatesnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatesnippetdescription"></a>`description` | [`String`](#string) | Description of the snippet. |
|
|
| <a id="mutationcreatesnippetprojectpath"></a>`projectPath` | [`ID`](#id) | Full path of the project the snippet is associated with. |
|
|
| <a id="mutationcreatesnippettitle"></a>`title` | [`String!`](#string) | Title of the snippet. |
|
|
| <a id="mutationcreatesnippetuploadedfiles"></a>`uploadedFiles` | [`[String!]`](#string) | Paths to files uploaded in the snippet description. |
|
|
| <a id="mutationcreatesnippetvisibilitylevel"></a>`visibilityLevel` | [`VisibilityLevelsEnum!`](#visibilitylevelsenum) | Visibility level of the snippet. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatesnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatesnippeterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreatesnippetsnippet"></a>`snippet` | [`Snippet`](#snippet) | Snippet after mutation. |
|
|
|
|
### `Mutation.createTestCase`
|
|
|
|
Input type: `CreateTestCaseInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatetestcaseclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatetestcasedescription"></a>`description` | [`String`](#string) | Test case description. |
|
|
| <a id="mutationcreatetestcaselabelids"></a>`labelIds` | [`[ID!]`](#id) | IDs of labels to be added to the test case. |
|
|
| <a id="mutationcreatetestcaseprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path to create the test case in. |
|
|
| <a id="mutationcreatetestcasetitle"></a>`title` | [`String!`](#string) | Test case title. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcreatetestcaseclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcreatetestcaseerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcreatetestcasetestcase"></a>`testCase` | [`Issue`](#issue) | Test case created. |
|
|
|
|
### `Mutation.customerRelationsContactCreate`
|
|
|
|
Input type: `CustomerRelationsContactCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcustomerrelationscontactcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcustomerrelationscontactcreatedescription"></a>`description` | [`String`](#string) | Description of or notes for the contact. |
|
|
| <a id="mutationcustomerrelationscontactcreateemail"></a>`email` | [`String`](#string) | Email address of the contact. |
|
|
| <a id="mutationcustomerrelationscontactcreatefirstname"></a>`firstName` | [`String!`](#string) | First name of the contact. |
|
|
| <a id="mutationcustomerrelationscontactcreategroupid"></a>`groupId` | [`GroupID!`](#groupid) | Group for the contact. |
|
|
| <a id="mutationcustomerrelationscontactcreatelastname"></a>`lastName` | [`String!`](#string) | Last name of the contact. |
|
|
| <a id="mutationcustomerrelationscontactcreateorganizationid"></a>`organizationId` | [`CustomerRelationsOrganizationID`](#customerrelationsorganizationid) | Organization for the contact. |
|
|
| <a id="mutationcustomerrelationscontactcreatephone"></a>`phone` | [`String`](#string) | Phone number of the contact. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcustomerrelationscontactcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcustomerrelationscontactcreatecontact"></a>`contact` | [`CustomerRelationsContact`](#customerrelationscontact) | Contact after the mutation. |
|
|
| <a id="mutationcustomerrelationscontactcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.customerRelationsContactUpdate`
|
|
|
|
Input type: `CustomerRelationsContactUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcustomerrelationscontactupdateactive"></a>`active` | [`Boolean`](#boolean) | State of the contact. |
|
|
| <a id="mutationcustomerrelationscontactupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcustomerrelationscontactupdatedescription"></a>`description` | [`String`](#string) | Description of or notes for the contact. |
|
|
| <a id="mutationcustomerrelationscontactupdateemail"></a>`email` | [`String`](#string) | Email address of the contact. |
|
|
| <a id="mutationcustomerrelationscontactupdatefirstname"></a>`firstName` | [`String`](#string) | First name of the contact. |
|
|
| <a id="mutationcustomerrelationscontactupdateid"></a>`id` | [`CustomerRelationsContactID!`](#customerrelationscontactid) | Global ID of the contact. |
|
|
| <a id="mutationcustomerrelationscontactupdatelastname"></a>`lastName` | [`String`](#string) | Last name of the contact. |
|
|
| <a id="mutationcustomerrelationscontactupdateorganizationid"></a>`organizationId` | [`CustomerRelationsOrganizationID`](#customerrelationsorganizationid) | Organization of the contact. |
|
|
| <a id="mutationcustomerrelationscontactupdatephone"></a>`phone` | [`String`](#string) | Phone number of the contact. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcustomerrelationscontactupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcustomerrelationscontactupdatecontact"></a>`contact` | [`CustomerRelationsContact`](#customerrelationscontact) | Contact after the mutation. |
|
|
| <a id="mutationcustomerrelationscontactupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.customerRelationsOrganizationCreate`
|
|
|
|
Input type: `CustomerRelationsOrganizationCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcustomerrelationsorganizationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcustomerrelationsorganizationcreatedefaultrate"></a>`defaultRate` | [`Float`](#float) | Standard billing rate for the organization. |
|
|
| <a id="mutationcustomerrelationsorganizationcreatedescription"></a>`description` | [`String`](#string) | Description of or notes for the organization. |
|
|
| <a id="mutationcustomerrelationsorganizationcreategroupid"></a>`groupId` | [`GroupID!`](#groupid) | Group for the organization. |
|
|
| <a id="mutationcustomerrelationsorganizationcreatename"></a>`name` | [`String!`](#string) | Name of the organization. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcustomerrelationsorganizationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcustomerrelationsorganizationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcustomerrelationsorganizationcreateorganization"></a>`organization` | [`CustomerRelationsOrganization`](#customerrelationsorganization) | Organization after the mutation. |
|
|
|
|
### `Mutation.customerRelationsOrganizationUpdate`
|
|
|
|
Input type: `CustomerRelationsOrganizationUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcustomerrelationsorganizationupdateactive"></a>`active` | [`Boolean`](#boolean) | State of the organization. |
|
|
| <a id="mutationcustomerrelationsorganizationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcustomerrelationsorganizationupdatedefaultrate"></a>`defaultRate` | [`Float`](#float) | Standard billing rate for the organization. |
|
|
| <a id="mutationcustomerrelationsorganizationupdatedescription"></a>`description` | [`String`](#string) | Description of or notes for the organization. |
|
|
| <a id="mutationcustomerrelationsorganizationupdateid"></a>`id` | [`CustomerRelationsOrganizationID!`](#customerrelationsorganizationid) | Global ID of the organization. |
|
|
| <a id="mutationcustomerrelationsorganizationupdatename"></a>`name` | [`String`](#string) | Name of the organization. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationcustomerrelationsorganizationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationcustomerrelationsorganizationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationcustomerrelationsorganizationupdateorganization"></a>`organization` | [`CustomerRelationsOrganization!`](#customerrelationsorganization) | Organization after the mutation. |
|
|
|
|
### `Mutation.dastOnDemandScanCreate`
|
|
|
|
Input type: `DastOnDemandScanCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastondemandscancreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastondemandscancreatedastscannerprofileid"></a>`dastScannerProfileId` | [`DastScannerProfileID`](#dastscannerprofileid) | ID of the scanner profile to be used for the scan. |
|
|
| <a id="mutationdastondemandscancreatedastsiteprofileid"></a>`dastSiteProfileId` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile to be used for the scan. |
|
|
| <a id="mutationdastondemandscancreatefullpath"></a>`fullPath` | [`ID!`](#id) | Project the site profile belongs to. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastondemandscancreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastondemandscancreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastondemandscancreatepipelineurl"></a>`pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. |
|
|
|
|
### `Mutation.dastProfileCreate`
|
|
|
|
Input type: `DastProfileCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastprofilecreatebranchname"></a>`branchName` | [`String`](#string) | Associated branch. |
|
|
| <a id="mutationdastprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastprofilecreatedastprofileschedule"></a>`dastProfileSchedule` | [`DastProfileScheduleInput`](#dastprofilescheduleinput) | Represents a DAST Profile Schedule. |
|
|
| <a id="mutationdastprofilecreatedastscannerprofileid"></a>`dastScannerProfileId` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the scanner profile to be associated. |
|
|
| <a id="mutationdastprofilecreatedastsiteprofileid"></a>`dastSiteProfileId` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile to be associated. |
|
|
| <a id="mutationdastprofilecreatedescription"></a>`description` | [`String`](#string) | Description of the profile. Defaults to an empty string. |
|
|
| <a id="mutationdastprofilecreatefullpath"></a>`fullPath` | [`ID!`](#id) | Project the profile belongs to. |
|
|
| <a id="mutationdastprofilecreatename"></a>`name` | [`String!`](#string) | Name of the profile. |
|
|
| <a id="mutationdastprofilecreaterunaftercreate"></a>`runAfterCreate` | [`Boolean`](#boolean) | Run scan using profile after creation. Defaults to false. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastprofilecreatedastprofile"></a>`dastProfile` | [`DastProfile`](#dastprofile) | Created profile. |
|
|
| <a id="mutationdastprofilecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastprofilecreatepipelineurl"></a>`pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`. |
|
|
|
|
### `Mutation.dastProfileDelete`
|
|
|
|
Input type: `DastProfileDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastprofiledeleteid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the profile to be deleted. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastprofiledeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.dastProfileRun`
|
|
|
|
Input type: `DastProfileRunInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastprofilerunclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastprofilerunfullpath"></a>`fullPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Full path not required to qualify Global ID. Deprecated in 14.5. |
|
|
| <a id="mutationdastprofilerunid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the profile to be used for the scan. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastprofilerunclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastprofilerunerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastprofilerunpipelineurl"></a>`pipelineUrl` | [`String`](#string) | URL of the pipeline that was created. |
|
|
|
|
### `Mutation.dastProfileUpdate`
|
|
|
|
Input type: `DastProfileUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastprofileupdatebranchname"></a>`branchName` | [`String`](#string) | Associated branch. |
|
|
| <a id="mutationdastprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastprofileupdatedastprofileschedule"></a>`dastProfileSchedule` | [`DastProfileScheduleInput`](#dastprofilescheduleinput) | Represents a DAST profile schedule. |
|
|
| <a id="mutationdastprofileupdatedastscannerprofileid"></a>`dastScannerProfileId` | [`DastScannerProfileID`](#dastscannerprofileid) | ID of the scanner profile to be associated. |
|
|
| <a id="mutationdastprofileupdatedastsiteprofileid"></a>`dastSiteProfileId` | [`DastSiteProfileID`](#dastsiteprofileid) | ID of the site profile to be associated. |
|
|
| <a id="mutationdastprofileupdatedescription"></a>`description` | [`String`](#string) | Description of the profile. Defaults to an empty string. |
|
|
| <a id="mutationdastprofileupdatefullpath"></a>`fullPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Full path not required to qualify Global ID. Deprecated in 14.5. |
|
|
| <a id="mutationdastprofileupdateid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the profile to be deleted. |
|
|
| <a id="mutationdastprofileupdatename"></a>`name` | [`String`](#string) | Name of the profile. |
|
|
| <a id="mutationdastprofileupdaterunafterupdate"></a>`runAfterUpdate` | [`Boolean`](#boolean) | Run scan using profile after update. Defaults to false. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastprofileupdatedastprofile"></a>`dastProfile` | [`DastProfile`](#dastprofile) | Updated profile. |
|
|
| <a id="mutationdastprofileupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastprofileupdatepipelineurl"></a>`pipelineUrl` | [`String`](#string) | The URL of the pipeline that was created. Requires the input argument `runAfterUpdate` to be set to `true` when calling the mutation, otherwise no pipeline will be created. |
|
|
|
|
### `Mutation.dastScannerProfileCreate`
|
|
|
|
Input type: `DastScannerProfileCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastscannerprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastscannerprofilecreatefullpath"></a>`fullPath` | [`ID!`](#id) | Project the scanner profile belongs to. |
|
|
| <a id="mutationdastscannerprofilecreateprofilename"></a>`profileName` | [`String!`](#string) | Name of the scanner profile. |
|
|
| <a id="mutationdastscannerprofilecreatescantype"></a>`scanType` | [`DastScanTypeEnum`](#dastscantypeenum) | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. |
|
|
| <a id="mutationdastscannerprofilecreateshowdebugmessages"></a>`showDebugMessages` | [`Boolean`](#boolean) | Indicates if debug messages should be included in DAST console output. True to include the debug messages. |
|
|
| <a id="mutationdastscannerprofilecreatespidertimeout"></a>`spiderTimeout` | [`Int`](#int) | Maximum number of minutes allowed for the spider to traverse the site. |
|
|
| <a id="mutationdastscannerprofilecreatetargettimeout"></a>`targetTimeout` | [`Int`](#int) | Maximum number of seconds allowed for the site under test to respond to a request. |
|
|
| <a id="mutationdastscannerprofilecreateuseajaxspider"></a>`useAjaxSpider` | [`Boolean`](#boolean) | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastscannerprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastscannerprofilecreatedastscannerprofile"></a>`dastScannerProfile` | [`DastScannerProfile`](#dastscannerprofile) | Created scanner profile. |
|
|
| <a id="mutationdastscannerprofilecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastscannerprofilecreateid"></a>`id` **{warning-solid}** | [`DastScannerProfileID`](#dastscannerprofileid) | **Deprecated:** use `dastScannerProfile` field. Deprecated in 14.10. |
|
|
|
|
### `Mutation.dastScannerProfileDelete`
|
|
|
|
Input type: `DastScannerProfileDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastscannerprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastscannerprofiledeletefullpath"></a>`fullPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Full path not required to qualify Global ID. Deprecated in 14.5. |
|
|
| <a id="mutationdastscannerprofiledeleteid"></a>`id` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the scanner profile to be deleted. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastscannerprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastscannerprofiledeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.dastScannerProfileUpdate`
|
|
|
|
Input type: `DastScannerProfileUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastscannerprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastscannerprofileupdatefullpath"></a>`fullPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Full path not required to qualify Global ID. Deprecated in 14.5. |
|
|
| <a id="mutationdastscannerprofileupdateid"></a>`id` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the scanner profile to be updated. |
|
|
| <a id="mutationdastscannerprofileupdateprofilename"></a>`profileName` | [`String!`](#string) | Name of the scanner profile. |
|
|
| <a id="mutationdastscannerprofileupdatescantype"></a>`scanType` | [`DastScanTypeEnum`](#dastscantypeenum) | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. |
|
|
| <a id="mutationdastscannerprofileupdateshowdebugmessages"></a>`showDebugMessages` | [`Boolean`](#boolean) | Indicates if debug messages should be included in DAST console output. True to include the debug messages. |
|
|
| <a id="mutationdastscannerprofileupdatespidertimeout"></a>`spiderTimeout` | [`Int!`](#int) | Maximum number of minutes allowed for the spider to traverse the site. |
|
|
| <a id="mutationdastscannerprofileupdatetargettimeout"></a>`targetTimeout` | [`Int!`](#int) | Maximum number of seconds allowed for the site under test to respond to a request. |
|
|
| <a id="mutationdastscannerprofileupdateuseajaxspider"></a>`useAjaxSpider` | [`Boolean`](#boolean) | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastscannerprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastscannerprofileupdatedastscannerprofile"></a>`dastScannerProfile` | [`DastScannerProfile`](#dastscannerprofile) | Updated scanner profile. |
|
|
| <a id="mutationdastscannerprofileupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastscannerprofileupdateid"></a>`id` **{warning-solid}** | [`DastScannerProfileID`](#dastscannerprofileid) | **Deprecated:** use `dastScannerProfile` field. Deprecated in 14.10. |
|
|
|
|
### `Mutation.dastSiteProfileCreate`
|
|
|
|
Input type: `DastSiteProfileCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsiteprofilecreateauth"></a>`auth` | [`DastSiteProfileAuthInput`](#dastsiteprofileauthinput) | Parameters for authentication. |
|
|
| <a id="mutationdastsiteprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsiteprofilecreateexcludedurls"></a>`excludedUrls` | [`[String!]`](#string) | URLs to skip during an authenticated scan. Defaults to `[]`. |
|
|
| <a id="mutationdastsiteprofilecreatefullpath"></a>`fullPath` | [`ID!`](#id) | Project the site profile belongs to. |
|
|
| <a id="mutationdastsiteprofilecreateprofilename"></a>`profileName` | [`String!`](#string) | Name of the site profile. |
|
|
| <a id="mutationdastsiteprofilecreaterequestheaders"></a>`requestHeaders` | [`String`](#string) | Comma-separated list of request header names and values to be added to every request made by DAST. |
|
|
| <a id="mutationdastsiteprofilecreatescanmethod"></a>`scanMethod` | [`DastScanMethodType`](#dastscanmethodtype) | Scan method by the scanner. Is not saved or updated if `dast_api_scanner` feature flag is disabled. |
|
|
| <a id="mutationdastsiteprofilecreatetargettype"></a>`targetType` | [`DastTargetTypeEnum`](#dasttargettypeenum) | Type of target to be scanned. |
|
|
| <a id="mutationdastsiteprofilecreatetargeturl"></a>`targetUrl` | [`String`](#string) | URL of the target to be scanned. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsiteprofilecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsiteprofilecreatedastsiteprofile"></a>`dastSiteProfile` | [`DastSiteProfile`](#dastsiteprofile) | Site Profile object. |
|
|
| <a id="mutationdastsiteprofilecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastsiteprofilecreateid"></a>`id` **{warning-solid}** | [`DastSiteProfileID`](#dastsiteprofileid) | **Deprecated:** use `dastSiteProfile.id` field. Deprecated in 14.10. |
|
|
|
|
### `Mutation.dastSiteProfileDelete`
|
|
|
|
Input type: `DastSiteProfileDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsiteprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsiteprofiledeletefullpath"></a>`fullPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Full path not required to qualify Global ID. Deprecated in 14.5. |
|
|
| <a id="mutationdastsiteprofiledeleteid"></a>`id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile to be deleted. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsiteprofiledeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsiteprofiledeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.dastSiteProfileUpdate`
|
|
|
|
Input type: `DastSiteProfileUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsiteprofileupdateauth"></a>`auth` | [`DastSiteProfileAuthInput`](#dastsiteprofileauthinput) | Parameters for authentication. |
|
|
| <a id="mutationdastsiteprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsiteprofileupdateexcludedurls"></a>`excludedUrls` | [`[String!]`](#string) | URLs to skip during an authenticated scan. |
|
|
| <a id="mutationdastsiteprofileupdatefullpath"></a>`fullPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Full path not required to qualify Global ID. Deprecated in 14.5. |
|
|
| <a id="mutationdastsiteprofileupdateid"></a>`id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile to be updated. |
|
|
| <a id="mutationdastsiteprofileupdateprofilename"></a>`profileName` | [`String!`](#string) | Name of the site profile. |
|
|
| <a id="mutationdastsiteprofileupdaterequestheaders"></a>`requestHeaders` | [`String`](#string) | Comma-separated list of request header names and values to be added to every request made by DAST. |
|
|
| <a id="mutationdastsiteprofileupdatescanmethod"></a>`scanMethod` | [`DastScanMethodType`](#dastscanmethodtype) | Scan method by the scanner. Is not saved or updated if `dast_api_scanner` feature flag is disabled. |
|
|
| <a id="mutationdastsiteprofileupdatetargettype"></a>`targetType` | [`DastTargetTypeEnum`](#dasttargettypeenum) | Type of target to be scanned. |
|
|
| <a id="mutationdastsiteprofileupdatetargeturl"></a>`targetUrl` | [`String`](#string) | URL of the target to be scanned. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsiteprofileupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsiteprofileupdatedastsiteprofile"></a>`dastSiteProfile` | [`DastSiteProfile`](#dastsiteprofile) | Site profile object. |
|
|
| <a id="mutationdastsiteprofileupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastsiteprofileupdateid"></a>`id` **{warning-solid}** | [`DastSiteProfileID`](#dastsiteprofileid) | **Deprecated:** use `dastSiteProfile.id` field. Deprecated in 14.10. |
|
|
|
|
### `Mutation.dastSiteTokenCreate`
|
|
|
|
Input type: `DastSiteTokenCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsitetokencreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsitetokencreatefullpath"></a>`fullPath` | [`ID!`](#id) | Project the site token belongs to. |
|
|
| <a id="mutationdastsitetokencreatetargeturl"></a>`targetUrl` | [`String`](#string) | URL of the target to be validated. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsitetokencreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsitetokencreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastsitetokencreateid"></a>`id` | [`DastSiteTokenID`](#dastsitetokenid) | ID of the site token. |
|
|
| <a id="mutationdastsitetokencreatestatus"></a>`status` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | Current validation status of the target. |
|
|
| <a id="mutationdastsitetokencreatetoken"></a>`token` | [`String`](#string) | Token string. |
|
|
|
|
### `Mutation.dastSiteValidationCreate`
|
|
|
|
Input type: `DastSiteValidationCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsitevalidationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsitevalidationcreatedastsitetokenid"></a>`dastSiteTokenId` | [`DastSiteTokenID!`](#dastsitetokenid) | ID of the site token. |
|
|
| <a id="mutationdastsitevalidationcreatefullpath"></a>`fullPath` | [`ID!`](#id) | Project the site profile belongs to. |
|
|
| <a id="mutationdastsitevalidationcreatestrategy"></a>`strategy` | [`DastSiteValidationStrategyEnum`](#dastsitevalidationstrategyenum) | Validation strategy to be used. |
|
|
| <a id="mutationdastsitevalidationcreatevalidationpath"></a>`validationPath` | [`String!`](#string) | Path to be requested during validation. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsitevalidationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsitevalidationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdastsitevalidationcreateid"></a>`id` | [`DastSiteValidationID`](#dastsitevalidationid) | ID of the site validation. |
|
|
| <a id="mutationdastsitevalidationcreatestatus"></a>`status` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | Current validation status. |
|
|
|
|
### `Mutation.dastSiteValidationRevoke`
|
|
|
|
Input type: `DastSiteValidationRevokeInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsitevalidationrevokeclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsitevalidationrevokefullpath"></a>`fullPath` | [`ID!`](#id) | Project the site validation belongs to. |
|
|
| <a id="mutationdastsitevalidationrevokenormalizedtargeturl"></a>`normalizedTargetUrl` | [`String!`](#string) | Normalized URL of the target to be revoked. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdastsitevalidationrevokeclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdastsitevalidationrevokeerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.deleteAnnotation`
|
|
|
|
Input type: `DeleteAnnotationInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdeleteannotationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdeleteannotationid"></a>`id` | [`MetricsDashboardAnnotationID!`](#metricsdashboardannotationid) | Global ID of the annotation to delete. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdeleteannotationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdeleteannotationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.designManagementDelete`
|
|
|
|
Input type: `DesignManagementDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdesignmanagementdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdesignmanagementdeletefilenames"></a>`filenames` | [`[String!]!`](#string) | Filenames of the designs to delete. |
|
|
| <a id="mutationdesignmanagementdeleteiid"></a>`iid` | [`ID!`](#id) | IID of the issue to modify designs for. |
|
|
| <a id="mutationdesignmanagementdeleteprojectpath"></a>`projectPath` | [`ID!`](#id) | Project where the issue is to upload designs for. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdesignmanagementdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdesignmanagementdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdesignmanagementdeleteversion"></a>`version` | [`DesignVersion`](#designversion) | New version in which the designs are deleted. |
|
|
|
|
### `Mutation.designManagementMove`
|
|
|
|
Input type: `DesignManagementMoveInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdesignmanagementmoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdesignmanagementmoveid"></a>`id` | [`DesignManagementDesignID!`](#designmanagementdesignid) | ID of the design to move. |
|
|
| <a id="mutationdesignmanagementmovenext"></a>`next` | [`DesignManagementDesignID`](#designmanagementdesignid) | ID of the immediately following design. |
|
|
| <a id="mutationdesignmanagementmoveprevious"></a>`previous` | [`DesignManagementDesignID`](#designmanagementdesignid) | ID of the immediately preceding design. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdesignmanagementmoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdesignmanagementmovedesigncollection"></a>`designCollection` | [`DesignCollection`](#designcollection) | Current state of the collection. |
|
|
| <a id="mutationdesignmanagementmoveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.designManagementUpload`
|
|
|
|
Input type: `DesignManagementUploadInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdesignmanagementuploadclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdesignmanagementuploadfiles"></a>`files` | [`[Upload!]!`](#upload) | Files to upload. |
|
|
| <a id="mutationdesignmanagementuploadiid"></a>`iid` | [`ID!`](#id) | IID of the issue to modify designs for. |
|
|
| <a id="mutationdesignmanagementuploadprojectpath"></a>`projectPath` | [`ID!`](#id) | Project where the issue is to upload designs for. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdesignmanagementuploadclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdesignmanagementuploaddesigns"></a>`designs` | [`[Design!]!`](#design) | Designs that were uploaded by the mutation. |
|
|
| <a id="mutationdesignmanagementuploaderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdesignmanagementuploadskippeddesigns"></a>`skippedDesigns` | [`[Design!]!`](#design) | Any designs that were skipped from the upload due to there being no change to their content since their last version. |
|
|
|
|
### `Mutation.destroyBoard`
|
|
|
|
Input type: `DestroyBoardInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroyboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroyboardid"></a>`id` | [`BoardID!`](#boardid) | Global ID of the board to destroy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroyboardboard"></a>`board` | [`Board`](#board) | Board after mutation. |
|
|
| <a id="mutationdestroyboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroyboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.destroyBoardList`
|
|
|
|
Input type: `DestroyBoardListInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroyboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroyboardlistlistid"></a>`listId` | [`ListID!`](#listid) | Global ID of the list to destroy. Only label lists are accepted. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroyboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroyboardlisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdestroyboardlistlist"></a>`list` | [`BoardList`](#boardlist) | List after mutation. |
|
|
|
|
### `Mutation.destroyComplianceFramework`
|
|
|
|
Input type: `DestroyComplianceFrameworkInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroycomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroycomplianceframeworkid"></a>`id` | [`ComplianceManagementFrameworkID!`](#compliancemanagementframeworkid) | Global ID of the compliance framework to destroy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroycomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroycomplianceframeworkerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.destroyContainerRepository`
|
|
|
|
Input type: `DestroyContainerRepositoryInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroycontainerrepositoryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroycontainerrepositoryid"></a>`id` | [`ContainerRepositoryID!`](#containerrepositoryid) | ID of the container repository. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroycontainerrepositoryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroycontainerrepositorycontainerrepository"></a>`containerRepository` | [`ContainerRepository!`](#containerrepository) | Container repository policy after scheduling the deletion. |
|
|
| <a id="mutationdestroycontainerrepositoryerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.destroyContainerRepositoryTags`
|
|
|
|
Input type: `DestroyContainerRepositoryTagsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroycontainerrepositorytagsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroycontainerrepositorytagsid"></a>`id` | [`ContainerRepositoryID!`](#containerrepositoryid) | ID of the container repository. |
|
|
| <a id="mutationdestroycontainerrepositorytagstagnames"></a>`tagNames` | [`[String!]!`](#string) | Container repository tag(s) to delete. Total number can't be greater than 20. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroycontainerrepositorytagsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroycontainerrepositorytagsdeletedtagnames"></a>`deletedTagNames` | [`[String!]!`](#string) | Deleted container repository tags. |
|
|
| <a id="mutationdestroycontainerrepositorytagserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.destroyCustomEmoji`
|
|
|
|
Available only when feature flag `custom_emoji` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
|
|
|
|
Input type: `DestroyCustomEmojiInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroycustomemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroycustomemojiid"></a>`id` | [`CustomEmojiID!`](#customemojiid) | Global ID of the custom emoji to destroy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroycustomemojiclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroycustomemojicustomemoji"></a>`customEmoji` | [`CustomEmoji`](#customemoji) | Deleted custom emoji. |
|
|
| <a id="mutationdestroycustomemojierrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.destroyEpicBoard`
|
|
|
|
Input type: `DestroyEpicBoardInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroyepicboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroyepicboardid"></a>`id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the board to destroy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroyepicboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroyepicboardepicboard"></a>`epicBoard` | [`EpicBoard`](#epicboard) | Epic board after mutation. |
|
|
| <a id="mutationdestroyepicboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.destroyNote`
|
|
|
|
Input type: `DestroyNoteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroynoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroynoteid"></a>`id` | [`NoteID!`](#noteid) | Global ID of the note to destroy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroynoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroynoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdestroynotenote"></a>`note` | [`Note`](#note) | Note after mutation. |
|
|
|
|
### `Mutation.destroyPackage`
|
|
|
|
Input type: `DestroyPackageInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroypackageclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroypackageid"></a>`id` | [`PackagesPackageID!`](#packagespackageid) | ID of the Package. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroypackageclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroypackageerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.destroyPackageFile`
|
|
|
|
Input type: `DestroyPackageFileInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroypackagefileclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroypackagefileid"></a>`id` | [`PackagesPackageFileID!`](#packagespackagefileid) | ID of the Package file. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroypackagefileclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroypackagefileerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.destroySnippet`
|
|
|
|
Input type: `DestroySnippetInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroysnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroysnippetid"></a>`id` | [`SnippetID!`](#snippetid) | Global ID of the snippet to destroy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdestroysnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdestroysnippeterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationdestroysnippetsnippet"></a>`snippet` | [`Snippet`](#snippet) | Snippet after mutation. |
|
|
|
|
### `Mutation.disableDevopsAdoptionNamespace`
|
|
|
|
**BETA** This endpoint is subject to change without notice.
|
|
|
|
Input type: `DisableDevopsAdoptionNamespaceInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdisabledevopsadoptionnamespaceclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdisabledevopsadoptionnamespaceid"></a>`id` | [`[AnalyticsDevopsAdoptionEnabledNamespaceID!]!`](#analyticsdevopsadoptionenablednamespaceid) | One or many IDs of the enabled namespaces to disable. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdisabledevopsadoptionnamespaceclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdisabledevopsadoptionnamespaceerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.discussionToggleResolve`
|
|
|
|
Toggles the resolved state of a discussion.
|
|
|
|
Input type: `DiscussionToggleResolveInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdiscussiontoggleresolveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdiscussiontoggleresolveid"></a>`id` | [`DiscussionID!`](#discussionid) | Global ID of the discussion. |
|
|
| <a id="mutationdiscussiontoggleresolveresolve"></a>`resolve` | [`Boolean!`](#boolean) | Will resolve the discussion when true, and unresolve the discussion when false. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationdiscussiontoggleresolveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationdiscussiontoggleresolvediscussion"></a>`discussion` | [`Discussion`](#discussion) | Discussion after mutation. |
|
|
| <a id="mutationdiscussiontoggleresolveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.echoCreate`
|
|
|
|
A mutation that does not perform any changes.
|
|
|
|
This is expected to be used for testing of endpoints, to verify
|
|
that a user has mutation access.
|
|
|
|
Input type: `EchoCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationechocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationechocreateerrors"></a>`errors` | [`[String!]`](#string) | Errors to return to the user. |
|
|
| <a id="mutationechocreatemessages"></a>`messages` | [`[String!]`](#string) | Messages to return to the user. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationechocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationechocreateechoes"></a>`echoes` | [`[String!]`](#string) | Messages returned to the user. |
|
|
| <a id="mutationechocreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.enableDevopsAdoptionNamespace`
|
|
|
|
**BETA** This endpoint is subject to change without notice.
|
|
|
|
Input type: `EnableDevopsAdoptionNamespaceInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationenabledevopsadoptionnamespaceclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationenabledevopsadoptionnamespacedisplaynamespaceid"></a>`displayNamespaceId` | [`NamespaceID`](#namespaceid) | Display namespace ID. |
|
|
| <a id="mutationenabledevopsadoptionnamespacenamespaceid"></a>`namespaceId` | [`NamespaceID!`](#namespaceid) | Namespace ID. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationenabledevopsadoptionnamespaceclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationenabledevopsadoptionnamespaceenablednamespace"></a>`enabledNamespace` | [`DevopsAdoptionEnabledNamespace`](#devopsadoptionenablednamespace) | Enabled namespace after mutation. |
|
|
| <a id="mutationenabledevopsadoptionnamespaceerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.environmentsCanaryIngressUpdate`
|
|
|
|
**Deprecated** This endpoint is planned to be removed along with certificate-based clusters. [See this epic](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) for more information.
|
|
|
|
Input type: `EnvironmentsCanaryIngressUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationenvironmentscanaryingressupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationenvironmentscanaryingressupdateid"></a>`id` | [`EnvironmentID!`](#environmentid) | Global ID of the environment to update. |
|
|
| <a id="mutationenvironmentscanaryingressupdateweight"></a>`weight` | [`Int!`](#int) | Weight of the Canary Ingress. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationenvironmentscanaryingressupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationenvironmentscanaryingressupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.epicAddIssue`
|
|
|
|
Input type: `EpicAddIssueInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicaddissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicaddissuegrouppath"></a>`groupPath` | [`ID!`](#id) | Group the epic to mutate belongs to. |
|
|
| <a id="mutationepicaddissueiid"></a>`iid` | [`ID!`](#id) | IID of the epic to mutate. |
|
|
| <a id="mutationepicaddissueissueiid"></a>`issueIid` | [`String!`](#string) | IID of the issue to be added. |
|
|
| <a id="mutationepicaddissueprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the issue belongs to. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicaddissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicaddissueepic"></a>`epic` | [`Epic`](#epic) | Epic after mutation. |
|
|
| <a id="mutationepicaddissueepicissue"></a>`epicIssue` | [`EpicIssue`](#epicissue) | Epic-issue relationship. |
|
|
| <a id="mutationepicaddissueerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.epicBoardCreate`
|
|
|
|
Input type: `EpicBoardCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicboardcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicboardcreategrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. |
|
|
| <a id="mutationepicboardcreatehidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. |
|
|
| <a id="mutationepicboardcreatehideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. |
|
|
| <a id="mutationepicboardcreatelabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the board. |
|
|
| <a id="mutationepicboardcreatelabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. |
|
|
| <a id="mutationepicboardcreatename"></a>`name` | [`String`](#string) | Board name. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicboardcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicboardcreateepicboard"></a>`epicBoard` | [`EpicBoard`](#epicboard) | Created epic board. |
|
|
| <a id="mutationepicboardcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.epicBoardListCreate`
|
|
|
|
Input type: `EpicBoardListCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicboardlistcreatebacklog"></a>`backlog` | [`Boolean`](#boolean) | Create the backlog list. |
|
|
| <a id="mutationepicboardlistcreateboardid"></a>`boardId` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the issue board to mutate. |
|
|
| <a id="mutationepicboardlistcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicboardlistcreatelabelid"></a>`labelId` | [`LabelID`](#labelid) | Global ID of an existing label. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicboardlistcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicboardlistcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationepicboardlistcreatelist"></a>`list` | [`EpicList`](#epiclist) | Epic list in the epic board. |
|
|
|
|
### `Mutation.epicBoardListDestroy`
|
|
|
|
Destroys an epic board list.
|
|
|
|
Input type: `EpicBoardListDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicboardlistdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicboardlistdestroylistid"></a>`listId` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the epic board list to destroy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicboardlistdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicboardlistdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationepicboardlistdestroylist"></a>`list` | [`EpicList`](#epiclist) | Epic board list. `null` if the board was destroyed successfully. |
|
|
|
|
### `Mutation.epicBoardUpdate`
|
|
|
|
Input type: `EpicBoardUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicboardupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicboardupdatehidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. |
|
|
| <a id="mutationepicboardupdatehideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. |
|
|
| <a id="mutationepicboardupdateid"></a>`id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Epic board global ID. |
|
|
| <a id="mutationepicboardupdatelabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the board. |
|
|
| <a id="mutationepicboardupdatelabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. |
|
|
| <a id="mutationepicboardupdatename"></a>`name` | [`String`](#string) | Board name. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicboardupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicboardupdateepicboard"></a>`epicBoard` | [`EpicBoard`](#epicboard) | Updated epic board. |
|
|
| <a id="mutationepicboardupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.epicMoveList`
|
|
|
|
Input type: `EpicMoveListInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicmovelistboardid"></a>`boardId` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the board that the epic is in. |
|
|
| <a id="mutationepicmovelistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicmovelistepicid"></a>`epicId` | [`EpicID!`](#epicid) | ID of the epic to mutate. |
|
|
| <a id="mutationepicmovelistfromlistid"></a>`fromListId` | [`BoardsEpicListID`](#boardsepiclistid) | ID of the board list that the epic will be moved from. Required if moving between lists. |
|
|
| <a id="mutationepicmovelistmoveafterid"></a>`moveAfterId` | [`EpicID`](#epicid) | ID of epic that should be placed after the current epic. |
|
|
| <a id="mutationepicmovelistmovebeforeid"></a>`moveBeforeId` | [`EpicID`](#epicid) | ID of epic that should be placed before the current epic. |
|
|
| <a id="mutationepicmovelisttolistid"></a>`toListId` | [`BoardsEpicListID!`](#boardsepiclistid) | ID of the list the epic will be in after mutation. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicmovelistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicmovelistepic"></a>`epic` | [`Epic`](#epic) | Epic after mutation. |
|
|
| <a id="mutationepicmovelisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.epicSetSubscription`
|
|
|
|
Input type: `EpicSetSubscriptionInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicsetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicsetsubscriptiongrouppath"></a>`groupPath` | [`ID!`](#id) | Group the epic to mutate belongs to. |
|
|
| <a id="mutationepicsetsubscriptioniid"></a>`iid` | [`ID!`](#id) | IID of the epic to mutate. |
|
|
| <a id="mutationepicsetsubscriptionsubscribedstate"></a>`subscribedState` | [`Boolean!`](#boolean) | Desired state of the subscription. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepicsetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepicsetsubscriptionepic"></a>`epic` | [`Epic`](#epic) | Epic after mutation. |
|
|
| <a id="mutationepicsetsubscriptionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.epicTreeReorder`
|
|
|
|
Input type: `EpicTreeReorderInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepictreereorderbaseepicid"></a>`baseEpicId` | [`EpicID!`](#epicid) | ID of the base epic of the tree. |
|
|
| <a id="mutationepictreereorderclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepictreereordermoved"></a>`moved` | [`EpicTreeNodeFieldsInputType!`](#epictreenodefieldsinputtype) | Parameters for updating the tree positions. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationepictreereorderclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationepictreereordererrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.escalationPolicyCreate`
|
|
|
|
Input type: `EscalationPolicyCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationescalationpolicycreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationescalationpolicycreatedescription"></a>`description` | [`String`](#string) | Description of the escalation policy. |
|
|
| <a id="mutationescalationpolicycreatename"></a>`name` | [`String!`](#string) | Name of the escalation policy. |
|
|
| <a id="mutationescalationpolicycreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to create the escalation policy for. |
|
|
| <a id="mutationescalationpolicycreaterules"></a>`rules` | [`[EscalationRuleInput!]!`](#escalationruleinput) | Steps of the escalation policy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationescalationpolicycreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationescalationpolicycreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationescalationpolicycreateescalationpolicy"></a>`escalationPolicy` | [`EscalationPolicyType`](#escalationpolicytype) | Escalation policy. |
|
|
|
|
### `Mutation.escalationPolicyDestroy`
|
|
|
|
Input type: `EscalationPolicyDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationescalationpolicydestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationescalationpolicydestroyid"></a>`id` | [`IncidentManagementEscalationPolicyID!`](#incidentmanagementescalationpolicyid) | Escalation policy internal ID to remove. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationescalationpolicydestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationescalationpolicydestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationescalationpolicydestroyescalationpolicy"></a>`escalationPolicy` | [`EscalationPolicyType`](#escalationpolicytype) | Escalation policy. |
|
|
|
|
### `Mutation.escalationPolicyUpdate`
|
|
|
|
Input type: `EscalationPolicyUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationescalationpolicyupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationescalationpolicyupdatedescription"></a>`description` | [`String`](#string) | Description of the escalation policy. |
|
|
| <a id="mutationescalationpolicyupdateid"></a>`id` | [`IncidentManagementEscalationPolicyID!`](#incidentmanagementescalationpolicyid) | ID of the on-call schedule to create the on-call rotation in. |
|
|
| <a id="mutationescalationpolicyupdatename"></a>`name` | [`String`](#string) | Name of the escalation policy. |
|
|
| <a id="mutationescalationpolicyupdaterules"></a>`rules` | [`[EscalationRuleInput!]`](#escalationruleinput) | Steps of the escalation policy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationescalationpolicyupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationescalationpolicyupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationescalationpolicyupdateescalationpolicy"></a>`escalationPolicy` | [`EscalationPolicyType`](#escalationpolicytype) | Escalation policy. |
|
|
|
|
### `Mutation.exportRequirements`
|
|
|
|
Input type: `ExportRequirementsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationexportrequirementsauthorusername"></a>`authorUsername` | [`[String!]`](#string) | Filter requirements by author username. |
|
|
| <a id="mutationexportrequirementsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationexportrequirementsprojectpath"></a>`projectPath` | [`ID!`](#id) | Full project path the requirements are associated with. |
|
|
| <a id="mutationexportrequirementssearch"></a>`search` | [`String`](#string) | Search query for requirement title. |
|
|
| <a id="mutationexportrequirementsselectedfields"></a>`selectedFields` | [`[String!]`](#string) | List of selected requirements fields to be exported. |
|
|
| <a id="mutationexportrequirementssort"></a>`sort` | [`Sort`](#sort) | List requirements by sort order. |
|
|
| <a id="mutationexportrequirementsstate"></a>`state` | [`RequirementState`](#requirementstate) | Filter requirements by state. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationexportrequirementsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationexportrequirementserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.externalAuditEventDestinationCreate`
|
|
|
|
Input type: `ExternalAuditEventDestinationCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationexternalauditeventdestinationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationexternalauditeventdestinationcreatedestinationurl"></a>`destinationUrl` | [`String!`](#string) | Destination URL. |
|
|
| <a id="mutationexternalauditeventdestinationcreategrouppath"></a>`groupPath` | [`ID!`](#id) | Group path. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationexternalauditeventdestinationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationexternalauditeventdestinationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationexternalauditeventdestinationcreateexternalauditeventdestination"></a>`externalAuditEventDestination` | [`ExternalAuditEventDestination`](#externalauditeventdestination) | Destination created. |
|
|
|
|
### `Mutation.externalAuditEventDestinationDestroy`
|
|
|
|
Input type: `ExternalAuditEventDestinationDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationexternalauditeventdestinationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationexternalauditeventdestinationdestroyid"></a>`id` | [`AuditEventsExternalAuditEventDestinationID!`](#auditeventsexternalauditeventdestinationid) | ID of external audit event destination to destroy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationexternalauditeventdestinationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationexternalauditeventdestinationdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.externalAuditEventDestinationUpdate`
|
|
|
|
Input type: `ExternalAuditEventDestinationUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationexternalauditeventdestinationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationexternalauditeventdestinationupdatedestinationurl"></a>`destinationUrl` | [`String`](#string) | Destination URL to change. |
|
|
| <a id="mutationexternalauditeventdestinationupdateid"></a>`id` | [`AuditEventsExternalAuditEventDestinationID!`](#auditeventsexternalauditeventdestinationid) | ID of external audit event destination to update. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationexternalauditeventdestinationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationexternalauditeventdestinationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationexternalauditeventdestinationupdateexternalauditeventdestination"></a>`externalAuditEventDestination` | [`ExternalAuditEventDestination`](#externalauditeventdestination) | Updated destination. |
|
|
|
|
### `Mutation.gitlabSubscriptionActivate`
|
|
|
|
Input type: `GitlabSubscriptionActivateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationgitlabsubscriptionactivateactivationcode"></a>`activationCode` | [`String!`](#string) | Activation code received after purchasing a GitLab subscription. |
|
|
| <a id="mutationgitlabsubscriptionactivateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationgitlabsubscriptionactivateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationgitlabsubscriptionactivateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationgitlabsubscriptionactivatelicense"></a>`license` | [`CurrentLicense`](#currentlicense) | Current license. |
|
|
|
|
### `Mutation.groupUpdate`
|
|
|
|
Input type: `GroupUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationgroupupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationgroupupdatefullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the group that will be updated. |
|
|
| <a id="mutationgroupupdatesharedrunnerssetting"></a>`sharedRunnersSetting` | [`SharedRunnersSetting!`](#sharedrunnerssetting) | Shared runners availability for the namespace and its descendants. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationgroupupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationgroupupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationgroupupdategroup"></a>`group` | [`Group`](#group) | Group after update. |
|
|
|
|
### `Mutation.httpIntegrationCreate`
|
|
|
|
Input type: `HttpIntegrationCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationhttpintegrationcreateactive"></a>`active` | [`Boolean!`](#boolean) | Whether the integration is receiving alerts. |
|
|
| <a id="mutationhttpintegrationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationhttpintegrationcreatename"></a>`name` | [`String!`](#string) | Name of the integration. |
|
|
| <a id="mutationhttpintegrationcreatepayloadattributemappings"></a>`payloadAttributeMappings` | [`[AlertManagementPayloadAlertFieldInput!]`](#alertmanagementpayloadalertfieldinput) | Custom mapping of GitLab alert attributes to fields from the payload example. |
|
|
| <a id="mutationhttpintegrationcreatepayloadexample"></a>`payloadExample` | [`JsonString`](#jsonstring) | Example of an alert payload. |
|
|
| <a id="mutationhttpintegrationcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to create the integration in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationhttpintegrationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationhttpintegrationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationhttpintegrationcreateintegration"></a>`integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | HTTP integration. |
|
|
|
|
### `Mutation.httpIntegrationDestroy`
|
|
|
|
Input type: `HttpIntegrationDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationhttpintegrationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationhttpintegrationdestroyid"></a>`id` | [`AlertManagementHttpIntegrationID!`](#alertmanagementhttpintegrationid) | ID of the integration to remove. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationhttpintegrationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationhttpintegrationdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationhttpintegrationdestroyintegration"></a>`integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | HTTP integration. |
|
|
|
|
### `Mutation.httpIntegrationResetToken`
|
|
|
|
Input type: `HttpIntegrationResetTokenInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationhttpintegrationresettokenclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationhttpintegrationresettokenid"></a>`id` | [`AlertManagementHttpIntegrationID!`](#alertmanagementhttpintegrationid) | ID of the integration to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationhttpintegrationresettokenclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationhttpintegrationresettokenerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationhttpintegrationresettokenintegration"></a>`integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | HTTP integration. |
|
|
|
|
### `Mutation.httpIntegrationUpdate`
|
|
|
|
Input type: `HttpIntegrationUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationhttpintegrationupdateactive"></a>`active` | [`Boolean`](#boolean) | Whether the integration is receiving alerts. |
|
|
| <a id="mutationhttpintegrationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationhttpintegrationupdateid"></a>`id` | [`AlertManagementHttpIntegrationID!`](#alertmanagementhttpintegrationid) | ID of the integration to mutate. |
|
|
| <a id="mutationhttpintegrationupdatename"></a>`name` | [`String`](#string) | Name of the integration. |
|
|
| <a id="mutationhttpintegrationupdatepayloadattributemappings"></a>`payloadAttributeMappings` | [`[AlertManagementPayloadAlertFieldInput!]`](#alertmanagementpayloadalertfieldinput) | Custom mapping of GitLab alert attributes to fields from the payload example. |
|
|
| <a id="mutationhttpintegrationupdatepayloadexample"></a>`payloadExample` | [`JsonString`](#jsonstring) | Example of an alert payload. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationhttpintegrationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationhttpintegrationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationhttpintegrationupdateintegration"></a>`integration` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | HTTP integration. |
|
|
|
|
### `Mutation.issueMove`
|
|
|
|
Input type: `IssueMoveInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuemoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuemoveiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuemoveprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
| <a id="mutationissuemovetargetprojectpath"></a>`targetProjectPath` | [`ID!`](#id) | Project to move the issue to. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuemoveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuemoveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuemoveissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueMoveList`
|
|
|
|
Input type: `IssueMoveListInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuemovelistboardid"></a>`boardId` | [`BoardID!`](#boardid) | Global ID of the board that the issue is in. |
|
|
| <a id="mutationissuemovelistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuemovelistepicid"></a>`epicId` | [`EpicID`](#epicid) | ID of the parent epic. NULL when removing the association. |
|
|
| <a id="mutationissuemovelistfromlistid"></a>`fromListId` | [`ID`](#id) | ID of the board list that the issue will be moved from. |
|
|
| <a id="mutationissuemovelistiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuemovelistmoveafterid"></a>`moveAfterId` | [`ID`](#id) | ID of issue that should be placed after the current issue. |
|
|
| <a id="mutationissuemovelistmovebeforeid"></a>`moveBeforeId` | [`ID`](#id) | ID of issue that should be placed before the current issue. |
|
|
| <a id="mutationissuemovelistprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
| <a id="mutationissuemovelisttolistid"></a>`toListId` | [`ID`](#id) | ID of the board list that the issue will be moved to. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuemovelistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuemovelisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuemovelistissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetAssignees`
|
|
|
|
Input type: `IssueSetAssigneesInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetassigneesassigneeusernames"></a>`assigneeUsernames` | [`[String!]!`](#string) | Usernames to assign to the resource. Replaces existing assignees by default. |
|
|
| <a id="mutationissuesetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetassigneesiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetassigneesoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | Operation to perform. Defaults to REPLACE. |
|
|
| <a id="mutationissuesetassigneesprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetassigneeserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetassigneesissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetConfidential`
|
|
|
|
Input type: `IssueSetConfidentialInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetconfidentialclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetconfidentialconfidential"></a>`confidential` | [`Boolean!`](#boolean) | Whether or not to set the issue as a confidential. |
|
|
| <a id="mutationissuesetconfidentialiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetconfidentialprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetconfidentialclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetconfidentialerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetconfidentialissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetCrmContacts`
|
|
|
|
Input type: `IssueSetCrmContactsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetcrmcontactsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetcrmcontactscontactids"></a>`contactIds` | [`[CustomerRelationsContactID!]!`](#customerrelationscontactid) | Customer relations contact IDs to set. Replaces existing contacts by default. |
|
|
| <a id="mutationissuesetcrmcontactsiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetcrmcontactsoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | Changes the operation mode. Defaults to REPLACE. |
|
|
| <a id="mutationissuesetcrmcontactsprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetcrmcontactsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetcrmcontactserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetcrmcontactsissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetDueDate`
|
|
|
|
Input type: `IssueSetDueDateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetduedateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetduedateduedate"></a>`dueDate` | [`Time`](#time) | Desired due date for the issue. Due date is removed if null. |
|
|
| <a id="mutationissuesetduedateiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetduedateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetduedateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetduedateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetduedateissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetEpic`
|
|
|
|
Input type: `IssueSetEpicInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetepicepicid"></a>`epicId` | [`EpicID`](#epicid) | Global ID of the epic to be assigned to the issue, epic will be removed if absent or set to null. |
|
|
| <a id="mutationissuesetepiciid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetepicprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetepicerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetepicissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetEscalationPolicy`
|
|
|
|
Input type: `IssueSetEscalationPolicyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetescalationpolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetescalationpolicyescalationpolicyid"></a>`escalationPolicyId` | [`IncidentManagementEscalationPolicyID`](#incidentmanagementescalationpolicyid) | Global ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null. |
|
|
| <a id="mutationissuesetescalationpolicyiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetescalationpolicyprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetescalationpolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetescalationpolicyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetescalationpolicyissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetEscalationStatus`
|
|
|
|
Input type: `IssueSetEscalationStatusInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetescalationstatusclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetescalationstatusiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetescalationstatusprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
| <a id="mutationissuesetescalationstatusstatus"></a>`status` | [`IssueEscalationStatus!`](#issueescalationstatus) | Set the escalation status. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetescalationstatusclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetescalationstatuserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetescalationstatusissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetIteration`
|
|
|
|
Input type: `IssueSetIterationInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetiterationiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetiterationiterationid"></a>`iterationId` | [`IterationID`](#iterationid) | Iteration to assign to the issue. |
|
|
| <a id="mutationissuesetiterationprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetiterationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetiterationissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetLocked`
|
|
|
|
Input type: `IssueSetLockedInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetlockediid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetlockedlocked"></a>`locked` | [`Boolean!`](#boolean) | Whether or not to lock discussion on the issue. |
|
|
| <a id="mutationissuesetlockedprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetlockederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetlockedissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetSeverity`
|
|
|
|
Input type: `IssueSetSeverityInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetseverityclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetseverityiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetseverityprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
| <a id="mutationissuesetseverityseverity"></a>`severity` | [`IssuableSeverity!`](#issuableseverity) | Set the incident severity level. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetseverityclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetseverityerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetseverityissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetSubscription`
|
|
|
|
Input type: `IssueSetSubscriptionInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetsubscriptioniid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetsubscriptionprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
| <a id="mutationissuesetsubscriptionsubscribedstate"></a>`subscribedState` | [`Boolean!`](#boolean) | Desired state of the subscription. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetsubscriptionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetsubscriptionissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.issueSetWeight`
|
|
|
|
Input type: `IssueSetWeightInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetweightclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetweightiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationissuesetweightprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
| <a id="mutationissuesetweightweight"></a>`weight` | [`Int`](#int) | The desired weight for the issue. If set to null, weight is removed. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationissuesetweightclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationissuesetweighterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationissuesetweightissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.iterationCadenceCreate`
|
|
|
|
Input type: `IterationCadenceCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationcadencecreateactive"></a>`active` | [`Boolean!`](#boolean) | Whether the iteration cadence is active. |
|
|
| <a id="mutationiterationcadencecreateautomatic"></a>`automatic` | [`Boolean!`](#boolean) | Whether the iteration cadence should automatically generate upcoming iterations. |
|
|
| <a id="mutationiterationcadencecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationcadencecreatedescription"></a>`description` | [`String`](#string) | Description of the iteration cadence. Maximum length is 5000 characters. |
|
|
| <a id="mutationiterationcadencecreatedurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. |
|
|
| <a id="mutationiterationcadencecreategrouppath"></a>`groupPath` | [`ID!`](#id) | Group where the iteration cadence is created. |
|
|
| <a id="mutationiterationcadencecreateiterationsinadvance"></a>`iterationsInAdvance` | [`Int`](#int) | Upcoming iterations to be created when iteration cadence is set to automatic. |
|
|
| <a id="mutationiterationcadencecreaterollover"></a>`rollOver` | [`Boolean`](#boolean) | Whether the iteration cadence should roll over issues to the next iteration or not. |
|
|
| <a id="mutationiterationcadencecreatestartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the iteration cadence start date. |
|
|
| <a id="mutationiterationcadencecreatetitle"></a>`title` | [`String`](#string) | Title of the iteration cadence. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationcadencecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationcadencecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationiterationcadencecreateiterationcadence"></a>`iterationCadence` | [`IterationCadence`](#iterationcadence) | Created iteration cadence. |
|
|
|
|
### `Mutation.iterationCadenceDestroy`
|
|
|
|
Input type: `IterationCadenceDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationcadencedestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationcadencedestroyid"></a>`id` | [`IterationsCadenceID!`](#iterationscadenceid) | Global ID of the iteration cadence. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationcadencedestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationcadencedestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationiterationcadencedestroygroup"></a>`group` | [`Group!`](#group) | Group the iteration cadence belongs to. |
|
|
|
|
### `Mutation.iterationCadenceUpdate`
|
|
|
|
Input type: `IterationCadenceUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationcadenceupdateactive"></a>`active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. |
|
|
| <a id="mutationiterationcadenceupdateautomatic"></a>`automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate upcoming iterations. |
|
|
| <a id="mutationiterationcadenceupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationcadenceupdatedescription"></a>`description` | [`String`](#string) | Description of the iteration cadence. Maximum length is 5000 characters. |
|
|
| <a id="mutationiterationcadenceupdatedurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. |
|
|
| <a id="mutationiterationcadenceupdateid"></a>`id` | [`IterationsCadenceID!`](#iterationscadenceid) | Global ID of the iteration cadence. |
|
|
| <a id="mutationiterationcadenceupdateiterationsinadvance"></a>`iterationsInAdvance` | [`Int`](#int) | Upcoming iterations to be created when iteration cadence is set to automatic. |
|
|
| <a id="mutationiterationcadenceupdaterollover"></a>`rollOver` | [`Boolean`](#boolean) | Whether the iteration cadence should roll over issues to the next iteration or not. |
|
|
| <a id="mutationiterationcadenceupdatestartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the iteration cadence start date. |
|
|
| <a id="mutationiterationcadenceupdatetitle"></a>`title` | [`String`](#string) | Title of the iteration cadence. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationcadenceupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationcadenceupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationiterationcadenceupdateiterationcadence"></a>`iterationCadence` | [`IterationCadence`](#iterationcadence) | Updated iteration cadence. |
|
|
|
|
### `Mutation.iterationCreate`
|
|
|
|
WARNING:
|
|
**Deprecated** in 14.10.
|
|
Manual iteration management is deprecated. Only automatic iteration cadences will be supported in the future.
|
|
|
|
Input type: `iterationCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationcreatedescription"></a>`description` | [`String`](#string) | Description of the iteration. |
|
|
| <a id="mutationiterationcreateduedate"></a>`dueDate` | [`String`](#string) | End date of the iteration. |
|
|
| <a id="mutationiterationcreategrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. |
|
|
| <a id="mutationiterationcreateiterationscadenceid"></a>`iterationsCadenceId` **{warning-solid}** | [`IterationsCadenceID`](#iterationscadenceid) | **Deprecated:** `iterationCadenceId` is deprecated and will be removed in the future. This argument is ignored, because you can't create an iteration in a specific cadence. In the future only automatic iteration cadences will be allowed. Deprecated in 14.10. |
|
|
| <a id="mutationiterationcreateprojectpath"></a>`projectPath` | [`ID`](#id) | Full path of the project with which the resource is associated. |
|
|
| <a id="mutationiterationcreatestartdate"></a>`startDate` | [`String`](#string) | Start date of the iteration. |
|
|
| <a id="mutationiterationcreatetitle"></a>`title` | [`String`](#string) | Title of the iteration. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationiterationcreateiteration"></a>`iteration` | [`Iteration`](#iteration) | Created iteration. |
|
|
|
|
### `Mutation.iterationDelete`
|
|
|
|
WARNING:
|
|
**Deprecated** in 14.10.
|
|
Manual iteration management is deprecated. Only automatic iteration cadences will be supported in the future.
|
|
|
|
Input type: `IterationDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationdeleteid"></a>`id` | [`IterationID!`](#iterationid) | ID of the iteration. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationiterationdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationiterationdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationiterationdeletegroup"></a>`group` | [`Group!`](#group) | Group the iteration belongs to. |
|
|
|
|
### `Mutation.jiraImportStart`
|
|
|
|
Input type: `JiraImportStartInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjiraimportstartclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjiraimportstartjiraprojectkey"></a>`jiraProjectKey` | [`String!`](#string) | Project key of the importer Jira project. |
|
|
| <a id="mutationjiraimportstartjiraprojectname"></a>`jiraProjectName` | [`String`](#string) | Project name of the importer Jira project. |
|
|
| <a id="mutationjiraimportstartprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to import the Jira project into. |
|
|
| <a id="mutationjiraimportstartusersmapping"></a>`usersMapping` | [`[JiraUsersMappingInputType!]`](#jirausersmappinginputtype) | Mapping of Jira to GitLab users. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjiraimportstartclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjiraimportstarterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationjiraimportstartjiraimport"></a>`jiraImport` | [`JiraImport`](#jiraimport) | Jira import data after mutation. |
|
|
|
|
### `Mutation.jiraImportUsers`
|
|
|
|
Input type: `JiraImportUsersInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjiraimportusersclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjiraimportusersprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to import the Jira users into. |
|
|
| <a id="mutationjiraimportusersstartat"></a>`startAt` | [`Int`](#int) | Index of the record the import should started at, default 0 (50 records returned). |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjiraimportusersclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjiraimportuserserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationjiraimportusersjirausers"></a>`jiraUsers` | [`[JiraUser!]`](#jirauser) | Users returned from Jira, matched by email and name if possible. |
|
|
|
|
### `Mutation.jobCancel`
|
|
|
|
Input type: `JobCancelInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjobcancelclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjobcancelid"></a>`id` | [`CiBuildID!`](#cibuildid) | ID of the job to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjobcancelclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjobcancelerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationjobcanceljob"></a>`job` | [`CiJob`](#cijob) | Job after the mutation. |
|
|
|
|
### `Mutation.jobPlay`
|
|
|
|
Input type: `JobPlayInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjobplayclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjobplayid"></a>`id` | [`CiBuildID!`](#cibuildid) | ID of the job to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjobplayclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjobplayerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationjobplayjob"></a>`job` | [`CiJob`](#cijob) | Job after the mutation. |
|
|
|
|
### `Mutation.jobRetry`
|
|
|
|
Input type: `JobRetryInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjobretryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjobretryid"></a>`id` | [`CiBuildID!`](#cibuildid) | ID of the job to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjobretryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjobretryerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationjobretryjob"></a>`job` | [`CiJob`](#cijob) | Job after the mutation. |
|
|
|
|
### `Mutation.jobUnschedule`
|
|
|
|
Input type: `JobUnscheduleInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjobunscheduleclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjobunscheduleid"></a>`id` | [`CiBuildID!`](#cibuildid) | ID of the job to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationjobunscheduleclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationjobunscheduleerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationjobunschedulejob"></a>`job` | [`CiJob`](#cijob) | Job after the mutation. |
|
|
|
|
### `Mutation.labelCreate`
|
|
|
|
Input type: `LabelCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationlabelcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationlabelcreatecolor"></a>`color` | [`String`](#string) | The color of the label given in 6-digit hex notation with leading '#' sign (for example, `#FFAABB`) or one of the CSS color names. |
|
|
| <a id="mutationlabelcreatedescription"></a>`description` | [`String`](#string) | Description of the label. |
|
|
| <a id="mutationlabelcreategrouppath"></a>`groupPath` | [`ID`](#id) | Full path of the group with which the resource is associated. |
|
|
| <a id="mutationlabelcreateprojectpath"></a>`projectPath` | [`ID`](#id) | Full path of the project with which the resource is associated. |
|
|
| <a id="mutationlabelcreatetitle"></a>`title` | [`String!`](#string) | Title of the label. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationlabelcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationlabelcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationlabelcreatelabel"></a>`label` | [`Label`](#label) | Label after mutation. |
|
|
|
|
### `Mutation.markAsSpamSnippet`
|
|
|
|
Input type: `MarkAsSpamSnippetInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmarkasspamsnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmarkasspamsnippetid"></a>`id` | [`SnippetID!`](#snippetid) | Global ID of the snippet to update. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmarkasspamsnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmarkasspamsnippeterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmarkasspamsnippetsnippet"></a>`snippet` | [`Snippet`](#snippet) | Snippet after mutation. |
|
|
|
|
### `Mutation.mergeRequestAccept`
|
|
|
|
Accepts a merge request.
|
|
When accepted, the source branch will be merged into the target branch, either
|
|
immediately if possible, or using one of the automatic merge strategies.
|
|
|
|
Input type: `MergeRequestAcceptInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestacceptclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestacceptcommitmessage"></a>`commitMessage` | [`String`](#string) | Custom merge commit message. |
|
|
| <a id="mutationmergerequestacceptiid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestacceptprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
| <a id="mutationmergerequestacceptsha"></a>`sha` | [`String!`](#string) | HEAD SHA at the time when this merge was requested. |
|
|
| <a id="mutationmergerequestacceptshouldremovesourcebranch"></a>`shouldRemoveSourceBranch` | [`Boolean`](#boolean) | Should the source branch be removed. |
|
|
| <a id="mutationmergerequestacceptsquash"></a>`squash` | [`Boolean`](#boolean) | Squash commits on the source branch before merge. |
|
|
| <a id="mutationmergerequestacceptsquashcommitmessage"></a>`squashCommitMessage` | [`String`](#string) | Custom squash commit message (if squash is true). |
|
|
| <a id="mutationmergerequestacceptstrategy"></a>`strategy` | [`MergeStrategyEnum`](#mergestrategyenum) | How to merge this merge request. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestacceptclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestaccepterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestacceptmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestCreate`
|
|
|
|
Input type: `MergeRequestCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestcreatedescription"></a>`description` | [`String`](#string) | Description of the merge request (Markdown rendered as HTML for caching). |
|
|
| <a id="mutationmergerequestcreatelabels"></a>`labels` | [`[String!]`](#string) | Labels of the merge request. |
|
|
| <a id="mutationmergerequestcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project full path the merge request is associated with. |
|
|
| <a id="mutationmergerequestcreatesourcebranch"></a>`sourceBranch` | [`String!`](#string) | Source branch of the merge request. |
|
|
| <a id="mutationmergerequestcreatetargetbranch"></a>`targetBranch` | [`String!`](#string) | Target branch of the merge request. |
|
|
| <a id="mutationmergerequestcreatetitle"></a>`title` | [`String!`](#string) | Title of the merge request. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestcreatemergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestRemoveAttentionRequest`
|
|
|
|
Input type: `MergeRequestRemoveAttentionRequestInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestremoveattentionrequestclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestremoveattentionrequestiid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestremoveattentionrequestprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
| <a id="mutationmergerequestremoveattentionrequestuserid"></a>`userId` | [`UserID!`](#userid) | User ID of the user for attention request removal. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestremoveattentionrequestclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestremoveattentionrequesterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestremoveattentionrequestmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestRequestAttention`
|
|
|
|
Input type: `MergeRequestRequestAttentionInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestrequestattentionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestrequestattentioniid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestrequestattentionprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
| <a id="mutationmergerequestrequestattentionuserid"></a>`userId` | [`UserID!`](#userid) | User ID of the user to request attention. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestrequestattentionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestrequestattentionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestrequestattentionmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestReviewerRereview`
|
|
|
|
Input type: `MergeRequestReviewerRereviewInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestreviewerrereviewclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestreviewerrereviewiid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestreviewerrereviewprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
| <a id="mutationmergerequestreviewerrereviewuserid"></a>`userId` | [`UserID!`](#userid) | User ID for the user that has been requested for a new review. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestreviewerrereviewclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestreviewerrereviewerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestreviewerrereviewmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestSetAssignees`
|
|
|
|
Input type: `MergeRequestSetAssigneesInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetassigneesassigneeusernames"></a>`assigneeUsernames` | [`[String!]!`](#string) | Usernames to assign to the resource. Replaces existing assignees by default. |
|
|
| <a id="mutationmergerequestsetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetassigneesiid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestsetassigneesoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | Operation to perform. Defaults to REPLACE. |
|
|
| <a id="mutationmergerequestsetassigneesprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetassigneesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetassigneeserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestsetassigneesmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestSetDraft`
|
|
|
|
Input type: `MergeRequestSetDraftInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetdraftclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetdraftdraft"></a>`draft` | [`Boolean!`](#boolean) | Whether or not to set the merge request as a draft. |
|
|
| <a id="mutationmergerequestsetdraftiid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestsetdraftprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetdraftclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetdrafterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestsetdraftmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestSetLabels`
|
|
|
|
Input type: `MergeRequestSetLabelsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetlabelsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetlabelsiid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestsetlabelslabelids"></a>`labelIds` | [`[LabelID!]!`](#labelid) | Label IDs to set. Replaces existing labels by default. |
|
|
| <a id="mutationmergerequestsetlabelsoperationmode"></a>`operationMode` | [`MutationOperationMode`](#mutationoperationmode) | Changes the operation mode. Defaults to REPLACE. |
|
|
| <a id="mutationmergerequestsetlabelsprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetlabelsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetlabelserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestsetlabelsmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestSetLocked`
|
|
|
|
Input type: `MergeRequestSetLockedInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetlockediid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestsetlockedlocked"></a>`locked` | [`Boolean!`](#boolean) | Whether or not to lock the merge request. |
|
|
| <a id="mutationmergerequestsetlockedprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetlockederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestsetlockedmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestSetMilestone`
|
|
|
|
Input type: `MergeRequestSetMilestoneInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetmilestoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetmilestoneiid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestsetmilestonemilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | Milestone to assign to the merge request. |
|
|
| <a id="mutationmergerequestsetmilestoneprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetmilestoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetmilestoneerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestsetmilestonemergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestSetSubscription`
|
|
|
|
Input type: `MergeRequestSetSubscriptionInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetsubscriptioniid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestsetsubscriptionprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
| <a id="mutationmergerequestsetsubscriptionsubscribedstate"></a>`subscribedState` | [`Boolean!`](#boolean) | Desired state of the subscription. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestsetsubscriptionclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestsetsubscriptionerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestsetsubscriptionmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestToggleAttentionRequested`
|
|
|
|
Input type: `MergeRequestToggleAttentionRequestedInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequesttoggleattentionrequestedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequesttoggleattentionrequestediid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequesttoggleattentionrequestedprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
| <a id="mutationmergerequesttoggleattentionrequesteduserid"></a>`userId` | [`UserID!`](#userid) | User ID for the user to toggle attention requested. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequesttoggleattentionrequestedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequesttoggleattentionrequestederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequesttoggleattentionrequestedmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.mergeRequestUpdate`
|
|
|
|
Update attributes of a merge request.
|
|
|
|
Input type: `MergeRequestUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestupdatedescription"></a>`description` | [`String`](#string) | Description of the merge request (Markdown rendered as HTML for caching). |
|
|
| <a id="mutationmergerequestupdateiid"></a>`iid` | [`String!`](#string) | IID of the merge request to mutate. |
|
|
| <a id="mutationmergerequestupdateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the merge request to mutate is in. |
|
|
| <a id="mutationmergerequestupdatestate"></a>`state` | [`MergeRequestNewState`](#mergerequestnewstate) | Action to perform to change the state. |
|
|
| <a id="mutationmergerequestupdatetargetbranch"></a>`targetBranch` | [`String`](#string) | Target branch of the merge request. |
|
|
| <a id="mutationmergerequestupdatetitle"></a>`title` | [`String`](#string) | Title of the merge request. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationmergerequestupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationmergerequestupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationmergerequestupdatemergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request after mutation. |
|
|
|
|
### `Mutation.namespaceCiCdSettingsUpdate`
|
|
|
|
Input type: `NamespaceCiCdSettingsUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationnamespacecicdsettingsupdateallowstalerunnerpruning"></a>`allowStaleRunnerPruning` | [`Boolean`](#boolean) | Indicates if stale runners directly belonging to this namespace should be periodically pruned. |
|
|
| <a id="mutationnamespacecicdsettingsupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationnamespacecicdsettingsupdatefullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the namespace the settings belong to. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationnamespacecicdsettingsupdatecicdsettings"></a>`ciCdSettings` | [`NamespaceCiCdSetting!`](#namespacecicdsetting) | CI/CD settings after mutation. |
|
|
| <a id="mutationnamespacecicdsettingsupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationnamespacecicdsettingsupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.namespaceIncreaseStorageTemporarily`
|
|
|
|
Input type: `NamespaceIncreaseStorageTemporarilyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationnamespaceincreasestoragetemporarilyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationnamespaceincreasestoragetemporarilyid"></a>`id` | [`NamespaceID!`](#namespaceid) | Global ID of the namespace to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationnamespaceincreasestoragetemporarilyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationnamespaceincreasestoragetemporarilyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationnamespaceincreasestoragetemporarilynamespace"></a>`namespace` | [`Namespace`](#namespace) | Namespace after mutation. |
|
|
|
|
### `Mutation.oncallRotationCreate`
|
|
|
|
Input type: `OncallRotationCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallrotationcreateactiveperiod"></a>`activePeriod` | [`OncallRotationActivePeriodInputType`](#oncallrotationactiveperiodinputtype) | Active period of time that the on-call rotation should take place. |
|
|
| <a id="mutationoncallrotationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallrotationcreateendsat"></a>`endsAt` | [`OncallRotationDateInputType`](#oncallrotationdateinputtype) | End date and time of the on-call rotation, in the timezone of the on-call schedule. |
|
|
| <a id="mutationoncallrotationcreatename"></a>`name` | [`String!`](#string) | Name of the on-call rotation. |
|
|
| <a id="mutationoncallrotationcreateparticipants"></a>`participants` | [`[OncallUserInputType!]!`](#oncalluserinputtype) | Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. |
|
|
| <a id="mutationoncallrotationcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to create the on-call schedule in. |
|
|
| <a id="mutationoncallrotationcreaterotationlength"></a>`rotationLength` | [`OncallRotationLengthInputType!`](#oncallrotationlengthinputtype) | Rotation length of the on-call rotation. |
|
|
| <a id="mutationoncallrotationcreatescheduleiid"></a>`scheduleIid` | [`String!`](#string) | IID of the on-call schedule to create the on-call rotation in. |
|
|
| <a id="mutationoncallrotationcreatestartsat"></a>`startsAt` | [`OncallRotationDateInputType!`](#oncallrotationdateinputtype) | Start date and time of the on-call rotation, in the timezone of the on-call schedule. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallrotationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallrotationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationoncallrotationcreateoncallrotation"></a>`oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | On-call rotation. |
|
|
|
|
### `Mutation.oncallRotationDestroy`
|
|
|
|
Input type: `OncallRotationDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallrotationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallrotationdestroyid"></a>`id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | ID of the on-call rotation to remove. |
|
|
| <a id="mutationoncallrotationdestroyprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to remove the on-call schedule from. |
|
|
| <a id="mutationoncallrotationdestroyscheduleiid"></a>`scheduleIid` | [`String!`](#string) | IID of the on-call schedule to the on-call rotation belongs to. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallrotationdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallrotationdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationoncallrotationdestroyoncallrotation"></a>`oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | On-call rotation. |
|
|
|
|
### `Mutation.oncallRotationUpdate`
|
|
|
|
Input type: `OncallRotationUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallrotationupdateactiveperiod"></a>`activePeriod` | [`OncallRotationActivePeriodInputType`](#oncallrotationactiveperiodinputtype) | Active period of time that the on-call rotation should take place. |
|
|
| <a id="mutationoncallrotationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallrotationupdateendsat"></a>`endsAt` | [`OncallRotationDateInputType`](#oncallrotationdateinputtype) | End date and time of the on-call rotation, in the timezone of the on-call schedule. |
|
|
| <a id="mutationoncallrotationupdateid"></a>`id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | ID of the on-call schedule to create the on-call rotation in. |
|
|
| <a id="mutationoncallrotationupdatename"></a>`name` | [`String`](#string) | Name of the on-call rotation. |
|
|
| <a id="mutationoncallrotationupdateparticipants"></a>`participants` | [`[OncallUserInputType!]`](#oncalluserinputtype) | Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. |
|
|
| <a id="mutationoncallrotationupdaterotationlength"></a>`rotationLength` | [`OncallRotationLengthInputType`](#oncallrotationlengthinputtype) | Rotation length of the on-call rotation. |
|
|
| <a id="mutationoncallrotationupdatestartsat"></a>`startsAt` | [`OncallRotationDateInputType`](#oncallrotationdateinputtype) | Start date and time of the on-call rotation, in the timezone of the on-call schedule. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallrotationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallrotationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationoncallrotationupdateoncallrotation"></a>`oncallRotation` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | On-call rotation. |
|
|
|
|
### `Mutation.oncallScheduleCreate`
|
|
|
|
Input type: `OncallScheduleCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallschedulecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallschedulecreatedescription"></a>`description` | [`String`](#string) | Description of the on-call schedule. |
|
|
| <a id="mutationoncallschedulecreatename"></a>`name` | [`String!`](#string) | Name of the on-call schedule. |
|
|
| <a id="mutationoncallschedulecreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to create the on-call schedule in. |
|
|
| <a id="mutationoncallschedulecreatetimezone"></a>`timezone` | [`String!`](#string) | Timezone of the on-call schedule. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallschedulecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallschedulecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationoncallschedulecreateoncallschedule"></a>`oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | On-call schedule. |
|
|
|
|
### `Mutation.oncallScheduleDestroy`
|
|
|
|
Input type: `OncallScheduleDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallscheduledestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallscheduledestroyiid"></a>`iid` | [`String!`](#string) | On-call schedule internal ID to remove. |
|
|
| <a id="mutationoncallscheduledestroyprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to remove the on-call schedule from. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallscheduledestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallscheduledestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationoncallscheduledestroyoncallschedule"></a>`oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | On-call schedule. |
|
|
|
|
### `Mutation.oncallScheduleUpdate`
|
|
|
|
Input type: `OncallScheduleUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallscheduleupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallscheduleupdatedescription"></a>`description` | [`String`](#string) | Description of the on-call schedule. |
|
|
| <a id="mutationoncallscheduleupdateiid"></a>`iid` | [`String!`](#string) | On-call schedule internal ID to update. |
|
|
| <a id="mutationoncallscheduleupdatename"></a>`name` | [`String`](#string) | Name of the on-call schedule. |
|
|
| <a id="mutationoncallscheduleupdateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to update the on-call schedule in. |
|
|
| <a id="mutationoncallscheduleupdatetimezone"></a>`timezone` | [`String`](#string) | Timezone of the on-call schedule. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationoncallscheduleupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationoncallscheduleupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationoncallscheduleupdateoncallschedule"></a>`oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | On-call schedule. |
|
|
|
|
### `Mutation.pipelineCancel`
|
|
|
|
Input type: `PipelineCancelInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationpipelinecancelclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationpipelinecancelid"></a>`id` | [`CiPipelineID!`](#cipipelineid) | ID of the pipeline to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationpipelinecancelclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationpipelinecancelerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.pipelineDestroy`
|
|
|
|
Input type: `PipelineDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationpipelinedestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationpipelinedestroyid"></a>`id` | [`CiPipelineID!`](#cipipelineid) | ID of the pipeline to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationpipelinedestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationpipelinedestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.pipelineRetry`
|
|
|
|
Input type: `PipelineRetryInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationpipelineretryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationpipelineretryid"></a>`id` | [`CiPipelineID!`](#cipipelineid) | ID of the pipeline to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationpipelineretryclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationpipelineretryerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationpipelineretrypipeline"></a>`pipeline` | [`Pipeline`](#pipeline) | Pipeline after mutation. |
|
|
|
|
### `Mutation.projectCiCdSettingsUpdate`
|
|
|
|
Input type: `ProjectCiCdSettingsUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprojectcicdsettingsupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprojectcicdsettingsupdatefullpath"></a>`fullPath` | [`ID!`](#id) | Full Path of the project the settings belong to. |
|
|
| <a id="mutationprojectcicdsettingsupdatejobtokenscopeenabled"></a>`jobTokenScopeEnabled` | [`Boolean`](#boolean) | Indicates CI job tokens generated in this project have restricted access to resources. |
|
|
| <a id="mutationprojectcicdsettingsupdatekeeplatestartifact"></a>`keepLatestArtifact` | [`Boolean`](#boolean) | Indicates if the latest artifact should be kept for this project. |
|
|
| <a id="mutationprojectcicdsettingsupdatemergepipelinesenabled"></a>`mergePipelinesEnabled` | [`Boolean`](#boolean) | Indicates if merge pipelines are enabled for the project. |
|
|
| <a id="mutationprojectcicdsettingsupdatemergetrainsenabled"></a>`mergeTrainsEnabled` | [`Boolean`](#boolean) | Indicates if merge trains are enabled for the project. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprojectcicdsettingsupdatecicdsettings"></a>`ciCdSettings` | [`ProjectCiCdSetting!`](#projectcicdsetting) | CI/CD settings after mutation. |
|
|
| <a id="mutationprojectcicdsettingsupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprojectcicdsettingsupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.projectSetComplianceFramework`
|
|
|
|
Assign (or unset) a compliance framework to a project.
|
|
|
|
Input type: `ProjectSetComplianceFrameworkInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprojectsetcomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprojectsetcomplianceframeworkcomplianceframeworkid"></a>`complianceFrameworkId` | [`ComplianceManagementFrameworkID`](#compliancemanagementframeworkid) | ID of the compliance framework to assign to the project. Set to `null` to unset. |
|
|
| <a id="mutationprojectsetcomplianceframeworkprojectid"></a>`projectId` | [`ProjectID!`](#projectid) | ID of the project to change the compliance framework of. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprojectsetcomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprojectsetcomplianceframeworkerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationprojectsetcomplianceframeworkproject"></a>`project` | [`Project`](#project) | Project after mutation. |
|
|
|
|
### `Mutation.projectSetLocked`
|
|
|
|
Input type: `ProjectSetLockedInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprojectsetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprojectsetlockedfilepath"></a>`filePath` | [`String!`](#string) | Full path to the file. |
|
|
| <a id="mutationprojectsetlockedlock"></a>`lock` | [`Boolean!`](#boolean) | Whether or not to lock the file path. |
|
|
| <a id="mutationprojectsetlockedprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprojectsetlockedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprojectsetlockederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationprojectsetlockedproject"></a>`project` | [`Project`](#project) | Project after mutation. |
|
|
|
|
### `Mutation.prometheusIntegrationCreate`
|
|
|
|
Input type: `PrometheusIntegrationCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprometheusintegrationcreateactive"></a>`active` | [`Boolean!`](#boolean) | Whether the integration is receiving alerts. |
|
|
| <a id="mutationprometheusintegrationcreateapiurl"></a>`apiUrl` | [`String!`](#string) | Endpoint at which Prometheus can be queried. |
|
|
| <a id="mutationprometheusintegrationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprometheusintegrationcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Project to create the integration in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprometheusintegrationcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprometheusintegrationcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationprometheusintegrationcreateintegration"></a>`integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | Newly created integration. |
|
|
|
|
### `Mutation.prometheusIntegrationResetToken`
|
|
|
|
Input type: `PrometheusIntegrationResetTokenInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprometheusintegrationresettokenclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprometheusintegrationresettokenid"></a>`id` | [`IntegrationsPrometheusID!`](#integrationsprometheusid) | ID of the integration to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprometheusintegrationresettokenclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprometheusintegrationresettokenerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationprometheusintegrationresettokenintegration"></a>`integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | Newly created integration. |
|
|
|
|
### `Mutation.prometheusIntegrationUpdate`
|
|
|
|
Input type: `PrometheusIntegrationUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprometheusintegrationupdateactive"></a>`active` | [`Boolean`](#boolean) | Whether the integration is receiving alerts. |
|
|
| <a id="mutationprometheusintegrationupdateapiurl"></a>`apiUrl` | [`String`](#string) | Endpoint at which Prometheus can be queried. |
|
|
| <a id="mutationprometheusintegrationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprometheusintegrationupdateid"></a>`id` | [`IntegrationsPrometheusID!`](#integrationsprometheusid) | ID of the integration to mutate. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationprometheusintegrationupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationprometheusintegrationupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationprometheusintegrationupdateintegration"></a>`integration` | [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration) | Newly created integration. |
|
|
|
|
### `Mutation.promoteToEpic`
|
|
|
|
Input type: `PromoteToEpicInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationpromotetoepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationpromotetoepicgrouppath"></a>`groupPath` | [`ID`](#id) | Group the promoted epic will belong to. |
|
|
| <a id="mutationpromotetoepiciid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationpromotetoepicprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationpromotetoepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationpromotetoepicepic"></a>`epic` | [`Epic`](#epic) | Epic after issue promotion. |
|
|
| <a id="mutationpromotetoepicerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationpromotetoepicissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.releaseAssetLinkCreate`
|
|
|
|
Input type: `ReleaseAssetLinkCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleaseassetlinkcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleaseassetlinkcreatedirectassetpath"></a>`directAssetPath` | [`String`](#string) | Relative path for a direct asset link. |
|
|
| <a id="mutationreleaseassetlinkcreatelinktype"></a>`linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | Type of the asset link. |
|
|
| <a id="mutationreleaseassetlinkcreatename"></a>`name` | [`String!`](#string) | Name of the asset link. |
|
|
| <a id="mutationreleaseassetlinkcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the asset link is associated with. |
|
|
| <a id="mutationreleaseassetlinkcreatetagname"></a>`tagName` | [`String!`](#string) | Name of the associated release's tag. |
|
|
| <a id="mutationreleaseassetlinkcreateurl"></a>`url` | [`String!`](#string) | URL of the asset link. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleaseassetlinkcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleaseassetlinkcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationreleaseassetlinkcreatelink"></a>`link` | [`ReleaseAssetLink`](#releaseassetlink) | Asset link after mutation. |
|
|
|
|
### `Mutation.releaseAssetLinkDelete`
|
|
|
|
Input type: `ReleaseAssetLinkDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleaseassetlinkdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleaseassetlinkdeleteid"></a>`id` | [`ReleasesLinkID!`](#releaseslinkid) | ID of the release asset link to delete. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleaseassetlinkdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleaseassetlinkdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationreleaseassetlinkdeletelink"></a>`link` | [`ReleaseAssetLink`](#releaseassetlink) | Deleted release asset link. |
|
|
|
|
### `Mutation.releaseAssetLinkUpdate`
|
|
|
|
Input type: `ReleaseAssetLinkUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleaseassetlinkupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleaseassetlinkupdatedirectassetpath"></a>`directAssetPath` | [`String`](#string) | Relative path for a direct asset link. |
|
|
| <a id="mutationreleaseassetlinkupdateid"></a>`id` | [`ReleasesLinkID!`](#releaseslinkid) | ID of the release asset link to update. |
|
|
| <a id="mutationreleaseassetlinkupdatelinktype"></a>`linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | Type of the asset link. |
|
|
| <a id="mutationreleaseassetlinkupdatename"></a>`name` | [`String`](#string) | Name of the asset link. |
|
|
| <a id="mutationreleaseassetlinkupdateurl"></a>`url` | [`String`](#string) | URL of the asset link. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleaseassetlinkupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleaseassetlinkupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationreleaseassetlinkupdatelink"></a>`link` | [`ReleaseAssetLink`](#releaseassetlink) | Asset link after mutation. |
|
|
|
|
### `Mutation.releaseCreate`
|
|
|
|
Input type: `ReleaseCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleasecreateassets"></a>`assets` | [`ReleaseAssetsInput`](#releaseassetsinput) | Assets associated to the release. |
|
|
| <a id="mutationreleasecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleasecreatedescription"></a>`description` | [`String`](#string) | Description (also known as "release notes") of the release. |
|
|
| <a id="mutationreleasecreatemilestones"></a>`milestones` | [`[String!]`](#string) | Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. |
|
|
| <a id="mutationreleasecreatename"></a>`name` | [`String`](#string) | Name of the release. |
|
|
| <a id="mutationreleasecreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the release is associated with. |
|
|
| <a id="mutationreleasecreateref"></a>`ref` | [`String`](#string) | Commit SHA or branch name to use if creating a new tag. |
|
|
| <a id="mutationreleasecreatereleasedat"></a>`releasedAt` | [`Time`](#time) | Date and time for the release. Defaults to the current date and time. |
|
|
| <a id="mutationreleasecreatetagmessage"></a>`tagMessage` | [`String`](#string) | Message to use if creating a new annotated tag. |
|
|
| <a id="mutationreleasecreatetagname"></a>`tagName` | [`String!`](#string) | Name of the tag to associate with the release. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleasecreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleasecreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationreleasecreaterelease"></a>`release` | [`Release`](#release) | Release after mutation. |
|
|
|
|
### `Mutation.releaseDelete`
|
|
|
|
Input type: `ReleaseDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleasedeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleasedeleteprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the release is associated with. |
|
|
| <a id="mutationreleasedeletetagname"></a>`tagName` | [`String!`](#string) | Name of the tag associated with the release to delete. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleasedeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleasedeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationreleasedeleterelease"></a>`release` | [`Release`](#release) | Deleted release. |
|
|
|
|
### `Mutation.releaseUpdate`
|
|
|
|
Input type: `ReleaseUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleaseupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleaseupdatedescription"></a>`description` | [`String`](#string) | Description (release notes) of the release. |
|
|
| <a id="mutationreleaseupdatemilestones"></a>`milestones` | [`[String!]`](#string) | Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. |
|
|
| <a id="mutationreleaseupdatename"></a>`name` | [`String`](#string) | Name of the release. |
|
|
| <a id="mutationreleaseupdateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the release is associated with. |
|
|
| <a id="mutationreleaseupdatereleasedat"></a>`releasedAt` | [`Time`](#time) | Release date. |
|
|
| <a id="mutationreleaseupdatetagname"></a>`tagName` | [`String!`](#string) | Name of the tag associated with the release. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationreleaseupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationreleaseupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationreleaseupdaterelease"></a>`release` | [`Release`](#release) | Release after mutation. |
|
|
|
|
### `Mutation.removeProjectFromSecurityDashboard`
|
|
|
|
Input type: `RemoveProjectFromSecurityDashboardInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationremoveprojectfromsecuritydashboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationremoveprojectfromsecuritydashboardid"></a>`id` | [`ProjectID!`](#projectid) | ID of the project to remove from the Instance Security Dashboard. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationremoveprojectfromsecuritydashboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationremoveprojectfromsecuritydashboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.repositionImageDiffNote`
|
|
|
|
Repositions a DiffNote on an image (a `Note` where the `position.positionType` is `"image"`).
|
|
|
|
Input type: `RepositionImageDiffNoteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationrepositionimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationrepositionimagediffnoteid"></a>`id` | [`DiffNoteID!`](#diffnoteid) | Global ID of the DiffNote to update. |
|
|
| <a id="mutationrepositionimagediffnoteposition"></a>`position` | [`UpdateDiffImagePositionInput!`](#updatediffimagepositioninput) | Position of this note on a diff. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationrepositionimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationrepositionimagediffnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationrepositionimagediffnotenote"></a>`note` | [`Note`](#note) | Note after mutation. |
|
|
|
|
### `Mutation.runnerDelete`
|
|
|
|
Input type: `RunnerDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationrunnerdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationrunnerdeleteid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | ID of the runner to delete. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationrunnerdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationrunnerdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.runnerUpdate`
|
|
|
|
Input type: `RunnerUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationrunnerupdateaccesslevel"></a>`accessLevel` | [`CiRunnerAccessLevel`](#cirunneraccesslevel) | Access level of the runner. |
|
|
| <a id="mutationrunnerupdateactive"></a>`active` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated:** This was renamed. Please use `paused`. Deprecated in 14.8. |
|
|
| <a id="mutationrunnerupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationrunnerupdatedescription"></a>`description` | [`String`](#string) | Description of the runner. |
|
|
| <a id="mutationrunnerupdateid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | ID of the runner to update. |
|
|
| <a id="mutationrunnerupdatelocked"></a>`locked` | [`Boolean`](#boolean) | Indicates the runner is locked. |
|
|
| <a id="mutationrunnerupdatemaintenancenote"></a>`maintenanceNote` | [`String`](#string) | Runner's maintenance notes. |
|
|
| <a id="mutationrunnerupdatemaximumtimeout"></a>`maximumTimeout` | [`Int`](#int) | Maximum timeout (in seconds) for jobs processed by the runner. |
|
|
| <a id="mutationrunnerupdatepaused"></a>`paused` | [`Boolean`](#boolean) | Indicates the runner is not allowed to receive jobs. |
|
|
| <a id="mutationrunnerupdateprivateprojectsminutescostfactor"></a>`privateProjectsMinutesCostFactor` | [`Float`](#float) | Private projects' "minutes cost factor" associated with the runner (GitLab.com only). |
|
|
| <a id="mutationrunnerupdatepublicprojectsminutescostfactor"></a>`publicProjectsMinutesCostFactor` | [`Float`](#float) | Public projects' "minutes cost factor" associated with the runner (GitLab.com only). |
|
|
| <a id="mutationrunnerupdaterununtagged"></a>`runUntagged` | [`Boolean`](#boolean) | Indicates the runner is able to run untagged jobs. |
|
|
| <a id="mutationrunnerupdatetaglist"></a>`tagList` | [`[String!]`](#string) | Tags associated with the runner. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationrunnerupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationrunnerupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationrunnerupdaterunner"></a>`runner` | [`CiRunner`](#cirunner) | Runner after mutation. |
|
|
|
|
### `Mutation.runnersRegistrationTokenReset`
|
|
|
|
Input type: `RunnersRegistrationTokenResetInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationrunnersregistrationtokenresetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationrunnersregistrationtokenresetid"></a>`id` | [`ID`](#id) | ID of the project or group to reset the token for. Omit if resetting instance runner token. |
|
|
| <a id="mutationrunnersregistrationtokenresettype"></a>`type` | [`CiRunnerType!`](#cirunnertype) | Scope of the object to reset the token for. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationrunnersregistrationtokenresetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationrunnersregistrationtokenreseterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationrunnersregistrationtokenresettoken"></a>`token` | [`String`](#string) | Runner token after mutation. |
|
|
|
|
### `Mutation.savedReplyCreate`
|
|
|
|
Input type: `SavedReplyCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsavedreplycreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsavedreplycreatecontent"></a>`content` | [`String!`](#string) | Content of the saved reply. |
|
|
| <a id="mutationsavedreplycreatename"></a>`name` | [`String!`](#string) | Name of the saved reply. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsavedreplycreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsavedreplycreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationsavedreplycreatesavedreply"></a>`savedReply` | [`SavedReply`](#savedreply) | Saved reply after mutation. |
|
|
|
|
### `Mutation.savedReplyDestroy`
|
|
|
|
Input type: `SavedReplyDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsavedreplydestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsavedreplydestroyid"></a>`id` | [`UsersSavedReplyID!`](#userssavedreplyid) | Global ID of the saved reply. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsavedreplydestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsavedreplydestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationsavedreplydestroysavedreply"></a>`savedReply` | [`SavedReply`](#savedreply) | Saved reply after mutation. |
|
|
|
|
### `Mutation.savedReplyUpdate`
|
|
|
|
Input type: `SavedReplyUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsavedreplyupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsavedreplyupdatecontent"></a>`content` | [`String!`](#string) | Content of the saved reply. |
|
|
| <a id="mutationsavedreplyupdateid"></a>`id` | [`UsersSavedReplyID!`](#userssavedreplyid) | Global ID of the saved reply. |
|
|
| <a id="mutationsavedreplyupdatename"></a>`name` | [`String!`](#string) | Name of the saved reply. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsavedreplyupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsavedreplyupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationsavedreplyupdatesavedreply"></a>`savedReply` | [`SavedReply`](#savedreply) | Saved reply after mutation. |
|
|
|
|
### `Mutation.scanExecutionPolicyCommit`
|
|
|
|
Commits the `policy_yaml` content to the assigned security policy project for the given project (`full_path`).
|
|
|
|
Input type: `ScanExecutionPolicyCommitInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationscanexecutionpolicycommitclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationscanexecutionpolicycommitfullpath"></a>`fullPath` | [`String`](#string) | Full path of the project. |
|
|
| <a id="mutationscanexecutionpolicycommitname"></a>`name` | [`String`](#string) | Name of the policy. If the name is null, the `name` field from `policy_yaml` is used. |
|
|
| <a id="mutationscanexecutionpolicycommitoperationmode"></a>`operationMode` | [`MutationOperationMode!`](#mutationoperationmode) | Changes the operation mode. |
|
|
| <a id="mutationscanexecutionpolicycommitpolicyyaml"></a>`policyYaml` | [`String!`](#string) | YAML snippet of the policy. |
|
|
| <a id="mutationscanexecutionpolicycommitprojectpath"></a>`projectPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Use `fullPath`. Deprecated in 14.10. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationscanexecutionpolicycommitbranch"></a>`branch` | [`String`](#string) | Name of the branch to which the policy changes are committed. |
|
|
| <a id="mutationscanexecutionpolicycommitclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationscanexecutionpolicycommiterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.securityPolicyProjectAssign`
|
|
|
|
Assigns the specified project(`security_policy_project_id`) as security policy project for the given project(`full_path`). If the project already has a security policy project, this reassigns the project's security policy project with the given `security_policy_project_id`.
|
|
|
|
Input type: `SecurityPolicyProjectAssignInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsecuritypolicyprojectassignclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsecuritypolicyprojectassignfullpath"></a>`fullPath` | [`String`](#string) | Full path of the project or group. |
|
|
| <a id="mutationsecuritypolicyprojectassignprojectpath"></a>`projectPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Use `fullPath`. Deprecated in 14.10. |
|
|
| <a id="mutationsecuritypolicyprojectassignsecuritypolicyprojectid"></a>`securityPolicyProjectId` | [`ProjectID!`](#projectid) | ID of the security policy project. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsecuritypolicyprojectassignclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsecuritypolicyprojectassignerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.securityPolicyProjectCreate`
|
|
|
|
Creates and assigns a security policy project for the given project (`full_path`).
|
|
|
|
Input type: `SecurityPolicyProjectCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsecuritypolicyprojectcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsecuritypolicyprojectcreatefullpath"></a>`fullPath` | [`String`](#string) | Full path of the project or group. |
|
|
| <a id="mutationsecuritypolicyprojectcreateprojectpath"></a>`projectPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Use `fullPath`. Deprecated in 14.10. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsecuritypolicyprojectcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsecuritypolicyprojectcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationsecuritypolicyprojectcreateproject"></a>`project` | [`Project`](#project) | Security Policy Project that was created. |
|
|
|
|
### `Mutation.securityPolicyProjectUnassign`
|
|
|
|
Unassigns the security policy project for the given project (`full_path`).
|
|
|
|
Input type: `SecurityPolicyProjectUnassignInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsecuritypolicyprojectunassignclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsecuritypolicyprojectunassignfullpath"></a>`fullPath` | [`String`](#string) | Full path of the project or group. |
|
|
| <a id="mutationsecuritypolicyprojectunassignprojectpath"></a>`projectPath` **{warning-solid}** | [`ID`](#id) | **Deprecated:** Use `fullPath`. Deprecated in 14.10. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsecuritypolicyprojectunassignclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsecuritypolicyprojectunassignerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.securityTrainingUpdate`
|
|
|
|
Input type: `SecurityTrainingUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsecuritytrainingupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsecuritytrainingupdateisenabled"></a>`isEnabled` | [`Boolean!`](#boolean) | Sets the training provider as enabled for the project. |
|
|
| <a id="mutationsecuritytrainingupdateisprimary"></a>`isPrimary` | [`Boolean`](#boolean) | Sets the training provider as primary for the project. |
|
|
| <a id="mutationsecuritytrainingupdateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project. |
|
|
| <a id="mutationsecuritytrainingupdateproviderid"></a>`providerId` | [`SecurityTrainingProviderID!`](#securitytrainingproviderid) | ID of the provider. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationsecuritytrainingupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationsecuritytrainingupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationsecuritytrainingupdatetraining"></a>`training` | [`ProjectSecurityTraining`](#projectsecuritytraining) | Represents the training entity subject to mutation. |
|
|
|
|
### `Mutation.terraformStateDelete`
|
|
|
|
Input type: `TerraformStateDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationterraformstatedeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationterraformstatedeleteid"></a>`id` | [`TerraformStateID!`](#terraformstateid) | Global ID of the Terraform state. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationterraformstatedeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationterraformstatedeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.terraformStateLock`
|
|
|
|
Input type: `TerraformStateLockInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationterraformstatelockclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationterraformstatelockid"></a>`id` | [`TerraformStateID!`](#terraformstateid) | Global ID of the Terraform state. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationterraformstatelockclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationterraformstatelockerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.terraformStateUnlock`
|
|
|
|
Input type: `TerraformStateUnlockInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationterraformstateunlockclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationterraformstateunlockid"></a>`id` | [`TerraformStateID!`](#terraformstateid) | Global ID of the Terraform state. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationterraformstateunlockclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationterraformstateunlockerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.timelineEventCreate`
|
|
|
|
Input type: `TimelineEventCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelineeventcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelineeventcreateincidentid"></a>`incidentId` | [`IssueID!`](#issueid) | Incident ID of the timeline event. |
|
|
| <a id="mutationtimelineeventcreatenote"></a>`note` | [`String!`](#string) | Text note of the timeline event. |
|
|
| <a id="mutationtimelineeventcreateoccurredat"></a>`occurredAt` | [`Time!`](#time) | Timestamp of when the event occurred. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelineeventcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelineeventcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtimelineeventcreatetimelineevent"></a>`timelineEvent` | [`TimelineEventType`](#timelineeventtype) | Timeline event. |
|
|
|
|
### `Mutation.timelineEventDestroy`
|
|
|
|
Input type: `TimelineEventDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelineeventdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelineeventdestroyid"></a>`id` | [`IncidentManagementTimelineEventID!`](#incidentmanagementtimelineeventid) | Timeline event ID to remove. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelineeventdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelineeventdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtimelineeventdestroytimelineevent"></a>`timelineEvent` | [`TimelineEventType`](#timelineeventtype) | Timeline event. |
|
|
|
|
### `Mutation.timelineEventPromoteFromNote`
|
|
|
|
Input type: `TimelineEventPromoteFromNoteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelineeventpromotefromnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelineeventpromotefromnotenoteid"></a>`noteId` | [`NoteID!`](#noteid) | Note ID from which the timeline event promoted. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelineeventpromotefromnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelineeventpromotefromnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtimelineeventpromotefromnotetimelineevent"></a>`timelineEvent` | [`TimelineEventType`](#timelineeventtype) | Timeline event. |
|
|
|
|
### `Mutation.timelineEventUpdate`
|
|
|
|
Input type: `TimelineEventUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelineeventupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelineeventupdateid"></a>`id` | [`IncidentManagementTimelineEventID!`](#incidentmanagementtimelineeventid) | ID of the timeline event to update. |
|
|
| <a id="mutationtimelineeventupdatenote"></a>`note` | [`String`](#string) | Text note of the timeline event. |
|
|
| <a id="mutationtimelineeventupdateoccurredat"></a>`occurredAt` | [`Time`](#time) | Timestamp when the event occurred. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelineeventupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelineeventupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtimelineeventupdatetimelineevent"></a>`timelineEvent` | [`TimelineEventType`](#timelineeventtype) | Timeline event. |
|
|
|
|
### `Mutation.timelogDelete`
|
|
|
|
Input type: `TimelogDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelogdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelogdeleteid"></a>`id` | [`TimelogID!`](#timelogid) | Global ID of the timelog. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtimelogdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtimelogdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtimelogdeletetimelog"></a>`timelog` | [`Timelog`](#timelog) | Deleted timelog. |
|
|
|
|
### `Mutation.todoCreate`
|
|
|
|
Input type: `TodoCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodocreatetargetid"></a>`targetId` | [`TodoableID!`](#todoableid) | Global ID of the to-do item's parent. Issues, merge requests, designs, and epics are supported. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodocreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodocreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtodocreatetodo"></a>`todo` | [`Todo`](#todo) | To-do item created. |
|
|
|
|
### `Mutation.todoMarkDone`
|
|
|
|
Input type: `TodoMarkDoneInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodomarkdoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodomarkdoneid"></a>`id` | [`TodoID!`](#todoid) | Global ID of the to-do item to mark as done. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodomarkdoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodomarkdoneerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtodomarkdonetodo"></a>`todo` | [`Todo!`](#todo) | Requested to-do item. |
|
|
|
|
### `Mutation.todoRestore`
|
|
|
|
Input type: `TodoRestoreInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodorestoreclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodorestoreid"></a>`id` | [`TodoID!`](#todoid) | Global ID of the to-do item to restore. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodorestoreclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodorestoreerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtodorestoretodo"></a>`todo` | [`Todo!`](#todo) | Requested to-do item. |
|
|
|
|
### `Mutation.todoRestoreMany`
|
|
|
|
Input type: `TodoRestoreManyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodorestoremanyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodorestoremanyids"></a>`ids` | [`[TodoID!]!`](#todoid) | Global IDs of the to-do items to restore (a maximum of 50 is supported at once). |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodorestoremanyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodorestoremanyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtodorestoremanytodos"></a>`todos` | [`[Todo!]!`](#todo) | Updated to-do items. |
|
|
|
|
### `Mutation.todosMarkAllDone`
|
|
|
|
Input type: `TodosMarkAllDoneInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodosmarkalldoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodosmarkalldonetargetid"></a>`targetId` | [`TodoableID`](#todoableid) | Global ID of the to-do item's parent. Issues, merge requests, designs, and epics are supported. If argument is omitted, all pending to-do items of the current user are marked as done. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationtodosmarkalldoneclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationtodosmarkalldoneerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationtodosmarkalldonetodos"></a>`todos` | [`[Todo!]!`](#todo) | Updated to-do items. |
|
|
|
|
### `Mutation.updateAlertStatus`
|
|
|
|
Input type: `UpdateAlertStatusInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatealertstatusclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatealertstatusiid"></a>`iid` | [`String!`](#string) | IID of the alert to mutate. |
|
|
| <a id="mutationupdatealertstatusprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the alert to mutate is in. |
|
|
| <a id="mutationupdatealertstatusstatus"></a>`status` | [`AlertManagementStatus!`](#alertmanagementstatus) | Status to set the alert. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatealertstatusalert"></a>`alert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert after mutation. |
|
|
| <a id="mutationupdatealertstatusclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatealertstatuserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdatealertstatusissue"></a>`issue` | [`Issue`](#issue) | Issue created after mutation. |
|
|
| <a id="mutationupdatealertstatustodo"></a>`todo` | [`Todo`](#todo) | To-do item after mutation. |
|
|
|
|
### `Mutation.updateBoard`
|
|
|
|
Input type: `UpdateBoardInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateboardassigneeid"></a>`assigneeId` | [`UserID`](#userid) | ID of user to be assigned to the board. |
|
|
| <a id="mutationupdateboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateboardhidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. |
|
|
| <a id="mutationupdateboardhideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. |
|
|
| <a id="mutationupdateboardid"></a>`id` | [`BoardID!`](#boardid) | Board global ID. |
|
|
| <a id="mutationupdateboarditerationcadenceid"></a>`iterationCadenceId` | [`IterationsCadenceID`](#iterationscadenceid) | ID of iteration cadence to be assigned to the board. |
|
|
| <a id="mutationupdateboarditerationid"></a>`iterationId` | [`IterationID`](#iterationid) | ID of iteration to be assigned to the board. |
|
|
| <a id="mutationupdateboardlabelids"></a>`labelIds` | [`[LabelID!]`](#labelid) | IDs of labels to be added to the board. |
|
|
| <a id="mutationupdateboardlabels"></a>`labels` | [`[String!]`](#string) | Labels of the issue. |
|
|
| <a id="mutationupdateboardmilestoneid"></a>`milestoneId` | [`MilestoneID`](#milestoneid) | ID of milestone to be assigned to the board. |
|
|
| <a id="mutationupdateboardname"></a>`name` | [`String`](#string) | Board name. |
|
|
| <a id="mutationupdateboardweight"></a>`weight` | [`Int`](#int) | Weight value to be assigned to the board. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateboardboard"></a>`board` | [`Board`](#board) | Board after mutation. |
|
|
| <a id="mutationupdateboardclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateboarderrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.updateBoardEpicUserPreferences`
|
|
|
|
Input type: `UpdateBoardEpicUserPreferencesInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateboardepicuserpreferencesboardid"></a>`boardId` | [`BoardID!`](#boardid) | Board global ID. |
|
|
| <a id="mutationupdateboardepicuserpreferencesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateboardepicuserpreferencescollapsed"></a>`collapsed` | [`Boolean!`](#boolean) | Whether the epic should be collapsed in the board. |
|
|
| <a id="mutationupdateboardepicuserpreferencesepicid"></a>`epicId` | [`EpicID!`](#epicid) | ID of an epic to set preferences for. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateboardepicuserpreferencesclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateboardepicuserpreferencesepicuserpreferences"></a>`epicUserPreferences` | [`BoardEpicUserPreferences`](#boardepicuserpreferences) | User preferences for the epic in the board after mutation. |
|
|
| <a id="mutationupdateboardepicuserpreferenceserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.updateBoardList`
|
|
|
|
Input type: `UpdateBoardListInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateboardlistcollapsed"></a>`collapsed` | [`Boolean`](#boolean) | Indicates if the list is collapsed for this user. |
|
|
| <a id="mutationupdateboardlistlistid"></a>`listId` | [`ListID!`](#listid) | Global ID of the list. |
|
|
| <a id="mutationupdateboardlistposition"></a>`position` | [`Int`](#int) | Position of list within the board. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateboardlisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdateboardlistlist"></a>`list` | [`BoardList`](#boardlist) | Mutated list. |
|
|
|
|
### `Mutation.updateComplianceFramework`
|
|
|
|
Input type: `UpdateComplianceFrameworkInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatecomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatecomplianceframeworkid"></a>`id` | [`ComplianceManagementFrameworkID!`](#compliancemanagementframeworkid) | Global ID of the compliance framework to update. |
|
|
| <a id="mutationupdatecomplianceframeworkparams"></a>`params` | [`ComplianceFrameworkInput!`](#complianceframeworkinput) | Parameters to update the compliance framework with. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatecomplianceframeworkclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatecomplianceframeworkcomplianceframework"></a>`complianceFramework` | [`ComplianceFramework`](#complianceframework) | Compliance framework after mutation. |
|
|
| <a id="mutationupdatecomplianceframeworkerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.updateContainerExpirationPolicy`
|
|
|
|
Input type: `UpdateContainerExpirationPolicyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatecontainerexpirationpolicycadence"></a>`cadence` | [`ContainerExpirationPolicyCadenceEnum`](#containerexpirationpolicycadenceenum) | This container expiration policy schedule. |
|
|
| <a id="mutationupdatecontainerexpirationpolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatecontainerexpirationpolicyenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether this container expiration policy is enabled. |
|
|
| <a id="mutationupdatecontainerexpirationpolicykeepn"></a>`keepN` | [`ContainerExpirationPolicyKeepEnum`](#containerexpirationpolicykeepenum) | Number of tags to retain. |
|
|
| <a id="mutationupdatecontainerexpirationpolicynameregex"></a>`nameRegex` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will expire. |
|
|
| <a id="mutationupdatecontainerexpirationpolicynameregexkeep"></a>`nameRegexKeep` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will be preserved. |
|
|
| <a id="mutationupdatecontainerexpirationpolicyolderthan"></a>`olderThan` | [`ContainerExpirationPolicyOlderThanEnum`](#containerexpirationpolicyolderthanenum) | Tags older that this will expire. |
|
|
| <a id="mutationupdatecontainerexpirationpolicyprojectpath"></a>`projectPath` | [`ID!`](#id) | Project path where the container expiration policy is located. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatecontainerexpirationpolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatecontainerexpirationpolicycontainerexpirationpolicy"></a>`containerExpirationPolicy` | [`ContainerExpirationPolicy`](#containerexpirationpolicy) | Container expiration policy after mutation. |
|
|
| <a id="mutationupdatecontainerexpirationpolicyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.updateDependencyProxyImageTtlGroupPolicy`
|
|
|
|
Input type: `UpdateDependencyProxyImageTtlGroupPolicyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatedependencyproxyimagettlgrouppolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatedependencyproxyimagettlgrouppolicyenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether the policy is enabled or disabled. |
|
|
| <a id="mutationupdatedependencyproxyimagettlgrouppolicygrouppath"></a>`groupPath` | [`ID!`](#id) | Group path for the group dependency proxy image TTL policy. |
|
|
| <a id="mutationupdatedependencyproxyimagettlgrouppolicyttl"></a>`ttl` | [`Int`](#int) | Number of days to retain a cached image file. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatedependencyproxyimagettlgrouppolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatedependencyproxyimagettlgrouppolicydependencyproxyimagettlpolicy"></a>`dependencyProxyImageTtlPolicy` | [`DependencyProxyImageTtlGroupPolicy`](#dependencyproxyimagettlgrouppolicy) | Group image TTL policy after mutation. |
|
|
| <a id="mutationupdatedependencyproxyimagettlgrouppolicyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.updateDependencyProxySettings`
|
|
|
|
Input type: `UpdateDependencyProxySettingsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatedependencyproxysettingsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatedependencyproxysettingsenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether the policy is enabled or disabled. |
|
|
| <a id="mutationupdatedependencyproxysettingsgrouppath"></a>`groupPath` | [`ID!`](#id) | Group path for the group dependency proxy. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatedependencyproxysettingsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatedependencyproxysettingsdependencyproxysetting"></a>`dependencyProxySetting` | [`DependencyProxySetting`](#dependencyproxysetting) | Group dependency proxy settings after mutation. |
|
|
| <a id="mutationupdatedependencyproxysettingserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.updateEpic`
|
|
|
|
Input type: `UpdateEpicInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateepicaddlabelids"></a>`addLabelIds` | [`[ID!]`](#id) | IDs of labels to be added to the epic. |
|
|
| <a id="mutationupdateepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateepiccolor"></a>`color` | [`Color`](#color) | Color of the epic. Available only when feature flag `epic_color_highlight` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
|
|
| <a id="mutationupdateepicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. |
|
|
| <a id="mutationupdateepicdescription"></a>`description` | [`String`](#string) | Description of the epic. |
|
|
| <a id="mutationupdateepicduedatefixed"></a>`dueDateFixed` | [`String`](#string) | End date of the epic. |
|
|
| <a id="mutationupdateepicduedateisfixed"></a>`dueDateIsFixed` | [`Boolean`](#boolean) | Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
|
|
| <a id="mutationupdateepicgrouppath"></a>`groupPath` | [`ID!`](#id) | Group the epic to mutate is in. |
|
|
| <a id="mutationupdateepiciid"></a>`iid` | [`ID!`](#id) | IID of the epic to mutate. |
|
|
| <a id="mutationupdateepicremovelabelids"></a>`removeLabelIds` | [`[ID!]`](#id) | IDs of labels to be removed from the epic. |
|
|
| <a id="mutationupdateepicstartdatefixed"></a>`startDateFixed` | [`String`](#string) | Start date of the epic. |
|
|
| <a id="mutationupdateepicstartdateisfixed"></a>`startDateIsFixed` | [`Boolean`](#boolean) | Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
|
|
| <a id="mutationupdateepicstateevent"></a>`stateEvent` | [`EpicStateEvent`](#epicstateevent) | State event for the epic. |
|
|
| <a id="mutationupdateepictitle"></a>`title` | [`String`](#string) | Title of the epic. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateepicclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateepicepic"></a>`epic` | [`Epic`](#epic) | Epic after mutation. |
|
|
| <a id="mutationupdateepicerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.updateEpicBoardList`
|
|
|
|
Input type: `UpdateEpicBoardListInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateepicboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateepicboardlistcollapsed"></a>`collapsed` | [`Boolean`](#boolean) | Indicates if the list is collapsed for this user. |
|
|
| <a id="mutationupdateepicboardlistlistid"></a>`listId` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the epic list. |
|
|
| <a id="mutationupdateepicboardlistposition"></a>`position` | [`Int`](#int) | Position of list within the board. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateepicboardlistclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateepicboardlisterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdateepicboardlistlist"></a>`list` | [`EpicList`](#epiclist) | Mutated epic list. |
|
|
|
|
### `Mutation.updateImageDiffNote`
|
|
|
|
Updates a DiffNote on an image (a `Note` where the `position.positionType` is `"image"`).
|
|
If the body of the Note contains only quick actions,
|
|
the Note will be destroyed during an update, and no Note will be
|
|
returned.
|
|
|
|
Input type: `UpdateImageDiffNoteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateimagediffnotebody"></a>`body` | [`String`](#string) | Content of the note. |
|
|
| <a id="mutationupdateimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateimagediffnoteid"></a>`id` | [`NoteID!`](#noteid) | Global ID of the note to update. |
|
|
| <a id="mutationupdateimagediffnoteposition"></a>`position` | [`UpdateDiffImagePositionInput`](#updatediffimagepositioninput) | Position of this note on a diff. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateimagediffnoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateimagediffnoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdateimagediffnotenote"></a>`note` | [`Note`](#note) | Note after mutation. |
|
|
|
|
### `Mutation.updateIssue`
|
|
|
|
Input type: `UpdateIssueInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateissueaddlabelids"></a>`addLabelIds` | [`[ID!]`](#id) | IDs of labels to be added to the issue. |
|
|
| <a id="mutationupdateissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateissueconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates the issue is confidential. |
|
|
| <a id="mutationupdateissuedescription"></a>`description` | [`String`](#string) | Description of the issue. |
|
|
| <a id="mutationupdateissueduedate"></a>`dueDate` | [`ISO8601Date`](#iso8601date) | Due date of the issue. |
|
|
| <a id="mutationupdateissueepicid"></a>`epicId` | [`EpicID`](#epicid) | ID of the parent epic. NULL when removing the association. |
|
|
| <a id="mutationupdateissuehealthstatus"></a>`healthStatus` | [`HealthStatus`](#healthstatus) | Desired health status. |
|
|
| <a id="mutationupdateissueiid"></a>`iid` | [`String!`](#string) | IID of the issue to mutate. |
|
|
| <a id="mutationupdateissuelabelids"></a>`labelIds` | [`[ID!]`](#id) | IDs of labels to be set. Replaces existing issue labels. |
|
|
| <a id="mutationupdateissuelocked"></a>`locked` | [`Boolean`](#boolean) | Indicates discussion is locked on the issue. |
|
|
| <a id="mutationupdateissuemilestoneid"></a>`milestoneId` | [`ID`](#id) | ID of the milestone to assign to the issue. On update milestone will be removed if set to null. |
|
|
| <a id="mutationupdateissueprojectpath"></a>`projectPath` | [`ID!`](#id) | Project the issue to mutate is in. |
|
|
| <a id="mutationupdateissueremovelabelids"></a>`removeLabelIds` | [`[ID!]`](#id) | IDs of labels to be removed from the issue. |
|
|
| <a id="mutationupdateissuestateevent"></a>`stateEvent` | [`IssueStateEvent`](#issuestateevent) | Close or reopen an issue. |
|
|
| <a id="mutationupdateissuetitle"></a>`title` | [`String`](#string) | Title of the issue. |
|
|
| <a id="mutationupdateissuetype"></a>`type` | [`IssueType`](#issuetype) | Type of the issue. |
|
|
| <a id="mutationupdateissueweight"></a>`weight` | [`Int`](#int) | Weight of the issue. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateissueclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateissueerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdateissueissue"></a>`issue` | [`Issue`](#issue) | Issue after mutation. |
|
|
|
|
### `Mutation.updateIteration`
|
|
|
|
Input type: `UpdateIterationInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateiterationdescription"></a>`description` | [`String`](#string) | Description of the iteration. |
|
|
| <a id="mutationupdateiterationduedate"></a>`dueDate` **{warning-solid}** | [`String`](#string) | **Deprecated:** Manual iteration updates are deprecated, only `description` updates will be allowed in the future. Deprecated in 14.10. |
|
|
| <a id="mutationupdateiterationgrouppath"></a>`groupPath` | [`ID!`](#id) | Group of the iteration. |
|
|
| <a id="mutationupdateiterationid"></a>`id` | [`ID!`](#id) | Global ID of the iteration. |
|
|
| <a id="mutationupdateiterationstartdate"></a>`startDate` **{warning-solid}** | [`String`](#string) | **Deprecated:** Manual iteration updates are deprecated, only `description` updates will be allowed in the future. Deprecated in 14.10. |
|
|
| <a id="mutationupdateiterationtitle"></a>`title` **{warning-solid}** | [`String`](#string) | **Deprecated:** Manual iteration updates are deprecated, only `description` updates will be allowed in the future. Deprecated in 14.10. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdateiterationclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdateiterationerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdateiterationiteration"></a>`iteration` | [`Iteration`](#iteration) | Updated iteration. |
|
|
|
|
### `Mutation.updateNamespacePackageSettings`
|
|
|
|
Input type: `UpdateNamespacePackageSettingsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatenamespacepackagesettingsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatenamespacepackagesettingsgenericduplicateexceptionregex"></a>`genericDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
|
|
| <a id="mutationupdatenamespacepackagesettingsgenericduplicatesallowed"></a>`genericDuplicatesAllowed` | [`Boolean`](#boolean) | Indicates whether duplicate generic packages are allowed for this namespace. |
|
|
| <a id="mutationupdatenamespacepackagesettingsmavenduplicateexceptionregex"></a>`mavenDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
|
|
| <a id="mutationupdatenamespacepackagesettingsmavenduplicatesallowed"></a>`mavenDuplicatesAllowed` | [`Boolean`](#boolean) | Indicates whether duplicate Maven packages are allowed for this namespace. |
|
|
| <a id="mutationupdatenamespacepackagesettingsnamespacepath"></a>`namespacePath` | [`ID!`](#id) | Namespace path where the namespace package setting is located. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatenamespacepackagesettingsclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatenamespacepackagesettingserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdatenamespacepackagesettingspackagesettings"></a>`packageSettings` | [`PackageSettings`](#packagesettings) | Namespace package setting after mutation. |
|
|
|
|
### `Mutation.updateNote`
|
|
|
|
Updates a Note.
|
|
If the body of the Note contains only quick actions,
|
|
the Note will be destroyed during an update, and no Note will be
|
|
returned.
|
|
|
|
Input type: `UpdateNoteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatenotebody"></a>`body` | [`String`](#string) | Content of the note. |
|
|
| <a id="mutationupdatenoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatenoteconfidential"></a>`confidential` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated:** No longer allowed to update confidentiality of notes. Deprecated in 14.10. |
|
|
| <a id="mutationupdatenoteid"></a>`id` | [`NoteID!`](#noteid) | Global ID of the note to update. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatenoteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatenoteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdatenotenote"></a>`note` | [`Note`](#note) | Note after mutation. |
|
|
|
|
### `Mutation.updatePackagesCleanupPolicy`
|
|
|
|
Input type: `UpdatePackagesCleanupPolicyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatepackagescleanuppolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatepackagescleanuppolicykeepnduplicatedpackagefiles"></a>`keepNDuplicatedPackageFiles` | [`PackagesCleanupKeepDuplicatedPackageFilesEnum`](#packagescleanupkeepduplicatedpackagefilesenum) | Number of duplicated package files to retain. |
|
|
| <a id="mutationupdatepackagescleanuppolicyprojectpath"></a>`projectPath` | [`ID!`](#id) | Project path where the packages cleanup policy is located. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatepackagescleanuppolicyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatepackagescleanuppolicyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdatepackagescleanuppolicypackagescleanuppolicy"></a>`packagesCleanupPolicy` | [`PackagesCleanupPolicy`](#packagescleanuppolicy) | Packages cleanup policy after mutation. |
|
|
|
|
### `Mutation.updateRequirement`
|
|
|
|
Input type: `UpdateRequirementInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdaterequirementclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdaterequirementdescription"></a>`description` | [`String`](#string) | Description of the requirement. |
|
|
| <a id="mutationupdaterequirementiid"></a>`iid` | [`String!`](#string) | IID of the requirement to update. |
|
|
| <a id="mutationupdaterequirementlasttestreportstate"></a>`lastTestReportState` | [`TestReportState`](#testreportstate) | Creates a test report for the requirement with the given state. |
|
|
| <a id="mutationupdaterequirementprojectpath"></a>`projectPath` | [`ID!`](#id) | Full project path the requirement is associated with. |
|
|
| <a id="mutationupdaterequirementstate"></a>`state` | [`RequirementState`](#requirementstate) | State of the requirement. |
|
|
| <a id="mutationupdaterequirementtitle"></a>`title` | [`String`](#string) | Title of the requirement. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdaterequirementclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdaterequirementerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdaterequirementrequirement"></a>`requirement` | [`Requirement`](#requirement) | Requirement after mutation. |
|
|
|
|
### `Mutation.updateSnippet`
|
|
|
|
Input type: `UpdateSnippetInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatesnippetblobactions"></a>`blobActions` | [`[SnippetBlobActionInputType!]`](#snippetblobactioninputtype) | Actions to perform over the snippet repository and blobs. |
|
|
| <a id="mutationupdatesnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatesnippetdescription"></a>`description` | [`String`](#string) | Description of the snippet. |
|
|
| <a id="mutationupdatesnippetid"></a>`id` | [`SnippetID!`](#snippetid) | Global ID of the snippet to update. |
|
|
| <a id="mutationupdatesnippettitle"></a>`title` | [`String`](#string) | Title of the snippet. |
|
|
| <a id="mutationupdatesnippetvisibilitylevel"></a>`visibilityLevel` | [`VisibilityLevelsEnum`](#visibilitylevelsenum) | Visibility level of the snippet. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationupdatesnippetclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationupdatesnippeterrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationupdatesnippetsnippet"></a>`snippet` | [`Snippet`](#snippet) | Snippet after mutation. |
|
|
|
|
### `Mutation.userCalloutCreate`
|
|
|
|
Input type: `UserCalloutCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationusercalloutcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationusercalloutcreatefeaturename"></a>`featureName` | [`String!`](#string) | Feature name you want to dismiss the callout for. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationusercalloutcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationusercalloutcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationusercalloutcreateusercallout"></a>`userCallout` | [`UserCallout!`](#usercallout) | User callout dismissed. |
|
|
|
|
### `Mutation.userPreferencesUpdate`
|
|
|
|
Input type: `UserPreferencesUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationuserpreferencesupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationuserpreferencesupdateissuessort"></a>`issuesSort` | [`IssueSort`](#issuesort) | Sort order for issue lists. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationuserpreferencesupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationuserpreferencesupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationuserpreferencesupdateuserpreferences"></a>`userPreferences` | [`UserPreferences`](#userpreferences) | User preferences after mutation. |
|
|
|
|
### `Mutation.vulnerabilityConfirm`
|
|
|
|
Input type: `VulnerabilityConfirmInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityconfirmclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityconfirmid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be confirmed. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityconfirmclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityconfirmerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationvulnerabilityconfirmvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | Vulnerability after state change. |
|
|
|
|
### `Mutation.vulnerabilityCreate`
|
|
|
|
Input type: `VulnerabilityCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilitycreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilitycreateconfidence"></a>`confidence` | [`VulnerabilityConfidence`](#vulnerabilityconfidence) | Confidence of the vulnerability (defaults to `unknown`). |
|
|
| <a id="mutationvulnerabilitycreateconfirmedat"></a>`confirmedAt` | [`Time`](#time) | Timestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is `confirmed`). |
|
|
| <a id="mutationvulnerabilitycreatedescription"></a>`description` | [`String!`](#string) | Long text section that describes the vulnerability in more detail. |
|
|
| <a id="mutationvulnerabilitycreatedetectedat"></a>`detectedAt` | [`Time`](#time) | Timestamp of when the vulnerability was first detected (defaults to creation time). |
|
|
| <a id="mutationvulnerabilitycreatedismissedat"></a>`dismissedAt` | [`Time`](#time) | Timestamp of when the vulnerability state changed to dismissed (defaults to creation time if status is `dismissed`). |
|
|
| <a id="mutationvulnerabilitycreateidentifiers"></a>`identifiers` | [`[VulnerabilityIdentifierInput!]!`](#vulnerabilityidentifierinput) | Array of CVE or CWE identifiers for the vulnerability. |
|
|
| <a id="mutationvulnerabilitycreatemessage"></a>`message` | [`String`](#string) | Short text section that describes the vulnerability. This may include the finding's specific information. |
|
|
| <a id="mutationvulnerabilitycreatename"></a>`name` | [`String!`](#string) | Name of the vulnerability. |
|
|
| <a id="mutationvulnerabilitycreateproject"></a>`project` | [`ProjectID!`](#projectid) | ID of the project to attach the vulnerability to. |
|
|
| <a id="mutationvulnerabilitycreateresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the vulnerability state changed to resolved (defaults to creation time if status is `resolved`). |
|
|
| <a id="mutationvulnerabilitycreatescanner"></a>`scanner` | [`VulnerabilityScannerInput!`](#vulnerabilityscannerinput) | Information about the scanner used to discover the vulnerability. |
|
|
| <a id="mutationvulnerabilitycreateseverity"></a>`severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability (defaults to `unknown`). |
|
|
| <a id="mutationvulnerabilitycreatesolution"></a>`solution` | [`String`](#string) | Instructions for how to fix the vulnerability. |
|
|
| <a id="mutationvulnerabilitycreatestate"></a>`state` | [`VulnerabilityState`](#vulnerabilitystate) | State of the vulnerability (defaults to `detected`). |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilitycreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilitycreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationvulnerabilitycreatevulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | Vulnerability created. |
|
|
|
|
### `Mutation.vulnerabilityDismiss`
|
|
|
|
Input type: `VulnerabilityDismissInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilitydismissclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilitydismisscomment"></a>`comment` | [`String`](#string) | Comment why vulnerability should be dismissed. |
|
|
| <a id="mutationvulnerabilitydismissdismissalreason"></a>`dismissalReason` | [`VulnerabilityDismissalReason`](#vulnerabilitydismissalreason) | Reason why vulnerability should be dismissed. |
|
|
| <a id="mutationvulnerabilitydismissid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be dismissed. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilitydismissclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilitydismisserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationvulnerabilitydismissvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | Vulnerability after dismissal. |
|
|
|
|
### `Mutation.vulnerabilityExternalIssueLinkCreate`
|
|
|
|
Input type: `VulnerabilityExternalIssueLinkCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityexternalissuelinkcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityexternalissuelinkcreateexternaltracker"></a>`externalTracker` | [`VulnerabilityExternalIssueLinkExternalTracker!`](#vulnerabilityexternalissuelinkexternaltracker) | External tracker type of the external issue link. |
|
|
| <a id="mutationvulnerabilityexternalissuelinkcreateid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability. |
|
|
| <a id="mutationvulnerabilityexternalissuelinkcreatelinktype"></a>`linkType` | [`VulnerabilityExternalIssueLinkType!`](#vulnerabilityexternalissuelinktype) | Type of the external issue link. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityexternalissuelinkcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityexternalissuelinkcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationvulnerabilityexternalissuelinkcreateexternalissuelink"></a>`externalIssueLink` | [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink) | Created external issue link. |
|
|
|
|
### `Mutation.vulnerabilityExternalIssueLinkDestroy`
|
|
|
|
Input type: `VulnerabilityExternalIssueLinkDestroyInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityexternalissuelinkdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityexternalissuelinkdestroyid"></a>`id` | [`VulnerabilitiesExternalIssueLinkID!`](#vulnerabilitiesexternalissuelinkid) | Global ID of the vulnerability external issue link. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityexternalissuelinkdestroyclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityexternalissuelinkdestroyerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
|
|
### `Mutation.vulnerabilityFindingDismiss`
|
|
|
|
Input type: `VulnerabilityFindingDismissInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityfindingdismissclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityfindingdismisscomment"></a>`comment` | [`String`](#string) | Comment why finding should be dismissed. |
|
|
| <a id="mutationvulnerabilityfindingdismissdismissalreason"></a>`dismissalReason` | [`VulnerabilityDismissalReason`](#vulnerabilitydismissalreason) | Reason why finding should be dismissed. |
|
|
| <a id="mutationvulnerabilityfindingdismissid"></a>`id` | [`VulnerabilitiesFindingID!`](#vulnerabilitiesfindingid) | ID of the finding to be dismissed. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityfindingdismissclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityfindingdismisserrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationvulnerabilityfindingdismissfinding"></a>`finding` | [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding) | Finding after dismissal. |
|
|
|
|
### `Mutation.vulnerabilityResolve`
|
|
|
|
Input type: `VulnerabilityResolveInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityresolveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityresolveid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be resolved. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityresolveclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityresolveerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationvulnerabilityresolvevulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | Vulnerability after state change. |
|
|
|
|
### `Mutation.vulnerabilityRevertToDetected`
|
|
|
|
Input type: `VulnerabilityRevertToDetectedInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityreverttodetectedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityreverttodetectedid"></a>`id` | [`VulnerabilityID!`](#vulnerabilityid) | ID of the vulnerability to be reverted. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationvulnerabilityreverttodetectedclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationvulnerabilityreverttodetectederrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationvulnerabilityreverttodetectedvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | Vulnerability after revert. |
|
|
|
|
### `Mutation.workItemCreate`
|
|
|
|
Creates a work item. Available only when feature flag `work_items` is enabled.
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.1.
|
|
This feature is in Alpha, and can be removed or changed at any point.
|
|
|
|
Input type: `WorkItemCreateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemcreatedescription"></a>`description` | [`String`](#string) | Description of the work item. |
|
|
| <a id="mutationworkitemcreateprojectpath"></a>`projectPath` | [`ID!`](#id) | Full path of the project the work item is associated with. |
|
|
| <a id="mutationworkitemcreatetitle"></a>`title` | [`String!`](#string) | Title of the work item. |
|
|
| <a id="mutationworkitemcreateworkitemtypeid"></a>`workItemTypeId` | [`WorkItemsTypeID!`](#workitemstypeid) | Global ID of a work item type. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemcreateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemcreateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationworkitemcreateworkitem"></a>`workItem` | [`WorkItem`](#workitem) | Created work item. |
|
|
|
|
### `Mutation.workItemCreateFromTask`
|
|
|
|
Creates a work item from a task in another work item's description. Available only when feature flag `work_items` is enabled.
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.1.
|
|
This feature is in Alpha, and can be removed or changed at any point.
|
|
|
|
Input type: `WorkItemCreateFromTaskInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemcreatefromtaskclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemcreatefromtaskid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the work item. |
|
|
| <a id="mutationworkitemcreatefromtaskworkitemdata"></a>`workItemData` | [`WorkItemConvertTaskInput!`](#workitemconverttaskinput) | Arguments necessary to convert a task into a work item. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemcreatefromtaskclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemcreatefromtaskerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationworkitemcreatefromtasknewworkitem"></a>`newWorkItem` | [`WorkItem`](#workitem) | New work item created from task. |
|
|
| <a id="mutationworkitemcreatefromtaskworkitem"></a>`workItem` | [`WorkItem`](#workitem) | Updated work item. |
|
|
|
|
### `Mutation.workItemDelete`
|
|
|
|
Deletes a work item. Available only when feature flag `work_items` is enabled.
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.1.
|
|
This feature is in Alpha, and can be removed or changed at any point.
|
|
|
|
Input type: `WorkItemDeleteInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemdeleteid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the work item. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemdeleteclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemdeleteerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationworkitemdeleteproject"></a>`project` | [`Project`](#project) | Project the deleted work item belonged to. |
|
|
|
|
### `Mutation.workItemDeleteTask`
|
|
|
|
Deletes a task in a work item's description. Available only when feature flag `work_items` is enabled.
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.1.
|
|
This feature is in Alpha, and can be removed or changed at any point.
|
|
|
|
Input type: `WorkItemDeleteTaskInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemdeletetaskclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemdeletetaskid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the work item. |
|
|
| <a id="mutationworkitemdeletetasklockversion"></a>`lockVersion` | [`Int!`](#int) | Current lock version of the work item containing the task in the description. |
|
|
| <a id="mutationworkitemdeletetasktaskdata"></a>`taskData` | [`WorkItemDeletedTaskInput!`](#workitemdeletedtaskinput) | Arguments necessary to delete a task from a work item's description. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemdeletetaskclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemdeletetaskerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationworkitemdeletetaskworkitem"></a>`workItem` | [`WorkItem`](#workitem) | Updated work item. |
|
|
|
|
### `Mutation.workItemUpdate`
|
|
|
|
Updates a work item by Global ID. Available only when feature flag `work_items` is enabled.
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.1.
|
|
This feature is in Alpha, and can be removed or changed at any point.
|
|
|
|
Input type: `WorkItemUpdateInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemupdateid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the work item. |
|
|
| <a id="mutationworkitemupdatestateevent"></a>`stateEvent` | [`WorkItemStateEvent`](#workitemstateevent) | Close or reopen a work item. |
|
|
| <a id="mutationworkitemupdatetitle"></a>`title` | [`String`](#string) | Title of the work item. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemupdateclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemupdateerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationworkitemupdateworkitem"></a>`workItem` | [`WorkItem`](#workitem) | Updated work item. |
|
|
|
|
### `Mutation.workItemUpdateTask`
|
|
|
|
Updates a work item's task by Global ID. Available only when feature flag `work_items` is enabled.
|
|
|
|
WARNING:
|
|
**Deprecated** in 15.1.
|
|
This feature is in Alpha, and can be removed or changed at any point.
|
|
|
|
Input type: `WorkItemUpdateTaskInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemupdatetaskclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemupdatetaskid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the work item. |
|
|
| <a id="mutationworkitemupdatetasktaskdata"></a>`taskData` | [`WorkItemUpdatedTaskInput!`](#workitemupdatedtaskinput) | Arguments necessary to update a task. |
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mutationworkitemupdatetaskclientmutationid"></a>`clientMutationId` | [`String`](#string) | A unique identifier for the client performing the mutation. |
|
|
| <a id="mutationworkitemupdatetaskerrors"></a>`errors` | [`[String!]!`](#string) | Errors encountered during execution of the mutation. |
|
|
| <a id="mutationworkitemupdatetasktask"></a>`task` | [`WorkItem`](#workitem) | Updated task. |
|
|
| <a id="mutationworkitemupdatetaskworkitem"></a>`workItem` | [`WorkItem`](#workitem) | Updated work item. |
|
|
|
|
## Connections
|
|
|
|
Some types in our schema are `Connection` types - they represent a paginated
|
|
collection of edges between two nodes in the graph. These follow the
|
|
[Relay cursor connections specification](https://relay.dev/graphql/connections.htm).
|
|
|
|
### Pagination arguments {#connection-pagination-arguments}
|
|
|
|
All connection fields support the following pagination arguments:
|
|
|
|
| Name | Type | Description |
|
|
|------|------|-------------|
|
|
| `after` | [`String`](#string) | Returns the elements in the list that come after the specified cursor. |
|
|
| `before` | [`String`](#string) | Returns the elements in the list that come before the specified cursor. |
|
|
| `first` | [`Int`](#int) | Returns the first _n_ elements from the list. |
|
|
| `last` | [`Int`](#int) | Returns the last _n_ elements from the list. |
|
|
|
|
Since these arguments are common to all connection fields, they are not repeated for each connection.
|
|
|
|
### Connection fields
|
|
|
|
All connections have at least the following fields:
|
|
|
|
| Name | Type | Description |
|
|
|------|------|-------------|
|
|
| `pageInfo` | [`PageInfo!`](#pageinfo) | Pagination information. |
|
|
| `edges` | `[edge!]` | The edges. |
|
|
| `nodes` | `[item!]` | The items in the current page. |
|
|
|
|
The precise type of `Edge` and `Item` depends on the kind of connection. A
|
|
[`ProjectConnection`](#projectconnection) will have nodes that have the type
|
|
[`[Project!]`](#project), and edges that have the type [`ProjectEdge`](#projectedge).
|
|
|
|
### Connection types
|
|
|
|
Some of the types in the schema exist solely to model connections. Each connection
|
|
has a distinct, named type, with a distinct named edge type. These are listed separately
|
|
below.
|
|
|
|
#### `AgentConfigurationConnection`
|
|
|
|
The connection type for [`AgentConfiguration`](#agentconfiguration).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="agentconfigurationconnectionedges"></a>`edges` | [`[AgentConfigurationEdge]`](#agentconfigurationedge) | A list of edges. |
|
|
| <a id="agentconfigurationconnectionnodes"></a>`nodes` | [`[AgentConfiguration]`](#agentconfiguration) | A list of nodes. |
|
|
| <a id="agentconfigurationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `AgentConfigurationEdge`
|
|
|
|
The edge type for [`AgentConfiguration`](#agentconfiguration).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="agentconfigurationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="agentconfigurationedgenode"></a>`node` | [`AgentConfiguration`](#agentconfiguration) | The item at the end of the edge. |
|
|
|
|
#### `AlertManagementAlertConnection`
|
|
|
|
The connection type for [`AlertManagementAlert`](#alertmanagementalert).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementalertconnectionedges"></a>`edges` | [`[AlertManagementAlertEdge]`](#alertmanagementalertedge) | A list of edges. |
|
|
| <a id="alertmanagementalertconnectionnodes"></a>`nodes` | [`[AlertManagementAlert]`](#alertmanagementalert) | A list of nodes. |
|
|
| <a id="alertmanagementalertconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `AlertManagementAlertEdge`
|
|
|
|
The edge type for [`AlertManagementAlert`](#alertmanagementalert).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementalertedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="alertmanagementalertedgenode"></a>`node` | [`AlertManagementAlert`](#alertmanagementalert) | The item at the end of the edge. |
|
|
|
|
#### `AlertManagementHttpIntegrationConnection`
|
|
|
|
The connection type for [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementhttpintegrationconnectionedges"></a>`edges` | [`[AlertManagementHttpIntegrationEdge]`](#alertmanagementhttpintegrationedge) | A list of edges. |
|
|
| <a id="alertmanagementhttpintegrationconnectionnodes"></a>`nodes` | [`[AlertManagementHttpIntegration]`](#alertmanagementhttpintegration) | A list of nodes. |
|
|
| <a id="alertmanagementhttpintegrationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `AlertManagementHttpIntegrationEdge`
|
|
|
|
The edge type for [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementhttpintegrationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="alertmanagementhttpintegrationedgenode"></a>`node` | [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration) | The item at the end of the edge. |
|
|
|
|
#### `AlertManagementIntegrationConnection`
|
|
|
|
The connection type for [`AlertManagementIntegration`](#alertmanagementintegration).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementintegrationconnectionedges"></a>`edges` | [`[AlertManagementIntegrationEdge]`](#alertmanagementintegrationedge) | A list of edges. |
|
|
| <a id="alertmanagementintegrationconnectionnodes"></a>`nodes` | [`[AlertManagementIntegration]`](#alertmanagementintegration) | A list of nodes. |
|
|
| <a id="alertmanagementintegrationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `AlertManagementIntegrationEdge`
|
|
|
|
The edge type for [`AlertManagementIntegration`](#alertmanagementintegration).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementintegrationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="alertmanagementintegrationedgenode"></a>`node` | [`AlertManagementIntegration`](#alertmanagementintegration) | The item at the end of the edge. |
|
|
|
|
#### `AwardEmojiConnection`
|
|
|
|
The connection type for [`AwardEmoji`](#awardemoji).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="awardemojiconnectionedges"></a>`edges` | [`[AwardEmojiEdge]`](#awardemojiedge) | A list of edges. |
|
|
| <a id="awardemojiconnectionnodes"></a>`nodes` | [`[AwardEmoji]`](#awardemoji) | A list of nodes. |
|
|
| <a id="awardemojiconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `AwardEmojiEdge`
|
|
|
|
The edge type for [`AwardEmoji`](#awardemoji).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="awardemojiedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="awardemojiedgenode"></a>`node` | [`AwardEmoji`](#awardemoji) | The item at the end of the edge. |
|
|
|
|
#### `BlobConnection`
|
|
|
|
The connection type for [`Blob`](#blob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="blobconnectionedges"></a>`edges` | [`[BlobEdge]`](#blobedge) | A list of edges. |
|
|
| <a id="blobconnectionnodes"></a>`nodes` | [`[Blob]`](#blob) | A list of nodes. |
|
|
| <a id="blobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `BlobEdge`
|
|
|
|
The edge type for [`Blob`](#blob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="blobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="blobedgenode"></a>`node` | [`Blob`](#blob) | The item at the end of the edge. |
|
|
|
|
#### `BoardConnection`
|
|
|
|
The connection type for [`Board`](#board).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardconnectionedges"></a>`edges` | [`[BoardEdge]`](#boardedge) | A list of edges. |
|
|
| <a id="boardconnectionnodes"></a>`nodes` | [`[Board]`](#board) | A list of nodes. |
|
|
| <a id="boardconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `BoardEdge`
|
|
|
|
The edge type for [`Board`](#board).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="boardedgenode"></a>`node` | [`Board`](#board) | The item at the end of the edge. |
|
|
|
|
#### `BoardEpicConnection`
|
|
|
|
The connection type for [`BoardEpic`](#boardepic).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepicconnectionedges"></a>`edges` | [`[BoardEpicEdge]`](#boardepicedge) | A list of edges. |
|
|
| <a id="boardepicconnectionnodes"></a>`nodes` | [`[BoardEpic]`](#boardepic) | A list of nodes. |
|
|
| <a id="boardepicconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `BoardEpicEdge`
|
|
|
|
The edge type for [`BoardEpic`](#boardepic).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepicedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="boardepicedgenode"></a>`node` | [`BoardEpic`](#boardepic) | The item at the end of the edge. |
|
|
|
|
#### `BoardListConnection`
|
|
|
|
The connection type for [`BoardList`](#boardlist).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardlistconnectionedges"></a>`edges` | [`[BoardListEdge]`](#boardlistedge) | A list of edges. |
|
|
| <a id="boardlistconnectionnodes"></a>`nodes` | [`[BoardList]`](#boardlist) | A list of nodes. |
|
|
| <a id="boardlistconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `BoardListEdge`
|
|
|
|
The edge type for [`BoardList`](#boardlist).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardlistedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="boardlistedgenode"></a>`node` | [`BoardList`](#boardlist) | The item at the end of the edge. |
|
|
|
|
#### `CiBuildNeedConnection`
|
|
|
|
The connection type for [`CiBuildNeed`](#cibuildneed).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cibuildneedconnectionedges"></a>`edges` | [`[CiBuildNeedEdge]`](#cibuildneededge) | A list of edges. |
|
|
| <a id="cibuildneedconnectionnodes"></a>`nodes` | [`[CiBuildNeed]`](#cibuildneed) | A list of nodes. |
|
|
| <a id="cibuildneedconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiBuildNeedEdge`
|
|
|
|
The edge type for [`CiBuildNeed`](#cibuildneed).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cibuildneededgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="cibuildneededgenode"></a>`node` | [`CiBuildNeed`](#cibuildneed) | The item at the end of the edge. |
|
|
|
|
#### `CiConfigGroupConnection`
|
|
|
|
The connection type for [`CiConfigGroup`](#ciconfiggroup).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfiggroupconnectionedges"></a>`edges` | [`[CiConfigGroupEdge]`](#ciconfiggroupedge) | A list of edges. |
|
|
| <a id="ciconfiggroupconnectionnodes"></a>`nodes` | [`[CiConfigGroup]`](#ciconfiggroup) | A list of nodes. |
|
|
| <a id="ciconfiggroupconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiConfigGroupEdge`
|
|
|
|
The edge type for [`CiConfigGroup`](#ciconfiggroup).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfiggroupedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="ciconfiggroupedgenode"></a>`node` | [`CiConfigGroup`](#ciconfiggroup) | The item at the end of the edge. |
|
|
|
|
#### `CiConfigJobConnection`
|
|
|
|
The connection type for [`CiConfigJob`](#ciconfigjob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigjobconnectionedges"></a>`edges` | [`[CiConfigJobEdge]`](#ciconfigjobedge) | A list of edges. |
|
|
| <a id="ciconfigjobconnectionnodes"></a>`nodes` | [`[CiConfigJob]`](#ciconfigjob) | A list of nodes. |
|
|
| <a id="ciconfigjobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiConfigJobEdge`
|
|
|
|
The edge type for [`CiConfigJob`](#ciconfigjob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigjobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="ciconfigjobedgenode"></a>`node` | [`CiConfigJob`](#ciconfigjob) | The item at the end of the edge. |
|
|
|
|
#### `CiConfigNeedConnection`
|
|
|
|
The connection type for [`CiConfigNeed`](#ciconfigneed).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigneedconnectionedges"></a>`edges` | [`[CiConfigNeedEdge]`](#ciconfigneededge) | A list of edges. |
|
|
| <a id="ciconfigneedconnectionnodes"></a>`nodes` | [`[CiConfigNeed]`](#ciconfigneed) | A list of nodes. |
|
|
| <a id="ciconfigneedconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiConfigNeedEdge`
|
|
|
|
The edge type for [`CiConfigNeed`](#ciconfigneed).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigneededgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="ciconfigneededgenode"></a>`node` | [`CiConfigNeed`](#ciconfigneed) | The item at the end of the edge. |
|
|
|
|
#### `CiConfigStageConnection`
|
|
|
|
The connection type for [`CiConfigStage`](#ciconfigstage).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigstageconnectionedges"></a>`edges` | [`[CiConfigStageEdge]`](#ciconfigstageedge) | A list of edges. |
|
|
| <a id="ciconfigstageconnectionnodes"></a>`nodes` | [`[CiConfigStage]`](#ciconfigstage) | A list of nodes. |
|
|
| <a id="ciconfigstageconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiConfigStageEdge`
|
|
|
|
The edge type for [`CiConfigStage`](#ciconfigstage).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigstageedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="ciconfigstageedgenode"></a>`node` | [`CiConfigStage`](#ciconfigstage) | The item at the end of the edge. |
|
|
|
|
#### `CiGroupConnection`
|
|
|
|
The connection type for [`CiGroup`](#cigroup).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cigroupconnectionedges"></a>`edges` | [`[CiGroupEdge]`](#cigroupedge) | A list of edges. |
|
|
| <a id="cigroupconnectionnodes"></a>`nodes` | [`[CiGroup]`](#cigroup) | A list of nodes. |
|
|
| <a id="cigroupconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiGroupEdge`
|
|
|
|
The edge type for [`CiGroup`](#cigroup).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cigroupedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="cigroupedgenode"></a>`node` | [`CiGroup`](#cigroup) | The item at the end of the edge. |
|
|
|
|
#### `CiJobArtifactConnection`
|
|
|
|
The connection type for [`CiJobArtifact`](#cijobartifact).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cijobartifactconnectionedges"></a>`edges` | [`[CiJobArtifactEdge]`](#cijobartifactedge) | A list of edges. |
|
|
| <a id="cijobartifactconnectionnodes"></a>`nodes` | [`[CiJobArtifact]`](#cijobartifact) | A list of nodes. |
|
|
| <a id="cijobartifactconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiJobArtifactEdge`
|
|
|
|
The edge type for [`CiJobArtifact`](#cijobartifact).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cijobartifactedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="cijobartifactedgenode"></a>`node` | [`CiJobArtifact`](#cijobartifact) | The item at the end of the edge. |
|
|
|
|
#### `CiJobConnection`
|
|
|
|
The connection type for [`CiJob`](#cijob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cijobconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="cijobconnectionedges"></a>`edges` | [`[CiJobEdge]`](#cijobedge) | A list of edges. |
|
|
| <a id="cijobconnectionnodes"></a>`nodes` | [`[CiJob]`](#cijob) | A list of nodes. |
|
|
| <a id="cijobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiJobEdge`
|
|
|
|
The edge type for [`CiJob`](#cijob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cijobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="cijobedgenode"></a>`node` | [`CiJob`](#cijob) | The item at the end of the edge. |
|
|
|
|
#### `CiMinutesNamespaceMonthlyUsageConnection`
|
|
|
|
The connection type for [`CiMinutesNamespaceMonthlyUsage`](#ciminutesnamespacemonthlyusage).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciminutesnamespacemonthlyusageconnectionedges"></a>`edges` | [`[CiMinutesNamespaceMonthlyUsageEdge]`](#ciminutesnamespacemonthlyusageedge) | A list of edges. |
|
|
| <a id="ciminutesnamespacemonthlyusageconnectionnodes"></a>`nodes` | [`[CiMinutesNamespaceMonthlyUsage]`](#ciminutesnamespacemonthlyusage) | A list of nodes. |
|
|
| <a id="ciminutesnamespacemonthlyusageconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiMinutesNamespaceMonthlyUsageEdge`
|
|
|
|
The edge type for [`CiMinutesNamespaceMonthlyUsage`](#ciminutesnamespacemonthlyusage).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciminutesnamespacemonthlyusageedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="ciminutesnamespacemonthlyusageedgenode"></a>`node` | [`CiMinutesNamespaceMonthlyUsage`](#ciminutesnamespacemonthlyusage) | The item at the end of the edge. |
|
|
|
|
#### `CiMinutesProjectMonthlyUsageConnection`
|
|
|
|
The connection type for [`CiMinutesProjectMonthlyUsage`](#ciminutesprojectmonthlyusage).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciminutesprojectmonthlyusageconnectionedges"></a>`edges` | [`[CiMinutesProjectMonthlyUsageEdge]`](#ciminutesprojectmonthlyusageedge) | A list of edges. |
|
|
| <a id="ciminutesprojectmonthlyusageconnectionnodes"></a>`nodes` | [`[CiMinutesProjectMonthlyUsage]`](#ciminutesprojectmonthlyusage) | A list of nodes. |
|
|
| <a id="ciminutesprojectmonthlyusageconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiMinutesProjectMonthlyUsageEdge`
|
|
|
|
The edge type for [`CiMinutesProjectMonthlyUsage`](#ciminutesprojectmonthlyusage).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciminutesprojectmonthlyusageedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="ciminutesprojectmonthlyusageedgenode"></a>`node` | [`CiMinutesProjectMonthlyUsage`](#ciminutesprojectmonthlyusage) | The item at the end of the edge. |
|
|
|
|
#### `CiRunnerConnection`
|
|
|
|
The connection type for [`CiRunner`](#cirunner).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cirunnerconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="cirunnerconnectionedges"></a>`edges` | [`[CiRunnerEdge]`](#cirunneredge) | A list of edges. |
|
|
| <a id="cirunnerconnectionnodes"></a>`nodes` | [`[CiRunner]`](#cirunner) | A list of nodes. |
|
|
| <a id="cirunnerconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiRunnerEdge`
|
|
|
|
The edge type for [`CiRunner`](#cirunner).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cirunneredgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="cirunneredgeediturl"></a>`editUrl` | [`String`](#string) | Web URL of the runner edit page. The value depends on where you put this field in the query. You can use it for projects or groups. |
|
|
| <a id="cirunneredgenode"></a>`node` | [`CiRunner`](#cirunner) | The item at the end of the edge. |
|
|
| <a id="cirunneredgeweburl"></a>`webUrl` | [`String`](#string) | Web URL of the runner. The value depends on where you put this field in the query. You can use it for projects or groups. |
|
|
|
|
#### `CiStageConnection`
|
|
|
|
The connection type for [`CiStage`](#cistage).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cistageconnectionedges"></a>`edges` | [`[CiStageEdge]`](#cistageedge) | A list of edges. |
|
|
| <a id="cistageconnectionnodes"></a>`nodes` | [`[CiStage]`](#cistage) | A list of nodes. |
|
|
| <a id="cistageconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CiStageEdge`
|
|
|
|
The edge type for [`CiStage`](#cistage).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cistageedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="cistageedgenode"></a>`node` | [`CiStage`](#cistage) | The item at the end of the edge. |
|
|
|
|
#### `ClusterAgentActivityEventConnection`
|
|
|
|
The connection type for [`ClusterAgentActivityEvent`](#clusteragentactivityevent).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragentactivityeventconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="clusteragentactivityeventconnectionedges"></a>`edges` | [`[ClusterAgentActivityEventEdge]`](#clusteragentactivityeventedge) | A list of edges. |
|
|
| <a id="clusteragentactivityeventconnectionnodes"></a>`nodes` | [`[ClusterAgentActivityEvent]`](#clusteragentactivityevent) | A list of nodes. |
|
|
| <a id="clusteragentactivityeventconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ClusterAgentActivityEventEdge`
|
|
|
|
The edge type for [`ClusterAgentActivityEvent`](#clusteragentactivityevent).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragentactivityeventedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="clusteragentactivityeventedgenode"></a>`node` | [`ClusterAgentActivityEvent`](#clusteragentactivityevent) | The item at the end of the edge. |
|
|
|
|
#### `ClusterAgentConnection`
|
|
|
|
The connection type for [`ClusterAgent`](#clusteragent).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragentconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="clusteragentconnectionedges"></a>`edges` | [`[ClusterAgentEdge]`](#clusteragentedge) | A list of edges. |
|
|
| <a id="clusteragentconnectionnodes"></a>`nodes` | [`[ClusterAgent]`](#clusteragent) | A list of nodes. |
|
|
| <a id="clusteragentconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ClusterAgentEdge`
|
|
|
|
The edge type for [`ClusterAgent`](#clusteragent).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragentedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="clusteragentedgenode"></a>`node` | [`ClusterAgent`](#clusteragent) | The item at the end of the edge. |
|
|
|
|
#### `ClusterAgentTokenConnection`
|
|
|
|
The connection type for [`ClusterAgentToken`](#clusteragenttoken).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragenttokenconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="clusteragenttokenconnectionedges"></a>`edges` | [`[ClusterAgentTokenEdge]`](#clusteragenttokenedge) | A list of edges. |
|
|
| <a id="clusteragenttokenconnectionnodes"></a>`nodes` | [`[ClusterAgentToken]`](#clusteragenttoken) | A list of nodes. |
|
|
| <a id="clusteragenttokenconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ClusterAgentTokenEdge`
|
|
|
|
The edge type for [`ClusterAgentToken`](#clusteragenttoken).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragenttokenedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="clusteragenttokenedgenode"></a>`node` | [`ClusterAgentToken`](#clusteragenttoken) | The item at the end of the edge. |
|
|
|
|
#### `CodeCoverageActivityConnection`
|
|
|
|
The connection type for [`CodeCoverageActivity`](#codecoverageactivity).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="codecoverageactivityconnectionedges"></a>`edges` | [`[CodeCoverageActivityEdge]`](#codecoverageactivityedge) | A list of edges. |
|
|
| <a id="codecoverageactivityconnectionnodes"></a>`nodes` | [`[CodeCoverageActivity]`](#codecoverageactivity) | A list of nodes. |
|
|
| <a id="codecoverageactivityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CodeCoverageActivityEdge`
|
|
|
|
The edge type for [`CodeCoverageActivity`](#codecoverageactivity).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="codecoverageactivityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="codecoverageactivityedgenode"></a>`node` | [`CodeCoverageActivity`](#codecoverageactivity) | The item at the end of the edge. |
|
|
|
|
#### `CodeQualityDegradationConnection`
|
|
|
|
The connection type for [`CodeQualityDegradation`](#codequalitydegradation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="codequalitydegradationconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="codequalitydegradationconnectionedges"></a>`edges` | [`[CodeQualityDegradationEdge]`](#codequalitydegradationedge) | A list of edges. |
|
|
| <a id="codequalitydegradationconnectionnodes"></a>`nodes` | [`[CodeQualityDegradation]`](#codequalitydegradation) | A list of nodes. |
|
|
| <a id="codequalitydegradationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CodeQualityDegradationEdge`
|
|
|
|
The edge type for [`CodeQualityDegradation`](#codequalitydegradation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="codequalitydegradationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="codequalitydegradationedgenode"></a>`node` | [`CodeQualityDegradation`](#codequalitydegradation) | The item at the end of the edge. |
|
|
|
|
#### `CommitConnection`
|
|
|
|
The connection type for [`Commit`](#commit).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="commitconnectionedges"></a>`edges` | [`[CommitEdge]`](#commitedge) | A list of edges. |
|
|
| <a id="commitconnectionnodes"></a>`nodes` | [`[Commit]`](#commit) | A list of nodes. |
|
|
| <a id="commitconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CommitEdge`
|
|
|
|
The edge type for [`Commit`](#commit).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="commitedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="commitedgenode"></a>`node` | [`Commit`](#commit) | The item at the end of the edge. |
|
|
|
|
#### `ComplianceFrameworkConnection`
|
|
|
|
The connection type for [`ComplianceFramework`](#complianceframework).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="complianceframeworkconnectionedges"></a>`edges` | [`[ComplianceFrameworkEdge]`](#complianceframeworkedge) | A list of edges. |
|
|
| <a id="complianceframeworkconnectionnodes"></a>`nodes` | [`[ComplianceFramework]`](#complianceframework) | A list of nodes. |
|
|
| <a id="complianceframeworkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ComplianceFrameworkEdge`
|
|
|
|
The edge type for [`ComplianceFramework`](#complianceframework).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="complianceframeworkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="complianceframeworkedgenode"></a>`node` | [`ComplianceFramework`](#complianceframework) | The item at the end of the edge. |
|
|
|
|
#### `ComplianceViolationConnection`
|
|
|
|
The connection type for [`ComplianceViolation`](#complianceviolation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="complianceviolationconnectionedges"></a>`edges` | [`[ComplianceViolationEdge]`](#complianceviolationedge) | A list of edges. |
|
|
| <a id="complianceviolationconnectionnodes"></a>`nodes` | [`[ComplianceViolation]`](#complianceviolation) | A list of nodes. |
|
|
| <a id="complianceviolationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ComplianceViolationEdge`
|
|
|
|
The edge type for [`ComplianceViolation`](#complianceviolation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="complianceviolationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="complianceviolationedgenode"></a>`node` | [`ComplianceViolation`](#complianceviolation) | The item at the end of the edge. |
|
|
|
|
#### `ConnectedAgentConnection`
|
|
|
|
The connection type for [`ConnectedAgent`](#connectedagent).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="connectedagentconnectionedges"></a>`edges` | [`[ConnectedAgentEdge]`](#connectedagentedge) | A list of edges. |
|
|
| <a id="connectedagentconnectionnodes"></a>`nodes` | [`[ConnectedAgent]`](#connectedagent) | A list of nodes. |
|
|
| <a id="connectedagentconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ConnectedAgentEdge`
|
|
|
|
The edge type for [`ConnectedAgent`](#connectedagent).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="connectedagentedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="connectedagentedgenode"></a>`node` | [`ConnectedAgent`](#connectedagent) | The item at the end of the edge. |
|
|
|
|
#### `ContainerRepositoryConnection`
|
|
|
|
The connection type for [`ContainerRepository`](#containerrepository).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerrepositoryconnectionedges"></a>`edges` | [`[ContainerRepositoryEdge]`](#containerrepositoryedge) | A list of edges. |
|
|
| <a id="containerrepositoryconnectionnodes"></a>`nodes` | [`[ContainerRepository]`](#containerrepository) | A list of nodes. |
|
|
| <a id="containerrepositoryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ContainerRepositoryEdge`
|
|
|
|
The edge type for [`ContainerRepository`](#containerrepository).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerrepositoryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="containerrepositoryedgenode"></a>`node` | [`ContainerRepository`](#containerrepository) | The item at the end of the edge. |
|
|
|
|
#### `ContainerRepositoryTagConnection`
|
|
|
|
The connection type for [`ContainerRepositoryTag`](#containerrepositorytag).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerrepositorytagconnectionedges"></a>`edges` | [`[ContainerRepositoryTagEdge]`](#containerrepositorytagedge) | A list of edges. |
|
|
| <a id="containerrepositorytagconnectionnodes"></a>`nodes` | [`[ContainerRepositoryTag]`](#containerrepositorytag) | A list of nodes. |
|
|
| <a id="containerrepositorytagconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ContainerRepositoryTagEdge`
|
|
|
|
The edge type for [`ContainerRepositoryTag`](#containerrepositorytag).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerrepositorytagedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="containerrepositorytagedgenode"></a>`node` | [`ContainerRepositoryTag`](#containerrepositorytag) | The item at the end of the edge. |
|
|
|
|
#### `CoverageFuzzingCorpusConnection`
|
|
|
|
The connection type for [`CoverageFuzzingCorpus`](#coveragefuzzingcorpus).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="coveragefuzzingcorpusconnectionedges"></a>`edges` | [`[CoverageFuzzingCorpusEdge]`](#coveragefuzzingcorpusedge) | A list of edges. |
|
|
| <a id="coveragefuzzingcorpusconnectionnodes"></a>`nodes` | [`[CoverageFuzzingCorpus]`](#coveragefuzzingcorpus) | A list of nodes. |
|
|
| <a id="coveragefuzzingcorpusconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CoverageFuzzingCorpusEdge`
|
|
|
|
The edge type for [`CoverageFuzzingCorpus`](#coveragefuzzingcorpus).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="coveragefuzzingcorpusedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="coveragefuzzingcorpusedgenode"></a>`node` | [`CoverageFuzzingCorpus`](#coveragefuzzingcorpus) | The item at the end of the edge. |
|
|
|
|
#### `CustomEmojiConnection`
|
|
|
|
The connection type for [`CustomEmoji`](#customemoji).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customemojiconnectionedges"></a>`edges` | [`[CustomEmojiEdge]`](#customemojiedge) | A list of edges. |
|
|
| <a id="customemojiconnectionnodes"></a>`nodes` | [`[CustomEmoji]`](#customemoji) | A list of nodes. |
|
|
| <a id="customemojiconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CustomEmojiEdge`
|
|
|
|
The edge type for [`CustomEmoji`](#customemoji).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customemojiedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="customemojiedgenode"></a>`node` | [`CustomEmoji`](#customemoji) | The item at the end of the edge. |
|
|
|
|
#### `CustomerRelationsContactConnection`
|
|
|
|
The connection type for [`CustomerRelationsContact`](#customerrelationscontact).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customerrelationscontactconnectionedges"></a>`edges` | [`[CustomerRelationsContactEdge]`](#customerrelationscontactedge) | A list of edges. |
|
|
| <a id="customerrelationscontactconnectionnodes"></a>`nodes` | [`[CustomerRelationsContact]`](#customerrelationscontact) | A list of nodes. |
|
|
| <a id="customerrelationscontactconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CustomerRelationsContactEdge`
|
|
|
|
The edge type for [`CustomerRelationsContact`](#customerrelationscontact).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customerrelationscontactedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="customerrelationscontactedgenode"></a>`node` | [`CustomerRelationsContact`](#customerrelationscontact) | The item at the end of the edge. |
|
|
|
|
#### `CustomerRelationsOrganizationConnection`
|
|
|
|
The connection type for [`CustomerRelationsOrganization`](#customerrelationsorganization).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customerrelationsorganizationconnectionedges"></a>`edges` | [`[CustomerRelationsOrganizationEdge]`](#customerrelationsorganizationedge) | A list of edges. |
|
|
| <a id="customerrelationsorganizationconnectionnodes"></a>`nodes` | [`[CustomerRelationsOrganization]`](#customerrelationsorganization) | A list of nodes. |
|
|
| <a id="customerrelationsorganizationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `CustomerRelationsOrganizationEdge`
|
|
|
|
The edge type for [`CustomerRelationsOrganization`](#customerrelationsorganization).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customerrelationsorganizationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="customerrelationsorganizationedgenode"></a>`node` | [`CustomerRelationsOrganization`](#customerrelationsorganization) | The item at the end of the edge. |
|
|
|
|
#### `DastProfileConnection`
|
|
|
|
The connection type for [`DastProfile`](#dastprofile).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastprofileconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="dastprofileconnectionedges"></a>`edges` | [`[DastProfileEdge]`](#dastprofileedge) | A list of edges. |
|
|
| <a id="dastprofileconnectionnodes"></a>`nodes` | [`[DastProfile]`](#dastprofile) | A list of nodes. |
|
|
| <a id="dastprofileconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DastProfileEdge`
|
|
|
|
The edge type for [`DastProfile`](#dastprofile).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastprofileedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="dastprofileedgenode"></a>`node` | [`DastProfile`](#dastprofile) | The item at the end of the edge. |
|
|
|
|
#### `DastScannerProfileConnection`
|
|
|
|
The connection type for [`DastScannerProfile`](#dastscannerprofile).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastscannerprofileconnectionedges"></a>`edges` | [`[DastScannerProfileEdge]`](#dastscannerprofileedge) | A list of edges. |
|
|
| <a id="dastscannerprofileconnectionnodes"></a>`nodes` | [`[DastScannerProfile]`](#dastscannerprofile) | A list of nodes. |
|
|
| <a id="dastscannerprofileconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DastScannerProfileEdge`
|
|
|
|
The edge type for [`DastScannerProfile`](#dastscannerprofile).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastscannerprofileedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="dastscannerprofileedgenode"></a>`node` | [`DastScannerProfile`](#dastscannerprofile) | The item at the end of the edge. |
|
|
|
|
#### `DastSiteProfileConnection`
|
|
|
|
The connection type for [`DastSiteProfile`](#dastsiteprofile).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsiteprofileconnectionedges"></a>`edges` | [`[DastSiteProfileEdge]`](#dastsiteprofileedge) | A list of edges. |
|
|
| <a id="dastsiteprofileconnectionnodes"></a>`nodes` | [`[DastSiteProfile]`](#dastsiteprofile) | A list of nodes. |
|
|
| <a id="dastsiteprofileconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DastSiteProfileEdge`
|
|
|
|
The edge type for [`DastSiteProfile`](#dastsiteprofile).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsiteprofileedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="dastsiteprofileedgenode"></a>`node` | [`DastSiteProfile`](#dastsiteprofile) | The item at the end of the edge. |
|
|
|
|
#### `DastSiteValidationConnection`
|
|
|
|
The connection type for [`DastSiteValidation`](#dastsitevalidation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsitevalidationconnectionedges"></a>`edges` | [`[DastSiteValidationEdge]`](#dastsitevalidationedge) | A list of edges. |
|
|
| <a id="dastsitevalidationconnectionnodes"></a>`nodes` | [`[DastSiteValidation]`](#dastsitevalidation) | A list of nodes. |
|
|
| <a id="dastsitevalidationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DastSiteValidationEdge`
|
|
|
|
The edge type for [`DastSiteValidation`](#dastsitevalidation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsitevalidationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="dastsitevalidationedgenode"></a>`node` | [`DastSiteValidation`](#dastsitevalidation) | The item at the end of the edge. |
|
|
|
|
#### `DependencyProxyBlobConnection`
|
|
|
|
The connection type for [`DependencyProxyBlob`](#dependencyproxyblob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dependencyproxyblobconnectionedges"></a>`edges` | [`[DependencyProxyBlobEdge]`](#dependencyproxyblobedge) | A list of edges. |
|
|
| <a id="dependencyproxyblobconnectionnodes"></a>`nodes` | [`[DependencyProxyBlob]`](#dependencyproxyblob) | A list of nodes. |
|
|
| <a id="dependencyproxyblobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DependencyProxyBlobEdge`
|
|
|
|
The edge type for [`DependencyProxyBlob`](#dependencyproxyblob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dependencyproxyblobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="dependencyproxyblobedgenode"></a>`node` | [`DependencyProxyBlob`](#dependencyproxyblob) | The item at the end of the edge. |
|
|
|
|
#### `DependencyProxyManifestConnection`
|
|
|
|
The connection type for [`DependencyProxyManifest`](#dependencyproxymanifest).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dependencyproxymanifestconnectionedges"></a>`edges` | [`[DependencyProxyManifestEdge]`](#dependencyproxymanifestedge) | A list of edges. |
|
|
| <a id="dependencyproxymanifestconnectionnodes"></a>`nodes` | [`[DependencyProxyManifest]`](#dependencyproxymanifest) | A list of nodes. |
|
|
| <a id="dependencyproxymanifestconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DependencyProxyManifestEdge`
|
|
|
|
The edge type for [`DependencyProxyManifest`](#dependencyproxymanifest).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dependencyproxymanifestedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="dependencyproxymanifestedgenode"></a>`node` | [`DependencyProxyManifest`](#dependencyproxymanifest) | The item at the end of the edge. |
|
|
|
|
#### `DesignAtVersionConnection`
|
|
|
|
The connection type for [`DesignAtVersion`](#designatversion).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designatversionconnectionedges"></a>`edges` | [`[DesignAtVersionEdge]`](#designatversionedge) | A list of edges. |
|
|
| <a id="designatversionconnectionnodes"></a>`nodes` | [`[DesignAtVersion]`](#designatversion) | A list of nodes. |
|
|
| <a id="designatversionconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DesignAtVersionEdge`
|
|
|
|
The edge type for [`DesignAtVersion`](#designatversion).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designatversionedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="designatversionedgenode"></a>`node` | [`DesignAtVersion`](#designatversion) | The item at the end of the edge. |
|
|
|
|
#### `DesignConnection`
|
|
|
|
The connection type for [`Design`](#design).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designconnectionedges"></a>`edges` | [`[DesignEdge]`](#designedge) | A list of edges. |
|
|
| <a id="designconnectionnodes"></a>`nodes` | [`[Design]`](#design) | A list of nodes. |
|
|
| <a id="designconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DesignEdge`
|
|
|
|
The edge type for [`Design`](#design).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="designedgenode"></a>`node` | [`Design`](#design) | The item at the end of the edge. |
|
|
|
|
#### `DesignVersionConnection`
|
|
|
|
The connection type for [`DesignVersion`](#designversion).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designversionconnectionedges"></a>`edges` | [`[DesignVersionEdge]`](#designversionedge) | A list of edges. |
|
|
| <a id="designversionconnectionnodes"></a>`nodes` | [`[DesignVersion]`](#designversion) | A list of nodes. |
|
|
| <a id="designversionconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DesignVersionEdge`
|
|
|
|
The edge type for [`DesignVersion`](#designversion).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designversionedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="designversionedgenode"></a>`node` | [`DesignVersion`](#designversion) | The item at the end of the edge. |
|
|
|
|
#### `DevopsAdoptionEnabledNamespaceConnection`
|
|
|
|
The connection type for [`DevopsAdoptionEnabledNamespace`](#devopsadoptionenablednamespace).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="devopsadoptionenablednamespaceconnectionedges"></a>`edges` | [`[DevopsAdoptionEnabledNamespaceEdge]`](#devopsadoptionenablednamespaceedge) | A list of edges. |
|
|
| <a id="devopsadoptionenablednamespaceconnectionnodes"></a>`nodes` | [`[DevopsAdoptionEnabledNamespace]`](#devopsadoptionenablednamespace) | A list of nodes. |
|
|
| <a id="devopsadoptionenablednamespaceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DevopsAdoptionEnabledNamespaceEdge`
|
|
|
|
The edge type for [`DevopsAdoptionEnabledNamespace`](#devopsadoptionenablednamespace).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="devopsadoptionenablednamespaceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="devopsadoptionenablednamespaceedgenode"></a>`node` | [`DevopsAdoptionEnabledNamespace`](#devopsadoptionenablednamespace) | The item at the end of the edge. |
|
|
|
|
#### `DevopsAdoptionSnapshotConnection`
|
|
|
|
The connection type for [`DevopsAdoptionSnapshot`](#devopsadoptionsnapshot).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="devopsadoptionsnapshotconnectionedges"></a>`edges` | [`[DevopsAdoptionSnapshotEdge]`](#devopsadoptionsnapshotedge) | A list of edges. |
|
|
| <a id="devopsadoptionsnapshotconnectionnodes"></a>`nodes` | [`[DevopsAdoptionSnapshot]`](#devopsadoptionsnapshot) | A list of nodes. |
|
|
| <a id="devopsadoptionsnapshotconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DevopsAdoptionSnapshotEdge`
|
|
|
|
The edge type for [`DevopsAdoptionSnapshot`](#devopsadoptionsnapshot).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="devopsadoptionsnapshotedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="devopsadoptionsnapshotedgenode"></a>`node` | [`DevopsAdoptionSnapshot`](#devopsadoptionsnapshot) | The item at the end of the edge. |
|
|
|
|
#### `DiscussionConnection`
|
|
|
|
The connection type for [`Discussion`](#discussion).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="discussionconnectionedges"></a>`edges` | [`[DiscussionEdge]`](#discussionedge) | A list of edges. |
|
|
| <a id="discussionconnectionnodes"></a>`nodes` | [`[Discussion]`](#discussion) | A list of nodes. |
|
|
| <a id="discussionconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `DiscussionEdge`
|
|
|
|
The edge type for [`Discussion`](#discussion).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="discussionedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="discussionedgenode"></a>`node` | [`Discussion`](#discussion) | The item at the end of the edge. |
|
|
|
|
#### `EnvironmentConnection`
|
|
|
|
The connection type for [`Environment`](#environment).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="environmentconnectionedges"></a>`edges` | [`[EnvironmentEdge]`](#environmentedge) | A list of edges. |
|
|
| <a id="environmentconnectionnodes"></a>`nodes` | [`[Environment]`](#environment) | A list of nodes. |
|
|
| <a id="environmentconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `EnvironmentEdge`
|
|
|
|
The edge type for [`Environment`](#environment).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="environmentedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="environmentedgenode"></a>`node` | [`Environment`](#environment) | The item at the end of the edge. |
|
|
|
|
#### `EpicBoardConnection`
|
|
|
|
The connection type for [`EpicBoard`](#epicboard).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicboardconnectionedges"></a>`edges` | [`[EpicBoardEdge]`](#epicboardedge) | A list of edges. |
|
|
| <a id="epicboardconnectionnodes"></a>`nodes` | [`[EpicBoard]`](#epicboard) | A list of nodes. |
|
|
| <a id="epicboardconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `EpicBoardEdge`
|
|
|
|
The edge type for [`EpicBoard`](#epicboard).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicboardedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="epicboardedgenode"></a>`node` | [`EpicBoard`](#epicboard) | The item at the end of the edge. |
|
|
|
|
#### `EpicConnection`
|
|
|
|
The connection type for [`Epic`](#epic).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicconnectionedges"></a>`edges` | [`[EpicEdge]`](#epicedge) | A list of edges. |
|
|
| <a id="epicconnectionnodes"></a>`nodes` | [`[Epic]`](#epic) | A list of nodes. |
|
|
| <a id="epicconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `EpicEdge`
|
|
|
|
The edge type for [`Epic`](#epic).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="epicedgenode"></a>`node` | [`Epic`](#epic) | The item at the end of the edge. |
|
|
|
|
#### `EpicIssueConnection`
|
|
|
|
The connection type for [`EpicIssue`](#epicissue).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicissueconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="epicissueconnectionedges"></a>`edges` | [`[EpicIssueEdge]`](#epicissueedge) | A list of edges. |
|
|
| <a id="epicissueconnectionnodes"></a>`nodes` | [`[EpicIssue]`](#epicissue) | A list of nodes. |
|
|
| <a id="epicissueconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
| <a id="epicissueconnectionweight"></a>`weight` | [`Int!`](#int) | Total weight of issues collection. |
|
|
|
|
#### `EpicIssueEdge`
|
|
|
|
The edge type for [`EpicIssue`](#epicissue).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicissueedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="epicissueedgenode"></a>`node` | [`EpicIssue`](#epicissue) | The item at the end of the edge. |
|
|
|
|
#### `EpicListConnection`
|
|
|
|
The connection type for [`EpicList`](#epiclist).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epiclistconnectionedges"></a>`edges` | [`[EpicListEdge]`](#epiclistedge) | A list of edges. |
|
|
| <a id="epiclistconnectionnodes"></a>`nodes` | [`[EpicList]`](#epiclist) | A list of nodes. |
|
|
| <a id="epiclistconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `EpicListEdge`
|
|
|
|
The edge type for [`EpicList`](#epiclist).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epiclistedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="epiclistedgenode"></a>`node` | [`EpicList`](#epiclist) | The item at the end of the edge. |
|
|
|
|
#### `EscalationPolicyTypeConnection`
|
|
|
|
The connection type for [`EscalationPolicyType`](#escalationpolicytype).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="escalationpolicytypeconnectionedges"></a>`edges` | [`[EscalationPolicyTypeEdge]`](#escalationpolicytypeedge) | A list of edges. |
|
|
| <a id="escalationpolicytypeconnectionnodes"></a>`nodes` | [`[EscalationPolicyType]`](#escalationpolicytype) | A list of nodes. |
|
|
| <a id="escalationpolicytypeconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `EscalationPolicyTypeEdge`
|
|
|
|
The edge type for [`EscalationPolicyType`](#escalationpolicytype).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="escalationpolicytypeedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="escalationpolicytypeedgenode"></a>`node` | [`EscalationPolicyType`](#escalationpolicytype) | The item at the end of the edge. |
|
|
|
|
#### `EventConnection`
|
|
|
|
The connection type for [`Event`](#event).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="eventconnectionedges"></a>`edges` | [`[EventEdge]`](#eventedge) | A list of edges. |
|
|
| <a id="eventconnectionnodes"></a>`nodes` | [`[Event]`](#event) | A list of nodes. |
|
|
| <a id="eventconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `EventEdge`
|
|
|
|
The edge type for [`Event`](#event).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="eventedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="eventedgenode"></a>`node` | [`Event`](#event) | The item at the end of the edge. |
|
|
|
|
#### `ExternalAuditEventDestinationConnection`
|
|
|
|
The connection type for [`ExternalAuditEventDestination`](#externalauditeventdestination).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="externalauditeventdestinationconnectionedges"></a>`edges` | [`[ExternalAuditEventDestinationEdge]`](#externalauditeventdestinationedge) | A list of edges. |
|
|
| <a id="externalauditeventdestinationconnectionnodes"></a>`nodes` | [`[ExternalAuditEventDestination]`](#externalauditeventdestination) | A list of nodes. |
|
|
| <a id="externalauditeventdestinationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ExternalAuditEventDestinationEdge`
|
|
|
|
The edge type for [`ExternalAuditEventDestination`](#externalauditeventdestination).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="externalauditeventdestinationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="externalauditeventdestinationedgenode"></a>`node` | [`ExternalAuditEventDestination`](#externalauditeventdestination) | The item at the end of the edge. |
|
|
|
|
#### `GroupConnection`
|
|
|
|
The connection type for [`Group`](#group).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupconnectionedges"></a>`edges` | [`[GroupEdge]`](#groupedge) | A list of edges. |
|
|
| <a id="groupconnectionnodes"></a>`nodes` | [`[Group]`](#group) | A list of nodes. |
|
|
| <a id="groupconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `GroupEdge`
|
|
|
|
The edge type for [`Group`](#group).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="groupedgenode"></a>`node` | [`Group`](#group) | The item at the end of the edge. |
|
|
|
|
#### `GroupMemberConnection`
|
|
|
|
The connection type for [`GroupMember`](#groupmember).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupmemberconnectionedges"></a>`edges` | [`[GroupMemberEdge]`](#groupmemberedge) | A list of edges. |
|
|
| <a id="groupmemberconnectionnodes"></a>`nodes` | [`[GroupMember]`](#groupmember) | A list of nodes. |
|
|
| <a id="groupmemberconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `GroupMemberEdge`
|
|
|
|
The edge type for [`GroupMember`](#groupmember).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupmemberedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="groupmemberedgenode"></a>`node` | [`GroupMember`](#groupmember) | The item at the end of the edge. |
|
|
|
|
#### `GroupWikiRepositoryRegistryConnection`
|
|
|
|
The connection type for [`GroupWikiRepositoryRegistry`](#groupwikirepositoryregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupwikirepositoryregistryconnectionedges"></a>`edges` | [`[GroupWikiRepositoryRegistryEdge]`](#groupwikirepositoryregistryedge) | A list of edges. |
|
|
| <a id="groupwikirepositoryregistryconnectionnodes"></a>`nodes` | [`[GroupWikiRepositoryRegistry]`](#groupwikirepositoryregistry) | A list of nodes. |
|
|
| <a id="groupwikirepositoryregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `GroupWikiRepositoryRegistryEdge`
|
|
|
|
The edge type for [`GroupWikiRepositoryRegistry`](#groupwikirepositoryregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupwikirepositoryregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="groupwikirepositoryregistryedgenode"></a>`node` | [`GroupWikiRepositoryRegistry`](#groupwikirepositoryregistry) | The item at the end of the edge. |
|
|
|
|
#### `IncidentManagementOncallRotationConnection`
|
|
|
|
The connection type for [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallrotationconnectionedges"></a>`edges` | [`[IncidentManagementOncallRotationEdge]`](#incidentmanagementoncallrotationedge) | A list of edges. |
|
|
| <a id="incidentmanagementoncallrotationconnectionnodes"></a>`nodes` | [`[IncidentManagementOncallRotation]`](#incidentmanagementoncallrotation) | A list of nodes. |
|
|
| <a id="incidentmanagementoncallrotationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `IncidentManagementOncallRotationEdge`
|
|
|
|
The edge type for [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallrotationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="incidentmanagementoncallrotationedgenode"></a>`node` | [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation) | The item at the end of the edge. |
|
|
|
|
#### `IncidentManagementOncallScheduleConnection`
|
|
|
|
The connection type for [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallscheduleconnectionedges"></a>`edges` | [`[IncidentManagementOncallScheduleEdge]`](#incidentmanagementoncallscheduleedge) | A list of edges. |
|
|
| <a id="incidentmanagementoncallscheduleconnectionnodes"></a>`nodes` | [`[IncidentManagementOncallSchedule]`](#incidentmanagementoncallschedule) | A list of nodes. |
|
|
| <a id="incidentmanagementoncallscheduleconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `IncidentManagementOncallScheduleEdge`
|
|
|
|
The edge type for [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallscheduleedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="incidentmanagementoncallscheduleedgenode"></a>`node` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | The item at the end of the edge. |
|
|
|
|
#### `IncidentManagementOncallShiftConnection`
|
|
|
|
The connection type for [`IncidentManagementOncallShift`](#incidentmanagementoncallshift).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallshiftconnectionedges"></a>`edges` | [`[IncidentManagementOncallShiftEdge]`](#incidentmanagementoncallshiftedge) | A list of edges. |
|
|
| <a id="incidentmanagementoncallshiftconnectionnodes"></a>`nodes` | [`[IncidentManagementOncallShift]`](#incidentmanagementoncallshift) | A list of nodes. |
|
|
| <a id="incidentmanagementoncallshiftconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `IncidentManagementOncallShiftEdge`
|
|
|
|
The edge type for [`IncidentManagementOncallShift`](#incidentmanagementoncallshift).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallshiftedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="incidentmanagementoncallshiftedgenode"></a>`node` | [`IncidentManagementOncallShift`](#incidentmanagementoncallshift) | The item at the end of the edge. |
|
|
|
|
#### `IssueConnection`
|
|
|
|
The connection type for [`Issue`](#issue).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="issueconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="issueconnectionedges"></a>`edges` | [`[IssueEdge]`](#issueedge) | A list of edges. |
|
|
| <a id="issueconnectionnodes"></a>`nodes` | [`[Issue]`](#issue) | A list of nodes. |
|
|
| <a id="issueconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
| <a id="issueconnectionweight"></a>`weight` | [`Int!`](#int) | Total weight of issues collection. |
|
|
|
|
#### `IssueEdge`
|
|
|
|
The edge type for [`Issue`](#issue).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="issueedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="issueedgenode"></a>`node` | [`Issue`](#issue) | The item at the end of the edge. |
|
|
|
|
#### `IterationCadenceConnection`
|
|
|
|
The connection type for [`IterationCadence`](#iterationcadence).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="iterationcadenceconnectionedges"></a>`edges` | [`[IterationCadenceEdge]`](#iterationcadenceedge) | A list of edges. |
|
|
| <a id="iterationcadenceconnectionnodes"></a>`nodes` | [`[IterationCadence]`](#iterationcadence) | A list of nodes. |
|
|
| <a id="iterationcadenceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `IterationCadenceEdge`
|
|
|
|
The edge type for [`IterationCadence`](#iterationcadence).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="iterationcadenceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="iterationcadenceedgenode"></a>`node` | [`IterationCadence`](#iterationcadence) | The item at the end of the edge. |
|
|
|
|
#### `IterationConnection`
|
|
|
|
The connection type for [`Iteration`](#iteration).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="iterationconnectionedges"></a>`edges` | [`[IterationEdge]`](#iterationedge) | A list of edges. |
|
|
| <a id="iterationconnectionnodes"></a>`nodes` | [`[Iteration]`](#iteration) | A list of nodes. |
|
|
| <a id="iterationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `IterationEdge`
|
|
|
|
The edge type for [`Iteration`](#iteration).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="iterationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="iterationedgenode"></a>`node` | [`Iteration`](#iteration) | The item at the end of the edge. |
|
|
|
|
#### `JiraImportConnection`
|
|
|
|
The connection type for [`JiraImport`](#jiraimport).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jiraimportconnectionedges"></a>`edges` | [`[JiraImportEdge]`](#jiraimportedge) | A list of edges. |
|
|
| <a id="jiraimportconnectionnodes"></a>`nodes` | [`[JiraImport]`](#jiraimport) | A list of nodes. |
|
|
| <a id="jiraimportconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `JiraImportEdge`
|
|
|
|
The edge type for [`JiraImport`](#jiraimport).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jiraimportedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="jiraimportedgenode"></a>`node` | [`JiraImport`](#jiraimport) | The item at the end of the edge. |
|
|
|
|
#### `JiraProjectConnection`
|
|
|
|
The connection type for [`JiraProject`](#jiraproject).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jiraprojectconnectionedges"></a>`edges` | [`[JiraProjectEdge]`](#jiraprojectedge) | A list of edges. |
|
|
| <a id="jiraprojectconnectionnodes"></a>`nodes` | [`[JiraProject]`](#jiraproject) | A list of nodes. |
|
|
| <a id="jiraprojectconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `JiraProjectEdge`
|
|
|
|
The edge type for [`JiraProject`](#jiraproject).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jiraprojectedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="jiraprojectedgenode"></a>`node` | [`JiraProject`](#jiraproject) | The item at the end of the edge. |
|
|
|
|
#### `JobArtifactRegistryConnection`
|
|
|
|
The connection type for [`JobArtifactRegistry`](#jobartifactregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jobartifactregistryconnectionedges"></a>`edges` | [`[JobArtifactRegistryEdge]`](#jobartifactregistryedge) | A list of edges. |
|
|
| <a id="jobartifactregistryconnectionnodes"></a>`nodes` | [`[JobArtifactRegistry]`](#jobartifactregistry) | A list of nodes. |
|
|
| <a id="jobartifactregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `JobArtifactRegistryEdge`
|
|
|
|
The edge type for [`JobArtifactRegistry`](#jobartifactregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jobartifactregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="jobartifactregistryedgenode"></a>`node` | [`JobArtifactRegistry`](#jobartifactregistry) | The item at the end of the edge. |
|
|
|
|
#### `JobNeedUnionConnection`
|
|
|
|
The connection type for [`JobNeedUnion`](#jobneedunion).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jobneedunionconnectionedges"></a>`edges` | [`[JobNeedUnionEdge]`](#jobneedunionedge) | A list of edges. |
|
|
| <a id="jobneedunionconnectionnodes"></a>`nodes` | [`[JobNeedUnion]`](#jobneedunion) | A list of nodes. |
|
|
| <a id="jobneedunionconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `JobNeedUnionEdge`
|
|
|
|
The edge type for [`JobNeedUnion`](#jobneedunion).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jobneedunionedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="jobneedunionedgenode"></a>`node` | [`JobNeedUnion`](#jobneedunion) | The item at the end of the edge. |
|
|
|
|
#### `LabelConnection`
|
|
|
|
The connection type for [`Label`](#label).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="labelconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="labelconnectionedges"></a>`edges` | [`[LabelEdge]`](#labeledge) | A list of edges. |
|
|
| <a id="labelconnectionnodes"></a>`nodes` | [`[Label]`](#label) | A list of nodes. |
|
|
| <a id="labelconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `LabelEdge`
|
|
|
|
The edge type for [`Label`](#label).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="labeledgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="labeledgenode"></a>`node` | [`Label`](#label) | The item at the end of the edge. |
|
|
|
|
#### `LfsObjectRegistryConnection`
|
|
|
|
The connection type for [`LfsObjectRegistry`](#lfsobjectregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="lfsobjectregistryconnectionedges"></a>`edges` | [`[LfsObjectRegistryEdge]`](#lfsobjectregistryedge) | A list of edges. |
|
|
| <a id="lfsobjectregistryconnectionnodes"></a>`nodes` | [`[LfsObjectRegistry]`](#lfsobjectregistry) | A list of nodes. |
|
|
| <a id="lfsobjectregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `LfsObjectRegistryEdge`
|
|
|
|
The edge type for [`LfsObjectRegistry`](#lfsobjectregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="lfsobjectregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="lfsobjectregistryedgenode"></a>`node` | [`LfsObjectRegistry`](#lfsobjectregistry) | The item at the end of the edge. |
|
|
|
|
#### `LicenseHistoryEntryConnection`
|
|
|
|
The connection type for [`LicenseHistoryEntry`](#licensehistoryentry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="licensehistoryentryconnectionedges"></a>`edges` | [`[LicenseHistoryEntryEdge]`](#licensehistoryentryedge) | A list of edges. |
|
|
| <a id="licensehistoryentryconnectionnodes"></a>`nodes` | [`[LicenseHistoryEntry]`](#licensehistoryentry) | A list of nodes. |
|
|
| <a id="licensehistoryentryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `LicenseHistoryEntryEdge`
|
|
|
|
The edge type for [`LicenseHistoryEntry`](#licensehistoryentry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="licensehistoryentryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="licensehistoryentryedgenode"></a>`node` | [`LicenseHistoryEntry`](#licensehistoryentry) | The item at the end of the edge. |
|
|
|
|
#### `MemberInterfaceConnection`
|
|
|
|
The connection type for [`MemberInterface`](#memberinterface).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="memberinterfaceconnectionedges"></a>`edges` | [`[MemberInterfaceEdge]`](#memberinterfaceedge) | A list of edges. |
|
|
| <a id="memberinterfaceconnectionnodes"></a>`nodes` | [`[MemberInterface]`](#memberinterface) | A list of nodes. |
|
|
| <a id="memberinterfaceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `MemberInterfaceEdge`
|
|
|
|
The edge type for [`MemberInterface`](#memberinterface).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="memberinterfaceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="memberinterfaceedgenode"></a>`node` | [`MemberInterface`](#memberinterface) | The item at the end of the edge. |
|
|
|
|
#### `MergeRequestAssigneeConnection`
|
|
|
|
The connection type for [`MergeRequestAssignee`](#mergerequestassignee).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneeconnectionedges"></a>`edges` | [`[MergeRequestAssigneeEdge]`](#mergerequestassigneeedge) | A list of edges. |
|
|
| <a id="mergerequestassigneeconnectionnodes"></a>`nodes` | [`[MergeRequestAssignee]`](#mergerequestassignee) | A list of nodes. |
|
|
| <a id="mergerequestassigneeconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `MergeRequestAssigneeEdge`
|
|
|
|
The edge type for [`MergeRequestAssignee`](#mergerequestassignee).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneeedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="mergerequestassigneeedgenode"></a>`node` | [`MergeRequestAssignee`](#mergerequestassignee) | The item at the end of the edge. |
|
|
|
|
#### `MergeRequestConnection`
|
|
|
|
The connection type for [`MergeRequest`](#mergerequest).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="mergerequestconnectionedges"></a>`edges` | [`[MergeRequestEdge]`](#mergerequestedge) | A list of edges. |
|
|
| <a id="mergerequestconnectionnodes"></a>`nodes` | [`[MergeRequest]`](#mergerequest) | A list of nodes. |
|
|
| <a id="mergerequestconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
| <a id="mergerequestconnectiontotaltimetomerge"></a>`totalTimeToMerge` | [`Float`](#float) | Total sum of time to merge, in seconds, for the collection of merge requests. |
|
|
|
|
#### `MergeRequestDiffRegistryConnection`
|
|
|
|
The connection type for [`MergeRequestDiffRegistry`](#mergerequestdiffregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestdiffregistryconnectionedges"></a>`edges` | [`[MergeRequestDiffRegistryEdge]`](#mergerequestdiffregistryedge) | A list of edges. |
|
|
| <a id="mergerequestdiffregistryconnectionnodes"></a>`nodes` | [`[MergeRequestDiffRegistry]`](#mergerequestdiffregistry) | A list of nodes. |
|
|
| <a id="mergerequestdiffregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `MergeRequestDiffRegistryEdge`
|
|
|
|
The edge type for [`MergeRequestDiffRegistry`](#mergerequestdiffregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestdiffregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="mergerequestdiffregistryedgenode"></a>`node` | [`MergeRequestDiffRegistry`](#mergerequestdiffregistry) | The item at the end of the edge. |
|
|
|
|
#### `MergeRequestEdge`
|
|
|
|
The edge type for [`MergeRequest`](#mergerequest).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="mergerequestedgenode"></a>`node` | [`MergeRequest`](#mergerequest) | The item at the end of the edge. |
|
|
|
|
#### `MergeRequestParticipantConnection`
|
|
|
|
The connection type for [`MergeRequestParticipant`](#mergerequestparticipant).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantconnectionedges"></a>`edges` | [`[MergeRequestParticipantEdge]`](#mergerequestparticipantedge) | A list of edges. |
|
|
| <a id="mergerequestparticipantconnectionnodes"></a>`nodes` | [`[MergeRequestParticipant]`](#mergerequestparticipant) | A list of nodes. |
|
|
| <a id="mergerequestparticipantconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `MergeRequestParticipantEdge`
|
|
|
|
The edge type for [`MergeRequestParticipant`](#mergerequestparticipant).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="mergerequestparticipantedgenode"></a>`node` | [`MergeRequestParticipant`](#mergerequestparticipant) | The item at the end of the edge. |
|
|
|
|
#### `MergeRequestReviewerConnection`
|
|
|
|
The connection type for [`MergeRequestReviewer`](#mergerequestreviewer).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewerconnectionedges"></a>`edges` | [`[MergeRequestReviewerEdge]`](#mergerequestrevieweredge) | A list of edges. |
|
|
| <a id="mergerequestreviewerconnectionnodes"></a>`nodes` | [`[MergeRequestReviewer]`](#mergerequestreviewer) | A list of nodes. |
|
|
| <a id="mergerequestreviewerconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `MergeRequestReviewerEdge`
|
|
|
|
The edge type for [`MergeRequestReviewer`](#mergerequestreviewer).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestrevieweredgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="mergerequestrevieweredgenode"></a>`node` | [`MergeRequestReviewer`](#mergerequestreviewer) | The item at the end of the edge. |
|
|
|
|
#### `MetricsDashboardAnnotationConnection`
|
|
|
|
The connection type for [`MetricsDashboardAnnotation`](#metricsdashboardannotation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="metricsdashboardannotationconnectionedges"></a>`edges` | [`[MetricsDashboardAnnotationEdge]`](#metricsdashboardannotationedge) | A list of edges. |
|
|
| <a id="metricsdashboardannotationconnectionnodes"></a>`nodes` | [`[MetricsDashboardAnnotation]`](#metricsdashboardannotation) | A list of nodes. |
|
|
| <a id="metricsdashboardannotationconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `MetricsDashboardAnnotationEdge`
|
|
|
|
The edge type for [`MetricsDashboardAnnotation`](#metricsdashboardannotation).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="metricsdashboardannotationedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="metricsdashboardannotationedgenode"></a>`node` | [`MetricsDashboardAnnotation`](#metricsdashboardannotation) | The item at the end of the edge. |
|
|
|
|
#### `MilestoneConnection`
|
|
|
|
The connection type for [`Milestone`](#milestone).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="milestoneconnectionedges"></a>`edges` | [`[MilestoneEdge]`](#milestoneedge) | A list of edges. |
|
|
| <a id="milestoneconnectionnodes"></a>`nodes` | [`[Milestone]`](#milestone) | A list of nodes. |
|
|
| <a id="milestoneconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `MilestoneEdge`
|
|
|
|
The edge type for [`Milestone`](#milestone).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="milestoneedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="milestoneedgenode"></a>`node` | [`Milestone`](#milestone) | The item at the end of the edge. |
|
|
|
|
#### `NamespaceConnection`
|
|
|
|
The connection type for [`Namespace`](#namespace).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="namespaceconnectionedges"></a>`edges` | [`[NamespaceEdge]`](#namespaceedge) | A list of edges. |
|
|
| <a id="namespaceconnectionnodes"></a>`nodes` | [`[Namespace]`](#namespace) | A list of nodes. |
|
|
| <a id="namespaceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `NamespaceEdge`
|
|
|
|
The edge type for [`Namespace`](#namespace).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="namespaceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="namespaceedgenode"></a>`node` | [`Namespace`](#namespace) | The item at the end of the edge. |
|
|
|
|
#### `NetworkPolicyConnection`
|
|
|
|
The connection type for [`NetworkPolicy`](#networkpolicy).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="networkpolicyconnectionedges"></a>`edges` | [`[NetworkPolicyEdge]`](#networkpolicyedge) | A list of edges. |
|
|
| <a id="networkpolicyconnectionnodes"></a>`nodes` | [`[NetworkPolicy]`](#networkpolicy) | A list of nodes. |
|
|
| <a id="networkpolicyconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `NetworkPolicyEdge`
|
|
|
|
The edge type for [`NetworkPolicy`](#networkpolicy).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="networkpolicyedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="networkpolicyedgenode"></a>`node` | [`NetworkPolicy`](#networkpolicy) | The item at the end of the edge. |
|
|
|
|
#### `NoteConnection`
|
|
|
|
The connection type for [`Note`](#note).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="noteconnectionedges"></a>`edges` | [`[NoteEdge]`](#noteedge) | A list of edges. |
|
|
| <a id="noteconnectionnodes"></a>`nodes` | [`[Note]`](#note) | A list of nodes. |
|
|
| <a id="noteconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `NoteEdge`
|
|
|
|
The edge type for [`Note`](#note).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="noteedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="noteedgenode"></a>`node` | [`Note`](#note) | The item at the end of the edge. |
|
|
|
|
#### `OncallParticipantTypeConnection`
|
|
|
|
The connection type for [`OncallParticipantType`](#oncallparticipanttype).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="oncallparticipanttypeconnectionedges"></a>`edges` | [`[OncallParticipantTypeEdge]`](#oncallparticipanttypeedge) | A list of edges. |
|
|
| <a id="oncallparticipanttypeconnectionnodes"></a>`nodes` | [`[OncallParticipantType]`](#oncallparticipanttype) | A list of nodes. |
|
|
| <a id="oncallparticipanttypeconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `OncallParticipantTypeEdge`
|
|
|
|
The edge type for [`OncallParticipantType`](#oncallparticipanttype).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="oncallparticipanttypeedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="oncallparticipanttypeedgenode"></a>`node` | [`OncallParticipantType`](#oncallparticipanttype) | The item at the end of the edge. |
|
|
|
|
#### `PackageBaseConnection`
|
|
|
|
The connection type for [`PackageBase`](#packagebase).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagebaseconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="packagebaseconnectionedges"></a>`edges` | [`[PackageBaseEdge]`](#packagebaseedge) | A list of edges. |
|
|
| <a id="packagebaseconnectionnodes"></a>`nodes` | [`[PackageBase]`](#packagebase) | A list of nodes. |
|
|
| <a id="packagebaseconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PackageBaseEdge`
|
|
|
|
The edge type for [`PackageBase`](#packagebase).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagebaseedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="packagebaseedgenode"></a>`node` | [`PackageBase`](#packagebase) | The item at the end of the edge. |
|
|
|
|
#### `PackageConnection`
|
|
|
|
The connection type for [`Package`](#package).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packageconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="packageconnectionedges"></a>`edges` | [`[PackageEdge]`](#packageedge) | A list of edges. |
|
|
| <a id="packageconnectionnodes"></a>`nodes` | [`[Package]`](#package) | A list of nodes. |
|
|
| <a id="packageconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PackageDependencyLinkConnection`
|
|
|
|
The connection type for [`PackageDependencyLink`](#packagedependencylink).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagedependencylinkconnectionedges"></a>`edges` | [`[PackageDependencyLinkEdge]`](#packagedependencylinkedge) | A list of edges. |
|
|
| <a id="packagedependencylinkconnectionnodes"></a>`nodes` | [`[PackageDependencyLink]`](#packagedependencylink) | A list of nodes. |
|
|
| <a id="packagedependencylinkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PackageDependencyLinkEdge`
|
|
|
|
The edge type for [`PackageDependencyLink`](#packagedependencylink).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagedependencylinkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="packagedependencylinkedgenode"></a>`node` | [`PackageDependencyLink`](#packagedependencylink) | The item at the end of the edge. |
|
|
|
|
#### `PackageEdge`
|
|
|
|
The edge type for [`Package`](#package).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packageedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="packageedgenode"></a>`node` | [`Package`](#package) | The item at the end of the edge. |
|
|
|
|
#### `PackageFileConnection`
|
|
|
|
The connection type for [`PackageFile`](#packagefile).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagefileconnectionedges"></a>`edges` | [`[PackageFileEdge]`](#packagefileedge) | A list of edges. |
|
|
| <a id="packagefileconnectionnodes"></a>`nodes` | [`[PackageFile]`](#packagefile) | A list of nodes. |
|
|
| <a id="packagefileconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PackageFileEdge`
|
|
|
|
The edge type for [`PackageFile`](#packagefile).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagefileedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="packagefileedgenode"></a>`node` | [`PackageFile`](#packagefile) | The item at the end of the edge. |
|
|
|
|
#### `PackageFileRegistryConnection`
|
|
|
|
The connection type for [`PackageFileRegistry`](#packagefileregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagefileregistryconnectionedges"></a>`edges` | [`[PackageFileRegistryEdge]`](#packagefileregistryedge) | A list of edges. |
|
|
| <a id="packagefileregistryconnectionnodes"></a>`nodes` | [`[PackageFileRegistry]`](#packagefileregistry) | A list of nodes. |
|
|
| <a id="packagefileregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PackageFileRegistryEdge`
|
|
|
|
The edge type for [`PackageFileRegistry`](#packagefileregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagefileregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="packagefileregistryedgenode"></a>`node` | [`PackageFileRegistry`](#packagefileregistry) | The item at the end of the edge. |
|
|
|
|
#### `PackageTagConnection`
|
|
|
|
The connection type for [`PackageTag`](#packagetag).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagetagconnectionedges"></a>`edges` | [`[PackageTagEdge]`](#packagetagedge) | A list of edges. |
|
|
| <a id="packagetagconnectionnodes"></a>`nodes` | [`[PackageTag]`](#packagetag) | A list of nodes. |
|
|
| <a id="packagetagconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PackageTagEdge`
|
|
|
|
The edge type for [`PackageTag`](#packagetag).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagetagedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="packagetagedgenode"></a>`node` | [`PackageTag`](#packagetag) | The item at the end of the edge. |
|
|
|
|
#### `PagesDeploymentRegistryConnection`
|
|
|
|
The connection type for [`PagesDeploymentRegistry`](#pagesdeploymentregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pagesdeploymentregistryconnectionedges"></a>`edges` | [`[PagesDeploymentRegistryEdge]`](#pagesdeploymentregistryedge) | A list of edges. |
|
|
| <a id="pagesdeploymentregistryconnectionnodes"></a>`nodes` | [`[PagesDeploymentRegistry]`](#pagesdeploymentregistry) | A list of nodes. |
|
|
| <a id="pagesdeploymentregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PagesDeploymentRegistryEdge`
|
|
|
|
The edge type for [`PagesDeploymentRegistry`](#pagesdeploymentregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pagesdeploymentregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="pagesdeploymentregistryedgenode"></a>`node` | [`PagesDeploymentRegistry`](#pagesdeploymentregistry) | The item at the end of the edge. |
|
|
|
|
#### `PathLockConnection`
|
|
|
|
The connection type for [`PathLock`](#pathlock).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pathlockconnectionedges"></a>`edges` | [`[PathLockEdge]`](#pathlockedge) | A list of edges. |
|
|
| <a id="pathlockconnectionnodes"></a>`nodes` | [`[PathLock]`](#pathlock) | A list of nodes. |
|
|
| <a id="pathlockconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PathLockEdge`
|
|
|
|
The edge type for [`PathLock`](#pathlock).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pathlockedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="pathlockedgenode"></a>`node` | [`PathLock`](#pathlock) | The item at the end of the edge. |
|
|
|
|
#### `PipelineArtifactRegistryConnection`
|
|
|
|
The connection type for [`PipelineArtifactRegistry`](#pipelineartifactregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelineartifactregistryconnectionedges"></a>`edges` | [`[PipelineArtifactRegistryEdge]`](#pipelineartifactregistryedge) | A list of edges. |
|
|
| <a id="pipelineartifactregistryconnectionnodes"></a>`nodes` | [`[PipelineArtifactRegistry]`](#pipelineartifactregistry) | A list of nodes. |
|
|
| <a id="pipelineartifactregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PipelineArtifactRegistryEdge`
|
|
|
|
The edge type for [`PipelineArtifactRegistry`](#pipelineartifactregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelineartifactregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="pipelineartifactregistryedgenode"></a>`node` | [`PipelineArtifactRegistry`](#pipelineartifactregistry) | The item at the end of the edge. |
|
|
|
|
#### `PipelineConnection`
|
|
|
|
The connection type for [`Pipeline`](#pipeline).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelineconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="pipelineconnectionedges"></a>`edges` | [`[PipelineEdge]`](#pipelineedge) | A list of edges. |
|
|
| <a id="pipelineconnectionnodes"></a>`nodes` | [`[Pipeline]`](#pipeline) | A list of nodes. |
|
|
| <a id="pipelineconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PipelineEdge`
|
|
|
|
The edge type for [`Pipeline`](#pipeline).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelineedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="pipelineedgenode"></a>`node` | [`Pipeline`](#pipeline) | The item at the end of the edge. |
|
|
|
|
#### `PipelineSecurityReportFindingConnection`
|
|
|
|
The connection type for [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinesecurityreportfindingconnectionedges"></a>`edges` | [`[PipelineSecurityReportFindingEdge]`](#pipelinesecurityreportfindingedge) | A list of edges. |
|
|
| <a id="pipelinesecurityreportfindingconnectionnodes"></a>`nodes` | [`[PipelineSecurityReportFinding]`](#pipelinesecurityreportfinding) | A list of nodes. |
|
|
| <a id="pipelinesecurityreportfindingconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `PipelineSecurityReportFindingEdge`
|
|
|
|
The edge type for [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinesecurityreportfindingedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="pipelinesecurityreportfindingedgenode"></a>`node` | [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding) | The item at the end of the edge. |
|
|
|
|
#### `ProjectConnection`
|
|
|
|
The connection type for [`Project`](#project).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="projectconnectionedges"></a>`edges` | [`[ProjectEdge]`](#projectedge) | A list of edges. |
|
|
| <a id="projectconnectionnodes"></a>`nodes` | [`[Project]`](#project) | A list of nodes. |
|
|
| <a id="projectconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ProjectEdge`
|
|
|
|
The edge type for [`Project`](#project).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="projectedgenode"></a>`node` | [`Project`](#project) | The item at the end of the edge. |
|
|
|
|
#### `ProjectMemberConnection`
|
|
|
|
The connection type for [`ProjectMember`](#projectmember).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectmemberconnectionedges"></a>`edges` | [`[ProjectMemberEdge]`](#projectmemberedge) | A list of edges. |
|
|
| <a id="projectmemberconnectionnodes"></a>`nodes` | [`[ProjectMember]`](#projectmember) | A list of nodes. |
|
|
| <a id="projectmemberconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ProjectMemberEdge`
|
|
|
|
The edge type for [`ProjectMember`](#projectmember).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectmemberedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="projectmemberedgenode"></a>`node` | [`ProjectMember`](#projectmember) | The item at the end of the edge. |
|
|
|
|
#### `ReleaseAssetLinkConnection`
|
|
|
|
The connection type for [`ReleaseAssetLink`](#releaseassetlink).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseassetlinkconnectionedges"></a>`edges` | [`[ReleaseAssetLinkEdge]`](#releaseassetlinkedge) | A list of edges. |
|
|
| <a id="releaseassetlinkconnectionnodes"></a>`nodes` | [`[ReleaseAssetLink]`](#releaseassetlink) | A list of nodes. |
|
|
| <a id="releaseassetlinkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ReleaseAssetLinkEdge`
|
|
|
|
The edge type for [`ReleaseAssetLink`](#releaseassetlink).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseassetlinkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="releaseassetlinkedgenode"></a>`node` | [`ReleaseAssetLink`](#releaseassetlink) | The item at the end of the edge. |
|
|
|
|
#### `ReleaseConnection`
|
|
|
|
The connection type for [`Release`](#release).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="releaseconnectionedges"></a>`edges` | [`[ReleaseEdge]`](#releaseedge) | A list of edges. |
|
|
| <a id="releaseconnectionnodes"></a>`nodes` | [`[Release]`](#release) | A list of nodes. |
|
|
| <a id="releaseconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ReleaseEdge`
|
|
|
|
The edge type for [`Release`](#release).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="releaseedgenode"></a>`node` | [`Release`](#release) | The item at the end of the edge. |
|
|
|
|
#### `ReleaseEvidenceConnection`
|
|
|
|
The connection type for [`ReleaseEvidence`](#releaseevidence).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseevidenceconnectionedges"></a>`edges` | [`[ReleaseEvidenceEdge]`](#releaseevidenceedge) | A list of edges. |
|
|
| <a id="releaseevidenceconnectionnodes"></a>`nodes` | [`[ReleaseEvidence]`](#releaseevidence) | A list of nodes. |
|
|
| <a id="releaseevidenceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ReleaseEvidenceEdge`
|
|
|
|
The edge type for [`ReleaseEvidence`](#releaseevidence).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseevidenceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="releaseevidenceedgenode"></a>`node` | [`ReleaseEvidence`](#releaseevidence) | The item at the end of the edge. |
|
|
|
|
#### `ReleaseSourceConnection`
|
|
|
|
The connection type for [`ReleaseSource`](#releasesource).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releasesourceconnectionedges"></a>`edges` | [`[ReleaseSourceEdge]`](#releasesourceedge) | A list of edges. |
|
|
| <a id="releasesourceconnectionnodes"></a>`nodes` | [`[ReleaseSource]`](#releasesource) | A list of nodes. |
|
|
| <a id="releasesourceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ReleaseSourceEdge`
|
|
|
|
The edge type for [`ReleaseSource`](#releasesource).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releasesourceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="releasesourceedgenode"></a>`node` | [`ReleaseSource`](#releasesource) | The item at the end of the edge. |
|
|
|
|
#### `RepositoryBlobConnection`
|
|
|
|
The connection type for [`RepositoryBlob`](#repositoryblob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="repositoryblobconnectionedges"></a>`edges` | [`[RepositoryBlobEdge]`](#repositoryblobedge) | A list of edges. |
|
|
| <a id="repositoryblobconnectionnodes"></a>`nodes` | [`[RepositoryBlob]`](#repositoryblob) | A list of nodes. |
|
|
| <a id="repositoryblobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `RepositoryBlobEdge`
|
|
|
|
The edge type for [`RepositoryBlob`](#repositoryblob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="repositoryblobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="repositoryblobedgenode"></a>`node` | [`RepositoryBlob`](#repositoryblob) | The item at the end of the edge. |
|
|
|
|
#### `RequirementConnection`
|
|
|
|
The connection type for [`Requirement`](#requirement).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="requirementconnectionedges"></a>`edges` | [`[RequirementEdge]`](#requirementedge) | A list of edges. |
|
|
| <a id="requirementconnectionnodes"></a>`nodes` | [`[Requirement]`](#requirement) | A list of nodes. |
|
|
| <a id="requirementconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `RequirementEdge`
|
|
|
|
The edge type for [`Requirement`](#requirement).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="requirementedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="requirementedgenode"></a>`node` | [`Requirement`](#requirement) | The item at the end of the edge. |
|
|
|
|
#### `RunnerArchitectureConnection`
|
|
|
|
The connection type for [`RunnerArchitecture`](#runnerarchitecture).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="runnerarchitectureconnectionedges"></a>`edges` | [`[RunnerArchitectureEdge]`](#runnerarchitectureedge) | A list of edges. |
|
|
| <a id="runnerarchitectureconnectionnodes"></a>`nodes` | [`[RunnerArchitecture]`](#runnerarchitecture) | A list of nodes. |
|
|
| <a id="runnerarchitectureconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `RunnerArchitectureEdge`
|
|
|
|
The edge type for [`RunnerArchitecture`](#runnerarchitecture).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="runnerarchitectureedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="runnerarchitectureedgenode"></a>`node` | [`RunnerArchitecture`](#runnerarchitecture) | The item at the end of the edge. |
|
|
|
|
#### `RunnerPlatformConnection`
|
|
|
|
The connection type for [`RunnerPlatform`](#runnerplatform).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="runnerplatformconnectionedges"></a>`edges` | [`[RunnerPlatformEdge]`](#runnerplatformedge) | A list of edges. |
|
|
| <a id="runnerplatformconnectionnodes"></a>`nodes` | [`[RunnerPlatform]`](#runnerplatform) | A list of nodes. |
|
|
| <a id="runnerplatformconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `RunnerPlatformEdge`
|
|
|
|
The edge type for [`RunnerPlatform`](#runnerplatform).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="runnerplatformedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="runnerplatformedgenode"></a>`node` | [`RunnerPlatform`](#runnerplatform) | The item at the end of the edge. |
|
|
|
|
#### `SastCiConfigurationAnalyzersEntityConnection`
|
|
|
|
The connection type for [`SastCiConfigurationAnalyzersEntity`](#sastciconfigurationanalyzersentity).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationanalyzersentityconnectionedges"></a>`edges` | [`[SastCiConfigurationAnalyzersEntityEdge]`](#sastciconfigurationanalyzersentityedge) | A list of edges. |
|
|
| <a id="sastciconfigurationanalyzersentityconnectionnodes"></a>`nodes` | [`[SastCiConfigurationAnalyzersEntity]`](#sastciconfigurationanalyzersentity) | A list of nodes. |
|
|
| <a id="sastciconfigurationanalyzersentityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SastCiConfigurationAnalyzersEntityEdge`
|
|
|
|
The edge type for [`SastCiConfigurationAnalyzersEntity`](#sastciconfigurationanalyzersentity).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationanalyzersentityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="sastciconfigurationanalyzersentityedgenode"></a>`node` | [`SastCiConfigurationAnalyzersEntity`](#sastciconfigurationanalyzersentity) | The item at the end of the edge. |
|
|
|
|
#### `SastCiConfigurationEntityConnection`
|
|
|
|
The connection type for [`SastCiConfigurationEntity`](#sastciconfigurationentity).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationentityconnectionedges"></a>`edges` | [`[SastCiConfigurationEntityEdge]`](#sastciconfigurationentityedge) | A list of edges. |
|
|
| <a id="sastciconfigurationentityconnectionnodes"></a>`nodes` | [`[SastCiConfigurationEntity]`](#sastciconfigurationentity) | A list of nodes. |
|
|
| <a id="sastciconfigurationentityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SastCiConfigurationEntityEdge`
|
|
|
|
The edge type for [`SastCiConfigurationEntity`](#sastciconfigurationentity).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationentityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="sastciconfigurationentityedgenode"></a>`node` | [`SastCiConfigurationEntity`](#sastciconfigurationentity) | The item at the end of the edge. |
|
|
|
|
#### `SastCiConfigurationOptionsEntityConnection`
|
|
|
|
The connection type for [`SastCiConfigurationOptionsEntity`](#sastciconfigurationoptionsentity).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationoptionsentityconnectionedges"></a>`edges` | [`[SastCiConfigurationOptionsEntityEdge]`](#sastciconfigurationoptionsentityedge) | A list of edges. |
|
|
| <a id="sastciconfigurationoptionsentityconnectionnodes"></a>`nodes` | [`[SastCiConfigurationOptionsEntity]`](#sastciconfigurationoptionsentity) | A list of nodes. |
|
|
| <a id="sastciconfigurationoptionsentityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SastCiConfigurationOptionsEntityEdge`
|
|
|
|
The edge type for [`SastCiConfigurationOptionsEntity`](#sastciconfigurationoptionsentity).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationoptionsentityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="sastciconfigurationoptionsentityedgenode"></a>`node` | [`SastCiConfigurationOptionsEntity`](#sastciconfigurationoptionsentity) | The item at the end of the edge. |
|
|
|
|
#### `SavedReplyConnection`
|
|
|
|
The connection type for [`SavedReply`](#savedreply).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="savedreplyconnectionedges"></a>`edges` | [`[SavedReplyEdge]`](#savedreplyedge) | A list of edges. |
|
|
| <a id="savedreplyconnectionnodes"></a>`nodes` | [`[SavedReply]`](#savedreply) | A list of nodes. |
|
|
| <a id="savedreplyconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SavedReplyEdge`
|
|
|
|
The edge type for [`SavedReply`](#savedreply).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="savedreplyedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="savedreplyedgenode"></a>`node` | [`SavedReply`](#savedreply) | The item at the end of the edge. |
|
|
|
|
#### `ScanConnection`
|
|
|
|
The connection type for [`Scan`](#scan).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanconnectionedges"></a>`edges` | [`[ScanEdge]`](#scanedge) | A list of edges. |
|
|
| <a id="scanconnectionnodes"></a>`nodes` | [`[Scan]`](#scan) | A list of nodes. |
|
|
| <a id="scanconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ScanEdge`
|
|
|
|
The edge type for [`Scan`](#scan).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="scanedgenode"></a>`node` | [`Scan`](#scan) | The item at the end of the edge. |
|
|
|
|
#### `ScanExecutionPolicyConnection`
|
|
|
|
The connection type for [`ScanExecutionPolicy`](#scanexecutionpolicy).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanexecutionpolicyconnectionedges"></a>`edges` | [`[ScanExecutionPolicyEdge]`](#scanexecutionpolicyedge) | A list of edges. |
|
|
| <a id="scanexecutionpolicyconnectionnodes"></a>`nodes` | [`[ScanExecutionPolicy]`](#scanexecutionpolicy) | A list of nodes. |
|
|
| <a id="scanexecutionpolicyconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ScanExecutionPolicyEdge`
|
|
|
|
The edge type for [`ScanExecutionPolicy`](#scanexecutionpolicy).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanexecutionpolicyedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="scanexecutionpolicyedgenode"></a>`node` | [`ScanExecutionPolicy`](#scanexecutionpolicy) | The item at the end of the edge. |
|
|
|
|
#### `ScanResultPolicyConnection`
|
|
|
|
The connection type for [`ScanResultPolicy`](#scanresultpolicy).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanresultpolicyconnectionedges"></a>`edges` | [`[ScanResultPolicyEdge]`](#scanresultpolicyedge) | A list of edges. |
|
|
| <a id="scanresultpolicyconnectionnodes"></a>`nodes` | [`[ScanResultPolicy]`](#scanresultpolicy) | A list of nodes. |
|
|
| <a id="scanresultpolicyconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ScanResultPolicyEdge`
|
|
|
|
The edge type for [`ScanResultPolicy`](#scanresultpolicy).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanresultpolicyedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="scanresultpolicyedgenode"></a>`node` | [`ScanResultPolicy`](#scanresultpolicy) | The item at the end of the edge. |
|
|
|
|
#### `ScannedResourceConnection`
|
|
|
|
The connection type for [`ScannedResource`](#scannedresource).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scannedresourceconnectionedges"></a>`edges` | [`[ScannedResourceEdge]`](#scannedresourceedge) | A list of edges. |
|
|
| <a id="scannedresourceconnectionnodes"></a>`nodes` | [`[ScannedResource]`](#scannedresource) | A list of nodes. |
|
|
| <a id="scannedresourceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ScannedResourceEdge`
|
|
|
|
The edge type for [`ScannedResource`](#scannedresource).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scannedresourceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="scannedresourceedgenode"></a>`node` | [`ScannedResource`](#scannedresource) | The item at the end of the edge. |
|
|
|
|
#### `SentryErrorConnection`
|
|
|
|
The connection type for [`SentryError`](#sentryerror).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorconnectionedges"></a>`edges` | [`[SentryErrorEdge]`](#sentryerroredge) | A list of edges. |
|
|
| <a id="sentryerrorconnectionnodes"></a>`nodes` | [`[SentryError]`](#sentryerror) | A list of nodes. |
|
|
| <a id="sentryerrorconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SentryErrorEdge`
|
|
|
|
The edge type for [`SentryError`](#sentryerror).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerroredgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="sentryerroredgenode"></a>`node` | [`SentryError`](#sentryerror) | The item at the end of the edge. |
|
|
|
|
#### `ServiceConnection`
|
|
|
|
The connection type for [`Service`](#service).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="serviceconnectionedges"></a>`edges` | [`[ServiceEdge]`](#serviceedge) | A list of edges. |
|
|
| <a id="serviceconnectionnodes"></a>`nodes` | [`[Service]`](#service) | A list of nodes. |
|
|
| <a id="serviceconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `ServiceEdge`
|
|
|
|
The edge type for [`Service`](#service).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="serviceedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="serviceedgenode"></a>`node` | [`Service`](#service) | The item at the end of the edge. |
|
|
|
|
#### `SnippetBlobConnection`
|
|
|
|
The connection type for [`SnippetBlob`](#snippetblob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetblobconnectionedges"></a>`edges` | [`[SnippetBlobEdge]`](#snippetblobedge) | A list of edges. |
|
|
| <a id="snippetblobconnectionhasunretrievableblobs"></a>`hasUnretrievableBlobs` | [`Boolean!`](#boolean) | Indicates if the snippet has unretrievable blobs. |
|
|
| <a id="snippetblobconnectionnodes"></a>`nodes` | [`[SnippetBlob]`](#snippetblob) | A list of nodes. |
|
|
| <a id="snippetblobconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SnippetBlobEdge`
|
|
|
|
The edge type for [`SnippetBlob`](#snippetblob).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetblobedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="snippetblobedgenode"></a>`node` | [`SnippetBlob`](#snippetblob) | The item at the end of the edge. |
|
|
|
|
#### `SnippetConnection`
|
|
|
|
The connection type for [`Snippet`](#snippet).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetconnectionedges"></a>`edges` | [`[SnippetEdge]`](#snippetedge) | A list of edges. |
|
|
| <a id="snippetconnectionnodes"></a>`nodes` | [`[Snippet]`](#snippet) | A list of nodes. |
|
|
| <a id="snippetconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SnippetEdge`
|
|
|
|
The edge type for [`Snippet`](#snippet).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="snippetedgenode"></a>`node` | [`Snippet`](#snippet) | The item at the end of the edge. |
|
|
|
|
#### `SnippetRepositoryRegistryConnection`
|
|
|
|
The connection type for [`SnippetRepositoryRegistry`](#snippetrepositoryregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetrepositoryregistryconnectionedges"></a>`edges` | [`[SnippetRepositoryRegistryEdge]`](#snippetrepositoryregistryedge) | A list of edges. |
|
|
| <a id="snippetrepositoryregistryconnectionnodes"></a>`nodes` | [`[SnippetRepositoryRegistry]`](#snippetrepositoryregistry) | A list of nodes. |
|
|
| <a id="snippetrepositoryregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SnippetRepositoryRegistryEdge`
|
|
|
|
The edge type for [`SnippetRepositoryRegistry`](#snippetrepositoryregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetrepositoryregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="snippetrepositoryregistryedgenode"></a>`node` | [`SnippetRepositoryRegistry`](#snippetrepositoryregistry) | The item at the end of the edge. |
|
|
|
|
#### `SubmoduleConnection`
|
|
|
|
The connection type for [`Submodule`](#submodule).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="submoduleconnectionedges"></a>`edges` | [`[SubmoduleEdge]`](#submoduleedge) | A list of edges. |
|
|
| <a id="submoduleconnectionnodes"></a>`nodes` | [`[Submodule]`](#submodule) | A list of nodes. |
|
|
| <a id="submoduleconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SubmoduleEdge`
|
|
|
|
The edge type for [`Submodule`](#submodule).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="submoduleedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="submoduleedgenode"></a>`node` | [`Submodule`](#submodule) | The item at the end of the edge. |
|
|
|
|
#### `SubscriptionFutureEntryConnection`
|
|
|
|
The connection type for [`SubscriptionFutureEntry`](#subscriptionfutureentry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="subscriptionfutureentryconnectionedges"></a>`edges` | [`[SubscriptionFutureEntryEdge]`](#subscriptionfutureentryedge) | A list of edges. |
|
|
| <a id="subscriptionfutureentryconnectionnodes"></a>`nodes` | [`[SubscriptionFutureEntry]`](#subscriptionfutureentry) | A list of nodes. |
|
|
| <a id="subscriptionfutureentryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `SubscriptionFutureEntryEdge`
|
|
|
|
The edge type for [`SubscriptionFutureEntry`](#subscriptionfutureentry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="subscriptionfutureentryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="subscriptionfutureentryedgenode"></a>`node` | [`SubscriptionFutureEntry`](#subscriptionfutureentry) | The item at the end of the edge. |
|
|
|
|
#### `TerraformStateConnection`
|
|
|
|
The connection type for [`TerraformState`](#terraformstate).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="terraformstateconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="terraformstateconnectionedges"></a>`edges` | [`[TerraformStateEdge]`](#terraformstateedge) | A list of edges. |
|
|
| <a id="terraformstateconnectionnodes"></a>`nodes` | [`[TerraformState]`](#terraformstate) | A list of nodes. |
|
|
| <a id="terraformstateconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TerraformStateEdge`
|
|
|
|
The edge type for [`TerraformState`](#terraformstate).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="terraformstateedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="terraformstateedgenode"></a>`node` | [`TerraformState`](#terraformstate) | The item at the end of the edge. |
|
|
|
|
#### `TerraformStateVersionRegistryConnection`
|
|
|
|
The connection type for [`TerraformStateVersionRegistry`](#terraformstateversionregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="terraformstateversionregistryconnectionedges"></a>`edges` | [`[TerraformStateVersionRegistryEdge]`](#terraformstateversionregistryedge) | A list of edges. |
|
|
| <a id="terraformstateversionregistryconnectionnodes"></a>`nodes` | [`[TerraformStateVersionRegistry]`](#terraformstateversionregistry) | A list of nodes. |
|
|
| <a id="terraformstateversionregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TerraformStateVersionRegistryEdge`
|
|
|
|
The edge type for [`TerraformStateVersionRegistry`](#terraformstateversionregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="terraformstateversionregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="terraformstateversionregistryedgenode"></a>`node` | [`TerraformStateVersionRegistry`](#terraformstateversionregistry) | The item at the end of the edge. |
|
|
|
|
#### `TestCaseConnection`
|
|
|
|
The connection type for [`TestCase`](#testcase).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testcaseconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="testcaseconnectionedges"></a>`edges` | [`[TestCaseEdge]`](#testcaseedge) | A list of edges. |
|
|
| <a id="testcaseconnectionnodes"></a>`nodes` | [`[TestCase]`](#testcase) | A list of nodes. |
|
|
| <a id="testcaseconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TestCaseEdge`
|
|
|
|
The edge type for [`TestCase`](#testcase).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testcaseedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="testcaseedgenode"></a>`node` | [`TestCase`](#testcase) | The item at the end of the edge. |
|
|
|
|
#### `TestReportConnection`
|
|
|
|
The connection type for [`TestReport`](#testreport).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testreportconnectionedges"></a>`edges` | [`[TestReportEdge]`](#testreportedge) | A list of edges. |
|
|
| <a id="testreportconnectionnodes"></a>`nodes` | [`[TestReport]`](#testreport) | A list of nodes. |
|
|
| <a id="testreportconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TestReportEdge`
|
|
|
|
The edge type for [`TestReport`](#testreport).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testreportedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="testreportedgenode"></a>`node` | [`TestReport`](#testreport) | The item at the end of the edge. |
|
|
|
|
#### `TestSuiteSummaryConnection`
|
|
|
|
The connection type for [`TestSuiteSummary`](#testsuitesummary).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testsuitesummaryconnectioncount"></a>`count` | [`Int!`](#int) | Total count of collection. |
|
|
| <a id="testsuitesummaryconnectionedges"></a>`edges` | [`[TestSuiteSummaryEdge]`](#testsuitesummaryedge) | A list of edges. |
|
|
| <a id="testsuitesummaryconnectionnodes"></a>`nodes` | [`[TestSuiteSummary]`](#testsuitesummary) | A list of nodes. |
|
|
| <a id="testsuitesummaryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TestSuiteSummaryEdge`
|
|
|
|
The edge type for [`TestSuiteSummary`](#testsuitesummary).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testsuitesummaryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="testsuitesummaryedgenode"></a>`node` | [`TestSuiteSummary`](#testsuitesummary) | The item at the end of the edge. |
|
|
|
|
#### `TimelineEventTypeConnection`
|
|
|
|
The connection type for [`TimelineEventType`](#timelineeventtype).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timelineeventtypeconnectionedges"></a>`edges` | [`[TimelineEventTypeEdge]`](#timelineeventtypeedge) | A list of edges. |
|
|
| <a id="timelineeventtypeconnectionnodes"></a>`nodes` | [`[TimelineEventType]`](#timelineeventtype) | A list of nodes. |
|
|
| <a id="timelineeventtypeconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TimelineEventTypeEdge`
|
|
|
|
The edge type for [`TimelineEventType`](#timelineeventtype).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timelineeventtypeedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="timelineeventtypeedgenode"></a>`node` | [`TimelineEventType`](#timelineeventtype) | The item at the end of the edge. |
|
|
|
|
#### `TimelogConnection`
|
|
|
|
The connection type for [`Timelog`](#timelog).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timelogconnectionedges"></a>`edges` | [`[TimelogEdge]`](#timelogedge) | A list of edges. |
|
|
| <a id="timelogconnectionnodes"></a>`nodes` | [`[Timelog]`](#timelog) | A list of nodes. |
|
|
| <a id="timelogconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TimelogEdge`
|
|
|
|
The edge type for [`Timelog`](#timelog).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timelogedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="timelogedgenode"></a>`node` | [`Timelog`](#timelog) | The item at the end of the edge. |
|
|
|
|
#### `TodoConnection`
|
|
|
|
The connection type for [`Todo`](#todo).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="todoconnectionedges"></a>`edges` | [`[TodoEdge]`](#todoedge) | A list of edges. |
|
|
| <a id="todoconnectionnodes"></a>`nodes` | [`[Todo]`](#todo) | A list of nodes. |
|
|
| <a id="todoconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TodoEdge`
|
|
|
|
The edge type for [`Todo`](#todo).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="todoedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="todoedgenode"></a>`node` | [`Todo`](#todo) | The item at the end of the edge. |
|
|
|
|
#### `TopicConnection`
|
|
|
|
The connection type for [`Topic`](#topic).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="topicconnectionedges"></a>`edges` | [`[TopicEdge]`](#topicedge) | A list of edges. |
|
|
| <a id="topicconnectionnodes"></a>`nodes` | [`[Topic]`](#topic) | A list of nodes. |
|
|
| <a id="topicconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TopicEdge`
|
|
|
|
The edge type for [`Topic`](#topic).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="topicedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="topicedgenode"></a>`node` | [`Topic`](#topic) | The item at the end of the edge. |
|
|
|
|
#### `TreeConnection`
|
|
|
|
The connection type for [`Tree`](#tree).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="treeconnectionedges"></a>`edges` | [`[TreeEdge]`](#treeedge) | A list of edges. |
|
|
| <a id="treeconnectionnodes"></a>`nodes` | [`[Tree]`](#tree) | A list of nodes. |
|
|
| <a id="treeconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TreeEdge`
|
|
|
|
The edge type for [`Tree`](#tree).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="treeedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="treeedgenode"></a>`node` | [`Tree`](#tree) | The item at the end of the edge. |
|
|
|
|
#### `TreeEntryConnection`
|
|
|
|
The connection type for [`TreeEntry`](#treeentry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="treeentryconnectionedges"></a>`edges` | [`[TreeEntryEdge]`](#treeentryedge) | A list of edges. |
|
|
| <a id="treeentryconnectionnodes"></a>`nodes` | [`[TreeEntry]`](#treeentry) | A list of nodes. |
|
|
| <a id="treeentryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `TreeEntryEdge`
|
|
|
|
The edge type for [`TreeEntry`](#treeentry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="treeentryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="treeentryedgenode"></a>`node` | [`TreeEntry`](#treeentry) | The item at the end of the edge. |
|
|
|
|
#### `UploadRegistryConnection`
|
|
|
|
The connection type for [`UploadRegistry`](#uploadregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="uploadregistryconnectionedges"></a>`edges` | [`[UploadRegistryEdge]`](#uploadregistryedge) | A list of edges. |
|
|
| <a id="uploadregistryconnectionnodes"></a>`nodes` | [`[UploadRegistry]`](#uploadregistry) | A list of nodes. |
|
|
| <a id="uploadregistryconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `UploadRegistryEdge`
|
|
|
|
The edge type for [`UploadRegistry`](#uploadregistry).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="uploadregistryedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="uploadregistryedgenode"></a>`node` | [`UploadRegistry`](#uploadregistry) | The item at the end of the edge. |
|
|
|
|
#### `UsageTrendsMeasurementConnection`
|
|
|
|
The connection type for [`UsageTrendsMeasurement`](#usagetrendsmeasurement).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usagetrendsmeasurementconnectionedges"></a>`edges` | [`[UsageTrendsMeasurementEdge]`](#usagetrendsmeasurementedge) | A list of edges. |
|
|
| <a id="usagetrendsmeasurementconnectionnodes"></a>`nodes` | [`[UsageTrendsMeasurement]`](#usagetrendsmeasurement) | A list of nodes. |
|
|
| <a id="usagetrendsmeasurementconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `UsageTrendsMeasurementEdge`
|
|
|
|
The edge type for [`UsageTrendsMeasurement`](#usagetrendsmeasurement).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usagetrendsmeasurementedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="usagetrendsmeasurementedgenode"></a>`node` | [`UsageTrendsMeasurement`](#usagetrendsmeasurement) | The item at the end of the edge. |
|
|
|
|
#### `UserCalloutConnection`
|
|
|
|
The connection type for [`UserCallout`](#usercallout).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercalloutconnectionedges"></a>`edges` | [`[UserCalloutEdge]`](#usercalloutedge) | A list of edges. |
|
|
| <a id="usercalloutconnectionnodes"></a>`nodes` | [`[UserCallout]`](#usercallout) | A list of nodes. |
|
|
| <a id="usercalloutconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `UserCalloutEdge`
|
|
|
|
The edge type for [`UserCallout`](#usercallout).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercalloutedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="usercalloutedgenode"></a>`node` | [`UserCallout`](#usercallout) | The item at the end of the edge. |
|
|
|
|
#### `UserCoreConnection`
|
|
|
|
The connection type for [`UserCore`](#usercore).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoreconnectionedges"></a>`edges` | [`[UserCoreEdge]`](#usercoreedge) | A list of edges. |
|
|
| <a id="usercoreconnectionnodes"></a>`nodes` | [`[UserCore]`](#usercore) | A list of nodes. |
|
|
| <a id="usercoreconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `UserCoreEdge`
|
|
|
|
The edge type for [`UserCore`](#usercore).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoreedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="usercoreedgenode"></a>`node` | [`UserCore`](#usercore) | The item at the end of the edge. |
|
|
|
|
#### `VulnerabilitiesCountByDayConnection`
|
|
|
|
The connection type for [`VulnerabilitiesCountByDay`](#vulnerabilitiescountbyday).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitiescountbydayconnectionedges"></a>`edges` | [`[VulnerabilitiesCountByDayEdge]`](#vulnerabilitiescountbydayedge) | A list of edges. |
|
|
| <a id="vulnerabilitiescountbydayconnectionnodes"></a>`nodes` | [`[VulnerabilitiesCountByDay]`](#vulnerabilitiescountbyday) | A list of nodes. |
|
|
| <a id="vulnerabilitiescountbydayconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `VulnerabilitiesCountByDayEdge`
|
|
|
|
The edge type for [`VulnerabilitiesCountByDay`](#vulnerabilitiescountbyday).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitiescountbydayedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="vulnerabilitiescountbydayedgenode"></a>`node` | [`VulnerabilitiesCountByDay`](#vulnerabilitiescountbyday) | The item at the end of the edge. |
|
|
|
|
#### `VulnerabilityConnection`
|
|
|
|
The connection type for [`Vulnerability`](#vulnerability).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityconnectionedges"></a>`edges` | [`[VulnerabilityEdge]`](#vulnerabilityedge) | A list of edges. |
|
|
| <a id="vulnerabilityconnectionnodes"></a>`nodes` | [`[Vulnerability]`](#vulnerability) | A list of nodes. |
|
|
| <a id="vulnerabilityconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `VulnerabilityEdge`
|
|
|
|
The edge type for [`Vulnerability`](#vulnerability).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="vulnerabilityedgenode"></a>`node` | [`Vulnerability`](#vulnerability) | The item at the end of the edge. |
|
|
|
|
#### `VulnerabilityExternalIssueLinkConnection`
|
|
|
|
The connection type for [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityexternalissuelinkconnectionedges"></a>`edges` | [`[VulnerabilityExternalIssueLinkEdge]`](#vulnerabilityexternalissuelinkedge) | A list of edges. |
|
|
| <a id="vulnerabilityexternalissuelinkconnectionnodes"></a>`nodes` | [`[VulnerabilityExternalIssueLink]`](#vulnerabilityexternalissuelink) | A list of nodes. |
|
|
| <a id="vulnerabilityexternalissuelinkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `VulnerabilityExternalIssueLinkEdge`
|
|
|
|
The edge type for [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityexternalissuelinkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="vulnerabilityexternalissuelinkedgenode"></a>`node` | [`VulnerabilityExternalIssueLink`](#vulnerabilityexternalissuelink) | The item at the end of the edge. |
|
|
|
|
#### `VulnerabilityIssueLinkConnection`
|
|
|
|
The connection type for [`VulnerabilityIssueLink`](#vulnerabilityissuelink).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityissuelinkconnectionedges"></a>`edges` | [`[VulnerabilityIssueLinkEdge]`](#vulnerabilityissuelinkedge) | A list of edges. |
|
|
| <a id="vulnerabilityissuelinkconnectionnodes"></a>`nodes` | [`[VulnerabilityIssueLink]`](#vulnerabilityissuelink) | A list of nodes. |
|
|
| <a id="vulnerabilityissuelinkconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `VulnerabilityIssueLinkEdge`
|
|
|
|
The edge type for [`VulnerabilityIssueLink`](#vulnerabilityissuelink).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityissuelinkedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="vulnerabilityissuelinkedgenode"></a>`node` | [`VulnerabilityIssueLink`](#vulnerabilityissuelink) | The item at the end of the edge. |
|
|
|
|
#### `VulnerabilityScannerConnection`
|
|
|
|
The connection type for [`VulnerabilityScanner`](#vulnerabilityscanner).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityscannerconnectionedges"></a>`edges` | [`[VulnerabilityScannerEdge]`](#vulnerabilityscanneredge) | A list of edges. |
|
|
| <a id="vulnerabilityscannerconnectionnodes"></a>`nodes` | [`[VulnerabilityScanner]`](#vulnerabilityscanner) | A list of nodes. |
|
|
| <a id="vulnerabilityscannerconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `VulnerabilityScannerEdge`
|
|
|
|
The edge type for [`VulnerabilityScanner`](#vulnerabilityscanner).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityscanneredgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="vulnerabilityscanneredgenode"></a>`node` | [`VulnerabilityScanner`](#vulnerabilityscanner) | The item at the end of the edge. |
|
|
|
|
#### `WorkItemConnection`
|
|
|
|
The connection type for [`WorkItem`](#workitem).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemconnectionedges"></a>`edges` | [`[WorkItemEdge]`](#workitemedge) | A list of edges. |
|
|
| <a id="workitemconnectionnodes"></a>`nodes` | [`[WorkItem]`](#workitem) | A list of nodes. |
|
|
| <a id="workitemconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `WorkItemEdge`
|
|
|
|
The edge type for [`WorkItem`](#workitem).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="workitemedgenode"></a>`node` | [`WorkItem`](#workitem) | The item at the end of the edge. |
|
|
|
|
#### `WorkItemTypeConnection`
|
|
|
|
The connection type for [`WorkItemType`](#workitemtype).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemtypeconnectionedges"></a>`edges` | [`[WorkItemTypeEdge]`](#workitemtypeedge) | A list of edges. |
|
|
| <a id="workitemtypeconnectionnodes"></a>`nodes` | [`[WorkItemType]`](#workitemtype) | A list of nodes. |
|
|
| <a id="workitemtypeconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. |
|
|
|
|
#### `WorkItemTypeEdge`
|
|
|
|
The edge type for [`WorkItemType`](#workitemtype).
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemtypeedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. |
|
|
| <a id="workitemtypeedgenode"></a>`node` | [`WorkItemType`](#workitemtype) | The item at the end of the edge. |
|
|
|
|
## Object types
|
|
|
|
Object types represent the resources that the GitLab GraphQL API can return.
|
|
They contain _fields_. Each field has its own type, which will either be one of the
|
|
basic GraphQL [scalar types](https://graphql.org/learn/schema/#scalar-types)
|
|
(e.g.: `String` or `Boolean`) or other object types. Fields may have arguments.
|
|
Fields with arguments are exactly like top-level queries, and are listed beneath
|
|
the table of fields for each object type.
|
|
|
|
For more information, see
|
|
[Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields)
|
|
on `graphql.org`.
|
|
|
|
### `AccessLevel`
|
|
|
|
Represents the access level of a relationship between a User and object that it is related to.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="accesslevelintegervalue"></a>`integerValue` | [`Int`](#int) | Integer representation of access level. |
|
|
| <a id="accesslevelstringvalue"></a>`stringValue` | [`AccessLevelEnum`](#accesslevelenum) | String representation of access level. |
|
|
|
|
### `AgentConfiguration`
|
|
|
|
Configuration details for an Agent.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="agentconfigurationagentname"></a>`agentName` | [`String`](#string) | Name of the agent. |
|
|
|
|
### `AgentMetadata`
|
|
|
|
Information about a connected Agent.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="agentmetadatacommit"></a>`commit` | [`String`](#string) | Agent version commit. |
|
|
| <a id="agentmetadatapodname"></a>`podName` | [`String`](#string) | Name of the pod running the Agent. |
|
|
| <a id="agentmetadatapodnamespace"></a>`podNamespace` | [`String`](#string) | Namespace of the pod running the Agent. |
|
|
| <a id="agentmetadataversion"></a>`version` | [`String`](#string) | Agent version tag. |
|
|
|
|
### `AlertManagementAlert`
|
|
|
|
Describes an alert from the project's Alert Management.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementalertassignees"></a>`assignees` | [`UserCoreConnection`](#usercoreconnection) | Assignees of the alert. (see [Connections](#connections)) |
|
|
| <a id="alertmanagementalertcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp the alert was created. |
|
|
| <a id="alertmanagementalertdescription"></a>`description` | [`String`](#string) | Description of the alert. |
|
|
| <a id="alertmanagementalertdetails"></a>`details` | [`JSON`](#json) | Alert details. |
|
|
| <a id="alertmanagementalertdetailsurl"></a>`detailsUrl` | [`String!`](#string) | URL of the alert detail page. |
|
|
| <a id="alertmanagementalertdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="alertmanagementalertendedat"></a>`endedAt` | [`Time`](#time) | Timestamp the alert ended. |
|
|
| <a id="alertmanagementalertenvironment"></a>`environment` | [`Environment`](#environment) | Environment for the alert. |
|
|
| <a id="alertmanagementalerteventcount"></a>`eventCount` | [`Int`](#int) | Number of events of this alert. |
|
|
| <a id="alertmanagementalerthosts"></a>`hosts` | [`[String!]`](#string) | List of hosts the alert came from. |
|
|
| <a id="alertmanagementalertiid"></a>`iid` | [`ID!`](#id) | Internal ID of the alert. |
|
|
| <a id="alertmanagementalertissue"></a>`issue` | [`Issue`](#issue) | Issue attached to the alert. |
|
|
| <a id="alertmanagementalertissueiid"></a>`issueIid` **{warning-solid}** | [`ID`](#id) | **Deprecated** in 13.10. Use issue field. |
|
|
| <a id="alertmanagementalertmetricsdashboardurl"></a>`metricsDashboardUrl` | [`String`](#string) | URL for metrics embed for the alert. |
|
|
| <a id="alertmanagementalertmonitoringtool"></a>`monitoringTool` | [`String`](#string) | Monitoring tool the alert came from. |
|
|
| <a id="alertmanagementalertnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="alertmanagementalertprometheusalert"></a>`prometheusAlert` | [`PrometheusAlert`](#prometheusalert) | Alert condition for Prometheus. |
|
|
| <a id="alertmanagementalertrunbook"></a>`runbook` | [`String`](#string) | Runbook for the alert as defined in alert details. |
|
|
| <a id="alertmanagementalertservice"></a>`service` | [`String`](#string) | Service the alert came from. |
|
|
| <a id="alertmanagementalertseverity"></a>`severity` | [`AlertManagementSeverity`](#alertmanagementseverity) | Severity of the alert. |
|
|
| <a id="alertmanagementalertstartedat"></a>`startedAt` | [`Time`](#time) | Timestamp the alert was raised. |
|
|
| <a id="alertmanagementalertstatus"></a>`status` | [`AlertManagementStatus`](#alertmanagementstatus) | Status of the alert. |
|
|
| <a id="alertmanagementalerttitle"></a>`title` | [`String`](#string) | Title of the alert. |
|
|
| <a id="alertmanagementalertupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp the alert was last updated. |
|
|
| <a id="alertmanagementalertweburl"></a>`webUrl` | [`String!`](#string) | URL of the alert. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `AlertManagementAlert.todos`
|
|
|
|
To-do items of the current user for the alert.
|
|
|
|
Returns [`TodoConnection`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementalerttodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | Action to be filtered. |
|
|
| <a id="alertmanagementalerttodosauthorid"></a>`authorId` | [`[ID!]`](#id) | ID of an author. |
|
|
| <a id="alertmanagementalerttodosgroupid"></a>`groupId` | [`[ID!]`](#id) | ID of a group. |
|
|
| <a id="alertmanagementalerttodosprojectid"></a>`projectId` | [`[ID!]`](#id) | ID of a project. |
|
|
| <a id="alertmanagementalerttodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | State of the todo. |
|
|
| <a id="alertmanagementalerttodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | Type of the todo. |
|
|
|
|
### `AlertManagementAlertStatusCountsType`
|
|
|
|
Represents total number of alerts for the represented categories.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementalertstatuscountstypeacknowledged"></a>`acknowledged` | [`Int`](#int) | Number of alerts with status ACKNOWLEDGED for the project. |
|
|
| <a id="alertmanagementalertstatuscountstypeall"></a>`all` | [`Int`](#int) | Total number of alerts for the project. |
|
|
| <a id="alertmanagementalertstatuscountstypeignored"></a>`ignored` | [`Int`](#int) | Number of alerts with status IGNORED for the project. |
|
|
| <a id="alertmanagementalertstatuscountstypeopen"></a>`open` | [`Int`](#int) | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project. |
|
|
| <a id="alertmanagementalertstatuscountstyperesolved"></a>`resolved` | [`Int`](#int) | Number of alerts with status RESOLVED for the project. |
|
|
| <a id="alertmanagementalertstatuscountstypetriggered"></a>`triggered` | [`Int`](#int) | Number of alerts with status TRIGGERED for the project. |
|
|
|
|
### `AlertManagementHttpIntegration`
|
|
|
|
An endpoint and credentials used to accept alerts for a project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementhttpintegrationactive"></a>`active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. |
|
|
| <a id="alertmanagementhttpintegrationapiurl"></a>`apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. |
|
|
| <a id="alertmanagementhttpintegrationid"></a>`id` | [`ID!`](#id) | ID of the integration. |
|
|
| <a id="alertmanagementhttpintegrationname"></a>`name` | [`String`](#string) | Name of the integration. |
|
|
| <a id="alertmanagementhttpintegrationpayloadalertfields"></a>`payloadAlertFields` | [`[AlertManagementPayloadAlertField!]`](#alertmanagementpayloadalertfield) | Extract alert fields from payload example for custom mapping. |
|
|
| <a id="alertmanagementhttpintegrationpayloadattributemappings"></a>`payloadAttributeMappings` | [`[AlertManagementPayloadAlertMappingField!]`](#alertmanagementpayloadalertmappingfield) | The custom mapping of GitLab alert attributes to fields from the payload_example. |
|
|
| <a id="alertmanagementhttpintegrationpayloadexample"></a>`payloadExample` | [`JsonString`](#jsonstring) | Example of an alert payload. |
|
|
| <a id="alertmanagementhttpintegrationtoken"></a>`token` | [`String`](#string) | Token used to authenticate alert notification requests. |
|
|
| <a id="alertmanagementhttpintegrationtype"></a>`type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. |
|
|
| <a id="alertmanagementhttpintegrationurl"></a>`url` | [`String`](#string) | Endpoint which accepts alert notifications. |
|
|
|
|
### `AlertManagementPayloadAlertField`
|
|
|
|
Parsed field from an alert used for custom mappings.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementpayloadalertfieldlabel"></a>`label` | [`String`](#string) | Human-readable label of the payload path. |
|
|
| <a id="alertmanagementpayloadalertfieldpath"></a>`path` | [`[PayloadAlertFieldPathSegment!]`](#payloadalertfieldpathsegment) | Path to value inside payload JSON. |
|
|
| <a id="alertmanagementpayloadalertfieldtype"></a>`type` | [`AlertManagementPayloadAlertFieldType`](#alertmanagementpayloadalertfieldtype) | Type of the parsed value. |
|
|
|
|
### `AlertManagementPayloadAlertMappingField`
|
|
|
|
Parsed field (with its name) from an alert used for custom mappings.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementpayloadalertmappingfieldfieldname"></a>`fieldName` | [`AlertManagementPayloadAlertFieldName`](#alertmanagementpayloadalertfieldname) | GitLab alert field name. |
|
|
| <a id="alertmanagementpayloadalertmappingfieldlabel"></a>`label` | [`String`](#string) | Human-readable label of the payload path. |
|
|
| <a id="alertmanagementpayloadalertmappingfieldpath"></a>`path` | [`[PayloadAlertFieldPathSegment!]`](#payloadalertfieldpathsegment) | Path to value inside payload JSON. |
|
|
| <a id="alertmanagementpayloadalertmappingfieldtype"></a>`type` | [`AlertManagementPayloadAlertFieldType`](#alertmanagementpayloadalertfieldtype) | Type of the parsed value. |
|
|
|
|
### `AlertManagementPrometheusIntegration`
|
|
|
|
An endpoint and credentials used to accept Prometheus alerts for a project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementprometheusintegrationactive"></a>`active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. |
|
|
| <a id="alertmanagementprometheusintegrationapiurl"></a>`apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. |
|
|
| <a id="alertmanagementprometheusintegrationid"></a>`id` | [`ID!`](#id) | ID of the integration. |
|
|
| <a id="alertmanagementprometheusintegrationname"></a>`name` | [`String`](#string) | Name of the integration. |
|
|
| <a id="alertmanagementprometheusintegrationtoken"></a>`token` | [`String`](#string) | Token used to authenticate alert notification requests. |
|
|
| <a id="alertmanagementprometheusintegrationtype"></a>`type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. |
|
|
| <a id="alertmanagementprometheusintegrationurl"></a>`url` | [`String`](#string) | Endpoint which accepts alert notifications. |
|
|
|
|
### `ApiFuzzingCiConfiguration`
|
|
|
|
Data associated with configuring API fuzzing scans in GitLab CI.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="apifuzzingciconfigurationscanmodes"></a>`scanModes` | [`[ApiFuzzingScanMode!]`](#apifuzzingscanmode) | All available scan modes. |
|
|
| <a id="apifuzzingciconfigurationscanprofiles"></a>`scanProfiles` | [`[ApiFuzzingScanProfile!]`](#apifuzzingscanprofile) | All default scan profiles. |
|
|
|
|
### `ApiFuzzingScanProfile`
|
|
|
|
An API Fuzzing scan profile.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="apifuzzingscanprofiledescription"></a>`description` | [`String`](#string) | Short description of the profile. |
|
|
| <a id="apifuzzingscanprofilename"></a>`name` | [`String`](#string) | Unique name of the profile. |
|
|
| <a id="apifuzzingscanprofileyaml"></a>`yaml` | [`String`](#string) | Syntax highlighted HTML representation of the YAML. |
|
|
|
|
### `ApprovalRule`
|
|
|
|
Describes a rule for who can approve merge requests.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="approvalruleapprovalsrequired"></a>`approvalsRequired` | [`Int`](#int) | Number of required approvals. |
|
|
| <a id="approvalruleapproved"></a>`approved` | [`Boolean`](#boolean) | Indicates if the rule is satisfied. |
|
|
| <a id="approvalruleapprovedby"></a>`approvedBy` | [`UserCoreConnection`](#usercoreconnection) | List of users defined in the rule that approved the merge request. (see [Connections](#connections)) |
|
|
| <a id="approvalrulecontainshiddengroups"></a>`containsHiddenGroups` | [`Boolean`](#boolean) | Indicates if the rule contains approvers from a hidden group. |
|
|
| <a id="approvalruleeligibleapprovers"></a>`eligibleApprovers` | [`[UserCore!]`](#usercore) | List of all users eligible to approve the merge request (defined explicitly and from associated groups). |
|
|
| <a id="approvalrulegroups"></a>`groups` | [`GroupConnection`](#groupconnection) | List of groups added as approvers for the rule. (see [Connections](#connections)) |
|
|
| <a id="approvalruleid"></a>`id` | [`GlobalID!`](#globalid) | ID of the rule. |
|
|
| <a id="approvalrulename"></a>`name` | [`String`](#string) | Name of the rule. |
|
|
| <a id="approvalruleoverridden"></a>`overridden` | [`Boolean`](#boolean) | Indicates if the rule was overridden for the merge request. |
|
|
| <a id="approvalrulesection"></a>`section` | [`String`](#string) | Named section of the Code Owners file that the rule applies to. |
|
|
| <a id="approvalrulesourcerule"></a>`sourceRule` | [`ApprovalRule`](#approvalrule) | Source rule used to create the rule. |
|
|
| <a id="approvalruletype"></a>`type` | [`ApprovalRuleType`](#approvalruletype) | Type of the rule. |
|
|
| <a id="approvalruleusers"></a>`users` | [`UserCoreConnection`](#usercoreconnection) | List of users added as approvers for the rule. (see [Connections](#connections)) |
|
|
|
|
### `AssetType`
|
|
|
|
Represents a vulnerability asset type.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="assettypename"></a>`name` | [`String!`](#string) | Name of the asset. |
|
|
| <a id="assettypetype"></a>`type` | [`String!`](#string) | Type of the asset. |
|
|
| <a id="assettypeurl"></a>`url` | [`String!`](#string) | URL of the asset. |
|
|
|
|
### `AwardEmoji`
|
|
|
|
An emoji awarded by a user.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="awardemojidescription"></a>`description` | [`String!`](#string) | Emoji description. |
|
|
| <a id="awardemojiemoji"></a>`emoji` | [`String!`](#string) | Emoji as an icon. |
|
|
| <a id="awardemojiname"></a>`name` | [`String!`](#string) | Emoji name. |
|
|
| <a id="awardemojiunicode"></a>`unicode` | [`String!`](#string) | Emoji in Unicode. |
|
|
| <a id="awardemojiunicodeversion"></a>`unicodeVersion` | [`String!`](#string) | Unicode version for this emoji. |
|
|
| <a id="awardemojiuser"></a>`user` | [`UserCore!`](#usercore) | User who awarded the emoji. |
|
|
|
|
### `BaseService`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="baseserviceactive"></a>`active` | [`Boolean`](#boolean) | Indicates if the service is active. |
|
|
| <a id="baseserviceservicetype"></a>`serviceType` | [`ServiceType`](#servicetype) | Type of the service. |
|
|
| <a id="baseservicetype"></a>`type` | [`String`](#string) | Class name of the service. |
|
|
|
|
### `Blob`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="blobflatpath"></a>`flatPath` | [`String!`](#string) | Flat path of the entry. |
|
|
| <a id="blobid"></a>`id` | [`ID!`](#id) | ID of the entry. |
|
|
| <a id="bloblfsoid"></a>`lfsOid` | [`String`](#string) | LFS ID of the blob. |
|
|
| <a id="blobmode"></a>`mode` | [`String`](#string) | Blob mode in numeric format. |
|
|
| <a id="blobname"></a>`name` | [`String!`](#string) | Name of the entry. |
|
|
| <a id="blobpath"></a>`path` | [`String!`](#string) | Path of the entry. |
|
|
| <a id="blobsha"></a>`sha` | [`String!`](#string) | Last commit SHA for the entry. |
|
|
| <a id="blobtype"></a>`type` | [`EntryType!`](#entrytype) | Type of tree entry. |
|
|
| <a id="blobwebpath"></a>`webPath` | [`String`](#string) | Web path of the blob. |
|
|
| <a id="blobweburl"></a>`webUrl` | [`String`](#string) | Web URL of the blob. |
|
|
|
|
### `BlobViewer`
|
|
|
|
Represents how the blob content should be displayed.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="blobviewercollapsed"></a>`collapsed` | [`Boolean!`](#boolean) | Shows whether the blob should be displayed collapsed. |
|
|
| <a id="blobviewerfiletype"></a>`fileType` | [`String!`](#string) | Content file type. |
|
|
| <a id="blobviewerloadasync"></a>`loadAsync` | [`Boolean!`](#boolean) | Shows whether the blob content is loaded asynchronously. |
|
|
| <a id="blobviewerloadingpartialname"></a>`loadingPartialName` | [`String!`](#string) | Loading partial name. |
|
|
| <a id="blobviewerrendererror"></a>`renderError` | [`String`](#string) | Error rendering the blob content. |
|
|
| <a id="blobviewertoolarge"></a>`tooLarge` | [`Boolean!`](#boolean) | Shows whether the blob is too large to be displayed. |
|
|
| <a id="blobviewertype"></a>`type` | [`BlobViewersType!`](#blobviewerstype) | Type of blob viewer. |
|
|
|
|
### `Board`
|
|
|
|
Represents a project or group issue board.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardassignee"></a>`assignee` | [`UserCore`](#usercore) | Board assignee. |
|
|
| <a id="boardcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the board was created. |
|
|
| <a id="boardhidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. |
|
|
| <a id="boardhideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. |
|
|
| <a id="boardid"></a>`id` | [`ID!`](#id) | ID (global ID) of the board. |
|
|
| <a id="boarditeration"></a>`iteration` | [`Iteration`](#iteration) | Board iteration. |
|
|
| <a id="boarditerationcadence"></a>`iterationCadence` | [`IterationCadence`](#iterationcadence) | Board iteration cadence. |
|
|
| <a id="boardlabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the board. (see [Connections](#connections)) |
|
|
| <a id="boardmilestone"></a>`milestone` | [`Milestone`](#milestone) | Board milestone. |
|
|
| <a id="boardname"></a>`name` | [`String`](#string) | Name of the board. |
|
|
| <a id="boardupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the board was last updated. |
|
|
| <a id="boardwebpath"></a>`webPath` | [`String!`](#string) | Web path of the board. |
|
|
| <a id="boardweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the board. |
|
|
| <a id="boardweight"></a>`weight` | [`Int`](#int) | Weight of the board. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Board.epics`
|
|
|
|
Epics associated with board issues.
|
|
|
|
Returns [`BoardEpicConnection`](#boardepicconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepicsissuefilters"></a>`issueFilters` | [`BoardIssueInput`](#boardissueinput) | Filters applied when selecting issues on the board. |
|
|
|
|
##### `Board.lists`
|
|
|
|
Lists of the board.
|
|
|
|
Returns [`BoardListConnection`](#boardlistconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardlistsid"></a>`id` | [`ListID`](#listid) | Find a list by its global ID. |
|
|
| <a id="boardlistsissuefilters"></a>`issueFilters` | [`BoardIssueInput`](#boardissueinput) | Filters applied when getting issue metadata in the board list. |
|
|
|
|
### `BoardEpic`
|
|
|
|
Represents an epic on an issue board.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepicauthor"></a>`author` | [`UserCore!`](#usercore) | Author of the epic. |
|
|
| <a id="boardepicawardemoji"></a>`awardEmoji` | [`AwardEmojiConnection`](#awardemojiconnection) | List of award emojis associated with the epic. (see [Connections](#connections)) |
|
|
| <a id="boardepicblocked"></a>`blocked` | [`Boolean`](#boolean) | Indicates the epic is blocked. |
|
|
| <a id="boardepicblockedbycount"></a>`blockedByCount` | [`Int`](#int) | Count of epics blocking this epic. |
|
|
| <a id="boardepicblockedbyepics"></a>`blockedByEpics` | [`EpicConnection`](#epicconnection) | Epics blocking this epic. (see [Connections](#connections)) |
|
|
| <a id="boardepicblockingcount"></a>`blockingCount` | [`Int`](#int) | Count of epics that this epic is blocking. |
|
|
| <a id="boardepicclosedat"></a>`closedAt` | [`Time`](#time) | Timestamp of when the epic was closed. |
|
|
| <a id="boardepiccolor"></a>`color` | [`String!`](#string) | Color of the epic. Available only when feature flag `epic_color_highlight` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
|
|
| <a id="boardepicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. |
|
|
| <a id="boardepiccreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the epic was created. |
|
|
| <a id="boardepicdescendantcounts"></a>`descendantCounts` | [`EpicDescendantCount`](#epicdescendantcount) | Number of open and closed descendant epics and issues. |
|
|
| <a id="boardepicdescendantweightsum"></a>`descendantWeightSum` | [`EpicDescendantWeights`](#epicdescendantweights) | Total weight of open and closed issues in the epic and its descendants. |
|
|
| <a id="boardepicdescription"></a>`description` | [`String`](#string) | Description of the epic. |
|
|
| <a id="boardepicdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="boardepicdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="boardepicdownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes the epic has received. |
|
|
| <a id="boardepicduedate"></a>`dueDate` | [`Time`](#time) | Due date of the epic. |
|
|
| <a id="boardepicduedatefixed"></a>`dueDateFixed` | [`Time`](#time) | Fixed due date of the epic. |
|
|
| <a id="boardepicduedatefrominheritedsource"></a>`dueDateFromInheritedSource` | [`Time`](#time) | Inherited due date of the epic from child epics or milestones. |
|
|
| <a id="boardepicduedatefrommilestones"></a>`dueDateFromMilestones` | [`Time`](#time) | Inherited due date of the epic from milestones. |
|
|
| <a id="boardepicduedateisfixed"></a>`dueDateIsFixed` | [`Boolean`](#boolean) | Indicates if the due date has been manually set. |
|
|
| <a id="boardepicevents"></a>`events` | [`EventConnection`](#eventconnection) | List of events associated with the object. (see [Connections](#connections)) |
|
|
| <a id="boardepicgroup"></a>`group` | [`Group!`](#group) | Group to which the epic belongs. |
|
|
| <a id="boardepichaschildren"></a>`hasChildren` | [`Boolean!`](#boolean) | Indicates if the epic has children. |
|
|
| <a id="boardepichasissues"></a>`hasIssues` | [`Boolean!`](#boolean) | Indicates if the epic has direct issues. |
|
|
| <a id="boardepichasparent"></a>`hasParent` | [`Boolean!`](#boolean) | Indicates if the epic has a parent epic. |
|
|
| <a id="boardepichealthstatus"></a>`healthStatus` | [`EpicHealthStatus`](#epichealthstatus) | Current health status of the epic. |
|
|
| <a id="boardepicid"></a>`id` | [`ID!`](#id) | ID of the epic. |
|
|
| <a id="boardepiciid"></a>`iid` | [`ID!`](#id) | Internal ID of the epic. |
|
|
| <a id="boardepicissues"></a>`issues` | [`EpicIssueConnection`](#epicissueconnection) | A list of issues associated with the epic. (see [Connections](#connections)) |
|
|
| <a id="boardepiclabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels assigned to the epic. (see [Connections](#connections)) |
|
|
| <a id="boardepicnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="boardepicparent"></a>`parent` | [`Epic`](#epic) | Parent epic of the epic. |
|
|
| <a id="boardepicparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | List of participants for the epic. (see [Connections](#connections)) |
|
|
| <a id="boardepicrelationpath"></a>`relationPath` | [`String`](#string) | URI path of the epic-issue relationship. |
|
|
| <a id="boardepicrelativeposition"></a>`relativePosition` | [`Int`](#int) | Relative position of the epic in the epic tree. |
|
|
| <a id="boardepicstartdate"></a>`startDate` | [`Time`](#time) | Start date of the epic. |
|
|
| <a id="boardepicstartdatefixed"></a>`startDateFixed` | [`Time`](#time) | Fixed start date of the epic. |
|
|
| <a id="boardepicstartdatefrominheritedsource"></a>`startDateFromInheritedSource` | [`Time`](#time) | Inherited start date of the epic from child epics or milestones. |
|
|
| <a id="boardepicstartdatefrommilestones"></a>`startDateFromMilestones` | [`Time`](#time) | Inherited start date of the epic from milestones. |
|
|
| <a id="boardepicstartdateisfixed"></a>`startDateIsFixed` | [`Boolean`](#boolean) | Indicates if the start date has been manually set. |
|
|
| <a id="boardepicstate"></a>`state` | [`EpicState!`](#epicstate) | State of the epic. |
|
|
| <a id="boardepicsubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the epic. |
|
|
| <a id="boardepictextcolor"></a>`textColor` | [`String!`](#string) | Text color generated for the epic. Available only when feature flag `epic_color_highlight` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
|
|
| <a id="boardepictitle"></a>`title` | [`String`](#string) | Title of the epic. |
|
|
| <a id="boardepictitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. |
|
|
| <a id="boardepicupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp of when the epic was updated. |
|
|
| <a id="boardepicupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes the epic has received. |
|
|
| <a id="boardepicuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the epic. |
|
|
| <a id="boardepicusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes of the epic. |
|
|
| <a id="boardepicuserpermissions"></a>`userPermissions` | [`EpicPermissions!`](#epicpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="boardepicuserpreferences"></a>`userPreferences` | [`BoardEpicUserPreferences`](#boardepicuserpreferences) | User preferences for the epic on the issue board. |
|
|
| <a id="boardepicwebpath"></a>`webPath` | [`String!`](#string) | Web path of the epic. |
|
|
| <a id="boardepicweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the epic. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `BoardEpic.ancestors`
|
|
|
|
Ancestors (parents) of the epic.
|
|
|
|
Returns [`EpicConnection`](#epicconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepicancestorsauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. |
|
|
| <a id="boardepicancestorsconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. |
|
|
| <a id="boardepicancestorscreatedafter"></a>`createdAfter` | [`Time`](#time) | Epics created after this date. |
|
|
| <a id="boardepicancestorscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Epics created before this date. |
|
|
| <a id="boardepicancestorsenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="boardepicancestorsiid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". |
|
|
| <a id="boardepicancestorsiidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. |
|
|
| <a id="boardepicancestorsiids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., `[1, 2]`. |
|
|
| <a id="boardepicancestorsin"></a>`in` | [`[IssuableSearchableField!]`](#issuablesearchablefield) | Specify the fields to perform the search in. Defaults to `[TITLE, DESCRIPTION]`. Requires the `search` argument. |
|
|
| <a id="boardepicancestorsincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include epics from ancestor groups. |
|
|
| <a id="boardepicancestorsincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. |
|
|
| <a id="boardepicancestorslabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. |
|
|
| <a id="boardepicancestorsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. |
|
|
| <a id="boardepicancestorsmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. |
|
|
| <a id="boardepicancestorsnot"></a>`not` | [`NegatedEpicFilterInput`](#negatedepicfilterinput) | Negated epic arguments. |
|
|
| <a id="boardepicancestorssearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="boardepicancestorssort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. |
|
|
| <a id="boardepicancestorsstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="boardepicancestorsstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. |
|
|
| <a id="boardepicancestorstimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="boardepicancestorstoplevelhierarchyonly"></a>`topLevelHierarchyOnly` | [`Boolean`](#boolean) | Filter epics with a top-level hierarchy. |
|
|
| <a id="boardepicancestorsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Epics updated after this date. |
|
|
| <a id="boardepicancestorsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Epics updated before this date. |
|
|
|
|
##### `BoardEpic.children`
|
|
|
|
Children (sub-epics) of the epic.
|
|
|
|
Returns [`EpicConnection`](#epicconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepicchildrenauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. |
|
|
| <a id="boardepicchildrenconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. |
|
|
| <a id="boardepicchildrencreatedafter"></a>`createdAfter` | [`Time`](#time) | Epics created after this date. |
|
|
| <a id="boardepicchildrencreatedbefore"></a>`createdBefore` | [`Time`](#time) | Epics created before this date. |
|
|
| <a id="boardepicchildrenenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="boardepicchildreniid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". |
|
|
| <a id="boardepicchildreniidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. |
|
|
| <a id="boardepicchildreniids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., `[1, 2]`. |
|
|
| <a id="boardepicchildrenin"></a>`in` | [`[IssuableSearchableField!]`](#issuablesearchablefield) | Specify the fields to perform the search in. Defaults to `[TITLE, DESCRIPTION]`. Requires the `search` argument. |
|
|
| <a id="boardepicchildrenincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include epics from ancestor groups. |
|
|
| <a id="boardepicchildrenincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. |
|
|
| <a id="boardepicchildrenlabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. |
|
|
| <a id="boardepicchildrenmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. |
|
|
| <a id="boardepicchildrenmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. |
|
|
| <a id="boardepicchildrennot"></a>`not` | [`NegatedEpicFilterInput`](#negatedepicfilterinput) | Negated epic arguments. |
|
|
| <a id="boardepicchildrensearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="boardepicchildrensort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. |
|
|
| <a id="boardepicchildrenstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="boardepicchildrenstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. |
|
|
| <a id="boardepicchildrentimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="boardepicchildrentoplevelhierarchyonly"></a>`topLevelHierarchyOnly` | [`Boolean`](#boolean) | Filter epics with a top-level hierarchy. |
|
|
| <a id="boardepicchildrenupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Epics updated after this date. |
|
|
| <a id="boardepicchildrenupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Epics updated before this date. |
|
|
|
|
##### `BoardEpic.currentUserTodos`
|
|
|
|
To-do items for the current user.
|
|
|
|
Returns [`TodoConnection!`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepiccurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. |
|
|
|
|
##### `BoardEpic.reference`
|
|
|
|
Internal reference of the epic. Returned in shortened format by default.
|
|
|
|
Returns [`String!`](#string).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepicreferencefull"></a>`full` | [`Boolean`](#boolean) | Indicates if the reference should be returned in full. |
|
|
|
|
### `BoardEpicUserPreferences`
|
|
|
|
Represents user preferences for a board epic.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardepicuserpreferencescollapsed"></a>`collapsed` | [`Boolean!`](#boolean) | Indicates epic should be displayed as collapsed. |
|
|
|
|
### `BoardList`
|
|
|
|
Represents a list for an issue board.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardlistassignee"></a>`assignee` | [`UserCore`](#usercore) | Assignee in the list. |
|
|
| <a id="boardlistcollapsed"></a>`collapsed` | [`Boolean`](#boolean) | Indicates if the list is collapsed for this user. |
|
|
| <a id="boardlistid"></a>`id` | [`ID!`](#id) | ID (global ID) of the list. |
|
|
| <a id="boardlistissuescount"></a>`issuesCount` | [`Int`](#int) | Count of issues in the list. |
|
|
| <a id="boardlistiteration"></a>`iteration` | [`Iteration`](#iteration) | Iteration of the list. |
|
|
| <a id="boardlistlabel"></a>`label` | [`Label`](#label) | Label of the list. |
|
|
| <a id="boardlistlimitmetric"></a>`limitMetric` | [`ListLimitMetric`](#listlimitmetric) | Current limit metric for the list. |
|
|
| <a id="boardlistlisttype"></a>`listType` | [`String!`](#string) | Type of the list. |
|
|
| <a id="boardlistmaxissuecount"></a>`maxIssueCount` | [`Int`](#int) | Maximum number of issues in the list. |
|
|
| <a id="boardlistmaxissueweight"></a>`maxIssueWeight` | [`Int`](#int) | Maximum weight of issues in the list. |
|
|
| <a id="boardlistmilestone"></a>`milestone` | [`Milestone`](#milestone) | Milestone of the list. |
|
|
| <a id="boardlistposition"></a>`position` | [`Int`](#int) | Position of list within the board. |
|
|
| <a id="boardlisttitle"></a>`title` | [`String!`](#string) | Title of the list. |
|
|
| <a id="boardlisttotalweight"></a>`totalWeight` | [`Int`](#int) | Total weight of all issues in the list. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `BoardList.issues`
|
|
|
|
Board issues.
|
|
|
|
Returns [`IssueConnection`](#issueconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardlistissuesfilters"></a>`filters` | [`BoardIssueInput`](#boardissueinput) | Filters applied when selecting issues in the board list. |
|
|
|
|
### `Branch`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="branchcommit"></a>`commit` | [`Commit`](#commit) | Commit for the branch. |
|
|
| <a id="branchname"></a>`name` | [`String!`](#string) | Name of the branch. |
|
|
|
|
### `BurnupChartDailyTotals`
|
|
|
|
Represents the total number of issues and their weights for a particular day.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="burnupchartdailytotalscompletedcount"></a>`completedCount` | [`Int!`](#int) | Number of closed issues as of this day. |
|
|
| <a id="burnupchartdailytotalscompletedweight"></a>`completedWeight` | [`Int!`](#int) | Total weight of closed issues as of this day. |
|
|
| <a id="burnupchartdailytotalsdate"></a>`date` | [`ISO8601Date!`](#iso8601date) | Date for burnup totals. |
|
|
| <a id="burnupchartdailytotalsscopecount"></a>`scopeCount` | [`Int!`](#int) | Number of issues as of this day. |
|
|
| <a id="burnupchartdailytotalsscopeweight"></a>`scopeWeight` | [`Int!`](#int) | Total weight of issues as of this day. |
|
|
|
|
### `CiApplicationSettings`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciapplicationsettingskeeplatestartifact"></a>`keepLatestArtifact` | [`Boolean`](#boolean) | Whether to keep the latest jobs artifacts. |
|
|
|
|
### `CiBuildNeed`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cibuildneedid"></a>`id` | [`ID!`](#id) | ID of the BuildNeed. |
|
|
| <a id="cibuildneedname"></a>`name` | [`String`](#string) | Name of the job we need to complete. |
|
|
|
|
### `CiConfig`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigerrors"></a>`errors` | [`[String!]`](#string) | Linting errors. |
|
|
| <a id="ciconfigincludes"></a>`includes` | [`[CiConfigInclude!]`](#ciconfiginclude) | List of included files. |
|
|
| <a id="ciconfigmergedyaml"></a>`mergedYaml` | [`String`](#string) | Merged CI configuration YAML. |
|
|
| <a id="ciconfigstages"></a>`stages` | [`CiConfigStageConnection`](#ciconfigstageconnection) | Stages of the pipeline. (see [Connections](#connections)) |
|
|
| <a id="ciconfigstatus"></a>`status` | [`CiConfigStatus`](#ciconfigstatus) | Status of linting, can be either valid or invalid. |
|
|
| <a id="ciconfigwarnings"></a>`warnings` | [`[String!]`](#string) | Linting warnings. |
|
|
|
|
### `CiConfigGroup`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfiggroupjobs"></a>`jobs` | [`CiConfigJobConnection`](#ciconfigjobconnection) | Jobs in group. (see [Connections](#connections)) |
|
|
| <a id="ciconfiggroupname"></a>`name` | [`String`](#string) | Name of the job group. |
|
|
| <a id="ciconfiggroupsize"></a>`size` | [`Int`](#int) | Size of the job group. |
|
|
|
|
### `CiConfigInclude`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigincludeblob"></a>`blob` | [`String`](#string) | File blob location. It can be masked if it contains masked variables, e.g., "https://gitlab.com/gitlab-org/gitlab/-/blob/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml". |
|
|
| <a id="ciconfigincludecontextproject"></a>`contextProject` | [`String`](#string) | Current project scope, e.g., "gitlab-org/gitlab". |
|
|
| <a id="ciconfigincludecontextsha"></a>`contextSha` | [`String`](#string) | Current sha scope. |
|
|
| <a id="ciconfigincludeextra"></a>`extra` | [`JSON`](#json) | Extra information for the `include`, which can contain `job_name`, `project`, and `ref`. Values can be masked if they contain masked variables. |
|
|
| <a id="ciconfigincludelocation"></a>`location` | [`String`](#string) | File location. It can be masked if it contains masked variables, e.g., ".gitlab/ci/build-images.gitlab-ci.yml". |
|
|
| <a id="ciconfigincluderaw"></a>`raw` | [`String`](#string) | File raw location. It can be masked if it contains masked variables, e.g., "https://gitlab.com/gitlab-org/gitlab/-/raw/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml". |
|
|
| <a id="ciconfigincludetype"></a>`type` | [`CiConfigIncludeType`](#ciconfigincludetype) | Include type. |
|
|
|
|
### `CiConfigJob`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigjobafterscript"></a>`afterScript` | [`[String!]`](#string) | Override a set of commands that are executed after the job. |
|
|
| <a id="ciconfigjoballowfailure"></a>`allowFailure` | [`Boolean`](#boolean) | Allow job to fail. |
|
|
| <a id="ciconfigjobbeforescript"></a>`beforeScript` | [`[String!]`](#string) | Override a set of commands that are executed before the job. |
|
|
| <a id="ciconfigjobenvironment"></a>`environment` | [`String`](#string) | Name of an environment to which the job deploys. |
|
|
| <a id="ciconfigjobexcept"></a>`except` | [`CiConfigJobRestriction`](#ciconfigjobrestriction) | Limit when jobs are not created. |
|
|
| <a id="ciconfigjobgroupname"></a>`groupName` | [`String`](#string) | Name of the job group. |
|
|
| <a id="ciconfigjobname"></a>`name` | [`String`](#string) | Name of the job. |
|
|
| <a id="ciconfigjobneeds"></a>`needs` | [`CiConfigNeedConnection`](#ciconfigneedconnection) | Builds that must complete before the jobs run. (see [Connections](#connections)) |
|
|
| <a id="ciconfigjobonly"></a>`only` | [`CiConfigJobRestriction`](#ciconfigjobrestriction) | Jobs are created when these conditions do not apply. |
|
|
| <a id="ciconfigjobscript"></a>`script` | [`[String!]`](#string) | Shell script that is executed by a runner. |
|
|
| <a id="ciconfigjobstage"></a>`stage` | [`String`](#string) | Name of the job stage. |
|
|
| <a id="ciconfigjobtags"></a>`tags` | [`[String!]`](#string) | List of tags that are used to select a runner. |
|
|
| <a id="ciconfigjobwhen"></a>`when` | [`String`](#string) | When to run the job. |
|
|
|
|
### `CiConfigJobRestriction`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigjobrestrictionrefs"></a>`refs` | [`[String!]`](#string) | Git refs the job restriction applies to. |
|
|
|
|
### `CiConfigNeed`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigneedname"></a>`name` | [`String`](#string) | Name of the need. |
|
|
|
|
### `CiConfigStage`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciconfigstagegroups"></a>`groups` | [`CiConfigGroupConnection`](#ciconfiggroupconnection) | Groups of jobs for the stage. (see [Connections](#connections)) |
|
|
| <a id="ciconfigstagename"></a>`name` | [`String`](#string) | Name of the stage. |
|
|
|
|
### `CiGroup`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cigroupdetailedstatus"></a>`detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the group. |
|
|
| <a id="cigroupid"></a>`id` | [`String!`](#string) | ID for a group. |
|
|
| <a id="cigroupjobs"></a>`jobs` | [`CiJobConnection`](#cijobconnection) | Jobs in group. (see [Connections](#connections)) |
|
|
| <a id="cigroupname"></a>`name` | [`String`](#string) | Name of the job group. |
|
|
| <a id="cigroupsize"></a>`size` | [`Int`](#int) | Size of the group. |
|
|
|
|
### `CiJob`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cijobactive"></a>`active` | [`Boolean!`](#boolean) | Indicates the job is active. |
|
|
| <a id="cijoballowfailure"></a>`allowFailure` | [`Boolean!`](#boolean) | Whether the job is allowed to fail. |
|
|
| <a id="cijobartifacts"></a>`artifacts` | [`CiJobArtifactConnection`](#cijobartifactconnection) | Artifacts generated by the job. (see [Connections](#connections)) |
|
|
| <a id="cijobcancelable"></a>`cancelable` | [`Boolean!`](#boolean) | Indicates the job can be canceled. |
|
|
| <a id="cijobcommitpath"></a>`commitPath` | [`String`](#string) | Path to the commit that triggered the job. |
|
|
| <a id="cijobcoverage"></a>`coverage` | [`Float`](#float) | Coverage level of the job. |
|
|
| <a id="cijobcreatedat"></a>`createdAt` | [`Time!`](#time) | When the job was created. |
|
|
| <a id="cijobcreatedbytag"></a>`createdByTag` | [`Boolean!`](#boolean) | Whether the job was created by a tag. |
|
|
| <a id="cijobdetailedstatus"></a>`detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the job. |
|
|
| <a id="cijobdownstreampipeline"></a>`downstreamPipeline` | [`Pipeline`](#pipeline) | Downstream pipeline for a bridge. |
|
|
| <a id="cijobduration"></a>`duration` | [`Int`](#int) | Duration of the job in seconds. |
|
|
| <a id="cijobfinishedat"></a>`finishedAt` | [`Time`](#time) | When a job has finished running. |
|
|
| <a id="cijobid"></a>`id` | [`JobID`](#jobid) | ID of the job. |
|
|
| <a id="cijobkind"></a>`kind` | [`CiJobKind!`](#cijobkind) | Indicates the type of job. |
|
|
| <a id="cijobmanualjob"></a>`manualJob` | [`Boolean`](#boolean) | Whether the job has a manual action. |
|
|
| <a id="cijobname"></a>`name` | [`String`](#string) | Name of the job. |
|
|
| <a id="cijobneeds"></a>`needs` | [`CiBuildNeedConnection`](#cibuildneedconnection) | References to builds that must complete before the jobs run. (see [Connections](#connections)) |
|
|
| <a id="cijobpipeline"></a>`pipeline` | [`Pipeline`](#pipeline) | Pipeline the job belongs to. |
|
|
| <a id="cijobplayable"></a>`playable` | [`Boolean!`](#boolean) | Indicates the job can be played. |
|
|
| <a id="cijobpreviousstagejobsorneeds"></a>`previousStageJobsOrNeeds` | [`JobNeedUnionConnection`](#jobneedunionconnection) | Jobs that must complete before the job runs. Returns `BuildNeed`, which is the needed jobs if the job uses the `needs` keyword, or the previous stage jobs otherwise. (see [Connections](#connections)) |
|
|
| <a id="cijobqueuedat"></a>`queuedAt` | [`Time`](#time) | When the job was enqueued and marked as pending. |
|
|
| <a id="cijobqueuedduration"></a>`queuedDuration` | [`Duration`](#duration) | How long the job was enqueued before starting. |
|
|
| <a id="cijobrefname"></a>`refName` | [`String`](#string) | Ref name of the job. |
|
|
| <a id="cijobrefpath"></a>`refPath` | [`String`](#string) | Path to the ref. |
|
|
| <a id="cijobretryable"></a>`retryable` | [`Boolean!`](#boolean) | Indicates the job can be retried. |
|
|
| <a id="cijobscheduledat"></a>`scheduledAt` | [`Time`](#time) | Schedule for the build. |
|
|
| <a id="cijobschedulingtype"></a>`schedulingType` | [`String`](#string) | Type of job scheduling. Value is `dag` if the job uses the `needs` keyword, and `stage` otherwise. |
|
|
| <a id="cijobshortsha"></a>`shortSha` | [`String!`](#string) | Short SHA1 ID of the commit. |
|
|
| <a id="cijobstage"></a>`stage` | [`CiStage`](#cistage) | Stage of the job. |
|
|
| <a id="cijobstartedat"></a>`startedAt` | [`Time`](#time) | When the job was started. |
|
|
| <a id="cijobstatus"></a>`status` | [`CiJobStatus`](#cijobstatus) | Status of the job. |
|
|
| <a id="cijobstuck"></a>`stuck` | [`Boolean!`](#boolean) | Indicates the job is stuck. |
|
|
| <a id="cijobtags"></a>`tags` | [`[String!]`](#string) | Tags for the current job. |
|
|
| <a id="cijobtriggered"></a>`triggered` | [`Boolean`](#boolean) | Whether the job was triggered. |
|
|
| <a id="cijobuserpermissions"></a>`userPermissions` | [`JobPermissions!`](#jobpermissions) | Permissions for the current user on the resource. |
|
|
|
|
### `CiJobArtifact`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cijobartifactdownloadpath"></a>`downloadPath` | [`String`](#string) | URL for downloading the artifact's file. |
|
|
| <a id="cijobartifactfiletype"></a>`fileType` | [`JobArtifactFileType`](#jobartifactfiletype) | File type of the artifact. |
|
|
| <a id="cijobartifactname"></a>`name` | [`String`](#string) | File name of the artifact. |
|
|
|
|
### `CiJobTokenScopeType`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cijobtokenscopetypeprojects"></a>`projects` | [`ProjectConnection!`](#projectconnection) | Allow list of projects that can be accessed by CI Job tokens created by this project. (see [Connections](#connections)) |
|
|
|
|
### `CiMinutesNamespaceMonthlyUsage`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciminutesnamespacemonthlyusageminutes"></a>`minutes` | [`Int`](#int) | Total number of minutes used by all projects in the namespace. |
|
|
| <a id="ciminutesnamespacemonthlyusagemonth"></a>`month` | [`String`](#string) | Month related to the usage data. |
|
|
| <a id="ciminutesnamespacemonthlyusagemonthiso8601"></a>`monthIso8601` | [`ISO8601Date`](#iso8601date) | Month related to the usage data in ISO 8601 date format. |
|
|
| <a id="ciminutesnamespacemonthlyusageprojects"></a>`projects` | [`CiMinutesProjectMonthlyUsageConnection`](#ciminutesprojectmonthlyusageconnection) | CI/CD minutes usage data for projects in the namespace. (see [Connections](#connections)) |
|
|
| <a id="ciminutesnamespacemonthlyusagesharedrunnersduration"></a>`sharedRunnersDuration` | [`Int`](#int) | Total duration (in seconds) of shared runners use by the namespace for the month. |
|
|
|
|
### `CiMinutesProjectMonthlyUsage`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="ciminutesprojectmonthlyusageminutes"></a>`minutes` | [`Int`](#int) | Number of CI/CD minutes used by the project in the month. |
|
|
| <a id="ciminutesprojectmonthlyusagename"></a>`name` | [`String`](#string) | Name of the project. |
|
|
| <a id="ciminutesprojectmonthlyusagesharedrunnersduration"></a>`sharedRunnersDuration` | [`Int`](#int) | Total duration (in seconds) of shared runners use by the project for the month. |
|
|
|
|
### `CiRunner`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cirunneraccesslevel"></a>`accessLevel` | [`CiRunnerAccessLevel!`](#cirunneraccesslevel) | Access level of the runner. |
|
|
| <a id="cirunneractive"></a>`active` **{warning-solid}** | [`Boolean!`](#boolean) | **Deprecated** in 14.8. Use paused. |
|
|
| <a id="cirunneradminurl"></a>`adminUrl` | [`String`](#string) | Admin URL of the runner. Only available for administrators. |
|
|
| <a id="cirunnerarchitecturename"></a>`architectureName` | [`String`](#string) | Architecture provided by the the runner. |
|
|
| <a id="cirunnercontactedat"></a>`contactedAt` | [`Time`](#time) | Timestamp of last contact from this runner. |
|
|
| <a id="cirunnercreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of creation of this runner. |
|
|
| <a id="cirunnerdescription"></a>`description` | [`String`](#string) | Description of the runner. |
|
|
| <a id="cirunnereditadminurl"></a>`editAdminUrl` | [`String`](#string) | Admin form URL of the runner. Only available for administrators. |
|
|
| <a id="cirunnerexecutorname"></a>`executorName` | [`String`](#string) | Executor last advertised by the runner. |
|
|
| <a id="cirunnergroups"></a>`groups` | [`GroupConnection`](#groupconnection) | Groups the runner is associated with. For group runners only. (see [Connections](#connections)) |
|
|
| <a id="cirunnerid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | ID of the runner. |
|
|
| <a id="cirunneripaddress"></a>`ipAddress` | [`String`](#string) | IP address of the runner. |
|
|
| <a id="cirunnerjobcount"></a>`jobCount` | [`Int`](#int) | Number of jobs processed by the runner (limited to 1000, plus one to indicate that more items exist). |
|
|
| <a id="cirunnerlocked"></a>`locked` | [`Boolean`](#boolean) | Indicates the runner is locked. |
|
|
| <a id="cirunnermaintenancenote"></a>`maintenanceNote` | [`String`](#string) | Runner's maintenance notes. |
|
|
| <a id="cirunnermaintenancenotehtml"></a>`maintenanceNoteHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `maintenance_note`. |
|
|
| <a id="cirunnermaximumtimeout"></a>`maximumTimeout` | [`Int`](#int) | Maximum timeout (in seconds) for jobs processed by the runner. |
|
|
| <a id="cirunnerpaused"></a>`paused` | [`Boolean!`](#boolean) | Indicates the runner is paused and not available to run jobs. |
|
|
| <a id="cirunnerplatformname"></a>`platformName` | [`String`](#string) | Platform provided by the runner. |
|
|
| <a id="cirunnerprivateprojectsminutescostfactor"></a>`privateProjectsMinutesCostFactor` | [`Float`](#float) | Private projects' "minutes cost factor" associated with the runner (GitLab.com only). |
|
|
| <a id="cirunnerprojectcount"></a>`projectCount` | [`Int`](#int) | Number of projects that the runner is associated with. |
|
|
| <a id="cirunnerprojects"></a>`projects` | [`ProjectConnection`](#projectconnection) | Projects the runner is associated with. For project runners only. (see [Connections](#connections)) |
|
|
| <a id="cirunnerpublicprojectsminutescostfactor"></a>`publicProjectsMinutesCostFactor` | [`Float`](#float) | Public projects' "minutes cost factor" associated with the runner (GitLab.com only). |
|
|
| <a id="cirunnerrevision"></a>`revision` | [`String`](#string) | Revision of the runner. |
|
|
| <a id="cirunnerrununtagged"></a>`runUntagged` | [`Boolean!`](#boolean) | Indicates the runner is able to run untagged jobs. |
|
|
| <a id="cirunnerrunnertype"></a>`runnerType` | [`CiRunnerType!`](#cirunnertype) | Type of the runner. |
|
|
| <a id="cirunnershortsha"></a>`shortSha` | [`String`](#string) | First eight characters of the runner's token used to authenticate new job requests. Used as the runner's unique ID. |
|
|
| <a id="cirunnertaglist"></a>`tagList` | [`[String!]`](#string) | Tags associated with the runner. |
|
|
| <a id="cirunnertokenexpiresat"></a>`tokenExpiresAt` | [`Time`](#time) | Runner token expiration time. |
|
|
| <a id="cirunnerupgradestatus"></a>`upgradeStatus` **{warning-solid}** | [`CiRunnerUpgradeStatusType`](#cirunnerupgradestatustype) | **Deprecated** in 14.10. This feature is in Alpha, and can be removed or changed at any point. |
|
|
| <a id="cirunneruserpermissions"></a>`userPermissions` | [`RunnerPermissions!`](#runnerpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="cirunnerversion"></a>`version` | [`String`](#string) | Version of the runner. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `CiRunner.jobs`
|
|
|
|
Jobs assigned to the runner.
|
|
|
|
Returns [`CiJobConnection`](#cijobconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cirunnerjobsstatuses"></a>`statuses` | [`[CiJobStatus!]`](#cijobstatus) | Filter jobs by status. |
|
|
|
|
##### `CiRunner.status`
|
|
|
|
Status of the runner.
|
|
|
|
Returns [`CiRunnerStatus!`](#cirunnerstatus).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cirunnerstatuslegacymode"></a>`legacyMode` **{warning-solid}** | [`String`](#string) | **Deprecated** in 15.0. Will be removed in 17.0. In GitLab 16.0 and later, the field will act as if `legacyMode` is null. |
|
|
|
|
### `CiStage`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="cistagedetailedstatus"></a>`detailedStatus` | [`DetailedStatus`](#detailedstatus) | Detailed status of the stage. |
|
|
| <a id="cistagegroups"></a>`groups` | [`CiGroupConnection`](#cigroupconnection) | Group of jobs for the stage. (see [Connections](#connections)) |
|
|
| <a id="cistageid"></a>`id` | [`ID!`](#id) | ID of the stage. |
|
|
| <a id="cistagejobs"></a>`jobs` | [`CiJobConnection`](#cijobconnection) | Jobs for the stage. (see [Connections](#connections)) |
|
|
| <a id="cistagename"></a>`name` | [`String`](#string) | Name of the stage. |
|
|
| <a id="cistagestatus"></a>`status` | [`String`](#string) | Status of the pipeline stage. |
|
|
|
|
### `CiTemplate`
|
|
|
|
GitLab CI/CD configuration template.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="citemplatecontent"></a>`content` | [`String!`](#string) | Contents of the CI template. |
|
|
| <a id="citemplatename"></a>`name` | [`String!`](#string) | Name of the CI template. |
|
|
|
|
### `ClusterAgent`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragentactivityevents"></a>`activityEvents` | [`ClusterAgentActivityEventConnection`](#clusteragentactivityeventconnection) | Recent activity for the cluster agent. (see [Connections](#connections)) |
|
|
| <a id="clusteragentconnections"></a>`connections` | [`ConnectedAgentConnection`](#connectedagentconnection) | Active connections for the cluster agent. (see [Connections](#connections)) |
|
|
| <a id="clusteragentcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp the cluster agent was created. |
|
|
| <a id="clusteragentcreatedbyuser"></a>`createdByUser` | [`UserCore`](#usercore) | User object, containing information about the person who created the agent. |
|
|
| <a id="clusteragentid"></a>`id` | [`ID!`](#id) | ID of the cluster agent. |
|
|
| <a id="clusteragentname"></a>`name` | [`String`](#string) | Name of the cluster agent. |
|
|
| <a id="clusteragentproject"></a>`project` | [`Project`](#project) | Project this cluster agent is associated with. |
|
|
| <a id="clusteragentupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp the cluster agent was updated. |
|
|
| <a id="clusteragentwebpath"></a>`webPath` | [`String`](#string) | Web path of the cluster agent. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `ClusterAgent.tokens`
|
|
|
|
Tokens associated with the cluster agent.
|
|
|
|
Returns [`ClusterAgentTokenConnection`](#clusteragenttokenconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragenttokensstatus"></a>`status` | [`AgentTokenStatus`](#agenttokenstatus) | Status of the token. |
|
|
|
|
### `ClusterAgentActivityEvent`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragentactivityeventagenttoken"></a>`agentToken` | [`ClusterAgentToken`](#clusteragenttoken) | Agent token associated with the event. |
|
|
| <a id="clusteragentactivityeventkind"></a>`kind` | [`String`](#string) | Type of event. |
|
|
| <a id="clusteragentactivityeventlevel"></a>`level` | [`String`](#string) | Severity of the event. |
|
|
| <a id="clusteragentactivityeventrecordedat"></a>`recordedAt` | [`Time`](#time) | Timestamp the event was recorded. |
|
|
| <a id="clusteragentactivityeventuser"></a>`user` | [`UserCore`](#usercore) | User associated with the event. |
|
|
|
|
### `ClusterAgentToken`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="clusteragenttokenclusteragent"></a>`clusterAgent` | [`ClusterAgent`](#clusteragent) | Cluster agent this token is associated with. |
|
|
| <a id="clusteragenttokencreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp the token was created. |
|
|
| <a id="clusteragenttokencreatedbyuser"></a>`createdByUser` | [`UserCore`](#usercore) | User who created the token. |
|
|
| <a id="clusteragenttokendescription"></a>`description` | [`String`](#string) | Description of the token. |
|
|
| <a id="clusteragenttokenid"></a>`id` | [`ClustersAgentTokenID!`](#clustersagenttokenid) | Global ID of the token. |
|
|
| <a id="clusteragenttokenlastusedat"></a>`lastUsedAt` | [`Time`](#time) | Timestamp the token was last used. |
|
|
| <a id="clusteragenttokenname"></a>`name` | [`String`](#string) | Name given to the token. |
|
|
| <a id="clusteragenttokenstatus"></a>`status` | [`AgentTokenStatus`](#agenttokenstatus) | Current status of the token. |
|
|
|
|
### `CodeCoverageActivity`
|
|
|
|
Represents the code coverage activity for a group.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="codecoverageactivityaveragecoverage"></a>`averageCoverage` | [`Float`](#float) | Average percentage of the different code coverage results available for the group. |
|
|
| <a id="codecoverageactivitycoveragecount"></a>`coverageCount` | [`Int`](#int) | Number of different code coverage results available for the group. |
|
|
| <a id="codecoverageactivitydate"></a>`date` | [`Date!`](#date) | Date when the code coverage was created. |
|
|
| <a id="codecoverageactivityprojectcount"></a>`projectCount` | [`Int`](#int) | Number of projects with code coverage results for the group. |
|
|
|
|
### `CodeCoverageSummary`
|
|
|
|
Represents the code coverage summary for a project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="codecoveragesummaryaveragecoverage"></a>`averageCoverage` | [`Float`](#float) | Average percentage of the different code coverage results available for the project. |
|
|
| <a id="codecoveragesummarycoveragecount"></a>`coverageCount` | [`Int`](#int) | Number of different code coverage results available. |
|
|
| <a id="codecoveragesummarylastupdatedon"></a>`lastUpdatedOn` | [`Date`](#date) | Latest date when the code coverage was created for the project. |
|
|
|
|
### `CodeQualityDegradation`
|
|
|
|
Represents a code quality degradation on the pipeline.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="codequalitydegradationdescription"></a>`description` | [`String!`](#string) | Description of the code quality degradation. |
|
|
| <a id="codequalitydegradationfingerprint"></a>`fingerprint` | [`String!`](#string) | Unique fingerprint to identify the code quality degradation. For example, an MD5 hash. |
|
|
| <a id="codequalitydegradationline"></a>`line` | [`Int!`](#int) | Line on which the code quality degradation occurred. |
|
|
| <a id="codequalitydegradationpath"></a>`path` | [`String!`](#string) | Relative path to the file containing the code quality degradation. |
|
|
| <a id="codequalitydegradationseverity"></a>`severity` | [`CodeQualityDegradationSeverity!`](#codequalitydegradationseverity) | Status of the degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO, UNKNOWN). |
|
|
|
|
### `Commit`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="commitauthor"></a>`author` | [`UserCore`](#usercore) | Author of the commit. |
|
|
| <a id="commitauthoremail"></a>`authorEmail` | [`String`](#string) | Commit author's email. |
|
|
| <a id="commitauthorgravatar"></a>`authorGravatar` | [`String`](#string) | Commit authors gravatar. |
|
|
| <a id="commitauthorname"></a>`authorName` | [`String`](#string) | Commit authors name. |
|
|
| <a id="commitauthoreddate"></a>`authoredDate` | [`Time`](#time) | Timestamp of when the commit was authored. |
|
|
| <a id="commitdescription"></a>`description` | [`String`](#string) | Description of the commit message. |
|
|
| <a id="commitdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="commitfulltitle"></a>`fullTitle` | [`String`](#string) | Full title of the commit message. |
|
|
| <a id="commitfulltitlehtml"></a>`fullTitleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `full_title`. |
|
|
| <a id="commitid"></a>`id` | [`ID!`](#id) | ID (global ID) of the commit. |
|
|
| <a id="commitmessage"></a>`message` | [`String`](#string) | Raw commit message. |
|
|
| <a id="commitsha"></a>`sha` | [`String!`](#string) | SHA1 ID of the commit. |
|
|
| <a id="commitshortid"></a>`shortId` | [`String!`](#string) | Short SHA1 ID of the commit. |
|
|
| <a id="commitsignaturehtml"></a>`signatureHtml` | [`String`](#string) | Rendered HTML of the commit signature. |
|
|
| <a id="committitle"></a>`title` | [`String`](#string) | Title of the commit message. |
|
|
| <a id="committitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. |
|
|
| <a id="commitwebpath"></a>`webPath` | [`String!`](#string) | Web path of the commit. |
|
|
| <a id="commitweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the commit. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Commit.pipelines`
|
|
|
|
Pipelines of the commit ordered latest first.
|
|
|
|
Returns [`PipelineConnection`](#pipelineconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="commitpipelinesref"></a>`ref` | [`String`](#string) | Filter pipelines by the ref they are run for. |
|
|
| <a id="commitpipelinesscope"></a>`scope` | [`PipelineScopeEnum`](#pipelinescopeenum) | Filter pipelines by scope. |
|
|
| <a id="commitpipelinessha"></a>`sha` | [`String`](#string) | Filter pipelines by the sha of the commit they are run for. |
|
|
| <a id="commitpipelinessource"></a>`source` | [`String`](#string) | Filter pipelines by their source. |
|
|
| <a id="commitpipelinesstatus"></a>`status` | [`PipelineStatusEnum`](#pipelinestatusenum) | Filter pipelines by their status. |
|
|
| <a id="commitpipelinesupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Pipelines updated after this date. |
|
|
| <a id="commitpipelinesupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Pipelines updated before this date. |
|
|
| <a id="commitpipelinesusername"></a>`username` | [`String`](#string) | Filter pipelines by the user that triggered the pipeline. |
|
|
|
|
### `ComplianceFramework`
|
|
|
|
Represents a ComplianceFramework associated with a Project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="complianceframeworkcolor"></a>`color` | [`String!`](#string) | Hexadecimal representation of compliance framework's label color. |
|
|
| <a id="complianceframeworkdescription"></a>`description` | [`String!`](#string) | Description of the compliance framework. |
|
|
| <a id="complianceframeworkid"></a>`id` | [`ID!`](#id) | Compliance framework ID. |
|
|
| <a id="complianceframeworkname"></a>`name` | [`String!`](#string) | Name of the compliance framework. |
|
|
| <a id="complianceframeworkpipelineconfigurationfullpath"></a>`pipelineConfigurationFullPath` | [`String`](#string) | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. |
|
|
|
|
### `ComplianceViolation`
|
|
|
|
Compliance violation associated with a merged merge request.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="complianceviolationid"></a>`id` | [`ID!`](#id) | Compliance violation ID. |
|
|
| <a id="complianceviolationmergerequest"></a>`mergeRequest` | [`MergeRequest!`](#mergerequest) | Merge request the compliance violation occurred in. |
|
|
| <a id="complianceviolationreason"></a>`reason` | [`ComplianceViolationReason!`](#complianceviolationreason) | Reason the compliance violation occurred. |
|
|
| <a id="complianceviolationseveritylevel"></a>`severityLevel` | [`ComplianceViolationSeverity!`](#complianceviolationseverity) | Severity of the compliance violation. |
|
|
| <a id="complianceviolationviolatinguser"></a>`violatingUser` | [`UserCore!`](#usercore) | User suspected of causing the compliance violation. |
|
|
|
|
### `ComposerMetadata`
|
|
|
|
Composer metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="composermetadatacomposerjson"></a>`composerJson` | [`PackageComposerJsonType!`](#packagecomposerjsontype) | Data of the Composer JSON file. |
|
|
| <a id="composermetadatatargetsha"></a>`targetSha` | [`String!`](#string) | Target SHA of the package. |
|
|
|
|
### `ConanFileMetadata`
|
|
|
|
Conan file metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="conanfilemetadataconanfiletype"></a>`conanFileType` | [`ConanMetadatumFileTypeEnum!`](#conanmetadatumfiletypeenum) | Type of the Conan file. |
|
|
| <a id="conanfilemetadataconanpackagereference"></a>`conanPackageReference` | [`String`](#string) | Reference of the Conan package. |
|
|
| <a id="conanfilemetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="conanfilemetadataid"></a>`id` | [`PackagesConanFileMetadatumID!`](#packagesconanfilemetadatumid) | ID of the metadatum. |
|
|
| <a id="conanfilemetadatapackagerevision"></a>`packageRevision` | [`String`](#string) | Revision of the package. |
|
|
| <a id="conanfilemetadatareciperevision"></a>`recipeRevision` | [`String!`](#string) | Revision of the Conan recipe. |
|
|
| <a id="conanfilemetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
|
|
### `ConanMetadata`
|
|
|
|
Conan metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="conanmetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="conanmetadataid"></a>`id` | [`PackagesConanMetadatumID!`](#packagesconanmetadatumid) | ID of the metadatum. |
|
|
| <a id="conanmetadatapackagechannel"></a>`packageChannel` | [`String!`](#string) | Channel of the Conan package. |
|
|
| <a id="conanmetadatapackageusername"></a>`packageUsername` | [`String!`](#string) | Username of the Conan package. |
|
|
| <a id="conanmetadatarecipe"></a>`recipe` | [`String!`](#string) | Recipe of the Conan package. |
|
|
| <a id="conanmetadatarecipepath"></a>`recipePath` | [`String!`](#string) | Recipe path of the Conan package. |
|
|
| <a id="conanmetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
|
|
### `ConnectedAgent`
|
|
|
|
Connection details for an Agent.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="connectedagentconnectedat"></a>`connectedAt` | [`Time`](#time) | When the connection was established. |
|
|
| <a id="connectedagentconnectionid"></a>`connectionId` | [`BigInt`](#bigint) | ID of the connection. |
|
|
| <a id="connectedagentmetadata"></a>`metadata` | [`AgentMetadata`](#agentmetadata) | Information about the Agent. |
|
|
|
|
### `ContainerExpirationPolicy`
|
|
|
|
A tag expiration policy designed to keep only the images that matter most.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerexpirationpolicycadence"></a>`cadence` | [`ContainerExpirationPolicyCadenceEnum!`](#containerexpirationpolicycadenceenum) | This container expiration policy schedule. |
|
|
| <a id="containerexpirationpolicycreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the container expiration policy was created. |
|
|
| <a id="containerexpirationpolicyenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether this container expiration policy is enabled. |
|
|
| <a id="containerexpirationpolicykeepn"></a>`keepN` | [`ContainerExpirationPolicyKeepEnum`](#containerexpirationpolicykeepenum) | Number of tags to retain. |
|
|
| <a id="containerexpirationpolicynameregex"></a>`nameRegex` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will expire. |
|
|
| <a id="containerexpirationpolicynameregexkeep"></a>`nameRegexKeep` | [`UntrustedRegexp`](#untrustedregexp) | Tags with names matching this regex pattern will be preserved. |
|
|
| <a id="containerexpirationpolicynextrunat"></a>`nextRunAt` | [`Time`](#time) | Next time that this container expiration policy will get executed. |
|
|
| <a id="containerexpirationpolicyolderthan"></a>`olderThan` | [`ContainerExpirationPolicyOlderThanEnum`](#containerexpirationpolicyolderthanenum) | Tags older that this will expire. |
|
|
| <a id="containerexpirationpolicyupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the container expiration policy was updated. |
|
|
|
|
### `ContainerRepository`
|
|
|
|
A container repository.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerrepositorycandelete"></a>`canDelete` | [`Boolean!`](#boolean) | Can the current user delete the container repository. |
|
|
| <a id="containerrepositorycreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp when the container repository was created. |
|
|
| <a id="containerrepositoryexpirationpolicycleanupstatus"></a>`expirationPolicyCleanupStatus` | [`ContainerRepositoryCleanupStatus`](#containerrepositorycleanupstatus) | Tags cleanup status for the container repository. |
|
|
| <a id="containerrepositoryexpirationpolicystartedat"></a>`expirationPolicyStartedAt` | [`Time`](#time) | Timestamp when the cleanup done by the expiration policy was started on the container repository. |
|
|
| <a id="containerrepositoryid"></a>`id` | [`ID!`](#id) | ID of the container repository. |
|
|
| <a id="containerrepositorylastcleanupdeletedtagscount"></a>`lastCleanupDeletedTagsCount` | [`Int`](#int) | Number of deleted tags from the last cleanup. |
|
|
| <a id="containerrepositorylocation"></a>`location` | [`String!`](#string) | URL of the container repository. |
|
|
| <a id="containerrepositorymigrationstate"></a>`migrationState` | [`String!`](#string) | Migration state of the container repository. |
|
|
| <a id="containerrepositoryname"></a>`name` | [`String!`](#string) | Name of the container repository. |
|
|
| <a id="containerrepositorypath"></a>`path` | [`String!`](#string) | Path of the container repository. |
|
|
| <a id="containerrepositoryproject"></a>`project` | [`Project!`](#project) | Project of the container registry. |
|
|
| <a id="containerrepositorystatus"></a>`status` | [`ContainerRepositoryStatus`](#containerrepositorystatus) | Status of the container repository. |
|
|
| <a id="containerrepositorytagscount"></a>`tagsCount` | [`Int!`](#int) | Number of tags associated with this image. |
|
|
| <a id="containerrepositoryupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp when the container repository was updated. |
|
|
|
|
### `ContainerRepositoryDetails`
|
|
|
|
Details of a container repository.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerrepositorydetailscandelete"></a>`canDelete` | [`Boolean!`](#boolean) | Can the current user delete the container repository. |
|
|
| <a id="containerrepositorydetailscreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp when the container repository was created. |
|
|
| <a id="containerrepositorydetailsexpirationpolicycleanupstatus"></a>`expirationPolicyCleanupStatus` | [`ContainerRepositoryCleanupStatus`](#containerrepositorycleanupstatus) | Tags cleanup status for the container repository. |
|
|
| <a id="containerrepositorydetailsexpirationpolicystartedat"></a>`expirationPolicyStartedAt` | [`Time`](#time) | Timestamp when the cleanup done by the expiration policy was started on the container repository. |
|
|
| <a id="containerrepositorydetailsid"></a>`id` | [`ID!`](#id) | ID of the container repository. |
|
|
| <a id="containerrepositorydetailslastcleanupdeletedtagscount"></a>`lastCleanupDeletedTagsCount` | [`Int`](#int) | Number of deleted tags from the last cleanup. |
|
|
| <a id="containerrepositorydetailslocation"></a>`location` | [`String!`](#string) | URL of the container repository. |
|
|
| <a id="containerrepositorydetailsmigrationstate"></a>`migrationState` | [`String!`](#string) | Migration state of the container repository. |
|
|
| <a id="containerrepositorydetailsname"></a>`name` | [`String!`](#string) | Name of the container repository. |
|
|
| <a id="containerrepositorydetailspath"></a>`path` | [`String!`](#string) | Path of the container repository. |
|
|
| <a id="containerrepositorydetailsproject"></a>`project` | [`Project!`](#project) | Project of the container registry. |
|
|
| <a id="containerrepositorydetailssize"></a>`size` | [`Float`](#float) | Deduplicated size of the image repository in bytes. This is only available on GitLab.com for repositories created after `2021-11-04`. |
|
|
| <a id="containerrepositorydetailsstatus"></a>`status` | [`ContainerRepositoryStatus`](#containerrepositorystatus) | Status of the container repository. |
|
|
| <a id="containerrepositorydetailstagscount"></a>`tagsCount` | [`Int!`](#int) | Number of tags associated with this image. |
|
|
| <a id="containerrepositorydetailsupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp when the container repository was updated. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `ContainerRepositoryDetails.tags`
|
|
|
|
Tags of the container repository.
|
|
|
|
Returns [`ContainerRepositoryTagConnection`](#containerrepositorytagconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerrepositorydetailstagsname"></a>`name` | [`String`](#string) | Search by tag name. |
|
|
| <a id="containerrepositorydetailstagssort"></a>`sort` | [`ContainerRepositoryTagSort`](#containerrepositorytagsort) | Sort tags by these criteria. |
|
|
|
|
### `ContainerRepositoryTag`
|
|
|
|
A tag from a container repository.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="containerrepositorytagcandelete"></a>`canDelete` | [`Boolean!`](#boolean) | Can the current user delete this tag. |
|
|
| <a id="containerrepositorytagcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the tag was created. |
|
|
| <a id="containerrepositorytagdigest"></a>`digest` | [`String`](#string) | Digest of the tag. |
|
|
| <a id="containerrepositorytaglocation"></a>`location` | [`String!`](#string) | URL of the tag. |
|
|
| <a id="containerrepositorytagname"></a>`name` | [`String!`](#string) | Name of the tag. |
|
|
| <a id="containerrepositorytagpath"></a>`path` | [`String!`](#string) | Path of the tag. |
|
|
| <a id="containerrepositorytagrevision"></a>`revision` | [`String`](#string) | Revision of the tag. |
|
|
| <a id="containerrepositorytagshortrevision"></a>`shortRevision` | [`String`](#string) | Short revision of the tag. |
|
|
| <a id="containerrepositorytagtotalsize"></a>`totalSize` | [`BigInt`](#bigint) | Size of the tag. |
|
|
|
|
### `CoverageFuzzingCorpus`
|
|
|
|
Corpus for a coverage fuzzing job.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="coveragefuzzingcorpusid"></a>`id` | [`AppSecFuzzingCoverageCorpusID!`](#appsecfuzzingcoveragecorpusid) | ID of the corpus. |
|
|
| <a id="coveragefuzzingcorpuspackage"></a>`package` | [`PackageDetailsType!`](#packagedetailstype) | Package of the corpus. |
|
|
|
|
### `CurrentLicense`
|
|
|
|
Represents the current license.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="currentlicenseactivatedat"></a>`activatedAt` | [`Date`](#date) | Date when the license was activated. |
|
|
| <a id="currentlicensebillableuserscount"></a>`billableUsersCount` | [`Int`](#int) | Number of billable users on the system. |
|
|
| <a id="currentlicenseblockchangesat"></a>`blockChangesAt` | [`Date`](#date) | Date, including grace period, when licensed features will be blocked. |
|
|
| <a id="currentlicensecompany"></a>`company` | [`String`](#string) | Company of the licensee. |
|
|
| <a id="currentlicensecreatedat"></a>`createdAt` | [`Date`](#date) | Date when the license was added. |
|
|
| <a id="currentlicenseemail"></a>`email` | [`String`](#string) | Email of the licensee. |
|
|
| <a id="currentlicenseexpiresat"></a>`expiresAt` | [`Date`](#date) | Date when the license expires. |
|
|
| <a id="currentlicenseid"></a>`id` | [`ID!`](#id) | ID of the license extracted from the license data. |
|
|
| <a id="currentlicenselastsync"></a>`lastSync` | [`Time`](#time) | Date when the license was last synced. |
|
|
| <a id="currentlicensemaximumusercount"></a>`maximumUserCount` | [`Int`](#int) | Highest number of billable users on the system during the term of the current license. |
|
|
| <a id="currentlicensename"></a>`name` | [`String`](#string) | Name of the licensee. |
|
|
| <a id="currentlicenseplan"></a>`plan` | [`String!`](#string) | Name of the subscription plan. |
|
|
| <a id="currentlicensestartsat"></a>`startsAt` | [`Date`](#date) | Date when the license started. |
|
|
| <a id="currentlicensetype"></a>`type` | [`String!`](#string) | Type of the license. |
|
|
| <a id="currentlicenseusersinlicensecount"></a>`usersInLicenseCount` | [`Int`](#int) | Number of paid users in the license. |
|
|
| <a id="currentlicenseusersoverlicensecount"></a>`usersOverLicenseCount` | [`Int`](#int) | Number of users over the paid users in the license. |
|
|
|
|
### `CustomEmoji`
|
|
|
|
A custom emoji uploaded by user.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customemojiexternal"></a>`external` | [`Boolean!`](#boolean) | Whether the emoji is an external link. |
|
|
| <a id="customemojiid"></a>`id` | [`CustomEmojiID!`](#customemojiid) | ID of the emoji. |
|
|
| <a id="customemojiname"></a>`name` | [`String!`](#string) | Name of the emoji. |
|
|
| <a id="customemojiurl"></a>`url` | [`String!`](#string) | Link to file of the emoji. |
|
|
|
|
### `CustomerRelationsContact`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customerrelationscontactactive"></a>`active` | [`Boolean!`](#boolean) | State of the contact. |
|
|
| <a id="customerrelationscontactcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp the contact was created. |
|
|
| <a id="customerrelationscontactdescription"></a>`description` | [`String`](#string) | Description of or notes for the contact. |
|
|
| <a id="customerrelationscontactemail"></a>`email` | [`String`](#string) | Email address of the contact. |
|
|
| <a id="customerrelationscontactfirstname"></a>`firstName` | [`String!`](#string) | First name of the contact. |
|
|
| <a id="customerrelationscontactid"></a>`id` | [`ID!`](#id) | Internal ID of the contact. |
|
|
| <a id="customerrelationscontactlastname"></a>`lastName` | [`String!`](#string) | Last name of the contact. |
|
|
| <a id="customerrelationscontactorganization"></a>`organization` | [`CustomerRelationsOrganization`](#customerrelationsorganization) | Organization of the contact. |
|
|
| <a id="customerrelationscontactphone"></a>`phone` | [`String`](#string) | Phone number of the contact. |
|
|
| <a id="customerrelationscontactupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp the contact was last updated. |
|
|
|
|
### `CustomerRelationsOrganization`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="customerrelationsorganizationactive"></a>`active` | [`Boolean!`](#boolean) | State of the organization. |
|
|
| <a id="customerrelationsorganizationcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp the organization was created. |
|
|
| <a id="customerrelationsorganizationdefaultrate"></a>`defaultRate` | [`Float`](#float) | Standard billing rate for the organization. |
|
|
| <a id="customerrelationsorganizationdescription"></a>`description` | [`String`](#string) | Description of or notes for the organization. |
|
|
| <a id="customerrelationsorganizationid"></a>`id` | [`ID!`](#id) | Internal ID of the organization. |
|
|
| <a id="customerrelationsorganizationname"></a>`name` | [`String!`](#string) | Name of the organization. |
|
|
| <a id="customerrelationsorganizationupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp the organization was last updated. |
|
|
|
|
### `DastProfile`
|
|
|
|
Represents a DAST Profile.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastprofilebranch"></a>`branch` | [`DastProfileBranch`](#dastprofilebranch) | Associated branch. |
|
|
| <a id="dastprofiledastprofileschedule"></a>`dastProfileSchedule` | [`DastProfileSchedule`](#dastprofileschedule) | Associated profile schedule. |
|
|
| <a id="dastprofiledastscannerprofile"></a>`dastScannerProfile` | [`DastScannerProfile`](#dastscannerprofile) | Associated scanner profile. |
|
|
| <a id="dastprofiledastsiteprofile"></a>`dastSiteProfile` | [`DastSiteProfile`](#dastsiteprofile) | Associated site profile. |
|
|
| <a id="dastprofiledescription"></a>`description` | [`String`](#string) | Description of the scan. |
|
|
| <a id="dastprofileeditpath"></a>`editPath` | [`String`](#string) | Relative web path to the edit page of a profile. |
|
|
| <a id="dastprofileid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the profile. |
|
|
| <a id="dastprofilename"></a>`name` | [`String`](#string) | Name of the profile. |
|
|
|
|
### `DastProfileBranch`
|
|
|
|
Represents a DAST Profile Branch.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastprofilebranchexists"></a>`exists` | [`Boolean`](#boolean) | Indicates whether or not the branch exists. |
|
|
| <a id="dastprofilebranchname"></a>`name` | [`String`](#string) | Name of the branch. |
|
|
|
|
### `DastProfileCadence`
|
|
|
|
Represents DAST Profile Cadence.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastprofilecadenceduration"></a>`duration` | [`Int`](#int) | Duration of the DAST profile cadence. |
|
|
| <a id="dastprofilecadenceunit"></a>`unit` | [`DastProfileCadenceUnit`](#dastprofilecadenceunit) | Unit for the duration of DAST profile cadence. |
|
|
|
|
### `DastProfileSchedule`
|
|
|
|
Represents a DAST profile schedule.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastprofilescheduleactive"></a>`active` | [`Boolean`](#boolean) | Status of the DAST profile schedule. |
|
|
| <a id="dastprofileschedulecadence"></a>`cadence` | [`DastProfileCadence`](#dastprofilecadence) | Cadence of the DAST profile schedule. |
|
|
| <a id="dastprofilescheduleid"></a>`id` | [`DastProfileScheduleID!`](#dastprofilescheduleid) | ID of the DAST profile schedule. |
|
|
| <a id="dastprofileschedulenextrunat"></a>`nextRunAt` | [`Time`](#time) | Next run time of the DAST profile schedule in the given timezone. |
|
|
| <a id="dastprofilescheduleownervalid"></a>`ownerValid` | [`Boolean`](#boolean) | Status of the current owner of the DAST profile schedule. |
|
|
| <a id="dastprofileschedulestartsat"></a>`startsAt` | [`Time`](#time) | Start time of the DAST profile schedule in the given timezone. |
|
|
| <a id="dastprofilescheduletimezone"></a>`timezone` | [`String`](#string) | Time zone of the start time of the DAST profile schedule. |
|
|
|
|
### `DastScannerProfile`
|
|
|
|
Represents a DAST scanner profile.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastscannerprofileeditpath"></a>`editPath` | [`String`](#string) | Relative web path to the edit page of a scanner profile. |
|
|
| <a id="dastscannerprofileid"></a>`id` | [`DastScannerProfileID!`](#dastscannerprofileid) | ID of the DAST scanner profile. |
|
|
| <a id="dastscannerprofileprofilename"></a>`profileName` | [`String`](#string) | Name of the DAST scanner profile. |
|
|
| <a id="dastscannerprofilereferencedinsecuritypolicies"></a>`referencedInSecurityPolicies` | [`[String!]`](#string) | List of security policy names that are referencing given project. |
|
|
| <a id="dastscannerprofilescantype"></a>`scanType` | [`DastScanTypeEnum`](#dastscantypeenum) | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. |
|
|
| <a id="dastscannerprofileshowdebugmessages"></a>`showDebugMessages` | [`Boolean!`](#boolean) | Indicates if debug messages should be included in DAST console output. True to include the debug messages. |
|
|
| <a id="dastscannerprofilespidertimeout"></a>`spiderTimeout` | [`Int`](#int) | Maximum number of minutes allowed for the spider to traverse the site. |
|
|
| <a id="dastscannerprofiletargettimeout"></a>`targetTimeout` | [`Int`](#int) | Maximum number of seconds allowed for the site under test to respond to a request. |
|
|
| <a id="dastscannerprofileuseajaxspider"></a>`useAjaxSpider` | [`Boolean!`](#boolean) | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. |
|
|
|
|
### `DastSiteProfile`
|
|
|
|
Represents a DAST Site Profile.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsiteprofileauth"></a>`auth` | [`DastSiteProfileAuth`](#dastsiteprofileauth) | Target authentication details. |
|
|
| <a id="dastsiteprofileeditpath"></a>`editPath` | [`String`](#string) | Relative web path to the edit page of a site profile. |
|
|
| <a id="dastsiteprofileexcludedurls"></a>`excludedUrls` | [`[String!]`](#string) | URLs to skip during an authenticated scan. |
|
|
| <a id="dastsiteprofileid"></a>`id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile. |
|
|
| <a id="dastsiteprofilenormalizedtargeturl"></a>`normalizedTargetUrl` | [`String`](#string) | Normalized URL of the target to be scanned. |
|
|
| <a id="dastsiteprofileprofilename"></a>`profileName` | [`String`](#string) | Name of the site profile. |
|
|
| <a id="dastsiteprofilereferencedinsecuritypolicies"></a>`referencedInSecurityPolicies` | [`[String!]`](#string) | List of security policy names that are referencing given project. |
|
|
| <a id="dastsiteprofilerequestheaders"></a>`requestHeaders` | [`String`](#string) | Comma-separated list of request header names and values to be added to every request made by DAST. |
|
|
| <a id="dastsiteprofilescanmethod"></a>`scanMethod` | [`DastScanMethodType`](#dastscanmethodtype) | Scan method used by the scanner. Always returns `null` if `dast_api_scanner` feature flag is disabled. |
|
|
| <a id="dastsiteprofiletargettype"></a>`targetType` | [`DastTargetTypeEnum`](#dasttargettypeenum) | Type of target to be scanned. |
|
|
| <a id="dastsiteprofiletargeturl"></a>`targetUrl` | [`String`](#string) | URL of the target to be scanned. |
|
|
| <a id="dastsiteprofileuserpermissions"></a>`userPermissions` | [`DastSiteProfilePermissions!`](#dastsiteprofilepermissions) | Permissions for the current user on the resource. |
|
|
| <a id="dastsiteprofilevalidationstatus"></a>`validationStatus` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | Current validation status of the site profile. |
|
|
|
|
### `DastSiteProfileAuth`
|
|
|
|
Input type for DastSiteProfile authentication.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsiteprofileauthenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether authentication is enabled. |
|
|
| <a id="dastsiteprofileauthpassword"></a>`password` | [`String`](#string) | Redacted password to authenticate with on the target website. |
|
|
| <a id="dastsiteprofileauthpasswordfield"></a>`passwordField` | [`String`](#string) | Name of password field at the sign-in HTML form. |
|
|
| <a id="dastsiteprofileauthsubmitfield"></a>`submitField` | [`String`](#string) | Name or ID of sign-in submit button at the sign-in HTML form. |
|
|
| <a id="dastsiteprofileauthurl"></a>`url` | [`String`](#string) | The URL of the page containing the sign-in HTML form on the target website. |
|
|
| <a id="dastsiteprofileauthusername"></a>`username` | [`String`](#string) | Username to authenticate with on the target website. |
|
|
| <a id="dastsiteprofileauthusernamefield"></a>`usernameField` | [`String`](#string) | Name of username field at the sign-in HTML form. |
|
|
|
|
### `DastSiteProfilePermissions`
|
|
|
|
Check permissions for the current user on site profile.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsiteprofilepermissionscreateondemanddastscan"></a>`createOnDemandDastScan` | [`Boolean!`](#boolean) | Indicates the user can perform `create_on_demand_dast_scan` on this resource. |
|
|
|
|
### `DastSiteValidation`
|
|
|
|
Represents a DAST Site Validation.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsitevalidationid"></a>`id` | [`DastSiteValidationID!`](#dastsitevalidationid) | Global ID of the site validation. |
|
|
| <a id="dastsitevalidationnormalizedtargeturl"></a>`normalizedTargetUrl` | [`String`](#string) | Normalized URL of the target to be validated. |
|
|
| <a id="dastsitevalidationstatus"></a>`status` | [`DastSiteProfileValidationStatusEnum!`](#dastsiteprofilevalidationstatusenum) | Status of the site validation. |
|
|
|
|
### `DeleteJobsResponse`
|
|
|
|
The response from the AdminSidekiqQueuesDeleteJobs mutation.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="deletejobsresponsecompleted"></a>`completed` | [`Boolean`](#boolean) | Whether or not the entire queue was processed in time; if not, retrying the same request is safe. |
|
|
| <a id="deletejobsresponsedeletedjobs"></a>`deletedJobs` | [`Int`](#int) | Number of matching jobs deleted. |
|
|
| <a id="deletejobsresponsequeuesize"></a>`queueSize` | [`Int`](#int) | Queue size after processing. |
|
|
|
|
### `DependencyProxyBlob`
|
|
|
|
Dependency proxy blob.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dependencyproxyblobcreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="dependencyproxyblobfilename"></a>`fileName` | [`String!`](#string) | Name of the blob. |
|
|
| <a id="dependencyproxyblobsize"></a>`size` | [`String!`](#string) | Size of the blob file. |
|
|
| <a id="dependencyproxyblobupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
|
|
### `DependencyProxyImageTtlGroupPolicy`
|
|
|
|
Group-level Dependency Proxy TTL policy settings.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dependencyproxyimagettlgrouppolicycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of creation. |
|
|
| <a id="dependencyproxyimagettlgrouppolicyenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether the policy is enabled or disabled. |
|
|
| <a id="dependencyproxyimagettlgrouppolicyttl"></a>`ttl` | [`Int`](#int) | Number of days to retain a cached image file. |
|
|
| <a id="dependencyproxyimagettlgrouppolicyupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp of the most recent update. |
|
|
|
|
### `DependencyProxyManifest`
|
|
|
|
Dependency proxy manifest.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dependencyproxymanifestcreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="dependencyproxymanifestdigest"></a>`digest` | [`String!`](#string) | Digest of the manifest. |
|
|
| <a id="dependencyproxymanifestfilename"></a>`fileName` | [`String!`](#string) | Name of the manifest. |
|
|
| <a id="dependencyproxymanifestid"></a>`id` | [`DependencyProxyManifestID!`](#dependencyproxymanifestid) | ID of the manifest. |
|
|
| <a id="dependencyproxymanifestimagename"></a>`imageName` | [`String!`](#string) | Name of the image. |
|
|
| <a id="dependencyproxymanifestsize"></a>`size` | [`String!`](#string) | Size of the manifest file. |
|
|
| <a id="dependencyproxymanifeststatus"></a>`status` | [`DependencyProxyManifestStatus!`](#dependencyproxymanifeststatus) | Status of the manifest (default, pending_destruction, processing, error). |
|
|
| <a id="dependencyproxymanifestupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
|
|
### `DependencyProxySetting`
|
|
|
|
Group-level Dependency Proxy settings.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dependencyproxysettingenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether the dependency proxy is enabled for the group. |
|
|
|
|
### `Design`
|
|
|
|
A single design.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designdiffrefs"></a>`diffRefs` | [`DiffRefs!`](#diffrefs) | Diff refs for this design. |
|
|
| <a id="designdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="designevent"></a>`event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. |
|
|
| <a id="designfilename"></a>`filename` | [`String!`](#string) | Filename of the design. |
|
|
| <a id="designfullpath"></a>`fullPath` | [`String!`](#string) | Full path to the design file. |
|
|
| <a id="designid"></a>`id` | [`ID!`](#id) | ID of this design. |
|
|
| <a id="designimage"></a>`image` | [`String!`](#string) | URL of the full-sized image. |
|
|
| <a id="designimagev432x230"></a>`imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. |
|
|
| <a id="designissue"></a>`issue` | [`Issue!`](#issue) | Issue the design belongs to. |
|
|
| <a id="designnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="designnotescount"></a>`notesCount` | [`Int!`](#int) | Total count of user-created notes for this design. |
|
|
| <a id="designproject"></a>`project` | [`Project!`](#project) | Project the design belongs to. |
|
|
| <a id="designweburl"></a>`webUrl` | [`String!`](#string) | URL of the design. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Design.currentUserTodos`
|
|
|
|
To-do items for the current user.
|
|
|
|
Returns [`TodoConnection!`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designcurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. |
|
|
|
|
##### `Design.versions`
|
|
|
|
All versions related to this design ordered newest first.
|
|
|
|
Returns [`DesignVersionConnection!`](#designversionconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designversionsearlierorequaltoid"></a>`earlierOrEqualToId` | [`DesignManagementVersionID`](#designmanagementversionid) | Global ID of the most recent acceptable version. |
|
|
| <a id="designversionsearlierorequaltosha"></a>`earlierOrEqualToSha` | [`String`](#string) | SHA256 of the most recent acceptable version. |
|
|
|
|
### `DesignAtVersion`
|
|
|
|
A design pinned to a specific version. The image field reflects the design as of the associated version.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designatversiondesign"></a>`design` | [`Design!`](#design) | Underlying design. |
|
|
| <a id="designatversiondiffrefs"></a>`diffRefs` | [`DiffRefs!`](#diffrefs) | Diff refs for this design. |
|
|
| <a id="designatversionevent"></a>`event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. |
|
|
| <a id="designatversionfilename"></a>`filename` | [`String!`](#string) | Filename of the design. |
|
|
| <a id="designatversionfullpath"></a>`fullPath` | [`String!`](#string) | Full path to the design file. |
|
|
| <a id="designatversionid"></a>`id` | [`ID!`](#id) | ID of this design. |
|
|
| <a id="designatversionimage"></a>`image` | [`String!`](#string) | URL of the full-sized image. |
|
|
| <a id="designatversionimagev432x230"></a>`imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. |
|
|
| <a id="designatversionissue"></a>`issue` | [`Issue!`](#issue) | Issue the design belongs to. |
|
|
| <a id="designatversionnotescount"></a>`notesCount` | [`Int!`](#int) | Total count of user-created notes for this design. |
|
|
| <a id="designatversionproject"></a>`project` | [`Project!`](#project) | Project the design belongs to. |
|
|
| <a id="designatversionversion"></a>`version` | [`DesignVersion!`](#designversion) | Version this design-at-versions is pinned to. |
|
|
|
|
### `DesignCollection`
|
|
|
|
A collection of designs.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designcollectioncopystate"></a>`copyState` | [`DesignCollectionCopyState`](#designcollectioncopystate) | Copy state of the design collection. |
|
|
| <a id="designcollectionissue"></a>`issue` | [`Issue!`](#issue) | Issue associated with the design collection. |
|
|
| <a id="designcollectionproject"></a>`project` | [`Project!`](#project) | Project associated with the design collection. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `DesignCollection.design`
|
|
|
|
Find a specific design.
|
|
|
|
Returns [`Design`](#design).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designcollectiondesignfilename"></a>`filename` | [`String`](#string) | Find a design by its filename. |
|
|
| <a id="designcollectiondesignid"></a>`id` | [`DesignManagementDesignID`](#designmanagementdesignid) | Find a design by its ID. |
|
|
|
|
##### `DesignCollection.designAtVersion`
|
|
|
|
Find a design as of a version.
|
|
|
|
Returns [`DesignAtVersion`](#designatversion).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designcollectiondesignatversionid"></a>`id` | [`DesignManagementDesignAtVersionID!`](#designmanagementdesignatversionid) | Global ID of the design at this version. |
|
|
|
|
##### `DesignCollection.designs`
|
|
|
|
All designs for the design collection.
|
|
|
|
Returns [`DesignConnection!`](#designconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designcollectiondesignsatversion"></a>`atVersion` | [`DesignManagementVersionID`](#designmanagementversionid) | Filters designs to only those that existed at the version. If argument is omitted or nil then all designs will reflect the latest version. |
|
|
| <a id="designcollectiondesignsfilenames"></a>`filenames` | [`[String!]`](#string) | Filters designs by their filename. |
|
|
| <a id="designcollectiondesignsids"></a>`ids` | [`[DesignManagementDesignID!]`](#designmanagementdesignid) | Filters designs by their ID. |
|
|
|
|
##### `DesignCollection.version`
|
|
|
|
A specific version.
|
|
|
|
Returns [`DesignVersion`](#designversion).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designcollectionversionid"></a>`id` | [`DesignManagementVersionID`](#designmanagementversionid) | Global ID of the version. |
|
|
| <a id="designcollectionversionsha"></a>`sha` | [`String`](#string) | SHA256 of a specific version. |
|
|
|
|
##### `DesignCollection.versions`
|
|
|
|
All versions related to all designs, ordered newest first.
|
|
|
|
Returns [`DesignVersionConnection!`](#designversionconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designcollectionversionsearlierorequaltoid"></a>`earlierOrEqualToId` | [`DesignManagementVersionID`](#designmanagementversionid) | Global ID of the most recent acceptable version. |
|
|
| <a id="designcollectionversionsearlierorequaltosha"></a>`earlierOrEqualToSha` | [`String`](#string) | SHA256 of the most recent acceptable version. |
|
|
|
|
### `DesignManagement`
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `DesignManagement.designAtVersion`
|
|
|
|
Find a design as of a version.
|
|
|
|
Returns [`DesignAtVersion`](#designatversion).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designmanagementdesignatversionid"></a>`id` | [`DesignManagementDesignAtVersionID!`](#designmanagementdesignatversionid) | Global ID of the design at this version. |
|
|
|
|
##### `DesignManagement.version`
|
|
|
|
Find a version.
|
|
|
|
Returns [`DesignVersion`](#designversion).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designmanagementversionid"></a>`id` | [`DesignManagementVersionID!`](#designmanagementversionid) | Global ID of the version. |
|
|
|
|
### `DesignVersion`
|
|
|
|
A specific version in which designs were added, modified or deleted.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designversionauthor"></a>`author` | [`UserCore!`](#usercore) | Author of the version. |
|
|
| <a id="designversioncreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the version was created. |
|
|
| <a id="designversiondesigns"></a>`designs` | [`DesignConnection!`](#designconnection) | All designs that were changed in the version. (see [Connections](#connections)) |
|
|
| <a id="designversionid"></a>`id` | [`ID!`](#id) | ID of the design version. |
|
|
| <a id="designversionsha"></a>`sha` | [`ID!`](#id) | SHA of the design version. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `DesignVersion.designAtVersion`
|
|
|
|
A particular design as of this version, provided it is visible at this version.
|
|
|
|
Returns [`DesignAtVersion!`](#designatversion).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designversiondesignatversiondesignid"></a>`designId` | [`DesignManagementDesignID`](#designmanagementdesignid) | ID of a specific design. |
|
|
| <a id="designversiondesignatversionfilename"></a>`filename` | [`String`](#string) | Filename of a specific design. |
|
|
| <a id="designversiondesignatversionid"></a>`id` | [`DesignManagementDesignAtVersionID`](#designmanagementdesignatversionid) | ID of the DesignAtVersion. |
|
|
|
|
##### `DesignVersion.designsAtVersion`
|
|
|
|
All designs that are visible at this version, as of this version.
|
|
|
|
Returns [`DesignAtVersionConnection!`](#designatversionconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designversiondesignsatversionfilenames"></a>`filenames` | [`[String!]`](#string) | Filters designs by their filename. |
|
|
| <a id="designversiondesignsatversionids"></a>`ids` | [`[DesignManagementDesignID!]`](#designmanagementdesignid) | Filters designs by their ID. |
|
|
|
|
### `DetailedStatus`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="detailedstatusaction"></a>`action` | [`StatusAction`](#statusaction) | Action information for the status. This includes method, button title, icon, path, and title. |
|
|
| <a id="detailedstatusdetailspath"></a>`detailsPath` | [`String`](#string) | Path of the details for the status. |
|
|
| <a id="detailedstatusfavicon"></a>`favicon` | [`String`](#string) | Favicon of the status. |
|
|
| <a id="detailedstatusgroup"></a>`group` | [`String`](#string) | Group of the status. |
|
|
| <a id="detailedstatushasdetails"></a>`hasDetails` | [`Boolean`](#boolean) | Indicates if the status has further details. |
|
|
| <a id="detailedstatusicon"></a>`icon` | [`String`](#string) | Icon of the status. |
|
|
| <a id="detailedstatusid"></a>`id` | [`String!`](#string) | ID for a detailed status. |
|
|
| <a id="detailedstatuslabel"></a>`label` | [`String`](#string) | Label of the status. |
|
|
| <a id="detailedstatustext"></a>`text` | [`String`](#string) | Text of the status. |
|
|
| <a id="detailedstatustooltip"></a>`tooltip` | [`String`](#string) | Tooltip associated with the status. |
|
|
|
|
### `DevopsAdoptionEnabledNamespace`
|
|
|
|
Enabled namespace for DevopsAdoption.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="devopsadoptionenablednamespacedisplaynamespace"></a>`displayNamespace` | [`Namespace`](#namespace) | Namespace where data should be displayed. |
|
|
| <a id="devopsadoptionenablednamespaceid"></a>`id` | [`ID!`](#id) | ID of the enabled namespace. |
|
|
| <a id="devopsadoptionenablednamespacelatestsnapshot"></a>`latestSnapshot` | [`DevopsAdoptionSnapshot`](#devopsadoptionsnapshot) | Metrics snapshot for previous month for the enabled namespace. |
|
|
| <a id="devopsadoptionenablednamespacenamespace"></a>`namespace` | [`Namespace`](#namespace) | Namespace which should be calculated. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `DevopsAdoptionEnabledNamespace.snapshots`
|
|
|
|
Data snapshots of the namespace.
|
|
|
|
Returns [`DevopsAdoptionSnapshotConnection`](#devopsadoptionsnapshotconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="devopsadoptionenablednamespacesnapshotsendtimeafter"></a>`endTimeAfter` | [`Time`](#time) | Filter to snapshots with month end after the provided date. |
|
|
| <a id="devopsadoptionenablednamespacesnapshotsendtimebefore"></a>`endTimeBefore` | [`Time`](#time) | Filter to snapshots with month end before the provided date. |
|
|
|
|
### `DevopsAdoptionSnapshot`
|
|
|
|
Snapshot.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="devopsadoptionsnapshotcodeownersusedcount"></a>`codeOwnersUsedCount` | [`Int`](#int) | Total number of projects with existing CODEOWNERS file. |
|
|
| <a id="devopsadoptionsnapshotcoveragefuzzingenabledcount"></a>`coverageFuzzingEnabledCount` | [`Int`](#int) | Total number of projects with enabled coverage fuzzing. |
|
|
| <a id="devopsadoptionsnapshotdastenabledcount"></a>`dastEnabledCount` | [`Int`](#int) | Total number of projects with enabled DAST. |
|
|
| <a id="devopsadoptionsnapshotdependencyscanningenabledcount"></a>`dependencyScanningEnabledCount` | [`Int`](#int) | Total number of projects with enabled dependency scanning. |
|
|
| <a id="devopsadoptionsnapshotdeploysucceeded"></a>`deploySucceeded` | [`Boolean!`](#boolean) | At least one deployment succeeded. |
|
|
| <a id="devopsadoptionsnapshotendtime"></a>`endTime` | [`Time!`](#time) | End time for the snapshot where the data points were collected. |
|
|
| <a id="devopsadoptionsnapshotissueopened"></a>`issueOpened` | [`Boolean!`](#boolean) | At least one issue was opened. |
|
|
| <a id="devopsadoptionsnapshotmergerequestapproved"></a>`mergeRequestApproved` | [`Boolean!`](#boolean) | At least one merge request was approved. |
|
|
| <a id="devopsadoptionsnapshotmergerequestopened"></a>`mergeRequestOpened` | [`Boolean!`](#boolean) | At least one merge request was opened. |
|
|
| <a id="devopsadoptionsnapshotpipelinesucceeded"></a>`pipelineSucceeded` | [`Boolean!`](#boolean) | At least one pipeline succeeded. |
|
|
| <a id="devopsadoptionsnapshotrecordedat"></a>`recordedAt` | [`Time!`](#time) | Time the snapshot was recorded. |
|
|
| <a id="devopsadoptionsnapshotrunnerconfigured"></a>`runnerConfigured` | [`Boolean!`](#boolean) | At least one runner was used. |
|
|
| <a id="devopsadoptionsnapshotsastenabledcount"></a>`sastEnabledCount` | [`Int`](#int) | Total number of projects with enabled SAST. |
|
|
| <a id="devopsadoptionsnapshotstarttime"></a>`startTime` | [`Time!`](#time) | Start time for the snapshot where the data points were collected. |
|
|
| <a id="devopsadoptionsnapshottotalprojectscount"></a>`totalProjectsCount` | [`Int`](#int) | Total number of projects. |
|
|
| <a id="devopsadoptionsnapshotvulnerabilitymanagementusedcount"></a>`vulnerabilityManagementUsedCount` | [`Int`](#int) | Total number of projects with vulnerability management used at least once. |
|
|
|
|
### `DiffPosition`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="diffpositiondiffrefs"></a>`diffRefs` | [`DiffRefs!`](#diffrefs) | Information about the branch, HEAD, and base at the time of commenting. |
|
|
| <a id="diffpositionfilepath"></a>`filePath` | [`String!`](#string) | Path of the file that was changed. |
|
|
| <a id="diffpositionheight"></a>`height` | [`Int`](#int) | Total height of the image. |
|
|
| <a id="diffpositionnewline"></a>`newLine` | [`Int`](#int) | Line on HEAD SHA that was changed. |
|
|
| <a id="diffpositionnewpath"></a>`newPath` | [`String`](#string) | Path of the file on the HEAD SHA. |
|
|
| <a id="diffpositionoldline"></a>`oldLine` | [`Int`](#int) | Line on start SHA that was changed. |
|
|
| <a id="diffpositionoldpath"></a>`oldPath` | [`String`](#string) | Path of the file on the start SHA. |
|
|
| <a id="diffpositionpositiontype"></a>`positionType` | [`DiffPositionType!`](#diffpositiontype) | Type of file the position refers to. |
|
|
| <a id="diffpositionwidth"></a>`width` | [`Int`](#int) | Total width of the image. |
|
|
| <a id="diffpositionx"></a>`x` | [`Int`](#int) | X position of the note. |
|
|
| <a id="diffpositiony"></a>`y` | [`Int`](#int) | Y position of the note. |
|
|
|
|
### `DiffRefs`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="diffrefsbasesha"></a>`baseSha` | [`String`](#string) | Merge base of the branch the comment was made on. |
|
|
| <a id="diffrefsheadsha"></a>`headSha` | [`String!`](#string) | SHA of the HEAD at the time the comment was made. |
|
|
| <a id="diffrefsstartsha"></a>`startSha` | [`String!`](#string) | SHA of the branch being compared against. |
|
|
|
|
### `DiffStats`
|
|
|
|
Changes to a single file.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="diffstatsadditions"></a>`additions` | [`Int!`](#int) | Number of lines added to this file. |
|
|
| <a id="diffstatsdeletions"></a>`deletions` | [`Int!`](#int) | Number of lines deleted from this file. |
|
|
| <a id="diffstatspath"></a>`path` | [`String!`](#string) | File path, relative to repository root. |
|
|
|
|
### `DiffStatsSummary`
|
|
|
|
Aggregated summary of changes.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="diffstatssummaryadditions"></a>`additions` | [`Int!`](#int) | Number of lines added. |
|
|
| <a id="diffstatssummarychanges"></a>`changes` | [`Int!`](#int) | Number of lines changed. |
|
|
| <a id="diffstatssummarydeletions"></a>`deletions` | [`Int!`](#int) | Number of lines deleted. |
|
|
| <a id="diffstatssummaryfilecount"></a>`fileCount` | [`Int!`](#int) | Number of files changed. |
|
|
|
|
### `Discussion`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="discussioncreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the discussion's creation. |
|
|
| <a id="discussionid"></a>`id` | [`DiscussionID!`](#discussionid) | ID of this discussion. |
|
|
| <a id="discussionnoteable"></a>`noteable` | [`NoteableType`](#noteabletype) | Object which the discussion belongs to. |
|
|
| <a id="discussionnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes in the discussion. (see [Connections](#connections)) |
|
|
| <a id="discussionreplyid"></a>`replyId` | [`DiscussionID!`](#discussionid) | ID used to reply to this discussion. |
|
|
| <a id="discussionresolvable"></a>`resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. |
|
|
| <a id="discussionresolved"></a>`resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. |
|
|
| <a id="discussionresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. |
|
|
| <a id="discussionresolvedby"></a>`resolvedBy` | [`UserCore`](#usercore) | User who resolved the object. |
|
|
|
|
### `Dora`
|
|
|
|
All information related to DORA metrics.
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Dora.metrics`
|
|
|
|
DORA metrics for the current group or project.
|
|
|
|
Returns [`[DoraMetric!]`](#dorametric).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dorametricsenddate"></a>`endDate` | [`Date`](#date) | Date range to end at. Default is the current date. |
|
|
| <a id="dorametricsenvironmenttier"></a>`environmentTier` | [`DeploymentTier`](#deploymenttier) | Deployment tier of the environments to return. Defaults to `PRODUCTION`. |
|
|
| <a id="dorametricsinterval"></a>`interval` | [`DoraMetricBucketingInterval`](#dorametricbucketinginterval) | How the metric should be aggregrated. Defaults to `DAILY`. In the case of `ALL`, the `date` field in the response will be `null`. |
|
|
| <a id="dorametricsmetric"></a>`metric` | [`DoraMetricType!`](#dorametrictype) | Type of metric to return. |
|
|
| <a id="dorametricsstartdate"></a>`startDate` | [`Date`](#date) | Date range to start from. Default is 3 months ago. |
|
|
|
|
### `DoraMetric`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dorametricdate"></a>`date` | [`String`](#string) | Date of the data point. |
|
|
| <a id="dorametricvalue"></a>`value` | [`Float`](#float) | Value of the data point. |
|
|
|
|
### `Environment`
|
|
|
|
Describes where code is deployed for a project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="environmentid"></a>`id` | [`ID!`](#id) | ID of the environment. |
|
|
| <a id="environmentlatestopenedmostseverealert"></a>`latestOpenedMostSevereAlert` | [`AlertManagementAlert`](#alertmanagementalert) | Most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. |
|
|
| <a id="environmentname"></a>`name` | [`String!`](#string) | Human-readable name of the environment. |
|
|
| <a id="environmentpath"></a>`path` | [`String!`](#string) | Path to the environment. |
|
|
| <a id="environmentstate"></a>`state` | [`String!`](#string) | State of the environment, for example: available/stopped. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Environment.metricsDashboard`
|
|
|
|
Metrics dashboard schema for the environment.
|
|
|
|
Returns [`MetricsDashboard`](#metricsdashboard).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="environmentmetricsdashboardpath"></a>`path` | [`String!`](#string) | Path to a file which defines a metrics dashboard eg: `"config/prometheus/common_metrics.yml"`. |
|
|
|
|
### `Epic`
|
|
|
|
Represents an epic.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicauthor"></a>`author` | [`UserCore!`](#usercore) | Author of the epic. |
|
|
| <a id="epicawardemoji"></a>`awardEmoji` | [`AwardEmojiConnection`](#awardemojiconnection) | List of award emojis associated with the epic. (see [Connections](#connections)) |
|
|
| <a id="epicblocked"></a>`blocked` | [`Boolean`](#boolean) | Indicates the epic is blocked. |
|
|
| <a id="epicblockedbycount"></a>`blockedByCount` | [`Int`](#int) | Count of epics blocking this epic. |
|
|
| <a id="epicblockedbyepics"></a>`blockedByEpics` | [`EpicConnection`](#epicconnection) | Epics blocking this epic. (see [Connections](#connections)) |
|
|
| <a id="epicblockingcount"></a>`blockingCount` | [`Int`](#int) | Count of epics that this epic is blocking. |
|
|
| <a id="epicclosedat"></a>`closedAt` | [`Time`](#time) | Timestamp of when the epic was closed. |
|
|
| <a id="epiccolor"></a>`color` | [`String!`](#string) | Color of the epic. Available only when feature flag `epic_color_highlight` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
|
|
| <a id="epicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if the epic is confidential. |
|
|
| <a id="epiccreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the epic was created. |
|
|
| <a id="epicdescendantcounts"></a>`descendantCounts` | [`EpicDescendantCount`](#epicdescendantcount) | Number of open and closed descendant epics and issues. |
|
|
| <a id="epicdescendantweightsum"></a>`descendantWeightSum` | [`EpicDescendantWeights`](#epicdescendantweights) | Total weight of open and closed issues in the epic and its descendants. |
|
|
| <a id="epicdescription"></a>`description` | [`String`](#string) | Description of the epic. |
|
|
| <a id="epicdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="epicdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="epicdownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes the epic has received. |
|
|
| <a id="epicduedate"></a>`dueDate` | [`Time`](#time) | Due date of the epic. |
|
|
| <a id="epicduedatefixed"></a>`dueDateFixed` | [`Time`](#time) | Fixed due date of the epic. |
|
|
| <a id="epicduedatefrominheritedsource"></a>`dueDateFromInheritedSource` | [`Time`](#time) | Inherited due date of the epic from child epics or milestones. |
|
|
| <a id="epicduedatefrommilestones"></a>`dueDateFromMilestones` | [`Time`](#time) | Inherited due date of the epic from milestones. |
|
|
| <a id="epicduedateisfixed"></a>`dueDateIsFixed` | [`Boolean`](#boolean) | Indicates if the due date has been manually set. |
|
|
| <a id="epicevents"></a>`events` | [`EventConnection`](#eventconnection) | List of events associated with the object. (see [Connections](#connections)) |
|
|
| <a id="epicgroup"></a>`group` | [`Group!`](#group) | Group to which the epic belongs. |
|
|
| <a id="epichaschildren"></a>`hasChildren` | [`Boolean!`](#boolean) | Indicates if the epic has children. |
|
|
| <a id="epichasissues"></a>`hasIssues` | [`Boolean!`](#boolean) | Indicates if the epic has direct issues. |
|
|
| <a id="epichasparent"></a>`hasParent` | [`Boolean!`](#boolean) | Indicates if the epic has a parent epic. |
|
|
| <a id="epichealthstatus"></a>`healthStatus` | [`EpicHealthStatus`](#epichealthstatus) | Current health status of the epic. |
|
|
| <a id="epicid"></a>`id` | [`ID!`](#id) | ID of the epic. |
|
|
| <a id="epiciid"></a>`iid` | [`ID!`](#id) | Internal ID of the epic. |
|
|
| <a id="epicissues"></a>`issues` | [`EpicIssueConnection`](#epicissueconnection) | A list of issues associated with the epic. (see [Connections](#connections)) |
|
|
| <a id="epiclabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels assigned to the epic. (see [Connections](#connections)) |
|
|
| <a id="epicnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="epicparent"></a>`parent` | [`Epic`](#epic) | Parent epic of the epic. |
|
|
| <a id="epicparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | List of participants for the epic. (see [Connections](#connections)) |
|
|
| <a id="epicrelationpath"></a>`relationPath` | [`String`](#string) | URI path of the epic-issue relationship. |
|
|
| <a id="epicrelativeposition"></a>`relativePosition` | [`Int`](#int) | Relative position of the epic in the epic tree. |
|
|
| <a id="epicstartdate"></a>`startDate` | [`Time`](#time) | Start date of the epic. |
|
|
| <a id="epicstartdatefixed"></a>`startDateFixed` | [`Time`](#time) | Fixed start date of the epic. |
|
|
| <a id="epicstartdatefrominheritedsource"></a>`startDateFromInheritedSource` | [`Time`](#time) | Inherited start date of the epic from child epics or milestones. |
|
|
| <a id="epicstartdatefrommilestones"></a>`startDateFromMilestones` | [`Time`](#time) | Inherited start date of the epic from milestones. |
|
|
| <a id="epicstartdateisfixed"></a>`startDateIsFixed` | [`Boolean`](#boolean) | Indicates if the start date has been manually set. |
|
|
| <a id="epicstate"></a>`state` | [`EpicState!`](#epicstate) | State of the epic. |
|
|
| <a id="epicsubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the epic. |
|
|
| <a id="epictextcolor"></a>`textColor` | [`String!`](#string) | Text color generated for the epic. Available only when feature flag `epic_color_highlight` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
|
|
| <a id="epictitle"></a>`title` | [`String`](#string) | Title of the epic. |
|
|
| <a id="epictitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. |
|
|
| <a id="epicupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp of when the epic was updated. |
|
|
| <a id="epicupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes the epic has received. |
|
|
| <a id="epicuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the epic. |
|
|
| <a id="epicusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes of the epic. |
|
|
| <a id="epicuserpermissions"></a>`userPermissions` | [`EpicPermissions!`](#epicpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="epicwebpath"></a>`webPath` | [`String!`](#string) | Web path of the epic. |
|
|
| <a id="epicweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the epic. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Epic.ancestors`
|
|
|
|
Ancestors (parents) of the epic.
|
|
|
|
Returns [`EpicConnection`](#epicconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicancestorsauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. |
|
|
| <a id="epicancestorsconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. |
|
|
| <a id="epicancestorscreatedafter"></a>`createdAfter` | [`Time`](#time) | Epics created after this date. |
|
|
| <a id="epicancestorscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Epics created before this date. |
|
|
| <a id="epicancestorsenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="epicancestorsiid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". |
|
|
| <a id="epicancestorsiidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. |
|
|
| <a id="epicancestorsiids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., `[1, 2]`. |
|
|
| <a id="epicancestorsin"></a>`in` | [`[IssuableSearchableField!]`](#issuablesearchablefield) | Specify the fields to perform the search in. Defaults to `[TITLE, DESCRIPTION]`. Requires the `search` argument. |
|
|
| <a id="epicancestorsincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include epics from ancestor groups. |
|
|
| <a id="epicancestorsincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. |
|
|
| <a id="epicancestorslabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. |
|
|
| <a id="epicancestorsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. |
|
|
| <a id="epicancestorsmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. |
|
|
| <a id="epicancestorsnot"></a>`not` | [`NegatedEpicFilterInput`](#negatedepicfilterinput) | Negated epic arguments. |
|
|
| <a id="epicancestorssearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="epicancestorssort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. |
|
|
| <a id="epicancestorsstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="epicancestorsstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. |
|
|
| <a id="epicancestorstimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="epicancestorstoplevelhierarchyonly"></a>`topLevelHierarchyOnly` | [`Boolean`](#boolean) | Filter epics with a top-level hierarchy. |
|
|
| <a id="epicancestorsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Epics updated after this date. |
|
|
| <a id="epicancestorsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Epics updated before this date. |
|
|
|
|
##### `Epic.children`
|
|
|
|
Children (sub-epics) of the epic.
|
|
|
|
Returns [`EpicConnection`](#epicconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicchildrenauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. |
|
|
| <a id="epicchildrenconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. |
|
|
| <a id="epicchildrencreatedafter"></a>`createdAfter` | [`Time`](#time) | Epics created after this date. |
|
|
| <a id="epicchildrencreatedbefore"></a>`createdBefore` | [`Time`](#time) | Epics created before this date. |
|
|
| <a id="epicchildrenenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="epicchildreniid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". |
|
|
| <a id="epicchildreniidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. |
|
|
| <a id="epicchildreniids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., `[1, 2]`. |
|
|
| <a id="epicchildrenin"></a>`in` | [`[IssuableSearchableField!]`](#issuablesearchablefield) | Specify the fields to perform the search in. Defaults to `[TITLE, DESCRIPTION]`. Requires the `search` argument. |
|
|
| <a id="epicchildrenincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include epics from ancestor groups. |
|
|
| <a id="epicchildrenincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. |
|
|
| <a id="epicchildrenlabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. |
|
|
| <a id="epicchildrenmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. |
|
|
| <a id="epicchildrenmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. |
|
|
| <a id="epicchildrennot"></a>`not` | [`NegatedEpicFilterInput`](#negatedepicfilterinput) | Negated epic arguments. |
|
|
| <a id="epicchildrensearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="epicchildrensort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. |
|
|
| <a id="epicchildrenstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="epicchildrenstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. |
|
|
| <a id="epicchildrentimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="epicchildrentoplevelhierarchyonly"></a>`topLevelHierarchyOnly` | [`Boolean`](#boolean) | Filter epics with a top-level hierarchy. |
|
|
| <a id="epicchildrenupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Epics updated after this date. |
|
|
| <a id="epicchildrenupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Epics updated before this date. |
|
|
|
|
##### `Epic.currentUserTodos`
|
|
|
|
To-do items for the current user.
|
|
|
|
Returns [`TodoConnection!`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epiccurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. |
|
|
|
|
##### `Epic.reference`
|
|
|
|
Internal reference of the epic. Returned in shortened format by default.
|
|
|
|
Returns [`String!`](#string).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicreferencefull"></a>`full` | [`Boolean`](#boolean) | Indicates if the reference should be returned in full. |
|
|
|
|
### `EpicBoard`
|
|
|
|
Represents an epic board.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicboardhidebackloglist"></a>`hideBacklogList` | [`Boolean`](#boolean) | Whether or not backlog list is hidden. |
|
|
| <a id="epicboardhideclosedlist"></a>`hideClosedList` | [`Boolean`](#boolean) | Whether or not closed list is hidden. |
|
|
| <a id="epicboardid"></a>`id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Global ID of the epic board. |
|
|
| <a id="epicboardlabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the board. (see [Connections](#connections)) |
|
|
| <a id="epicboardname"></a>`name` | [`String`](#string) | Name of the epic board. |
|
|
| <a id="epicboardwebpath"></a>`webPath` | [`String!`](#string) | Web path of the epic board. |
|
|
| <a id="epicboardweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the epic board. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `EpicBoard.lists`
|
|
|
|
Epic board lists.
|
|
|
|
Returns [`EpicListConnection`](#epiclistconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicboardlistsepicfilters"></a>`epicFilters` | [`EpicFilters`](#epicfilters) | Filters applied when getting epic metadata in the epic board list. |
|
|
| <a id="epicboardlistsid"></a>`id` | [`BoardsEpicListID`](#boardsepiclistid) | Find an epic board list by ID. |
|
|
|
|
### `EpicDescendantCount`
|
|
|
|
Counts of descendent epics.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicdescendantcountclosedepics"></a>`closedEpics` | [`Int`](#int) | Number of closed child epics. |
|
|
| <a id="epicdescendantcountclosedissues"></a>`closedIssues` | [`Int`](#int) | Number of closed epic issues. |
|
|
| <a id="epicdescendantcountopenedepics"></a>`openedEpics` | [`Int`](#int) | Number of opened child epics. |
|
|
| <a id="epicdescendantcountopenedissues"></a>`openedIssues` | [`Int`](#int) | Number of opened epic issues. |
|
|
|
|
### `EpicDescendantWeights`
|
|
|
|
Total weight of open and closed descendant issues.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicdescendantweightsclosedissues"></a>`closedIssues` | [`Int`](#int) | Total weight of completed (closed) issues in this epic, including epic descendants. |
|
|
| <a id="epicdescendantweightsopenedissues"></a>`openedIssues` | [`Int`](#int) | Total weight of opened issues in this epic, including epic descendants. |
|
|
|
|
### `EpicHealthStatus`
|
|
|
|
Health status of child issues.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epichealthstatusissuesatrisk"></a>`issuesAtRisk` | [`Int`](#int) | Number of issues at risk. |
|
|
| <a id="epichealthstatusissuesneedingattention"></a>`issuesNeedingAttention` | [`Int`](#int) | Number of issues that need attention. |
|
|
| <a id="epichealthstatusissuesontrack"></a>`issuesOnTrack` | [`Int`](#int) | Number of issues on track. |
|
|
|
|
### `EpicIssue`
|
|
|
|
Relationship between an epic and an issue.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicissuealertmanagementalert"></a>`alertManagementAlert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert associated to this issue. |
|
|
| <a id="epicissueassignees"></a>`assignees` | [`UserCoreConnection`](#usercoreconnection) | Assignees of the issue. (see [Connections](#connections)) |
|
|
| <a id="epicissueauthor"></a>`author` | [`UserCore!`](#usercore) | User that created the issue. |
|
|
| <a id="epicissueblocked"></a>`blocked` | [`Boolean!`](#boolean) | Indicates the issue is blocked. |
|
|
| <a id="epicissueblockedbycount"></a>`blockedByCount` | [`Int`](#int) | Count of issues blocking this issue. |
|
|
| <a id="epicissueblockedbyissues"></a>`blockedByIssues` | [`IssueConnection`](#issueconnection) | Issues blocking this issue. (see [Connections](#connections)) |
|
|
| <a id="epicissueblockingcount"></a>`blockingCount` | [`Int!`](#int) | Count of issues this issue is blocking. |
|
|
| <a id="epicissueclosedasduplicateof"></a>`closedAsDuplicateOf` | [`Issue`](#issue) | Issue this issue was closed as a duplicate of. |
|
|
| <a id="epicissueclosedat"></a>`closedAt` | [`Time`](#time) | Timestamp of when the issue was closed. |
|
|
| <a id="epicissueconfidential"></a>`confidential` | [`Boolean!`](#boolean) | Indicates the issue is confidential. |
|
|
| <a id="epicissuecreatenoteemail"></a>`createNoteEmail` | [`String`](#string) | User specific email address for the issue. |
|
|
| <a id="epicissuecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the issue was created. |
|
|
| <a id="epicissuecustomerrelationscontacts"></a>`customerRelationsContacts` | [`CustomerRelationsContactConnection`](#customerrelationscontactconnection) | Customer relations contacts of the issue. (see [Connections](#connections)) |
|
|
| <a id="epicissuedescription"></a>`description` | [`String`](#string) | Description of the issue. |
|
|
| <a id="epicissuedescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="epicissuedesigncollection"></a>`designCollection` | [`DesignCollection`](#designcollection) | Collection of design images associated with this issue. |
|
|
| <a id="epicissuediscussionlocked"></a>`discussionLocked` | [`Boolean!`](#boolean) | Indicates discussion is locked on the issue. |
|
|
| <a id="epicissuediscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="epicissuedownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes the issue has received. |
|
|
| <a id="epicissueduedate"></a>`dueDate` | [`Time`](#time) | Due date of the issue. |
|
|
| <a id="epicissueemailsdisabled"></a>`emailsDisabled` | [`Boolean!`](#boolean) | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. |
|
|
| <a id="epicissueepic"></a>`epic` | [`Epic`](#epic) | Epic to which this issue belongs. |
|
|
| <a id="epicissueepicissueid"></a>`epicIssueId` | [`ID!`](#id) | ID of the epic-issue relation. |
|
|
| <a id="epicissueescalationpolicy"></a>`escalationPolicy` | [`EscalationPolicyType`](#escalationpolicytype) | Escalation policy associated with the issue. Available for issues which support escalation. |
|
|
| <a id="epicissueescalationstatus"></a>`escalationStatus` | [`IssueEscalationStatus`](#issueescalationstatus) | Escalation status of the issue. |
|
|
| <a id="epicissuehealthstatus"></a>`healthStatus` | [`HealthStatus`](#healthstatus) | Current health status. |
|
|
| <a id="epicissuehidden"></a>`hidden` | [`Boolean`](#boolean) | Indicates the issue is hidden because the author has been banned. Will always return `null` if `ban_user_feature_flag` feature flag is disabled. |
|
|
| <a id="epicissuehumantimeestimate"></a>`humanTimeEstimate` | [`String`](#string) | Human-readable time estimate of the issue. |
|
|
| <a id="epicissuehumantotaltimespent"></a>`humanTotalTimeSpent` | [`String`](#string) | Human-readable total time reported as spent on the issue. |
|
|
| <a id="epicissueid"></a>`id` | [`ID`](#id) | Global ID of the epic-issue relation. |
|
|
| <a id="epicissueiid"></a>`iid` | [`ID!`](#id) | Internal ID of the issue. |
|
|
| <a id="epicissueiteration"></a>`iteration` | [`Iteration`](#iteration) | Iteration of the issue. |
|
|
| <a id="epicissuelabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the issue. (see [Connections](#connections)) |
|
|
| <a id="epicissuemergerequestscount"></a>`mergeRequestsCount` | [`Int!`](#int) | Number of merge requests that close the issue on merge. |
|
|
| <a id="epicissuemetricimages"></a>`metricImages` | [`[MetricImage!]`](#metricimage) | Metric images associated to the issue. |
|
|
| <a id="epicissuemilestone"></a>`milestone` | [`Milestone`](#milestone) | Milestone of the issue. |
|
|
| <a id="epicissuemoved"></a>`moved` | [`Boolean`](#boolean) | Indicates if issue got moved from other project. |
|
|
| <a id="epicissuemovedto"></a>`movedTo` | [`Issue`](#issue) | Updated Issue after it got moved to another project. |
|
|
| <a id="epicissuenotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="epicissueparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | List of participants in the issue. (see [Connections](#connections)) |
|
|
| <a id="epicissueprojectid"></a>`projectId` | [`Int!`](#int) | ID of the issue project. |
|
|
| <a id="epicissuerelationpath"></a>`relationPath` | [`String`](#string) | URI path of the epic-issue relation. |
|
|
| <a id="epicissuerelativeposition"></a>`relativePosition` | [`Int`](#int) | Relative position of the issue (used for positioning in epic tree and issue boards). |
|
|
| <a id="epicissueseverity"></a>`severity` | [`IssuableSeverity`](#issuableseverity) | Severity level of the incident. |
|
|
| <a id="epicissuesladueat"></a>`slaDueAt` | [`Time`](#time) | Timestamp of when the issue SLA expires. |
|
|
| <a id="epicissuestate"></a>`state` | [`IssueState!`](#issuestate) | State of the issue. |
|
|
| <a id="epicissuestatuspagepublishedincident"></a>`statusPagePublishedIncident` | [`Boolean`](#boolean) | Indicates whether an issue is published to the status page. |
|
|
| <a id="epicissuesubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the issue. |
|
|
| <a id="epicissuetaskcompletionstatus"></a>`taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Task completion status of the issue. |
|
|
| <a id="epicissuetimeestimate"></a>`timeEstimate` | [`Int!`](#int) | Time estimate of the issue. |
|
|
| <a id="epicissuetimelogs"></a>`timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the issue. (see [Connections](#connections)) |
|
|
| <a id="epicissuetitle"></a>`title` | [`String!`](#string) | Title of the issue. |
|
|
| <a id="epicissuetitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. |
|
|
| <a id="epicissuetotaltimespent"></a>`totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the issue. |
|
|
| <a id="epicissuetype"></a>`type` | [`IssueType`](#issuetype) | Type of the issue. |
|
|
| <a id="epicissueupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the issue was last updated. |
|
|
| <a id="epicissueupdatedby"></a>`updatedBy` | [`UserCore`](#usercore) | User that last updated the issue. |
|
|
| <a id="epicissueupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes the issue has received. |
|
|
| <a id="epicissueuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the issue. |
|
|
| <a id="epicissueusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes of the issue. |
|
|
| <a id="epicissueuserpermissions"></a>`userPermissions` | [`IssuePermissions!`](#issuepermissions) | Permissions for the current user on the resource. |
|
|
| <a id="epicissuewebpath"></a>`webPath` | [`String!`](#string) | Web path of the issue. |
|
|
| <a id="epicissueweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the issue. |
|
|
| <a id="epicissueweight"></a>`weight` | [`Int`](#int) | Weight of the issue. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `EpicIssue.currentUserTodos`
|
|
|
|
To-do items for the current user.
|
|
|
|
Returns [`TodoConnection!`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicissuecurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. |
|
|
|
|
##### `EpicIssue.reference`
|
|
|
|
Internal reference of the issue. Returned in shortened format by default.
|
|
|
|
Returns [`String!`](#string).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicissuereferencefull"></a>`full` | [`Boolean`](#boolean) | Boolean option specifying whether the reference should be returned in full. |
|
|
|
|
### `EpicList`
|
|
|
|
Represents an epic board list.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epiclistcollapsed"></a>`collapsed` | [`Boolean`](#boolean) | Indicates if this list is collapsed for this user. |
|
|
| <a id="epiclistepicscount"></a>`epicsCount` **{warning-solid}** | [`Int`](#int) | **Deprecated** in 14.9. This was renamed. Use: `metadata`. |
|
|
| <a id="epiclistid"></a>`id` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the board list. |
|
|
| <a id="epiclistlabel"></a>`label` | [`Label`](#label) | Label of the list. |
|
|
| <a id="epiclistlisttype"></a>`listType` | [`String!`](#string) | Type of the list. |
|
|
| <a id="epiclistmetadata"></a>`metadata` | [`EpicListMetadata`](#epiclistmetadata) | Epic list metatada. |
|
|
| <a id="epiclistposition"></a>`position` | [`Int`](#int) | Position of the list within the board. |
|
|
| <a id="epiclisttitle"></a>`title` | [`String!`](#string) | Title of the list. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `EpicList.epics`
|
|
|
|
List epics.
|
|
|
|
Returns [`EpicConnection`](#epicconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epiclistepicsfilters"></a>`filters` | [`EpicFilters`](#epicfilters) | Filters applied when selecting epics in the board list. |
|
|
|
|
### `EpicListMetadata`
|
|
|
|
Represents epic board list metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epiclistmetadataepicscount"></a>`epicsCount` | [`Int`](#int) | Count of epics in the list. |
|
|
| <a id="epiclistmetadatatotalweight"></a>`totalWeight` | [`Int`](#int) | Total weight of all issues in the list. Available only when feature flag `epic_board_total_weight` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
|
|
|
|
### `EpicPermissions`
|
|
|
|
Check permissions for the current user on an epic.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicpermissionsadminepic"></a>`adminEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_epic` on this resource. |
|
|
| <a id="epicpermissionsawardemoji"></a>`awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. |
|
|
| <a id="epicpermissionscreateepic"></a>`createEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `create_epic` on this resource. |
|
|
| <a id="epicpermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. |
|
|
| <a id="epicpermissionsdestroyepic"></a>`destroyEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_epic` on this resource. |
|
|
| <a id="epicpermissionsreadepic"></a>`readEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `read_epic` on this resource. |
|
|
| <a id="epicpermissionsreadepiciid"></a>`readEpicIid` | [`Boolean!`](#boolean) | Indicates the user can perform `read_epic_iid` on this resource. |
|
|
| <a id="epicpermissionsupdateepic"></a>`updateEpic` | [`Boolean!`](#boolean) | Indicates the user can perform `update_epic` on this resource. |
|
|
|
|
### `EscalationPolicyType`
|
|
|
|
Represents an escalation policy.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="escalationpolicytypedescription"></a>`description` | [`String`](#string) | Description of the escalation policy. |
|
|
| <a id="escalationpolicytypeid"></a>`id` | [`IncidentManagementEscalationPolicyID`](#incidentmanagementescalationpolicyid) | ID of the escalation policy. |
|
|
| <a id="escalationpolicytypename"></a>`name` | [`String`](#string) | Name of the escalation policy. |
|
|
| <a id="escalationpolicytyperules"></a>`rules` | [`[EscalationRuleType!]`](#escalationruletype) | Steps of the escalation policy. |
|
|
|
|
### `EscalationRuleType`
|
|
|
|
Represents an escalation rule for an escalation policy.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="escalationruletypeelapsedtimeseconds"></a>`elapsedTimeSeconds` | [`Int`](#int) | Time in seconds before the rule is activated. |
|
|
| <a id="escalationruletypeid"></a>`id` | [`IncidentManagementEscalationRuleID`](#incidentmanagementescalationruleid) | ID of the escalation policy. |
|
|
| <a id="escalationruletypeoncallschedule"></a>`oncallSchedule` | [`IncidentManagementOncallSchedule`](#incidentmanagementoncallschedule) | On-call schedule to notify. |
|
|
| <a id="escalationruletypestatus"></a>`status` | [`EscalationRuleStatus`](#escalationrulestatus) | Status required to prevent the rule from activating. |
|
|
| <a id="escalationruletypeuser"></a>`user` | [`UserCore`](#usercore) | User to notify. |
|
|
|
|
### `Event`
|
|
|
|
Representing an event.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="eventaction"></a>`action` | [`EventAction!`](#eventaction) | Action of the event. |
|
|
| <a id="eventauthor"></a>`author` | [`UserCore!`](#usercore) | Author of this event. |
|
|
| <a id="eventcreatedat"></a>`createdAt` | [`Time!`](#time) | When this event was created. |
|
|
| <a id="eventid"></a>`id` | [`ID!`](#id) | ID of the event. |
|
|
| <a id="eventupdatedat"></a>`updatedAt` | [`Time!`](#time) | When this event was updated. |
|
|
|
|
### `ExternalAuditEventDestination`
|
|
|
|
Represents an external resource to send audit events to.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="externalauditeventdestinationdestinationurl"></a>`destinationUrl` | [`String!`](#string) | External destination to send audit events to. |
|
|
| <a id="externalauditeventdestinationgroup"></a>`group` | [`Group!`](#group) | Group the destination belongs to. |
|
|
| <a id="externalauditeventdestinationid"></a>`id` | [`ID!`](#id) | ID of the destination. |
|
|
| <a id="externalauditeventdestinationverificationtoken"></a>`verificationToken` | [`String!`](#string) | Verification token to validate source of event. |
|
|
|
|
### `ExternalIssue`
|
|
|
|
Represents an external issue.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="externalissuecreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the issue was created. |
|
|
| <a id="externalissueexternaltracker"></a>`externalTracker` | [`String`](#string) | Type of external tracker. |
|
|
| <a id="externalissuerelativereference"></a>`relativeReference` | [`String`](#string) | Relative reference of the issue in the external tracker. |
|
|
| <a id="externalissuestatus"></a>`status` | [`String`](#string) | Status of the issue in the external tracker. |
|
|
| <a id="externalissuetitle"></a>`title` | [`String`](#string) | Title of the issue in the external tracker. |
|
|
| <a id="externalissueupdatedat"></a>`updatedAt` | [`Time`](#time) | Timestamp of when the issue was updated. |
|
|
| <a id="externalissueweburl"></a>`webUrl` | [`String`](#string) | URL to the issue in the external tracker. |
|
|
|
|
### `GeoNode`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodecontainerrepositoriesmaxcapacity"></a>`containerRepositoriesMaxCapacity` | [`Int`](#int) | Maximum concurrency of container repository sync for this secondary node. |
|
|
| <a id="geonodeenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether this Geo node is enabled. |
|
|
| <a id="geonodefilesmaxcapacity"></a>`filesMaxCapacity` | [`Int`](#int) | Maximum concurrency of LFS/attachment backfill for this secondary node. |
|
|
| <a id="geonodeid"></a>`id` | [`ID!`](#id) | ID of this GeoNode. |
|
|
| <a id="geonodeinternalurl"></a>`internalUrl` | [`String`](#string) | URL defined on the primary node secondary nodes should use to contact it. |
|
|
| <a id="geonodeminimumreverificationinterval"></a>`minimumReverificationInterval` | [`Int`](#int) | Interval (in days) in which the repository verification is valid. After expiry, it is reverted. |
|
|
| <a id="geonodename"></a>`name` | [`String`](#string) | Unique identifier for this Geo node. |
|
|
| <a id="geonodeprimary"></a>`primary` | [`Boolean`](#boolean) | Indicates whether this Geo node is the primary. |
|
|
| <a id="geonodereposmaxcapacity"></a>`reposMaxCapacity` | [`Int`](#int) | Maximum concurrency of repository backfill for this secondary node. |
|
|
| <a id="geonodeselectivesyncnamespaces"></a>`selectiveSyncNamespaces` | [`NamespaceConnection`](#namespaceconnection) | Namespaces that should be synced, if `selective_sync_type` == `namespaces`. (see [Connections](#connections)) |
|
|
| <a id="geonodeselectivesyncshards"></a>`selectiveSyncShards` | [`[String!]`](#string) | Repository storages whose projects should be synced, if `selective_sync_type` == `shards`. |
|
|
| <a id="geonodeselectivesynctype"></a>`selectiveSyncType` | [`String`](#string) | Indicates if syncing is limited to only specific groups, or shards. |
|
|
| <a id="geonodesyncobjectstorage"></a>`syncObjectStorage` | [`Boolean`](#boolean) | Indicates if this secondary node will replicate blobs in Object Storage. |
|
|
| <a id="geonodeurl"></a>`url` | [`String`](#string) | User-facing URL for this Geo node. |
|
|
| <a id="geonodeverificationmaxcapacity"></a>`verificationMaxCapacity` | [`Int`](#int) | Maximum concurrency of repository verification for this secondary node. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `GeoNode.groupWikiRepositoryRegistries`
|
|
|
|
Find group wiki repository registries on this Geo node.
|
|
|
|
Returns [`GroupWikiRepositoryRegistryConnection`](#groupwikirepositoryregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodegroupwikirepositoryregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.jobArtifactRegistries`
|
|
|
|
Find Job Artifact registries on this Geo node.
|
|
|
|
Returns [`JobArtifactRegistryConnection`](#jobartifactregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodejobartifactregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.lfsObjectRegistries`
|
|
|
|
Find LFS object registries on this Geo node.
|
|
|
|
Returns [`LfsObjectRegistryConnection`](#lfsobjectregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodelfsobjectregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.mergeRequestDiffRegistries`
|
|
|
|
Find merge request diff registries on this Geo node.
|
|
|
|
Returns [`MergeRequestDiffRegistryConnection`](#mergerequestdiffregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodemergerequestdiffregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.packageFileRegistries`
|
|
|
|
Package file registries of the GeoNode.
|
|
|
|
Returns [`PackageFileRegistryConnection`](#packagefileregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodepackagefileregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.pagesDeploymentRegistries`
|
|
|
|
Find Pages Deployment registries on this Geo node.
|
|
|
|
Returns [`PagesDeploymentRegistryConnection`](#pagesdeploymentregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodepagesdeploymentregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.pipelineArtifactRegistries`
|
|
|
|
Find pipeline artifact registries on this Geo node.
|
|
|
|
Returns [`PipelineArtifactRegistryConnection`](#pipelineartifactregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodepipelineartifactregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.snippetRepositoryRegistries`
|
|
|
|
Find snippet repository registries on this Geo node.
|
|
|
|
Returns [`SnippetRepositoryRegistryConnection`](#snippetrepositoryregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodesnippetrepositoryregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.terraformStateVersionRegistries`
|
|
|
|
Find terraform state version registries on this Geo node.
|
|
|
|
Returns [`TerraformStateVersionRegistryConnection`](#terraformstateversionregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodeterraformstateversionregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
##### `GeoNode.uploadRegistries`
|
|
|
|
Find Upload registries on this Geo node.
|
|
|
|
Returns [`UploadRegistryConnection`](#uploadregistryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="geonodeuploadregistriesids"></a>`ids` | [`[ID!]`](#id) | Filters registries by their ID. |
|
|
|
|
### `GrafanaIntegration`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="grafanaintegrationcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the issue's creation. |
|
|
| <a id="grafanaintegrationenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether Grafana integration is enabled. |
|
|
| <a id="grafanaintegrationgrafanaurl"></a>`grafanaUrl` | [`String!`](#string) | URL for the Grafana host for the Grafana integration. |
|
|
| <a id="grafanaintegrationid"></a>`id` | [`ID!`](#id) | Internal ID of the Grafana integration. |
|
|
| <a id="grafanaintegrationupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of the issue's last activity. |
|
|
|
|
### `Group`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupactualrepositorysizelimit"></a>`actualRepositorySizeLimit` | [`Float`](#float) | Size limit for repositories in the namespace in bytes. |
|
|
| <a id="groupadditionalpurchasedstoragesize"></a>`additionalPurchasedStorageSize` | [`Float`](#float) | Additional storage purchased for the root namespace in bytes. |
|
|
| <a id="groupallowstalerunnerpruning"></a>`allowStaleRunnerPruning` | [`Boolean!`](#boolean) | Indicates whether to regularly prune stale group runners. Defaults to false. |
|
|
| <a id="groupautodevopsenabled"></a>`autoDevopsEnabled` | [`Boolean`](#boolean) | Indicates whether Auto DevOps is enabled for all projects within this group. |
|
|
| <a id="groupavatarurl"></a>`avatarUrl` | [`String`](#string) | Avatar URL of the group. |
|
|
| <a id="groupcontacts"></a>`contacts` | [`CustomerRelationsContactConnection`](#customerrelationscontactconnection) | Find contacts of this group. (see [Connections](#connections)) |
|
|
| <a id="groupcontainerrepositoriescount"></a>`containerRepositoriesCount` | [`Int!`](#int) | Number of container repositories in the group. |
|
|
| <a id="groupcontainslockedprojects"></a>`containsLockedProjects` | [`Boolean!`](#boolean) | Includes at least one project where the repository size exceeds the limit. |
|
|
| <a id="groupcrossprojectpipelineavailable"></a>`crossProjectPipelineAvailable` | [`Boolean!`](#boolean) | Indicates if the cross_project_pipeline feature is available for the namespace. |
|
|
| <a id="groupcustomemoji"></a>`customEmoji` | [`CustomEmojiConnection`](#customemojiconnection) | Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. (see [Connections](#connections)) |
|
|
| <a id="groupdependencyproxyblobcount"></a>`dependencyProxyBlobCount` | [`Int!`](#int) | Number of dependency proxy blobs cached in the group. |
|
|
| <a id="groupdependencyproxyblobs"></a>`dependencyProxyBlobs` | [`DependencyProxyBlobConnection`](#dependencyproxyblobconnection) | Dependency Proxy blobs. (see [Connections](#connections)) |
|
|
| <a id="groupdependencyproxyimagecount"></a>`dependencyProxyImageCount` | [`Int!`](#int) | Number of dependency proxy images cached in the group. |
|
|
| <a id="groupdependencyproxyimageprefix"></a>`dependencyProxyImagePrefix` | [`String!`](#string) | Prefix for pulling images when using the dependency proxy. |
|
|
| <a id="groupdependencyproxyimagettlpolicy"></a>`dependencyProxyImageTtlPolicy` | [`DependencyProxyImageTtlGroupPolicy`](#dependencyproxyimagettlgrouppolicy) | Dependency proxy TTL policy for the group. |
|
|
| <a id="groupdependencyproxymanifests"></a>`dependencyProxyManifests` | [`DependencyProxyManifestConnection`](#dependencyproxymanifestconnection) | Dependency Proxy manifests. (see [Connections](#connections)) |
|
|
| <a id="groupdependencyproxysetting"></a>`dependencyProxySetting` | [`DependencyProxySetting`](#dependencyproxysetting) | Dependency Proxy settings for the group. |
|
|
| <a id="groupdependencyproxytotalsize"></a>`dependencyProxyTotalSize` | [`String!`](#string) | Total size of the dependency proxy cached images. |
|
|
| <a id="groupdescription"></a>`description` | [`String`](#string) | Description of the namespace. |
|
|
| <a id="groupdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="groupdora"></a>`dora` | [`Dora`](#dora) | Group's DORA metrics. |
|
|
| <a id="groupemailsdisabled"></a>`emailsDisabled` | [`Boolean`](#boolean) | Indicates if a group has email notifications disabled. |
|
|
| <a id="groupepicboards"></a>`epicBoards` | [`EpicBoardConnection`](#epicboardconnection) | Find epic boards. (see [Connections](#connections)) |
|
|
| <a id="groupepicsenabled"></a>`epicsEnabled` | [`Boolean`](#boolean) | Indicates if Epics are enabled for namespace. |
|
|
| <a id="groupexternalauditeventdestinations"></a>`externalAuditEventDestinations` | [`ExternalAuditEventDestinationConnection`](#externalauditeventdestinationconnection) | External locations that receive audit events belonging to the group. (see [Connections](#connections)) |
|
|
| <a id="groupfullname"></a>`fullName` | [`String!`](#string) | Full name of the namespace. |
|
|
| <a id="groupfullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the namespace. |
|
|
| <a id="groupid"></a>`id` | [`ID!`](#id) | ID of the namespace. |
|
|
| <a id="groupistemporarystorageincreaseenabled"></a>`isTemporaryStorageIncreaseEnabled` | [`Boolean!`](#boolean) | Status of the temporary storage increase. |
|
|
| <a id="grouplfsenabled"></a>`lfsEnabled` | [`Boolean`](#boolean) | Indicates if Large File Storage (LFS) is enabled for namespace. |
|
|
| <a id="groupmentionsdisabled"></a>`mentionsDisabled` | [`Boolean`](#boolean) | Indicates if a group is disabled from getting mentioned. |
|
|
| <a id="groupname"></a>`name` | [`String!`](#string) | Name of the namespace. |
|
|
| <a id="grouporganizations"></a>`organizations` | [`CustomerRelationsOrganizationConnection`](#customerrelationsorganizationconnection) | Find organizations of this group. (see [Connections](#connections)) |
|
|
| <a id="grouppackagesettings"></a>`packageSettings` | [`PackageSettings`](#packagesettings) | Package settings for the namespace. |
|
|
| <a id="groupparent"></a>`parent` | [`Group`](#group) | Parent group. |
|
|
| <a id="grouppath"></a>`path` | [`String!`](#string) | Path of the namespace. |
|
|
| <a id="groupprojectcreationlevel"></a>`projectCreationLevel` | [`String`](#string) | Permission level required to create projects in the group. |
|
|
| <a id="grouprecentissueboards"></a>`recentIssueBoards` | [`BoardConnection`](#boardconnection) | List of recently visited boards of the group. Maximum size is 4. (see [Connections](#connections)) |
|
|
| <a id="grouprepositorysizeexcessprojectcount"></a>`repositorySizeExcessProjectCount` | [`Int!`](#int) | Number of projects in the root namespace where the repository size exceeds the limit. |
|
|
| <a id="grouprequestaccessenabled"></a>`requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request access to namespace. |
|
|
| <a id="grouprequiretwofactorauthentication"></a>`requireTwoFactorAuthentication` | [`Boolean`](#boolean) | Indicates if all users in this group are required to set up two-factor authentication. |
|
|
| <a id="grouprootstoragestatistics"></a>`rootStorageStatistics` | [`RootStorageStatistics`](#rootstoragestatistics) | Aggregated storage statistics of the namespace. Only available for root namespaces. |
|
|
| <a id="groupsharewithgrouplock"></a>`shareWithGroupLock` | [`Boolean`](#boolean) | Indicates if sharing a project with another group within this group is prevented. |
|
|
| <a id="groupsharedrunnerssetting"></a>`sharedRunnersSetting` | [`SharedRunnersSetting`](#sharedrunnerssetting) | Shared runners availability for the namespace and its descendants. |
|
|
| <a id="groupstats"></a>`stats` | [`GroupStats`](#groupstats) | Group statistics. |
|
|
| <a id="groupstoragesizelimit"></a>`storageSizeLimit` | [`Float`](#float) | Total storage limit of the root namespace in bytes. |
|
|
| <a id="groupsubgroupcreationlevel"></a>`subgroupCreationLevel` | [`String`](#string) | Permission level required to create subgroups within the group. |
|
|
| <a id="grouptemporarystorageincreaseendson"></a>`temporaryStorageIncreaseEndsOn` | [`Time`](#time) | Date until the temporary storage increase is active. |
|
|
| <a id="grouptotalrepositorysize"></a>`totalRepositorySize` | [`Float`](#float) | Total repository size of all projects in the root namespace in bytes. |
|
|
| <a id="grouptotalrepositorysizeexcess"></a>`totalRepositorySizeExcess` | [`Float`](#float) | Total excess repository size of all projects in the root namespace in bytes. |
|
|
| <a id="grouptwofactorgraceperiod"></a>`twoFactorGracePeriod` | [`Int`](#int) | Time before two-factor authentication is enforced. |
|
|
| <a id="groupuserpermissions"></a>`userPermissions` | [`GroupPermissions!`](#grouppermissions) | Permissions for the current user on the resource. |
|
|
| <a id="groupvisibility"></a>`visibility` | [`String`](#string) | Visibility of the namespace. |
|
|
| <a id="groupvulnerabilityscanners"></a>`vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. (see [Connections](#connections)) |
|
|
| <a id="groupweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the group. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Group.billableMembersCount`
|
|
|
|
Number of billable users in the group.
|
|
|
|
Returns [`Int`](#int).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupbillablememberscountrequestedhostedplan"></a>`requestedHostedPlan` | [`String`](#string) | Plan from which to get billable members. |
|
|
|
|
##### `Group.board`
|
|
|
|
A single board of the group.
|
|
|
|
Returns [`Board`](#board).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupboardid"></a>`id` | [`BoardID!`](#boardid) | ID of the board. |
|
|
|
|
##### `Group.boards`
|
|
|
|
Boards of the group.
|
|
|
|
Returns [`BoardConnection`](#boardconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupboardsid"></a>`id` | [`BoardID`](#boardid) | Find a board by its ID. |
|
|
|
|
##### `Group.codeCoverageActivities`
|
|
|
|
Represents the code coverage activity for this group.
|
|
|
|
Returns [`CodeCoverageActivityConnection`](#codecoverageactivityconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupcodecoverageactivitiesstartdate"></a>`startDate` | [`Date!`](#date) | First day for which to fetch code coverage activity (maximum time window is set to 90 days). |
|
|
|
|
##### `Group.complianceFrameworks`
|
|
|
|
Compliance frameworks available to projects in this namespace.
|
|
|
|
Returns [`ComplianceFrameworkConnection`](#complianceframeworkconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupcomplianceframeworksid"></a>`id` | [`ComplianceManagementFrameworkID`](#compliancemanagementframeworkid) | Global ID of a specific compliance framework to return. |
|
|
|
|
##### `Group.containerRepositories`
|
|
|
|
Container repositories of the group.
|
|
|
|
Returns [`ContainerRepositoryConnection`](#containerrepositoryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupcontainerrepositoriesname"></a>`name` | [`String`](#string) | Filter the container repositories by their name. |
|
|
| <a id="groupcontainerrepositoriessort"></a>`sort` | [`ContainerRepositorySort`](#containerrepositorysort) | Sort container repositories by this criteria. |
|
|
|
|
##### `Group.descendantGroups`
|
|
|
|
List of descendant groups of this group.
|
|
|
|
Returns [`GroupConnection`](#groupconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupdescendantgroupsincludeparentdescendants"></a>`includeParentDescendants` | [`Boolean`](#boolean) | List of descendant groups of the parent group. |
|
|
| <a id="groupdescendantgroupsowned"></a>`owned` | [`Boolean`](#boolean) | Limit result to groups owned by authenticated user. |
|
|
| <a id="groupdescendantgroupssearch"></a>`search` | [`String`](#string) | Search query for group name or group full path. |
|
|
|
|
##### `Group.epic`
|
|
|
|
Find a single epic.
|
|
|
|
Returns [`Epic`](#epic).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupepicauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. |
|
|
| <a id="groupepicconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. |
|
|
| <a id="groupepiccreatedafter"></a>`createdAfter` | [`Time`](#time) | Epics created after this date. |
|
|
| <a id="groupepiccreatedbefore"></a>`createdBefore` | [`Time`](#time) | Epics created before this date. |
|
|
| <a id="groupepicenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="groupepiciid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". |
|
|
| <a id="groupepiciidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. |
|
|
| <a id="groupepiciids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., `[1, 2]`. |
|
|
| <a id="groupepicin"></a>`in` | [`[IssuableSearchableField!]`](#issuablesearchablefield) | Specify the fields to perform the search in. Defaults to `[TITLE, DESCRIPTION]`. Requires the `search` argument. |
|
|
| <a id="groupepicincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include epics from ancestor groups. |
|
|
| <a id="groupepicincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. |
|
|
| <a id="groupepiclabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. |
|
|
| <a id="groupepicmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. |
|
|
| <a id="groupepicmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. |
|
|
| <a id="groupepicnot"></a>`not` | [`NegatedEpicFilterInput`](#negatedepicfilterinput) | Negated epic arguments. |
|
|
| <a id="groupepicsearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="groupepicsort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. |
|
|
| <a id="groupepicstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="groupepicstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. |
|
|
| <a id="groupepictimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="groupepictoplevelhierarchyonly"></a>`topLevelHierarchyOnly` | [`Boolean`](#boolean) | Filter epics with a top-level hierarchy. |
|
|
| <a id="groupepicupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Epics updated after this date. |
|
|
| <a id="groupepicupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Epics updated before this date. |
|
|
|
|
##### `Group.epicBoard`
|
|
|
|
Find a single epic board.
|
|
|
|
Returns [`EpicBoard`](#epicboard).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupepicboardid"></a>`id` | [`BoardsEpicBoardID!`](#boardsepicboardid) | Find an epic board by ID. |
|
|
|
|
##### `Group.epics`
|
|
|
|
Find epics.
|
|
|
|
Returns [`EpicConnection`](#epicconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupepicsauthorusername"></a>`authorUsername` | [`String`](#string) | Filter epics by author. |
|
|
| <a id="groupepicsconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter epics by given confidentiality. |
|
|
| <a id="groupepicscreatedafter"></a>`createdAfter` | [`Time`](#time) | Epics created after this date. |
|
|
| <a id="groupepicscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Epics created before this date. |
|
|
| <a id="groupepicsenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="groupepicsiid"></a>`iid` | [`ID`](#id) | IID of the epic, e.g., "1". |
|
|
| <a id="groupepicsiidstartswith"></a>`iidStartsWith` | [`String`](#string) | Filter epics by IID for autocomplete. |
|
|
| <a id="groupepicsiids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of epics, e.g., `[1, 2]`. |
|
|
| <a id="groupepicsin"></a>`in` | [`[IssuableSearchableField!]`](#issuablesearchablefield) | Specify the fields to perform the search in. Defaults to `[TITLE, DESCRIPTION]`. Requires the `search` argument. |
|
|
| <a id="groupepicsincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include epics from ancestor groups. |
|
|
| <a id="groupepicsincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include epics from descendant groups. |
|
|
| <a id="groupepicslabelname"></a>`labelName` | [`[String!]`](#string) | Filter epics by labels. |
|
|
| <a id="groupepicsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter epics by milestone title, computed from epic's issues. |
|
|
| <a id="groupepicsmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. |
|
|
| <a id="groupepicsnot"></a>`not` | [`NegatedEpicFilterInput`](#negatedepicfilterinput) | Negated epic arguments. |
|
|
| <a id="groupepicssearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="groupepicssort"></a>`sort` | [`EpicSort`](#epicsort) | List epics by sort order. |
|
|
| <a id="groupepicsstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="groupepicsstate"></a>`state` | [`EpicState`](#epicstate) | Filter epics by state. |
|
|
| <a id="groupepicstimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="groupepicstoplevelhierarchyonly"></a>`topLevelHierarchyOnly` | [`Boolean`](#boolean) | Filter epics with a top-level hierarchy. |
|
|
| <a id="groupepicsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Epics updated after this date. |
|
|
| <a id="groupepicsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Epics updated before this date. |
|
|
|
|
##### `Group.groupMembers`
|
|
|
|
A membership of a user within this group.
|
|
|
|
Returns [`GroupMemberConnection`](#groupmemberconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupgroupmembersaccesslevels"></a>`accessLevels` | [`[AccessLevelEnum!]`](#accesslevelenum) | Filter members by the given access levels. |
|
|
| <a id="groupgroupmembersrelations"></a>`relations` | [`[GroupMemberRelation!]`](#groupmemberrelation) | Filter members by the given member relations. |
|
|
| <a id="groupgroupmemberssearch"></a>`search` | [`String`](#string) | Search query. |
|
|
|
|
##### `Group.issues`
|
|
|
|
Issues for projects in this group.
|
|
|
|
Returns [`IssueConnection`](#issueconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupissuesassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="groupissuesassigneeusername"></a>`assigneeUsername` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use `assigneeUsernames`. |
|
|
| <a id="groupissuesassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. |
|
|
| <a id="groupissuesauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. |
|
|
| <a id="groupissuesclosedafter"></a>`closedAfter` | [`Time`](#time) | Issues closed after this date. |
|
|
| <a id="groupissuesclosedbefore"></a>`closedBefore` | [`Time`](#time) | Issues closed before this date. |
|
|
| <a id="groupissuesconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues. |
|
|
| <a id="groupissuescreatedafter"></a>`createdAfter` | [`Time`](#time) | Issues created after this date. |
|
|
| <a id="groupissuescreatedbefore"></a>`createdBefore` | [`Time`](#time) | Issues created before this date. |
|
|
| <a id="groupissuescrmcontactid"></a>`crmContactId` | [`String`](#string) | ID of a contact assigned to the issues. |
|
|
| <a id="groupissuescrmorganizationid"></a>`crmOrganizationId` | [`String`](#string) | ID of an organization assigned to the issues. |
|
|
| <a id="groupissuesepicid"></a>`epicId` | [`String`](#string) | ID of an epic associated with the issues, "none" and "any" values are supported. |
|
|
| <a id="groupissuesiid"></a>`iid` | [`String`](#string) | IID of the issue. For example, "1". |
|
|
| <a id="groupissuesiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example, `["1", "2"]`. |
|
|
| <a id="groupissuesincludearchived"></a>`includeArchived` | [`Boolean`](#boolean) | Return issues from archived projects. |
|
|
| <a id="groupissuesincludesubepics"></a>`includeSubepics` | [`Boolean`](#boolean) | Whether to include subepics when filtering issues by epicId. |
|
|
| <a id="groupissuesincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include issues belonging to subgroups. |
|
|
| <a id="groupissuesiterationid"></a>`iterationId` | [`[ID]`](#id) | List of iteration Global IDs applied to the issue. |
|
|
| <a id="groupissuesiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by iteration ID wildcard. |
|
|
| <a id="groupissueslabelname"></a>`labelName` | [`[String]`](#string) | Labels applied to this issue. |
|
|
| <a id="groupissuesmilestonetitle"></a>`milestoneTitle` | [`[String]`](#string) | Milestone applied to this issue. |
|
|
| <a id="groupissuesmilestonewildcardid"></a>`milestoneWildcardId` | [`MilestoneWildcardId`](#milestonewildcardid) | Filter issues by milestone ID wildcard. |
|
|
| <a id="groupissuesmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="groupissuesnot"></a>`not` | [`NegatedIssueFilterInput`](#negatedissuefilterinput) | Negated arguments. |
|
|
| <a id="groupissuessearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="groupissuessort"></a>`sort` | [`IssueSort`](#issuesort) | Sort issues by this criteria. |
|
|
| <a id="groupissuesstate"></a>`state` | [`IssuableState`](#issuablestate) | Current state of this issue. |
|
|
| <a id="groupissuestypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter issues by the given issue types. |
|
|
| <a id="groupissuesupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Issues updated after this date. |
|
|
| <a id="groupissuesupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Issues updated before this date. |
|
|
| <a id="groupissuesweight"></a>`weight` | [`String`](#string) | Weight applied to the issue, "none" and "any" values are supported. |
|
|
|
|
##### `Group.iterationCadences`
|
|
|
|
Find iteration cadences.
|
|
|
|
Returns [`IterationCadenceConnection`](#iterationcadenceconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupiterationcadencesactive"></a>`active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. |
|
|
| <a id="groupiterationcadencesautomatic"></a>`automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate upcoming iterations. |
|
|
| <a id="groupiterationcadencesdurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. |
|
|
| <a id="groupiterationcadencesid"></a>`id` | [`IterationsCadenceID`](#iterationscadenceid) | Global ID of the iteration cadence to look up. |
|
|
| <a id="groupiterationcadencesincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Whether to include ancestor groups to search iterations cadences in. |
|
|
| <a id="groupiterationcadencestitle"></a>`title` | [`String`](#string) | Fuzzy search by title. |
|
|
|
|
##### `Group.iterations`
|
|
|
|
Find iterations.
|
|
|
|
Returns [`IterationConnection`](#iterationconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupiterationsenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="groupiterationsid"></a>`id` | [`ID`](#id) | Global ID of the Iteration to look up. |
|
|
| <a id="groupiterationsiid"></a>`iid` | [`ID`](#id) | Internal ID of the Iteration to look up. |
|
|
| <a id="groupiterationsin"></a>`in` | [`[IterationSearchableField!]`](#iterationsearchablefield) | Fields in which the fuzzy-search should be performed with the query given in the argument `search`. Defaults to `[title]`. |
|
|
| <a id="groupiterationsincludeancestors"></a>`includeAncestors` | [`Boolean`](#boolean) | Whether to include ancestor iterations. Defaults to true. |
|
|
| <a id="groupiterationsiterationcadenceids"></a>`iterationCadenceIds` | [`[IterationsCadenceID!]`](#iterationscadenceid) | Global iteration cadence IDs by which to look up the iterations. |
|
|
| <a id="groupiterationssearch"></a>`search` | [`String`](#string) | Query used for fuzzy-searching in the fields selected in the argument `in`. Returns all iterations if empty. |
|
|
| <a id="groupiterationssort"></a>`sort` | [`IterationSort`](#iterationsort) | List iterations by sort order. If unspecified, an arbitrary order (subject to change) is used. |
|
|
| <a id="groupiterationsstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="groupiterationsstate"></a>`state` | [`IterationState`](#iterationstate) | Filter iterations by state. |
|
|
| <a id="groupiterationstimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="groupiterationstitle"></a>`title` **{warning-solid}** | [`String`](#string) | **Deprecated** in 15.4. The argument will be removed in 15.4. Please use `search` and `in` fields instead. |
|
|
|
|
##### `Group.label`
|
|
|
|
Label available on this group.
|
|
|
|
Returns [`Label`](#label).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="grouplabeltitle"></a>`title` | [`String!`](#string) | Title of the label. |
|
|
|
|
##### `Group.labels`
|
|
|
|
Labels available on this group.
|
|
|
|
Returns [`LabelConnection`](#labelconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="grouplabelsincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include labels from ancestor groups. |
|
|
| <a id="grouplabelsincludedescendantgroups"></a>`includeDescendantGroups` | [`Boolean`](#boolean) | Include labels from descendant groups. |
|
|
| <a id="grouplabelsonlygrouplabels"></a>`onlyGroupLabels` | [`Boolean`](#boolean) | Include only group level labels. |
|
|
| <a id="grouplabelssearchterm"></a>`searchTerm` | [`String`](#string) | Search term to find labels with. |
|
|
|
|
##### `Group.mergeRequestViolations`
|
|
|
|
Compliance violations reported on merge requests merged within the group.
|
|
|
|
Returns [`ComplianceViolationConnection`](#complianceviolationconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupmergerequestviolationsfilters"></a>`filters` | [`ComplianceViolationInput`](#complianceviolationinput) | Filters applied when retrieving compliance violations. |
|
|
| <a id="groupmergerequestviolationssort"></a>`sort` | [`ComplianceViolationSort`](#complianceviolationsort) | List compliance violations by sort order. |
|
|
|
|
##### `Group.mergeRequests`
|
|
|
|
Merge requests for projects in this group.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="groupmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="groupmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="groupmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="groupmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="groupmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="groupmergerequestsincludearchived"></a>`includeArchived` | [`Boolean`](#boolean) | Return merge requests from archived projects. |
|
|
| <a id="groupmergerequestsincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include merge requests belonging to subgroups. |
|
|
| <a id="groupmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="groupmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="groupmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="groupmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="groupmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="groupmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="groupmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="groupmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="groupmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="groupmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="groupmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `Group.milestones`
|
|
|
|
Milestones of the group.
|
|
|
|
Returns [`MilestoneConnection`](#milestoneconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupmilestonescontainingdate"></a>`containingDate` | [`Time`](#time) | Date the milestone contains. |
|
|
| <a id="groupmilestonesenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="groupmilestonesids"></a>`ids` | [`[ID!]`](#id) | Array of global milestone IDs, e.g., `"gid://gitlab/Milestone/1"`. |
|
|
| <a id="groupmilestonesincludeancestors"></a>`includeAncestors` | [`Boolean`](#boolean) | Include milestones from all parent groups. |
|
|
| <a id="groupmilestonesincludedescendants"></a>`includeDescendants` | [`Boolean`](#boolean) | Include milestones from all subgroups and subprojects. |
|
|
| <a id="groupmilestonessearchtitle"></a>`searchTitle` | [`String`](#string) | Search string for the title. |
|
|
| <a id="groupmilestonessort"></a>`sort` | [`MilestoneSort`](#milestonesort) | Sort milestones by this criteria. |
|
|
| <a id="groupmilestonesstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="groupmilestonesstate"></a>`state` | [`MilestoneStateEnum`](#milestonestateenum) | Filter milestones by state. |
|
|
| <a id="groupmilestonestimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="groupmilestonestitle"></a>`title` | [`String`](#string) | Title of the milestone. |
|
|
|
|
##### `Group.packages`
|
|
|
|
Packages of the group.
|
|
|
|
Returns [`PackageConnection`](#packageconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="grouppackagesincludeversionless"></a>`includeVersionless` | [`Boolean`](#boolean) | Include versionless packages. |
|
|
| <a id="grouppackagespackagename"></a>`packageName` | [`String`](#string) | Search a package by name. |
|
|
| <a id="grouppackagespackagetype"></a>`packageType` | [`PackageTypeEnum`](#packagetypeenum) | Filter a package by type. |
|
|
| <a id="grouppackagessort"></a>`sort` | [`PackageGroupSort`](#packagegroupsort) | Sort packages by this criteria. |
|
|
| <a id="grouppackagesstatus"></a>`status` | [`PackageStatus`](#packagestatus) | Filter a package by status. |
|
|
|
|
##### `Group.projects`
|
|
|
|
Projects within this namespace.
|
|
|
|
Returns [`ProjectConnection!`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupprojectshascodecoverage"></a>`hasCodeCoverage` | [`Boolean`](#boolean) | Returns only the projects which have code coverage. |
|
|
| <a id="groupprojectshasvulnerabilities"></a>`hasVulnerabilities` | [`Boolean`](#boolean) | Returns only the projects which have vulnerabilities. |
|
|
| <a id="groupprojectsids"></a>`ids` | [`[ID!]`](#id) | Filter projects by IDs. |
|
|
| <a id="groupprojectsincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include also subgroup projects. |
|
|
| <a id="groupprojectssearch"></a>`search` | [`String`](#string) | Search project with most similar names or paths. |
|
|
| <a id="groupprojectssort"></a>`sort` | [`NamespaceProjectSort`](#namespaceprojectsort) | Sort projects by this criteria. |
|
|
|
|
##### `Group.runners`
|
|
|
|
Find runners visible to the current user.
|
|
|
|
Returns [`CiRunnerConnection`](#cirunnerconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="grouprunnersactive"></a>`active` **{warning-solid}** | [`Boolean`](#boolean) | **Deprecated** in 14.8. This was renamed. Use: `paused`. |
|
|
| <a id="grouprunnersmembership"></a>`membership` | [`RunnerMembershipFilter`](#runnermembershipfilter) | Control which runners to include in the results. |
|
|
| <a id="grouprunnerspaused"></a>`paused` | [`Boolean`](#boolean) | Filter runners by `paused` (true) or `active` (false) status. |
|
|
| <a id="grouprunnerssearch"></a>`search` | [`String`](#string) | Filter by full token or partial text in description field. |
|
|
| <a id="grouprunnerssort"></a>`sort` | [`CiRunnerSort`](#cirunnersort) | Sort order of results. |
|
|
| <a id="grouprunnersstatus"></a>`status` | [`CiRunnerStatus`](#cirunnerstatus) | Filter runners by status. |
|
|
| <a id="grouprunnerstaglist"></a>`tagList` | [`[String!]`](#string) | Filter by tags associated with the runner (comma-separated or array). |
|
|
| <a id="grouprunnerstype"></a>`type` | [`CiRunnerType`](#cirunnertype) | Filter runners by type. |
|
|
|
|
##### `Group.scanExecutionPolicies`
|
|
|
|
Scan Execution Policies of the namespace.
|
|
|
|
Returns [`ScanExecutionPolicyConnection`](#scanexecutionpolicyconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupscanexecutionpoliciesactionscantypes"></a>`actionScanTypes` | [`[SecurityReportTypeEnum!]`](#securityreporttypeenum) | Filters policies by the action scan type. Only these scan types are supported: `dast`, `secret_detection`, `cluster_image_scanning`, `container_scanning`, `sast`. |
|
|
| <a id="groupscanexecutionpoliciesrelationship"></a>`relationship` | [`SecurityPolicyRelationType`](#securitypolicyrelationtype) | Filter policies by the given policy relationship. |
|
|
|
|
##### `Group.timelogs`
|
|
|
|
Time logged on issues and merge requests in the group and its subgroups.
|
|
|
|
Returns [`TimelogConnection!`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="grouptimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="grouptimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="grouptimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="grouptimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="grouptimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="grouptimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="grouptimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
##### `Group.vulnerabilities`
|
|
|
|
Vulnerabilities reported on the projects in the group and its subgroups.
|
|
|
|
Returns [`VulnerabilityConnection`](#vulnerabilityconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupvulnerabilitiesclusteragentid"></a>`clusterAgentId` | [`[ClustersAgentID!]`](#clustersagentid) | Filter vulnerabilities by `cluster_agent_id`. Vulnerabilities with a `reportType` of `cluster_image_scanning` are only included with this filter. |
|
|
| <a id="groupvulnerabilitiesclusterid"></a>`clusterId` | [`[ClustersClusterID!]`](#clustersclusterid) | Filter vulnerabilities by `cluster_id`. Vulnerabilities with a `reportType` of `cluster_image_scanning` are only included with this filter. |
|
|
| <a id="groupvulnerabilitieshasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have linked issues. |
|
|
| <a id="groupvulnerabilitieshasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have been resolved on default branch. |
|
|
| <a id="groupvulnerabilitiesimage"></a>`image` | [`[String!]`](#string) | Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a `reportType` that includes `container_scanning`, `cluster_image_scanning`. |
|
|
| <a id="groupvulnerabilitiesprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. |
|
|
| <a id="groupvulnerabilitiesreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. |
|
|
| <a id="groupvulnerabilitiesscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by VulnerabilityScanner.externalId. |
|
|
| <a id="groupvulnerabilitiesscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. |
|
|
| <a id="groupvulnerabilitiesseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. |
|
|
| <a id="groupvulnerabilitiessort"></a>`sort` | [`VulnerabilitySort`](#vulnerabilitysort) | List vulnerabilities by sort order. |
|
|
| <a id="groupvulnerabilitiesstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. |
|
|
|
|
##### `Group.vulnerabilitiesCountByDay`
|
|
|
|
The historical number of vulnerabilities per day for the projects in the group and its subgroups.
|
|
|
|
Returns [`VulnerabilitiesCountByDayConnection`](#vulnerabilitiescountbydayconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupvulnerabilitiescountbydayenddate"></a>`endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. |
|
|
| <a id="groupvulnerabilitiescountbydaystartdate"></a>`startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. |
|
|
|
|
##### `Group.vulnerabilityGrades`
|
|
|
|
Represents vulnerable project counts for each grade.
|
|
|
|
Returns [`[VulnerableProjectsByGrade!]!`](#vulnerableprojectsbygrade).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupvulnerabilitygradesincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include grades belonging to subgroups. |
|
|
|
|
##### `Group.vulnerabilitySeveritiesCount`
|
|
|
|
Counts for each vulnerability severity in the group and its subgroups.
|
|
|
|
Returns [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupvulnerabilityseveritiescounthasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Filter vulnerabilities that do or do not have issues. |
|
|
| <a id="groupvulnerabilityseveritiescounthasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Filter vulnerabilities that do or do not have a resolution. |
|
|
| <a id="groupvulnerabilityseveritiescountprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. |
|
|
| <a id="groupvulnerabilityseveritiescountreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. |
|
|
| <a id="groupvulnerabilityseveritiescountscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by scanner. |
|
|
| <a id="groupvulnerabilityseveritiescountscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. |
|
|
| <a id="groupvulnerabilityseveritiescountseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. |
|
|
| <a id="groupvulnerabilityseveritiescountstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. |
|
|
|
|
##### `Group.workItemTypes`
|
|
|
|
Work item types available to the group. Returns `null` if `work_items` feature flag is disabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
|
|
|
|
Returns [`WorkItemTypeConnection`](#workitemtypeconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupworkitemtypestaskable"></a>`taskable` | [`Boolean`](#boolean) | If `true`, only taskable work item types will be returned. Argument is experimental and can be removed in the future without notice. |
|
|
|
|
### `GroupMember`
|
|
|
|
Represents a Group Membership.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupmemberaccesslevel"></a>`accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. |
|
|
| <a id="groupmembercreatedat"></a>`createdAt` | [`Time`](#time) | Date and time the membership was created. |
|
|
| <a id="groupmembercreatedby"></a>`createdBy` | [`UserCore`](#usercore) | User that authorized membership. |
|
|
| <a id="groupmemberexpiresat"></a>`expiresAt` | [`Time`](#time) | Date and time the membership expires. |
|
|
| <a id="groupmembergroup"></a>`group` | [`Group`](#group) | Group that a User is a member of. |
|
|
| <a id="groupmemberid"></a>`id` | [`ID!`](#id) | ID of the member. |
|
|
| <a id="groupmembernotificationemail"></a>`notificationEmail` | [`String`](#string) | Group notification email for User. Only available for admins. |
|
|
| <a id="groupmemberupdatedat"></a>`updatedAt` | [`Time`](#time) | Date and time the membership was last updated. |
|
|
| <a id="groupmemberuser"></a>`user` | [`UserCore`](#usercore) | User that is associated with the member object. |
|
|
| <a id="groupmemberuserpermissions"></a>`userPermissions` | [`GroupPermissions!`](#grouppermissions) | Permissions for the current user on the resource. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `GroupMember.mergeRequestInteraction`
|
|
|
|
Find a merge request.
|
|
|
|
Returns [`UserMergeRequestInteraction`](#usermergerequestinteraction).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupmembermergerequestinteractionid"></a>`id` | [`MergeRequestID!`](#mergerequestid) | Global ID of the merge request. |
|
|
|
|
### `GroupPermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="grouppermissionscreateprojects"></a>`createProjects` | [`Boolean!`](#boolean) | Indicates the user can perform `create_projects` on this resource. |
|
|
| <a id="grouppermissionsreadgroup"></a>`readGroup` | [`Boolean!`](#boolean) | Indicates the user can perform `read_group` on this resource. |
|
|
|
|
### `GroupReleaseStats`
|
|
|
|
Contains release-related statistics about a group.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupreleasestatsreleasescount"></a>`releasesCount` | [`Int`](#int) | Total number of releases in all descendant projects of the group. |
|
|
| <a id="groupreleasestatsreleasespercentage"></a>`releasesPercentage` | [`Int`](#int) | Percentage of the group's descendant projects that have at least one release. |
|
|
|
|
### `GroupSecurityPolicySource`
|
|
|
|
Represents the source of a security policy belonging to a group.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupsecuritypolicysourceinherited"></a>`inherited` | [`Boolean!`](#boolean) | Indicates whether this policy is inherited from parent group. |
|
|
| <a id="groupsecuritypolicysourcenamespace"></a>`namespace` | [`Namespace`](#namespace) | Project the policy is associated with. |
|
|
|
|
### `GroupStats`
|
|
|
|
Contains statistics about a group.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupstatsreleasestats"></a>`releaseStats` | [`GroupReleaseStats`](#groupreleasestats) | Statistics related to releases within the group. |
|
|
|
|
### `GroupWikiRepositoryRegistry`
|
|
|
|
Represents the Geo sync and verification state of a group wiki repository.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="groupwikirepositoryregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the GroupWikiRepositoryRegistry was created. |
|
|
| <a id="groupwikirepositoryregistrygroupwikirepositoryid"></a>`groupWikiRepositoryId` | [`ID!`](#id) | ID of the Group Wiki Repository. |
|
|
| <a id="groupwikirepositoryregistryid"></a>`id` | [`ID!`](#id) | ID of the GroupWikiRepositoryRegistry. |
|
|
| <a id="groupwikirepositoryregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the GroupWikiRepositoryRegistry. |
|
|
| <a id="groupwikirepositoryregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the GroupWikiRepositoryRegistry. |
|
|
| <a id="groupwikirepositoryregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the GroupWikiRepositoryRegistry should be resynced. |
|
|
| <a id="groupwikirepositoryregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the GroupWikiRepositoryRegistry. |
|
|
| <a id="groupwikirepositoryregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the GroupWikiRepositoryRegistry. |
|
|
|
|
### `HelmFileMetadata`
|
|
|
|
Helm file metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="helmfilemetadatachannel"></a>`channel` | [`String!`](#string) | Channel of the Helm chart. |
|
|
| <a id="helmfilemetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="helmfilemetadatametadata"></a>`metadata` | [`PackageHelmMetadataType!`](#packagehelmmetadatatype) | Metadata of the Helm chart. |
|
|
| <a id="helmfilemetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
|
|
### `IncidentManagementOncallRotation`
|
|
|
|
Describes an incident management on-call rotation.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallrotationactiveperiod"></a>`activePeriod` | [`OncallRotationActivePeriodType`](#oncallrotationactiveperiodtype) | Active period for the on-call rotation. |
|
|
| <a id="incidentmanagementoncallrotationendsat"></a>`endsAt` | [`Time`](#time) | End date and time of the on-call rotation. |
|
|
| <a id="incidentmanagementoncallrotationid"></a>`id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | ID of the on-call rotation. |
|
|
| <a id="incidentmanagementoncallrotationlength"></a>`length` | [`Int`](#int) | Length of the on-call schedule, in the units specified by lengthUnit. |
|
|
| <a id="incidentmanagementoncallrotationlengthunit"></a>`lengthUnit` | [`OncallRotationUnitEnum`](#oncallrotationunitenum) | Unit of the on-call rotation length. |
|
|
| <a id="incidentmanagementoncallrotationname"></a>`name` | [`String!`](#string) | Name of the on-call rotation. |
|
|
| <a id="incidentmanagementoncallrotationparticipants"></a>`participants` | [`OncallParticipantTypeConnection`](#oncallparticipanttypeconnection) | Participants of the on-call rotation. (see [Connections](#connections)) |
|
|
| <a id="incidentmanagementoncallrotationstartsat"></a>`startsAt` | [`Time`](#time) | Start date of the on-call rotation. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `IncidentManagementOncallRotation.shifts`
|
|
|
|
Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month.
|
|
|
|
Returns [`IncidentManagementOncallShiftConnection`](#incidentmanagementoncallshiftconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallrotationshiftsendtime"></a>`endTime` | [`Time!`](#time) | End of timeframe to include shifts for. Cannot exceed one month after start. |
|
|
| <a id="incidentmanagementoncallrotationshiftsstarttime"></a>`startTime` | [`Time!`](#time) | Start of timeframe to include shifts for. |
|
|
|
|
### `IncidentManagementOncallSchedule`
|
|
|
|
Describes an incident management on-call schedule.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallscheduledescription"></a>`description` | [`String`](#string) | Description of the on-call schedule. |
|
|
| <a id="incidentmanagementoncallscheduleiid"></a>`iid` | [`ID!`](#id) | Internal ID of the on-call schedule. |
|
|
| <a id="incidentmanagementoncallschedulename"></a>`name` | [`String!`](#string) | Name of the on-call schedule. |
|
|
| <a id="incidentmanagementoncallscheduleoncallusers"></a>`oncallUsers` | [`[UserCore!]`](#usercore) | |
|
|
| <a id="incidentmanagementoncallschedulerotations"></a>`rotations` | [`IncidentManagementOncallRotationConnection!`](#incidentmanagementoncallrotationconnection) | On-call rotations for the on-call schedule. (see [Connections](#connections)) |
|
|
| <a id="incidentmanagementoncallscheduletimezone"></a>`timezone` | [`String!`](#string) | Time zone of the on-call schedule. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `IncidentManagementOncallSchedule.rotation`
|
|
|
|
On-call rotation for the on-call schedule.
|
|
|
|
Returns [`IncidentManagementOncallRotation`](#incidentmanagementoncallrotation).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallschedulerotationid"></a>`id` | [`IncidentManagementOncallRotationID!`](#incidentmanagementoncallrotationid) | ID of the on-call rotation. |
|
|
|
|
### `IncidentManagementOncallShift`
|
|
|
|
A block of time for which a participant is on-call.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="incidentmanagementoncallshiftendsat"></a>`endsAt` | [`Time`](#time) | End time of the on-call shift. |
|
|
| <a id="incidentmanagementoncallshiftparticipant"></a>`participant` | [`OncallParticipantType`](#oncallparticipanttype) | Participant assigned to the on-call shift. |
|
|
| <a id="incidentmanagementoncallshiftstartsat"></a>`startsAt` | [`Time`](#time) | Start time of the on-call shift. |
|
|
|
|
### `InstanceSecurityDashboard`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="instancesecuritydashboardvulnerabilitygrades"></a>`vulnerabilityGrades` | [`[VulnerableProjectsByGrade!]!`](#vulnerableprojectsbygrade) | Represents vulnerable project counts for each grade. |
|
|
| <a id="instancesecuritydashboardvulnerabilityscanners"></a>`vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. (see [Connections](#connections)) |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `InstanceSecurityDashboard.projects`
|
|
|
|
Projects selected in Instance Security Dashboard.
|
|
|
|
Returns [`ProjectConnection!`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="instancesecuritydashboardprojectssearch"></a>`search` | [`String`](#string) | Search query for project name, path, or description. |
|
|
|
|
##### `InstanceSecurityDashboard.vulnerabilitySeveritiesCount`
|
|
|
|
Counts for each vulnerability severity from projects selected in Instance Security Dashboard.
|
|
|
|
Returns [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="instancesecuritydashboardvulnerabilityseveritiescounthasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Filter vulnerabilities that do or do not have issues. |
|
|
| <a id="instancesecuritydashboardvulnerabilityseveritiescounthasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Filter vulnerabilities that do or do not have a resolution. |
|
|
| <a id="instancesecuritydashboardvulnerabilityseveritiescountprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. |
|
|
| <a id="instancesecuritydashboardvulnerabilityseveritiescountreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. |
|
|
| <a id="instancesecuritydashboardvulnerabilityseveritiescountscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by scanner. |
|
|
| <a id="instancesecuritydashboardvulnerabilityseveritiescountscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. |
|
|
| <a id="instancesecuritydashboardvulnerabilityseveritiescountseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. |
|
|
| <a id="instancesecuritydashboardvulnerabilityseveritiescountstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. |
|
|
|
|
### `Issue`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="issuealertmanagementalert"></a>`alertManagementAlert` | [`AlertManagementAlert`](#alertmanagementalert) | Alert associated to this issue. |
|
|
| <a id="issueassignees"></a>`assignees` | [`UserCoreConnection`](#usercoreconnection) | Assignees of the issue. (see [Connections](#connections)) |
|
|
| <a id="issueauthor"></a>`author` | [`UserCore!`](#usercore) | User that created the issue. |
|
|
| <a id="issueblocked"></a>`blocked` | [`Boolean!`](#boolean) | Indicates the issue is blocked. |
|
|
| <a id="issueblockedbycount"></a>`blockedByCount` | [`Int`](#int) | Count of issues blocking this issue. |
|
|
| <a id="issueblockedbyissues"></a>`blockedByIssues` | [`IssueConnection`](#issueconnection) | Issues blocking this issue. (see [Connections](#connections)) |
|
|
| <a id="issueblockingcount"></a>`blockingCount` | [`Int!`](#int) | Count of issues this issue is blocking. |
|
|
| <a id="issueclosedasduplicateof"></a>`closedAsDuplicateOf` | [`Issue`](#issue) | Issue this issue was closed as a duplicate of. |
|
|
| <a id="issueclosedat"></a>`closedAt` | [`Time`](#time) | Timestamp of when the issue was closed. |
|
|
| <a id="issueconfidential"></a>`confidential` | [`Boolean!`](#boolean) | Indicates the issue is confidential. |
|
|
| <a id="issuecreatenoteemail"></a>`createNoteEmail` | [`String`](#string) | User specific email address for the issue. |
|
|
| <a id="issuecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the issue was created. |
|
|
| <a id="issuecustomerrelationscontacts"></a>`customerRelationsContacts` | [`CustomerRelationsContactConnection`](#customerrelationscontactconnection) | Customer relations contacts of the issue. (see [Connections](#connections)) |
|
|
| <a id="issuedescription"></a>`description` | [`String`](#string) | Description of the issue. |
|
|
| <a id="issuedescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="issuedesigncollection"></a>`designCollection` | [`DesignCollection`](#designcollection) | Collection of design images associated with this issue. |
|
|
| <a id="issuediscussionlocked"></a>`discussionLocked` | [`Boolean!`](#boolean) | Indicates discussion is locked on the issue. |
|
|
| <a id="issuediscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="issuedownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes the issue has received. |
|
|
| <a id="issueduedate"></a>`dueDate` | [`Time`](#time) | Due date of the issue. |
|
|
| <a id="issueemailsdisabled"></a>`emailsDisabled` | [`Boolean!`](#boolean) | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. |
|
|
| <a id="issueepic"></a>`epic` | [`Epic`](#epic) | Epic to which this issue belongs. |
|
|
| <a id="issueescalationpolicy"></a>`escalationPolicy` | [`EscalationPolicyType`](#escalationpolicytype) | Escalation policy associated with the issue. Available for issues which support escalation. |
|
|
| <a id="issueescalationstatus"></a>`escalationStatus` | [`IssueEscalationStatus`](#issueescalationstatus) | Escalation status of the issue. |
|
|
| <a id="issuehealthstatus"></a>`healthStatus` | [`HealthStatus`](#healthstatus) | Current health status. |
|
|
| <a id="issuehidden"></a>`hidden` | [`Boolean`](#boolean) | Indicates the issue is hidden because the author has been banned. Will always return `null` if `ban_user_feature_flag` feature flag is disabled. |
|
|
| <a id="issuehumantimeestimate"></a>`humanTimeEstimate` | [`String`](#string) | Human-readable time estimate of the issue. |
|
|
| <a id="issuehumantotaltimespent"></a>`humanTotalTimeSpent` | [`String`](#string) | Human-readable total time reported as spent on the issue. |
|
|
| <a id="issueid"></a>`id` | [`ID!`](#id) | ID of the issue. |
|
|
| <a id="issueiid"></a>`iid` | [`ID!`](#id) | Internal ID of the issue. |
|
|
| <a id="issueiteration"></a>`iteration` | [`Iteration`](#iteration) | Iteration of the issue. |
|
|
| <a id="issuelabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the issue. (see [Connections](#connections)) |
|
|
| <a id="issuemergerequestscount"></a>`mergeRequestsCount` | [`Int!`](#int) | Number of merge requests that close the issue on merge. |
|
|
| <a id="issuemetricimages"></a>`metricImages` | [`[MetricImage!]`](#metricimage) | Metric images associated to the issue. |
|
|
| <a id="issuemilestone"></a>`milestone` | [`Milestone`](#milestone) | Milestone of the issue. |
|
|
| <a id="issuemoved"></a>`moved` | [`Boolean`](#boolean) | Indicates if issue got moved from other project. |
|
|
| <a id="issuemovedto"></a>`movedTo` | [`Issue`](#issue) | Updated Issue after it got moved to another project. |
|
|
| <a id="issuenotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="issueparticipants"></a>`participants` | [`UserCoreConnection`](#usercoreconnection) | List of participants in the issue. (see [Connections](#connections)) |
|
|
| <a id="issueprojectid"></a>`projectId` | [`Int!`](#int) | ID of the issue project. |
|
|
| <a id="issuerelativeposition"></a>`relativePosition` | [`Int`](#int) | Relative position of the issue (used for positioning in epic tree and issue boards). |
|
|
| <a id="issueseverity"></a>`severity` | [`IssuableSeverity`](#issuableseverity) | Severity level of the incident. |
|
|
| <a id="issuesladueat"></a>`slaDueAt` | [`Time`](#time) | Timestamp of when the issue SLA expires. |
|
|
| <a id="issuestate"></a>`state` | [`IssueState!`](#issuestate) | State of the issue. |
|
|
| <a id="issuestatuspagepublishedincident"></a>`statusPagePublishedIncident` | [`Boolean`](#boolean) | Indicates whether an issue is published to the status page. |
|
|
| <a id="issuesubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates the currently logged in user is subscribed to the issue. |
|
|
| <a id="issuetaskcompletionstatus"></a>`taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Task completion status of the issue. |
|
|
| <a id="issuetimeestimate"></a>`timeEstimate` | [`Int!`](#int) | Time estimate of the issue. |
|
|
| <a id="issuetimelogs"></a>`timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the issue. (see [Connections](#connections)) |
|
|
| <a id="issuetitle"></a>`title` | [`String!`](#string) | Title of the issue. |
|
|
| <a id="issuetitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. |
|
|
| <a id="issuetotaltimespent"></a>`totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the issue. |
|
|
| <a id="issuetype"></a>`type` | [`IssueType`](#issuetype) | Type of the issue. |
|
|
| <a id="issueupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the issue was last updated. |
|
|
| <a id="issueupdatedby"></a>`updatedBy` | [`UserCore`](#usercore) | User that last updated the issue. |
|
|
| <a id="issueupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes the issue has received. |
|
|
| <a id="issueuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the issue. |
|
|
| <a id="issueusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes of the issue. |
|
|
| <a id="issueuserpermissions"></a>`userPermissions` | [`IssuePermissions!`](#issuepermissions) | Permissions for the current user on the resource. |
|
|
| <a id="issuewebpath"></a>`webPath` | [`String!`](#string) | Web path of the issue. |
|
|
| <a id="issueweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the issue. |
|
|
| <a id="issueweight"></a>`weight` | [`Int`](#int) | Weight of the issue. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Issue.currentUserTodos`
|
|
|
|
To-do items for the current user.
|
|
|
|
Returns [`TodoConnection!`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="issuecurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. |
|
|
|
|
##### `Issue.reference`
|
|
|
|
Internal reference of the issue. Returned in shortened format by default.
|
|
|
|
Returns [`String!`](#string).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="issuereferencefull"></a>`full` | [`Boolean`](#boolean) | Boolean option specifying whether the reference should be returned in full. |
|
|
|
|
### `IssuePermissions`
|
|
|
|
Check permissions for the current user on a issue.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="issuepermissionsadminissue"></a>`adminIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_issue` on this resource. |
|
|
| <a id="issuepermissionscreatedesign"></a>`createDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `create_design` on this resource. |
|
|
| <a id="issuepermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. |
|
|
| <a id="issuepermissionsdestroydesign"></a>`destroyDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_design` on this resource. |
|
|
| <a id="issuepermissionsreaddesign"></a>`readDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `read_design` on this resource. |
|
|
| <a id="issuepermissionsreadissue"></a>`readIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `read_issue` on this resource. |
|
|
| <a id="issuepermissionsreopenissue"></a>`reopenIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `reopen_issue` on this resource. |
|
|
| <a id="issuepermissionsupdateissue"></a>`updateIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `update_issue` on this resource. |
|
|
|
|
### `IssueStatusCountsType`
|
|
|
|
Represents total number of issues for the represented statuses.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="issuestatuscountstypeall"></a>`all` | [`Int`](#int) | Number of issues with status ALL for the project. |
|
|
| <a id="issuestatuscountstypeclosed"></a>`closed` | [`Int`](#int) | Number of issues with status CLOSED for the project. |
|
|
| <a id="issuestatuscountstypeopened"></a>`opened` | [`Int`](#int) | Number of issues with status OPENED for the project. |
|
|
|
|
### `Iteration`
|
|
|
|
Represents an iteration object.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="iterationcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of iteration creation. |
|
|
| <a id="iterationdescription"></a>`description` | [`String`](#string) | Description of the iteration. |
|
|
| <a id="iterationdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="iterationduedate"></a>`dueDate` | [`Time`](#time) | Timestamp of the iteration due date. |
|
|
| <a id="iterationid"></a>`id` | [`ID!`](#id) | ID of the iteration. |
|
|
| <a id="iterationiid"></a>`iid` | [`ID!`](#id) | Internal ID of the iteration. |
|
|
| <a id="iterationiterationcadence"></a>`iterationCadence` | [`IterationCadence!`](#iterationcadence) | Cadence of the iteration. |
|
|
| <a id="iterationscopedpath"></a>`scopedPath` | [`String`](#string) | Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. |
|
|
| <a id="iterationscopedurl"></a>`scopedUrl` | [`String`](#string) | Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. |
|
|
| <a id="iterationsequence"></a>`sequence` | [`Int!`](#int) | Sequence number for the iteration when you sort the containing cadence's iterations by the start and end date. The earliest starting and ending iteration is assigned 1. |
|
|
| <a id="iterationstartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the iteration start date. |
|
|
| <a id="iterationstate"></a>`state` | [`IterationState!`](#iterationstate) | State of the iteration. |
|
|
| <a id="iterationtitle"></a>`title` | [`String`](#string) | Title of the iteration. Title must be specified unless iteration_cadences feature flag is enabled. |
|
|
| <a id="iterationupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of last iteration update. |
|
|
| <a id="iterationwebpath"></a>`webPath` | [`String!`](#string) | Web path of the iteration. |
|
|
| <a id="iterationweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the iteration. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Iteration.report`
|
|
|
|
Historically accurate report about the timebox.
|
|
|
|
Returns [`TimeboxReport`](#timeboxreport).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="iterationreportfullpath"></a>`fullPath` | [`String`](#string) | Full path of the project or group used as a scope for report. For example, `gitlab-org` or `gitlab-org/gitlab`. |
|
|
|
|
### `IterationCadence`
|
|
|
|
Represents an iteration cadence.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="iterationcadenceactive"></a>`active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. |
|
|
| <a id="iterationcadenceautomatic"></a>`automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate upcoming iterations. |
|
|
| <a id="iterationcadencedescription"></a>`description` | [`String`](#string) | Description of the iteration cadence. Maximum length is 5000 characters. |
|
|
| <a id="iterationcadencedurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. |
|
|
| <a id="iterationcadenceid"></a>`id` | [`IterationsCadenceID!`](#iterationscadenceid) | Global ID of the iteration cadence. |
|
|
| <a id="iterationcadenceiterationsinadvance"></a>`iterationsInAdvance` | [`Int`](#int) | Upcoming iterations to be created when iteration cadence is set to automatic. |
|
|
| <a id="iterationcadencerollover"></a>`rollOver` | [`Boolean!`](#boolean) | Whether the iteration cadence should roll over issues to the next iteration or not. |
|
|
| <a id="iterationcadencestartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the iteration cadence start date. |
|
|
| <a id="iterationcadencetitle"></a>`title` | [`String!`](#string) | Title of the iteration cadence. |
|
|
|
|
### `JiraImport`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jiraimportcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the Jira import was created. |
|
|
| <a id="jiraimportfailedtoimportcount"></a>`failedToImportCount` | [`Int!`](#int) | Count of issues that failed to import. |
|
|
| <a id="jiraimportimportedissuescount"></a>`importedIssuesCount` | [`Int!`](#int) | Count of issues that were successfully imported. |
|
|
| <a id="jiraimportjiraprojectkey"></a>`jiraProjectKey` | [`String!`](#string) | Project key for the imported Jira project. |
|
|
| <a id="jiraimportscheduledat"></a>`scheduledAt` | [`Time`](#time) | Timestamp of when the Jira import was scheduled. |
|
|
| <a id="jiraimportscheduledby"></a>`scheduledBy` | [`UserCore`](#usercore) | User that started the Jira import. |
|
|
| <a id="jiraimporttotalissuecount"></a>`totalIssueCount` | [`Int!`](#int) | Total count of issues that were attempted to import. |
|
|
|
|
### `JiraProject`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jiraprojectkey"></a>`key` | [`String!`](#string) | Key of the Jira project. |
|
|
| <a id="jiraprojectname"></a>`name` | [`String`](#string) | Name of the Jira project. |
|
|
| <a id="jiraprojectprojectid"></a>`projectId` | [`Int!`](#int) | ID of the Jira project. |
|
|
|
|
### `JiraService`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jiraserviceactive"></a>`active` | [`Boolean`](#boolean) | Indicates if the service is active. |
|
|
| <a id="jiraserviceservicetype"></a>`serviceType` | [`ServiceType`](#servicetype) | Type of the service. |
|
|
| <a id="jiraservicetype"></a>`type` | [`String`](#string) | Class name of the service. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `JiraService.projects`
|
|
|
|
List of all Jira projects fetched through Jira REST API.
|
|
|
|
Returns [`JiraProjectConnection`](#jiraprojectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jiraserviceprojectsname"></a>`name` | [`String`](#string) | Project name or key. |
|
|
|
|
### `JiraUser`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jirausergitlabid"></a>`gitlabId` | [`Int`](#int) | ID of the matched GitLab user. |
|
|
| <a id="jirausergitlabname"></a>`gitlabName` | [`String`](#string) | Name of the matched GitLab user. |
|
|
| <a id="jirausergitlabusername"></a>`gitlabUsername` | [`String`](#string) | Username of the matched GitLab user. |
|
|
| <a id="jirauserjiraaccountid"></a>`jiraAccountId` | [`String!`](#string) | Account ID of the Jira user. |
|
|
| <a id="jirauserjiradisplayname"></a>`jiraDisplayName` | [`String!`](#string) | Display name of the Jira user. |
|
|
| <a id="jirauserjiraemail"></a>`jiraEmail` | [`String`](#string) | Email of the Jira user, returned only for users with public emails. |
|
|
|
|
### `JobArtifactRegistry`
|
|
|
|
Represents the Geo replication and verification state of a job_artifact.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jobartifactregistryartifactid"></a>`artifactId` | [`ID!`](#id) | ID of the Job Artifact. |
|
|
| <a id="jobartifactregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the JobArtifactRegistry was created. |
|
|
| <a id="jobartifactregistryid"></a>`id` | [`ID!`](#id) | ID of the JobArtifactRegistry. |
|
|
| <a id="jobartifactregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the JobArtifactRegistry. |
|
|
| <a id="jobartifactregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the JobArtifactRegistry. |
|
|
| <a id="jobartifactregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the JobArtifactRegistry should be resynced. |
|
|
| <a id="jobartifactregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the JobArtifactRegistry. |
|
|
| <a id="jobartifactregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the JobArtifactRegistry. |
|
|
|
|
### `JobPermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jobpermissionsreadbuild"></a>`readBuild` | [`Boolean!`](#boolean) | Indicates the user can perform `read_build` on this resource. |
|
|
| <a id="jobpermissionsreadjobartifacts"></a>`readJobArtifacts` | [`Boolean!`](#boolean) | Indicates the user can perform `read_job_artifacts` on this resource. |
|
|
| <a id="jobpermissionsupdatebuild"></a>`updateBuild` | [`Boolean!`](#boolean) | Indicates the user can perform `update_build` on this resource. |
|
|
|
|
### `Kas`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="kasenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether the Kubernetes Agent Server is enabled. |
|
|
| <a id="kasexternalurl"></a>`externalUrl` | [`String`](#string) | URL used by the Agents to communicate with KAS. |
|
|
| <a id="kasversion"></a>`version` | [`String`](#string) | KAS version. |
|
|
|
|
### `Label`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="labelcolor"></a>`color` | [`String!`](#string) | Background color of the label. |
|
|
| <a id="labelcreatedat"></a>`createdAt` | [`Time!`](#time) | When this label was created. |
|
|
| <a id="labeldescription"></a>`description` | [`String`](#string) | Description of the label (Markdown rendered as HTML for caching). |
|
|
| <a id="labeldescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="labelid"></a>`id` | [`ID!`](#id) | Label ID. |
|
|
| <a id="labeltextcolor"></a>`textColor` | [`String!`](#string) | Text color of the label. |
|
|
| <a id="labeltitle"></a>`title` | [`String!`](#string) | Content of the label. |
|
|
| <a id="labelupdatedat"></a>`updatedAt` | [`Time!`](#time) | When this label was last updated. |
|
|
|
|
### `LfsObjectRegistry`
|
|
|
|
Represents the Geo sync and verification state of an LFS object.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="lfsobjectregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the LfsObjectRegistry was created. |
|
|
| <a id="lfsobjectregistryid"></a>`id` | [`ID!`](#id) | ID of the LfsObjectRegistry. |
|
|
| <a id="lfsobjectregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the LfsObjectRegistry. |
|
|
| <a id="lfsobjectregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the LfsObjectRegistry. |
|
|
| <a id="lfsobjectregistrylfsobjectid"></a>`lfsObjectId` | [`ID!`](#id) | ID of the LFS object. |
|
|
| <a id="lfsobjectregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the LfsObjectRegistry should be resynced. |
|
|
| <a id="lfsobjectregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the LfsObjectRegistry. |
|
|
| <a id="lfsobjectregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the LfsObjectRegistry. |
|
|
|
|
### `LicenseHistoryEntry`
|
|
|
|
Represents an entry from the Cloud License history.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="licensehistoryentryactivatedat"></a>`activatedAt` | [`Date`](#date) | Date when the license was activated. |
|
|
| <a id="licensehistoryentryblockchangesat"></a>`blockChangesAt` | [`Date`](#date) | Date, including grace period, when licensed features will be blocked. |
|
|
| <a id="licensehistoryentrycompany"></a>`company` | [`String`](#string) | Company of the licensee. |
|
|
| <a id="licensehistoryentrycreatedat"></a>`createdAt` | [`Date`](#date) | Date when the license was added. |
|
|
| <a id="licensehistoryentryemail"></a>`email` | [`String`](#string) | Email of the licensee. |
|
|
| <a id="licensehistoryentryexpiresat"></a>`expiresAt` | [`Date`](#date) | Date when the license expires. |
|
|
| <a id="licensehistoryentryid"></a>`id` | [`ID!`](#id) | ID of the license extracted from the license data. |
|
|
| <a id="licensehistoryentryname"></a>`name` | [`String`](#string) | Name of the licensee. |
|
|
| <a id="licensehistoryentryplan"></a>`plan` | [`String!`](#string) | Name of the subscription plan. |
|
|
| <a id="licensehistoryentrystartsat"></a>`startsAt` | [`Date`](#date) | Date when the license started. |
|
|
| <a id="licensehistoryentrytype"></a>`type` | [`String!`](#string) | Type of the license. |
|
|
| <a id="licensehistoryentryusersinlicensecount"></a>`usersInLicenseCount` | [`Int`](#int) | Number of paid users in the license. |
|
|
|
|
### `MavenMetadata`
|
|
|
|
Maven metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mavenmetadataappgroup"></a>`appGroup` | [`String!`](#string) | App group of the Maven package. |
|
|
| <a id="mavenmetadataappname"></a>`appName` | [`String!`](#string) | App name of the Maven package. |
|
|
| <a id="mavenmetadataappversion"></a>`appVersion` | [`String`](#string) | App version of the Maven package. |
|
|
| <a id="mavenmetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="mavenmetadataid"></a>`id` | [`PackagesMavenMetadatumID!`](#packagesmavenmetadatumid) | ID of the metadatum. |
|
|
| <a id="mavenmetadatapath"></a>`path` | [`String!`](#string) | Path of the Maven package. |
|
|
| <a id="mavenmetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
|
|
### `MergeRequest`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestallowcollaboration"></a>`allowCollaboration` | [`Boolean`](#boolean) | Indicates if members of the target project can push to the fork. |
|
|
| <a id="mergerequestapprovalstate"></a>`approvalState` | [`MergeRequestApprovalState!`](#mergerequestapprovalstate) | Information relating to rules that must be satisfied to merge this merge request. |
|
|
| <a id="mergerequestapprovalsleft"></a>`approvalsLeft` | [`Int`](#int) | Number of approvals left. |
|
|
| <a id="mergerequestapprovalsrequired"></a>`approvalsRequired` | [`Int`](#int) | Number of approvals required. |
|
|
| <a id="mergerequestapproved"></a>`approved` | [`Boolean!`](#boolean) | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. |
|
|
| <a id="mergerequestapprovedby"></a>`approvedBy` | [`UserCoreConnection`](#usercoreconnection) | Users who approved the merge request. (see [Connections](#connections)) |
|
|
| <a id="mergerequestassignees"></a>`assignees` | [`MergeRequestAssigneeConnection`](#mergerequestassigneeconnection) | Assignees of the merge request. (see [Connections](#connections)) |
|
|
| <a id="mergerequestauthor"></a>`author` | [`MergeRequestAuthor`](#mergerequestauthor) | User who created this merge request. |
|
|
| <a id="mergerequestautomergeenabled"></a>`autoMergeEnabled` | [`Boolean!`](#boolean) | Indicates if auto merge is enabled for the merge request. |
|
|
| <a id="mergerequestautomergestrategy"></a>`autoMergeStrategy` | [`String`](#string) | Selected auto merge strategy. |
|
|
| <a id="mergerequestavailableautomergestrategies"></a>`availableAutoMergeStrategies` | [`[String!]`](#string) | Array of available auto merge strategies. |
|
|
| <a id="mergerequestcommitcount"></a>`commitCount` | [`Int`](#int) | Number of commits in the merge request. |
|
|
| <a id="mergerequestcommits"></a>`commits` | [`CommitConnection`](#commitconnection) | Merge request commits. (see [Connections](#connections)) |
|
|
| <a id="mergerequestcommitswithoutmergecommits"></a>`commitsWithoutMergeCommits` | [`CommitConnection`](#commitconnection) | Merge request commits excluding merge commits. (see [Connections](#connections)) |
|
|
| <a id="mergerequestcommitters"></a>`committers` | [`UserCoreConnection`](#usercoreconnection) | Users who have added commits to the merge request. (see [Connections](#connections)) |
|
|
| <a id="mergerequestconflicts"></a>`conflicts` | [`Boolean!`](#boolean) | Indicates if the merge request has conflicts. |
|
|
| <a id="mergerequestcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the merge request was created. |
|
|
| <a id="mergerequestdefaultmergecommitmessage"></a>`defaultMergeCommitMessage` | [`String`](#string) | Default merge commit message of the merge request. |
|
|
| <a id="mergerequestdefaultsquashcommitmessage"></a>`defaultSquashCommitMessage` | [`String`](#string) | Default squash commit message of the merge request. |
|
|
| <a id="mergerequestdescription"></a>`description` | [`String`](#string) | Description of the merge request (Markdown rendered as HTML for caching). |
|
|
| <a id="mergerequestdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="mergerequestdiffheadsha"></a>`diffHeadSha` | [`String`](#string) | Diff head SHA of the merge request. |
|
|
| <a id="mergerequestdiffrefs"></a>`diffRefs` | [`DiffRefs`](#diffrefs) | References of the base SHA, the head SHA, and the start SHA for this merge request. |
|
|
| <a id="mergerequestdiffstatssummary"></a>`diffStatsSummary` | [`DiffStatsSummary`](#diffstatssummary) | Summary of which files were changed in this merge request. |
|
|
| <a id="mergerequestdiscussionlocked"></a>`discussionLocked` | [`Boolean!`](#boolean) | Indicates if comments on the merge request are locked to members only. |
|
|
| <a id="mergerequestdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="mergerequestdivergedfromtargetbranch"></a>`divergedFromTargetBranch` | [`Boolean!`](#boolean) | Indicates if the source branch is behind the target branch. |
|
|
| <a id="mergerequestdownvotes"></a>`downvotes` | [`Int!`](#int) | Number of downvotes for the merge request. |
|
|
| <a id="mergerequestdraft"></a>`draft` | [`Boolean!`](#boolean) | Indicates if the merge request is a draft. |
|
|
| <a id="mergerequestforceremovesourcebranch"></a>`forceRemoveSourceBranch` | [`Boolean`](#boolean) | Indicates if the project settings will lead to source branch deletion after merge. |
|
|
| <a id="mergerequesthasci"></a>`hasCi` | [`Boolean!`](#boolean) | Indicates if the merge request has CI. |
|
|
| <a id="mergerequesthassecurityreports"></a>`hasSecurityReports` | [`Boolean!`](#boolean) | Indicates if the source branch has any security reports. |
|
|
| <a id="mergerequestheadpipeline"></a>`headPipeline` | [`Pipeline`](#pipeline) | Pipeline running on the branch HEAD of the merge request. |
|
|
| <a id="mergerequesthumantimeestimate"></a>`humanTimeEstimate` | [`String`](#string) | Human-readable time estimate of the merge request. |
|
|
| <a id="mergerequesthumantotaltimespent"></a>`humanTotalTimeSpent` | [`String`](#string) | Human-readable total time reported as spent on the merge request. |
|
|
| <a id="mergerequestid"></a>`id` | [`ID!`](#id) | ID of the merge request. |
|
|
| <a id="mergerequestiid"></a>`iid` | [`String!`](#string) | Internal ID of the merge request. |
|
|
| <a id="mergerequestinprogressmergecommitsha"></a>`inProgressMergeCommitSha` | [`String`](#string) | Commit SHA of the merge request if merge is in progress. |
|
|
| <a id="mergerequestlabels"></a>`labels` | [`LabelConnection`](#labelconnection) | Labels of the merge request. (see [Connections](#connections)) |
|
|
| <a id="mergerequestmergecommitsha"></a>`mergeCommitSha` | [`String`](#string) | SHA of the merge request commit (set once merged). |
|
|
| <a id="mergerequestmergeerror"></a>`mergeError` | [`String`](#string) | Error message due to a merge error. |
|
|
| <a id="mergerequestmergeongoing"></a>`mergeOngoing` | [`Boolean!`](#boolean) | Indicates if a merge is currently occurring. |
|
|
| <a id="mergerequestmergestatus"></a>`mergeStatus` **{warning-solid}** | [`String`](#string) | **Deprecated** in 14.0. This was renamed. Use: [`MergeRequest.mergeStatusEnum`](#mergerequestmergestatusenum). |
|
|
| <a id="mergerequestmergestatusenum"></a>`mergeStatusEnum` | [`MergeStatus`](#mergestatus) | Merge status of the merge request. |
|
|
| <a id="mergerequestmergetrainscount"></a>`mergeTrainsCount` | [`Int`](#int) | Number of merge requests in the merge train. |
|
|
| <a id="mergerequestmergeuser"></a>`mergeUser` | [`UserCore`](#usercore) | User who merged this merge request or set it to merge when pipeline succeeds. |
|
|
| <a id="mergerequestmergewhenpipelinesucceeds"></a>`mergeWhenPipelineSucceeds` | [`Boolean`](#boolean) | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS). |
|
|
| <a id="mergerequestmergeable"></a>`mergeable` | [`Boolean!`](#boolean) | Indicates if the merge request is mergeable. |
|
|
| <a id="mergerequestmergeablediscussionsstate"></a>`mergeableDiscussionsState` | [`Boolean`](#boolean) | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged. |
|
|
| <a id="mergerequestmergedat"></a>`mergedAt` | [`Time`](#time) | Timestamp of when the merge request was merged, null if not merged. |
|
|
| <a id="mergerequestmilestone"></a>`milestone` | [`Milestone`](#milestone) | Milestone of the merge request. |
|
|
| <a id="mergerequestnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="mergerequestparticipants"></a>`participants` | [`MergeRequestParticipantConnection`](#mergerequestparticipantconnection) | Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. (see [Connections](#connections)) |
|
|
| <a id="mergerequestproject"></a>`project` | [`Project!`](#project) | Alias for target_project. |
|
|
| <a id="mergerequestprojectid"></a>`projectId` | [`Int!`](#int) | ID of the merge request project. |
|
|
| <a id="mergerequestrebasecommitsha"></a>`rebaseCommitSha` | [`String`](#string) | Rebase commit SHA of the merge request. |
|
|
| <a id="mergerequestrebaseinprogress"></a>`rebaseInProgress` | [`Boolean!`](#boolean) | Indicates if there is a rebase currently in progress for the merge request. |
|
|
| <a id="mergerequestreviewers"></a>`reviewers` | [`MergeRequestReviewerConnection`](#mergerequestreviewerconnection) | Users from whom a review has been requested. (see [Connections](#connections)) |
|
|
| <a id="mergerequestsecurityautofix"></a>`securityAutoFix` | [`Boolean`](#boolean) | Indicates if the merge request is created by @GitLab-Security-Bot. |
|
|
| <a id="mergerequestsecurityreportsuptodateontargetbranch"></a>`securityReportsUpToDateOnTargetBranch` | [`Boolean!`](#boolean) | Indicates if the target branch security reports are out of date. |
|
|
| <a id="mergerequestshouldberebased"></a>`shouldBeRebased` | [`Boolean!`](#boolean) | Indicates if the merge request will be rebased. |
|
|
| <a id="mergerequestshouldremovesourcebranch"></a>`shouldRemoveSourceBranch` | [`Boolean`](#boolean) | Indicates if the source branch of the merge request will be deleted after merge. |
|
|
| <a id="mergerequestsourcebranch"></a>`sourceBranch` | [`String!`](#string) | Source branch of the merge request. |
|
|
| <a id="mergerequestsourcebranchexists"></a>`sourceBranchExists` | [`Boolean!`](#boolean) | Indicates if the source branch of the merge request exists. |
|
|
| <a id="mergerequestsourcebranchprotected"></a>`sourceBranchProtected` | [`Boolean!`](#boolean) | Indicates if the source branch is protected. |
|
|
| <a id="mergerequestsourceproject"></a>`sourceProject` | [`Project`](#project) | Source project of the merge request. |
|
|
| <a id="mergerequestsourceprojectid"></a>`sourceProjectId` | [`Int`](#int) | ID of the merge request source project. |
|
|
| <a id="mergerequestsquash"></a>`squash` | [`Boolean!`](#boolean) | Indicates if squash on merge is enabled. |
|
|
| <a id="mergerequestsquashonmerge"></a>`squashOnMerge` | [`Boolean!`](#boolean) | Indicates if squash on merge is enabled. |
|
|
| <a id="mergerequeststate"></a>`state` | [`MergeRequestState!`](#mergerequeststate) | State of the merge request. |
|
|
| <a id="mergerequestsubscribed"></a>`subscribed` | [`Boolean!`](#boolean) | Indicates if the currently logged in user is subscribed to this merge request. |
|
|
| <a id="mergerequesttargetbranch"></a>`targetBranch` | [`String!`](#string) | Target branch of the merge request. |
|
|
| <a id="mergerequesttargetbranchexists"></a>`targetBranchExists` | [`Boolean!`](#boolean) | Indicates if the target branch of the merge request exists. |
|
|
| <a id="mergerequesttargetproject"></a>`targetProject` | [`Project!`](#project) | Target project of the merge request. |
|
|
| <a id="mergerequesttargetprojectid"></a>`targetProjectId` | [`Int!`](#int) | ID of the merge request target project. |
|
|
| <a id="mergerequesttaskcompletionstatus"></a>`taskCompletionStatus` | [`TaskCompletionStatus!`](#taskcompletionstatus) | Completion status of tasks. |
|
|
| <a id="mergerequesttimeestimate"></a>`timeEstimate` | [`Int!`](#int) | Time estimate of the merge request. |
|
|
| <a id="mergerequesttimelogs"></a>`timelogs` | [`TimelogConnection!`](#timelogconnection) | Timelogs on the merge request. (see [Connections](#connections)) |
|
|
| <a id="mergerequesttitle"></a>`title` | [`String!`](#string) | Title of the merge request. |
|
|
| <a id="mergerequesttitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. |
|
|
| <a id="mergerequesttotaltimespent"></a>`totalTimeSpent` | [`Int!`](#int) | Total time reported as spent on the merge request. |
|
|
| <a id="mergerequestupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the merge request was last updated. |
|
|
| <a id="mergerequestupvotes"></a>`upvotes` | [`Int!`](#int) | Number of upvotes for the merge request. |
|
|
| <a id="mergerequestuserdiscussionscount"></a>`userDiscussionsCount` | [`Int`](#int) | Number of user discussions in the merge request. |
|
|
| <a id="mergerequestusernotescount"></a>`userNotesCount` | [`Int`](#int) | User notes count of the merge request. |
|
|
| <a id="mergerequestuserpermissions"></a>`userPermissions` | [`MergeRequestPermissions!`](#mergerequestpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="mergerequestweburl"></a>`webUrl` | [`String`](#string) | Web URL of the merge request. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `MergeRequest.currentUserTodos`
|
|
|
|
To-do items for the current user.
|
|
|
|
Returns [`TodoConnection!`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestcurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. |
|
|
|
|
##### `MergeRequest.diffStats`
|
|
|
|
Details about which files were changed in this merge request.
|
|
|
|
Returns [`[DiffStats!]`](#diffstats).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestdiffstatspath"></a>`path` | [`String`](#string) | Specific file path. |
|
|
|
|
##### `MergeRequest.pipelines`
|
|
|
|
Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned.
|
|
|
|
Returns [`PipelineConnection`](#pipelineconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestpipelinesref"></a>`ref` | [`String`](#string) | Filter pipelines by the ref they are run for. |
|
|
| <a id="mergerequestpipelinesscope"></a>`scope` | [`PipelineScopeEnum`](#pipelinescopeenum) | Filter pipelines by scope. |
|
|
| <a id="mergerequestpipelinessha"></a>`sha` | [`String`](#string) | Filter pipelines by the sha of the commit they are run for. |
|
|
| <a id="mergerequestpipelinessource"></a>`source` | [`String`](#string) | Filter pipelines by their source. |
|
|
| <a id="mergerequestpipelinesstatus"></a>`status` | [`PipelineStatusEnum`](#pipelinestatusenum) | Filter pipelines by their status. |
|
|
| <a id="mergerequestpipelinesupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Pipelines updated after this date. |
|
|
| <a id="mergerequestpipelinesupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Pipelines updated before this date. |
|
|
| <a id="mergerequestpipelinesusername"></a>`username` | [`String`](#string) | Filter pipelines by the user that triggered the pipeline. |
|
|
|
|
##### `MergeRequest.reference`
|
|
|
|
Internal reference of the merge request. Returned in shortened format by default.
|
|
|
|
Returns [`String!`](#string).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreferencefull"></a>`full` | [`Boolean`](#boolean) | Boolean option specifying whether the reference should be returned in full. |
|
|
|
|
### `MergeRequestApprovalState`
|
|
|
|
Information relating to rules that must be satisfied to merge this merge request.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestapprovalstateapprovalrulesoverwritten"></a>`approvalRulesOverwritten` | [`Boolean`](#boolean) | Indicates if the merge request approval rules are overwritten for the merge request. |
|
|
| <a id="mergerequestapprovalstaterules"></a>`rules` | [`[ApprovalRule!]`](#approvalrule) | List of approval rules associated with the merge request. |
|
|
|
|
### `MergeRequestAssignee`
|
|
|
|
A user assigned to a merge request.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneeavatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. |
|
|
| <a id="mergerequestassigneebot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. |
|
|
| <a id="mergerequestassigneecallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestassigneeemail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). |
|
|
| <a id="mergerequestassigneegitpodenabled"></a>`gitpodEnabled` | [`Boolean`](#boolean) | Whether Gitpod is enabled at the user level. |
|
|
| <a id="mergerequestassigneegroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. |
|
|
| <a id="mergerequestassigneegroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestassigneeid"></a>`id` | [`ID!`](#id) | ID of the user. |
|
|
| <a id="mergerequestassigneelocation"></a>`location` | [`String`](#string) | Location of the user. |
|
|
| <a id="mergerequestassigneemergerequestinteraction"></a>`mergeRequestInteraction` | [`UserMergeRequestInteraction`](#usermergerequestinteraction) | Details of this user's interactions with the merge request. |
|
|
| <a id="mergerequestassigneename"></a>`name` | [`String!`](#string) | Human-readable name of the user. Returns `****` if the user is a project bot and the requester does not have permission to view the project. |
|
|
| <a id="mergerequestassigneenamespace"></a>`namespace` | [`Namespace`](#namespace) | Personal namespace of the user. |
|
|
| <a id="mergerequestassigneepreferencesgitpodpath"></a>`preferencesGitpodPath` | [`String`](#string) | Web path to the Gitpod section within user preferences. |
|
|
| <a id="mergerequestassigneeprofileenablegitpodpath"></a>`profileEnableGitpodPath` | [`String`](#string) | Web path to enable Gitpod for the user. |
|
|
| <a id="mergerequestassigneeprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestassigneepublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. |
|
|
| <a id="mergerequestassigneesavedreplies"></a>`savedReplies` | [`SavedReplyConnection`](#savedreplyconnection) | Saved replies authored by the user. Will not return saved replies if `saved_replies` feature flag is disabled. (see [Connections](#connections)) |
|
|
| <a id="mergerequestassigneestate"></a>`state` | [`UserState!`](#userstate) | State of the user. |
|
|
| <a id="mergerequestassigneestatus"></a>`status` | [`UserStatus`](#userstatus) | User status. |
|
|
| <a id="mergerequestassigneeuserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="mergerequestassigneeusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. |
|
|
| <a id="mergerequestassigneewebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. |
|
|
| <a id="mergerequestassigneeweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `MergeRequestAssignee.assignedMergeRequests`
|
|
|
|
Merge requests assigned to the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneeassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="mergerequestassigneeassignedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestassigneeassignedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestassigneeassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="mergerequestassigneeassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestassigneeassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestassigneeassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestassigneeassignedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestAssignee.authoredMergeRequests`
|
|
|
|
Merge requests authored by the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestassigneeauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestassigneeauthoredmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestAssignee.groups`
|
|
|
|
Groups where the user has access.
|
|
|
|
Returns [`GroupConnection`](#groupconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneegroupspermissionscope"></a>`permissionScope` | [`GroupPermission`](#grouppermission) | Filter by permissions the user has on groups. |
|
|
| <a id="mergerequestassigneegroupssearch"></a>`search` | [`String`](#string) | Search by group name or path. |
|
|
|
|
##### `MergeRequestAssignee.reviewRequestedMergeRequests`
|
|
|
|
Merge requests assigned to the user for review.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestassigneereviewrequestedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestAssignee.snippets`
|
|
|
|
Snippets authored by the user.
|
|
|
|
Returns [`SnippetConnection`](#snippetconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneesnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. |
|
|
| <a id="mergerequestassigneesnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | Type of snippet. |
|
|
| <a id="mergerequestassigneesnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. |
|
|
|
|
##### `MergeRequestAssignee.starredProjects`
|
|
|
|
Projects starred by the user.
|
|
|
|
Returns [`ProjectConnection`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneestarredprojectssearch"></a>`search` | [`String`](#string) | Search query. |
|
|
|
|
##### `MergeRequestAssignee.timelogs`
|
|
|
|
Time logged by the user.
|
|
|
|
Returns [`TimelogConnection`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneetimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="mergerequestassigneetimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="mergerequestassigneetimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="mergerequestassigneetimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="mergerequestassigneetimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="mergerequestassigneetimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="mergerequestassigneetimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
##### `MergeRequestAssignee.todos`
|
|
|
|
To-do items of the user.
|
|
|
|
Returns [`TodoConnection`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestassigneetodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | Action to be filtered. |
|
|
| <a id="mergerequestassigneetodosauthorid"></a>`authorId` | [`[ID!]`](#id) | ID of an author. |
|
|
| <a id="mergerequestassigneetodosgroupid"></a>`groupId` | [`[ID!]`](#id) | ID of a group. |
|
|
| <a id="mergerequestassigneetodosprojectid"></a>`projectId` | [`[ID!]`](#id) | ID of a project. |
|
|
| <a id="mergerequestassigneetodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | State of the todo. |
|
|
| <a id="mergerequestassigneetodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | Type of the todo. |
|
|
|
|
### `MergeRequestAuthor`
|
|
|
|
The author of the merge request.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthoravatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. |
|
|
| <a id="mergerequestauthorbot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. |
|
|
| <a id="mergerequestauthorcallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestauthoremail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). |
|
|
| <a id="mergerequestauthorgitpodenabled"></a>`gitpodEnabled` | [`Boolean`](#boolean) | Whether Gitpod is enabled at the user level. |
|
|
| <a id="mergerequestauthorgroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. |
|
|
| <a id="mergerequestauthorgroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestauthorid"></a>`id` | [`ID!`](#id) | ID of the user. |
|
|
| <a id="mergerequestauthorlocation"></a>`location` | [`String`](#string) | Location of the user. |
|
|
| <a id="mergerequestauthormergerequestinteraction"></a>`mergeRequestInteraction` | [`UserMergeRequestInteraction`](#usermergerequestinteraction) | Details of this user's interactions with the merge request. |
|
|
| <a id="mergerequestauthorname"></a>`name` | [`String!`](#string) | Human-readable name of the user. Returns `****` if the user is a project bot and the requester does not have permission to view the project. |
|
|
| <a id="mergerequestauthornamespace"></a>`namespace` | [`Namespace`](#namespace) | Personal namespace of the user. |
|
|
| <a id="mergerequestauthorpreferencesgitpodpath"></a>`preferencesGitpodPath` | [`String`](#string) | Web path to the Gitpod section within user preferences. |
|
|
| <a id="mergerequestauthorprofileenablegitpodpath"></a>`profileEnableGitpodPath` | [`String`](#string) | Web path to enable Gitpod for the user. |
|
|
| <a id="mergerequestauthorprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestauthorpublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. |
|
|
| <a id="mergerequestauthorsavedreplies"></a>`savedReplies` | [`SavedReplyConnection`](#savedreplyconnection) | Saved replies authored by the user. Will not return saved replies if `saved_replies` feature flag is disabled. (see [Connections](#connections)) |
|
|
| <a id="mergerequestauthorstate"></a>`state` | [`UserState!`](#userstate) | State of the user. |
|
|
| <a id="mergerequestauthorstatus"></a>`status` | [`UserStatus`](#userstatus) | User status. |
|
|
| <a id="mergerequestauthoruserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="mergerequestauthorusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. |
|
|
| <a id="mergerequestauthorwebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. |
|
|
| <a id="mergerequestauthorweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `MergeRequestAuthor.assignedMergeRequests`
|
|
|
|
Merge requests assigned to the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthorassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="mergerequestauthorassignedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestauthorassignedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestauthorassignedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestauthorassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestauthorassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestauthorassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestauthorassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestauthorassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestauthorassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestauthorassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestauthorassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestauthorassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="mergerequestauthorassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestauthorassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestauthorassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestauthorassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestauthorassignedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestauthorassignedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestAuthor.authoredMergeRequests`
|
|
|
|
Merge requests authored by the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthorauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="mergerequestauthorauthoredmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestauthorauthoredmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestauthorauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="mergerequestauthorauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestauthorauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestauthorauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestauthorauthoredmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestAuthor.groups`
|
|
|
|
Groups where the user has access.
|
|
|
|
Returns [`GroupConnection`](#groupconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthorgroupspermissionscope"></a>`permissionScope` | [`GroupPermission`](#grouppermission) | Filter by permissions the user has on groups. |
|
|
| <a id="mergerequestauthorgroupssearch"></a>`search` | [`String`](#string) | Search by group name or path. |
|
|
|
|
##### `MergeRequestAuthor.reviewRequestedMergeRequests`
|
|
|
|
Merge requests assigned to the user for review.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestauthorreviewrequestedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestAuthor.snippets`
|
|
|
|
Snippets authored by the user.
|
|
|
|
Returns [`SnippetConnection`](#snippetconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthorsnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. |
|
|
| <a id="mergerequestauthorsnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | Type of snippet. |
|
|
| <a id="mergerequestauthorsnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. |
|
|
|
|
##### `MergeRequestAuthor.starredProjects`
|
|
|
|
Projects starred by the user.
|
|
|
|
Returns [`ProjectConnection`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthorstarredprojectssearch"></a>`search` | [`String`](#string) | Search query. |
|
|
|
|
##### `MergeRequestAuthor.timelogs`
|
|
|
|
Time logged by the user.
|
|
|
|
Returns [`TimelogConnection`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthortimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="mergerequestauthortimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="mergerequestauthortimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="mergerequestauthortimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="mergerequestauthortimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="mergerequestauthortimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="mergerequestauthortimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
##### `MergeRequestAuthor.todos`
|
|
|
|
To-do items of the user.
|
|
|
|
Returns [`TodoConnection`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestauthortodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | Action to be filtered. |
|
|
| <a id="mergerequestauthortodosauthorid"></a>`authorId` | [`[ID!]`](#id) | ID of an author. |
|
|
| <a id="mergerequestauthortodosgroupid"></a>`groupId` | [`[ID!]`](#id) | ID of a group. |
|
|
| <a id="mergerequestauthortodosprojectid"></a>`projectId` | [`[ID!]`](#id) | ID of a project. |
|
|
| <a id="mergerequestauthortodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | State of the todo. |
|
|
| <a id="mergerequestauthortodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | Type of the todo. |
|
|
|
|
### `MergeRequestDiffRegistry`
|
|
|
|
Represents the Geo sync and verification state of a Merge Request diff.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestdiffregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the MergeRequestDiffRegistry was created. |
|
|
| <a id="mergerequestdiffregistryid"></a>`id` | [`ID!`](#id) | ID of the MergeRequestDiffRegistry. |
|
|
| <a id="mergerequestdiffregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the MergeRequestDiffRegistry. |
|
|
| <a id="mergerequestdiffregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the MergeRequestDiffRegistry. |
|
|
| <a id="mergerequestdiffregistrymergerequestdiffid"></a>`mergeRequestDiffId` | [`ID!`](#id) | ID of the Merge Request diff. |
|
|
| <a id="mergerequestdiffregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the MergeRequestDiffRegistry should be resynced. |
|
|
| <a id="mergerequestdiffregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the MergeRequestDiffRegistry. |
|
|
| <a id="mergerequestdiffregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the MergeRequestDiffRegistry. |
|
|
|
|
### `MergeRequestParticipant`
|
|
|
|
A user participating in a merge request.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantavatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. |
|
|
| <a id="mergerequestparticipantbot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. |
|
|
| <a id="mergerequestparticipantcallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestparticipantemail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). |
|
|
| <a id="mergerequestparticipantgitpodenabled"></a>`gitpodEnabled` | [`Boolean`](#boolean) | Whether Gitpod is enabled at the user level. |
|
|
| <a id="mergerequestparticipantgroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. |
|
|
| <a id="mergerequestparticipantgroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestparticipantid"></a>`id` | [`ID!`](#id) | ID of the user. |
|
|
| <a id="mergerequestparticipantlocation"></a>`location` | [`String`](#string) | Location of the user. |
|
|
| <a id="mergerequestparticipantmergerequestinteraction"></a>`mergeRequestInteraction` | [`UserMergeRequestInteraction`](#usermergerequestinteraction) | Details of this user's interactions with the merge request. |
|
|
| <a id="mergerequestparticipantname"></a>`name` | [`String!`](#string) | Human-readable name of the user. Returns `****` if the user is a project bot and the requester does not have permission to view the project. |
|
|
| <a id="mergerequestparticipantnamespace"></a>`namespace` | [`Namespace`](#namespace) | Personal namespace of the user. |
|
|
| <a id="mergerequestparticipantpreferencesgitpodpath"></a>`preferencesGitpodPath` | [`String`](#string) | Web path to the Gitpod section within user preferences. |
|
|
| <a id="mergerequestparticipantprofileenablegitpodpath"></a>`profileEnableGitpodPath` | [`String`](#string) | Web path to enable Gitpod for the user. |
|
|
| <a id="mergerequestparticipantprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestparticipantpublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. |
|
|
| <a id="mergerequestparticipantsavedreplies"></a>`savedReplies` | [`SavedReplyConnection`](#savedreplyconnection) | Saved replies authored by the user. Will not return saved replies if `saved_replies` feature flag is disabled. (see [Connections](#connections)) |
|
|
| <a id="mergerequestparticipantstate"></a>`state` | [`UserState!`](#userstate) | State of the user. |
|
|
| <a id="mergerequestparticipantstatus"></a>`status` | [`UserStatus`](#userstatus) | User status. |
|
|
| <a id="mergerequestparticipantuserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="mergerequestparticipantusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. |
|
|
| <a id="mergerequestparticipantwebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. |
|
|
| <a id="mergerequestparticipantweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `MergeRequestParticipant.assignedMergeRequests`
|
|
|
|
Merge requests assigned to the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="mergerequestparticipantassignedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestparticipantassignedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestparticipantassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="mergerequestparticipantassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestparticipantassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestparticipantassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestparticipantassignedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestParticipant.authoredMergeRequests`
|
|
|
|
Merge requests authored by the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestparticipantauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestparticipantauthoredmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestParticipant.groups`
|
|
|
|
Groups where the user has access.
|
|
|
|
Returns [`GroupConnection`](#groupconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantgroupspermissionscope"></a>`permissionScope` | [`GroupPermission`](#grouppermission) | Filter by permissions the user has on groups. |
|
|
| <a id="mergerequestparticipantgroupssearch"></a>`search` | [`String`](#string) | Search by group name or path. |
|
|
|
|
##### `MergeRequestParticipant.reviewRequestedMergeRequests`
|
|
|
|
Merge requests assigned to the user for review.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestparticipantreviewrequestedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestParticipant.snippets`
|
|
|
|
Snippets authored by the user.
|
|
|
|
Returns [`SnippetConnection`](#snippetconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantsnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. |
|
|
| <a id="mergerequestparticipantsnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | Type of snippet. |
|
|
| <a id="mergerequestparticipantsnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. |
|
|
|
|
##### `MergeRequestParticipant.starredProjects`
|
|
|
|
Projects starred by the user.
|
|
|
|
Returns [`ProjectConnection`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipantstarredprojectssearch"></a>`search` | [`String`](#string) | Search query. |
|
|
|
|
##### `MergeRequestParticipant.timelogs`
|
|
|
|
Time logged by the user.
|
|
|
|
Returns [`TimelogConnection`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipanttimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="mergerequestparticipanttimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="mergerequestparticipanttimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="mergerequestparticipanttimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="mergerequestparticipanttimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="mergerequestparticipanttimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="mergerequestparticipanttimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
##### `MergeRequestParticipant.todos`
|
|
|
|
To-do items of the user.
|
|
|
|
Returns [`TodoConnection`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestparticipanttodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | Action to be filtered. |
|
|
| <a id="mergerequestparticipanttodosauthorid"></a>`authorId` | [`[ID!]`](#id) | ID of an author. |
|
|
| <a id="mergerequestparticipanttodosgroupid"></a>`groupId` | [`[ID!]`](#id) | ID of a group. |
|
|
| <a id="mergerequestparticipanttodosprojectid"></a>`projectId` | [`[ID!]`](#id) | ID of a project. |
|
|
| <a id="mergerequestparticipanttodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | State of the todo. |
|
|
| <a id="mergerequestparticipanttodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | Type of the todo. |
|
|
|
|
### `MergeRequestPermissions`
|
|
|
|
Check permissions for the current user on a merge request.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestpermissionsadminmergerequest"></a>`adminMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_merge_request` on this resource. |
|
|
| <a id="mergerequestpermissionscanmerge"></a>`canMerge` | [`Boolean!`](#boolean) | Indicates the user can perform `can_merge` on this resource. |
|
|
| <a id="mergerequestpermissionscherrypickoncurrentmergerequest"></a>`cherryPickOnCurrentMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource. |
|
|
| <a id="mergerequestpermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. |
|
|
| <a id="mergerequestpermissionspushtosourcebranch"></a>`pushToSourceBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `push_to_source_branch` on this resource. |
|
|
| <a id="mergerequestpermissionsreadmergerequest"></a>`readMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `read_merge_request` on this resource. |
|
|
| <a id="mergerequestpermissionsremovesourcebranch"></a>`removeSourceBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_source_branch` on this resource. |
|
|
| <a id="mergerequestpermissionsrevertoncurrentmergerequest"></a>`revertOnCurrentMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `revert_on_current_merge_request` on this resource. |
|
|
| <a id="mergerequestpermissionsupdatemergerequest"></a>`updateMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `update_merge_request` on this resource. |
|
|
|
|
### `MergeRequestReviewer`
|
|
|
|
A user assigned to a merge request as a reviewer.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestrevieweravatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. |
|
|
| <a id="mergerequestreviewerbot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. |
|
|
| <a id="mergerequestreviewercallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestrevieweremail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). |
|
|
| <a id="mergerequestreviewergitpodenabled"></a>`gitpodEnabled` | [`Boolean`](#boolean) | Whether Gitpod is enabled at the user level. |
|
|
| <a id="mergerequestreviewergroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. |
|
|
| <a id="mergerequestreviewergroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestreviewerid"></a>`id` | [`ID!`](#id) | ID of the user. |
|
|
| <a id="mergerequestreviewerlocation"></a>`location` | [`String`](#string) | Location of the user. |
|
|
| <a id="mergerequestreviewermergerequestinteraction"></a>`mergeRequestInteraction` | [`UserMergeRequestInteraction`](#usermergerequestinteraction) | Details of this user's interactions with the merge request. |
|
|
| <a id="mergerequestreviewername"></a>`name` | [`String!`](#string) | Human-readable name of the user. Returns `****` if the user is a project bot and the requester does not have permission to view the project. |
|
|
| <a id="mergerequestreviewernamespace"></a>`namespace` | [`Namespace`](#namespace) | Personal namespace of the user. |
|
|
| <a id="mergerequestreviewerpreferencesgitpodpath"></a>`preferencesGitpodPath` | [`String`](#string) | Web path to the Gitpod section within user preferences. |
|
|
| <a id="mergerequestreviewerprofileenablegitpodpath"></a>`profileEnableGitpodPath` | [`String`](#string) | Web path to enable Gitpod for the user. |
|
|
| <a id="mergerequestreviewerprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="mergerequestreviewerpublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. |
|
|
| <a id="mergerequestreviewersavedreplies"></a>`savedReplies` | [`SavedReplyConnection`](#savedreplyconnection) | Saved replies authored by the user. Will not return saved replies if `saved_replies` feature flag is disabled. (see [Connections](#connections)) |
|
|
| <a id="mergerequestreviewerstate"></a>`state` | [`UserState!`](#userstate) | State of the user. |
|
|
| <a id="mergerequestreviewerstatus"></a>`status` | [`UserStatus`](#userstatus) | User status. |
|
|
| <a id="mergerequestrevieweruserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="mergerequestreviewerusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. |
|
|
| <a id="mergerequestreviewerwebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. |
|
|
| <a id="mergerequestreviewerweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `MergeRequestReviewer.assignedMergeRequests`
|
|
|
|
Merge requests assigned to the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewerassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="mergerequestreviewerassignedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestreviewerassignedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestreviewerassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="mergerequestreviewerassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestreviewerassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestreviewerassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestreviewerassignedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestReviewer.authoredMergeRequests`
|
|
|
|
Merge requests authored by the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestreviewerauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestreviewerauthoredmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestReviewer.groups`
|
|
|
|
Groups where the user has access.
|
|
|
|
Returns [`GroupConnection`](#groupconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewergroupspermissionscope"></a>`permissionScope` | [`GroupPermission`](#grouppermission) | Filter by permissions the user has on groups. |
|
|
| <a id="mergerequestreviewergroupssearch"></a>`search` | [`String`](#string) | Search by group name or path. |
|
|
|
|
##### `MergeRequestReviewer.reviewRequestedMergeRequests`
|
|
|
|
Merge requests assigned to the user for review.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="mergerequestreviewerreviewrequestedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `MergeRequestReviewer.snippets`
|
|
|
|
Snippets authored by the user.
|
|
|
|
Returns [`SnippetConnection`](#snippetconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewersnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. |
|
|
| <a id="mergerequestreviewersnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | Type of snippet. |
|
|
| <a id="mergerequestreviewersnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. |
|
|
|
|
##### `MergeRequestReviewer.starredProjects`
|
|
|
|
Projects starred by the user.
|
|
|
|
Returns [`ProjectConnection`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewerstarredprojectssearch"></a>`search` | [`String`](#string) | Search query. |
|
|
|
|
##### `MergeRequestReviewer.timelogs`
|
|
|
|
Time logged by the user.
|
|
|
|
Returns [`TimelogConnection`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewertimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="mergerequestreviewertimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="mergerequestreviewertimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="mergerequestreviewertimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="mergerequestreviewertimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="mergerequestreviewertimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="mergerequestreviewertimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
##### `MergeRequestReviewer.todos`
|
|
|
|
To-do items of the user.
|
|
|
|
Returns [`TodoConnection`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestreviewertodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | Action to be filtered. |
|
|
| <a id="mergerequestreviewertodosauthorid"></a>`authorId` | [`[ID!]`](#id) | ID of an author. |
|
|
| <a id="mergerequestreviewertodosgroupid"></a>`groupId` | [`[ID!]`](#id) | ID of a group. |
|
|
| <a id="mergerequestreviewertodosprojectid"></a>`projectId` | [`[ID!]`](#id) | ID of a project. |
|
|
| <a id="mergerequestreviewertodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | State of the todo. |
|
|
| <a id="mergerequestreviewertodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | Type of the todo. |
|
|
|
|
### `Metadata`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="metadatakas"></a>`kas` | [`Kas!`](#kas) | Metadata about KAS. |
|
|
| <a id="metadatarevision"></a>`revision` | [`String!`](#string) | Revision. |
|
|
| <a id="metadataversion"></a>`version` | [`String!`](#string) | Version. |
|
|
|
|
### `MetricImage`
|
|
|
|
Represents a metric image upload.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="metricimagefilename"></a>`fileName` | [`String`](#string) | File name of the metric image. |
|
|
| <a id="metricimagefilepath"></a>`filePath` | [`String`](#string) | File path of the metric image. |
|
|
| <a id="metricimageid"></a>`id` | [`ID!`](#id) | ID of the metric upload. |
|
|
| <a id="metricimageiid"></a>`iid` | [`ID!`](#id) | Internal ID of the metric upload. |
|
|
| <a id="metricimageurl"></a>`url` | [`String!`](#string) | URL of the metric source. |
|
|
|
|
### `MetricsDashboard`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="metricsdashboardpath"></a>`path` | [`String`](#string) | Path to a file with the dashboard definition. |
|
|
| <a id="metricsdashboardschemavalidationwarnings"></a>`schemaValidationWarnings` | [`[String!]`](#string) | Dashboard schema validation warnings. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `MetricsDashboard.annotations`
|
|
|
|
Annotations added to the dashboard.
|
|
|
|
Returns [`MetricsDashboardAnnotationConnection`](#metricsdashboardannotationconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="metricsdashboardannotationsfrom"></a>`from` | [`Time!`](#time) | Timestamp marking date and time from which annotations need to be fetched. |
|
|
| <a id="metricsdashboardannotationsto"></a>`to` | [`Time`](#time) | Timestamp marking date and time to which annotations need to be fetched. |
|
|
|
|
### `MetricsDashboardAnnotation`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="metricsdashboardannotationdescription"></a>`description` | [`String`](#string) | Description of the annotation. |
|
|
| <a id="metricsdashboardannotationendingat"></a>`endingAt` | [`Time`](#time) | Timestamp marking end of annotated time span. |
|
|
| <a id="metricsdashboardannotationid"></a>`id` | [`ID!`](#id) | ID of the annotation. |
|
|
| <a id="metricsdashboardannotationpanelid"></a>`panelId` | [`String`](#string) | ID of a dashboard panel to which the annotation should be scoped. |
|
|
| <a id="metricsdashboardannotationstartingat"></a>`startingAt` | [`Time`](#time) | Timestamp marking start of annotated time span. |
|
|
|
|
### `Milestone`
|
|
|
|
Represents a milestone.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="milestonecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of milestone creation. |
|
|
| <a id="milestonedescription"></a>`description` | [`String`](#string) | Description of the milestone. |
|
|
| <a id="milestoneduedate"></a>`dueDate` | [`Time`](#time) | Timestamp of the milestone due date. |
|
|
| <a id="milestoneexpired"></a>`expired` | [`Boolean!`](#boolean) | Expired state of the milestone (a milestone is expired when the due date is past the current date). Defaults to `false` when due date has not been set. |
|
|
| <a id="milestonegroupmilestone"></a>`groupMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at group level. |
|
|
| <a id="milestoneid"></a>`id` | [`ID!`](#id) | ID of the milestone. |
|
|
| <a id="milestoneiid"></a>`iid` | [`ID!`](#id) | Internal ID of the milestone. |
|
|
| <a id="milestoneprojectmilestone"></a>`projectMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at project level. |
|
|
| <a id="milestonereleases"></a>`releases` | [`ReleaseConnection`](#releaseconnection) | Releases associated with this milestone. (see [Connections](#connections)) |
|
|
| <a id="milestonestartdate"></a>`startDate` | [`Time`](#time) | Timestamp of the milestone start date. |
|
|
| <a id="milestonestate"></a>`state` | [`MilestoneStateEnum!`](#milestonestateenum) | State of the milestone. |
|
|
| <a id="milestonestats"></a>`stats` | [`MilestoneStats`](#milestonestats) | Milestone statistics. |
|
|
| <a id="milestonesubgroupmilestone"></a>`subgroupMilestone` | [`Boolean!`](#boolean) | Indicates if milestone is at subgroup level. |
|
|
| <a id="milestonetitle"></a>`title` | [`String!`](#string) | Title of the milestone. |
|
|
| <a id="milestoneupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of last milestone update. |
|
|
| <a id="milestonewebpath"></a>`webPath` | [`String!`](#string) | Web path of the milestone. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Milestone.report`
|
|
|
|
Historically accurate report about the timebox.
|
|
|
|
Returns [`TimeboxReport`](#timeboxreport).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="milestonereportfullpath"></a>`fullPath` | [`String`](#string) | Full path of the project or group used as a scope for report. For example, `gitlab-org` or `gitlab-org/gitlab`. |
|
|
|
|
### `MilestoneStats`
|
|
|
|
Contains statistics about a milestone.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="milestonestatsclosedissuescount"></a>`closedIssuesCount` | [`Int`](#int) | Number of closed issues associated with the milestone. |
|
|
| <a id="milestonestatstotalissuescount"></a>`totalIssuesCount` | [`Int`](#int) | Total number of issues associated with the milestone. |
|
|
|
|
### `Namespace`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="namespaceactualrepositorysizelimit"></a>`actualRepositorySizeLimit` | [`Float`](#float) | Size limit for repositories in the namespace in bytes. |
|
|
| <a id="namespaceadditionalpurchasedstoragesize"></a>`additionalPurchasedStorageSize` | [`Float`](#float) | Additional storage purchased for the root namespace in bytes. |
|
|
| <a id="namespacecontainslockedprojects"></a>`containsLockedProjects` | [`Boolean!`](#boolean) | Includes at least one project where the repository size exceeds the limit. |
|
|
| <a id="namespacecrossprojectpipelineavailable"></a>`crossProjectPipelineAvailable` | [`Boolean!`](#boolean) | Indicates if the cross_project_pipeline feature is available for the namespace. |
|
|
| <a id="namespacedescription"></a>`description` | [`String`](#string) | Description of the namespace. |
|
|
| <a id="namespacedescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="namespacefullname"></a>`fullName` | [`String!`](#string) | Full name of the namespace. |
|
|
| <a id="namespacefullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the namespace. |
|
|
| <a id="namespaceid"></a>`id` | [`ID!`](#id) | ID of the namespace. |
|
|
| <a id="namespaceistemporarystorageincreaseenabled"></a>`isTemporaryStorageIncreaseEnabled` | [`Boolean!`](#boolean) | Status of the temporary storage increase. |
|
|
| <a id="namespacelfsenabled"></a>`lfsEnabled` | [`Boolean`](#boolean) | Indicates if Large File Storage (LFS) is enabled for namespace. |
|
|
| <a id="namespacename"></a>`name` | [`String!`](#string) | Name of the namespace. |
|
|
| <a id="namespacepackagesettings"></a>`packageSettings` | [`PackageSettings`](#packagesettings) | Package settings for the namespace. |
|
|
| <a id="namespacepath"></a>`path` | [`String!`](#string) | Path of the namespace. |
|
|
| <a id="namespacerepositorysizeexcessprojectcount"></a>`repositorySizeExcessProjectCount` | [`Int!`](#int) | Number of projects in the root namespace where the repository size exceeds the limit. |
|
|
| <a id="namespacerequestaccessenabled"></a>`requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request access to namespace. |
|
|
| <a id="namespacerootstoragestatistics"></a>`rootStorageStatistics` | [`RootStorageStatistics`](#rootstoragestatistics) | Aggregated storage statistics of the namespace. Only available for root namespaces. |
|
|
| <a id="namespacesharedrunnerssetting"></a>`sharedRunnersSetting` | [`SharedRunnersSetting`](#sharedrunnerssetting) | Shared runners availability for the namespace and its descendants. |
|
|
| <a id="namespacestoragesizelimit"></a>`storageSizeLimit` | [`Float`](#float) | Total storage limit of the root namespace in bytes. |
|
|
| <a id="namespacetemporarystorageincreaseendson"></a>`temporaryStorageIncreaseEndsOn` | [`Time`](#time) | Date until the temporary storage increase is active. |
|
|
| <a id="namespacetotalrepositorysize"></a>`totalRepositorySize` | [`Float`](#float) | Total repository size of all projects in the root namespace in bytes. |
|
|
| <a id="namespacetotalrepositorysizeexcess"></a>`totalRepositorySizeExcess` | [`Float`](#float) | Total excess repository size of all projects in the root namespace in bytes. |
|
|
| <a id="namespacevisibility"></a>`visibility` | [`String`](#string) | Visibility of the namespace. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Namespace.complianceFrameworks`
|
|
|
|
Compliance frameworks available to projects in this namespace.
|
|
|
|
Returns [`ComplianceFrameworkConnection`](#complianceframeworkconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="namespacecomplianceframeworksid"></a>`id` | [`ComplianceManagementFrameworkID`](#compliancemanagementframeworkid) | Global ID of a specific compliance framework to return. |
|
|
|
|
##### `Namespace.projects`
|
|
|
|
Projects within this namespace.
|
|
|
|
Returns [`ProjectConnection!`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="namespaceprojectshascodecoverage"></a>`hasCodeCoverage` | [`Boolean`](#boolean) | Returns only the projects which have code coverage. |
|
|
| <a id="namespaceprojectshasvulnerabilities"></a>`hasVulnerabilities` | [`Boolean`](#boolean) | Returns only the projects which have vulnerabilities. |
|
|
| <a id="namespaceprojectsids"></a>`ids` | [`[ID!]`](#id) | Filter projects by IDs. |
|
|
| <a id="namespaceprojectsincludesubgroups"></a>`includeSubgroups` | [`Boolean`](#boolean) | Include also subgroup projects. |
|
|
| <a id="namespaceprojectssearch"></a>`search` | [`String`](#string) | Search project with most similar names or paths. |
|
|
| <a id="namespaceprojectssort"></a>`sort` | [`NamespaceProjectSort`](#namespaceprojectsort) | Sort projects by this criteria. |
|
|
|
|
##### `Namespace.scanExecutionPolicies`
|
|
|
|
Scan Execution Policies of the namespace.
|
|
|
|
Returns [`ScanExecutionPolicyConnection`](#scanexecutionpolicyconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="namespacescanexecutionpoliciesactionscantypes"></a>`actionScanTypes` | [`[SecurityReportTypeEnum!]`](#securityreporttypeenum) | Filters policies by the action scan type. Only these scan types are supported: `dast`, `secret_detection`, `cluster_image_scanning`, `container_scanning`, `sast`. |
|
|
| <a id="namespacescanexecutionpoliciesrelationship"></a>`relationship` | [`SecurityPolicyRelationType`](#securitypolicyrelationtype) | Filter policies by the given policy relationship. |
|
|
|
|
### `NamespaceCiCdSetting`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="namespacecicdsettingallowstalerunnerpruning"></a>`allowStaleRunnerPruning` | [`Boolean`](#boolean) | Indicates if stale runners directly belonging to this namespace should be periodically pruned. |
|
|
| <a id="namespacecicdsettingnamespace"></a>`namespace` | [`Namespace`](#namespace) | Namespace the CI/CD settings belong to. |
|
|
|
|
### `NetworkPolicy`
|
|
|
|
Represents the network policy.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="networkpolicyenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether this policy is enabled. |
|
|
| <a id="networkpolicyenvironments"></a>`environments` | [`EnvironmentConnection`](#environmentconnection) | Environments where this policy is applied. (see [Connections](#connections)) |
|
|
| <a id="networkpolicyfromautodevops"></a>`fromAutoDevops` | [`Boolean!`](#boolean) | Indicates whether this policy is created from AutoDevops. |
|
|
| <a id="networkpolicykind"></a>`kind` | [`NetworkPolicyKind!`](#networkpolicykind) | Kind of the policy. |
|
|
| <a id="networkpolicyname"></a>`name` | [`String!`](#string) | Name of the policy. |
|
|
| <a id="networkpolicynamespace"></a>`namespace` | [`String!`](#string) | Namespace of the policy. |
|
|
| <a id="networkpolicyupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the policy YAML was last updated. |
|
|
| <a id="networkpolicyyaml"></a>`yaml` | [`String!`](#string) | YAML definition of the policy. |
|
|
|
|
### `Note`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="noteauthor"></a>`author` | [`UserCore!`](#usercore) | User who wrote this note. |
|
|
| <a id="notebody"></a>`body` | [`String!`](#string) | Content of the note. |
|
|
| <a id="notebodyhtml"></a>`bodyHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `note`. |
|
|
| <a id="noteconfidential"></a>`confidential` | [`Boolean`](#boolean) | Indicates if this note is confidential. |
|
|
| <a id="notecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the note creation. |
|
|
| <a id="notediscussion"></a>`discussion` | [`Discussion`](#discussion) | Discussion this note is a part of. |
|
|
| <a id="noteid"></a>`id` | [`NoteID!`](#noteid) | ID of the note. |
|
|
| <a id="noteposition"></a>`position` | [`DiffPosition`](#diffposition) | Position of this note on a diff. |
|
|
| <a id="noteproject"></a>`project` | [`Project`](#project) | Project associated with the note. |
|
|
| <a id="noteresolvable"></a>`resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. |
|
|
| <a id="noteresolved"></a>`resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. |
|
|
| <a id="noteresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. |
|
|
| <a id="noteresolvedby"></a>`resolvedBy` | [`UserCore`](#usercore) | User who resolved the object. |
|
|
| <a id="notesystem"></a>`system` | [`Boolean!`](#boolean) | Indicates whether this note was created by the system or by a user. |
|
|
| <a id="notesystemnoteiconname"></a>`systemNoteIconName` | [`String`](#string) | Name of the icon corresponding to a system note. |
|
|
| <a id="noteupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of the note's last activity. |
|
|
| <a id="noteurl"></a>`url` | [`String`](#string) | URL to view this Note in the Web UI. |
|
|
| <a id="noteuserpermissions"></a>`userPermissions` | [`NotePermissions!`](#notepermissions) | Permissions for the current user on the resource. |
|
|
|
|
### `NotePermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="notepermissionsadminnote"></a>`adminNote` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_note` on this resource. |
|
|
| <a id="notepermissionsawardemoji"></a>`awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. |
|
|
| <a id="notepermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. |
|
|
| <a id="notepermissionsreadnote"></a>`readNote` | [`Boolean!`](#boolean) | Indicates the user can perform `read_note` on this resource. |
|
|
| <a id="notepermissionsrepositionnote"></a>`repositionNote` | [`Boolean!`](#boolean) | Indicates the user can perform `reposition_note` on this resource. |
|
|
| <a id="notepermissionsresolvenote"></a>`resolveNote` | [`Boolean!`](#boolean) | Indicates the user can perform `resolve_note` on this resource. |
|
|
|
|
### `NugetDependencyLinkMetadata`
|
|
|
|
Nuget dependency link metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="nugetdependencylinkmetadataid"></a>`id` | [`PackagesNugetDependencyLinkMetadatumID!`](#packagesnugetdependencylinkmetadatumid) | ID of the metadatum. |
|
|
| <a id="nugetdependencylinkmetadatatargetframework"></a>`targetFramework` | [`String!`](#string) | Target framework of the dependency link package. |
|
|
|
|
### `NugetMetadata`
|
|
|
|
Nuget metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="nugetmetadataiconurl"></a>`iconUrl` | [`String`](#string) | Icon URL of the Nuget package. |
|
|
| <a id="nugetmetadataid"></a>`id` | [`PackagesNugetMetadatumID!`](#packagesnugetmetadatumid) | ID of the metadatum. |
|
|
| <a id="nugetmetadatalicenseurl"></a>`licenseUrl` | [`String`](#string) | License URL of the Nuget package. |
|
|
| <a id="nugetmetadataprojecturl"></a>`projectUrl` | [`String`](#string) | Project URL of the Nuget package. |
|
|
|
|
### `OncallParticipantType`
|
|
|
|
The rotation participant and color palette.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="oncallparticipanttypecolorpalette"></a>`colorPalette` | [`String`](#string) | Color palette to assign to the on-call user. For example "blue". |
|
|
| <a id="oncallparticipanttypecolorweight"></a>`colorWeight` | [`String`](#string) | Color weight to assign to for the on-call user, for example "500". Max 4 chars. For easy identification of the user. |
|
|
| <a id="oncallparticipanttypeid"></a>`id` | [`IncidentManagementOncallParticipantID!`](#incidentmanagementoncallparticipantid) | ID of the on-call participant. |
|
|
| <a id="oncallparticipanttypeuser"></a>`user` | [`UserCore!`](#usercore) | User who is participating. |
|
|
|
|
### `OncallRotationActivePeriodType`
|
|
|
|
Active period time range for on-call rotation.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="oncallrotationactiveperiodtypeendtime"></a>`endTime` | [`String`](#string) | End of the rotation active period. |
|
|
| <a id="oncallrotationactiveperiodtypestarttime"></a>`startTime` | [`String`](#string) | Start of the rotation active period. |
|
|
|
|
### `Package`
|
|
|
|
Represents a package with pipelines in the Package Registry.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagecandestroy"></a>`canDestroy` | [`Boolean!`](#boolean) | Whether the user can destroy the package. |
|
|
| <a id="packagecreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="packageid"></a>`id` | [`PackagesPackageID!`](#packagespackageid) | ID of the package. |
|
|
| <a id="packagemetadata"></a>`metadata` | [`PackageMetadata`](#packagemetadata) | Package metadata. |
|
|
| <a id="packagename"></a>`name` | [`String!`](#string) | Name of the package. |
|
|
| <a id="packagepackagetype"></a>`packageType` | [`PackageTypeEnum!`](#packagetypeenum) | Package type. |
|
|
| <a id="packagepipelines"></a>`pipelines` | [`PipelineConnection`](#pipelineconnection) | Pipelines that built the package. Max page size 20. (see [Connections](#connections)) |
|
|
| <a id="packageproject"></a>`project` | [`Project!`](#project) | Project where the package is stored. |
|
|
| <a id="packagestatus"></a>`status` | [`PackageStatus!`](#packagestatus) | Package status. |
|
|
| <a id="packagetags"></a>`tags` | [`PackageTagConnection`](#packagetagconnection) | Package tags. (see [Connections](#connections)) |
|
|
| <a id="packageupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
| <a id="packageversion"></a>`version` | [`String`](#string) | Version string. |
|
|
|
|
### `PackageBase`
|
|
|
|
Represents a package in the Package Registry.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagebasecandestroy"></a>`canDestroy` | [`Boolean!`](#boolean) | Whether the user can destroy the package. |
|
|
| <a id="packagebasecreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="packagebaseid"></a>`id` | [`PackagesPackageID!`](#packagespackageid) | ID of the package. |
|
|
| <a id="packagebasemetadata"></a>`metadata` | [`PackageMetadata`](#packagemetadata) | Package metadata. |
|
|
| <a id="packagebasename"></a>`name` | [`String!`](#string) | Name of the package. |
|
|
| <a id="packagebasepackagetype"></a>`packageType` | [`PackageTypeEnum!`](#packagetypeenum) | Package type. |
|
|
| <a id="packagebaseproject"></a>`project` | [`Project!`](#project) | Project where the package is stored. |
|
|
| <a id="packagebasestatus"></a>`status` | [`PackageStatus!`](#packagestatus) | Package status. |
|
|
| <a id="packagebasetags"></a>`tags` | [`PackageTagConnection`](#packagetagconnection) | Package tags. (see [Connections](#connections)) |
|
|
| <a id="packagebaseupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
| <a id="packagebaseversion"></a>`version` | [`String`](#string) | Version string. |
|
|
|
|
### `PackageComposerJsonType`
|
|
|
|
Represents a composer JSON file.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagecomposerjsontypelicense"></a>`license` | [`String`](#string) | License set in the Composer JSON file. |
|
|
| <a id="packagecomposerjsontypename"></a>`name` | [`String`](#string) | Name set in the Composer JSON file. |
|
|
| <a id="packagecomposerjsontypetype"></a>`type` | [`String`](#string) | Type set in the Composer JSON file. |
|
|
| <a id="packagecomposerjsontypeversion"></a>`version` | [`String`](#string) | Version set in the Composer JSON file. |
|
|
|
|
### `PackageDependency`
|
|
|
|
Represents a package dependency.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagedependencyid"></a>`id` | [`PackagesDependencyID!`](#packagesdependencyid) | ID of the dependency. |
|
|
| <a id="packagedependencyname"></a>`name` | [`String!`](#string) | Name of the dependency. |
|
|
| <a id="packagedependencyversionpattern"></a>`versionPattern` | [`String!`](#string) | Version pattern of the dependency. |
|
|
|
|
### `PackageDependencyLink`
|
|
|
|
Represents a package dependency link.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagedependencylinkdependency"></a>`dependency` | [`PackageDependency`](#packagedependency) | Dependency. |
|
|
| <a id="packagedependencylinkdependencytype"></a>`dependencyType` | [`PackageDependencyType!`](#packagedependencytype) | Dependency type. |
|
|
| <a id="packagedependencylinkid"></a>`id` | [`PackagesDependencyLinkID!`](#packagesdependencylinkid) | ID of the dependency link. |
|
|
| <a id="packagedependencylinkmetadata"></a>`metadata` | [`DependencyLinkMetadata`](#dependencylinkmetadata) | Dependency link metadata. |
|
|
|
|
### `PackageDetailsType`
|
|
|
|
Represents a package details in the Package Registry.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagedetailstypecandestroy"></a>`canDestroy` | [`Boolean!`](#boolean) | Whether the user can destroy the package. |
|
|
| <a id="packagedetailstypecomposerconfigrepositoryurl"></a>`composerConfigRepositoryUrl` | [`String`](#string) | Url of the Composer setup endpoint. |
|
|
| <a id="packagedetailstypecomposerurl"></a>`composerUrl` | [`String`](#string) | Url of the Composer endpoint. |
|
|
| <a id="packagedetailstypeconanurl"></a>`conanUrl` | [`String`](#string) | Url of the Conan project endpoint. |
|
|
| <a id="packagedetailstypecreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="packagedetailstypedependencylinks"></a>`dependencyLinks` | [`PackageDependencyLinkConnection`](#packagedependencylinkconnection) | Dependency link. (see [Connections](#connections)) |
|
|
| <a id="packagedetailstypeid"></a>`id` | [`PackagesPackageID!`](#packagespackageid) | ID of the package. |
|
|
| <a id="packagedetailstypemavenurl"></a>`mavenUrl` | [`String`](#string) | Url of the Maven project endpoint. |
|
|
| <a id="packagedetailstypemetadata"></a>`metadata` | [`PackageMetadata`](#packagemetadata) | Package metadata. |
|
|
| <a id="packagedetailstypename"></a>`name` | [`String!`](#string) | Name of the package. |
|
|
| <a id="packagedetailstypenpmurl"></a>`npmUrl` | [`String`](#string) | Url of the NPM project endpoint. |
|
|
| <a id="packagedetailstypenugeturl"></a>`nugetUrl` | [`String`](#string) | Url of the Nuget project endpoint. |
|
|
| <a id="packagedetailstypepackagefiles"></a>`packageFiles` | [`PackageFileConnection`](#packagefileconnection) | Package files. (see [Connections](#connections)) |
|
|
| <a id="packagedetailstypepackagetype"></a>`packageType` | [`PackageTypeEnum!`](#packagetypeenum) | Package type. |
|
|
| <a id="packagedetailstypepipelines"></a>`pipelines` | [`PipelineConnection`](#pipelineconnection) | Pipelines that built the package. Max page size 20. (see [Connections](#connections)) |
|
|
| <a id="packagedetailstypeproject"></a>`project` | [`Project!`](#project) | Project where the package is stored. |
|
|
| <a id="packagedetailstypepypisetupurl"></a>`pypiSetupUrl` | [`String`](#string) | Url of the PyPi project setup endpoint. |
|
|
| <a id="packagedetailstypepypiurl"></a>`pypiUrl` | [`String`](#string) | Url of the PyPi project endpoint. |
|
|
| <a id="packagedetailstypestatus"></a>`status` | [`PackageStatus!`](#packagestatus) | Package status. |
|
|
| <a id="packagedetailstypetags"></a>`tags` | [`PackageTagConnection`](#packagetagconnection) | Package tags. (see [Connections](#connections)) |
|
|
| <a id="packagedetailstypeupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
| <a id="packagedetailstypeversion"></a>`version` | [`String`](#string) | Version string. |
|
|
| <a id="packagedetailstypeversions"></a>`versions` | [`PackageBaseConnection`](#packagebaseconnection) | Other versions of the package. (see [Connections](#connections)) |
|
|
|
|
### `PackageFile`
|
|
|
|
Represents a package file.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagefilecreatedat"></a>`createdAt` | [`Time!`](#time) | Created date. |
|
|
| <a id="packagefiledownloadpath"></a>`downloadPath` | [`String!`](#string) | Download path of the package file. |
|
|
| <a id="packagefilefilemd5"></a>`fileMd5` | [`String`](#string) | Md5 of the package file. |
|
|
| <a id="packagefilefilemetadata"></a>`fileMetadata` | [`PackageFileMetadata`](#packagefilemetadata) | File metadata. |
|
|
| <a id="packagefilefilename"></a>`fileName` | [`String!`](#string) | Name of the package file. |
|
|
| <a id="packagefilefilesha1"></a>`fileSha1` | [`String`](#string) | Sha1 of the package file. |
|
|
| <a id="packagefilefilesha256"></a>`fileSha256` | [`String`](#string) | Sha256 of the package file. |
|
|
| <a id="packagefileid"></a>`id` | [`PackagesPackageFileID!`](#packagespackagefileid) | ID of the file. |
|
|
| <a id="packagefilesize"></a>`size` | [`String!`](#string) | Size of the package file. |
|
|
| <a id="packagefileupdatedat"></a>`updatedAt` | [`Time!`](#time) | Updated date. |
|
|
|
|
### `PackageFileRegistry`
|
|
|
|
Represents the Geo sync and verification state of a package file.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagefileregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the PackageFileRegistry was created. |
|
|
| <a id="packagefileregistryid"></a>`id` | [`ID!`](#id) | ID of the PackageFileRegistry. |
|
|
| <a id="packagefileregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the PackageFileRegistry. |
|
|
| <a id="packagefileregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the PackageFileRegistry. |
|
|
| <a id="packagefileregistrypackagefileid"></a>`packageFileId` | [`ID!`](#id) | ID of the PackageFile. |
|
|
| <a id="packagefileregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the PackageFileRegistry should be resynced. |
|
|
| <a id="packagefileregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the PackageFileRegistry. |
|
|
| <a id="packagefileregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the PackageFileRegistry. |
|
|
|
|
### `PackageHelmDependencyType`
|
|
|
|
Represents a Helm dependency.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagehelmdependencytypealias"></a>`alias` | [`String`](#string) | Alias of the dependency. |
|
|
| <a id="packagehelmdependencytypecondition"></a>`condition` | [`String`](#string) | Condition of the dependency. |
|
|
| <a id="packagehelmdependencytypeenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates the dependency is enabled. |
|
|
| <a id="packagehelmdependencytypeimportvalues"></a>`importValues` | [`[JSON!]`](#json) | Import-values of the dependency. |
|
|
| <a id="packagehelmdependencytypename"></a>`name` | [`String`](#string) | Name of the dependency. |
|
|
| <a id="packagehelmdependencytyperepository"></a>`repository` | [`String`](#string) | Repository of the dependency. |
|
|
| <a id="packagehelmdependencytypetags"></a>`tags` | [`[String!]`](#string) | Tags of the dependency. |
|
|
| <a id="packagehelmdependencytypeversion"></a>`version` | [`String`](#string) | Version of the dependency. |
|
|
|
|
### `PackageHelmMaintainerType`
|
|
|
|
Represents a Helm maintainer.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagehelmmaintainertypeemail"></a>`email` | [`String`](#string) | Email of the maintainer. |
|
|
| <a id="packagehelmmaintainertypename"></a>`name` | [`String`](#string) | Name of the maintainer. |
|
|
| <a id="packagehelmmaintainertypeurl"></a>`url` | [`String`](#string) | URL of the maintainer. |
|
|
|
|
### `PackageHelmMetadataType`
|
|
|
|
Represents the contents of a Helm Chart.yml file.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagehelmmetadatatypeannotations"></a>`annotations` | [`JSON`](#json) | Annotations for the chart. |
|
|
| <a id="packagehelmmetadatatypeapiversion"></a>`apiVersion` | [`String!`](#string) | API version of the chart. |
|
|
| <a id="packagehelmmetadatatypeappversion"></a>`appVersion` | [`String`](#string) | App version of the chart. |
|
|
| <a id="packagehelmmetadatatypecondition"></a>`condition` | [`String`](#string) | Condition for the chart. |
|
|
| <a id="packagehelmmetadatatypedependencies"></a>`dependencies` | [`[PackageHelmDependencyType!]`](#packagehelmdependencytype) | Dependencies of the chart. |
|
|
| <a id="packagehelmmetadatatypedeprecated"></a>`deprecated` | [`Boolean`](#boolean) | Indicates if the chart is deprecated. |
|
|
| <a id="packagehelmmetadatatypedescription"></a>`description` | [`String`](#string) | Description of the chart. |
|
|
| <a id="packagehelmmetadatatypehome"></a>`home` | [`String`](#string) | URL of the home page. |
|
|
| <a id="packagehelmmetadatatypeicon"></a>`icon` | [`String`](#string) | URL to an SVG or PNG image for the chart. |
|
|
| <a id="packagehelmmetadatatypekeywords"></a>`keywords` | [`[String!]`](#string) | Keywords for the chart. |
|
|
| <a id="packagehelmmetadatatypekubeversion"></a>`kubeVersion` | [`String`](#string) | Kubernetes versions for the chart. |
|
|
| <a id="packagehelmmetadatatypemaintainers"></a>`maintainers` | [`[PackageHelmMaintainerType!]`](#packagehelmmaintainertype) | Maintainers of the chart. |
|
|
| <a id="packagehelmmetadatatypename"></a>`name` | [`String!`](#string) | Name of the chart. |
|
|
| <a id="packagehelmmetadatatypesources"></a>`sources` | [`[String!]`](#string) | URLs of the source code for the chart. |
|
|
| <a id="packagehelmmetadatatypetags"></a>`tags` | [`String`](#string) | Tags for the chart. |
|
|
| <a id="packagehelmmetadatatypetype"></a>`type` | [`String`](#string) | Type of the chart. |
|
|
| <a id="packagehelmmetadatatypeversion"></a>`version` | [`String!`](#string) | Version of the chart. |
|
|
|
|
### `PackageSettings`
|
|
|
|
Namespace-level Package Registry settings.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagesettingsgenericduplicateexceptionregex"></a>`genericDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
|
|
| <a id="packagesettingsgenericduplicatesallowed"></a>`genericDuplicatesAllowed` | [`Boolean!`](#boolean) | Indicates whether duplicate generic packages are allowed for this namespace. |
|
|
| <a id="packagesettingsmavenduplicateexceptionregex"></a>`mavenDuplicateExceptionRegex` | [`UntrustedRegexp`](#untrustedregexp) | When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
|
|
| <a id="packagesettingsmavenduplicatesallowed"></a>`mavenDuplicatesAllowed` | [`Boolean!`](#boolean) | Indicates whether duplicate Maven packages are allowed for this namespace. |
|
|
|
|
### `PackageTag`
|
|
|
|
Represents a package tag.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagetagcreatedat"></a>`createdAt` | [`Time!`](#time) | Created date. |
|
|
| <a id="packagetagid"></a>`id` | [`ID!`](#id) | ID of the tag. |
|
|
| <a id="packagetagname"></a>`name` | [`String!`](#string) | Name of the tag. |
|
|
| <a id="packagetagupdatedat"></a>`updatedAt` | [`Time!`](#time) | Updated date. |
|
|
|
|
### `PackagesCleanupPolicy`
|
|
|
|
A packages cleanup policy designed to keep only packages and packages assets that matter most.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagescleanuppolicykeepnduplicatedpackagefiles"></a>`keepNDuplicatedPackageFiles` | [`PackagesCleanupKeepDuplicatedPackageFilesEnum!`](#packagescleanupkeepduplicatedpackagefilesenum) | Number of duplicated package files to retain. |
|
|
| <a id="packagescleanuppolicynextrunat"></a>`nextRunAt` | [`Time`](#time) | Next time that this packages cleanup policy will be executed. |
|
|
|
|
### `PageInfo`
|
|
|
|
Information about pagination in a connection.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pageinfoendcursor"></a>`endCursor` | [`String`](#string) | When paginating forwards, the cursor to continue. |
|
|
| <a id="pageinfohasnextpage"></a>`hasNextPage` | [`Boolean!`](#boolean) | When paginating forwards, are there more items?. |
|
|
| <a id="pageinfohaspreviouspage"></a>`hasPreviousPage` | [`Boolean!`](#boolean) | When paginating backwards, are there more items?. |
|
|
| <a id="pageinfostartcursor"></a>`startCursor` | [`String`](#string) | When paginating backwards, the cursor to continue. |
|
|
|
|
### `PagesDeploymentRegistry`
|
|
|
|
Represents the Geo replication and verification state of a pages_deployment.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pagesdeploymentregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the PagesDeploymentRegistry was created. |
|
|
| <a id="pagesdeploymentregistryid"></a>`id` | [`ID!`](#id) | ID of the PagesDeploymentRegistry. |
|
|
| <a id="pagesdeploymentregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the PagesDeploymentRegistry. |
|
|
| <a id="pagesdeploymentregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the PagesDeploymentRegistry. |
|
|
| <a id="pagesdeploymentregistrypagesdeploymentid"></a>`pagesDeploymentId` | [`ID!`](#id) | ID of the Pages Deployment. |
|
|
| <a id="pagesdeploymentregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the PagesDeploymentRegistry should be resynced. |
|
|
| <a id="pagesdeploymentregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the PagesDeploymentRegistry. |
|
|
| <a id="pagesdeploymentregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the PagesDeploymentRegistry. |
|
|
|
|
### `PathLock`
|
|
|
|
Represents a file or directory in the project repository that has been locked.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pathlockid"></a>`id` | [`PathLockID!`](#pathlockid) | ID of the path lock. |
|
|
| <a id="pathlockpath"></a>`path` | [`String`](#string) | Locked path. |
|
|
| <a id="pathlockuser"></a>`user` | [`UserCore`](#usercore) | User that has locked this path. |
|
|
|
|
### `Pipeline`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelineactive"></a>`active` | [`Boolean!`](#boolean) | Indicates if the pipeline is active. |
|
|
| <a id="pipelinebeforesha"></a>`beforeSha` | [`String`](#string) | Base SHA of the source branch. |
|
|
| <a id="pipelinecancelable"></a>`cancelable` | [`Boolean!`](#boolean) | Specifies if a pipeline can be canceled. |
|
|
| <a id="pipelinecodequalityreports"></a>`codeQualityReports` | [`CodeQualityDegradationConnection`](#codequalitydegradationconnection) | Code Quality degradations reported on the pipeline. (see [Connections](#connections)) |
|
|
| <a id="pipelinecommit"></a>`commit` | [`Commit`](#commit) | Git commit of the pipeline. |
|
|
| <a id="pipelinecommitpath"></a>`commitPath` | [`String`](#string) | Path to the commit that triggered the pipeline. |
|
|
| <a id="pipelinecommittedat"></a>`committedAt` | [`Time`](#time) | Timestamp of the pipeline's commit. |
|
|
| <a id="pipelinecomplete"></a>`complete` | [`Boolean!`](#boolean) | Indicates if a pipeline is complete. |
|
|
| <a id="pipelineconfigsource"></a>`configSource` | [`PipelineConfigSourceEnum`](#pipelineconfigsourceenum) | Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE). |
|
|
| <a id="pipelinecoverage"></a>`coverage` | [`Float`](#float) | Coverage percentage. |
|
|
| <a id="pipelinecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of the pipeline's creation. |
|
|
| <a id="pipelinedastprofile"></a>`dastProfile` | [`DastProfile`](#dastprofile) | DAST profile associated with the pipeline. |
|
|
| <a id="pipelinedetailedstatus"></a>`detailedStatus` | [`DetailedStatus!`](#detailedstatus) | Detailed status of the pipeline. |
|
|
| <a id="pipelinedownstream"></a>`downstream` | [`PipelineConnection`](#pipelineconnection) | Pipelines this pipeline will trigger. (see [Connections](#connections)) |
|
|
| <a id="pipelineduration"></a>`duration` | [`Int`](#int) | Duration of the pipeline in seconds. |
|
|
| <a id="pipelinefinishedat"></a>`finishedAt` | [`Time`](#time) | Timestamp of the pipeline's completion. |
|
|
| <a id="pipelineid"></a>`id` | [`ID!`](#id) | ID of the pipeline. |
|
|
| <a id="pipelineiid"></a>`iid` | [`String!`](#string) | Internal ID of the pipeline. |
|
|
| <a id="pipelinejobartifacts"></a>`jobArtifacts` | [`[CiJobArtifact!]`](#cijobartifact) | Job artifacts of the pipeline. |
|
|
| <a id="pipelinemergerequesteventtype"></a>`mergeRequestEventType` | [`PipelineMergeRequestEventType`](#pipelinemergerequesteventtype) | Event type of the pipeline associated with a merge request. |
|
|
| <a id="pipelinepath"></a>`path` | [`String`](#string) | Relative path to the pipeline's page. |
|
|
| <a id="pipelineproject"></a>`project` | [`Project`](#project) | Project the pipeline belongs to. |
|
|
| <a id="pipelinequeuedduration"></a>`queuedDuration` | [`Duration`](#duration) | How long the pipeline was queued before starting. |
|
|
| <a id="pipelineref"></a>`ref` | [`String`](#string) | Reference to the branch from which the pipeline was triggered. |
|
|
| <a id="pipelinerefpath"></a>`refPath` | [`String`](#string) | Reference path to the branch from which the pipeline was triggered. |
|
|
| <a id="pipelineretryable"></a>`retryable` | [`Boolean!`](#boolean) | Specifies if a pipeline can be retried. |
|
|
| <a id="pipelinesecurityreportsummary"></a>`securityReportSummary` | [`SecurityReportSummary`](#securityreportsummary) | Vulnerability and scanned resource counts for each security scanner of the pipeline. |
|
|
| <a id="pipelinesourcejob"></a>`sourceJob` | [`CiJob`](#cijob) | Job where pipeline was triggered from. |
|
|
| <a id="pipelinestages"></a>`stages` | [`CiStageConnection`](#cistageconnection) | Stages of the pipeline. (see [Connections](#connections)) |
|
|
| <a id="pipelinestartedat"></a>`startedAt` | [`Time`](#time) | Timestamp when the pipeline was started. |
|
|
| <a id="pipelinestatus"></a>`status` | [`PipelineStatusEnum!`](#pipelinestatusenum) | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED). |
|
|
| <a id="pipelinetestreportsummary"></a>`testReportSummary` | [`TestReportSummary!`](#testreportsummary) | Summary of the test report generated by the pipeline. |
|
|
| <a id="pipelineupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of the pipeline's last activity. |
|
|
| <a id="pipelineupstream"></a>`upstream` | [`Pipeline`](#pipeline) | Pipeline that triggered the pipeline. |
|
|
| <a id="pipelineuser"></a>`user` | [`UserCore`](#usercore) | Pipeline user. |
|
|
| <a id="pipelineuserpermissions"></a>`userPermissions` | [`PipelinePermissions!`](#pipelinepermissions) | Permissions for the current user on the resource. |
|
|
| <a id="pipelineusesneeds"></a>`usesNeeds` | [`Boolean`](#boolean) | Indicates if the pipeline has jobs with `needs` dependencies. |
|
|
| <a id="pipelinewarningmessages"></a>`warningMessages` | [`[PipelineMessage!]`](#pipelinemessage) | Pipeline warning messages. |
|
|
| <a id="pipelinewarnings"></a>`warnings` | [`Boolean!`](#boolean) | Indicates if a pipeline has warnings. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Pipeline.job`
|
|
|
|
Specific job in this pipeline, either by name or ID.
|
|
|
|
Returns [`CiJob`](#cijob).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinejobid"></a>`id` | [`JobID`](#jobid) | ID of the job. |
|
|
| <a id="pipelinejobname"></a>`name` | [`String`](#string) | Name of the job. |
|
|
|
|
##### `Pipeline.jobs`
|
|
|
|
Jobs belonging to the pipeline.
|
|
|
|
Returns [`CiJobConnection`](#cijobconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinejobssecurityreporttypes"></a>`securityReportTypes` | [`[SecurityReportTypeEnum!]`](#securityreporttypeenum) | Filter jobs by the type of security report they produce. |
|
|
| <a id="pipelinejobsstatuses"></a>`statuses` | [`[CiJobStatus!]`](#cijobstatus) | Filter jobs by status. |
|
|
|
|
##### `Pipeline.securityReportFindings`
|
|
|
|
Vulnerability findings reported on the pipeline.
|
|
|
|
Returns [`PipelineSecurityReportFindingConnection`](#pipelinesecurityreportfindingconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinesecurityreportfindingsreporttype"></a>`reportType` | [`[String!]`](#string) | Filter vulnerability findings by report type. |
|
|
| <a id="pipelinesecurityreportfindingsscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerability findings by Scanner.externalId. |
|
|
| <a id="pipelinesecurityreportfindingsseverity"></a>`severity` | [`[String!]`](#string) | Filter vulnerability findings by severity. |
|
|
| <a id="pipelinesecurityreportfindingsstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerability findings by state. |
|
|
|
|
##### `Pipeline.sha`
|
|
|
|
SHA of the pipeline's commit.
|
|
|
|
Returns [`String`](#string).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelineshaformat"></a>`format` | [`ShaFormat`](#shaformat) | Format of the SHA. |
|
|
|
|
##### `Pipeline.testSuite`
|
|
|
|
A specific test suite in a pipeline test report.
|
|
|
|
Returns [`TestSuite`](#testsuite).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinetestsuitebuildids"></a>`buildIds` | [`[ID!]!`](#id) | IDs of the builds used to run the test suite. |
|
|
|
|
### `PipelineAnalytics`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelineanalyticsmonthpipelineslabels"></a>`monthPipelinesLabels` | [`[String!]`](#string) | Labels for the monthly pipeline count. |
|
|
| <a id="pipelineanalyticsmonthpipelinessuccessful"></a>`monthPipelinesSuccessful` | [`[Int!]`](#int) | Total monthly successful pipeline count. |
|
|
| <a id="pipelineanalyticsmonthpipelinestotals"></a>`monthPipelinesTotals` | [`[Int!]`](#int) | Total monthly pipeline count. |
|
|
| <a id="pipelineanalyticspipelinetimeslabels"></a>`pipelineTimesLabels` | [`[String!]`](#string) | Pipeline times labels. |
|
|
| <a id="pipelineanalyticspipelinetimesvalues"></a>`pipelineTimesValues` | [`[Int!]`](#int) | Pipeline times. |
|
|
| <a id="pipelineanalyticsweekpipelineslabels"></a>`weekPipelinesLabels` | [`[String!]`](#string) | Labels for the weekly pipeline count. |
|
|
| <a id="pipelineanalyticsweekpipelinessuccessful"></a>`weekPipelinesSuccessful` | [`[Int!]`](#int) | Total weekly successful pipeline count. |
|
|
| <a id="pipelineanalyticsweekpipelinestotals"></a>`weekPipelinesTotals` | [`[Int!]`](#int) | Total weekly pipeline count. |
|
|
| <a id="pipelineanalyticsyearpipelineslabels"></a>`yearPipelinesLabels` | [`[String!]`](#string) | Labels for the yearly pipeline count. |
|
|
| <a id="pipelineanalyticsyearpipelinessuccessful"></a>`yearPipelinesSuccessful` | [`[Int!]`](#int) | Total yearly successful pipeline count. |
|
|
| <a id="pipelineanalyticsyearpipelinestotals"></a>`yearPipelinesTotals` | [`[Int!]`](#int) | Total yearly pipeline count. |
|
|
|
|
### `PipelineArtifactRegistry`
|
|
|
|
Represents the Geo sync and verification state of a pipeline artifact.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelineartifactregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the PipelineArtifactRegistry was created. |
|
|
| <a id="pipelineartifactregistryid"></a>`id` | [`ID!`](#id) | ID of the PipelineArtifactRegistry. |
|
|
| <a id="pipelineartifactregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the PipelineArtifactRegistry. |
|
|
| <a id="pipelineartifactregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the PipelineArtifactRegistry. |
|
|
| <a id="pipelineartifactregistrypipelineartifactid"></a>`pipelineArtifactId` | [`ID!`](#id) | ID of the pipeline artifact. |
|
|
| <a id="pipelineartifactregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the PipelineArtifactRegistry should be resynced. |
|
|
| <a id="pipelineartifactregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the PipelineArtifactRegistry. |
|
|
| <a id="pipelineartifactregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the PipelineArtifactRegistry. |
|
|
|
|
### `PipelineCounts`
|
|
|
|
Represents pipeline counts for the project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinecountsall"></a>`all` | [`Int`](#int) | Total number of pipelines for the project. |
|
|
| <a id="pipelinecountsfinished"></a>`finished` | [`Int`](#int) | Number of pipelines with scope FINISHED for the project. |
|
|
| <a id="pipelinecountspending"></a>`pending` | [`Int`](#int) | Number of pipelines with scope PENDING for the project. |
|
|
| <a id="pipelinecountsrunning"></a>`running` | [`Int`](#int) | Number of pipelines with scope RUNNING for the project. |
|
|
|
|
### `PipelineMessage`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinemessagecontent"></a>`content` | [`String!`](#string) | Content of the pipeline message. |
|
|
| <a id="pipelinemessageid"></a>`id` | [`ID!`](#id) | ID of the pipeline message. |
|
|
|
|
### `PipelinePermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinepermissionsadminpipeline"></a>`adminPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_pipeline` on this resource. |
|
|
| <a id="pipelinepermissionsdestroypipeline"></a>`destroyPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_pipeline` on this resource. |
|
|
| <a id="pipelinepermissionsupdatepipeline"></a>`updatePipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `update_pipeline` on this resource. |
|
|
|
|
### `PipelineSecurityReportFinding`
|
|
|
|
Represents vulnerability finding of a security report on the pipeline.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pipelinesecurityreportfindingassets"></a>`assets` | [`[AssetType!]`](#assettype) | List of assets associated with the vulnerability. |
|
|
| <a id="pipelinesecurityreportfindingconfidence"></a>`confidence` | [`String`](#string) | Type of the security report that found the vulnerability. |
|
|
| <a id="pipelinesecurityreportfindingdescription"></a>`description` | [`String`](#string) | Description of the vulnerability finding. |
|
|
| <a id="pipelinesecurityreportfindingevidence"></a>`evidence` | [`VulnerabilityEvidence`](#vulnerabilityevidence) | Evidence for the vulnerability. |
|
|
| <a id="pipelinesecurityreportfindingfalsepositive"></a>`falsePositive` | [`Boolean`](#boolean) | Indicates whether the vulnerability is a false positive. |
|
|
| <a id="pipelinesecurityreportfindingidentifiers"></a>`identifiers` | [`[VulnerabilityIdentifier!]!`](#vulnerabilityidentifier) | Identifiers of the vulnerability finding. |
|
|
| <a id="pipelinesecurityreportfindinglinks"></a>`links` | [`[VulnerabilityLink!]`](#vulnerabilitylink) | List of links associated with the vulnerability. |
|
|
| <a id="pipelinesecurityreportfindinglocation"></a>`location` | [`VulnerabilityLocation`](#vulnerabilitylocation) | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. |
|
|
| <a id="pipelinesecurityreportfindingname"></a>`name` | [`String`](#string) | Name of the vulnerability finding. |
|
|
| <a id="pipelinesecurityreportfindingproject"></a>`project` | [`Project`](#project) | Project on which the vulnerability finding was found. |
|
|
| <a id="pipelinesecurityreportfindingprojectfingerprint"></a>`projectFingerprint` | [`String`](#string) | Name of the vulnerability finding. |
|
|
| <a id="pipelinesecurityreportfindingreporttype"></a>`reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the security report that found the vulnerability finding. |
|
|
| <a id="pipelinesecurityreportfindingscanner"></a>`scanner` | [`VulnerabilityScanner`](#vulnerabilityscanner) | Scanner metadata for the vulnerability. |
|
|
| <a id="pipelinesecurityreportfindingseverity"></a>`severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability finding. |
|
|
| <a id="pipelinesecurityreportfindingsolution"></a>`solution` | [`String`](#string) | URL to the vulnerability's details page. |
|
|
| <a id="pipelinesecurityreportfindingstate"></a>`state` | [`VulnerabilityState`](#vulnerabilitystate) | Finding status. |
|
|
| <a id="pipelinesecurityreportfindingtitle"></a>`title` | [`String`](#string) | Title of the vulnerability finding. |
|
|
| <a id="pipelinesecurityreportfindinguuid"></a>`uuid` | [`String`](#string) | Name of the vulnerability finding. |
|
|
|
|
### `Project`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectactualrepositorysizelimit"></a>`actualRepositorySizeLimit` | [`Float`](#float) | Size limit for the repository in bytes. |
|
|
| <a id="projectagentconfigurations"></a>`agentConfigurations` | [`AgentConfigurationConnection`](#agentconfigurationconnection) | Agent configurations defined by the project. (see [Connections](#connections)) |
|
|
| <a id="projectallowmergeonskippedpipeline"></a>`allowMergeOnSkippedPipeline` | [`Boolean`](#boolean) | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs. |
|
|
| <a id="projectapifuzzingciconfiguration"></a>`apiFuzzingCiConfiguration` | [`ApiFuzzingCiConfiguration`](#apifuzzingciconfiguration) | API fuzzing configuration for the project. |
|
|
| <a id="projectarchived"></a>`archived` | [`Boolean`](#boolean) | Indicates the archived status of the project. |
|
|
| <a id="projectautoclosereferencedissues"></a>`autocloseReferencedIssues` | [`Boolean`](#boolean) | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically. |
|
|
| <a id="projectavatarurl"></a>`avatarUrl` | [`String`](#string) | URL to avatar image file of the project. |
|
|
| <a id="projectcicdsettings"></a>`ciCdSettings` | [`ProjectCiCdSetting`](#projectcicdsetting) | CI/CD settings for the project. |
|
|
| <a id="projectciconfigpathordefault"></a>`ciConfigPathOrDefault` | [`String!`](#string) | Path of the CI configuration file. |
|
|
| <a id="projectcijobtokenscope"></a>`ciJobTokenScope` | [`CiJobTokenScopeType`](#cijobtokenscopetype) | The CI Job Tokens scope of access. |
|
|
| <a id="projectclusteragents"></a>`clusterAgents` | [`ClusterAgentConnection`](#clusteragentconnection) | Cluster agents associated with the project. (see [Connections](#connections)) |
|
|
| <a id="projectcodecoveragesummary"></a>`codeCoverageSummary` | [`CodeCoverageSummary`](#codecoveragesummary) | Code coverage summary associated with the project. |
|
|
| <a id="projectcomplianceframeworks"></a>`complianceFrameworks` | [`ComplianceFrameworkConnection`](#complianceframeworkconnection) | Compliance frameworks associated with the project. (see [Connections](#connections)) |
|
|
| <a id="projectcontainerexpirationpolicy"></a>`containerExpirationPolicy` | [`ContainerExpirationPolicy`](#containerexpirationpolicy) | Container expiration policy of the project. |
|
|
| <a id="projectcontainerregistryenabled"></a>`containerRegistryEnabled` | [`Boolean`](#boolean) | Indicates if Container Registry is enabled for the current user. |
|
|
| <a id="projectcontainerrepositoriescount"></a>`containerRepositoriesCount` | [`Int!`](#int) | Number of container repositories in the project. |
|
|
| <a id="projectcorpuses"></a>`corpuses` | [`CoverageFuzzingCorpusConnection`](#coveragefuzzingcorpusconnection) | Find corpuses of the project. (see [Connections](#connections)) |
|
|
| <a id="projectcreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of the project creation. |
|
|
| <a id="projectdastscannerprofiles"></a>`dastScannerProfiles` | [`DastScannerProfileConnection`](#dastscannerprofileconnection) | DAST scanner profiles associated with the project. (see [Connections](#connections)) |
|
|
| <a id="projectdastsiteprofiles"></a>`dastSiteProfiles` | [`DastSiteProfileConnection`](#dastsiteprofileconnection) | DAST Site Profiles associated with the project. (see [Connections](#connections)) |
|
|
| <a id="projectdescription"></a>`description` | [`String`](#string) | Short description of the project. |
|
|
| <a id="projectdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="projectdora"></a>`dora` | [`Dora`](#dora) | Project's DORA metrics. |
|
|
| <a id="projectforkscount"></a>`forksCount` | [`Int!`](#int) | Number of times the project has been forked. |
|
|
| <a id="projectfullpath"></a>`fullPath` | [`ID!`](#id) | Full path of the project. |
|
|
| <a id="projectgrafanaintegration"></a>`grafanaIntegration` | [`GrafanaIntegration`](#grafanaintegration) | Grafana integration details for the project. |
|
|
| <a id="projectgroup"></a>`group` | [`Group`](#group) | Group of the project. |
|
|
| <a id="projecthttpurltorepo"></a>`httpUrlToRepo` | [`String`](#string) | URL to connect to the project via HTTPS. |
|
|
| <a id="projectid"></a>`id` | [`ID!`](#id) | ID of the project. |
|
|
| <a id="projectimportstatus"></a>`importStatus` | [`String`](#string) | Status of import background job of the project. |
|
|
| <a id="projectissuesenabled"></a>`issuesEnabled` | [`Boolean`](#boolean) | Indicates if Issues are enabled for the current user. |
|
|
| <a id="projectjiraimportstatus"></a>`jiraImportStatus` | [`String`](#string) | Status of Jira import background job of the project. |
|
|
| <a id="projectjiraimports"></a>`jiraImports` | [`JiraImportConnection`](#jiraimportconnection) | Jira imports into the project. (see [Connections](#connections)) |
|
|
| <a id="projectjobsenabled"></a>`jobsEnabled` | [`Boolean`](#boolean) | Indicates if CI/CD pipeline jobs are enabled for the current user. |
|
|
| <a id="projectlastactivityat"></a>`lastActivityAt` | [`Time`](#time) | Timestamp of the project last activity. |
|
|
| <a id="projectlfsenabled"></a>`lfsEnabled` | [`Boolean`](#boolean) | Indicates if the project has Large File Storage (LFS) enabled. |
|
|
| <a id="projectmergecommittemplate"></a>`mergeCommitTemplate` | [`String`](#string) | Template used to create merge commit message in merge requests. |
|
|
| <a id="projectmergerequestsenabled"></a>`mergeRequestsEnabled` | [`Boolean`](#boolean) | Indicates if Merge Requests are enabled for the current user. |
|
|
| <a id="projectmergerequestsffonlyenabled"></a>`mergeRequestsFfOnlyEnabled` | [`Boolean`](#boolean) | Indicates if no merge commits should be created and all merges should instead be fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded. |
|
|
| <a id="projectname"></a>`name` | [`String!`](#string) | Name of the project (without namespace). |
|
|
| <a id="projectnamewithnamespace"></a>`nameWithNamespace` | [`String!`](#string) | Full name of the project with its namespace. |
|
|
| <a id="projectnamespace"></a>`namespace` | [`Namespace`](#namespace) | Namespace of the project. |
|
|
| <a id="projectonlyallowmergeifalldiscussionsareresolved"></a>`onlyAllowMergeIfAllDiscussionsAreResolved` | [`Boolean`](#boolean) | Indicates if merge requests of the project can only be merged when all the discussions are resolved. |
|
|
| <a id="projectonlyallowmergeifpipelinesucceeds"></a>`onlyAllowMergeIfPipelineSucceeds` | [`Boolean`](#boolean) | Indicates if merge requests of the project can only be merged with successful jobs. |
|
|
| <a id="projectopenissuescount"></a>`openIssuesCount` | [`Int`](#int) | Number of open issues for the project. |
|
|
| <a id="projectpackagescleanuppolicy"></a>`packagesCleanupPolicy` | [`PackagesCleanupPolicy`](#packagescleanuppolicy) | Packages cleanup policy for the project. |
|
|
| <a id="projectpath"></a>`path` | [`String!`](#string) | Path of the project. |
|
|
| <a id="projectpathlocks"></a>`pathLocks` | [`PathLockConnection`](#pathlockconnection) | The project's path locks. (see [Connections](#connections)) |
|
|
| <a id="projectpipelineanalytics"></a>`pipelineAnalytics` | [`PipelineAnalytics`](#pipelineanalytics) | Pipeline analytics. |
|
|
| <a id="projectprintingmergerequestlinkenabled"></a>`printingMergeRequestLinkEnabled` | [`Boolean`](#boolean) | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line. |
|
|
| <a id="projectpublicjobs"></a>`publicJobs` | [`Boolean`](#boolean) | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. |
|
|
| <a id="projectpushrules"></a>`pushRules` | [`PushRules`](#pushrules) | Project's push rules settings. |
|
|
| <a id="projectrecentissueboards"></a>`recentIssueBoards` | [`BoardConnection`](#boardconnection) | List of recently visited boards of the project. Maximum size is 4. (see [Connections](#connections)) |
|
|
| <a id="projectremovesourcebranchaftermerge"></a>`removeSourceBranchAfterMerge` | [`Boolean`](#boolean) | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project. |
|
|
| <a id="projectrepository"></a>`repository` | [`Repository`](#repository) | Git repository of the project. |
|
|
| <a id="projectrepositorysizeexcess"></a>`repositorySizeExcess` | [`Float`](#float) | Size of repository that exceeds the limit in bytes. |
|
|
| <a id="projectrequestaccessenabled"></a>`requestAccessEnabled` | [`Boolean`](#boolean) | Indicates if users can request member access to the project. |
|
|
| <a id="projectrequirementstatescount"></a>`requirementStatesCount` | [`RequirementStatesCount`](#requirementstatescount) | Number of requirements for the project by their state. |
|
|
| <a id="projectsastciconfiguration"></a>`sastCiConfiguration` | [`SastCiConfiguration`](#sastciconfiguration) | SAST CI configuration for the project. |
|
|
| <a id="projectscanresultpolicies"></a>`scanResultPolicies` | [`ScanResultPolicyConnection`](#scanresultpolicyconnection) | Scan Result Policies of the project. (see [Connections](#connections)) |
|
|
| <a id="projectsecuritydashboardpath"></a>`securityDashboardPath` | [`String`](#string) | Path to project's security dashboard. |
|
|
| <a id="projectsecurityscanners"></a>`securityScanners` | [`SecurityScanners`](#securityscanners) | Information about security analyzers used in the project. |
|
|
| <a id="projectsentryerrors"></a>`sentryErrors` | [`SentryErrorCollection`](#sentryerrorcollection) | Paginated collection of Sentry errors on the project. |
|
|
| <a id="projectservicedeskaddress"></a>`serviceDeskAddress` | [`String`](#string) | E-mail address of the service desk. |
|
|
| <a id="projectservicedeskenabled"></a>`serviceDeskEnabled` | [`Boolean`](#boolean) | Indicates if the project has service desk enabled. |
|
|
| <a id="projectsharedrunnersenabled"></a>`sharedRunnersEnabled` | [`Boolean`](#boolean) | Indicates if shared runners are enabled for the project. |
|
|
| <a id="projectsnippetsenabled"></a>`snippetsEnabled` | [`Boolean`](#boolean) | Indicates if Snippets are enabled for the current user. |
|
|
| <a id="projectsquashcommittemplate"></a>`squashCommitTemplate` | [`String`](#string) | Template used to create squash commit message in merge requests. |
|
|
| <a id="projectsquashreadonly"></a>`squashReadOnly` | [`Boolean!`](#boolean) | Indicates if `squashReadOnly` is enabled. |
|
|
| <a id="projectsshurltorepo"></a>`sshUrlToRepo` | [`String`](#string) | URL to connect to the project via SSH. |
|
|
| <a id="projectstarcount"></a>`starCount` | [`Int!`](#int) | Number of times the project has been starred. |
|
|
| <a id="projectstatistics"></a>`statistics` | [`ProjectStatistics`](#projectstatistics) | Statistics of the project. |
|
|
| <a id="projectsuggestioncommitmessage"></a>`suggestionCommitMessage` | [`String`](#string) | Commit message used to apply merge request suggestions. |
|
|
| <a id="projecttaglist"></a>`tagList` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.12. Use `topics`. |
|
|
| <a id="projectterraformstates"></a>`terraformStates` | [`TerraformStateConnection`](#terraformstateconnection) | Terraform states associated with the project. (see [Connections](#connections)) |
|
|
| <a id="projecttopics"></a>`topics` | [`[String!]`](#string) | List of project topics. |
|
|
| <a id="projectuserpermissions"></a>`userPermissions` | [`ProjectPermissions!`](#projectpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="projectvisibility"></a>`visibility` | [`String`](#string) | Visibility of the project. |
|
|
| <a id="projectvulnerabilityscanners"></a>`vulnerabilityScanners` | [`VulnerabilityScannerConnection`](#vulnerabilityscannerconnection) | Vulnerability scanners reported on the project vulnerabilities. (see [Connections](#connections)) |
|
|
| <a id="projectweburl"></a>`webUrl` | [`String`](#string) | Web URL of the project. |
|
|
| <a id="projectwikienabled"></a>`wikiEnabled` | [`Boolean`](#boolean) | Indicates if Wikis are enabled for the current user. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Project.alertManagementAlert`
|
|
|
|
A single Alert Management alert of the project.
|
|
|
|
Returns [`AlertManagementAlert`](#alertmanagementalert).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectalertmanagementalertassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of a user assigned to the issue. |
|
|
| <a id="projectalertmanagementalertdomain"></a>`domain` | [`AlertManagementDomainFilter!`](#alertmanagementdomainfilter) | Filter query for given domain. |
|
|
| <a id="projectalertmanagementalertiid"></a>`iid` | [`String`](#string) | IID of the alert. For example, "1". |
|
|
| <a id="projectalertmanagementalertsearch"></a>`search` | [`String`](#string) | Search query for title, description, service, or monitoring_tool. |
|
|
| <a id="projectalertmanagementalertsort"></a>`sort` | [`AlertManagementAlertSort`](#alertmanagementalertsort) | Sort alerts by this criteria. |
|
|
| <a id="projectalertmanagementalertstatuses"></a>`statuses` | [`[AlertManagementStatus!]`](#alertmanagementstatus) | Alerts with the specified statues. For example, `[TRIGGERED]`. |
|
|
|
|
##### `Project.alertManagementAlertStatusCounts`
|
|
|
|
Counts of alerts by status for the project.
|
|
|
|
Returns [`AlertManagementAlertStatusCountsType`](#alertmanagementalertstatuscountstype).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectalertmanagementalertstatuscountsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of a user assigned to the issue. |
|
|
| <a id="projectalertmanagementalertstatuscountssearch"></a>`search` | [`String`](#string) | Search query for title, description, service, or monitoring_tool. |
|
|
|
|
##### `Project.alertManagementAlerts`
|
|
|
|
Alert Management alerts of the project.
|
|
|
|
Returns [`AlertManagementAlertConnection`](#alertmanagementalertconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectalertmanagementalertsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of a user assigned to the issue. |
|
|
| <a id="projectalertmanagementalertsdomain"></a>`domain` | [`AlertManagementDomainFilter!`](#alertmanagementdomainfilter) | Filter query for given domain. |
|
|
| <a id="projectalertmanagementalertsiid"></a>`iid` | [`String`](#string) | IID of the alert. For example, "1". |
|
|
| <a id="projectalertmanagementalertssearch"></a>`search` | [`String`](#string) | Search query for title, description, service, or monitoring_tool. |
|
|
| <a id="projectalertmanagementalertssort"></a>`sort` | [`AlertManagementAlertSort`](#alertmanagementalertsort) | Sort alerts by this criteria. |
|
|
| <a id="projectalertmanagementalertsstatuses"></a>`statuses` | [`[AlertManagementStatus!]`](#alertmanagementstatus) | Alerts with the specified statues. For example, `[TRIGGERED]`. |
|
|
|
|
##### `Project.alertManagementHttpIntegrations`
|
|
|
|
HTTP Integrations which can receive alerts for the project.
|
|
|
|
Returns [`AlertManagementHttpIntegrationConnection`](#alertmanagementhttpintegrationconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectalertmanagementhttpintegrationsid"></a>`id` | [`AlertManagementHttpIntegrationID`](#alertmanagementhttpintegrationid) | ID of the integration. |
|
|
|
|
##### `Project.alertManagementIntegrations`
|
|
|
|
Integrations which can receive alerts for the project.
|
|
|
|
Returns [`AlertManagementIntegrationConnection`](#alertmanagementintegrationconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectalertmanagementintegrationsid"></a>`id` | [`GlobalID`](#globalid) | ID of the integration. |
|
|
|
|
##### `Project.alertManagementPayloadFields`
|
|
|
|
Extract alert fields from payload for custom mapping.
|
|
|
|
Returns [`[AlertManagementPayloadAlertField!]`](#alertmanagementpayloadalertfield).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectalertmanagementpayloadfieldspayloadexample"></a>`payloadExample` | [`String!`](#string) | Sample payload for extracting alert fields for custom mappings. |
|
|
|
|
##### `Project.board`
|
|
|
|
A single board of the project.
|
|
|
|
Returns [`Board`](#board).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectboardid"></a>`id` | [`BoardID!`](#boardid) | ID of the board. |
|
|
|
|
##### `Project.boards`
|
|
|
|
Boards of the project.
|
|
|
|
Returns [`BoardConnection`](#boardconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectboardsid"></a>`id` | [`BoardID`](#boardid) | Find a board by its ID. |
|
|
|
|
##### `Project.ciTemplate`
|
|
|
|
Find a single CI/CD template by name.
|
|
|
|
Returns [`CiTemplate`](#citemplate).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectcitemplatename"></a>`name` | [`String!`](#string) | Name of the CI/CD template to search for. Template must be formatted as `Name.gitlab-ci.yml`. |
|
|
|
|
##### `Project.clusterAgent`
|
|
|
|
Find a single cluster agent by name.
|
|
|
|
Returns [`ClusterAgent`](#clusteragent).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectclusteragentname"></a>`name` | [`String!`](#string) | Name of the cluster agent. |
|
|
|
|
##### `Project.containerRepositories`
|
|
|
|
Container repositories of the project.
|
|
|
|
Returns [`ContainerRepositoryConnection`](#containerrepositoryconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectcontainerrepositoriesname"></a>`name` | [`String`](#string) | Filter the container repositories by their name. |
|
|
| <a id="projectcontainerrepositoriessort"></a>`sort` | [`ContainerRepositorySort`](#containerrepositorysort) | Sort container repositories by this criteria. |
|
|
|
|
##### `Project.dastProfile`
|
|
|
|
DAST Profile associated with the project.
|
|
|
|
Returns [`DastProfile`](#dastprofile).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectdastprofilehasdastprofileschedule"></a>`hasDastProfileSchedule` | [`Boolean`](#boolean) | Filter DAST Profiles by whether or not they have a schedule. |
|
|
| <a id="projectdastprofileid"></a>`id` | [`DastProfileID!`](#dastprofileid) | ID of the DAST Profile. |
|
|
|
|
##### `Project.dastProfiles`
|
|
|
|
DAST Profiles associated with the project.
|
|
|
|
Returns [`DastProfileConnection`](#dastprofileconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectdastprofileshasdastprofileschedule"></a>`hasDastProfileSchedule` | [`Boolean`](#boolean) | Filter DAST Profiles by whether or not they have a schedule. |
|
|
|
|
##### `Project.dastSiteProfile`
|
|
|
|
DAST Site Profile associated with the project.
|
|
|
|
Returns [`DastSiteProfile`](#dastsiteprofile).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectdastsiteprofileid"></a>`id` | [`DastSiteProfileID!`](#dastsiteprofileid) | ID of the site profile. |
|
|
|
|
##### `Project.dastSiteValidations`
|
|
|
|
DAST Site Validations associated with the project.
|
|
|
|
Returns [`DastSiteValidationConnection`](#dastsitevalidationconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectdastsitevalidationsnormalizedtargeturls"></a>`normalizedTargetUrls` | [`[String!]`](#string) | Normalized URL of the target to be scanned. |
|
|
| <a id="projectdastsitevalidationsstatus"></a>`status` | [`DastSiteValidationStatusEnum`](#dastsitevalidationstatusenum) | Status of the site validation. |
|
|
|
|
##### `Project.environment`
|
|
|
|
A single environment of the project.
|
|
|
|
Returns [`Environment`](#environment).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectenvironmentname"></a>`name` | [`String`](#string) | Name of the environment. |
|
|
| <a id="projectenvironmentsearch"></a>`search` | [`String`](#string) | Search query for environment name. |
|
|
| <a id="projectenvironmentstates"></a>`states` | [`[String!]`](#string) | States of environments that should be included in result. |
|
|
|
|
##### `Project.environments`
|
|
|
|
Environments of the project.
|
|
|
|
Returns [`EnvironmentConnection`](#environmentconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectenvironmentsname"></a>`name` | [`String`](#string) | Name of the environment. |
|
|
| <a id="projectenvironmentssearch"></a>`search` | [`String`](#string) | Search query for environment name. |
|
|
| <a id="projectenvironmentsstates"></a>`states` | [`[String!]`](#string) | States of environments that should be included in result. |
|
|
|
|
##### `Project.incidentManagementEscalationPolicies`
|
|
|
|
Incident Management escalation policies of the project.
|
|
|
|
Returns [`EscalationPolicyTypeConnection`](#escalationpolicytypeconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectincidentmanagementescalationpoliciesname"></a>`name` | [`String`](#string) | Fuzzy search by escalation policy name. |
|
|
|
|
##### `Project.incidentManagementEscalationPolicy`
|
|
|
|
Incident Management escalation policy of the project.
|
|
|
|
Returns [`EscalationPolicyType`](#escalationpolicytype).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectincidentmanagementescalationpolicyid"></a>`id` | [`IncidentManagementEscalationPolicyID!`](#incidentmanagementescalationpolicyid) | ID of the escalation policy. |
|
|
| <a id="projectincidentmanagementescalationpolicyname"></a>`name` | [`String`](#string) | Fuzzy search by escalation policy name. |
|
|
|
|
##### `Project.incidentManagementOncallSchedules`
|
|
|
|
Incident Management On-call schedules of the project.
|
|
|
|
Returns [`IncidentManagementOncallScheduleConnection`](#incidentmanagementoncallscheduleconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectincidentmanagementoncallschedulesiids"></a>`iids` | [`[ID!]`](#id) | IIDs of on-call schedules. |
|
|
|
|
##### `Project.incidentManagementTimelineEvent`
|
|
|
|
Incident Management Timeline event associated with the incident.
|
|
|
|
Returns [`TimelineEventType`](#timelineeventtype).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectincidentmanagementtimelineeventid"></a>`id` | [`IncidentManagementTimelineEventID!`](#incidentmanagementtimelineeventid) | ID of the timeline event. |
|
|
| <a id="projectincidentmanagementtimelineeventincidentid"></a>`incidentId` | [`IssueID!`](#issueid) | ID of the incident. |
|
|
|
|
##### `Project.incidentManagementTimelineEvents`
|
|
|
|
Incident Management Timeline events associated with the incident.
|
|
|
|
Returns [`TimelineEventTypeConnection`](#timelineeventtypeconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectincidentmanagementtimelineeventsincidentid"></a>`incidentId` | [`IssueID!`](#issueid) | ID of the incident. |
|
|
|
|
##### `Project.issue`
|
|
|
|
A single issue of the project.
|
|
|
|
Returns [`Issue`](#issue).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectissueassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="projectissueassigneeusername"></a>`assigneeUsername` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use `assigneeUsernames`. |
|
|
| <a id="projectissueassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. |
|
|
| <a id="projectissueauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. |
|
|
| <a id="projectissueclosedafter"></a>`closedAfter` | [`Time`](#time) | Issues closed after this date. |
|
|
| <a id="projectissueclosedbefore"></a>`closedBefore` | [`Time`](#time) | Issues closed before this date. |
|
|
| <a id="projectissueconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues. |
|
|
| <a id="projectissuecreatedafter"></a>`createdAfter` | [`Time`](#time) | Issues created after this date. |
|
|
| <a id="projectissuecreatedbefore"></a>`createdBefore` | [`Time`](#time) | Issues created before this date. |
|
|
| <a id="projectissuecrmcontactid"></a>`crmContactId` | [`String`](#string) | ID of a contact assigned to the issues. |
|
|
| <a id="projectissuecrmorganizationid"></a>`crmOrganizationId` | [`String`](#string) | ID of an organization assigned to the issues. |
|
|
| <a id="projectissueepicid"></a>`epicId` | [`String`](#string) | ID of an epic associated with the issues, "none" and "any" values are supported. |
|
|
| <a id="projectissueiid"></a>`iid` | [`String`](#string) | IID of the issue. For example, "1". |
|
|
| <a id="projectissueiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example, `["1", "2"]`. |
|
|
| <a id="projectissueincludesubepics"></a>`includeSubepics` | [`Boolean`](#boolean) | Whether to include subepics when filtering issues by epicId. |
|
|
| <a id="projectissueiterationid"></a>`iterationId` | [`[ID]`](#id) | List of iteration Global IDs applied to the issue. |
|
|
| <a id="projectissueiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by iteration ID wildcard. |
|
|
| <a id="projectissuelabelname"></a>`labelName` | [`[String]`](#string) | Labels applied to this issue. |
|
|
| <a id="projectissuemilestonetitle"></a>`milestoneTitle` | [`[String]`](#string) | Milestone applied to this issue. |
|
|
| <a id="projectissuemilestonewildcardid"></a>`milestoneWildcardId` | [`MilestoneWildcardId`](#milestonewildcardid) | Filter issues by milestone ID wildcard. |
|
|
| <a id="projectissuemyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="projectissuenot"></a>`not` | [`NegatedIssueFilterInput`](#negatedissuefilterinput) | Negated arguments. |
|
|
| <a id="projectissuereleasetag"></a>`releaseTag` | [`[String!]`](#string) | Release tag associated with the issue's milestone. |
|
|
| <a id="projectissuereleasetagwildcardid"></a>`releaseTagWildcardId` | [`ReleaseTagWildcardId`](#releasetagwildcardid) | Filter issues by release tag ID wildcard. |
|
|
| <a id="projectissuesearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="projectissuesort"></a>`sort` | [`IssueSort`](#issuesort) | Sort issues by this criteria. |
|
|
| <a id="projectissuestate"></a>`state` | [`IssuableState`](#issuablestate) | Current state of this issue. |
|
|
| <a id="projectissuetypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter issues by the given issue types. |
|
|
| <a id="projectissueupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Issues updated after this date. |
|
|
| <a id="projectissueupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Issues updated before this date. |
|
|
| <a id="projectissueweight"></a>`weight` | [`String`](#string) | Weight applied to the issue, "none" and "any" values are supported. |
|
|
|
|
##### `Project.issueStatusCounts`
|
|
|
|
Counts of issues by status for the project.
|
|
|
|
Returns [`IssueStatusCountsType`](#issuestatuscountstype).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectissuestatuscountsassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="projectissuestatuscountsassigneeusername"></a>`assigneeUsername` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use `assigneeUsernames`. |
|
|
| <a id="projectissuestatuscountsassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. |
|
|
| <a id="projectissuestatuscountsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. |
|
|
| <a id="projectissuestatuscountsclosedafter"></a>`closedAfter` | [`Time`](#time) | Issues closed after this date. |
|
|
| <a id="projectissuestatuscountsclosedbefore"></a>`closedBefore` | [`Time`](#time) | Issues closed before this date. |
|
|
| <a id="projectissuestatuscountsconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues. |
|
|
| <a id="projectissuestatuscountscreatedafter"></a>`createdAfter` | [`Time`](#time) | Issues created after this date. |
|
|
| <a id="projectissuestatuscountscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Issues created before this date. |
|
|
| <a id="projectissuestatuscountscrmcontactid"></a>`crmContactId` | [`String`](#string) | ID of a contact assigned to the issues. |
|
|
| <a id="projectissuestatuscountscrmorganizationid"></a>`crmOrganizationId` | [`String`](#string) | ID of an organization assigned to the issues. |
|
|
| <a id="projectissuestatuscountsiid"></a>`iid` | [`String`](#string) | IID of the issue. For example, "1". |
|
|
| <a id="projectissuestatuscountsiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example, `["1", "2"]`. |
|
|
| <a id="projectissuestatuscountslabelname"></a>`labelName` | [`[String]`](#string) | Labels applied to this issue. |
|
|
| <a id="projectissuestatuscountsmilestonetitle"></a>`milestoneTitle` | [`[String]`](#string) | Milestone applied to this issue. |
|
|
| <a id="projectissuestatuscountsmilestonewildcardid"></a>`milestoneWildcardId` | [`MilestoneWildcardId`](#milestonewildcardid) | Filter issues by milestone ID wildcard. |
|
|
| <a id="projectissuestatuscountsmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="projectissuestatuscountsnot"></a>`not` | [`NegatedIssueFilterInput`](#negatedissuefilterinput) | Negated arguments. |
|
|
| <a id="projectissuestatuscountsreleasetag"></a>`releaseTag` | [`[String!]`](#string) | Release tag associated with the issue's milestone. |
|
|
| <a id="projectissuestatuscountsreleasetagwildcardid"></a>`releaseTagWildcardId` | [`ReleaseTagWildcardId`](#releasetagwildcardid) | Filter issues by release tag ID wildcard. |
|
|
| <a id="projectissuestatuscountssearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="projectissuestatuscountstypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter issues by the given issue types. |
|
|
| <a id="projectissuestatuscountsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Issues updated after this date. |
|
|
| <a id="projectissuestatuscountsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Issues updated before this date. |
|
|
|
|
##### `Project.issues`
|
|
|
|
Issues of the project.
|
|
|
|
Returns [`IssueConnection`](#issueconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectissuesassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="projectissuesassigneeusername"></a>`assigneeUsername` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.11. Use `assigneeUsernames`. |
|
|
| <a id="projectissuesassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. |
|
|
| <a id="projectissuesauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. |
|
|
| <a id="projectissuesclosedafter"></a>`closedAfter` | [`Time`](#time) | Issues closed after this date. |
|
|
| <a id="projectissuesclosedbefore"></a>`closedBefore` | [`Time`](#time) | Issues closed before this date. |
|
|
| <a id="projectissuesconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues. |
|
|
| <a id="projectissuescreatedafter"></a>`createdAfter` | [`Time`](#time) | Issues created after this date. |
|
|
| <a id="projectissuescreatedbefore"></a>`createdBefore` | [`Time`](#time) | Issues created before this date. |
|
|
| <a id="projectissuescrmcontactid"></a>`crmContactId` | [`String`](#string) | ID of a contact assigned to the issues. |
|
|
| <a id="projectissuescrmorganizationid"></a>`crmOrganizationId` | [`String`](#string) | ID of an organization assigned to the issues. |
|
|
| <a id="projectissuesepicid"></a>`epicId` | [`String`](#string) | ID of an epic associated with the issues, "none" and "any" values are supported. |
|
|
| <a id="projectissuesiid"></a>`iid` | [`String`](#string) | IID of the issue. For example, "1". |
|
|
| <a id="projectissuesiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example, `["1", "2"]`. |
|
|
| <a id="projectissuesincludesubepics"></a>`includeSubepics` | [`Boolean`](#boolean) | Whether to include subepics when filtering issues by epicId. |
|
|
| <a id="projectissuesiterationid"></a>`iterationId` | [`[ID]`](#id) | List of iteration Global IDs applied to the issue. |
|
|
| <a id="projectissuesiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by iteration ID wildcard. |
|
|
| <a id="projectissueslabelname"></a>`labelName` | [`[String]`](#string) | Labels applied to this issue. |
|
|
| <a id="projectissuesmilestonetitle"></a>`milestoneTitle` | [`[String]`](#string) | Milestone applied to this issue. |
|
|
| <a id="projectissuesmilestonewildcardid"></a>`milestoneWildcardId` | [`MilestoneWildcardId`](#milestonewildcardid) | Filter issues by milestone ID wildcard. |
|
|
| <a id="projectissuesmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="projectissuesnot"></a>`not` | [`NegatedIssueFilterInput`](#negatedissuefilterinput) | Negated arguments. |
|
|
| <a id="projectissuesreleasetag"></a>`releaseTag` | [`[String!]`](#string) | Release tag associated with the issue's milestone. |
|
|
| <a id="projectissuesreleasetagwildcardid"></a>`releaseTagWildcardId` | [`ReleaseTagWildcardId`](#releasetagwildcardid) | Filter issues by release tag ID wildcard. |
|
|
| <a id="projectissuessearch"></a>`search` | [`String`](#string) | Search query for title or description. |
|
|
| <a id="projectissuessort"></a>`sort` | [`IssueSort`](#issuesort) | Sort issues by this criteria. |
|
|
| <a id="projectissuesstate"></a>`state` | [`IssuableState`](#issuablestate) | Current state of this issue. |
|
|
| <a id="projectissuestypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter issues by the given issue types. |
|
|
| <a id="projectissuesupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Issues updated after this date. |
|
|
| <a id="projectissuesupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Issues updated before this date. |
|
|
| <a id="projectissuesweight"></a>`weight` | [`String`](#string) | Weight applied to the issue, "none" and "any" values are supported. |
|
|
|
|
##### `Project.iterationCadences`
|
|
|
|
Find iteration cadences.
|
|
|
|
Returns [`IterationCadenceConnection`](#iterationcadenceconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectiterationcadencesactive"></a>`active` | [`Boolean`](#boolean) | Whether the iteration cadence is active. |
|
|
| <a id="projectiterationcadencesautomatic"></a>`automatic` | [`Boolean`](#boolean) | Whether the iteration cadence should automatically generate upcoming iterations. |
|
|
| <a id="projectiterationcadencesdurationinweeks"></a>`durationInWeeks` | [`Int`](#int) | Duration in weeks of the iterations within this cadence. |
|
|
| <a id="projectiterationcadencesid"></a>`id` | [`IterationsCadenceID`](#iterationscadenceid) | Global ID of the iteration cadence to look up. |
|
|
| <a id="projectiterationcadencesincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Whether to include ancestor groups to search iterations cadences in. |
|
|
| <a id="projectiterationcadencestitle"></a>`title` | [`String`](#string) | Fuzzy search by title. |
|
|
|
|
##### `Project.iterations`
|
|
|
|
Find iterations.
|
|
|
|
Returns [`IterationConnection`](#iterationconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectiterationsenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="projectiterationsid"></a>`id` | [`ID`](#id) | Global ID of the Iteration to look up. |
|
|
| <a id="projectiterationsiid"></a>`iid` | [`ID`](#id) | Internal ID of the Iteration to look up. |
|
|
| <a id="projectiterationsin"></a>`in` | [`[IterationSearchableField!]`](#iterationsearchablefield) | Fields in which the fuzzy-search should be performed with the query given in the argument `search`. Defaults to `[title]`. |
|
|
| <a id="projectiterationsincludeancestors"></a>`includeAncestors` | [`Boolean`](#boolean) | Whether to include ancestor iterations. Defaults to true. |
|
|
| <a id="projectiterationsiterationcadenceids"></a>`iterationCadenceIds` | [`[IterationsCadenceID!]`](#iterationscadenceid) | Global iteration cadence IDs by which to look up the iterations. |
|
|
| <a id="projectiterationssearch"></a>`search` | [`String`](#string) | Query used for fuzzy-searching in the fields selected in the argument `in`. Returns all iterations if empty. |
|
|
| <a id="projectiterationssort"></a>`sort` | [`IterationSort`](#iterationsort) | List iterations by sort order. If unspecified, an arbitrary order (subject to change) is used. |
|
|
| <a id="projectiterationsstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="projectiterationsstate"></a>`state` | [`IterationState`](#iterationstate) | Filter iterations by state. |
|
|
| <a id="projectiterationstimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="projectiterationstitle"></a>`title` **{warning-solid}** | [`String`](#string) | **Deprecated** in 15.4. The argument will be removed in 15.4. Please use `search` and `in` fields instead. |
|
|
|
|
##### `Project.jobs`
|
|
|
|
Jobs of a project. This field can only be resolved for one project in any single request.
|
|
|
|
Returns [`CiJobConnection`](#cijobconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectjobsstatuses"></a>`statuses` | [`[CiJobStatus!]`](#cijobstatus) | Filter jobs by status. |
|
|
|
|
##### `Project.label`
|
|
|
|
Label available on this project.
|
|
|
|
Returns [`Label`](#label).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectlabeltitle"></a>`title` | [`String!`](#string) | Title of the label. |
|
|
|
|
##### `Project.labels`
|
|
|
|
Labels available on this project.
|
|
|
|
Returns [`LabelConnection`](#labelconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectlabelsincludeancestorgroups"></a>`includeAncestorGroups` | [`Boolean`](#boolean) | Include labels from ancestor groups. |
|
|
| <a id="projectlabelssearchterm"></a>`searchTerm` | [`String`](#string) | Search term to find labels with. |
|
|
|
|
##### `Project.mergeRequest`
|
|
|
|
A single merge request of the project.
|
|
|
|
Returns [`MergeRequest`](#mergerequest).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectmergerequestiid"></a>`iid` | [`String!`](#string) | IID of the merge request, for example `1`. |
|
|
|
|
##### `Project.mergeRequests`
|
|
|
|
Merge requests of the project.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="projectmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="projectmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="projectmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="projectmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="projectmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="projectmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="projectmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="projectmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="projectmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="projectmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="projectmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="projectmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="projectmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="projectmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="projectmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="projectmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="projectmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `Project.milestones`
|
|
|
|
Milestones of the project.
|
|
|
|
Returns [`MilestoneConnection`](#milestoneconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectmilestonescontainingdate"></a>`containingDate` | [`Time`](#time) | Date the milestone contains. |
|
|
| <a id="projectmilestonesenddate"></a>`endDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.end. |
|
|
| <a id="projectmilestonesids"></a>`ids` | [`[ID!]`](#id) | Array of global milestone IDs, e.g., `"gid://gitlab/Milestone/1"`. |
|
|
| <a id="projectmilestonesincludeancestors"></a>`includeAncestors` | [`Boolean`](#boolean) | Also return milestones in the project's parent group and its ancestors. |
|
|
| <a id="projectmilestonessearchtitle"></a>`searchTitle` | [`String`](#string) | Search string for the title. |
|
|
| <a id="projectmilestonessort"></a>`sort` | [`MilestoneSort`](#milestonesort) | Sort milestones by this criteria. |
|
|
| <a id="projectmilestonesstartdate"></a>`startDate` **{warning-solid}** | [`Time`](#time) | **Deprecated** in 13.5. Use timeframe.start. |
|
|
| <a id="projectmilestonesstate"></a>`state` | [`MilestoneStateEnum`](#milestonestateenum) | Filter milestones by state. |
|
|
| <a id="projectmilestonestimeframe"></a>`timeframe` | [`Timeframe`](#timeframe) | List items overlapping the given timeframe. |
|
|
| <a id="projectmilestonestitle"></a>`title` | [`String`](#string) | Title of the milestone. |
|
|
|
|
##### `Project.networkPolicies`
|
|
|
|
Network Policies of the project.
|
|
|
|
WARNING:
|
|
**Deprecated** in 14.8.
|
|
Network policies are deprecated and will be removed in GitLab 16.0. Since GitLab 15.0 this field returns no data.
|
|
|
|
Returns [`NetworkPolicyConnection`](#networkpolicyconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectnetworkpoliciesenvironmentid"></a>`environmentId` | [`EnvironmentID`](#environmentid) | Global ID of the environment to filter policies. |
|
|
|
|
##### `Project.packages`
|
|
|
|
Packages of the project.
|
|
|
|
Returns [`PackageConnection`](#packageconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectpackagesincludeversionless"></a>`includeVersionless` | [`Boolean`](#boolean) | Include versionless packages. |
|
|
| <a id="projectpackagespackagename"></a>`packageName` | [`String`](#string) | Search a package by name. |
|
|
| <a id="projectpackagespackagetype"></a>`packageType` | [`PackageTypeEnum`](#packagetypeenum) | Filter a package by type. |
|
|
| <a id="projectpackagessort"></a>`sort` | [`PackageSort`](#packagesort) | Sort packages by this criteria. |
|
|
| <a id="projectpackagesstatus"></a>`status` | [`PackageStatus`](#packagestatus) | Filter a package by status. |
|
|
|
|
##### `Project.pipeline`
|
|
|
|
Build pipeline of the project.
|
|
|
|
Returns [`Pipeline`](#pipeline).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectpipelineiid"></a>`iid` | [`ID`](#id) | IID of the Pipeline. For example, "1". |
|
|
| <a id="projectpipelinesha"></a>`sha` | [`String`](#string) | SHA of the Pipeline. For example, "dyd0f15ay83993f5ab66k927w28673882x99100b". |
|
|
|
|
##### `Project.pipelineCounts`
|
|
|
|
Build pipeline counts of the project.
|
|
|
|
Returns [`PipelineCounts`](#pipelinecounts).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectpipelinecountsref"></a>`ref` | [`String`](#string) | Filter pipelines by the ref they are run for. |
|
|
| <a id="projectpipelinecountssha"></a>`sha` | [`String`](#string) | Filter pipelines by the SHA of the commit they are run for. |
|
|
| <a id="projectpipelinecountssource"></a>`source` | [`String`](#string) | Filter pipelines by their source. |
|
|
|
|
##### `Project.pipelines`
|
|
|
|
Build pipelines of the project.
|
|
|
|
Returns [`PipelineConnection`](#pipelineconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectpipelinesref"></a>`ref` | [`String`](#string) | Filter pipelines by the ref they are run for. |
|
|
| <a id="projectpipelinesscope"></a>`scope` | [`PipelineScopeEnum`](#pipelinescopeenum) | Filter pipelines by scope. |
|
|
| <a id="projectpipelinessha"></a>`sha` | [`String`](#string) | Filter pipelines by the sha of the commit they are run for. |
|
|
| <a id="projectpipelinessource"></a>`source` | [`String`](#string) | Filter pipelines by their source. |
|
|
| <a id="projectpipelinesstatus"></a>`status` | [`PipelineStatusEnum`](#pipelinestatusenum) | Filter pipelines by their status. |
|
|
| <a id="projectpipelinesupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Pipelines updated after this date. |
|
|
| <a id="projectpipelinesupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Pipelines updated before this date. |
|
|
| <a id="projectpipelinesusername"></a>`username` | [`String`](#string) | Filter pipelines by the user that triggered the pipeline. |
|
|
|
|
##### `Project.projectMembers`
|
|
|
|
Members of the project.
|
|
|
|
Returns [`MemberInterfaceConnection`](#memberinterfaceconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectprojectmembersrelations"></a>`relations` | [`[ProjectMemberRelation!]`](#projectmemberrelation) | Filter members by the given member relations. |
|
|
| <a id="projectprojectmemberssearch"></a>`search` | [`String`](#string) | Search query. |
|
|
|
|
##### `Project.release`
|
|
|
|
A single release of the project.
|
|
|
|
Returns [`Release`](#release).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectreleasetagname"></a>`tagName` | [`String!`](#string) | Name of the tag associated to the release. |
|
|
|
|
##### `Project.releases`
|
|
|
|
Releases of the project.
|
|
|
|
Returns [`ReleaseConnection`](#releaseconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectreleasessort"></a>`sort` | [`ReleaseSort`](#releasesort) | Sort releases by this criteria. |
|
|
|
|
##### `Project.requirement`
|
|
|
|
Find a single requirement.
|
|
|
|
Returns [`Requirement`](#requirement).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectrequirementauthorusername"></a>`authorUsername` | [`[String!]`](#string) | Filter requirements by author username. |
|
|
| <a id="projectrequirementiid"></a>`iid` | [`ID`](#id) | IID of the requirement, e.g., "1". |
|
|
| <a id="projectrequirementiids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of requirements, e.g., `[1, 2]`. |
|
|
| <a id="projectrequirementlasttestreportstate"></a>`lastTestReportState` | [`RequirementStatusFilter`](#requirementstatusfilter) | State of latest requirement test report. |
|
|
| <a id="projectrequirementsearch"></a>`search` | [`String`](#string) | Search query for requirement title. |
|
|
| <a id="projectrequirementsort"></a>`sort` | [`Sort`](#sort) | List requirements by sort order. |
|
|
| <a id="projectrequirementstate"></a>`state` | [`RequirementState`](#requirementstate) | Filter requirements by state. |
|
|
|
|
##### `Project.requirements`
|
|
|
|
Find requirements.
|
|
|
|
Returns [`RequirementConnection`](#requirementconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectrequirementsauthorusername"></a>`authorUsername` | [`[String!]`](#string) | Filter requirements by author username. |
|
|
| <a id="projectrequirementsiid"></a>`iid` | [`ID`](#id) | IID of the requirement, e.g., "1". |
|
|
| <a id="projectrequirementsiids"></a>`iids` | [`[ID!]`](#id) | List of IIDs of requirements, e.g., `[1, 2]`. |
|
|
| <a id="projectrequirementslasttestreportstate"></a>`lastTestReportState` | [`RequirementStatusFilter`](#requirementstatusfilter) | State of latest requirement test report. |
|
|
| <a id="projectrequirementssearch"></a>`search` | [`String`](#string) | Search query for requirement title. |
|
|
| <a id="projectrequirementssort"></a>`sort` | [`Sort`](#sort) | List requirements by sort order. |
|
|
| <a id="projectrequirementsstate"></a>`state` | [`RequirementState`](#requirementstate) | Filter requirements by state. |
|
|
|
|
##### `Project.scanExecutionPolicies`
|
|
|
|
Scan Execution Policies of the project.
|
|
|
|
Returns [`ScanExecutionPolicyConnection`](#scanexecutionpolicyconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectscanexecutionpoliciesactionscantypes"></a>`actionScanTypes` | [`[SecurityReportTypeEnum!]`](#securityreporttypeenum) | Filters policies by the action scan type. Only these scan types are supported: `dast`, `secret_detection`, `cluster_image_scanning`, `container_scanning`, `sast`. |
|
|
| <a id="projectscanexecutionpoliciesrelationship"></a>`relationship` | [`SecurityPolicyRelationType`](#securitypolicyrelationtype) | Filter policies by the given policy relationship. |
|
|
|
|
##### `Project.securityTrainingProviders`
|
|
|
|
List of security training providers for the project.
|
|
|
|
Returns [`[ProjectSecurityTraining!]`](#projectsecuritytraining).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectsecuritytrainingprovidersonlyenabled"></a>`onlyEnabled` | [`Boolean`](#boolean) | Filter the list by only enabled security trainings. |
|
|
|
|
##### `Project.securityTrainingUrls`
|
|
|
|
Security training URLs for the enabled training providers of the project.
|
|
|
|
Returns [`[SecurityTrainingUrl!]`](#securitytrainingurl).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectsecuritytrainingurlsfilename"></a>`filename` | [`String`](#string) | Filename to filter security training URLs by programming language. |
|
|
| <a id="projectsecuritytrainingurlsidentifierexternalids"></a>`identifierExternalIds` | [`[String!]!`](#string) | List of external IDs of vulnerability identifiers. |
|
|
| <a id="projectsecuritytrainingurlslanguage"></a>`language` | [`String`](#string) | Desired language for training urls. |
|
|
|
|
##### `Project.sentryDetailedError`
|
|
|
|
Detailed version of a Sentry error on the project.
|
|
|
|
Returns [`SentryDetailedError`](#sentrydetailederror).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectsentrydetailederrorid"></a>`id` | [`GitlabErrorTrackingDetailedErrorID!`](#gitlaberrortrackingdetailederrorid) | ID of the Sentry issue. |
|
|
|
|
##### `Project.services`
|
|
|
|
Project services.
|
|
|
|
Returns [`ServiceConnection`](#serviceconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectservicesactive"></a>`active` | [`Boolean`](#boolean) | Indicates if the integration is active. |
|
|
| <a id="projectservicestype"></a>`type` | [`ServiceType`](#servicetype) | Type of integration. |
|
|
|
|
##### `Project.snippets`
|
|
|
|
Snippets of the project.
|
|
|
|
Returns [`SnippetConnection`](#snippetconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectsnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. |
|
|
| <a id="projectsnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. |
|
|
|
|
##### `Project.terraformState`
|
|
|
|
Find a single Terraform state by name.
|
|
|
|
Returns [`TerraformState`](#terraformstate).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectterraformstatename"></a>`name` | [`String!`](#string) | Name of the Terraform state. |
|
|
|
|
##### `Project.timelogs`
|
|
|
|
Time logged on issues and merge requests in the project.
|
|
|
|
Returns [`TimelogConnection`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projecttimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="projecttimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="projecttimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="projecttimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="projecttimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="projecttimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="projecttimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
##### `Project.vulnerabilities`
|
|
|
|
Vulnerabilities reported on the project.
|
|
|
|
Returns [`VulnerabilityConnection`](#vulnerabilityconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectvulnerabilitiesclusteragentid"></a>`clusterAgentId` | [`[ClustersAgentID!]`](#clustersagentid) | Filter vulnerabilities by `cluster_agent_id`. Vulnerabilities with a `reportType` of `cluster_image_scanning` are only included with this filter. |
|
|
| <a id="projectvulnerabilitiesclusterid"></a>`clusterId` | [`[ClustersClusterID!]`](#clustersclusterid) | Filter vulnerabilities by `cluster_id`. Vulnerabilities with a `reportType` of `cluster_image_scanning` are only included with this filter. |
|
|
| <a id="projectvulnerabilitieshasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have linked issues. |
|
|
| <a id="projectvulnerabilitieshasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Returns only the vulnerabilities which have been resolved on default branch. |
|
|
| <a id="projectvulnerabilitiesimage"></a>`image` | [`[String!]`](#string) | Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a `reportType` that includes `container_scanning`, `cluster_image_scanning`. |
|
|
| <a id="projectvulnerabilitiesprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. |
|
|
| <a id="projectvulnerabilitiesreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. |
|
|
| <a id="projectvulnerabilitiesscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by VulnerabilityScanner.externalId. |
|
|
| <a id="projectvulnerabilitiesscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. |
|
|
| <a id="projectvulnerabilitiesseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. |
|
|
| <a id="projectvulnerabilitiessort"></a>`sort` | [`VulnerabilitySort`](#vulnerabilitysort) | List vulnerabilities by sort order. |
|
|
| <a id="projectvulnerabilitiesstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. |
|
|
|
|
##### `Project.vulnerabilitiesCountByDay`
|
|
|
|
The historical number of vulnerabilities per day for the project.
|
|
|
|
Returns [`VulnerabilitiesCountByDayConnection`](#vulnerabilitiescountbydayconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectvulnerabilitiescountbydayenddate"></a>`endDate` | [`ISO8601Date!`](#iso8601date) | Last day for which to fetch vulnerability history. |
|
|
| <a id="projectvulnerabilitiescountbydaystartdate"></a>`startDate` | [`ISO8601Date!`](#iso8601date) | First day for which to fetch vulnerability history. |
|
|
|
|
##### `Project.vulnerabilitySeveritiesCount`
|
|
|
|
Counts for each vulnerability severity in the project.
|
|
|
|
Returns [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectvulnerabilityseveritiescounthasissues"></a>`hasIssues` | [`Boolean`](#boolean) | Filter vulnerabilities that do or do not have issues. |
|
|
| <a id="projectvulnerabilityseveritiescounthasresolution"></a>`hasResolution` | [`Boolean`](#boolean) | Filter vulnerabilities that do or do not have a resolution. |
|
|
| <a id="projectvulnerabilityseveritiescountprojectid"></a>`projectId` | [`[ID!]`](#id) | Filter vulnerabilities by project. |
|
|
| <a id="projectvulnerabilityseveritiescountreporttype"></a>`reportType` | [`[VulnerabilityReportType!]`](#vulnerabilityreporttype) | Filter vulnerabilities by report type. |
|
|
| <a id="projectvulnerabilityseveritiescountscanner"></a>`scanner` | [`[String!]`](#string) | Filter vulnerabilities by scanner. |
|
|
| <a id="projectvulnerabilityseveritiescountscannerid"></a>`scannerId` | [`[VulnerabilitiesScannerID!]`](#vulnerabilitiesscannerid) | Filter vulnerabilities by scanner ID. |
|
|
| <a id="projectvulnerabilityseveritiescountseverity"></a>`severity` | [`[VulnerabilitySeverity!]`](#vulnerabilityseverity) | Filter vulnerabilities by severity. |
|
|
| <a id="projectvulnerabilityseveritiescountstate"></a>`state` | [`[VulnerabilityState!]`](#vulnerabilitystate) | Filter vulnerabilities by state. |
|
|
|
|
##### `Project.workItemTypes`
|
|
|
|
Work item types available to the project. Returns `null` if `work_items` feature flag is disabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice.
|
|
|
|
Returns [`WorkItemTypeConnection`](#workitemtypeconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectworkitemtypestaskable"></a>`taskable` | [`Boolean`](#boolean) | If `true`, only taskable work item types will be returned. Argument is experimental and can be removed in the future without notice. |
|
|
|
|
### `ProjectCiCdSetting`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectcicdsettingjobtokenscopeenabled"></a>`jobTokenScopeEnabled` | [`Boolean`](#boolean) | Indicates CI job tokens generated in this project have restricted access to resources. |
|
|
| <a id="projectcicdsettingkeeplatestartifact"></a>`keepLatestArtifact` | [`Boolean`](#boolean) | Whether to keep the latest builds artifacts. |
|
|
| <a id="projectcicdsettingmergepipelinesenabled"></a>`mergePipelinesEnabled` | [`Boolean`](#boolean) | Whether merge pipelines are enabled. |
|
|
| <a id="projectcicdsettingmergetrainsenabled"></a>`mergeTrainsEnabled` | [`Boolean`](#boolean) | Whether merge trains are enabled. |
|
|
| <a id="projectcicdsettingproject"></a>`project` | [`Project`](#project) | Project the CI/CD settings belong to. |
|
|
|
|
### `ProjectMember`
|
|
|
|
Represents a Project Membership.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectmemberaccesslevel"></a>`accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. |
|
|
| <a id="projectmembercreatedat"></a>`createdAt` | [`Time`](#time) | Date and time the membership was created. |
|
|
| <a id="projectmembercreatedby"></a>`createdBy` | [`UserCore`](#usercore) | User that authorized membership. |
|
|
| <a id="projectmemberexpiresat"></a>`expiresAt` | [`Time`](#time) | Date and time the membership expires. |
|
|
| <a id="projectmemberid"></a>`id` | [`ID!`](#id) | ID of the member. |
|
|
| <a id="projectmemberproject"></a>`project` | [`Project`](#project) | Project that User is a member of. |
|
|
| <a id="projectmemberupdatedat"></a>`updatedAt` | [`Time`](#time) | Date and time the membership was last updated. |
|
|
| <a id="projectmemberuser"></a>`user` | [`UserCore`](#usercore) | User that is associated with the member object. |
|
|
| <a id="projectmemberuserpermissions"></a>`userPermissions` | [`ProjectPermissions!`](#projectpermissions) | Permissions for the current user on the resource. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `ProjectMember.mergeRequestInteraction`
|
|
|
|
Find a merge request.
|
|
|
|
Returns [`UserMergeRequestInteraction`](#usermergerequestinteraction).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectmembermergerequestinteractionid"></a>`id` | [`MergeRequestID!`](#mergerequestid) | Global ID of the merge request. |
|
|
|
|
### `ProjectPermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectpermissionsadminoperations"></a>`adminOperations` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_operations` on this resource. |
|
|
| <a id="projectpermissionsadminpathlocks"></a>`adminPathLocks` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_path_locks` on this resource. |
|
|
| <a id="projectpermissionsadminproject"></a>`adminProject` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_project` on this resource. |
|
|
| <a id="projectpermissionsadminremotemirror"></a>`adminRemoteMirror` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_remote_mirror` on this resource. |
|
|
| <a id="projectpermissionsadminwiki"></a>`adminWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_wiki` on this resource. |
|
|
| <a id="projectpermissionsarchiveproject"></a>`archiveProject` | [`Boolean!`](#boolean) | Indicates the user can perform `archive_project` on this resource. |
|
|
| <a id="projectpermissionschangenamespace"></a>`changeNamespace` | [`Boolean!`](#boolean) | Indicates the user can perform `change_namespace` on this resource. |
|
|
| <a id="projectpermissionschangevisibilitylevel"></a>`changeVisibilityLevel` | [`Boolean!`](#boolean) | Indicates the user can perform `change_visibility_level` on this resource. |
|
|
| <a id="projectpermissionscreatedeployment"></a>`createDeployment` | [`Boolean!`](#boolean) | Indicates the user can perform `create_deployment` on this resource. |
|
|
| <a id="projectpermissionscreatedesign"></a>`createDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `create_design` on this resource. |
|
|
| <a id="projectpermissionscreateissue"></a>`createIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `create_issue` on this resource. |
|
|
| <a id="projectpermissionscreatelabel"></a>`createLabel` | [`Boolean!`](#boolean) | Indicates the user can perform `create_label` on this resource. |
|
|
| <a id="projectpermissionscreatemergerequestfrom"></a>`createMergeRequestFrom` | [`Boolean!`](#boolean) | Indicates the user can perform `create_merge_request_from` on this resource. |
|
|
| <a id="projectpermissionscreatemergerequestin"></a>`createMergeRequestIn` | [`Boolean!`](#boolean) | Indicates the user can perform `create_merge_request_in` on this resource. |
|
|
| <a id="projectpermissionscreatepages"></a>`createPages` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pages` on this resource. |
|
|
| <a id="projectpermissionscreatepipeline"></a>`createPipeline` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pipeline` on this resource. |
|
|
| <a id="projectpermissionscreatepipelineschedule"></a>`createPipelineSchedule` | [`Boolean!`](#boolean) | Indicates the user can perform `create_pipeline_schedule` on this resource. |
|
|
| <a id="projectpermissionscreatesnippet"></a>`createSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `create_snippet` on this resource. |
|
|
| <a id="projectpermissionscreatewiki"></a>`createWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `create_wiki` on this resource. |
|
|
| <a id="projectpermissionsdestroydesign"></a>`destroyDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_design` on this resource. |
|
|
| <a id="projectpermissionsdestroypages"></a>`destroyPages` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_pages` on this resource. |
|
|
| <a id="projectpermissionsdestroywiki"></a>`destroyWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_wiki` on this resource. |
|
|
| <a id="projectpermissionsdownloadcode"></a>`downloadCode` | [`Boolean!`](#boolean) | Indicates the user can perform `download_code` on this resource. |
|
|
| <a id="projectpermissionsdownloadwikicode"></a>`downloadWikiCode` | [`Boolean!`](#boolean) | Indicates the user can perform `download_wiki_code` on this resource. |
|
|
| <a id="projectpermissionsforkproject"></a>`forkProject` | [`Boolean!`](#boolean) | Indicates the user can perform `fork_project` on this resource. |
|
|
| <a id="projectpermissionspushcode"></a>`pushCode` | [`Boolean!`](#boolean) | Indicates the user can perform `push_code` on this resource. |
|
|
| <a id="projectpermissionspushtodeleteprotectedbranch"></a>`pushToDeleteProtectedBranch` | [`Boolean!`](#boolean) | Indicates the user can perform `push_to_delete_protected_branch` on this resource. |
|
|
| <a id="projectpermissionsreadcommitstatus"></a>`readCommitStatus` | [`Boolean!`](#boolean) | Indicates the user can perform `read_commit_status` on this resource. |
|
|
| <a id="projectpermissionsreadcycleanalytics"></a>`readCycleAnalytics` | [`Boolean!`](#boolean) | Indicates the user can perform `read_cycle_analytics` on this resource. |
|
|
| <a id="projectpermissionsreaddesign"></a>`readDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `read_design` on this resource. |
|
|
| <a id="projectpermissionsreadmergerequest"></a>`readMergeRequest` | [`Boolean!`](#boolean) | Indicates the user can perform `read_merge_request` on this resource. |
|
|
| <a id="projectpermissionsreadpagescontent"></a>`readPagesContent` | [`Boolean!`](#boolean) | Indicates the user can perform `read_pages_content` on this resource. |
|
|
| <a id="projectpermissionsreadproject"></a>`readProject` | [`Boolean!`](#boolean) | Indicates the user can perform `read_project` on this resource. |
|
|
| <a id="projectpermissionsreadprojectmember"></a>`readProjectMember` | [`Boolean!`](#boolean) | Indicates the user can perform `read_project_member` on this resource. |
|
|
| <a id="projectpermissionsreadwiki"></a>`readWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `read_wiki` on this resource. |
|
|
| <a id="projectpermissionsremoveforkproject"></a>`removeForkProject` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_fork_project` on this resource. |
|
|
| <a id="projectpermissionsremovepages"></a>`removePages` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_pages` on this resource. |
|
|
| <a id="projectpermissionsremoveproject"></a>`removeProject` | [`Boolean!`](#boolean) | Indicates the user can perform `remove_project` on this resource. |
|
|
| <a id="projectpermissionsrenameproject"></a>`renameProject` | [`Boolean!`](#boolean) | Indicates the user can perform `rename_project` on this resource. |
|
|
| <a id="projectpermissionsrequestaccess"></a>`requestAccess` | [`Boolean!`](#boolean) | Indicates the user can perform `request_access` on this resource. |
|
|
| <a id="projectpermissionsupdatepages"></a>`updatePages` | [`Boolean!`](#boolean) | Indicates the user can perform `update_pages` on this resource. |
|
|
| <a id="projectpermissionsupdatewiki"></a>`updateWiki` | [`Boolean!`](#boolean) | Indicates the user can perform `update_wiki` on this resource. |
|
|
| <a id="projectpermissionsuploadfile"></a>`uploadFile` | [`Boolean!`](#boolean) | Indicates the user can perform `upload_file` on this resource. |
|
|
|
|
### `ProjectSecurityPolicySource`
|
|
|
|
Represents the source of a security policy belonging to a project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectsecuritypolicysourceproject"></a>`project` | [`Project`](#project) | Project the policy is associated with. |
|
|
|
|
### `ProjectSecurityTraining`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectsecuritytrainingdescription"></a>`description` | [`String`](#string) | Description of the training provider. |
|
|
| <a id="projectsecuritytrainingid"></a>`id` | [`GlobalID!`](#globalid) | ID of the training provider. |
|
|
| <a id="projectsecuritytrainingisenabled"></a>`isEnabled` | [`Boolean!`](#boolean) | Represents whether the provider is enabled or not. |
|
|
| <a id="projectsecuritytrainingisprimary"></a>`isPrimary` | [`Boolean!`](#boolean) | Represents whether the provider is set as primary or not. |
|
|
| <a id="projectsecuritytraininglogourl"></a>`logoUrl` | [`String`](#string) | Logo URL of the provider. |
|
|
| <a id="projectsecuritytrainingname"></a>`name` | [`String!`](#string) | Name of the training provider. |
|
|
| <a id="projectsecuritytrainingurl"></a>`url` | [`String!`](#string) | URL of the provider. |
|
|
|
|
### `ProjectStatistics`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="projectstatisticsbuildartifactssize"></a>`buildArtifactsSize` | [`Float!`](#float) | Build artifacts size of the project in bytes. |
|
|
| <a id="projectstatisticscommitcount"></a>`commitCount` | [`Float!`](#float) | Commit count of the project. |
|
|
| <a id="projectstatisticscontainerregistrysize"></a>`containerRegistrySize` | [`Float`](#float) | Container Registry size of the project in bytes. |
|
|
| <a id="projectstatisticslfsobjectssize"></a>`lfsObjectsSize` | [`Float!`](#float) | Large File Storage (LFS) object size of the project in bytes. |
|
|
| <a id="projectstatisticspackagessize"></a>`packagesSize` | [`Float!`](#float) | Packages size of the project in bytes. |
|
|
| <a id="projectstatisticspipelineartifactssize"></a>`pipelineArtifactsSize` | [`Float`](#float) | CI Pipeline artifacts size in bytes. |
|
|
| <a id="projectstatisticsrepositorysize"></a>`repositorySize` | [`Float!`](#float) | Repository size of the project in bytes. |
|
|
| <a id="projectstatisticssnippetssize"></a>`snippetsSize` | [`Float`](#float) | Snippets size of the project in bytes. |
|
|
| <a id="projectstatisticsstoragesize"></a>`storageSize` | [`Float!`](#float) | Storage size of the project in bytes. |
|
|
| <a id="projectstatisticsuploadssize"></a>`uploadsSize` | [`Float`](#float) | Uploads size of the project in bytes. |
|
|
| <a id="projectstatisticswikisize"></a>`wikiSize` | [`Float`](#float) | Wiki size of the project in bytes. |
|
|
|
|
### `PrometheusAlert`
|
|
|
|
The alert condition for Prometheus.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="prometheusalerthumanizedtext"></a>`humanizedText` | [`String!`](#string) | Human-readable text of the alert condition. |
|
|
| <a id="prometheusalertid"></a>`id` | [`ID!`](#id) | ID of the alert condition. |
|
|
|
|
### `PushRules`
|
|
|
|
Represents rules that commit pushes must follow.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pushrulesrejectunsignedcommits"></a>`rejectUnsignedCommits` | [`Boolean!`](#boolean) | Indicates whether commits not signed through GPG will be rejected. |
|
|
|
|
### `PypiMetadata`
|
|
|
|
Pypi metadata.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="pypimetadataid"></a>`id` | [`PackagesPypiMetadatumID!`](#packagespypimetadatumid) | ID of the metadatum. |
|
|
| <a id="pypimetadatarequiredpython"></a>`requiredPython` | [`String`](#string) | Required Python version of the Pypi package. |
|
|
|
|
### `QueryComplexity`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="querycomplexitylimit"></a>`limit` | [`Int`](#int) | GraphQL query complexity limit. See [GitLab documentation on this limit](https://docs.gitlab.com/ee/api/graphql/index.html#max-query-complexity). |
|
|
| <a id="querycomplexityscore"></a>`score` | [`Int`](#int) | GraphQL query complexity score. |
|
|
|
|
### `RecentFailures`
|
|
|
|
Recent failure history of a test case.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="recentfailuresbasebranch"></a>`baseBranch` | [`String`](#string) | Name of the base branch of the project. |
|
|
| <a id="recentfailurescount"></a>`count` | [`Int`](#int) | Number of times the test case has failed in the past 14 days. |
|
|
|
|
### `Release`
|
|
|
|
Represents a release.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseassets"></a>`assets` | [`ReleaseAssets`](#releaseassets) | Assets of the release. |
|
|
| <a id="releaseauthor"></a>`author` | [`UserCore`](#usercore) | User that created the release. |
|
|
| <a id="releasecommit"></a>`commit` | [`Commit`](#commit) | Commit associated with the release. |
|
|
| <a id="releasecreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the release was created. |
|
|
| <a id="releasedescription"></a>`description` | [`String`](#string) | Description (also known as "release notes") of the release. |
|
|
| <a id="releasedescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="releaseevidences"></a>`evidences` | [`ReleaseEvidenceConnection`](#releaseevidenceconnection) | Evidence for the release. (see [Connections](#connections)) |
|
|
| <a id="releaseid"></a>`id` | [`ReleaseID!`](#releaseid) | Global ID of the release. |
|
|
| <a id="releaselinks"></a>`links` | [`ReleaseLinks`](#releaselinks) | Links of the release. |
|
|
| <a id="releasemilestones"></a>`milestones` | [`MilestoneConnection`](#milestoneconnection) | Milestones associated to the release. (see [Connections](#connections)) |
|
|
| <a id="releasename"></a>`name` | [`String`](#string) | Name of the release. |
|
|
| <a id="releasereleasedat"></a>`releasedAt` | [`Time`](#time) | Timestamp of when the release was released. |
|
|
| <a id="releasetagname"></a>`tagName` | [`String`](#string) | Name of the tag associated with the release. |
|
|
| <a id="releasetagpath"></a>`tagPath` | [`String`](#string) | Relative web path to the tag associated with the release. |
|
|
| <a id="releaseupcomingrelease"></a>`upcomingRelease` | [`Boolean`](#boolean) | Indicates the release is an upcoming release. |
|
|
|
|
### `ReleaseAssetLink`
|
|
|
|
Represents an asset link associated with a release.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseassetlinkdirectassetpath"></a>`directAssetPath` | [`String`](#string) | Relative path for the direct asset link. |
|
|
| <a id="releaseassetlinkdirectasseturl"></a>`directAssetUrl` | [`String`](#string) | Direct asset URL of the link. |
|
|
| <a id="releaseassetlinkexternal"></a>`external` | [`Boolean`](#boolean) | Indicates the link points to an external resource. |
|
|
| <a id="releaseassetlinkid"></a>`id` | [`ID!`](#id) | ID of the link. |
|
|
| <a id="releaseassetlinklinktype"></a>`linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`. |
|
|
| <a id="releaseassetlinkname"></a>`name` | [`String`](#string) | Name of the link. |
|
|
| <a id="releaseassetlinkurl"></a>`url` | [`String`](#string) | URL of the link. |
|
|
|
|
### `ReleaseAssets`
|
|
|
|
A container for all assets associated with a release.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseassetscount"></a>`count` | [`Int`](#int) | Number of assets of the release. |
|
|
| <a id="releaseassetslinks"></a>`links` | [`ReleaseAssetLinkConnection`](#releaseassetlinkconnection) | Asset links of the release. (see [Connections](#connections)) |
|
|
| <a id="releaseassetssources"></a>`sources` | [`ReleaseSourceConnection`](#releasesourceconnection) | Sources of the release. (see [Connections](#connections)) |
|
|
|
|
### `ReleaseEvidence`
|
|
|
|
Evidence for a release.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseevidencecollectedat"></a>`collectedAt` | [`Time`](#time) | Timestamp when the evidence was collected. |
|
|
| <a id="releaseevidencefilepath"></a>`filepath` | [`String`](#string) | URL from where the evidence can be downloaded. |
|
|
| <a id="releaseevidenceid"></a>`id` | [`ID!`](#id) | ID of the evidence. |
|
|
| <a id="releaseevidencesha"></a>`sha` | [`String`](#string) | SHA1 ID of the evidence hash. |
|
|
|
|
### `ReleaseLinks`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaselinksclosedissuesurl"></a>`closedIssuesUrl` | [`String`](#string) | HTTP URL of the issues page, filtered by this release and `state=closed`. |
|
|
| <a id="releaselinksclosedmergerequestsurl"></a>`closedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page , filtered by this release and `state=closed`. |
|
|
| <a id="releaselinksediturl"></a>`editUrl` | [`String`](#string) | HTTP URL of the release's edit page. |
|
|
| <a id="releaselinksmergedmergerequestsurl"></a>`mergedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page , filtered by this release and `state=merged`. |
|
|
| <a id="releaselinksopenedissuesurl"></a>`openedIssuesUrl` | [`String`](#string) | HTTP URL of the issues page, filtered by this release and `state=open`. |
|
|
| <a id="releaselinksopenedmergerequestsurl"></a>`openedMergeRequestsUrl` | [`String`](#string) | HTTP URL of the merge request page, filtered by this release and `state=open`. |
|
|
| <a id="releaselinksselfurl"></a>`selfUrl` | [`String`](#string) | HTTP URL of the release. |
|
|
|
|
### `ReleaseSource`
|
|
|
|
Represents the source code attached to a release in a particular format.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releasesourceformat"></a>`format` | [`String`](#string) | Format of the source. |
|
|
| <a id="releasesourceurl"></a>`url` | [`String`](#string) | Download URL of the source. |
|
|
|
|
### `Repository`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="repositorydiskpath"></a>`diskPath` | [`String`](#string) | Shows a disk path of the repository. |
|
|
| <a id="repositoryempty"></a>`empty` | [`Boolean!`](#boolean) | Indicates repository has no visible content. |
|
|
| <a id="repositoryexists"></a>`exists` | [`Boolean!`](#boolean) | Indicates a corresponding Git repository exists on disk. |
|
|
| <a id="repositoryrootref"></a>`rootRef` | [`String`](#string) | Default branch of the repository. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Repository.blobs`
|
|
|
|
Blobs contained within the repository.
|
|
|
|
Returns [`RepositoryBlobConnection`](#repositoryblobconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="repositoryblobspaths"></a>`paths` | [`[String!]!`](#string) | Array of desired blob paths. |
|
|
| <a id="repositoryblobsref"></a>`ref` | [`String`](#string) | Commit ref to get the blobs from. Default value is HEAD. |
|
|
|
|
##### `Repository.branchNames`
|
|
|
|
Names of branches available in this repository that match the search pattern.
|
|
|
|
Returns [`[String!]`](#string).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="repositorybranchnameslimit"></a>`limit` | [`Int!`](#int) | Number of branch names to return. |
|
|
| <a id="repositorybranchnamesoffset"></a>`offset` | [`Int!`](#int) | Number of branch names to skip. |
|
|
| <a id="repositorybranchnamessearchpattern"></a>`searchPattern` | [`String!`](#string) | Pattern to search for branch names by. |
|
|
|
|
##### `Repository.paginatedTree`
|
|
|
|
Paginated tree of the repository.
|
|
|
|
Returns [`TreeConnection`](#treeconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="repositorypaginatedtreepath"></a>`path` | [`String`](#string) | Path to get the tree for. Default value is the root of the repository. |
|
|
| <a id="repositorypaginatedtreerecursive"></a>`recursive` | [`Boolean`](#boolean) | Used to get a recursive tree. Default is false. |
|
|
| <a id="repositorypaginatedtreeref"></a>`ref` | [`String`](#string) | Commit ref to get the tree for. Default value is HEAD. |
|
|
|
|
##### `Repository.tree`
|
|
|
|
Tree of the repository.
|
|
|
|
Returns [`Tree`](#tree).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="repositorytreepath"></a>`path` | [`String`](#string) | Path to get the tree for. Default value is the root of the repository. |
|
|
| <a id="repositorytreerecursive"></a>`recursive` | [`Boolean`](#boolean) | Used to get a recursive tree. Default is false. |
|
|
| <a id="repositorytreeref"></a>`ref` | [`String`](#string) | Commit ref to get the tree for. Default value is HEAD. |
|
|
|
|
### `RepositoryBlob`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="repositoryblobarchived"></a>`archived` | [`Boolean`](#boolean) | Whether the current project is archived. |
|
|
| <a id="repositoryblobblamepath"></a>`blamePath` | [`String`](#string) | Web path to blob blame page. |
|
|
| <a id="repositoryblobcancurrentuserpushtobranch"></a>`canCurrentUserPushToBranch` | [`Boolean`](#boolean) | Whether the current user can push to the branch. |
|
|
| <a id="repositoryblobcanmodifyblob"></a>`canModifyBlob` | [`Boolean`](#boolean) | Whether the current user can modify the blob. |
|
|
| <a id="repositoryblobcodenavigationpath"></a>`codeNavigationPath` | [`String`](#string) | Web path for code navigation. |
|
|
| <a id="repositoryblobcodeowners"></a>`codeOwners` | [`[UserCore!]`](#usercore) | List of code owners for the blob. |
|
|
| <a id="repositoryblobeditblobpath"></a>`editBlobPath` | [`String`](#string) | Web path to edit the blob in the old-style editor. |
|
|
| <a id="repositoryblobenvironmentexternalurlforroutemap"></a>`environmentExternalUrlForRouteMap` | [`String`](#string) | Web path to blob on an environment. |
|
|
| <a id="repositoryblobenvironmentformattedexternalurl"></a>`environmentFormattedExternalUrl` | [`String`](#string) | Environment on which the blob is available. |
|
|
| <a id="repositoryblobexternalstorage"></a>`externalStorage` | [`String`](#string) | External storage being used, if enabled (for instance, 'LFS'). |
|
|
| <a id="repositoryblobexternalstorageurl"></a>`externalStorageUrl` | [`String`](#string) | Web path to download the raw blob via external storage, if enabled. |
|
|
| <a id="repositoryblobfiletype"></a>`fileType` | [`String`](#string) | Expected format of the blob based on the extension. |
|
|
| <a id="repositoryblobfindfilepath"></a>`findFilePath` | [`String`](#string) | Web path to find file. |
|
|
| <a id="repositoryblobforkandeditpath"></a>`forkAndEditPath` | [`String`](#string) | Web path to edit this blob using a forked project. |
|
|
| <a id="repositoryblobforkandviewpath"></a>`forkAndViewPath` | [`String`](#string) | Web path to view this blob using a forked project. |
|
|
| <a id="repositoryblobgitpodbloburl"></a>`gitpodBlobUrl` | [`String`](#string) | URL to the blob within Gitpod. |
|
|
| <a id="repositoryblobhistorypath"></a>`historyPath` | [`String`](#string) | Web path to blob history page. |
|
|
| <a id="repositoryblobid"></a>`id` | [`ID!`](#id) | ID of the blob. |
|
|
| <a id="repositoryblobideeditpath"></a>`ideEditPath` | [`String`](#string) | Web path to edit this blob in the Web IDE. |
|
|
| <a id="repositoryblobideforkandeditpath"></a>`ideForkAndEditPath` | [`String`](#string) | Web path to edit this blob in the Web IDE using a forked project. |
|
|
| <a id="repositorybloblanguage"></a>`language` | [`String`](#string) | Blob language. |
|
|
| <a id="repositorybloblfsoid"></a>`lfsOid` | [`String`](#string) | LFS OID of the blob. |
|
|
| <a id="repositoryblobmode"></a>`mode` | [`String`](#string) | Blob mode. |
|
|
| <a id="repositoryblobname"></a>`name` | [`String`](#string) | Blob name. |
|
|
| <a id="repositorybloboid"></a>`oid` | [`String!`](#string) | OID of the blob. |
|
|
| <a id="repositoryblobpath"></a>`path` | [`String!`](#string) | Path of the blob. |
|
|
| <a id="repositoryblobpermalinkpath"></a>`permalinkPath` | [`String`](#string) | Web path to blob permalink. |
|
|
| <a id="repositoryblobpipelineeditorpath"></a>`pipelineEditorPath` | [`String`](#string) | Web path to edit .gitlab-ci.yml file. |
|
|
| <a id="repositoryblobplaindata"></a>`plainData` | [`String`](#string) | Blob plain highlighted data. |
|
|
| <a id="repositoryblobprojectblobpathroot"></a>`projectBlobPathRoot` | [`String`](#string) | Web path for the root of the blob. |
|
|
| <a id="repositoryblobrawblob"></a>`rawBlob` | [`String`](#string) | Raw content of the blob. |
|
|
| <a id="repositoryblobrawpath"></a>`rawPath` | [`String`](#string) | Web path to download the raw blob. |
|
|
| <a id="repositoryblobrawsize"></a>`rawSize` | [`Int`](#int) | Size (in bytes) of the blob, or the blob target if stored externally. |
|
|
| <a id="repositoryblobrawtextblob"></a>`rawTextBlob` | [`String`](#string) | Raw content of the blob, if the blob is text data. |
|
|
| <a id="repositoryblobreplacepath"></a>`replacePath` | [`String`](#string) | Web path to replace the blob content. |
|
|
| <a id="repositoryblobrichviewer"></a>`richViewer` | [`BlobViewer`](#blobviewer) | Blob content rich viewer. |
|
|
| <a id="repositoryblobsimpleviewer"></a>`simpleViewer` | [`BlobViewer!`](#blobviewer) | Blob content simple viewer. |
|
|
| <a id="repositoryblobsize"></a>`size` | [`Int`](#int) | Size (in bytes) of the blob. |
|
|
| <a id="repositoryblobstoredexternally"></a>`storedExternally` | [`Boolean`](#boolean) | Whether the blob's content is stored externally (for instance, in LFS). |
|
|
| <a id="repositoryblobwebpath"></a>`webPath` | [`String`](#string) | Web path of the blob. |
|
|
|
|
### `Requirement`
|
|
|
|
Represents a requirement.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="requirementauthor"></a>`author` | [`UserCore!`](#usercore) | Author of the requirement. |
|
|
| <a id="requirementcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the requirement was created. |
|
|
| <a id="requirementdescription"></a>`description` | [`String`](#string) | Description of the requirement. |
|
|
| <a id="requirementdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="requirementid"></a>`id` | [`ID!`](#id) | ID of the requirement. |
|
|
| <a id="requirementiid"></a>`iid` | [`ID!`](#id) | Internal ID of the requirement. |
|
|
| <a id="requirementlasttestreportmanuallycreated"></a>`lastTestReportManuallyCreated` | [`Boolean`](#boolean) | Indicates if latest test report was created by user. |
|
|
| <a id="requirementlasttestreportstate"></a>`lastTestReportState` | [`TestReportState`](#testreportstate) | Latest requirement test report state. |
|
|
| <a id="requirementproject"></a>`project` | [`Project!`](#project) | Project to which the requirement belongs. |
|
|
| <a id="requirementstate"></a>`state` | [`RequirementState!`](#requirementstate) | State of the requirement. |
|
|
| <a id="requirementtitle"></a>`title` | [`String`](#string) | Title of the requirement. |
|
|
| <a id="requirementtitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. |
|
|
| <a id="requirementupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the requirement was last updated. |
|
|
| <a id="requirementuserpermissions"></a>`userPermissions` | [`RequirementPermissions!`](#requirementpermissions) | Permissions for the current user on the resource. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Requirement.testReports`
|
|
|
|
Test reports of the requirement.
|
|
|
|
Returns [`TestReportConnection`](#testreportconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="requirementtestreportssort"></a>`sort` | [`Sort`](#sort) | List test reports by sort order. |
|
|
|
|
### `RequirementPermissions`
|
|
|
|
Check permissions for the current user on a requirement.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="requirementpermissionsadminrequirement"></a>`adminRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_requirement` on this resource. |
|
|
| <a id="requirementpermissionscreaterequirement"></a>`createRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `create_requirement` on this resource. |
|
|
| <a id="requirementpermissionsdestroyrequirement"></a>`destroyRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_requirement` on this resource. |
|
|
| <a id="requirementpermissionsreadrequirement"></a>`readRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `read_requirement` on this resource. |
|
|
| <a id="requirementpermissionsupdaterequirement"></a>`updateRequirement` | [`Boolean!`](#boolean) | Indicates the user can perform `update_requirement` on this resource. |
|
|
|
|
### `RequirementStatesCount`
|
|
|
|
Counts of requirements by their state.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="requirementstatescountarchived"></a>`archived` | [`Int`](#int) | Number of archived requirements. |
|
|
| <a id="requirementstatescountopened"></a>`opened` | [`Int`](#int) | Number of opened requirements. |
|
|
|
|
### `RootStorageStatistics`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="rootstoragestatisticsbuildartifactssize"></a>`buildArtifactsSize` | [`Float!`](#float) | CI artifacts size in bytes. |
|
|
| <a id="rootstoragestatisticscontainerregistrysize"></a>`containerRegistrySize` | [`Float!`](#float) | Container Registry size in bytes. |
|
|
| <a id="rootstoragestatisticsdependencyproxysize"></a>`dependencyProxySize` | [`Float!`](#float) | Dependency Proxy sizes in bytes. |
|
|
| <a id="rootstoragestatisticslfsobjectssize"></a>`lfsObjectsSize` | [`Float!`](#float) | LFS objects size in bytes. |
|
|
| <a id="rootstoragestatisticspackagessize"></a>`packagesSize` | [`Float!`](#float) | Packages size in bytes. |
|
|
| <a id="rootstoragestatisticspipelineartifactssize"></a>`pipelineArtifactsSize` | [`Float!`](#float) | CI pipeline artifacts size in bytes. |
|
|
| <a id="rootstoragestatisticsrepositorysize"></a>`repositorySize` | [`Float!`](#float) | Git repository size in bytes. |
|
|
| <a id="rootstoragestatisticssnippetssize"></a>`snippetsSize` | [`Float!`](#float) | Snippets size in bytes. |
|
|
| <a id="rootstoragestatisticsstoragesize"></a>`storageSize` | [`Float!`](#float) | Total storage in bytes. |
|
|
| <a id="rootstoragestatisticsuploadssize"></a>`uploadsSize` | [`Float!`](#float) | Uploads size in bytes. |
|
|
| <a id="rootstoragestatisticswikisize"></a>`wikiSize` | [`Float!`](#float) | Wiki size in bytes. |
|
|
|
|
### `RunnerArchitecture`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="runnerarchitecturedownloadlocation"></a>`downloadLocation` | [`String!`](#string) | Download location for the runner for the platform architecture. |
|
|
| <a id="runnerarchitecturename"></a>`name` | [`String!`](#string) | Name of the runner platform architecture. |
|
|
|
|
### `RunnerPermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="runnerpermissionsdeleterunner"></a>`deleteRunner` | [`Boolean!`](#boolean) | Indicates the user can perform `delete_runner` on this resource. |
|
|
| <a id="runnerpermissionsreadrunner"></a>`readRunner` | [`Boolean!`](#boolean) | Indicates the user can perform `read_runner` on this resource. |
|
|
| <a id="runnerpermissionsupdaterunner"></a>`updateRunner` | [`Boolean!`](#boolean) | Indicates the user can perform `update_runner` on this resource. |
|
|
|
|
### `RunnerPlatform`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="runnerplatformarchitectures"></a>`architectures` | [`RunnerArchitectureConnection`](#runnerarchitectureconnection) | Runner architectures supported for the platform. (see [Connections](#connections)) |
|
|
| <a id="runnerplatformhumanreadablename"></a>`humanReadableName` | [`String!`](#string) | Human readable name of the runner platform. |
|
|
| <a id="runnerplatformname"></a>`name` | [`String!`](#string) | Name slug of the runner platform. |
|
|
|
|
### `RunnerSetup`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="runnersetupinstallinstructions"></a>`installInstructions` | [`String!`](#string) | Instructions for installing the runner on the specified architecture. |
|
|
| <a id="runnersetupregisterinstructions"></a>`registerInstructions` | [`String`](#string) | Instructions for registering the runner. The actual registration tokens are not included in the commands. Instead, a placeholder `$REGISTRATION_TOKEN` is shown. |
|
|
|
|
### `SastCiConfiguration`
|
|
|
|
Represents a CI configuration of SAST.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationanalyzers"></a>`analyzers` | [`SastCiConfigurationAnalyzersEntityConnection`](#sastciconfigurationanalyzersentityconnection) | List of analyzers entities attached to SAST configuration. (see [Connections](#connections)) |
|
|
| <a id="sastciconfigurationglobal"></a>`global` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of global entities related to SAST configuration. (see [Connections](#connections)) |
|
|
| <a id="sastciconfigurationpipeline"></a>`pipeline` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of pipeline entities related to SAST configuration. (see [Connections](#connections)) |
|
|
|
|
### `SastCiConfigurationAnalyzersEntity`
|
|
|
|
Represents an analyzer entity in SAST CI configuration.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationanalyzersentitydescription"></a>`description` | [`String`](#string) | Analyzer description that is displayed on the form. |
|
|
| <a id="sastciconfigurationanalyzersentityenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether an analyzer is enabled. |
|
|
| <a id="sastciconfigurationanalyzersentitylabel"></a>`label` | [`String`](#string) | Analyzer label used in the config UI. |
|
|
| <a id="sastciconfigurationanalyzersentityname"></a>`name` | [`String`](#string) | Name of the analyzer. |
|
|
| <a id="sastciconfigurationanalyzersentityvariables"></a>`variables` | [`SastCiConfigurationEntityConnection`](#sastciconfigurationentityconnection) | List of supported variables. (see [Connections](#connections)) |
|
|
|
|
### `SastCiConfigurationEntity`
|
|
|
|
Represents an entity in SAST CI configuration.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationentitydefaultvalue"></a>`defaultValue` | [`String`](#string) | Default value that is used if value is empty. |
|
|
| <a id="sastciconfigurationentitydescription"></a>`description` | [`String`](#string) | Entity description that is displayed on the form. |
|
|
| <a id="sastciconfigurationentityfield"></a>`field` | [`String`](#string) | CI keyword of entity. |
|
|
| <a id="sastciconfigurationentitylabel"></a>`label` | [`String`](#string) | Label for entity used in the form. |
|
|
| <a id="sastciconfigurationentityoptions"></a>`options` | [`SastCiConfigurationOptionsEntityConnection`](#sastciconfigurationoptionsentityconnection) | Different possible values of the field. (see [Connections](#connections)) |
|
|
| <a id="sastciconfigurationentitysize"></a>`size` | [`SastUiComponentSize`](#sastuicomponentsize) | Size of the UI component. |
|
|
| <a id="sastciconfigurationentitytype"></a>`type` | [`String`](#string) | Type of the field value. |
|
|
| <a id="sastciconfigurationentityvalue"></a>`value` | [`String`](#string) | Current value of the entity. |
|
|
|
|
### `SastCiConfigurationOptionsEntity`
|
|
|
|
Represents an entity for options in SAST CI configuration.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationoptionsentitylabel"></a>`label` | [`String`](#string) | Label of option entity. |
|
|
| <a id="sastciconfigurationoptionsentityvalue"></a>`value` | [`String`](#string) | Value of option entity. |
|
|
|
|
### `SavedReply`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="savedreplycontent"></a>`content` | [`String!`](#string) | Content of the saved reply. |
|
|
| <a id="savedreplyid"></a>`id` | [`UsersSavedReplyID!`](#userssavedreplyid) | Global ID of the saved reply. |
|
|
| <a id="savedreplyname"></a>`name` | [`String!`](#string) | Name of the saved reply. |
|
|
|
|
### `Scan`
|
|
|
|
Represents the security scan information.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanerrors"></a>`errors` | [`[String!]!`](#string) | List of errors. |
|
|
| <a id="scanname"></a>`name` | [`String!`](#string) | Name of the scan. |
|
|
| <a id="scanstatus"></a>`status` | [`ScanStatus!`](#scanstatus) | Indicates the status of the scan. |
|
|
| <a id="scanwarnings"></a>`warnings` | [`[String!]!`](#string) | List of warnings. |
|
|
|
|
### `ScanExecutionPolicy`
|
|
|
|
Represents the scan execution policy.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanexecutionpolicydescription"></a>`description` | [`String!`](#string) | Description of the policy. |
|
|
| <a id="scanexecutionpolicyenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether this policy is enabled. |
|
|
| <a id="scanexecutionpolicyname"></a>`name` | [`String!`](#string) | Name of the policy. |
|
|
| <a id="scanexecutionpolicysource"></a>`source` | [`SecurityPolicySource!`](#securitypolicysource) | Source of the policy. Its fields depend on the source type. |
|
|
| <a id="scanexecutionpolicyupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the policy YAML was last updated. |
|
|
| <a id="scanexecutionpolicyyaml"></a>`yaml` | [`String!`](#string) | YAML definition of the policy. |
|
|
|
|
### `ScanResultPolicy`
|
|
|
|
Represents the scan result policy.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scanresultpolicydescription"></a>`description` | [`String!`](#string) | Description of the policy. |
|
|
| <a id="scanresultpolicyenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether this policy is enabled. |
|
|
| <a id="scanresultpolicyname"></a>`name` | [`String!`](#string) | Name of the policy. |
|
|
| <a id="scanresultpolicyupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the policy YAML was last updated. |
|
|
| <a id="scanresultpolicyyaml"></a>`yaml` | [`String!`](#string) | YAML definition of the policy. |
|
|
|
|
### `ScannedResource`
|
|
|
|
Represents a resource scanned by a security scan.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="scannedresourcerequestmethod"></a>`requestMethod` | [`String`](#string) | HTTP request method used to access the URL. |
|
|
| <a id="scannedresourceurl"></a>`url` | [`String`](#string) | URL scanned by the scanner. |
|
|
|
|
### `SecurityReportSummary`
|
|
|
|
Represents summary of a security report.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="securityreportsummaryapifuzzing"></a>`apiFuzzing` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `api_fuzzing` scan. |
|
|
| <a id="securityreportsummaryclusterimagescanning"></a>`clusterImageScanning` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `cluster_image_scanning` scan. |
|
|
| <a id="securityreportsummarycontainerscanning"></a>`containerScanning` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `container_scanning` scan. |
|
|
| <a id="securityreportsummarycoveragefuzzing"></a>`coverageFuzzing` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `coverage_fuzzing` scan. |
|
|
| <a id="securityreportsummarydast"></a>`dast` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `dast` scan. |
|
|
| <a id="securityreportsummarydependencyscanning"></a>`dependencyScanning` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `dependency_scanning` scan. |
|
|
| <a id="securityreportsummarygeneric"></a>`generic` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `generic` scan. |
|
|
| <a id="securityreportsummarysast"></a>`sast` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `sast` scan. |
|
|
| <a id="securityreportsummarysecretdetection"></a>`secretDetection` | [`SecurityReportSummarySection`](#securityreportsummarysection) | Aggregated counts for the `secret_detection` scan. |
|
|
|
|
### `SecurityReportSummarySection`
|
|
|
|
Represents a section of a summary of a security report.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="securityreportsummarysectionscannedresources"></a>`scannedResources` | [`ScannedResourceConnection`](#scannedresourceconnection) | List of the first 20 scanned resources. (see [Connections](#connections)) |
|
|
| <a id="securityreportsummarysectionscannedresourcescount"></a>`scannedResourcesCount` | [`Int`](#int) | Total number of scanned resources. |
|
|
| <a id="securityreportsummarysectionscannedresourcescsvpath"></a>`scannedResourcesCsvPath` | [`String`](#string) | Path to download all the scanned resources in CSV format. |
|
|
| <a id="securityreportsummarysectionscans"></a>`scans` | [`ScanConnection!`](#scanconnection) | List of security scans ran for the type. (see [Connections](#connections)) |
|
|
| <a id="securityreportsummarysectionvulnerabilitiescount"></a>`vulnerabilitiesCount` | [`Int`](#int) | Total number of vulnerabilities. |
|
|
|
|
### `SecurityScanners`
|
|
|
|
Represents a list of security scanners.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="securityscannersavailable"></a>`available` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which are available for the project. |
|
|
| <a id="securityscannersenabled"></a>`enabled` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which are enabled for the project. |
|
|
| <a id="securityscannerspipelinerun"></a>`pipelineRun` | [`[SecurityScannerType!]`](#securityscannertype) | List of analyzers which ran successfully in the latest pipeline. |
|
|
|
|
### `SecurityTrainingUrl`
|
|
|
|
Represents a URL related to a security training.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="securitytrainingurlidentifier"></a>`identifier` | [`String`](#string) | Name of the vulnerability identifier. |
|
|
| <a id="securitytrainingurlname"></a>`name` | [`String`](#string) | Name of the training provider. |
|
|
| <a id="securitytrainingurlstatus"></a>`status` | [`TrainingUrlRequestStatus`](#trainingurlrequeststatus) | Status of the request to training provider. |
|
|
| <a id="securitytrainingurlurl"></a>`url` | [`String`](#string) | URL of the link for security training content. |
|
|
|
|
### `SentryDetailedError`
|
|
|
|
A Sentry error.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentrydetailederrorcount"></a>`count` | [`Int!`](#int) | Count of occurrences. |
|
|
| <a id="sentrydetailederrorculprit"></a>`culprit` | [`String!`](#string) | Culprit of the error. |
|
|
| <a id="sentrydetailederrorexternalbaseurl"></a>`externalBaseUrl` | [`String!`](#string) | External Base URL of the Sentry Instance. |
|
|
| <a id="sentrydetailederrorexternalurl"></a>`externalUrl` | [`String!`](#string) | External URL of the error. |
|
|
| <a id="sentrydetailederrorfirstreleaselastcommit"></a>`firstReleaseLastCommit` | [`String`](#string) | Commit the error was first seen. |
|
|
| <a id="sentrydetailederrorfirstreleaseshortversion"></a>`firstReleaseShortVersion` | [`String`](#string) | Release short version the error was first seen. |
|
|
| <a id="sentrydetailederrorfirstreleaseversion"></a>`firstReleaseVersion` | [`String`](#string) | Release version the error was first seen. |
|
|
| <a id="sentrydetailederrorfirstseen"></a>`firstSeen` | [`Time!`](#time) | Timestamp when the error was first seen. |
|
|
| <a id="sentrydetailederrorfrequency"></a>`frequency` | [`[SentryErrorFrequency!]!`](#sentryerrorfrequency) | Last 24hr stats of the error. |
|
|
| <a id="sentrydetailederrorgitlabcommit"></a>`gitlabCommit` | [`String`](#string) | GitLab commit SHA attributed to the Error based on the release version. |
|
|
| <a id="sentrydetailederrorgitlabcommitpath"></a>`gitlabCommitPath` | [`String`](#string) | Path to the GitLab page for the GitLab commit attributed to the error. |
|
|
| <a id="sentrydetailederrorgitlabissuepath"></a>`gitlabIssuePath` | [`String`](#string) | URL of GitLab Issue. |
|
|
| <a id="sentrydetailederrorid"></a>`id` | [`ID!`](#id) | ID (global ID) of the error. |
|
|
| <a id="sentrydetailederrorintegrated"></a>`integrated` | [`Boolean`](#boolean) | Error tracking backend. |
|
|
| <a id="sentrydetailederrorlastreleaselastcommit"></a>`lastReleaseLastCommit` | [`String`](#string) | Commit the error was last seen. |
|
|
| <a id="sentrydetailederrorlastreleaseshortversion"></a>`lastReleaseShortVersion` | [`String`](#string) | Release short version the error was last seen. |
|
|
| <a id="sentrydetailederrorlastreleaseversion"></a>`lastReleaseVersion` | [`String`](#string) | Release version the error was last seen. |
|
|
| <a id="sentrydetailederrorlastseen"></a>`lastSeen` | [`Time!`](#time) | Timestamp when the error was last seen. |
|
|
| <a id="sentrydetailederrormessage"></a>`message` | [`String`](#string) | Sentry metadata message of the error. |
|
|
| <a id="sentrydetailederrorsentryid"></a>`sentryId` | [`String!`](#string) | ID (Sentry ID) of the error. |
|
|
| <a id="sentrydetailederrorsentryprojectid"></a>`sentryProjectId` | [`ID!`](#id) | ID of the project (Sentry project). |
|
|
| <a id="sentrydetailederrorsentryprojectname"></a>`sentryProjectName` | [`String!`](#string) | Name of the project affected by the error. |
|
|
| <a id="sentrydetailederrorsentryprojectslug"></a>`sentryProjectSlug` | [`String!`](#string) | Slug of the project affected by the error. |
|
|
| <a id="sentrydetailederrorshortid"></a>`shortId` | [`String!`](#string) | Short ID (Sentry ID) of the error. |
|
|
| <a id="sentrydetailederrorstatus"></a>`status` | [`SentryErrorStatus!`](#sentryerrorstatus) | Status of the error. |
|
|
| <a id="sentrydetailederrortags"></a>`tags` | [`SentryErrorTags!`](#sentryerrortags) | Tags associated with the Sentry Error. |
|
|
| <a id="sentrydetailederrortitle"></a>`title` | [`String!`](#string) | Title of the error. |
|
|
| <a id="sentrydetailederrortype"></a>`type` | [`String!`](#string) | Type of the error. |
|
|
| <a id="sentrydetailederrorusercount"></a>`userCount` | [`Int!`](#int) | Count of users affected by the error. |
|
|
|
|
### `SentryError`
|
|
|
|
A Sentry error. A simplified version of SentryDetailedError.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorcount"></a>`count` | [`Int!`](#int) | Count of occurrences. |
|
|
| <a id="sentryerrorculprit"></a>`culprit` | [`String!`](#string) | Culprit of the error. |
|
|
| <a id="sentryerrorexternalurl"></a>`externalUrl` | [`String!`](#string) | External URL of the error. |
|
|
| <a id="sentryerrorfirstseen"></a>`firstSeen` | [`Time!`](#time) | Timestamp when the error was first seen. |
|
|
| <a id="sentryerrorfrequency"></a>`frequency` | [`[SentryErrorFrequency!]!`](#sentryerrorfrequency) | Last 24hr stats of the error. |
|
|
| <a id="sentryerrorid"></a>`id` | [`ID!`](#id) | ID (global ID) of the error. |
|
|
| <a id="sentryerrorlastseen"></a>`lastSeen` | [`Time!`](#time) | Timestamp when the error was last seen. |
|
|
| <a id="sentryerrormessage"></a>`message` | [`String`](#string) | Sentry metadata message of the error. |
|
|
| <a id="sentryerrorsentryid"></a>`sentryId` | [`String!`](#string) | ID (Sentry ID) of the error. |
|
|
| <a id="sentryerrorsentryprojectid"></a>`sentryProjectId` | [`ID!`](#id) | ID of the project (Sentry project). |
|
|
| <a id="sentryerrorsentryprojectname"></a>`sentryProjectName` | [`String!`](#string) | Name of the project affected by the error. |
|
|
| <a id="sentryerrorsentryprojectslug"></a>`sentryProjectSlug` | [`String!`](#string) | Slug of the project affected by the error. |
|
|
| <a id="sentryerrorshortid"></a>`shortId` | [`String!`](#string) | Short ID (Sentry ID) of the error. |
|
|
| <a id="sentryerrorstatus"></a>`status` | [`SentryErrorStatus!`](#sentryerrorstatus) | Status of the error. |
|
|
| <a id="sentryerrortitle"></a>`title` | [`String!`](#string) | Title of the error. |
|
|
| <a id="sentryerrortype"></a>`type` | [`String!`](#string) | Type of the error. |
|
|
| <a id="sentryerrorusercount"></a>`userCount` | [`Int!`](#int) | Count of users affected by the error. |
|
|
|
|
### `SentryErrorCollection`
|
|
|
|
An object containing a collection of Sentry errors, and a detailed error.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorcollectionexternalurl"></a>`externalUrl` | [`String`](#string) | External URL for Sentry. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `SentryErrorCollection.detailedError`
|
|
|
|
Detailed version of a Sentry error on the project.
|
|
|
|
Returns [`SentryDetailedError`](#sentrydetailederror).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorcollectiondetailederrorid"></a>`id` | [`GitlabErrorTrackingDetailedErrorID!`](#gitlaberrortrackingdetailederrorid) | ID of the Sentry issue. |
|
|
|
|
##### `SentryErrorCollection.errorStackTrace`
|
|
|
|
Stack Trace of Sentry Error.
|
|
|
|
Returns [`SentryErrorStackTrace`](#sentryerrorstacktrace).
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorcollectionerrorstacktraceid"></a>`id` | [`GitlabErrorTrackingDetailedErrorID!`](#gitlaberrortrackingdetailederrorid) | ID of the Sentry issue. |
|
|
|
|
##### `SentryErrorCollection.errors`
|
|
|
|
Collection of Sentry Errors.
|
|
|
|
Returns [`SentryErrorConnection`](#sentryerrorconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorcollectionerrorssearchterm"></a>`searchTerm` | [`String`](#string) | Search query for the Sentry error details. |
|
|
| <a id="sentryerrorcollectionerrorssort"></a>`sort` | [`String`](#string) | Attribute to sort on. Options are frequency, first_seen, last_seen. last_seen is default. |
|
|
|
|
### `SentryErrorFrequency`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorfrequencycount"></a>`count` | [`Int!`](#int) | Count of errors received since the previously recorded time. |
|
|
| <a id="sentryerrorfrequencytime"></a>`time` | [`Time!`](#time) | Time the error frequency stats were recorded. |
|
|
|
|
### `SentryErrorStackTrace`
|
|
|
|
An object containing a stack trace entry for a Sentry error.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorstacktracedatereceived"></a>`dateReceived` | [`String!`](#string) | Time the stack trace was received by Sentry. |
|
|
| <a id="sentryerrorstacktraceissueid"></a>`issueId` | [`String!`](#string) | ID of the Sentry error. |
|
|
| <a id="sentryerrorstacktracestacktraceentries"></a>`stackTraceEntries` | [`[SentryErrorStackTraceEntry!]!`](#sentryerrorstacktraceentry) | Stack trace entries for the Sentry error. |
|
|
|
|
### `SentryErrorStackTraceContext`
|
|
|
|
An object context for a Sentry error stack trace.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorstacktracecontextcode"></a>`code` | [`String!`](#string) | Code number of the context. |
|
|
| <a id="sentryerrorstacktracecontextline"></a>`line` | [`Int!`](#int) | Line number of the context. |
|
|
|
|
### `SentryErrorStackTraceEntry`
|
|
|
|
An object containing a stack trace entry for a Sentry error.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrorstacktraceentrycol"></a>`col` | [`String`](#string) | Function in which the Sentry error occurred. |
|
|
| <a id="sentryerrorstacktraceentryfilename"></a>`fileName` | [`String`](#string) | File in which the Sentry error occurred. |
|
|
| <a id="sentryerrorstacktraceentryfunction"></a>`function` | [`String`](#string) | Function in which the Sentry error occurred. |
|
|
| <a id="sentryerrorstacktraceentryline"></a>`line` | [`String`](#string) | Function in which the Sentry error occurred. |
|
|
| <a id="sentryerrorstacktraceentrytracecontext"></a>`traceContext` | [`[SentryErrorStackTraceContext!]`](#sentryerrorstacktracecontext) | Context of the Sentry error. |
|
|
|
|
### `SentryErrorTags`
|
|
|
|
State of a Sentry error.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sentryerrortagslevel"></a>`level` | [`String`](#string) | Severity level of the Sentry Error. |
|
|
| <a id="sentryerrortagslogger"></a>`logger` | [`String`](#string) | Logger of the Sentry Error. |
|
|
|
|
### `Snippet`
|
|
|
|
Represents a snippet entry.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetauthor"></a>`author` | [`UserCore`](#usercore) | Owner of the snippet. |
|
|
| <a id="snippetcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp this snippet was created. |
|
|
| <a id="snippetdescription"></a>`description` | [`String`](#string) | Description of the snippet. |
|
|
| <a id="snippetdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="snippetdiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="snippetfilename"></a>`fileName` | [`String`](#string) | File Name of the snippet. |
|
|
| <a id="snippethttpurltorepo"></a>`httpUrlToRepo` | [`String`](#string) | HTTP URL to the snippet repository. |
|
|
| <a id="snippetid"></a>`id` | [`SnippetID!`](#snippetid) | ID of the snippet. |
|
|
| <a id="snippetnotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="snippetproject"></a>`project` | [`Project`](#project) | Project the snippet is associated with. |
|
|
| <a id="snippetrawurl"></a>`rawUrl` | [`String!`](#string) | Raw URL of the snippet. |
|
|
| <a id="snippetsshurltorepo"></a>`sshUrlToRepo` | [`String`](#string) | SSH URL to the snippet repository. |
|
|
| <a id="snippettitle"></a>`title` | [`String!`](#string) | Title of the snippet. |
|
|
| <a id="snippetupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp this snippet was updated. |
|
|
| <a id="snippetuserpermissions"></a>`userPermissions` | [`SnippetPermissions!`](#snippetpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="snippetvisibilitylevel"></a>`visibilityLevel` | [`VisibilityLevelsEnum!`](#visibilitylevelsenum) | Visibility Level of the snippet. |
|
|
| <a id="snippetweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the snippet. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Snippet.blobs`
|
|
|
|
Snippet blobs.
|
|
|
|
Returns [`SnippetBlobConnection`](#snippetblobconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetblobspaths"></a>`paths` | [`[String!]`](#string) | Paths of the blobs. |
|
|
|
|
### `SnippetBlob`
|
|
|
|
Represents the snippet blob.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetblobbinary"></a>`binary` | [`Boolean!`](#boolean) | Shows whether the blob is binary. |
|
|
| <a id="snippetblobexternalstorage"></a>`externalStorage` | [`String`](#string) | Blob external storage. |
|
|
| <a id="snippetblobmode"></a>`mode` | [`String`](#string) | Blob mode. |
|
|
| <a id="snippetblobname"></a>`name` | [`String`](#string) | Blob name. |
|
|
| <a id="snippetblobpath"></a>`path` | [`String`](#string) | Blob path. |
|
|
| <a id="snippetblobplaindata"></a>`plainData` | [`String`](#string) | Blob plain highlighted data. |
|
|
| <a id="snippetblobrawpath"></a>`rawPath` | [`String!`](#string) | Blob raw content endpoint path. |
|
|
| <a id="snippetblobrawplaindata"></a>`rawPlainData` | [`String`](#string) | Raw content of the blob, if the blob is text data. |
|
|
| <a id="snippetblobrenderedastext"></a>`renderedAsText` | [`Boolean!`](#boolean) | Shows whether the blob is rendered as text. |
|
|
| <a id="snippetblobrichdata"></a>`richData` | [`String`](#string) | Blob highlighted data. |
|
|
| <a id="snippetblobrichviewer"></a>`richViewer` | [`SnippetBlobViewer`](#snippetblobviewer) | Blob content rich viewer. |
|
|
| <a id="snippetblobsimpleviewer"></a>`simpleViewer` | [`SnippetBlobViewer!`](#snippetblobviewer) | Blob content simple viewer. |
|
|
| <a id="snippetblobsize"></a>`size` | [`Int!`](#int) | Blob size. |
|
|
|
|
### `SnippetBlobViewer`
|
|
|
|
Represents how the blob content should be displayed.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetblobviewercollapsed"></a>`collapsed` | [`Boolean!`](#boolean) | Shows whether the blob should be displayed collapsed. |
|
|
| <a id="snippetblobviewerfiletype"></a>`fileType` | [`String!`](#string) | Content file type. |
|
|
| <a id="snippetblobviewerloadasync"></a>`loadAsync` | [`Boolean!`](#boolean) | Shows whether the blob content is loaded asynchronously. |
|
|
| <a id="snippetblobviewerloadingpartialname"></a>`loadingPartialName` | [`String!`](#string) | Loading partial name. |
|
|
| <a id="snippetblobviewerrendererror"></a>`renderError` | [`String`](#string) | Error rendering the blob content. |
|
|
| <a id="snippetblobviewertoolarge"></a>`tooLarge` | [`Boolean!`](#boolean) | Shows whether the blob is too large to be displayed. |
|
|
| <a id="snippetblobviewertype"></a>`type` | [`BlobViewersType!`](#blobviewerstype) | Type of blob viewer. |
|
|
|
|
### `SnippetPermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetpermissionsadminsnippet"></a>`adminSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_snippet` on this resource. |
|
|
| <a id="snippetpermissionsawardemoji"></a>`awardEmoji` | [`Boolean!`](#boolean) | Indicates the user can perform `award_emoji` on this resource. |
|
|
| <a id="snippetpermissionscreatenote"></a>`createNote` | [`Boolean!`](#boolean) | Indicates the user can perform `create_note` on this resource. |
|
|
| <a id="snippetpermissionsreadsnippet"></a>`readSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `read_snippet` on this resource. |
|
|
| <a id="snippetpermissionsreportsnippet"></a>`reportSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `report_snippet` on this resource. |
|
|
| <a id="snippetpermissionsupdatesnippet"></a>`updateSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `update_snippet` on this resource. |
|
|
|
|
### `SnippetRepositoryRegistry`
|
|
|
|
Represents the Geo sync and verification state of a snippet repository.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetrepositoryregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the SnippetRepositoryRegistry was created. |
|
|
| <a id="snippetrepositoryregistryid"></a>`id` | [`ID!`](#id) | ID of the SnippetRepositoryRegistry. |
|
|
| <a id="snippetrepositoryregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the SnippetRepositoryRegistry. |
|
|
| <a id="snippetrepositoryregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the SnippetRepositoryRegistry. |
|
|
| <a id="snippetrepositoryregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the SnippetRepositoryRegistry should be resynced. |
|
|
| <a id="snippetrepositoryregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the SnippetRepositoryRegistry. |
|
|
| <a id="snippetrepositoryregistrysnippetrepositoryid"></a>`snippetRepositoryId` | [`ID!`](#id) | ID of the Snippet Repository. |
|
|
| <a id="snippetrepositoryregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the SnippetRepositoryRegistry. |
|
|
|
|
### `StatusAction`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="statusactionbuttontitle"></a>`buttonTitle` | [`String`](#string) | Title for the button, for example: Retry this job. |
|
|
| <a id="statusactionicon"></a>`icon` | [`String`](#string) | Icon used in the action button. |
|
|
| <a id="statusactionid"></a>`id` | [`String!`](#string) | ID for a status action. |
|
|
| <a id="statusactionmethod"></a>`method` | [`String`](#string) | Method for the action, for example: :post. |
|
|
| <a id="statusactionpath"></a>`path` | [`String`](#string) | Path for the action. |
|
|
| <a id="statusactiontitle"></a>`title` | [`String`](#string) | Title for the action, for example: Retry. |
|
|
|
|
### `Submodule`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="submoduleflatpath"></a>`flatPath` | [`String!`](#string) | Flat path of the entry. |
|
|
| <a id="submoduleid"></a>`id` | [`ID!`](#id) | ID of the entry. |
|
|
| <a id="submodulename"></a>`name` | [`String!`](#string) | Name of the entry. |
|
|
| <a id="submodulepath"></a>`path` | [`String!`](#string) | Path of the entry. |
|
|
| <a id="submodulesha"></a>`sha` | [`String!`](#string) | Last commit SHA for the entry. |
|
|
| <a id="submoduletreeurl"></a>`treeUrl` | [`String`](#string) | Tree URL for the sub-module. |
|
|
| <a id="submoduletype"></a>`type` | [`EntryType!`](#entrytype) | Type of tree entry. |
|
|
| <a id="submoduleweburl"></a>`webUrl` | [`String`](#string) | Web URL for the sub-module. |
|
|
|
|
### `SubscriptionFutureEntry`
|
|
|
|
Represents an entry from the future subscriptions.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="subscriptionfutureentrycompany"></a>`company` | [`String`](#string) | Company of the licensee. |
|
|
| <a id="subscriptionfutureentryemail"></a>`email` | [`String`](#string) | Email of the licensee. |
|
|
| <a id="subscriptionfutureentryexpiresat"></a>`expiresAt` | [`Date`](#date) | Date when the license expires. |
|
|
| <a id="subscriptionfutureentryname"></a>`name` | [`String`](#string) | Name of the licensee. |
|
|
| <a id="subscriptionfutureentryplan"></a>`plan` | [`String!`](#string) | Name of the subscription plan. |
|
|
| <a id="subscriptionfutureentrystartsat"></a>`startsAt` | [`Date`](#date) | Date when the license started. |
|
|
| <a id="subscriptionfutureentrytype"></a>`type` | [`String!`](#string) | Type of license the subscription will yield. |
|
|
| <a id="subscriptionfutureentryusersinlicensecount"></a>`usersInLicenseCount` | [`Int`](#int) | Number of paid user seats. |
|
|
|
|
### `TaskCompletionStatus`
|
|
|
|
Completion status of tasks.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="taskcompletionstatuscompletedcount"></a>`completedCount` | [`Int!`](#int) | Number of completed tasks. |
|
|
| <a id="taskcompletionstatuscount"></a>`count` | [`Int!`](#int) | Number of total tasks. |
|
|
|
|
### `TerraformState`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="terraformstatecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp the Terraform state was created. |
|
|
| <a id="terraformstatedeletedat"></a>`deletedAt` | [`Time`](#time) | Timestamp the Terraform state was deleted. |
|
|
| <a id="terraformstateid"></a>`id` | [`ID!`](#id) | ID of the Terraform state. |
|
|
| <a id="terraformstatelatestversion"></a>`latestVersion` | [`TerraformStateVersion`](#terraformstateversion) | Latest version of the Terraform state. |
|
|
| <a id="terraformstatelockedat"></a>`lockedAt` | [`Time`](#time) | Timestamp the Terraform state was locked. |
|
|
| <a id="terraformstatelockedbyuser"></a>`lockedByUser` | [`UserCore`](#usercore) | User currently holding a lock on the Terraform state. |
|
|
| <a id="terraformstatename"></a>`name` | [`String!`](#string) | Name of the Terraform state. |
|
|
| <a id="terraformstateupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp the Terraform state was updated. |
|
|
|
|
### `TerraformStateVersion`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="terraformstateversioncreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp the version was created. |
|
|
| <a id="terraformstateversioncreatedbyuser"></a>`createdByUser` | [`UserCore`](#usercore) | User that created this version. |
|
|
| <a id="terraformstateversiondownloadpath"></a>`downloadPath` | [`String`](#string) | URL for downloading the version's JSON file. |
|
|
| <a id="terraformstateversionid"></a>`id` | [`ID!`](#id) | ID of the Terraform state version. |
|
|
| <a id="terraformstateversionjob"></a>`job` | [`CiJob`](#cijob) | Job that created this version. |
|
|
| <a id="terraformstateversionserial"></a>`serial` | [`Int`](#int) | Serial number of the version. |
|
|
| <a id="terraformstateversionupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp the version was updated. |
|
|
|
|
### `TerraformStateVersionRegistry`
|
|
|
|
Represents the Geo sync and verification state of a terraform state version.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="terraformstateversionregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the TerraformStateVersionRegistry was created. |
|
|
| <a id="terraformstateversionregistryid"></a>`id` | [`ID!`](#id) | ID of the TerraformStateVersionRegistry. |
|
|
| <a id="terraformstateversionregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the TerraformStateVersionRegistry. |
|
|
| <a id="terraformstateversionregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the TerraformStateVersionRegistry. |
|
|
| <a id="terraformstateversionregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the TerraformStateVersionRegistry should be resynced. |
|
|
| <a id="terraformstateversionregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the TerraformStateVersionRegistry. |
|
|
| <a id="terraformstateversionregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the TerraformStateVersionRegistry. |
|
|
| <a id="terraformstateversionregistryterraformstateversionid"></a>`terraformStateVersionId` | [`ID!`](#id) | ID of the terraform state version. |
|
|
|
|
### `TestCase`
|
|
|
|
Test case in pipeline test report.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testcaseattachmenturl"></a>`attachmentUrl` | [`String`](#string) | URL of the test case attachment file. |
|
|
| <a id="testcaseclassname"></a>`classname` | [`String`](#string) | Classname of the test case. |
|
|
| <a id="testcaseexecutiontime"></a>`executionTime` | [`Float`](#float) | Test case execution time in seconds. |
|
|
| <a id="testcasefile"></a>`file` | [`String`](#string) | Path to the file of the test case. |
|
|
| <a id="testcasename"></a>`name` | [`String`](#string) | Name of the test case. |
|
|
| <a id="testcaserecentfailures"></a>`recentFailures` | [`RecentFailures`](#recentfailures) | Recent failure history of the test case on the base branch. |
|
|
| <a id="testcasestacktrace"></a>`stackTrace` | [`String`](#string) | Stack trace of the test case. |
|
|
| <a id="testcasestatus"></a>`status` | [`TestCaseStatus`](#testcasestatus) | Status of the test case (error, failed, success, skipped). |
|
|
| <a id="testcasesystemoutput"></a>`systemOutput` | [`String`](#string) | System output of the test case. |
|
|
|
|
### `TestReport`
|
|
|
|
Represents a requirement test report.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testreportauthor"></a>`author` | [`UserCore`](#usercore) | Author of the test report. |
|
|
| <a id="testreportcreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp of when the test report was created. |
|
|
| <a id="testreportid"></a>`id` | [`ID!`](#id) | ID of the test report. |
|
|
| <a id="testreportstate"></a>`state` | [`TestReportState!`](#testreportstate) | State of the test report. |
|
|
|
|
### `TestReportSummary`
|
|
|
|
Test report for a pipeline.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testreportsummarytestsuites"></a>`testSuites` | [`TestSuiteSummaryConnection!`](#testsuitesummaryconnection) | Test suites belonging to a pipeline test report. (see [Connections](#connections)) |
|
|
| <a id="testreportsummarytotal"></a>`total` | [`TestReportTotal!`](#testreporttotal) | Total report statistics for a pipeline test report. |
|
|
|
|
### `TestReportTotal`
|
|
|
|
Total test report statistics.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testreporttotalcount"></a>`count` | [`Int`](#int) | Total number of the test cases. |
|
|
| <a id="testreporttotalerror"></a>`error` | [`Int`](#int) | Total number of test cases that had an error. |
|
|
| <a id="testreporttotalfailed"></a>`failed` | [`Int`](#int) | Total number of test cases that failed. |
|
|
| <a id="testreporttotalskipped"></a>`skipped` | [`Int`](#int) | Total number of test cases that were skipped. |
|
|
| <a id="testreporttotalsuccess"></a>`success` | [`Int`](#int) | Total number of test cases that succeeded. |
|
|
| <a id="testreporttotalsuiteerror"></a>`suiteError` | [`String`](#string) | Test suite error message. |
|
|
| <a id="testreporttotaltime"></a>`time` | [`Float`](#float) | Total duration of the tests. |
|
|
|
|
### `TestSuite`
|
|
|
|
Test suite in a pipeline test report.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testsuiteerrorcount"></a>`errorCount` | [`Int`](#int) | Total number of test cases that had an error. |
|
|
| <a id="testsuitefailedcount"></a>`failedCount` | [`Int`](#int) | Total number of test cases that failed in the test suite. |
|
|
| <a id="testsuitename"></a>`name` | [`String`](#string) | Name of the test suite. |
|
|
| <a id="testsuiteskippedcount"></a>`skippedCount` | [`Int`](#int) | Total number of test cases that were skipped in the test suite. |
|
|
| <a id="testsuitesuccesscount"></a>`successCount` | [`Int`](#int) | Total number of test cases that succeeded in the test suite. |
|
|
| <a id="testsuitesuiteerror"></a>`suiteError` | [`String`](#string) | Test suite error message. |
|
|
| <a id="testsuitetestcases"></a>`testCases` | [`TestCaseConnection`](#testcaseconnection) | Test cases in the test suite. (see [Connections](#connections)) |
|
|
| <a id="testsuitetotalcount"></a>`totalCount` | [`Int`](#int) | Total number of the test cases in the test suite. |
|
|
| <a id="testsuitetotaltime"></a>`totalTime` | [`Float`](#float) | Total duration of the tests in the test suite. |
|
|
|
|
### `TestSuiteSummary`
|
|
|
|
Test suite summary in a pipeline test report.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="testsuitesummarybuildids"></a>`buildIds` | [`[ID!]`](#id) | IDs of the builds used to run the test suite. |
|
|
| <a id="testsuitesummaryerrorcount"></a>`errorCount` | [`Int`](#int) | Total number of test cases that had an error. |
|
|
| <a id="testsuitesummaryfailedcount"></a>`failedCount` | [`Int`](#int) | Total number of test cases that failed in the test suite. |
|
|
| <a id="testsuitesummaryname"></a>`name` | [`String`](#string) | Name of the test suite. |
|
|
| <a id="testsuitesummaryskippedcount"></a>`skippedCount` | [`Int`](#int) | Total number of test cases that were skipped in the test suite. |
|
|
| <a id="testsuitesummarysuccesscount"></a>`successCount` | [`Int`](#int) | Total number of test cases that succeeded in the test suite. |
|
|
| <a id="testsuitesummarysuiteerror"></a>`suiteError` | [`String`](#string) | Test suite error message. |
|
|
| <a id="testsuitesummarytotalcount"></a>`totalCount` | [`Int`](#int) | Total number of the test cases in the test suite. |
|
|
| <a id="testsuitesummarytotaltime"></a>`totalTime` | [`Float`](#float) | Total duration of the tests in the test suite. |
|
|
|
|
### `TimeReportStats`
|
|
|
|
Represents the time report stats for timeboxes.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timereportstatscomplete"></a>`complete` | [`TimeboxMetrics`](#timeboxmetrics) | Completed issues metrics. |
|
|
| <a id="timereportstatsincomplete"></a>`incomplete` | [`TimeboxMetrics`](#timeboxmetrics) | Incomplete issues metrics. |
|
|
| <a id="timereportstatstotal"></a>`total` | [`TimeboxMetrics`](#timeboxmetrics) | Total issues metrics. |
|
|
|
|
### `TimeboxMetrics`
|
|
|
|
Represents measured stats metrics for timeboxes.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timeboxmetricscount"></a>`count` | [`Int!`](#int) | Count metric. |
|
|
| <a id="timeboxmetricsweight"></a>`weight` | [`Int!`](#int) | Weight metric. |
|
|
|
|
### `TimeboxReport`
|
|
|
|
Represents a historically accurate report about the timebox.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timeboxreportburnuptimeseries"></a>`burnupTimeSeries` | [`[BurnupChartDailyTotals!]`](#burnupchartdailytotals) | Daily scope and completed totals for burnup charts. |
|
|
| <a id="timeboxreporterror"></a>`error` | [`TimeboxReportError`](#timeboxreporterror) | If the report cannot be generated, information about why. |
|
|
| <a id="timeboxreportstats"></a>`stats` | [`TimeReportStats`](#timereportstats) | Represents the time report stats for the timebox. |
|
|
|
|
### `TimeboxReportError`
|
|
|
|
Explains why we could not generate a timebox report.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timeboxreporterrorcode"></a>`code` | [`TimeboxReportErrorReason`](#timeboxreporterrorreason) | Machine readable code, categorizing the error. |
|
|
| <a id="timeboxreporterrormessage"></a>`message` | [`String`](#string) | Human readable message explaining what happened. |
|
|
|
|
### `TimelineEventType`
|
|
|
|
Describes an incident management timeline event.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timelineeventtypeaction"></a>`action` | [`String!`](#string) | Indicates the timeline event icon. |
|
|
| <a id="timelineeventtypeauthor"></a>`author` | [`UserCore`](#usercore) | User that created the timeline event. |
|
|
| <a id="timelineeventtypecreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp when the event created. |
|
|
| <a id="timelineeventtypeeditable"></a>`editable` | [`Boolean!`](#boolean) | Indicates the timeline event is editable. |
|
|
| <a id="timelineeventtypeid"></a>`id` | [`IncidentManagementTimelineEventID!`](#incidentmanagementtimelineeventid) | ID of the timeline event. |
|
|
| <a id="timelineeventtypeincident"></a>`incident` | [`Issue!`](#issue) | Incident of the timeline event. |
|
|
| <a id="timelineeventtypenote"></a>`note` | [`String`](#string) | Text note of the timeline event. |
|
|
| <a id="timelineeventtypenotehtml"></a>`noteHtml` | [`String`](#string) | HTML note of the timeline event. |
|
|
| <a id="timelineeventtypeoccurredat"></a>`occurredAt` | [`Time!`](#time) | Timestamp when the event occurred. |
|
|
| <a id="timelineeventtypepromotedfromnote"></a>`promotedFromNote` | [`Note`](#note) | Note from which the timeline event was created. |
|
|
| <a id="timelineeventtypeupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp when the event updated. |
|
|
| <a id="timelineeventtypeupdatedbyuser"></a>`updatedByUser` | [`UserCore`](#usercore) | User that updated the timeline event. |
|
|
|
|
### `Timelog`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timelogid"></a>`id` | [`ID!`](#id) | Internal ID of the timelog. |
|
|
| <a id="timelogissue"></a>`issue` | [`Issue`](#issue) | Issue that logged time was added to. |
|
|
| <a id="timelogmergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request that logged time was added to. |
|
|
| <a id="timelognote"></a>`note` | [`Note`](#note) | Note where the quick action was executed to add the logged time. |
|
|
| <a id="timelogspentat"></a>`spentAt` | [`Time`](#time) | Timestamp of when the time tracked was spent at. |
|
|
| <a id="timelogsummary"></a>`summary` | [`String`](#string) | Summary of how the time was spent. |
|
|
| <a id="timelogtimespent"></a>`timeSpent` | [`Int!`](#int) | Time spent displayed in seconds. |
|
|
| <a id="timeloguser"></a>`user` | [`UserCore!`](#usercore) | User that logged the time. |
|
|
| <a id="timeloguserpermissions"></a>`userPermissions` | [`TimelogPermissions!`](#timelogpermissions) | Permissions for the current user on the resource. |
|
|
|
|
### `TimelogPermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timelogpermissionsadmintimelog"></a>`adminTimelog` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_timelog` on this resource. |
|
|
|
|
### `Todo`
|
|
|
|
Representing a to-do entry.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="todoaction"></a>`action` | [`TodoActionEnum!`](#todoactionenum) | Action of the to-do item. |
|
|
| <a id="todoauthor"></a>`author` | [`UserCore!`](#usercore) | Author of this to-do item. |
|
|
| <a id="todobody"></a>`body` | [`String!`](#string) | Body of the to-do item. |
|
|
| <a id="todocreatedat"></a>`createdAt` | [`Time!`](#time) | Timestamp this to-do item was created. |
|
|
| <a id="todogroup"></a>`group` | [`Group`](#group) | Group this to-do item is associated with. |
|
|
| <a id="todoid"></a>`id` | [`ID!`](#id) | ID of the to-do item. |
|
|
| <a id="todonote"></a>`note` | [`Note`](#note) | Note which created this to-do item. |
|
|
| <a id="todoproject"></a>`project` | [`Project`](#project) | Project this to-do item is associated with. |
|
|
| <a id="todostate"></a>`state` | [`TodoStateEnum!`](#todostateenum) | State of the to-do item. |
|
|
| <a id="todotarget"></a>`target` | [`Todoable!`](#todoable) | Target of the to-do item. |
|
|
| <a id="todotargettype"></a>`targetType` | [`TodoTargetEnum!`](#todotargetenum) | Target type of the to-do item. |
|
|
|
|
### `Topic`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="topicavatarurl"></a>`avatarUrl` | [`String`](#string) | URL to avatar image file of the topic. |
|
|
| <a id="topicdescription"></a>`description` | [`String`](#string) | Description of the topic. |
|
|
| <a id="topicdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="topicid"></a>`id` | [`ID!`](#id) | ID of the topic. |
|
|
| <a id="topicname"></a>`name` | [`String!`](#string) | Name of the topic. |
|
|
| <a id="topictitle"></a>`title` | [`String!`](#string) | Title of the topic. |
|
|
|
|
### `Tree`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="treeblobs"></a>`blobs` | [`BlobConnection!`](#blobconnection) | Blobs of the tree. (see [Connections](#connections)) |
|
|
| <a id="treelastcommit"></a>`lastCommit` | [`Commit`](#commit) | Last commit for the tree. |
|
|
| <a id="treesubmodules"></a>`submodules` | [`SubmoduleConnection!`](#submoduleconnection) | Sub-modules of the tree. (see [Connections](#connections)) |
|
|
| <a id="treetrees"></a>`trees` | [`TreeEntryConnection!`](#treeentryconnection) | Trees of the tree. (see [Connections](#connections)) |
|
|
|
|
### `TreeEntry`
|
|
|
|
Represents a directory.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="treeentryflatpath"></a>`flatPath` | [`String!`](#string) | Flat path of the entry. |
|
|
| <a id="treeentryid"></a>`id` | [`ID!`](#id) | ID of the entry. |
|
|
| <a id="treeentryname"></a>`name` | [`String!`](#string) | Name of the entry. |
|
|
| <a id="treeentrypath"></a>`path` | [`String!`](#string) | Path of the entry. |
|
|
| <a id="treeentrysha"></a>`sha` | [`String!`](#string) | Last commit SHA for the entry. |
|
|
| <a id="treeentrytype"></a>`type` | [`EntryType!`](#entrytype) | Type of tree entry. |
|
|
| <a id="treeentrywebpath"></a>`webPath` | [`String`](#string) | Web path for the tree entry (directory). |
|
|
| <a id="treeentryweburl"></a>`webUrl` | [`String`](#string) | Web URL for the tree entry (directory). |
|
|
|
|
### `UploadRegistry`
|
|
|
|
Represents the Geo replication and verification state of an upload.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="uploadregistrycreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp when the UploadRegistry was created. |
|
|
| <a id="uploadregistryfileid"></a>`fileId` | [`ID!`](#id) | ID of the Upload. |
|
|
| <a id="uploadregistryid"></a>`id` | [`ID!`](#id) | ID of the UploadRegistry. |
|
|
| <a id="uploadregistrylastsyncfailure"></a>`lastSyncFailure` | [`String`](#string) | Error message during sync of the UploadRegistry. |
|
|
| <a id="uploadregistrylastsyncedat"></a>`lastSyncedAt` | [`Time`](#time) | Timestamp of the most recent successful sync of the UploadRegistry. |
|
|
| <a id="uploadregistryretryat"></a>`retryAt` | [`Time`](#time) | Timestamp after which the UploadRegistry should be resynced. |
|
|
| <a id="uploadregistryretrycount"></a>`retryCount` | [`Int`](#int) | Number of consecutive failed sync attempts of the UploadRegistry. |
|
|
| <a id="uploadregistrystate"></a>`state` | [`RegistryState`](#registrystate) | Sync state of the UploadRegistry. |
|
|
|
|
### `UsageTrendsMeasurement`
|
|
|
|
Represents a recorded measurement (object count) for the Admins.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usagetrendsmeasurementcount"></a>`count` | [`Int!`](#int) | Object count. |
|
|
| <a id="usagetrendsmeasurementidentifier"></a>`identifier` | [`MeasurementIdentifier!`](#measurementidentifier) | Type of objects being measured. |
|
|
| <a id="usagetrendsmeasurementrecordedat"></a>`recordedAt` | [`Time`](#time) | Time the measurement was recorded. |
|
|
|
|
### `UserCallout`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercalloutdismissedat"></a>`dismissedAt` | [`Time`](#time) | Date when the callout was dismissed. |
|
|
| <a id="usercalloutfeaturename"></a>`featureName` | [`UserCalloutFeatureNameEnum`](#usercalloutfeaturenameenum) | Name of the feature that the callout is for. |
|
|
|
|
### `UserCore`
|
|
|
|
Core represention of a GitLab user.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoreavatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. |
|
|
| <a id="usercorebot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. |
|
|
| <a id="usercorecallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) |
|
|
| <a id="usercoreemail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). |
|
|
| <a id="usercoregitpodenabled"></a>`gitpodEnabled` | [`Boolean`](#boolean) | Whether Gitpod is enabled at the user level. |
|
|
| <a id="usercoregroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. |
|
|
| <a id="usercoregroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="usercoreid"></a>`id` | [`ID!`](#id) | ID of the user. |
|
|
| <a id="usercorelocation"></a>`location` | [`String`](#string) | Location of the user. |
|
|
| <a id="usercorename"></a>`name` | [`String!`](#string) | Human-readable name of the user. Returns `****` if the user is a project bot and the requester does not have permission to view the project. |
|
|
| <a id="usercorenamespace"></a>`namespace` | [`Namespace`](#namespace) | Personal namespace of the user. |
|
|
| <a id="usercorepreferencesgitpodpath"></a>`preferencesGitpodPath` | [`String`](#string) | Web path to the Gitpod section within user preferences. |
|
|
| <a id="usercoreprofileenablegitpodpath"></a>`profileEnableGitpodPath` | [`String`](#string) | Web path to enable Gitpod for the user. |
|
|
| <a id="usercoreprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="usercorepublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. |
|
|
| <a id="usercoresavedreplies"></a>`savedReplies` | [`SavedReplyConnection`](#savedreplyconnection) | Saved replies authored by the user. Will not return saved replies if `saved_replies` feature flag is disabled. (see [Connections](#connections)) |
|
|
| <a id="usercorestate"></a>`state` | [`UserState!`](#userstate) | State of the user. |
|
|
| <a id="usercorestatus"></a>`status` | [`UserStatus`](#userstatus) | User status. |
|
|
| <a id="usercoreuserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="usercoreusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. |
|
|
| <a id="usercorewebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. |
|
|
| <a id="usercoreweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `UserCore.assignedMergeRequests`
|
|
|
|
Merge requests assigned to the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoreassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="usercoreassignedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="usercoreassignedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="usercoreassignedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="usercoreassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="usercoreassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="usercoreassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="usercoreassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="usercoreassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="usercoreassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="usercoreassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="usercoreassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="usercoreassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="usercoreassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="usercoreassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="usercoreassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="usercoreassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="usercoreassignedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="usercoreassignedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `UserCore.authoredMergeRequests`
|
|
|
|
Merge requests authored by the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoreauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="usercoreauthoredmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="usercoreauthoredmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="usercoreauthoredmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="usercoreauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="usercoreauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="usercoreauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="usercoreauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="usercoreauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="usercoreauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="usercoreauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="usercoreauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="usercoreauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="usercoreauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="usercoreauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="usercoreauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="usercoreauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="usercoreauthoredmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="usercoreauthoredmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `UserCore.groups`
|
|
|
|
Groups where the user has access.
|
|
|
|
Returns [`GroupConnection`](#groupconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoregroupspermissionscope"></a>`permissionScope` | [`GroupPermission`](#grouppermission) | Filter by permissions the user has on groups. |
|
|
| <a id="usercoregroupssearch"></a>`search` | [`String`](#string) | Search by group name or path. |
|
|
|
|
##### `UserCore.reviewRequestedMergeRequests`
|
|
|
|
Merge requests assigned to the user for review.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercorereviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="usercorereviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="usercorereviewrequestedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="usercorereviewrequestedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="usercorereviewrequestedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="usercorereviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="usercorereviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="usercorereviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="usercorereviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="usercorereviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="usercorereviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="usercorereviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="usercorereviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="usercorereviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="usercorereviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="usercorereviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="usercorereviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="usercorereviewrequestedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="usercorereviewrequestedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
##### `UserCore.snippets`
|
|
|
|
Snippets authored by the user.
|
|
|
|
Returns [`SnippetConnection`](#snippetconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoresnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. |
|
|
| <a id="usercoresnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | Type of snippet. |
|
|
| <a id="usercoresnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. |
|
|
|
|
##### `UserCore.starredProjects`
|
|
|
|
Projects starred by the user.
|
|
|
|
Returns [`ProjectConnection`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercorestarredprojectssearch"></a>`search` | [`String`](#string) | Search query. |
|
|
|
|
##### `UserCore.timelogs`
|
|
|
|
Time logged by the user.
|
|
|
|
Returns [`TimelogConnection`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoretimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="usercoretimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="usercoretimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="usercoretimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="usercoretimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="usercoretimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="usercoretimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
##### `UserCore.todos`
|
|
|
|
To-do items of the user.
|
|
|
|
Returns [`TodoConnection`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usercoretodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | Action to be filtered. |
|
|
| <a id="usercoretodosauthorid"></a>`authorId` | [`[ID!]`](#id) | ID of an author. |
|
|
| <a id="usercoretodosgroupid"></a>`groupId` | [`[ID!]`](#id) | ID of a group. |
|
|
| <a id="usercoretodosprojectid"></a>`projectId` | [`[ID!]`](#id) | ID of a project. |
|
|
| <a id="usercoretodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | State of the todo. |
|
|
| <a id="usercoretodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | Type of the todo. |
|
|
|
|
### `UserMergeRequestInteraction`
|
|
|
|
Information about a merge request given a specific user.
|
|
|
|
This object has two parts to its state: a `User` and a `MergeRequest`. All
|
|
fields relate to interactions between the two entities.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usermergerequestinteractionapplicableapprovalrules"></a>`applicableApprovalRules` | [`[ApprovalRule!]`](#approvalrule) | Approval rules that apply to this user for this merge request. |
|
|
| <a id="usermergerequestinteractionapproved"></a>`approved` | [`Boolean!`](#boolean) | Whether this user has approved this merge request. |
|
|
| <a id="usermergerequestinteractioncanmerge"></a>`canMerge` | [`Boolean!`](#boolean) | Whether this user can merge this merge request. |
|
|
| <a id="usermergerequestinteractioncanupdate"></a>`canUpdate` | [`Boolean!`](#boolean) | Whether this user can update this merge request. |
|
|
| <a id="usermergerequestinteractionreviewstate"></a>`reviewState` | [`MergeRequestReviewState`](#mergerequestreviewstate) | State of the review by this user. |
|
|
| <a id="usermergerequestinteractionreviewed"></a>`reviewed` | [`Boolean!`](#boolean) | Whether this user has provided a review for this merge request. |
|
|
|
|
### `UserPermissions`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="userpermissionscreatesnippet"></a>`createSnippet` | [`Boolean!`](#boolean) | Indicates the user can perform `create_snippet` on this resource. |
|
|
|
|
### `UserPreferences`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="userpreferencesissuessort"></a>`issuesSort` | [`IssueSort`](#issuesort) | Sort order for issue lists. |
|
|
|
|
### `UserStatus`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="userstatusavailability"></a>`availability` | [`AvailabilityEnum!`](#availabilityenum) | User availability status. |
|
|
| <a id="userstatusemoji"></a>`emoji` | [`String`](#string) | String representation of emoji. |
|
|
| <a id="userstatusmessage"></a>`message` | [`String`](#string) | User status message. |
|
|
| <a id="userstatusmessagehtml"></a>`messageHtml` | [`String`](#string) | HTML of the user status message. |
|
|
|
|
### `VulnerabilitiesCountByDay`
|
|
|
|
Represents the count of vulnerabilities by severity on a particular day. This data is retained for 365 days.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitiescountbydaycritical"></a>`critical` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with critical severity. |
|
|
| <a id="vulnerabilitiescountbydaydate"></a>`date` | [`ISO8601Date!`](#iso8601date) | Date for the count. |
|
|
| <a id="vulnerabilitiescountbydayhigh"></a>`high` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with high severity. |
|
|
| <a id="vulnerabilitiescountbydayinfo"></a>`info` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with info severity. |
|
|
| <a id="vulnerabilitiescountbydaylow"></a>`low` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with low severity. |
|
|
| <a id="vulnerabilitiescountbydaymedium"></a>`medium` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with medium severity. |
|
|
| <a id="vulnerabilitiescountbydaytotal"></a>`total` | [`Int!`](#int) | Total number of vulnerabilities on a particular day. |
|
|
| <a id="vulnerabilitiescountbydayunknown"></a>`unknown` | [`Int!`](#int) | Total number of vulnerabilities on a particular day with unknown severity. |
|
|
|
|
### `Vulnerability`
|
|
|
|
Represents a vulnerability.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityconfirmedat"></a>`confirmedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to confirmed. |
|
|
| <a id="vulnerabilityconfirmedby"></a>`confirmedBy` | [`UserCore`](#usercore) | User that confirmed the vulnerability. |
|
|
| <a id="vulnerabilitydescription"></a>`description` | [`String`](#string) | Description of the vulnerability. |
|
|
| <a id="vulnerabilitydescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="vulnerabilitydetails"></a>`details` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Details of the vulnerability. |
|
|
| <a id="vulnerabilitydetectedat"></a>`detectedAt` | [`Time!`](#time) | Timestamp of when the vulnerability was first detected. |
|
|
| <a id="vulnerabilitydiscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="vulnerabilitydismissedat"></a>`dismissedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to dismissed. |
|
|
| <a id="vulnerabilitydismissedby"></a>`dismissedBy` | [`UserCore`](#usercore) | User that dismissed the vulnerability. |
|
|
| <a id="vulnerabilityexternalissuelinks"></a>`externalIssueLinks` | [`VulnerabilityExternalIssueLinkConnection!`](#vulnerabilityexternalissuelinkconnection) | List of external issue links related to the vulnerability. (see [Connections](#connections)) |
|
|
| <a id="vulnerabilityfalsepositive"></a>`falsePositive` | [`Boolean`](#boolean) | Indicates whether the vulnerability is a false positive. |
|
|
| <a id="vulnerabilityhassolutions"></a>`hasSolutions` | [`Boolean`](#boolean) | Indicates whether there is a solution available for this vulnerability. |
|
|
| <a id="vulnerabilityid"></a>`id` | [`ID!`](#id) | GraphQL ID of the vulnerability. |
|
|
| <a id="vulnerabilityidentifiers"></a>`identifiers` | [`[VulnerabilityIdentifier!]!`](#vulnerabilityidentifier) | Identifiers of the vulnerability. |
|
|
| <a id="vulnerabilitylinks"></a>`links` | [`[VulnerabilityLink!]!`](#vulnerabilitylink) | List of links associated with the vulnerability. |
|
|
| <a id="vulnerabilitylocation"></a>`location` | [`VulnerabilityLocation`](#vulnerabilitylocation) | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. |
|
|
| <a id="vulnerabilitymergerequest"></a>`mergeRequest` | [`MergeRequest`](#mergerequest) | Merge request that fixes the vulnerability. |
|
|
| <a id="vulnerabilitymessage"></a>`message` | [`String`](#string) | Short text description of the vulnerability. This may include the finding's specific information. |
|
|
| <a id="vulnerabilitynotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
| <a id="vulnerabilityprimaryidentifier"></a>`primaryIdentifier` | [`VulnerabilityIdentifier`](#vulnerabilityidentifier) | Primary identifier of the vulnerability. |
|
|
| <a id="vulnerabilityproject"></a>`project` | [`Project`](#project) | Project on which the vulnerability was found. |
|
|
| <a id="vulnerabilityreporttype"></a>`reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING, CLUSTER_IMAGE_SCANNING, GENERIC). `Scan Type` in the UI. |
|
|
| <a id="vulnerabilityresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the vulnerability state was changed to resolved. |
|
|
| <a id="vulnerabilityresolvedby"></a>`resolvedBy` | [`UserCore`](#usercore) | User that resolved the vulnerability. |
|
|
| <a id="vulnerabilityresolvedondefaultbranch"></a>`resolvedOnDefaultBranch` | [`Boolean!`](#boolean) | Indicates whether the vulnerability is fixed on the default branch or not. |
|
|
| <a id="vulnerabilityscanner"></a>`scanner` | [`VulnerabilityScanner`](#vulnerabilityscanner) | Scanner metadata for the vulnerability. |
|
|
| <a id="vulnerabilityseverity"></a>`severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL). |
|
|
| <a id="vulnerabilitystate"></a>`state` | [`VulnerabilityState`](#vulnerabilitystate) | State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED). |
|
|
| <a id="vulnerabilitytitle"></a>`title` | [`String`](#string) | Title of the vulnerability. |
|
|
| <a id="vulnerabilityusernotescount"></a>`userNotesCount` | [`Int!`](#int) | Number of user notes attached to the vulnerability. |
|
|
| <a id="vulnerabilityuserpermissions"></a>`userPermissions` | [`VulnerabilityPermissions!`](#vulnerabilitypermissions) | Permissions for the current user on the resource. |
|
|
| <a id="vulnerabilityvulnerabilitypath"></a>`vulnerabilityPath` | [`String`](#string) | URL to the vulnerability's details page. |
|
|
|
|
#### Fields with arguments
|
|
|
|
##### `Vulnerability.issueLinks`
|
|
|
|
List of issue links related to the vulnerability.
|
|
|
|
Returns [`VulnerabilityIssueLinkConnection!`](#vulnerabilityissuelinkconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
###### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityissuelinkslinktype"></a>`linkType` | [`VulnerabilityIssueLinkType`](#vulnerabilityissuelinktype) | Filter issue links by link type. |
|
|
|
|
### `VulnerabilityDetailBase`
|
|
|
|
Represents the vulnerability details base.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailbasedescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailbasefieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailbasename"></a>`name` | [`String`](#string) | Name of the field. |
|
|
|
|
### `VulnerabilityDetailBoolean`
|
|
|
|
Represents the vulnerability details boolean value.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailbooleandescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailbooleanfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailbooleanname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailbooleanvalue"></a>`value` | [`Boolean!`](#boolean) | Value of the field. |
|
|
|
|
### `VulnerabilityDetailCode`
|
|
|
|
Represents the vulnerability details code field.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailcodedescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailcodefieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailcodelang"></a>`lang` | [`String`](#string) | Language of the code. |
|
|
| <a id="vulnerabilitydetailcodename"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailcodevalue"></a>`value` | [`String!`](#string) | Source code. |
|
|
|
|
### `VulnerabilityDetailCommit`
|
|
|
|
Represents the vulnerability details commit field.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailcommitdescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailcommitfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailcommitname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailcommitvalue"></a>`value` | [`String!`](#string) | Commit SHA value. |
|
|
|
|
### `VulnerabilityDetailDiff`
|
|
|
|
Represents the vulnerability details diff field.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetaildiffafter"></a>`after` | [`String!`](#string) | Value of the field after the change. |
|
|
| <a id="vulnerabilitydetaildiffbefore"></a>`before` | [`String!`](#string) | Value of the field before the change. |
|
|
| <a id="vulnerabilitydetaildiffdescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetaildifffieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetaildiffname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
|
|
### `VulnerabilityDetailFileLocation`
|
|
|
|
Represents the vulnerability details location within a file in the project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailfilelocationdescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailfilelocationfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailfilelocationfilename"></a>`fileName` | [`String!`](#string) | File name. |
|
|
| <a id="vulnerabilitydetailfilelocationlineend"></a>`lineEnd` | [`Int!`](#int) | End line number of the file location. |
|
|
| <a id="vulnerabilitydetailfilelocationlinestart"></a>`lineStart` | [`Int!`](#int) | Start line number of the file location. |
|
|
| <a id="vulnerabilitydetailfilelocationname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
|
|
### `VulnerabilityDetailInt`
|
|
|
|
Represents the vulnerability details integer value.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailintdescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailintfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailintname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailintvalue"></a>`value` | [`Int!`](#int) | Value of the field. |
|
|
|
|
### `VulnerabilityDetailList`
|
|
|
|
Represents the vulnerability details list value.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetaillistdescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetaillistfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetaillistitems"></a>`items` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | List of details. |
|
|
| <a id="vulnerabilitydetaillistname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
|
|
### `VulnerabilityDetailMarkdown`
|
|
|
|
Represents the vulnerability details Markdown field.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailmarkdowndescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailmarkdownfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailmarkdownname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailmarkdownvalue"></a>`value` | [`String!`](#string) | Value of the Markdown field. |
|
|
|
|
### `VulnerabilityDetailModuleLocation`
|
|
|
|
Represents the vulnerability details location within a file in the project.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailmodulelocationdescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailmodulelocationfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailmodulelocationmodulename"></a>`moduleName` | [`String!`](#string) | Module name. |
|
|
| <a id="vulnerabilitydetailmodulelocationname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailmodulelocationoffset"></a>`offset` | [`Int!`](#int) | Offset of the module location. |
|
|
|
|
### `VulnerabilityDetailTable`
|
|
|
|
Represents the vulnerability details table value.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailtabledescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailtablefieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailtableheaders"></a>`headers` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Table headers. |
|
|
| <a id="vulnerabilitydetailtablename"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailtablerows"></a>`rows` | [`[VulnerabilityDetail!]!`](#vulnerabilitydetail) | Table rows. |
|
|
|
|
### `VulnerabilityDetailText`
|
|
|
|
Represents the vulnerability details text field.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailtextdescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailtextfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailtextname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailtextvalue"></a>`value` | [`String!`](#string) | Value of the text field. |
|
|
|
|
### `VulnerabilityDetailUrl`
|
|
|
|
Represents the vulnerability details URL field.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitydetailurldescription"></a>`description` | [`String`](#string) | Description of the field. |
|
|
| <a id="vulnerabilitydetailurlfieldname"></a>`fieldName` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailurlhref"></a>`href` | [`String!`](#string) | Href of the URL. |
|
|
| <a id="vulnerabilitydetailurlname"></a>`name` | [`String`](#string) | Name of the field. |
|
|
| <a id="vulnerabilitydetailurltext"></a>`text` | [`String`](#string) | Text of the URL. |
|
|
|
|
### `VulnerabilityEvidence`
|
|
|
|
Represents a Vulnerability Evidence.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityevidencerequest"></a>`request` | [`VulnerabilityRequest`](#vulnerabilityrequest) | HTTP request of the Vulnerability Evidence. |
|
|
| <a id="vulnerabilityevidenceresponse"></a>`response` | [`VulnerabilityResponse`](#vulnerabilityresponse) | HTTP response of the Vulnerability Evidence. |
|
|
| <a id="vulnerabilityevidencesource"></a>`source` | [`VulnerabilityEvidenceSource`](#vulnerabilityevidencesource) | Source of the Vulnerability Evidence. |
|
|
| <a id="vulnerabilityevidencesummary"></a>`summary` | [`String`](#string) | Summary of the Vulnerability Evidence. |
|
|
| <a id="vulnerabilityevidencesupportingmessages"></a>`supportingMessages` | [`[VulnerabilityEvidenceSupportingMessage!]`](#vulnerabilityevidencesupportingmessage) | Supporting messages of the Vulnerability Evidence. |
|
|
|
|
### `VulnerabilityEvidenceSource`
|
|
|
|
Represents a vulnerability evidence.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityevidencesourceidentifier"></a>`identifier` | [`String!`](#string) | ID of the Vulnerability Evidence Source. |
|
|
| <a id="vulnerabilityevidencesourcename"></a>`name` | [`String!`](#string) | Name of the Vulnerability Evidence Source. |
|
|
| <a id="vulnerabilityevidencesourceurl"></a>`url` | [`String`](#string) | URL of the Vulnerability Evidence Source. |
|
|
|
|
### `VulnerabilityEvidenceSupportingMessage`
|
|
|
|
Represents a vulnerability evidence supporting message.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityevidencesupportingmessagename"></a>`name` | [`String!`](#string) | Name of the vulnerability supporting message. |
|
|
| <a id="vulnerabilityevidencesupportingmessagerequest"></a>`request` | [`VulnerabilityRequest`](#vulnerabilityrequest) | HTTP request of the vulnerability evidence supporting message. |
|
|
| <a id="vulnerabilityevidencesupportingmessageresponse"></a>`response` | [`VulnerabilityResponse`](#vulnerabilityresponse) | HTTP response of the vulnerability evidence supporting message. |
|
|
|
|
### `VulnerabilityExternalIssueLink`
|
|
|
|
Represents an external issue link of a vulnerability.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityexternalissuelinkexternalissue"></a>`externalIssue` | [`ExternalIssue`](#externalissue) | The external issue attached to the issue link. |
|
|
| <a id="vulnerabilityexternalissuelinkid"></a>`id` | [`VulnerabilitiesExternalIssueLinkID!`](#vulnerabilitiesexternalissuelinkid) | GraphQL ID of the external issue link. |
|
|
| <a id="vulnerabilityexternalissuelinklinktype"></a>`linkType` | [`VulnerabilityExternalIssueLinkType!`](#vulnerabilityexternalissuelinktype) | Type of the external issue link. |
|
|
|
|
### `VulnerabilityIdentifier`
|
|
|
|
Represents a vulnerability identifier.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityidentifierexternalid"></a>`externalId` | [`String`](#string) | External ID of the vulnerability identifier. |
|
|
| <a id="vulnerabilityidentifierexternaltype"></a>`externalType` | [`String`](#string) | External type of the vulnerability identifier. |
|
|
| <a id="vulnerabilityidentifiername"></a>`name` | [`String`](#string) | Name of the vulnerability identifier. |
|
|
| <a id="vulnerabilityidentifierurl"></a>`url` | [`String`](#string) | URL of the vulnerability identifier. |
|
|
|
|
### `VulnerabilityIssueLink`
|
|
|
|
Represents an issue link of a vulnerability.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityissuelinkid"></a>`id` | [`ID!`](#id) | GraphQL ID of the vulnerability. |
|
|
| <a id="vulnerabilityissuelinkissue"></a>`issue` | [`Issue`](#issue) | Issue attached to issue link. |
|
|
| <a id="vulnerabilityissuelinklinktype"></a>`linkType` | [`VulnerabilityIssueLinkType!`](#vulnerabilityissuelinktype) | Type of the issue link. |
|
|
|
|
### `VulnerabilityLink`
|
|
|
|
Represents a link related to a vulnerability.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylinkname"></a>`name` | [`String`](#string) | Name of the link. |
|
|
| <a id="vulnerabilitylinkurl"></a>`url` | [`String!`](#string) | URL of the link. |
|
|
|
|
### `VulnerabilityLocationClusterImageScanning`
|
|
|
|
Represents the location of a vulnerability found by a cluster image scan.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylocationclusterimagescanningdependency"></a>`dependency` | [`VulnerableDependency`](#vulnerabledependency) | Dependency containing the vulnerability. |
|
|
| <a id="vulnerabilitylocationclusterimagescanningimage"></a>`image` | [`String`](#string) | Name of the vulnerable container image. |
|
|
| <a id="vulnerabilitylocationclusterimagescanningkubernetesresource"></a>`kubernetesResource` | [`VulnerableKubernetesResource`](#vulnerablekubernetesresource) | Kubernetes resource which uses the vulnerable container image. |
|
|
| <a id="vulnerabilitylocationclusterimagescanningoperatingsystem"></a>`operatingSystem` | [`String`](#string) | Operating system that runs on the vulnerable container image. |
|
|
|
|
### `VulnerabilityLocationContainerScanning`
|
|
|
|
Represents the location of a vulnerability found by a container security scan.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylocationcontainerscanningdependency"></a>`dependency` | [`VulnerableDependency`](#vulnerabledependency) | Dependency containing the vulnerability. |
|
|
| <a id="vulnerabilitylocationcontainerscanningimage"></a>`image` | [`String`](#string) | Name of the vulnerable container image. |
|
|
| <a id="vulnerabilitylocationcontainerscanningoperatingsystem"></a>`operatingSystem` | [`String`](#string) | Operating system that runs on the vulnerable container image. |
|
|
|
|
### `VulnerabilityLocationCoverageFuzzing`
|
|
|
|
Represents the location of a vulnerability found by a Coverage Fuzzing scan.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingblobpath"></a>`blobPath` | [`String`](#string) | Blob path to the vulnerable file. |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingcrashaddress"></a>`crashAddress` | [`String`](#string) | Relative address in memory were the crash occurred. |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingcrashtype"></a>`crashType` | [`String`](#string) | Type of the crash. |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingendline"></a>`endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingfile"></a>`file` | [`String`](#string) | Path to the vulnerable file. |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingstacktracesnippet"></a>`stacktraceSnippet` | [`String`](#string) | Stack trace recorded during fuzzing resulting the crash. |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingstartline"></a>`startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingvulnerableclass"></a>`vulnerableClass` | [`String`](#string) | Class containing the vulnerability. |
|
|
| <a id="vulnerabilitylocationcoveragefuzzingvulnerablemethod"></a>`vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. |
|
|
|
|
### `VulnerabilityLocationDast`
|
|
|
|
Represents the location of a vulnerability found by a DAST scan.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylocationdasthostname"></a>`hostname` | [`String`](#string) | Domain name of the vulnerable request. |
|
|
| <a id="vulnerabilitylocationdastparam"></a>`param` | [`String`](#string) | Query parameter for the URL on which the vulnerability occurred. |
|
|
| <a id="vulnerabilitylocationdastpath"></a>`path` | [`String`](#string) | URL path and query string of the vulnerable request. |
|
|
| <a id="vulnerabilitylocationdastrequestmethod"></a>`requestMethod` | [`String`](#string) | HTTP method of the vulnerable request. |
|
|
|
|
### `VulnerabilityLocationDependencyScanning`
|
|
|
|
Represents the location of a vulnerability found by a dependency security scan.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylocationdependencyscanningblobpath"></a>`blobPath` | [`String`](#string) | Blob path to the vulnerable file. |
|
|
| <a id="vulnerabilitylocationdependencyscanningdependency"></a>`dependency` | [`VulnerableDependency`](#vulnerabledependency) | Dependency containing the vulnerability. |
|
|
| <a id="vulnerabilitylocationdependencyscanningfile"></a>`file` | [`String`](#string) | Path to the vulnerable file. |
|
|
|
|
### `VulnerabilityLocationGeneric`
|
|
|
|
Represents the location of a vulnerability found by a generic scanner.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylocationgenericdescription"></a>`description` | [`String`](#string) | Free-form description of where the vulnerability is located. |
|
|
|
|
### `VulnerabilityLocationSast`
|
|
|
|
Represents the location of a vulnerability found by a SAST scan.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylocationsastblobpath"></a>`blobPath` | [`String`](#string) | Blob path to the vulnerable file. |
|
|
| <a id="vulnerabilitylocationsastendline"></a>`endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. |
|
|
| <a id="vulnerabilitylocationsastfile"></a>`file` | [`String`](#string) | Path to the vulnerable file. |
|
|
| <a id="vulnerabilitylocationsaststartline"></a>`startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. |
|
|
| <a id="vulnerabilitylocationsastvulnerableclass"></a>`vulnerableClass` | [`String`](#string) | Class containing the vulnerability. |
|
|
| <a id="vulnerabilitylocationsastvulnerablemethod"></a>`vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. |
|
|
|
|
### `VulnerabilityLocationSecretDetection`
|
|
|
|
Represents the location of a vulnerability found by a secret detection scan.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitylocationsecretdetectionblobpath"></a>`blobPath` | [`String`](#string) | Blob path to the vulnerable file. |
|
|
| <a id="vulnerabilitylocationsecretdetectionendline"></a>`endLine` | [`String`](#string) | Number of the last relevant line in the vulnerable file. |
|
|
| <a id="vulnerabilitylocationsecretdetectionfile"></a>`file` | [`String`](#string) | Path to the vulnerable file. |
|
|
| <a id="vulnerabilitylocationsecretdetectionstartline"></a>`startLine` | [`String`](#string) | Number of the first relevant line in the vulnerable file. |
|
|
| <a id="vulnerabilitylocationsecretdetectionvulnerableclass"></a>`vulnerableClass` | [`String`](#string) | Class containing the vulnerability. |
|
|
| <a id="vulnerabilitylocationsecretdetectionvulnerablemethod"></a>`vulnerableMethod` | [`String`](#string) | Method containing the vulnerability. |
|
|
|
|
### `VulnerabilityPermissions`
|
|
|
|
Check permissions for the current user on a vulnerability.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilitypermissionsadminvulnerability"></a>`adminVulnerability` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability` on this resource. |
|
|
| <a id="vulnerabilitypermissionsadminvulnerabilityexternalissuelink"></a>`adminVulnerabilityExternalIssueLink` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability_external_issue_link` on this resource. |
|
|
| <a id="vulnerabilitypermissionsadminvulnerabilityissuelink"></a>`adminVulnerabilityIssueLink` | [`Boolean!`](#boolean) | Indicates the user can perform `admin_vulnerability_issue_link` on this resource. |
|
|
| <a id="vulnerabilitypermissionscreatevulnerability"></a>`createVulnerability` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability` on this resource. |
|
|
| <a id="vulnerabilitypermissionscreatevulnerabilityexport"></a>`createVulnerabilityExport` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability_export` on this resource. |
|
|
| <a id="vulnerabilitypermissionscreatevulnerabilityfeedback"></a>`createVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `create_vulnerability_feedback` on this resource. |
|
|
| <a id="vulnerabilitypermissionsdestroyvulnerabilityfeedback"></a>`destroyVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `destroy_vulnerability_feedback` on this resource. |
|
|
| <a id="vulnerabilitypermissionsreadvulnerabilityfeedback"></a>`readVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `read_vulnerability_feedback` on this resource. |
|
|
| <a id="vulnerabilitypermissionsupdatevulnerabilityfeedback"></a>`updateVulnerabilityFeedback` | [`Boolean!`](#boolean) | Indicates the user can perform `update_vulnerability_feedback` on this resource. |
|
|
|
|
### `VulnerabilityRequest`
|
|
|
|
Represents a Vulnerability Request.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityrequestbody"></a>`body` | [`String`](#string) | Body of the Vulnerability Request. |
|
|
| <a id="vulnerabilityrequestheaders"></a>`headers` | [`[VulnerabilityRequestResponseHeader!]!`](#vulnerabilityrequestresponseheader) | HTTP headers of the Vulnerability Request. |
|
|
| <a id="vulnerabilityrequestmethod"></a>`method` | [`String`](#string) | Method of the Vulnerability Request. |
|
|
| <a id="vulnerabilityrequesturl"></a>`url` | [`String`](#string) | URL of the Vulnerability Request. |
|
|
|
|
### `VulnerabilityRequestResponseHeader`
|
|
|
|
Represents a Vulnerability Request/Response Header.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityrequestresponseheadername"></a>`name` | [`String`](#string) | Name of the Vulnerability Request/Response Header. |
|
|
| <a id="vulnerabilityrequestresponseheadervalue"></a>`value` | [`String`](#string) | Value of the Vulnerability Request/Response Header. |
|
|
|
|
### `VulnerabilityResponse`
|
|
|
|
Represents a Vulnerability Response.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityresponsebody"></a>`body` | [`String`](#string) | Body of the Vulnerability Response. |
|
|
| <a id="vulnerabilityresponseheaders"></a>`headers` | [`[VulnerabilityRequestResponseHeader!]!`](#vulnerabilityrequestresponseheader) | HTTP headers of the Vulnerability Response. |
|
|
| <a id="vulnerabilityresponsereasonphrase"></a>`reasonPhrase` | [`String`](#string) | Reason Phrase of the Vulnerability Response. |
|
|
| <a id="vulnerabilityresponsestatuscode"></a>`statusCode` | [`Int`](#int) | Status Code of the Vulnerability Response. |
|
|
|
|
### `VulnerabilityScanner`
|
|
|
|
Represents a vulnerability scanner.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityscannerexternalid"></a>`externalId` | [`String`](#string) | External ID of the vulnerability scanner. |
|
|
| <a id="vulnerabilityscannerid"></a>`id` | [`ID`](#id) | ID of the scanner. |
|
|
| <a id="vulnerabilityscannername"></a>`name` | [`String`](#string) | Name of the vulnerability scanner. |
|
|
| <a id="vulnerabilityscannerreporttype"></a>`reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the vulnerability report. |
|
|
| <a id="vulnerabilityscannervendor"></a>`vendor` | [`String`](#string) | Vendor of the vulnerability scanner. |
|
|
|
|
### `VulnerabilitySeveritiesCount`
|
|
|
|
Represents vulnerability counts by severity.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityseveritiescountcritical"></a>`critical` | [`Int`](#int) | Number of vulnerabilities of CRITICAL severity of the project. |
|
|
| <a id="vulnerabilityseveritiescounthigh"></a>`high` | [`Int`](#int) | Number of vulnerabilities of HIGH severity of the project. |
|
|
| <a id="vulnerabilityseveritiescountinfo"></a>`info` | [`Int`](#int) | Number of vulnerabilities of INFO severity of the project. |
|
|
| <a id="vulnerabilityseveritiescountlow"></a>`low` | [`Int`](#int) | Number of vulnerabilities of LOW severity of the project. |
|
|
| <a id="vulnerabilityseveritiescountmedium"></a>`medium` | [`Int`](#int) | Number of vulnerabilities of MEDIUM severity of the project. |
|
|
| <a id="vulnerabilityseveritiescountunknown"></a>`unknown` | [`Int`](#int) | Number of vulnerabilities of UNKNOWN severity of the project. |
|
|
|
|
### `VulnerableDependency`
|
|
|
|
Represents a vulnerable dependency. Used in vulnerability location data.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabledependencypackage"></a>`package` | [`VulnerablePackage`](#vulnerablepackage) | Package associated with the vulnerable dependency. |
|
|
| <a id="vulnerabledependencyversion"></a>`version` | [`String`](#string) | Version of the vulnerable dependency. |
|
|
|
|
### `VulnerableKubernetesResource`
|
|
|
|
Represents a vulnerable Kubernetes resource. Used in vulnerability location data.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerablekubernetesresourceagent"></a>`agent` | [`ClusterAgent`](#clusteragent) | Kubernetes Agent which performed the scan. |
|
|
| <a id="vulnerablekubernetesresourceclusterid"></a>`clusterId` | [`ClustersClusterID`](#clustersclusterid) | ID of the Cluster integration which was used to perform the scan. |
|
|
| <a id="vulnerablekubernetesresourcecontainername"></a>`containerName` | [`String!`](#string) | Name of the container that had its image scanned. |
|
|
| <a id="vulnerablekubernetesresourcekind"></a>`kind` | [`String!`](#string) | Kind of the Kubernetes resource. |
|
|
| <a id="vulnerablekubernetesresourcename"></a>`name` | [`String!`](#string) | Name of the Kubernetes resource. |
|
|
| <a id="vulnerablekubernetesresourcenamespace"></a>`namespace` | [`String!`](#string) | Kubernetes namespace which the resource resides in. |
|
|
|
|
### `VulnerablePackage`
|
|
|
|
Represents a vulnerable package. Used in vulnerability dependency data.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerablepackagename"></a>`name` | [`String`](#string) | Name of the vulnerable package. |
|
|
|
|
### `VulnerableProjectsByGrade`
|
|
|
|
Represents vulnerability letter grades with associated projects.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerableprojectsbygradecount"></a>`count` | [`Int!`](#int) | Number of projects within this grade. |
|
|
| <a id="vulnerableprojectsbygradegrade"></a>`grade` | [`VulnerabilityGrade!`](#vulnerabilitygrade) | Grade based on the highest severity vulnerability present. |
|
|
| <a id="vulnerableprojectsbygradeprojects"></a>`projects` | [`ProjectConnection!`](#projectconnection) | Projects within this grade. (see [Connections](#connections)) |
|
|
|
|
### `WorkItem`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemdescription"></a>`description` | [`String`](#string) | Description of the work item. |
|
|
| <a id="workitemdescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="workitemid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the work item. |
|
|
| <a id="workitemiid"></a>`iid` | [`ID!`](#id) | Internal ID of the work item. |
|
|
| <a id="workitemlockversion"></a>`lockVersion` | [`Int!`](#int) | Lock version of the work item. Incremented each time the work item is updated. |
|
|
| <a id="workitemstate"></a>`state` | [`WorkItemState!`](#workitemstate) | State of the work item. |
|
|
| <a id="workitemtitle"></a>`title` | [`String!`](#string) | Title of the work item. |
|
|
| <a id="workitemtitlehtml"></a>`titleHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `title`. |
|
|
| <a id="workitemuserpermissions"></a>`userPermissions` | [`WorkItemPermissions!`](#workitempermissions) | Permissions for the current user on the resource. |
|
|
| <a id="workitemwidgets"></a>`widgets` | [`[WorkItemWidget!]`](#workitemwidget) | Collection of widgets that belong to the work item. |
|
|
| <a id="workitemworkitemtype"></a>`workItemType` | [`WorkItemType!`](#workitemtype) | Type assigned to the work item. |
|
|
|
|
### `WorkItemPermissions`
|
|
|
|
Check permissions for the current user on a work item.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitempermissionsdeleteworkitem"></a>`deleteWorkItem` | [`Boolean!`](#boolean) | Indicates the user can perform `delete_work_item` on this resource. |
|
|
| <a id="workitempermissionsreadworkitem"></a>`readWorkItem` | [`Boolean!`](#boolean) | Indicates the user can perform `read_work_item` on this resource. |
|
|
| <a id="workitempermissionsupdateworkitem"></a>`updateWorkItem` | [`Boolean!`](#boolean) | Indicates the user can perform `update_work_item` on this resource. |
|
|
|
|
### `WorkItemType`
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemtypeiconname"></a>`iconName` | [`String`](#string) | Icon name of the work item type. |
|
|
| <a id="workitemtypeid"></a>`id` | [`WorkItemsTypeID!`](#workitemstypeid) | Global ID of the work item type. |
|
|
| <a id="workitemtypename"></a>`name` | [`String!`](#string) | Name of the work item type. |
|
|
|
|
### `WorkItemWidgetDescription`
|
|
|
|
Represents a description widget.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemwidgetdescriptiondescription"></a>`description` | [`String`](#string) | Description of the work item. |
|
|
| <a id="workitemwidgetdescriptiondescriptionhtml"></a>`descriptionHtml` | [`String`](#string) | The GitLab Flavored Markdown rendering of `description`. |
|
|
| <a id="workitemwidgetdescriptiontype"></a>`type` | [`WorkItemWidgetType`](#workitemwidgettype) | Widget type. |
|
|
|
|
### `WorkItemWidgetHierarchy`
|
|
|
|
Represents a hierarchy widget.
|
|
|
|
#### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemwidgethierarchychildren"></a>`children` | [`WorkItemConnection`](#workitemconnection) | Child work items. (see [Connections](#connections)) |
|
|
| <a id="workitemwidgethierarchyparent"></a>`parent` | [`WorkItem`](#workitem) | Parent work item. |
|
|
| <a id="workitemwidgethierarchytype"></a>`type` | [`WorkItemWidgetType`](#workitemwidgettype) | Widget type. |
|
|
|
|
## Enumeration types
|
|
|
|
Also called _Enums_, enumeration types are a special kind of scalar that
|
|
is restricted to a particular set of allowed values.
|
|
|
|
For more information, see
|
|
[Enumeration Types](https://graphql.org/learn/schema/#enumeration-types)
|
|
on `graphql.org`.
|
|
|
|
### `AccessLevelEnum`
|
|
|
|
Access level to a resource.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="accesslevelenumdeveloper"></a>`DEVELOPER` | Developer access. |
|
|
| <a id="accesslevelenumguest"></a>`GUEST` | Guest access. |
|
|
| <a id="accesslevelenummaintainer"></a>`MAINTAINER` | Maintainer access. |
|
|
| <a id="accesslevelenumminimal_access"></a>`MINIMAL_ACCESS` | Minimal access. |
|
|
| <a id="accesslevelenumno_access"></a>`NO_ACCESS` | No access. |
|
|
| <a id="accesslevelenumowner"></a>`OWNER` | Owner access. |
|
|
| <a id="accesslevelenumreporter"></a>`REPORTER` | Reporter access. |
|
|
|
|
### `AgentTokenStatus`
|
|
|
|
Agent token statuses.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="agenttokenstatusactive"></a>`ACTIVE` | Active agent token. |
|
|
| <a id="agenttokenstatusrevoked"></a>`REVOKED` | Revoked agent token. |
|
|
|
|
### `AlertManagementAlertSort`
|
|
|
|
Values for sorting alerts.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="alertmanagementalertsortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. |
|
|
| <a id="alertmanagementalertsortcreated_desc"></a>`CREATED_DESC` | Created at descending order. |
|
|
| <a id="alertmanagementalertsortcreated_time_asc"></a>`CREATED_TIME_ASC` | Created time by ascending order. |
|
|
| <a id="alertmanagementalertsortcreated_time_desc"></a>`CREATED_TIME_DESC` | Created time by descending order. |
|
|
| <a id="alertmanagementalertsortended_at_asc"></a>`ENDED_AT_ASC` | End time by ascending order. |
|
|
| <a id="alertmanagementalertsortended_at_desc"></a>`ENDED_AT_DESC` | End time by descending order. |
|
|
| <a id="alertmanagementalertsortevent_count_asc"></a>`EVENT_COUNT_ASC` | Events count by ascending order. |
|
|
| <a id="alertmanagementalertsortevent_count_desc"></a>`EVENT_COUNT_DESC` | Events count by descending order. |
|
|
| <a id="alertmanagementalertsortseverity_asc"></a>`SEVERITY_ASC` | Severity from less critical to more critical. |
|
|
| <a id="alertmanagementalertsortseverity_desc"></a>`SEVERITY_DESC` | Severity from more critical to less critical. |
|
|
| <a id="alertmanagementalertsortstarted_at_asc"></a>`STARTED_AT_ASC` | Start time by ascending order. |
|
|
| <a id="alertmanagementalertsortstarted_at_desc"></a>`STARTED_AT_DESC` | Start time by descending order. |
|
|
| <a id="alertmanagementalertsortstatus_asc"></a>`STATUS_ASC` | Status by order: `Ignored > Resolved > Acknowledged > Triggered`. |
|
|
| <a id="alertmanagementalertsortstatus_desc"></a>`STATUS_DESC` | Status by order: `Triggered > Acknowledged > Resolved > Ignored`. |
|
|
| <a id="alertmanagementalertsortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. |
|
|
| <a id="alertmanagementalertsortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. |
|
|
| <a id="alertmanagementalertsortupdated_time_asc"></a>`UPDATED_TIME_ASC` | Created time by ascending order. |
|
|
| <a id="alertmanagementalertsortupdated_time_desc"></a>`UPDATED_TIME_DESC` | Created time by descending order. |
|
|
| <a id="alertmanagementalertsortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_ASC`. |
|
|
| <a id="alertmanagementalertsortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_DESC`. |
|
|
| <a id="alertmanagementalertsortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_ASC`. |
|
|
| <a id="alertmanagementalertsortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_DESC`. |
|
|
|
|
### `AlertManagementDomainFilter`
|
|
|
|
Filters the alerts based on given domain.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="alertmanagementdomainfilteroperations"></a>`operations` | Alerts for operations domain. |
|
|
| <a id="alertmanagementdomainfilterthreat_monitoring"></a>`threat_monitoring` **{warning-solid}** | **Deprecated** in 15.0. Network policies are deprecated and will be removed in GitLab 16.0. |
|
|
|
|
### `AlertManagementIntegrationType`
|
|
|
|
Values of types of integrations.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="alertmanagementintegrationtypehttp"></a>`HTTP` | Integration with any monitoring tool. |
|
|
| <a id="alertmanagementintegrationtypeprometheus"></a>`PROMETHEUS` | Prometheus integration. |
|
|
|
|
### `AlertManagementPayloadAlertFieldName`
|
|
|
|
Values for alert field names used in the custom mapping.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="alertmanagementpayloadalertfieldnamedescription"></a>`DESCRIPTION` | A high-level summary of the problem. |
|
|
| <a id="alertmanagementpayloadalertfieldnameend_time"></a>`END_TIME` | The resolved time of the incident. |
|
|
| <a id="alertmanagementpayloadalertfieldnamefingerprint"></a>`FINGERPRINT` | The unique identifier of the alert. This can be used to group occurrences of the same alert. |
|
|
| <a id="alertmanagementpayloadalertfieldnamegitlab_environment_name"></a>`GITLAB_ENVIRONMENT_NAME` | The name of the associated GitLab environment. |
|
|
| <a id="alertmanagementpayloadalertfieldnamehosts"></a>`HOSTS` | One or more hosts, as to where this incident occurred. |
|
|
| <a id="alertmanagementpayloadalertfieldnamemonitoring_tool"></a>`MONITORING_TOOL` | The name of the associated monitoring tool. |
|
|
| <a id="alertmanagementpayloadalertfieldnameservice"></a>`SERVICE` | The affected service. |
|
|
| <a id="alertmanagementpayloadalertfieldnameseverity"></a>`SEVERITY` | The severity of the alert. |
|
|
| <a id="alertmanagementpayloadalertfieldnamestart_time"></a>`START_TIME` | The time of the incident. |
|
|
| <a id="alertmanagementpayloadalertfieldnametitle"></a>`TITLE` | The title of the incident. |
|
|
|
|
### `AlertManagementPayloadAlertFieldType`
|
|
|
|
Values for alert field types used in the custom mapping.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="alertmanagementpayloadalertfieldtypearray"></a>`ARRAY` | Array field type. |
|
|
| <a id="alertmanagementpayloadalertfieldtypedatetime"></a>`DATETIME` | DateTime field type. |
|
|
| <a id="alertmanagementpayloadalertfieldtypestring"></a>`STRING` | String field type. |
|
|
|
|
### `AlertManagementSeverity`
|
|
|
|
Alert severity values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="alertmanagementseveritycritical"></a>`CRITICAL` | Critical severity. |
|
|
| <a id="alertmanagementseverityhigh"></a>`HIGH` | High severity. |
|
|
| <a id="alertmanagementseverityinfo"></a>`INFO` | Info severity. |
|
|
| <a id="alertmanagementseveritylow"></a>`LOW` | Low severity. |
|
|
| <a id="alertmanagementseveritymedium"></a>`MEDIUM` | Medium severity. |
|
|
| <a id="alertmanagementseverityunknown"></a>`UNKNOWN` | Unknown severity. |
|
|
|
|
### `AlertManagementStatus`
|
|
|
|
Alert status values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="alertmanagementstatusacknowledged"></a>`ACKNOWLEDGED` | Someone is actively investigating the problem. |
|
|
| <a id="alertmanagementstatusignored"></a>`IGNORED` | No action will be taken. |
|
|
| <a id="alertmanagementstatusresolved"></a>`RESOLVED` | The problem has been addressed. |
|
|
| <a id="alertmanagementstatustriggered"></a>`TRIGGERED` | Investigation has not started. |
|
|
|
|
### `ApiFuzzingScanMode`
|
|
|
|
All possible ways to specify the API surface for an API fuzzing scan.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="apifuzzingscanmodehar"></a>`HAR` | The API surface is specified by a HAR file. |
|
|
| <a id="apifuzzingscanmodeopenapi"></a>`OPENAPI` | The API surface is specified by a OPENAPI file. |
|
|
| <a id="apifuzzingscanmodepostman"></a>`POSTMAN` | The API surface is specified by a POSTMAN file. |
|
|
|
|
### `ApprovalRuleType`
|
|
|
|
The kind of an approval rule.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="approvalruletypeany_approver"></a>`ANY_APPROVER` | A `any_approver` approval rule. |
|
|
| <a id="approvalruletypecode_owner"></a>`CODE_OWNER` | A `code_owner` approval rule. |
|
|
| <a id="approvalruletyperegular"></a>`REGULAR` | A `regular` approval rule. |
|
|
| <a id="approvalruletypereport_approver"></a>`REPORT_APPROVER` | A `report_approver` approval rule. |
|
|
|
|
### `AssigneeWildcardId`
|
|
|
|
Assignee ID wildcard values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="assigneewildcardidany"></a>`ANY` | An assignee is assigned. |
|
|
| <a id="assigneewildcardidnone"></a>`NONE` | No assignee is assigned. |
|
|
|
|
### `AvailabilityEnum`
|
|
|
|
User availability status.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="availabilityenumbusy"></a>`BUSY` | Busy. |
|
|
| <a id="availabilityenumnot_set"></a>`NOT_SET` | Not Set. |
|
|
|
|
### `BlobViewersType`
|
|
|
|
Types of blob viewers.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="blobviewerstypeauxiliary"></a>`auxiliary` | Auxiliary blob viewers type. |
|
|
| <a id="blobviewerstyperich"></a>`rich` | Rich blob viewers type. |
|
|
| <a id="blobviewerstypesimple"></a>`simple` | Simple blob viewers type. |
|
|
|
|
### `CiConfigIncludeType`
|
|
|
|
Include type.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="ciconfigincludetypefile"></a>`file` | Project file include. |
|
|
| <a id="ciconfigincludetypelocal"></a>`local` | Local include. |
|
|
| <a id="ciconfigincludetyperemote"></a>`remote` | Remote include. |
|
|
| <a id="ciconfigincludetypetemplate"></a>`template` | Template include. |
|
|
|
|
### `CiConfigStatus`
|
|
|
|
Values for YAML processor result.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="ciconfigstatusinvalid"></a>`INVALID` | Configuration file is not valid. |
|
|
| <a id="ciconfigstatusvalid"></a>`VALID` | Configuration file is valid. |
|
|
|
|
### `CiJobKind`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="cijobkindbridge"></a>`BRIDGE` | Bridge CI job connecting a parent and child pipeline. |
|
|
| <a id="cijobkindbuild"></a>`BUILD` | Standard CI job. |
|
|
|
|
### `CiJobStatus`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="cijobstatuscanceled"></a>`CANCELED` | A job that is canceled. |
|
|
| <a id="cijobstatuscreated"></a>`CREATED` | A job that is created. |
|
|
| <a id="cijobstatusfailed"></a>`FAILED` | A job that is failed. |
|
|
| <a id="cijobstatusmanual"></a>`MANUAL` | A job that is manual. |
|
|
| <a id="cijobstatuspending"></a>`PENDING` | A job that is pending. |
|
|
| <a id="cijobstatuspreparing"></a>`PREPARING` | A job that is preparing. |
|
|
| <a id="cijobstatusrunning"></a>`RUNNING` | A job that is running. |
|
|
| <a id="cijobstatusscheduled"></a>`SCHEDULED` | A job that is scheduled. |
|
|
| <a id="cijobstatusskipped"></a>`SKIPPED` | A job that is skipped. |
|
|
| <a id="cijobstatussuccess"></a>`SUCCESS` | A job that is success. |
|
|
| <a id="cijobstatuswaiting_for_resource"></a>`WAITING_FOR_RESOURCE` | A job that is waiting for resource. |
|
|
|
|
### `CiRunnerAccessLevel`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="cirunneraccesslevelnot_protected"></a>`NOT_PROTECTED` | A runner that is not protected. |
|
|
| <a id="cirunneraccesslevelref_protected"></a>`REF_PROTECTED` | A runner that is ref protected. |
|
|
|
|
### `CiRunnerSort`
|
|
|
|
Values for sorting runners.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="cirunnersortcontacted_asc"></a>`CONTACTED_ASC` | Ordered by contacted_at in ascending order. |
|
|
| <a id="cirunnersortcontacted_desc"></a>`CONTACTED_DESC` | Ordered by contacted_at in descending order. |
|
|
| <a id="cirunnersortcreated_asc"></a>`CREATED_ASC` | Ordered by created_at in ascending order. |
|
|
| <a id="cirunnersortcreated_desc"></a>`CREATED_DESC` | Ordered by created_at in descending order. |
|
|
| <a id="cirunnersorttoken_expires_at_asc"></a>`TOKEN_EXPIRES_AT_ASC` | Ordered by token_expires_at in ascending order. |
|
|
| <a id="cirunnersorttoken_expires_at_desc"></a>`TOKEN_EXPIRES_AT_DESC` | Ordered by token_expires_at in descending order. |
|
|
|
|
### `CiRunnerStatus`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="cirunnerstatusactive"></a>`ACTIVE` **{warning-solid}** | **Deprecated** in 14.6. This was renamed. Use: [`CiRunner.paused`](#cirunnerpaused). |
|
|
| <a id="cirunnerstatusnever_contacted"></a>`NEVER_CONTACTED` | Runner that has never contacted this instance. |
|
|
| <a id="cirunnerstatusoffline"></a>`OFFLINE` | Runner that has not contacted this instance within the last 2 hours. Will be considered `STALE` if offline for more than 3 months. |
|
|
| <a id="cirunnerstatusonline"></a>`ONLINE` | Runner that contacted this instance within the last 2 hours. |
|
|
| <a id="cirunnerstatuspaused"></a>`PAUSED` **{warning-solid}** | **Deprecated** in 14.6. This was renamed. Use: [`CiRunner.paused`](#cirunnerpaused). |
|
|
| <a id="cirunnerstatusstale"></a>`STALE` | Runner that has not contacted this instance within the last 3 months. |
|
|
|
|
### `CiRunnerType`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="cirunnertypegroup_type"></a>`GROUP_TYPE` | A runner that is group type. |
|
|
| <a id="cirunnertypeinstance_type"></a>`INSTANCE_TYPE` | A runner that is instance type. |
|
|
| <a id="cirunnertypeproject_type"></a>`PROJECT_TYPE` | A runner that is project type. |
|
|
|
|
### `CiRunnerUpgradeStatusType`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="cirunnerupgradestatustypeavailable"></a>`AVAILABLE` | Upgrade is available for the runner. |
|
|
| <a id="cirunnerupgradestatustypeinvalid"></a>`INVALID` | Runner version is not valid. |
|
|
| <a id="cirunnerupgradestatustypenot_available"></a>`NOT_AVAILABLE` | Upgrade is not available for the runner. |
|
|
| <a id="cirunnerupgradestatustyperecommended"></a>`RECOMMENDED` | Upgrade is available and recommended for the runner. |
|
|
| <a id="cirunnerupgradestatustypeunknown"></a>`UNKNOWN` | Upgrade status is unknown. |
|
|
|
|
### `CodeQualityDegradationSeverity`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="codequalitydegradationseverityblocker"></a>`BLOCKER` | Code Quality degradation has a status of blocker. |
|
|
| <a id="codequalitydegradationseveritycritical"></a>`CRITICAL` | Code Quality degradation has a status of critical. |
|
|
| <a id="codequalitydegradationseverityinfo"></a>`INFO` | Code Quality degradation has a status of info. |
|
|
| <a id="codequalitydegradationseveritymajor"></a>`MAJOR` | Code Quality degradation has a status of major. |
|
|
| <a id="codequalitydegradationseverityminor"></a>`MINOR` | Code Quality degradation has a status of minor. |
|
|
| <a id="codequalitydegradationseverityunknown"></a>`UNKNOWN` | Code Quality degradation has a status of unknown. |
|
|
|
|
### `CommitActionMode`
|
|
|
|
Mode of a commit action.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="commitactionmodechmod"></a>`CHMOD` | Chmod command. |
|
|
| <a id="commitactionmodecreate"></a>`CREATE` | Create command. |
|
|
| <a id="commitactionmodedelete"></a>`DELETE` | Delete command. |
|
|
| <a id="commitactionmodemove"></a>`MOVE` | Move command. |
|
|
| <a id="commitactionmodeupdate"></a>`UPDATE` | Update command. |
|
|
|
|
### `CommitEncoding`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="commitencodingbase64"></a>`BASE64` | Base64 encoding. |
|
|
| <a id="commitencodingtext"></a>`TEXT` | Text encoding. |
|
|
|
|
### `ComplianceViolationReason`
|
|
|
|
Reason for the compliance violation.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="complianceviolationreasonapproved_by_committer"></a>`APPROVED_BY_COMMITTER` | Approved by committer. |
|
|
| <a id="complianceviolationreasonapproved_by_insufficient_users"></a>`APPROVED_BY_INSUFFICIENT_USERS` | Approved by insufficient users. |
|
|
| <a id="complianceviolationreasonapproved_by_merge_request_author"></a>`APPROVED_BY_MERGE_REQUEST_AUTHOR` | Approved by merge request author. |
|
|
|
|
### `ComplianceViolationSeverity`
|
|
|
|
Severity of the compliance violation.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="complianceviolationseveritycritical"></a>`CRITICAL` | Critical severity. |
|
|
| <a id="complianceviolationseverityhigh"></a>`HIGH` | High severity. |
|
|
| <a id="complianceviolationseverityinfo"></a>`INFO` | Info severity. |
|
|
| <a id="complianceviolationseveritylow"></a>`LOW` | Low severity. |
|
|
| <a id="complianceviolationseveritymedium"></a>`MEDIUM` | Medium severity. |
|
|
|
|
### `ComplianceViolationSort`
|
|
|
|
Compliance violation sort values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="complianceviolationsortmerged_at_asc"></a>`MERGED_AT_ASC` | Date merged in ascending order, further sorted by ID in ascending order. |
|
|
| <a id="complianceviolationsortmerged_at_desc"></a>`MERGED_AT_DESC` | Date merged in descending order, further sorted by ID in descending order. |
|
|
| <a id="complianceviolationsortmerge_request_title_asc"></a>`MERGE_REQUEST_TITLE_ASC` | Merge request title in ascending order, further sorted by ID in ascending order. |
|
|
| <a id="complianceviolationsortmerge_request_title_desc"></a>`MERGE_REQUEST_TITLE_DESC` | Merge request title in descending order, further sorted by ID in descending order. |
|
|
| <a id="complianceviolationsortseverity_level_asc"></a>`SEVERITY_LEVEL_ASC` | Severity in ascending order, further sorted by ID in ascending order. |
|
|
| <a id="complianceviolationsortseverity_level_desc"></a>`SEVERITY_LEVEL_DESC` | Severity in descending order, further sorted by ID in descending order. |
|
|
| <a id="complianceviolationsortviolation_reason_asc"></a>`VIOLATION_REASON_ASC` | Violation reason in ascending order, further sorted by ID in ascending order. |
|
|
| <a id="complianceviolationsortviolation_reason_desc"></a>`VIOLATION_REASON_DESC` | Violation reason in descending order, further sorted by ID in descending order. |
|
|
|
|
### `ConanMetadatumFileTypeEnum`
|
|
|
|
Conan file types.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="conanmetadatumfiletypeenumpackage_file"></a>`PACKAGE_FILE` | A package file type. |
|
|
| <a id="conanmetadatumfiletypeenumrecipe_file"></a>`RECIPE_FILE` | A recipe file type. |
|
|
|
|
### `ContainerExpirationPolicyCadenceEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="containerexpirationpolicycadenceenumevery_day"></a>`EVERY_DAY` | Every day. |
|
|
| <a id="containerexpirationpolicycadenceenumevery_month"></a>`EVERY_MONTH` | Every month. |
|
|
| <a id="containerexpirationpolicycadenceenumevery_three_months"></a>`EVERY_THREE_MONTHS` | Every three months. |
|
|
| <a id="containerexpirationpolicycadenceenumevery_two_weeks"></a>`EVERY_TWO_WEEKS` | Every two weeks. |
|
|
| <a id="containerexpirationpolicycadenceenumevery_week"></a>`EVERY_WEEK` | Every week. |
|
|
|
|
### `ContainerExpirationPolicyKeepEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="containerexpirationpolicykeepenumfifty_tags"></a>`FIFTY_TAGS` | 50 tags per image name. |
|
|
| <a id="containerexpirationpolicykeepenumfive_tags"></a>`FIVE_TAGS` | 5 tags per image name. |
|
|
| <a id="containerexpirationpolicykeepenumone_hundred_tags"></a>`ONE_HUNDRED_TAGS` | 100 tags per image name. |
|
|
| <a id="containerexpirationpolicykeepenumone_tag"></a>`ONE_TAG` | 1 tag per image name. |
|
|
| <a id="containerexpirationpolicykeepenumten_tags"></a>`TEN_TAGS` | 10 tags per image name. |
|
|
| <a id="containerexpirationpolicykeepenumtwenty_five_tags"></a>`TWENTY_FIVE_TAGS` | 25 tags per image name. |
|
|
|
|
### `ContainerExpirationPolicyOlderThanEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="containerexpirationpolicyolderthanenumfourteen_days"></a>`FOURTEEN_DAYS` | 14 days until tags are automatically removed. |
|
|
| <a id="containerexpirationpolicyolderthanenumninety_days"></a>`NINETY_DAYS` | 90 days until tags are automatically removed. |
|
|
| <a id="containerexpirationpolicyolderthanenumseven_days"></a>`SEVEN_DAYS` | 7 days until tags are automatically removed. |
|
|
| <a id="containerexpirationpolicyolderthanenumsixty_days"></a>`SIXTY_DAYS` | 60 days until tags are automatically removed. |
|
|
| <a id="containerexpirationpolicyolderthanenumthirty_days"></a>`THIRTY_DAYS` | 30 days until tags are automatically removed. |
|
|
|
|
### `ContainerRepositoryCleanupStatus`
|
|
|
|
Status of the tags cleanup of a container repository.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="containerrepositorycleanupstatusongoing"></a>`ONGOING` | Tags cleanup is ongoing. |
|
|
| <a id="containerrepositorycleanupstatusscheduled"></a>`SCHEDULED` | Tags cleanup is scheduled and is going to be executed shortly. |
|
|
| <a id="containerrepositorycleanupstatusunfinished"></a>`UNFINISHED` | Tags cleanup has been partially executed. There are still remaining tags to delete. |
|
|
| <a id="containerrepositorycleanupstatusunscheduled"></a>`UNSCHEDULED` | Tags cleanup is not scheduled. This is the default state. |
|
|
|
|
### `ContainerRepositorySort`
|
|
|
|
Values for sorting container repositories.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="containerrepositorysortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. |
|
|
| <a id="containerrepositorysortcreated_desc"></a>`CREATED_DESC` | Created at descending order. |
|
|
| <a id="containerrepositorysortname_asc"></a>`NAME_ASC` | Name by ascending order. |
|
|
| <a id="containerrepositorysortname_desc"></a>`NAME_DESC` | Name by descending order. |
|
|
| <a id="containerrepositorysortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. |
|
|
| <a id="containerrepositorysortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. |
|
|
| <a id="containerrepositorysortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_ASC`. |
|
|
| <a id="containerrepositorysortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_DESC`. |
|
|
| <a id="containerrepositorysortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_ASC`. |
|
|
| <a id="containerrepositorysortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_DESC`. |
|
|
|
|
### `ContainerRepositoryStatus`
|
|
|
|
Status of a container repository.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="containerrepositorystatusdelete_failed"></a>`DELETE_FAILED` | Delete Failed status. |
|
|
| <a id="containerrepositorystatusdelete_scheduled"></a>`DELETE_SCHEDULED` | Delete Scheduled status. |
|
|
|
|
### `ContainerRepositoryTagSort`
|
|
|
|
Values for sorting tags.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="containerrepositorytagsortname_asc"></a>`NAME_ASC` | Ordered by name in ascending order. |
|
|
| <a id="containerrepositorytagsortname_desc"></a>`NAME_DESC` | Ordered by name in descending order. |
|
|
|
|
### `DastProfileCadenceUnit`
|
|
|
|
Unit for the duration of Dast Profile Cadence.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dastprofilecadenceunitday"></a>`DAY` | DAST Profile Cadence duration in days. |
|
|
| <a id="dastprofilecadenceunitmonth"></a>`MONTH` | DAST Profile Cadence duration in months. |
|
|
| <a id="dastprofilecadenceunitweek"></a>`WEEK` | DAST Profile Cadence duration in weeks. |
|
|
| <a id="dastprofilecadenceunityear"></a>`YEAR` | DAST Profile Cadence duration in years. |
|
|
|
|
### `DastScanMethodType`
|
|
|
|
Scan method to be used by the scanner.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dastscanmethodtypehar"></a>`HAR` | HAR scan method. |
|
|
| <a id="dastscanmethodtypeopenapi"></a>`OPENAPI` | OpenAPI scan method. |
|
|
| <a id="dastscanmethodtypepostman_collection"></a>`POSTMAN_COLLECTION` | Postman scan method. |
|
|
| <a id="dastscanmethodtypewebsite"></a>`WEBSITE` | Website scan method. |
|
|
|
|
### `DastScanTypeEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dastscantypeenumactive"></a>`ACTIVE` | Active DAST scan. This scan will make active attacks against the target site. |
|
|
| <a id="dastscantypeenumpassive"></a>`PASSIVE` | Passive DAST scan. This scan will not make active attacks against the target site. |
|
|
|
|
### `DastSiteProfileValidationStatusEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dastsiteprofilevalidationstatusenumfailed_validation"></a>`FAILED_VALIDATION` | Site validation process finished but failed. |
|
|
| <a id="dastsiteprofilevalidationstatusenuminprogress_validation"></a>`INPROGRESS_VALIDATION` | Site validation process is in progress. |
|
|
| <a id="dastsiteprofilevalidationstatusenumnone"></a>`NONE` | No site validation exists. |
|
|
| <a id="dastsiteprofilevalidationstatusenumpassed_validation"></a>`PASSED_VALIDATION` | Site validation process finished successfully. |
|
|
| <a id="dastsiteprofilevalidationstatusenumpending_validation"></a>`PENDING_VALIDATION` | Site validation process has not started. |
|
|
|
|
### `DastSiteValidationStatusEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dastsitevalidationstatusenumfailed_validation"></a>`FAILED_VALIDATION` | Site validation process finished but failed. |
|
|
| <a id="dastsitevalidationstatusenuminprogress_validation"></a>`INPROGRESS_VALIDATION` | Site validation process is in progress. |
|
|
| <a id="dastsitevalidationstatusenumpassed_validation"></a>`PASSED_VALIDATION` | Site validation process finished successfully. |
|
|
| <a id="dastsitevalidationstatusenumpending_validation"></a>`PENDING_VALIDATION` | Site validation process has not started. |
|
|
|
|
### `DastSiteValidationStrategyEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dastsitevalidationstrategyenumheader"></a>`HEADER` | Header validation. |
|
|
| <a id="dastsitevalidationstrategyenummeta_tag"></a>`META_TAG` | Meta tag validation. |
|
|
| <a id="dastsitevalidationstrategyenumtext_file"></a>`TEXT_FILE` | Text file validation. |
|
|
|
|
### `DastTargetTypeEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dasttargettypeenumapi"></a>`API` | API target. |
|
|
| <a id="dasttargettypeenumwebsite"></a>`WEBSITE` | Website target. |
|
|
|
|
### `DataVisualizationColorEnum`
|
|
|
|
Color of the data visualization palette.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="datavisualizationcolorenumaqua"></a>`AQUA` | Aqua color. |
|
|
| <a id="datavisualizationcolorenumblue"></a>`BLUE` | Blue color. |
|
|
| <a id="datavisualizationcolorenumgreen"></a>`GREEN` | Green color. |
|
|
| <a id="datavisualizationcolorenummagenta"></a>`MAGENTA` | Magenta color. |
|
|
| <a id="datavisualizationcolorenumorange"></a>`ORANGE` | Orange color. |
|
|
|
|
### `DataVisualizationWeightEnum`
|
|
|
|
Weight of the data visualization palette.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="datavisualizationweightenumweight_100"></a>`WEIGHT_100` | 100 weight. |
|
|
| <a id="datavisualizationweightenumweight_200"></a>`WEIGHT_200` | 200 weight. |
|
|
| <a id="datavisualizationweightenumweight_300"></a>`WEIGHT_300` | 300 weight. |
|
|
| <a id="datavisualizationweightenumweight_400"></a>`WEIGHT_400` | 400 weight. |
|
|
| <a id="datavisualizationweightenumweight_50"></a>`WEIGHT_50` | 50 weight. |
|
|
| <a id="datavisualizationweightenumweight_500"></a>`WEIGHT_500` | 500 weight. |
|
|
| <a id="datavisualizationweightenumweight_600"></a>`WEIGHT_600` | 600 weight. |
|
|
| <a id="datavisualizationweightenumweight_700"></a>`WEIGHT_700` | 700 weight. |
|
|
| <a id="datavisualizationweightenumweight_800"></a>`WEIGHT_800` | 800 weight. |
|
|
| <a id="datavisualizationweightenumweight_900"></a>`WEIGHT_900` | 900 weight. |
|
|
| <a id="datavisualizationweightenumweight_950"></a>`WEIGHT_950` | 950 weight. |
|
|
|
|
### `DependencyProxyManifestStatus`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dependencyproxymanifeststatusdefault"></a>`DEFAULT` | Dependency proxy manifest has a status of default. |
|
|
| <a id="dependencyproxymanifeststatuserror"></a>`ERROR` | Dependency proxy manifest has a status of error. |
|
|
| <a id="dependencyproxymanifeststatuspending_destruction"></a>`PENDING_DESTRUCTION` | Dependency proxy manifest has a status of pending_destruction. |
|
|
| <a id="dependencyproxymanifeststatusprocessing"></a>`PROCESSING` | Dependency proxy manifest has a status of processing. |
|
|
|
|
### `DeploymentTier`
|
|
|
|
All environment deployment tiers.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="deploymenttierdevelopment"></a>`DEVELOPMENT` | Development. |
|
|
| <a id="deploymenttierother"></a>`OTHER` | Other. |
|
|
| <a id="deploymenttierproduction"></a>`PRODUCTION` | Production. |
|
|
| <a id="deploymenttierstaging"></a>`STAGING` | Staging. |
|
|
| <a id="deploymenttiertesting"></a>`TESTING` | Testing. |
|
|
|
|
### `DesignCollectionCopyState`
|
|
|
|
Copy state of a DesignCollection.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="designcollectioncopystateerror"></a>`ERROR` | The DesignCollection encountered an error during a copy. |
|
|
| <a id="designcollectioncopystatein_progress"></a>`IN_PROGRESS` | The DesignCollection is being copied. |
|
|
| <a id="designcollectioncopystateready"></a>`READY` | The DesignCollection has no copy in progress. |
|
|
|
|
### `DesignVersionEvent`
|
|
|
|
Mutation event of a design within a version.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="designversioneventcreation"></a>`CREATION` | A creation event. |
|
|
| <a id="designversioneventdeletion"></a>`DELETION` | A deletion event. |
|
|
| <a id="designversioneventmodification"></a>`MODIFICATION` | A modification event. |
|
|
| <a id="designversioneventnone"></a>`NONE` | No change. |
|
|
|
|
### `DiffPositionType`
|
|
|
|
Type of file the position refers to.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="diffpositiontypeimage"></a>`image` | An image. |
|
|
| <a id="diffpositiontypetext"></a>`text` | Text file. |
|
|
|
|
### `DoraMetricBucketingInterval`
|
|
|
|
All possible ways that DORA metrics can be aggregated.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dorametricbucketingintervalall"></a>`ALL` | All data points are combined into a single value. |
|
|
| <a id="dorametricbucketingintervaldaily"></a>`DAILY` | Data points are combined into chunks by day. |
|
|
| <a id="dorametricbucketingintervalmonthly"></a>`MONTHLY` | Data points are combined into chunks by month. |
|
|
|
|
### `DoraMetricType`
|
|
|
|
All supported DORA metric types.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="dorametrictypechange_failure_rate"></a>`CHANGE_FAILURE_RATE` | Change failure rate. |
|
|
| <a id="dorametrictypedeployment_frequency"></a>`DEPLOYMENT_FREQUENCY` | Deployment frequency. |
|
|
| <a id="dorametrictypelead_time_for_changes"></a>`LEAD_TIME_FOR_CHANGES` | Lead time for changes. |
|
|
| <a id="dorametrictypetime_to_restore_service"></a>`TIME_TO_RESTORE_SERVICE` | Time to restore service. |
|
|
|
|
### `EntryType`
|
|
|
|
Type of a tree entry.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="entrytypeblob"></a>`blob` | File tree type. |
|
|
| <a id="entrytypecommit"></a>`commit` | Commit tree type. |
|
|
| <a id="entrytypetree"></a>`tree` | Directory tree type. |
|
|
|
|
### `EpicSort`
|
|
|
|
Roadmap sort values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="epicsortcreated_at_asc"></a>`CREATED_AT_ASC` | Sort by created_at by ascending order. |
|
|
| <a id="epicsortcreated_at_desc"></a>`CREATED_AT_DESC` | Sort by created_at by descending order. |
|
|
| <a id="epicsortend_date_asc"></a>`END_DATE_ASC` | Sort by end date in ascending order. |
|
|
| <a id="epicsortend_date_desc"></a>`END_DATE_DESC` | Sort by end date in descending order. |
|
|
| <a id="epicsortstart_date_asc"></a>`START_DATE_ASC` | Sort by start date in ascending order. |
|
|
| <a id="epicsortstart_date_desc"></a>`START_DATE_DESC` | Sort by start date in descending order. |
|
|
| <a id="epicsorttitle_asc"></a>`TITLE_ASC` | Sort by title in ascending order. |
|
|
| <a id="epicsorttitle_desc"></a>`TITLE_DESC` | Sort by title in descending order. |
|
|
| <a id="epicsortupdated_at_asc"></a>`UPDATED_AT_ASC` | Sort by updated_at by ascending order. |
|
|
| <a id="epicsortupdated_at_desc"></a>`UPDATED_AT_DESC` | Sort by updated_at by descending order. |
|
|
| <a id="epicsortend_date_asc"></a>`end_date_asc` **{warning-solid}** | **Deprecated** in 13.11. Use END_DATE_ASC. |
|
|
| <a id="epicsortend_date_desc"></a>`end_date_desc` **{warning-solid}** | **Deprecated** in 13.11. Use END_DATE_DESC. |
|
|
| <a id="epicsortstart_date_asc"></a>`start_date_asc` **{warning-solid}** | **Deprecated** in 13.11. Use START_DATE_ASC. |
|
|
| <a id="epicsortstart_date_desc"></a>`start_date_desc` **{warning-solid}** | **Deprecated** in 13.11. Use START_DATE_DESC. |
|
|
|
|
### `EpicState`
|
|
|
|
State of an epic.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="epicstateall"></a>`all` | All epics. |
|
|
| <a id="epicstateclosed"></a>`closed` | Closed epics. |
|
|
| <a id="epicstateopened"></a>`opened` | Open epics. |
|
|
|
|
### `EpicStateEvent`
|
|
|
|
State event of an epic.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="epicstateeventclose"></a>`CLOSE` | Close the epic. |
|
|
| <a id="epicstateeventreopen"></a>`REOPEN` | Reopen the epic. |
|
|
|
|
### `EpicWildcardId`
|
|
|
|
Epic ID wildcard values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="epicwildcardidany"></a>`ANY` | Any epic is assigned. |
|
|
| <a id="epicwildcardidnone"></a>`NONE` | No epic is assigned. |
|
|
|
|
### `EscalationRuleStatus`
|
|
|
|
Escalation rule statuses.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="escalationrulestatusacknowledged"></a>`ACKNOWLEDGED` | . |
|
|
| <a id="escalationrulestatusresolved"></a>`RESOLVED` | . |
|
|
|
|
### `EventAction`
|
|
|
|
Event action.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="eventactionapproved"></a>`APPROVED` | Approved action. |
|
|
| <a id="eventactionclosed"></a>`CLOSED` | Closed action. |
|
|
| <a id="eventactioncommented"></a>`COMMENTED` | Commented action. |
|
|
| <a id="eventactioncreated"></a>`CREATED` | Created action. |
|
|
| <a id="eventactiondestroyed"></a>`DESTROYED` | Destroyed action. |
|
|
| <a id="eventactionexpired"></a>`EXPIRED` | Expired action. |
|
|
| <a id="eventactionjoined"></a>`JOINED` | Joined action. |
|
|
| <a id="eventactionleft"></a>`LEFT` | Left action. |
|
|
| <a id="eventactionmerged"></a>`MERGED` | Merged action. |
|
|
| <a id="eventactionpushed"></a>`PUSHED` | Pushed action. |
|
|
| <a id="eventactionreopened"></a>`REOPENED` | Reopened action. |
|
|
| <a id="eventactionupdated"></a>`UPDATED` | Updated action. |
|
|
|
|
### `GroupMemberRelation`
|
|
|
|
Group member relation.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="groupmemberrelationdescendants"></a>`DESCENDANTS` | Members in the group's subgroups. |
|
|
| <a id="groupmemberrelationdirect"></a>`DIRECT` | Members in the group itself. |
|
|
| <a id="groupmemberrelationinherited"></a>`INHERITED` | Members in the group's ancestor groups. |
|
|
| <a id="groupmemberrelationshared_from_groups"></a>`SHARED_FROM_GROUPS` | Invited group's members. |
|
|
|
|
### `GroupPermission`
|
|
|
|
User permission on groups.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="grouppermissioncreate_projects"></a>`CREATE_PROJECTS` | Groups where the user can create projects. |
|
|
|
|
### `HealthStatus`
|
|
|
|
Health status of an issue or epic.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="healthstatusatrisk"></a>`atRisk` | At risk. |
|
|
| <a id="healthstatusneedsattention"></a>`needsAttention` | Needs attention. |
|
|
| <a id="healthstatusontrack"></a>`onTrack` | On track. |
|
|
|
|
### `IssuableSearchableField`
|
|
|
|
Fields to perform the search in.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issuablesearchablefielddescription"></a>`DESCRIPTION` | Search in description field. |
|
|
| <a id="issuablesearchablefieldtitle"></a>`TITLE` | Search in title field. |
|
|
|
|
### `IssuableSeverity`
|
|
|
|
Incident severity.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issuableseveritycritical"></a>`CRITICAL` | Critical severity. |
|
|
| <a id="issuableseverityhigh"></a>`HIGH` | High severity. |
|
|
| <a id="issuableseveritylow"></a>`LOW` | Low severity. |
|
|
| <a id="issuableseveritymedium"></a>`MEDIUM` | Medium severity. |
|
|
| <a id="issuableseverityunknown"></a>`UNKNOWN` | Unknown severity. |
|
|
|
|
### `IssuableState`
|
|
|
|
State of a GitLab issue or merge request.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issuablestateall"></a>`all` | All available. |
|
|
| <a id="issuablestateclosed"></a>`closed` | In closed state. |
|
|
| <a id="issuablestatelocked"></a>`locked` | Discussion has been locked. |
|
|
| <a id="issuablestateopened"></a>`opened` | In open state. |
|
|
|
|
### `IssueCreationIterationWildcardId`
|
|
|
|
Iteration ID wildcard values for issue creation.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issuecreationiterationwildcardidcurrent"></a>`CURRENT` | Current iteration. |
|
|
|
|
### `IssueEscalationStatus`
|
|
|
|
Issue escalation status values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issueescalationstatusacknowledged"></a>`ACKNOWLEDGED` | Someone is actively investigating the problem. |
|
|
| <a id="issueescalationstatusignored"></a>`IGNORED` | No action will be taken. |
|
|
| <a id="issueescalationstatusresolved"></a>`RESOLVED` | The problem has been addressed. |
|
|
| <a id="issueescalationstatustriggered"></a>`TRIGGERED` | Investigation has not started. |
|
|
|
|
### `IssueSort`
|
|
|
|
Values for sorting issues.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issuesortblocking_issues_asc"></a>`BLOCKING_ISSUES_ASC` | Blocking issues count by ascending order. |
|
|
| <a id="issuesortblocking_issues_desc"></a>`BLOCKING_ISSUES_DESC` | Blocking issues count by descending order. |
|
|
| <a id="issuesortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. |
|
|
| <a id="issuesortcreated_desc"></a>`CREATED_DESC` | Created at descending order. |
|
|
| <a id="issuesortdue_date_asc"></a>`DUE_DATE_ASC` | Due date by ascending order. |
|
|
| <a id="issuesortdue_date_desc"></a>`DUE_DATE_DESC` | Due date by descending order. |
|
|
| <a id="issuesortescalation_status_asc"></a>`ESCALATION_STATUS_ASC` | Status from triggered to resolved. |
|
|
| <a id="issuesortescalation_status_desc"></a>`ESCALATION_STATUS_DESC` | Status from resolved to triggered. |
|
|
| <a id="issuesortlabel_priority_asc"></a>`LABEL_PRIORITY_ASC` | Label priority by ascending order. |
|
|
| <a id="issuesortlabel_priority_desc"></a>`LABEL_PRIORITY_DESC` | Label priority by descending order. |
|
|
| <a id="issuesortmilestone_due_asc"></a>`MILESTONE_DUE_ASC` | Milestone due date by ascending order. |
|
|
| <a id="issuesortmilestone_due_desc"></a>`MILESTONE_DUE_DESC` | Milestone due date by descending order. |
|
|
| <a id="issuesortpopularity_asc"></a>`POPULARITY_ASC` | Number of upvotes (awarded "thumbs up" emoji) by ascending order. |
|
|
| <a id="issuesortpopularity_desc"></a>`POPULARITY_DESC` | Number of upvotes (awarded "thumbs up" emoji) by descending order. |
|
|
| <a id="issuesortpriority_asc"></a>`PRIORITY_ASC` | Priority by ascending order. |
|
|
| <a id="issuesortpriority_desc"></a>`PRIORITY_DESC` | Priority by descending order. |
|
|
| <a id="issuesortpublished_asc"></a>`PUBLISHED_ASC` | Published issues shown last. |
|
|
| <a id="issuesortpublished_desc"></a>`PUBLISHED_DESC` | Published issues shown first. |
|
|
| <a id="issuesortrelative_position_asc"></a>`RELATIVE_POSITION_ASC` | Relative position by ascending order. |
|
|
| <a id="issuesortseverity_asc"></a>`SEVERITY_ASC` | Severity from less critical to more critical. |
|
|
| <a id="issuesortseverity_desc"></a>`SEVERITY_DESC` | Severity from more critical to less critical. |
|
|
| <a id="issuesortsla_due_at_asc"></a>`SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first. |
|
|
| <a id="issuesortsla_due_at_desc"></a>`SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first. |
|
|
| <a id="issuesorttitle_asc"></a>`TITLE_ASC` | Title by ascending order. |
|
|
| <a id="issuesorttitle_desc"></a>`TITLE_DESC` | Title by descending order. |
|
|
| <a id="issuesortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. |
|
|
| <a id="issuesortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. |
|
|
| <a id="issuesortweight_asc"></a>`WEIGHT_ASC` | Weight by ascending order. |
|
|
| <a id="issuesortweight_desc"></a>`WEIGHT_DESC` | Weight by descending order. |
|
|
| <a id="issuesortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_ASC`. |
|
|
| <a id="issuesortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_DESC`. |
|
|
| <a id="issuesortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_ASC`. |
|
|
| <a id="issuesortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_DESC`. |
|
|
|
|
### `IssueState`
|
|
|
|
State of a GitLab issue.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issuestateall"></a>`all` | All available. |
|
|
| <a id="issuestateclosed"></a>`closed` | In closed state. |
|
|
| <a id="issuestatelocked"></a>`locked` | Discussion has been locked. |
|
|
| <a id="issuestateopened"></a>`opened` | In open state. |
|
|
|
|
### `IssueStateEvent`
|
|
|
|
Values for issue state events.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issuestateeventclose"></a>`CLOSE` | Closes the issue. |
|
|
| <a id="issuestateeventreopen"></a>`REOPEN` | Reopens the issue. |
|
|
|
|
### `IssueType`
|
|
|
|
Issue type.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="issuetypeincident"></a>`INCIDENT` | Incident issue type. |
|
|
| <a id="issuetypeissue"></a>`ISSUE` | Issue issue type. |
|
|
| <a id="issuetyperequirement"></a>`REQUIREMENT` | Requirement issue type. |
|
|
| <a id="issuetypetest_case"></a>`TEST_CASE` | Test Case issue type. |
|
|
|
|
### `IterationSearchableField`
|
|
|
|
Fields to perform the search in.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="iterationsearchablefieldcadence_title"></a>`CADENCE_TITLE` | Search in cadence_title field. |
|
|
| <a id="iterationsearchablefieldtitle"></a>`TITLE` | Search in title field. |
|
|
|
|
### `IterationSort`
|
|
|
|
Iteration sort values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="iterationsortcadence_and_due_date_asc"></a>`CADENCE_AND_DUE_DATE_ASC` | Sort by cadence id and due date in ascending order. |
|
|
|
|
### `IterationState`
|
|
|
|
State of a GitLab iteration.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="iterationstateall"></a>`all` | Any iteration. |
|
|
| <a id="iterationstateclosed"></a>`closed` | Closed iteration. |
|
|
| <a id="iterationstatecurrent"></a>`current` | Current iteration. |
|
|
| <a id="iterationstateopened"></a>`opened` | Open iteration. |
|
|
| <a id="iterationstatestarted"></a>`started` **{warning-solid}** | **Deprecated** in 14.1. Use current instead. |
|
|
| <a id="iterationstateupcoming"></a>`upcoming` | Upcoming iteration. |
|
|
|
|
### `IterationWildcardId`
|
|
|
|
Iteration ID wildcard values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="iterationwildcardidany"></a>`ANY` | An iteration is assigned. |
|
|
| <a id="iterationwildcardidcurrent"></a>`CURRENT` | Current iteration. |
|
|
| <a id="iterationwildcardidnone"></a>`NONE` | No iteration is assigned. |
|
|
|
|
### `JobArtifactFileType`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="jobartifactfiletypeaccessibility"></a>`ACCESSIBILITY` | ACCESSIBILITY job artifact file type. |
|
|
| <a id="jobartifactfiletypeapi_fuzzing"></a>`API_FUZZING` | API FUZZING job artifact file type. |
|
|
| <a id="jobartifactfiletypearchive"></a>`ARCHIVE` | ARCHIVE job artifact file type. |
|
|
| <a id="jobartifactfiletypebrowser_performance"></a>`BROWSER_PERFORMANCE` | BROWSER PERFORMANCE job artifact file type. |
|
|
| <a id="jobartifactfiletypecluster_applications"></a>`CLUSTER_APPLICATIONS` | CLUSTER APPLICATIONS job artifact file type. |
|
|
| <a id="jobartifactfiletypecluster_image_scanning"></a>`CLUSTER_IMAGE_SCANNING` | CLUSTER IMAGE SCANNING job artifact file type. |
|
|
| <a id="jobartifactfiletypecobertura"></a>`COBERTURA` | COBERTURA job artifact file type. |
|
|
| <a id="jobartifactfiletypecodequality"></a>`CODEQUALITY` | CODE QUALITY job artifact file type. |
|
|
| <a id="jobartifactfiletypecontainer_scanning"></a>`CONTAINER_SCANNING` | CONTAINER SCANNING job artifact file type. |
|
|
| <a id="jobartifactfiletypecoverage_fuzzing"></a>`COVERAGE_FUZZING` | COVERAGE FUZZING job artifact file type. |
|
|
| <a id="jobartifactfiletypedast"></a>`DAST` | DAST job artifact file type. |
|
|
| <a id="jobartifactfiletypedependency_scanning"></a>`DEPENDENCY_SCANNING` | DEPENDENCY SCANNING job artifact file type. |
|
|
| <a id="jobartifactfiletypedotenv"></a>`DOTENV` | DOTENV job artifact file type. |
|
|
| <a id="jobartifactfiletypejunit"></a>`JUNIT` | JUNIT job artifact file type. |
|
|
| <a id="jobartifactfiletypelicense_scanning"></a>`LICENSE_SCANNING` | LICENSE SCANNING job artifact file type. |
|
|
| <a id="jobartifactfiletypeload_performance"></a>`LOAD_PERFORMANCE` | LOAD PERFORMANCE job artifact file type. |
|
|
| <a id="jobartifactfiletypelsif"></a>`LSIF` | LSIF job artifact file type. |
|
|
| <a id="jobartifactfiletypemetadata"></a>`METADATA` | METADATA job artifact file type. |
|
|
| <a id="jobartifactfiletypemetrics"></a>`METRICS` | METRICS job artifact file type. |
|
|
| <a id="jobartifactfiletypemetrics_referee"></a>`METRICS_REFEREE` | METRICS REFEREE job artifact file type. |
|
|
| <a id="jobartifactfiletypenetwork_referee"></a>`NETWORK_REFEREE` | NETWORK REFEREE job artifact file type. |
|
|
| <a id="jobartifactfiletypeperformance"></a>`PERFORMANCE` | PERFORMANCE job artifact file type. |
|
|
| <a id="jobartifactfiletyperequirements"></a>`REQUIREMENTS` | REQUIREMENTS job artifact file type. |
|
|
| <a id="jobartifactfiletypesast"></a>`SAST` | SAST job artifact file type. |
|
|
| <a id="jobartifactfiletypesecret_detection"></a>`SECRET_DETECTION` | SECRET DETECTION job artifact file type. |
|
|
| <a id="jobartifactfiletypeterraform"></a>`TERRAFORM` | TERRAFORM job artifact file type. |
|
|
| <a id="jobartifactfiletypetrace"></a>`TRACE` | TRACE job artifact file type. |
|
|
|
|
### `ListLimitMetric`
|
|
|
|
List limit metric setting.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="listlimitmetricall_metrics"></a>`all_metrics` | Limit list by number and total weight of issues. |
|
|
| <a id="listlimitmetricissue_count"></a>`issue_count` | Limit list by number of issues. |
|
|
| <a id="listlimitmetricissue_weights"></a>`issue_weights` | Limit list by total weight of issues. |
|
|
|
|
### `MeasurementIdentifier`
|
|
|
|
Possible identifier types for a measurement.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="measurementidentifiergroups"></a>`GROUPS` | Group count. |
|
|
| <a id="measurementidentifierissues"></a>`ISSUES` | Issue count. |
|
|
| <a id="measurementidentifiermerge_requests"></a>`MERGE_REQUESTS` | Merge request count. |
|
|
| <a id="measurementidentifierpipelines"></a>`PIPELINES` | Pipeline count. |
|
|
| <a id="measurementidentifierpipelines_canceled"></a>`PIPELINES_CANCELED` | Pipeline count with canceled status. |
|
|
| <a id="measurementidentifierpipelines_failed"></a>`PIPELINES_FAILED` | Pipeline count with failed status. |
|
|
| <a id="measurementidentifierpipelines_skipped"></a>`PIPELINES_SKIPPED` | Pipeline count with skipped status. |
|
|
| <a id="measurementidentifierpipelines_succeeded"></a>`PIPELINES_SUCCEEDED` | Pipeline count with success status. |
|
|
| <a id="measurementidentifierprojects"></a>`PROJECTS` | Project count. |
|
|
| <a id="measurementidentifierusers"></a>`USERS` | User count. |
|
|
|
|
### `MergeRequestNewState`
|
|
|
|
New state to apply to a merge request.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="mergerequestnewstateclosed"></a>`CLOSED` | Close the merge request if it is open. |
|
|
| <a id="mergerequestnewstateopen"></a>`OPEN` | Open the merge request if it is closed. |
|
|
|
|
### `MergeRequestReviewState`
|
|
|
|
State of a review of a GitLab merge request.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="mergerequestreviewstateattention_requested"></a>`ATTENTION_REQUESTED` | The merge request is attention_requested. |
|
|
| <a id="mergerequestreviewstatereviewed"></a>`REVIEWED` | The merge request is reviewed. |
|
|
| <a id="mergerequestreviewstateunreviewed"></a>`UNREVIEWED` | The merge request is unreviewed. |
|
|
|
|
### `MergeRequestSort`
|
|
|
|
Values for sorting merge requests.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="mergerequestsortclosed_at_asc"></a>`CLOSED_AT_ASC` | Closed time by ascending order. |
|
|
| <a id="mergerequestsortclosed_at_desc"></a>`CLOSED_AT_DESC` | Closed time by descending order. |
|
|
| <a id="mergerequestsortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. |
|
|
| <a id="mergerequestsortcreated_desc"></a>`CREATED_DESC` | Created at descending order. |
|
|
| <a id="mergerequestsortlabel_priority_asc"></a>`LABEL_PRIORITY_ASC` | Label priority by ascending order. |
|
|
| <a id="mergerequestsortlabel_priority_desc"></a>`LABEL_PRIORITY_DESC` | Label priority by descending order. |
|
|
| <a id="mergerequestsortmerged_at_asc"></a>`MERGED_AT_ASC` | Merge time by ascending order. |
|
|
| <a id="mergerequestsortmerged_at_desc"></a>`MERGED_AT_DESC` | Merge time by descending order. |
|
|
| <a id="mergerequestsortmilestone_due_asc"></a>`MILESTONE_DUE_ASC` | Milestone due date by ascending order. |
|
|
| <a id="mergerequestsortmilestone_due_desc"></a>`MILESTONE_DUE_DESC` | Milestone due date by descending order. |
|
|
| <a id="mergerequestsortpriority_asc"></a>`PRIORITY_ASC` | Priority by ascending order. |
|
|
| <a id="mergerequestsortpriority_desc"></a>`PRIORITY_DESC` | Priority by descending order. |
|
|
| <a id="mergerequestsorttitle_asc"></a>`TITLE_ASC` | Title by ascending order. |
|
|
| <a id="mergerequestsorttitle_desc"></a>`TITLE_DESC` | Title by descending order. |
|
|
| <a id="mergerequestsortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. |
|
|
| <a id="mergerequestsortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. |
|
|
| <a id="mergerequestsortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_ASC`. |
|
|
| <a id="mergerequestsortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_DESC`. |
|
|
| <a id="mergerequestsortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_ASC`. |
|
|
| <a id="mergerequestsortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_DESC`. |
|
|
|
|
### `MergeRequestState`
|
|
|
|
State of a GitLab merge request.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="mergerequeststateall"></a>`all` | All available. |
|
|
| <a id="mergerequeststateclosed"></a>`closed` | In closed state. |
|
|
| <a id="mergerequeststatelocked"></a>`locked` | Discussion has been locked. |
|
|
| <a id="mergerequeststatemerged"></a>`merged` | Merge request has been merged. |
|
|
| <a id="mergerequeststateopened"></a>`opened` | In open state. |
|
|
|
|
### `MergeStatus`
|
|
|
|
Representation of whether a GitLab merge request can be merged.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="mergestatuscannot_be_merged"></a>`CANNOT_BE_MERGED` | There are conflicts between the source and target branches. |
|
|
| <a id="mergestatuscannot_be_merged_recheck"></a>`CANNOT_BE_MERGED_RECHECK` | Currently unchecked. The previous state was `CANNOT_BE_MERGED`. |
|
|
| <a id="mergestatuscan_be_merged"></a>`CAN_BE_MERGED` | There are no conflicts between the source and target branches. |
|
|
| <a id="mergestatuschecking"></a>`CHECKING` | Currently checking for mergeability. |
|
|
| <a id="mergestatusunchecked"></a>`UNCHECKED` | Merge status has not been checked. |
|
|
|
|
### `MergeStrategyEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="mergestrategyenumadd_to_merge_train_when_pipeline_succeeds"></a>`ADD_TO_MERGE_TRAIN_WHEN_PIPELINE_SUCCEEDS` | Use the add_to_merge_train_when_pipeline_succeeds merge strategy. |
|
|
| <a id="mergestrategyenummerge_train"></a>`MERGE_TRAIN` | Use the merge_train merge strategy. |
|
|
| <a id="mergestrategyenummerge_when_pipeline_succeeds"></a>`MERGE_WHEN_PIPELINE_SUCCEEDS` | Use the merge_when_pipeline_succeeds merge strategy. |
|
|
|
|
### `MilestoneSort`
|
|
|
|
Values for sorting milestones.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="milestonesortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. |
|
|
| <a id="milestonesortcreated_desc"></a>`CREATED_DESC` | Created at descending order. |
|
|
| <a id="milestonesortdue_date_asc"></a>`DUE_DATE_ASC` | Milestone due date by ascending order. |
|
|
| <a id="milestonesortdue_date_desc"></a>`DUE_DATE_DESC` | Milestone due date by descending order. |
|
|
| <a id="milestonesortexpired_last_due_date_asc"></a>`EXPIRED_LAST_DUE_DATE_ASC` | Group milestones in this order: non-expired milestones with due dates, non-expired milestones without due dates and expired milestones then sort by due date in ascending order. |
|
|
| <a id="milestonesortexpired_last_due_date_desc"></a>`EXPIRED_LAST_DUE_DATE_DESC` | Group milestones in this order: non-expired milestones with due dates, non-expired milestones without due dates and expired milestones then sort by due date in descending order. |
|
|
| <a id="milestonesortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. |
|
|
| <a id="milestonesortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. |
|
|
| <a id="milestonesortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_ASC`. |
|
|
| <a id="milestonesortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_DESC`. |
|
|
| <a id="milestonesortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_ASC`. |
|
|
| <a id="milestonesortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_DESC`. |
|
|
|
|
### `MilestoneStateEnum`
|
|
|
|
Current state of milestone.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="milestonestateenumactive"></a>`active` | Milestone is currently active. |
|
|
| <a id="milestonestateenumclosed"></a>`closed` | Milestone is closed. |
|
|
|
|
### `MilestoneWildcardId`
|
|
|
|
Milestone ID wildcard values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="milestonewildcardidany"></a>`ANY` | Milestone is assigned. |
|
|
| <a id="milestonewildcardidnone"></a>`NONE` | No milestone is assigned. |
|
|
| <a id="milestonewildcardidstarted"></a>`STARTED` | Milestone assigned is open and started (start date <= today). |
|
|
| <a id="milestonewildcardidupcoming"></a>`UPCOMING` | Milestone assigned is due in the future (due date > today). |
|
|
|
|
### `MoveType`
|
|
|
|
The position to which the adjacent object should be moved.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="movetypeafter"></a>`after` | Adjacent object is moved after the object that is being moved. |
|
|
| <a id="movetypebefore"></a>`before` | Adjacent object is moved before the object that is being moved. |
|
|
|
|
### `MutationOperationMode`
|
|
|
|
Different toggles for changing mutator behavior.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="mutationoperationmodeappend"></a>`APPEND` | Performs an append operation. |
|
|
| <a id="mutationoperationmoderemove"></a>`REMOVE` | Performs a removal operation. |
|
|
| <a id="mutationoperationmodereplace"></a>`REPLACE` | Performs a replace operation. |
|
|
|
|
### `NamespaceProjectSort`
|
|
|
|
Values for sorting projects.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="namespaceprojectsortsimilarity"></a>`SIMILARITY` | Most similar to the search query. |
|
|
| <a id="namespaceprojectsortstorage"></a>`STORAGE` | Sort by storage size. |
|
|
|
|
### `NegatedIterationWildcardId`
|
|
|
|
Negated Iteration ID wildcard values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="negatediterationwildcardidcurrent"></a>`CURRENT` | Current iteration. |
|
|
|
|
### `NegatedMilestoneWildcardId`
|
|
|
|
Negated Milestone ID wildcard values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="negatedmilestonewildcardidstarted"></a>`STARTED` | Milestone assigned is open and yet to be started (start date > today). |
|
|
| <a id="negatedmilestonewildcardidupcoming"></a>`UPCOMING` | Milestone assigned is open but due in the past (due date <= today). |
|
|
|
|
### `NetworkPolicyKind`
|
|
|
|
Kind of the network policy.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="networkpolicykindciliumnetworkpolicy"></a>`CiliumNetworkPolicy` | Policy kind of Cilium Network Policy. |
|
|
| <a id="networkpolicykindnetworkpolicy"></a>`NetworkPolicy` | Policy kind of Network Policy. |
|
|
|
|
### `OncallRotationUnitEnum`
|
|
|
|
Rotation length unit of an on-call rotation.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="oncallrotationunitenumdays"></a>`DAYS` | Days. |
|
|
| <a id="oncallrotationunitenumhours"></a>`HOURS` | Hours. |
|
|
| <a id="oncallrotationunitenumweeks"></a>`WEEKS` | Weeks. |
|
|
|
|
### `PackageDependencyType`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="packagedependencytypebundle_dependencies"></a>`BUNDLE_DEPENDENCIES` | bundleDependencies dependency type. |
|
|
| <a id="packagedependencytypedependencies"></a>`DEPENDENCIES` | dependencies dependency type. |
|
|
| <a id="packagedependencytypedev_dependencies"></a>`DEV_DEPENDENCIES` | devDependencies dependency type. |
|
|
| <a id="packagedependencytypepeer_dependencies"></a>`PEER_DEPENDENCIES` | peerDependencies dependency type. |
|
|
|
|
### `PackageGroupSort`
|
|
|
|
Values for sorting group packages.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="packagegroupsortcreated_asc"></a>`CREATED_ASC` | Ordered by created_at in ascending order. |
|
|
| <a id="packagegroupsortcreated_desc"></a>`CREATED_DESC` | Ordered by created_at in descending order. |
|
|
| <a id="packagegroupsortname_asc"></a>`NAME_ASC` | Ordered by name in ascending order. |
|
|
| <a id="packagegroupsortname_desc"></a>`NAME_DESC` | Ordered by name in descending order. |
|
|
| <a id="packagegroupsortproject_path_asc"></a>`PROJECT_PATH_ASC` | Ordered by project path in ascending order. |
|
|
| <a id="packagegroupsortproject_path_desc"></a>`PROJECT_PATH_DESC` | Ordered by project path in descending order. |
|
|
| <a id="packagegroupsorttype_asc"></a>`TYPE_ASC` | Ordered by type in ascending order. |
|
|
| <a id="packagegroupsorttype_desc"></a>`TYPE_DESC` | Ordered by type in descending order. |
|
|
| <a id="packagegroupsortversion_asc"></a>`VERSION_ASC` | Ordered by version in ascending order. |
|
|
| <a id="packagegroupsortversion_desc"></a>`VERSION_DESC` | Ordered by version in descending order. |
|
|
|
|
### `PackageSort`
|
|
|
|
Values for sorting package.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="packagesortcreated_asc"></a>`CREATED_ASC` | Ordered by created_at in ascending order. |
|
|
| <a id="packagesortcreated_desc"></a>`CREATED_DESC` | Ordered by created_at in descending order. |
|
|
| <a id="packagesortname_asc"></a>`NAME_ASC` | Ordered by name in ascending order. |
|
|
| <a id="packagesortname_desc"></a>`NAME_DESC` | Ordered by name in descending order. |
|
|
| <a id="packagesorttype_asc"></a>`TYPE_ASC` | Ordered by type in ascending order. |
|
|
| <a id="packagesorttype_desc"></a>`TYPE_DESC` | Ordered by type in descending order. |
|
|
| <a id="packagesortversion_asc"></a>`VERSION_ASC` | Ordered by version in ascending order. |
|
|
| <a id="packagesortversion_desc"></a>`VERSION_DESC` | Ordered by version in descending order. |
|
|
|
|
### `PackageStatus`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="packagestatusdefault"></a>`DEFAULT` | Packages with a default status. |
|
|
| <a id="packagestatuserror"></a>`ERROR` | Packages with a error status. |
|
|
| <a id="packagestatushidden"></a>`HIDDEN` | Packages with a hidden status. |
|
|
| <a id="packagestatuspending_destruction"></a>`PENDING_DESTRUCTION` | Packages with a pending_destruction status. |
|
|
| <a id="packagestatusprocessing"></a>`PROCESSING` | Packages with a processing status. |
|
|
|
|
### `PackageTypeEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="packagetypeenumcomposer"></a>`COMPOSER` | Packages from the Composer package manager. |
|
|
| <a id="packagetypeenumconan"></a>`CONAN` | Packages from the Conan package manager. |
|
|
| <a id="packagetypeenumdebian"></a>`DEBIAN` | Packages from the Debian package manager. |
|
|
| <a id="packagetypeenumgeneric"></a>`GENERIC` | Packages from the Generic package manager. |
|
|
| <a id="packagetypeenumgolang"></a>`GOLANG` | Packages from the Golang package manager. |
|
|
| <a id="packagetypeenumhelm"></a>`HELM` | Packages from the Helm package manager. |
|
|
| <a id="packagetypeenummaven"></a>`MAVEN` | Packages from the Maven package manager. |
|
|
| <a id="packagetypeenumnpm"></a>`NPM` | Packages from the npm package manager. |
|
|
| <a id="packagetypeenumnuget"></a>`NUGET` | Packages from the Nuget package manager. |
|
|
| <a id="packagetypeenumpypi"></a>`PYPI` | Packages from the PyPI package manager. |
|
|
| <a id="packagetypeenumrubygems"></a>`RUBYGEMS` | Packages from the Rubygems package manager. |
|
|
| <a id="packagetypeenumterraform_module"></a>`TERRAFORM_MODULE` | Packages from the Terraform Module package manager. |
|
|
|
|
### `PackagesCleanupKeepDuplicatedPackageFilesEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="packagescleanupkeepduplicatedpackagefilesenumall_package_files"></a>`ALL_PACKAGE_FILES` | Value to keep all package files. |
|
|
| <a id="packagescleanupkeepduplicatedpackagefilesenumfifty_package_files"></a>`FIFTY_PACKAGE_FILES` | Value to keep 50 package files. |
|
|
| <a id="packagescleanupkeepduplicatedpackagefilesenumforty_package_files"></a>`FORTY_PACKAGE_FILES` | Value to keep 40 package files. |
|
|
| <a id="packagescleanupkeepduplicatedpackagefilesenumone_package_file"></a>`ONE_PACKAGE_FILE` | Value to keep 1 package files. |
|
|
| <a id="packagescleanupkeepduplicatedpackagefilesenumten_package_files"></a>`TEN_PACKAGE_FILES` | Value to keep 10 package files. |
|
|
| <a id="packagescleanupkeepduplicatedpackagefilesenumthirty_package_files"></a>`THIRTY_PACKAGE_FILES` | Value to keep 30 package files. |
|
|
| <a id="packagescleanupkeepduplicatedpackagefilesenumtwenty_package_files"></a>`TWENTY_PACKAGE_FILES` | Value to keep 20 package files. |
|
|
|
|
### `PipelineConfigSourceEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="pipelineconfigsourceenumauto_devops_source"></a>`AUTO_DEVOPS_SOURCE` | Auto DevOps source. |
|
|
| <a id="pipelineconfigsourceenumbridge_source"></a>`BRIDGE_SOURCE` | Bridge source. |
|
|
| <a id="pipelineconfigsourceenumcompliance_source"></a>`COMPLIANCE_SOURCE` | Compliance source. |
|
|
| <a id="pipelineconfigsourceenumexternal_project_source"></a>`EXTERNAL_PROJECT_SOURCE` | External project source. |
|
|
| <a id="pipelineconfigsourceenumparameter_source"></a>`PARAMETER_SOURCE` | Parameter source. |
|
|
| <a id="pipelineconfigsourceenumremote_source"></a>`REMOTE_SOURCE` | Remote source. |
|
|
| <a id="pipelineconfigsourceenumrepository_source"></a>`REPOSITORY_SOURCE` | Repository source. |
|
|
| <a id="pipelineconfigsourceenumunknown_source"></a>`UNKNOWN_SOURCE` | Unknown source. |
|
|
| <a id="pipelineconfigsourceenumwebide_source"></a>`WEBIDE_SOURCE` | Webide source. |
|
|
|
|
### `PipelineMergeRequestEventType`
|
|
|
|
Event type of the pipeline associated with a merge request.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="pipelinemergerequesteventtypedetached"></a>`DETACHED` | Pipeline run on the changes in the merge request source branch. |
|
|
| <a id="pipelinemergerequesteventtypemerged_result"></a>`MERGED_RESULT` | Pipeline run on the changes from the source branch combined with the target branch. |
|
|
| <a id="pipelinemergerequesteventtypemerge_train"></a>`MERGE_TRAIN` | Pipeline ran as part of a merge train. |
|
|
|
|
### `PipelineScopeEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="pipelinescopeenumbranches"></a>`BRANCHES` | Branches. |
|
|
| <a id="pipelinescopeenumfinished"></a>`FINISHED` | Pipeline has completed. |
|
|
| <a id="pipelinescopeenumpending"></a>`PENDING` | Pipeline has not started running yet. |
|
|
| <a id="pipelinescopeenumrunning"></a>`RUNNING` | Pipeline is running. |
|
|
| <a id="pipelinescopeenumtags"></a>`TAGS` | Tags. |
|
|
|
|
### `PipelineStatusEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="pipelinestatusenumcanceled"></a>`CANCELED` | Pipeline was canceled before completion. |
|
|
| <a id="pipelinestatusenumcreated"></a>`CREATED` | Pipeline has been created. |
|
|
| <a id="pipelinestatusenumfailed"></a>`FAILED` | At least one stage of the pipeline failed. |
|
|
| <a id="pipelinestatusenummanual"></a>`MANUAL` | Pipeline needs to be manually started. |
|
|
| <a id="pipelinestatusenumpending"></a>`PENDING` | Pipeline has not started running yet. |
|
|
| <a id="pipelinestatusenumpreparing"></a>`PREPARING` | Pipeline is preparing to run. |
|
|
| <a id="pipelinestatusenumrunning"></a>`RUNNING` | Pipeline is running. |
|
|
| <a id="pipelinestatusenumscheduled"></a>`SCHEDULED` | Pipeline is scheduled to run. |
|
|
| <a id="pipelinestatusenumskipped"></a>`SKIPPED` | Pipeline was skipped. |
|
|
| <a id="pipelinestatusenumsuccess"></a>`SUCCESS` | Pipeline completed successfully. |
|
|
| <a id="pipelinestatusenumwaiting_for_resource"></a>`WAITING_FOR_RESOURCE` | A resource (for example, a runner) that the pipeline requires to run is unavailable. |
|
|
|
|
### `ProjectMemberRelation`
|
|
|
|
Project member relation.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="projectmemberrelationdescendants"></a>`DESCENDANTS` | Descendants members. |
|
|
| <a id="projectmemberrelationdirect"></a>`DIRECT` | Direct members. |
|
|
| <a id="projectmemberrelationinherited"></a>`INHERITED` | Inherited members. |
|
|
| <a id="projectmemberrelationinvited_groups"></a>`INVITED_GROUPS` | Invited Groups members. |
|
|
|
|
### `RegistryState`
|
|
|
|
State of a Geo registry.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="registrystatefailed"></a>`FAILED` | Registry that failed to sync. |
|
|
| <a id="registrystatepending"></a>`PENDING` | Registry waiting to be synced. |
|
|
| <a id="registrystatestarted"></a>`STARTED` | Registry currently syncing. |
|
|
| <a id="registrystatesynced"></a>`SYNCED` | Registry that is synced. |
|
|
|
|
### `ReleaseAssetLinkType`
|
|
|
|
Type of the link: `other`, `runbook`, `image`, `package`.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="releaseassetlinktypeimage"></a>`IMAGE` | Image link type. |
|
|
| <a id="releaseassetlinktypeother"></a>`OTHER` | Other link type. |
|
|
| <a id="releaseassetlinktypepackage"></a>`PACKAGE` | Package link type. |
|
|
| <a id="releaseassetlinktyperunbook"></a>`RUNBOOK` | Runbook link type. |
|
|
|
|
### `ReleaseSort`
|
|
|
|
Values for sorting releases.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="releasesortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. |
|
|
| <a id="releasesortcreated_desc"></a>`CREATED_DESC` | Created at descending order. |
|
|
| <a id="releasesortreleased_at_asc"></a>`RELEASED_AT_ASC` | Released at by ascending order. |
|
|
| <a id="releasesortreleased_at_desc"></a>`RELEASED_AT_DESC` | Released at by descending order. |
|
|
|
|
### `ReleaseTagWildcardId`
|
|
|
|
Release tag ID wildcard values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="releasetagwildcardidany"></a>`ANY` | Release tag is assigned. |
|
|
| <a id="releasetagwildcardidnone"></a>`NONE` | No release tag is assigned. |
|
|
|
|
### `RequirementState`
|
|
|
|
State of a requirement.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="requirementstatearchived"></a>`ARCHIVED` | Archived requirement. |
|
|
| <a id="requirementstateopened"></a>`OPENED` | Open requirement. |
|
|
|
|
### `RequirementStatusFilter`
|
|
|
|
Status of a requirement based on last test report.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="requirementstatusfilterfailed"></a>`FAILED` | Failed test report. |
|
|
| <a id="requirementstatusfiltermissing"></a>`MISSING` | Requirements without any test report. |
|
|
| <a id="requirementstatusfilterpassed"></a>`PASSED` | Passed test report. |
|
|
|
|
### `RunnerMembershipFilter`
|
|
|
|
Values for filtering runners in namespaces.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="runnermembershipfilterdescendants"></a>`DESCENDANTS` | Include runners that have either a direct relationship or a relationship with descendants. These can be project runners or group runners (in the case where group is queried). |
|
|
| <a id="runnermembershipfilterdirect"></a>`DIRECT` | Include runners that have a direct relationship. |
|
|
|
|
### `SastUiComponentSize`
|
|
|
|
Size of UI component in SAST configuration page.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="sastuicomponentsizelarge"></a>`LARGE` | Size of UI component in SAST configuration page is large. |
|
|
| <a id="sastuicomponentsizemedium"></a>`MEDIUM` | Size of UI component in SAST configuration page is medium. |
|
|
| <a id="sastuicomponentsizesmall"></a>`SMALL` | Size of UI component in SAST configuration page is small. |
|
|
|
|
### `ScanStatus`
|
|
|
|
The status of the security scan.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="scanstatuscreated"></a>`CREATED` | The scan has been created. |
|
|
| <a id="scanstatusjob_failed"></a>`JOB_FAILED` | The related CI build failed. |
|
|
| <a id="scanstatuspreparation_failed"></a>`PREPARATION_FAILED` | Report couldn't be prepared. |
|
|
| <a id="scanstatuspreparing"></a>`PREPARING` | Preparing the report for the scan. |
|
|
| <a id="scanstatuspurged"></a>`PURGED` | Report for the scan has been removed from the database. |
|
|
| <a id="scanstatusreport_error"></a>`REPORT_ERROR` | The report artifact provided by the CI build couldn't be parsed. |
|
|
| <a id="scanstatussucceeded"></a>`SUCCEEDED` | The report has been successfully prepared. |
|
|
|
|
### `SecurityPolicyRelationType`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="securitypolicyrelationtypedirect"></a>`DIRECT` | Policies defined for the project only. |
|
|
| <a id="securitypolicyrelationtypeinherited"></a>`INHERITED` | Policies defined for the project and project's ancestor groups. |
|
|
|
|
### `SecurityReportTypeEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="securityreporttypeenumapi_fuzzing"></a>`API_FUZZING` | API FUZZING scan report. |
|
|
| <a id="securityreporttypeenumcluster_image_scanning"></a>`CLUSTER_IMAGE_SCANNING` | CLUSTER IMAGE SCANNING scan report. |
|
|
| <a id="securityreporttypeenumcontainer_scanning"></a>`CONTAINER_SCANNING` | CONTAINER SCANNING scan report. |
|
|
| <a id="securityreporttypeenumcoverage_fuzzing"></a>`COVERAGE_FUZZING` | COVERAGE FUZZING scan report. |
|
|
| <a id="securityreporttypeenumdast"></a>`DAST` | DAST scan report. |
|
|
| <a id="securityreporttypeenumdependency_scanning"></a>`DEPENDENCY_SCANNING` | DEPENDENCY SCANNING scan report. |
|
|
| <a id="securityreporttypeenumsast"></a>`SAST` | SAST scan report. |
|
|
| <a id="securityreporttypeenumsast_iac"></a>`SAST_IAC` | SAST IAC scan report. |
|
|
| <a id="securityreporttypeenumsecret_detection"></a>`SECRET_DETECTION` | SECRET DETECTION scan report. |
|
|
|
|
### `SecurityScannerType`
|
|
|
|
The type of the security scanner.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="securityscannertypeapi_fuzzing"></a>`API_FUZZING` | API Fuzzing scanner. |
|
|
| <a id="securityscannertypecluster_image_scanning"></a>`CLUSTER_IMAGE_SCANNING` | Cluster Image Scanning scanner. |
|
|
| <a id="securityscannertypecontainer_scanning"></a>`CONTAINER_SCANNING` | Container Scanning scanner. |
|
|
| <a id="securityscannertypecoverage_fuzzing"></a>`COVERAGE_FUZZING` | Coverage Fuzzing scanner. |
|
|
| <a id="securityscannertypedast"></a>`DAST` | DAST scanner. |
|
|
| <a id="securityscannertypedependency_scanning"></a>`DEPENDENCY_SCANNING` | Dependency Scanning scanner. |
|
|
| <a id="securityscannertypesast"></a>`SAST` | SAST scanner. |
|
|
| <a id="securityscannertypesast_iac"></a>`SAST_IAC` | Sast Iac scanner. |
|
|
| <a id="securityscannertypesecret_detection"></a>`SECRET_DETECTION` | Secret Detection scanner. |
|
|
|
|
### `SentryErrorStatus`
|
|
|
|
State of a Sentry error.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="sentryerrorstatusignored"></a>`IGNORED` | Error has been ignored. |
|
|
| <a id="sentryerrorstatusresolved"></a>`RESOLVED` | Error has been resolved. |
|
|
| <a id="sentryerrorstatusresolved_in_next_release"></a>`RESOLVED_IN_NEXT_RELEASE` | Error has been ignored until next release. |
|
|
| <a id="sentryerrorstatusunresolved"></a>`UNRESOLVED` | Error is unresolved. |
|
|
|
|
### `ServiceType`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="servicetypeasana_service"></a>`ASANA_SERVICE` | AsanaService type. |
|
|
| <a id="servicetypeassembla_service"></a>`ASSEMBLA_SERVICE` | AssemblaService type. |
|
|
| <a id="servicetypebamboo_service"></a>`BAMBOO_SERVICE` | BambooService type. |
|
|
| <a id="servicetypebugzilla_service"></a>`BUGZILLA_SERVICE` | BugzillaService type. |
|
|
| <a id="servicetypebuildkite_service"></a>`BUILDKITE_SERVICE` | BuildkiteService type. |
|
|
| <a id="servicetypecampfire_service"></a>`CAMPFIRE_SERVICE` | CampfireService type. |
|
|
| <a id="servicetypeconfluence_service"></a>`CONFLUENCE_SERVICE` | ConfluenceService type. |
|
|
| <a id="servicetypecustom_issue_tracker_service"></a>`CUSTOM_ISSUE_TRACKER_SERVICE` | CustomIssueTrackerService type. |
|
|
| <a id="servicetypedatadog_service"></a>`DATADOG_SERVICE` | DatadogService type. |
|
|
| <a id="servicetypediscord_service"></a>`DISCORD_SERVICE` | DiscordService type. |
|
|
| <a id="servicetypedrone_ci_service"></a>`DRONE_CI_SERVICE` | DroneCiService type. |
|
|
| <a id="servicetypeemails_on_push_service"></a>`EMAILS_ON_PUSH_SERVICE` | EmailsOnPushService type. |
|
|
| <a id="servicetypeewm_service"></a>`EWM_SERVICE` | EwmService type. |
|
|
| <a id="servicetypeexternal_wiki_service"></a>`EXTERNAL_WIKI_SERVICE` | ExternalWikiService type. |
|
|
| <a id="servicetypeflowdock_service"></a>`FLOWDOCK_SERVICE` | FlowdockService type. |
|
|
| <a id="servicetypegithub_service"></a>`GITHUB_SERVICE` | GithubService type. |
|
|
| <a id="servicetypegitlab_slack_application_service"></a>`GITLAB_SLACK_APPLICATION_SERVICE` | GitlabSlackApplicationService type (Gitlab.com only). |
|
|
| <a id="servicetypehangouts_chat_service"></a>`HANGOUTS_CHAT_SERVICE` | HangoutsChatService type. |
|
|
| <a id="servicetypeharbor_service"></a>`HARBOR_SERVICE` | HarborService type. |
|
|
| <a id="servicetypeirker_service"></a>`IRKER_SERVICE` | IrkerService type. |
|
|
| <a id="servicetypejenkins_service"></a>`JENKINS_SERVICE` | JenkinsService type. |
|
|
| <a id="servicetypejira_service"></a>`JIRA_SERVICE` | JiraService type. |
|
|
| <a id="servicetypemattermost_service"></a>`MATTERMOST_SERVICE` | MattermostService type. |
|
|
| <a id="servicetypemattermost_slash_commands_service"></a>`MATTERMOST_SLASH_COMMANDS_SERVICE` | MattermostSlashCommandsService type. |
|
|
| <a id="servicetypemicrosoft_teams_service"></a>`MICROSOFT_TEAMS_SERVICE` | MicrosoftTeamsService type. |
|
|
| <a id="servicetypepackagist_service"></a>`PACKAGIST_SERVICE` | PackagistService type. |
|
|
| <a id="servicetypepipelines_email_service"></a>`PIPELINES_EMAIL_SERVICE` | PipelinesEmailService type. |
|
|
| <a id="servicetypepivotaltracker_service"></a>`PIVOTALTRACKER_SERVICE` | PivotaltrackerService type. |
|
|
| <a id="servicetypeprometheus_service"></a>`PROMETHEUS_SERVICE` | PrometheusService type. |
|
|
| <a id="servicetypepushover_service"></a>`PUSHOVER_SERVICE` | PushoverService type. |
|
|
| <a id="servicetyperedmine_service"></a>`REDMINE_SERVICE` | RedmineService type. |
|
|
| <a id="servicetypeshimo_service"></a>`SHIMO_SERVICE` | ShimoService type. |
|
|
| <a id="servicetypeslack_service"></a>`SLACK_SERVICE` | SlackService type. |
|
|
| <a id="servicetypeslack_slash_commands_service"></a>`SLACK_SLASH_COMMANDS_SERVICE` | SlackSlashCommandsService type. |
|
|
| <a id="servicetypeteamcity_service"></a>`TEAMCITY_SERVICE` | TeamcityService type. |
|
|
| <a id="servicetypeunify_circuit_service"></a>`UNIFY_CIRCUIT_SERVICE` | UnifyCircuitService type. |
|
|
| <a id="servicetypewebex_teams_service"></a>`WEBEX_TEAMS_SERVICE` | WebexTeamsService type. |
|
|
| <a id="servicetypeyoutrack_service"></a>`YOUTRACK_SERVICE` | YoutrackService type. |
|
|
| <a id="servicetypezentao_service"></a>`ZENTAO_SERVICE` | ZentaoService type. |
|
|
|
|
### `ShaFormat`
|
|
|
|
How to format SHA strings.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="shaformatlong"></a>`LONG` | Unabbreviated format. |
|
|
| <a id="shaformatshort"></a>`SHORT` | Abbreviated format. Short SHAs are typically eight characters long. |
|
|
|
|
### `SharedRunnersSetting`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="sharedrunnerssettingdisabled_and_unoverridable"></a>`DISABLED_AND_UNOVERRIDABLE` | Sharing of runners is disabled and unoverridable. |
|
|
| <a id="sharedrunnerssettingdisabled_with_override"></a>`DISABLED_WITH_OVERRIDE` | Sharing of runners is disabled with override. |
|
|
| <a id="sharedrunnerssettingenabled"></a>`ENABLED` | Sharing of runners is enabled. |
|
|
|
|
### `SnippetBlobActionEnum`
|
|
|
|
Type of a snippet blob input action.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="snippetblobactionenumcreate"></a>`create` | Create a snippet blob. |
|
|
| <a id="snippetblobactionenumdelete"></a>`delete` | Delete a snippet blob. |
|
|
| <a id="snippetblobactionenummove"></a>`move` | Move a snippet blob. |
|
|
| <a id="snippetblobactionenumupdate"></a>`update` | Update a snippet blob. |
|
|
|
|
### `Sort`
|
|
|
|
Common sort values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="sortcreated_asc"></a>`CREATED_ASC` | Created at ascending order. |
|
|
| <a id="sortcreated_desc"></a>`CREATED_DESC` | Created at descending order. |
|
|
| <a id="sortupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. |
|
|
| <a id="sortupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. |
|
|
| <a id="sortcreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_ASC`. |
|
|
| <a id="sortcreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_DESC`. |
|
|
| <a id="sortupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_ASC`. |
|
|
| <a id="sortupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_DESC`. |
|
|
|
|
### `TestCaseStatus`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="testcasestatuserror"></a>`error` | Test case that has a status of error. |
|
|
| <a id="testcasestatusfailed"></a>`failed` | Test case that has a status of failed. |
|
|
| <a id="testcasestatusskipped"></a>`skipped` | Test case that has a status of skipped. |
|
|
| <a id="testcasestatussuccess"></a>`success` | Test case that has a status of success. |
|
|
|
|
### `TestReportState`
|
|
|
|
State of a test report.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="testreportstatefailed"></a>`FAILED` | Failed test report. |
|
|
| <a id="testreportstatepassed"></a>`PASSED` | Passed test report. |
|
|
|
|
### `TimeboxReportErrorReason`
|
|
|
|
Category of error.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="timeboxreporterrorreasoncreated_asc"></a>`CREATED_ASC` | Created at ascending order. |
|
|
| <a id="timeboxreporterrorreasoncreated_desc"></a>`CREATED_DESC` | Created at descending order. |
|
|
| <a id="timeboxreporterrorreasonlabel_priority_asc"></a>`LABEL_PRIORITY_ASC` | Label priority by ascending order. |
|
|
| <a id="timeboxreporterrorreasonlabel_priority_desc"></a>`LABEL_PRIORITY_DESC` | Label priority by descending order. |
|
|
| <a id="timeboxreporterrorreasonmilestone_due_asc"></a>`MILESTONE_DUE_ASC` | Milestone due date by ascending order. |
|
|
| <a id="timeboxreporterrorreasonmilestone_due_desc"></a>`MILESTONE_DUE_DESC` | Milestone due date by descending order. |
|
|
| <a id="timeboxreporterrorreasonmissing_dates"></a>`MISSING_DATES` | One or both of start_date and due_date is missing. |
|
|
| <a id="timeboxreporterrorreasonpriority_asc"></a>`PRIORITY_ASC` | Priority by ascending order. |
|
|
| <a id="timeboxreporterrorreasonpriority_desc"></a>`PRIORITY_DESC` | Priority by descending order. |
|
|
| <a id="timeboxreporterrorreasontoo_many_events"></a>`TOO_MANY_EVENTS` | There are too many events. |
|
|
| <a id="timeboxreporterrorreasonunsupported"></a>`UNSUPPORTED` | This type does not support timebox reports. |
|
|
| <a id="timeboxreporterrorreasonupdated_asc"></a>`UPDATED_ASC` | Updated at ascending order. |
|
|
| <a id="timeboxreporterrorreasonupdated_desc"></a>`UPDATED_DESC` | Updated at descending order. |
|
|
| <a id="timeboxreporterrorreasoncreated_asc"></a>`created_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_ASC`. |
|
|
| <a id="timeboxreporterrorreasoncreated_desc"></a>`created_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `CREATED_DESC`. |
|
|
| <a id="timeboxreporterrorreasonupdated_asc"></a>`updated_asc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_ASC`. |
|
|
| <a id="timeboxreporterrorreasonupdated_desc"></a>`updated_desc` **{warning-solid}** | **Deprecated** in 13.5. This was renamed. Use: `UPDATED_DESC`. |
|
|
|
|
### `TodoActionEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="todoactionenumapproval_required"></a>`approval_required` | User was set as an approver. |
|
|
| <a id="todoactionenumassigned"></a>`assigned` | User was assigned. |
|
|
| <a id="todoactionenumbuild_failed"></a>`build_failed` | Build triggered by the user failed. |
|
|
| <a id="todoactionenumdirectly_addressed"></a>`directly_addressed` | User was directly addressed. |
|
|
| <a id="todoactionenummarked"></a>`marked` | User added a TODO. |
|
|
| <a id="todoactionenummentioned"></a>`mentioned` | User was mentioned. |
|
|
| <a id="todoactionenummerge_train_removed"></a>`merge_train_removed` | Merge request authored by the user was removed from the merge train. |
|
|
| <a id="todoactionenumreview_requested"></a>`review_requested` | Review was requested from the user. |
|
|
| <a id="todoactionenumunmergeable"></a>`unmergeable` | Merge request authored by the user could not be merged. |
|
|
|
|
### `TodoStateEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="todostateenumdone"></a>`done` | State of the todo is done. |
|
|
| <a id="todostateenumpending"></a>`pending` | State of the todo is pending. |
|
|
|
|
### `TodoTargetEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="todotargetenumalert"></a>`ALERT` | Alert. |
|
|
| <a id="todotargetenumcommit"></a>`COMMIT` | Commit. |
|
|
| <a id="todotargetenumdesign"></a>`DESIGN` | Design. |
|
|
| <a id="todotargetenumepic"></a>`EPIC` | An Epic. |
|
|
| <a id="todotargetenumissue"></a>`ISSUE` | Issue. |
|
|
| <a id="todotargetenummergerequest"></a>`MERGEREQUEST` | Merge request. |
|
|
|
|
### `TrainingUrlRequestStatus`
|
|
|
|
Status of the request to the training provider. The URL of a TrainingUrl is calculated asynchronously. When PENDING, the URL of the TrainingUrl will be null. When COMPLETED, the URL of the TrainingUrl will be available.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="trainingurlrequeststatuscompleted"></a>`COMPLETED` | Completed request. |
|
|
| <a id="trainingurlrequeststatuspending"></a>`PENDING` | Pending request. |
|
|
|
|
### `TypeEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="typeenumpersonal"></a>`personal` | Snippet created independent of any project. |
|
|
| <a id="typeenumproject"></a>`project` | Snippet related to a specific project. |
|
|
|
|
### `UserCalloutFeatureNameEnum`
|
|
|
|
Name of the feature that the callout is for.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="usercalloutfeaturenameenumactive_user_count_threshold"></a>`ACTIVE_USER_COUNT_THRESHOLD` | Callout feature name for active_user_count_threshold. |
|
|
| <a id="usercalloutfeaturenameenumattention_requests_side_nav"></a>`ATTENTION_REQUESTS_SIDE_NAV` | Callout feature name for attention_requests_side_nav. |
|
|
| <a id="usercalloutfeaturenameenumattention_requests_top_nav"></a>`ATTENTION_REQUESTS_TOP_NAV` | Callout feature name for attention_requests_top_nav. |
|
|
| <a id="usercalloutfeaturenameenumbuy_pipeline_minutes_notification_dot"></a>`BUY_PIPELINE_MINUTES_NOTIFICATION_DOT` | Callout feature name for buy_pipeline_minutes_notification_dot. |
|
|
| <a id="usercalloutfeaturenameenumcanary_deployment"></a>`CANARY_DEPLOYMENT` | Callout feature name for canary_deployment. |
|
|
| <a id="usercalloutfeaturenameenumci_deprecation_warning_for_types_keyword"></a>`CI_DEPRECATION_WARNING_FOR_TYPES_KEYWORD` | Callout feature name for ci_deprecation_warning_for_types_keyword. |
|
|
| <a id="usercalloutfeaturenameenumcloud_licensing_subscription_activation_banner"></a>`CLOUD_LICENSING_SUBSCRIPTION_ACTIVATION_BANNER` | Callout feature name for cloud_licensing_subscription_activation_banner. |
|
|
| <a id="usercalloutfeaturenameenumcluster_security_warning"></a>`CLUSTER_SECURITY_WARNING` | Callout feature name for cluster_security_warning. |
|
|
| <a id="usercalloutfeaturenameenumeoa_bronze_plan_banner"></a>`EOA_BRONZE_PLAN_BANNER` | Callout feature name for eoa_bronze_plan_banner. |
|
|
| <a id="usercalloutfeaturenameenumfeature_flags_new_version"></a>`FEATURE_FLAGS_NEW_VERSION` | Callout feature name for feature_flags_new_version. |
|
|
| <a id="usercalloutfeaturenameenumgcp_signup_offer"></a>`GCP_SIGNUP_OFFER` | Callout feature name for gcp_signup_offer. |
|
|
| <a id="usercalloutfeaturenameenumgeo_enable_hashed_storage"></a>`GEO_ENABLE_HASHED_STORAGE` | Callout feature name for geo_enable_hashed_storage. |
|
|
| <a id="usercalloutfeaturenameenumgeo_migrate_hashed_storage"></a>`GEO_MIGRATE_HASHED_STORAGE` | Callout feature name for geo_migrate_hashed_storage. |
|
|
| <a id="usercalloutfeaturenameenumgke_cluster_integration"></a>`GKE_CLUSTER_INTEGRATION` | Callout feature name for gke_cluster_integration. |
|
|
| <a id="usercalloutfeaturenameenumgold_trial_billings"></a>`GOLD_TRIAL_BILLINGS` | Callout feature name for gold_trial_billings. |
|
|
| <a id="usercalloutfeaturenameenumminute_limit_banner"></a>`MINUTE_LIMIT_BANNER` | Callout feature name for minute_limit_banner. |
|
|
| <a id="usercalloutfeaturenameenumnew_user_signups_cap_reached"></a>`NEW_USER_SIGNUPS_CAP_REACHED` | Callout feature name for new_user_signups_cap_reached. |
|
|
| <a id="usercalloutfeaturenameenumpersonal_access_token_expiry"></a>`PERSONAL_ACCESS_TOKEN_EXPIRY` | Callout feature name for personal_access_token_expiry. |
|
|
| <a id="usercalloutfeaturenameenumpipeline_needs_banner"></a>`PIPELINE_NEEDS_BANNER` | Callout feature name for pipeline_needs_banner. |
|
|
| <a id="usercalloutfeaturenameenumpipeline_needs_hover_tip"></a>`PIPELINE_NEEDS_HOVER_TIP` | Callout feature name for pipeline_needs_hover_tip. |
|
|
| <a id="usercalloutfeaturenameenumpreview_user_over_limit_free_plan_alert"></a>`PREVIEW_USER_OVER_LIMIT_FREE_PLAN_ALERT` | Callout feature name for preview_user_over_limit_free_plan_alert. |
|
|
| <a id="usercalloutfeaturenameenumprofile_personal_access_token_expiry"></a>`PROFILE_PERSONAL_ACCESS_TOKEN_EXPIRY` | Callout feature name for profile_personal_access_token_expiry. |
|
|
| <a id="usercalloutfeaturenameenumregistration_enabled_callout"></a>`REGISTRATION_ENABLED_CALLOUT` | Callout feature name for registration_enabled_callout. |
|
|
| <a id="usercalloutfeaturenameenumsecurity_configuration_devops_alert"></a>`SECURITY_CONFIGURATION_DEVOPS_ALERT` | Callout feature name for security_configuration_devops_alert. |
|
|
| <a id="usercalloutfeaturenameenumsecurity_configuration_upgrade_banner"></a>`SECURITY_CONFIGURATION_UPGRADE_BANNER` | Callout feature name for security_configuration_upgrade_banner. |
|
|
| <a id="usercalloutfeaturenameenumsecurity_newsletter_callout"></a>`SECURITY_NEWSLETTER_CALLOUT` | Callout feature name for security_newsletter_callout. |
|
|
| <a id="usercalloutfeaturenameenumsecurity_training_feature_promotion"></a>`SECURITY_TRAINING_FEATURE_PROMOTION` | Callout feature name for security_training_feature_promotion. |
|
|
| <a id="usercalloutfeaturenameenumstorage_enforcement_banner_first_enforcement_threshold"></a>`STORAGE_ENFORCEMENT_BANNER_FIRST_ENFORCEMENT_THRESHOLD` | Callout feature name for storage_enforcement_banner_first_enforcement_threshold. |
|
|
| <a id="usercalloutfeaturenameenumstorage_enforcement_banner_fourth_enforcement_threshold"></a>`STORAGE_ENFORCEMENT_BANNER_FOURTH_ENFORCEMENT_THRESHOLD` | Callout feature name for storage_enforcement_banner_fourth_enforcement_threshold. |
|
|
| <a id="usercalloutfeaturenameenumstorage_enforcement_banner_second_enforcement_threshold"></a>`STORAGE_ENFORCEMENT_BANNER_SECOND_ENFORCEMENT_THRESHOLD` | Callout feature name for storage_enforcement_banner_second_enforcement_threshold. |
|
|
| <a id="usercalloutfeaturenameenumstorage_enforcement_banner_third_enforcement_threshold"></a>`STORAGE_ENFORCEMENT_BANNER_THIRD_ENFORCEMENT_THRESHOLD` | Callout feature name for storage_enforcement_banner_third_enforcement_threshold. |
|
|
| <a id="usercalloutfeaturenameenumsuggest_pipeline"></a>`SUGGEST_PIPELINE` | Callout feature name for suggest_pipeline. |
|
|
| <a id="usercalloutfeaturenameenumsuggest_popover_dismissed"></a>`SUGGEST_POPOVER_DISMISSED` | Callout feature name for suggest_popover_dismissed. |
|
|
| <a id="usercalloutfeaturenameenumtabs_position_highlight"></a>`TABS_POSITION_HIGHLIGHT` | Callout feature name for tabs_position_highlight. |
|
|
| <a id="usercalloutfeaturenameenumterraform_notification_dismissed"></a>`TERRAFORM_NOTIFICATION_DISMISSED` | Callout feature name for terraform_notification_dismissed. |
|
|
| <a id="usercalloutfeaturenameenumthreat_monitoring_info"></a>`THREAT_MONITORING_INFO` | Callout feature name for threat_monitoring_info. |
|
|
| <a id="usercalloutfeaturenameenumtrial_status_reminder_d14"></a>`TRIAL_STATUS_REMINDER_D14` | Callout feature name for trial_status_reminder_d14. |
|
|
| <a id="usercalloutfeaturenameenumtrial_status_reminder_d3"></a>`TRIAL_STATUS_REMINDER_D3` | Callout feature name for trial_status_reminder_d3. |
|
|
| <a id="usercalloutfeaturenameenumtwo_factor_auth_recovery_settings_check"></a>`TWO_FACTOR_AUTH_RECOVERY_SETTINGS_CHECK` | Callout feature name for two_factor_auth_recovery_settings_check. |
|
|
| <a id="usercalloutfeaturenameenumultimate_trial"></a>`ULTIMATE_TRIAL` | Callout feature name for ultimate_trial. |
|
|
| <a id="usercalloutfeaturenameenumunfinished_tag_cleanup_callout"></a>`UNFINISHED_TAG_CLEANUP_CALLOUT` | Callout feature name for unfinished_tag_cleanup_callout. |
|
|
| <a id="usercalloutfeaturenameenumuser_reached_limit_free_plan_alert"></a>`USER_REACHED_LIMIT_FREE_PLAN_ALERT` | Callout feature name for user_reached_limit_free_plan_alert. |
|
|
| <a id="usercalloutfeaturenameenumverification_reminder"></a>`VERIFICATION_REMINDER` | Callout feature name for verification_reminder. |
|
|
| <a id="usercalloutfeaturenameenumweb_ide_alert_dismissed"></a>`WEB_IDE_ALERT_DISMISSED` | Callout feature name for web_ide_alert_dismissed. |
|
|
| <a id="usercalloutfeaturenameenumweb_ide_ci_environments_guidance"></a>`WEB_IDE_CI_ENVIRONMENTS_GUIDANCE` | Callout feature name for web_ide_ci_environments_guidance. |
|
|
|
|
### `UserState`
|
|
|
|
Possible states of a user.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="userstateactive"></a>`active` | User is active and is able to use the system. |
|
|
| <a id="userstateblocked"></a>`blocked` | User has been blocked and is prevented from using the system. |
|
|
| <a id="userstatedeactivated"></a>`deactivated` | User is no longer active and is unable to use the system. |
|
|
|
|
### `VisibilityLevelsEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="visibilitylevelsenuminternal"></a>`internal` | Internal visibility level. |
|
|
| <a id="visibilitylevelsenumprivate"></a>`private` | Private visibility level. |
|
|
| <a id="visibilitylevelsenumpublic"></a>`public` | Public visibility level. |
|
|
|
|
### `VisibilityScopesEnum`
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="visibilityscopesenuminternal"></a>`internal` | Snippet is visible for any logged in user except external users. |
|
|
| <a id="visibilityscopesenumprivate"></a>`private` | Snippet is visible only to the snippet creator. |
|
|
| <a id="visibilityscopesenumpublic"></a>`public` | Snippet can be accessed without any authentication. |
|
|
|
|
### `VulnerabilityConfidence`
|
|
|
|
Confidence that a given vulnerability is present in the codebase.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilityconfidenceconfirmed"></a>`CONFIRMED` | Confirmed confidence. |
|
|
| <a id="vulnerabilityconfidenceexperimental"></a>`EXPERIMENTAL` | Experimental confidence. |
|
|
| <a id="vulnerabilityconfidencehigh"></a>`HIGH` | High confidence. |
|
|
| <a id="vulnerabilityconfidenceignore"></a>`IGNORE` | Ignore confidence. |
|
|
| <a id="vulnerabilityconfidencelow"></a>`LOW` | Low confidence. |
|
|
| <a id="vulnerabilityconfidencemedium"></a>`MEDIUM` | Medium confidence. |
|
|
| <a id="vulnerabilityconfidenceunknown"></a>`UNKNOWN` | Unknown confidence. |
|
|
|
|
### `VulnerabilityDismissalReason`
|
|
|
|
The dismissal reason of the Vulnerability.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilitydismissalreasonacceptable_risk"></a>`ACCEPTABLE_RISK` | The vulnerability is known, and has not been remediated or mitigated, but is considered to be an acceptable business risk. |
|
|
| <a id="vulnerabilitydismissalreasonfalse_positive"></a>`FALSE_POSITIVE` | An error in reporting in which a test result incorrectly indicates the presence of a vulnerability in a system when the vulnerability is not present. |
|
|
| <a id="vulnerabilitydismissalreasonmitigating_control"></a>`MITIGATING_CONTROL` | A management, operational, or technical control (that is, safeguard or countermeasure) employed by an organization that provides equivalent or comparable protection for an information system. |
|
|
| <a id="vulnerabilitydismissalreasonnot_applicable"></a>`NOT_APPLICABLE` | The vulnerability is known, and has not been remediated or mitigated, but is considered to be in a part of the application that will not be updated. |
|
|
| <a id="vulnerabilitydismissalreasonused_in_tests"></a>`USED_IN_TESTS` | The finding is not a vulnerability because it is part of a test or is test data. |
|
|
|
|
### `VulnerabilityExternalIssueLinkExternalTracker`
|
|
|
|
The external tracker of the external issue link related to a vulnerability.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilityexternalissuelinkexternaltrackerjira"></a>`JIRA` | Jira external tracker. |
|
|
|
|
### `VulnerabilityExternalIssueLinkType`
|
|
|
|
The type of the external issue link related to a vulnerability.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilityexternalissuelinktypecreated"></a>`CREATED` | Created link type. |
|
|
|
|
### `VulnerabilityGrade`
|
|
|
|
The grade of the vulnerable project.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilitygradea"></a>`A` | A grade. |
|
|
| <a id="vulnerabilitygradeb"></a>`B` | B grade. |
|
|
| <a id="vulnerabilitygradec"></a>`C` | C grade. |
|
|
| <a id="vulnerabilitygraded"></a>`D` | D grade. |
|
|
| <a id="vulnerabilitygradef"></a>`F` | F grade. |
|
|
|
|
### `VulnerabilityIssueLinkType`
|
|
|
|
The type of the issue link related to a vulnerability.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilityissuelinktypecreated"></a>`CREATED` | Issue is created for the vulnerability. |
|
|
| <a id="vulnerabilityissuelinktyperelated"></a>`RELATED` | Has a related issue. |
|
|
|
|
### `VulnerabilityReportType`
|
|
|
|
The type of the security scan that found the vulnerability.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilityreporttypeapi_fuzzing"></a>`API_FUZZING` | API Fuzzing report. |
|
|
| <a id="vulnerabilityreporttypecluster_image_scanning"></a>`CLUSTER_IMAGE_SCANNING` | Cluster Image Scanning report. |
|
|
| <a id="vulnerabilityreporttypecontainer_scanning"></a>`CONTAINER_SCANNING` | Container Scanning report. |
|
|
| <a id="vulnerabilityreporttypecoverage_fuzzing"></a>`COVERAGE_FUZZING` | Coverage Fuzzing report. |
|
|
| <a id="vulnerabilityreporttypedast"></a>`DAST` | DAST report. |
|
|
| <a id="vulnerabilityreporttypedependency_scanning"></a>`DEPENDENCY_SCANNING` | Dependency Scanning report. |
|
|
| <a id="vulnerabilityreporttypegeneric"></a>`GENERIC` | Generic report. |
|
|
| <a id="vulnerabilityreporttypesast"></a>`SAST` | SAST report. |
|
|
| <a id="vulnerabilityreporttypesecret_detection"></a>`SECRET_DETECTION` | Secret Detection report. |
|
|
|
|
### `VulnerabilitySeverity`
|
|
|
|
The severity of the vulnerability.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilityseveritycritical"></a>`CRITICAL` | Critical severity. |
|
|
| <a id="vulnerabilityseverityhigh"></a>`HIGH` | High severity. |
|
|
| <a id="vulnerabilityseverityinfo"></a>`INFO` | Info severity. |
|
|
| <a id="vulnerabilityseveritylow"></a>`LOW` | Low severity. |
|
|
| <a id="vulnerabilityseveritymedium"></a>`MEDIUM` | Medium severity. |
|
|
| <a id="vulnerabilityseverityunknown"></a>`UNKNOWN` | Unknown severity. |
|
|
|
|
### `VulnerabilitySort`
|
|
|
|
Vulnerability sort values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilitysortdetected_asc"></a>`detected_asc` | Detection timestamp in ascending order. |
|
|
| <a id="vulnerabilitysortdetected_desc"></a>`detected_desc` | Detection timestamp in descending order. |
|
|
| <a id="vulnerabilitysortreport_type_asc"></a>`report_type_asc` | Report Type in ascending order. |
|
|
| <a id="vulnerabilitysortreport_type_desc"></a>`report_type_desc` | Report Type in descending order. |
|
|
| <a id="vulnerabilitysortseverity_asc"></a>`severity_asc` | Severity in ascending order. |
|
|
| <a id="vulnerabilitysortseverity_desc"></a>`severity_desc` | Severity in descending order. |
|
|
| <a id="vulnerabilitysortstate_asc"></a>`state_asc` | State in ascending order. |
|
|
| <a id="vulnerabilitysortstate_desc"></a>`state_desc` | State in descending order. |
|
|
|
|
### `VulnerabilityState`
|
|
|
|
The state of the vulnerability.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="vulnerabilitystateconfirmed"></a>`CONFIRMED` | For details, see [vulnerability status values](https://docs.gitlab.com/ee/user/application_security/vulnerabilities/index.html#vulnerability-status-values). |
|
|
| <a id="vulnerabilitystatedetected"></a>`DETECTED` | For details, see [vulnerability status values](https://docs.gitlab.com/ee/user/application_security/vulnerabilities/index.html#vulnerability-status-values). |
|
|
| <a id="vulnerabilitystatedismissed"></a>`DISMISSED` | For details, see [vulnerability status values](https://docs.gitlab.com/ee/user/application_security/vulnerabilities/index.html#vulnerability-status-values). |
|
|
| <a id="vulnerabilitystateresolved"></a>`RESOLVED` | For details, see [vulnerability status values](https://docs.gitlab.com/ee/user/application_security/vulnerabilities/index.html#vulnerability-status-values). |
|
|
|
|
### `WeightWildcardId`
|
|
|
|
Weight ID wildcard values.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="weightwildcardidany"></a>`ANY` | Weight is assigned. |
|
|
| <a id="weightwildcardidnone"></a>`NONE` | No weight is assigned. |
|
|
|
|
### `WorkItemState`
|
|
|
|
State of a GitLab work item.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="workitemstateclosed"></a>`CLOSED` | In closed state. |
|
|
| <a id="workitemstateopen"></a>`OPEN` | In open state. |
|
|
|
|
### `WorkItemStateEvent`
|
|
|
|
Values for work item state events.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="workitemstateeventclose"></a>`CLOSE` | Closes the work item. |
|
|
| <a id="workitemstateeventreopen"></a>`REOPEN` | Reopens the work item. |
|
|
|
|
### `WorkItemWidgetType`
|
|
|
|
Type of a work item widget.
|
|
|
|
| Value | Description |
|
|
| ----- | ----------- |
|
|
| <a id="workitemwidgettypedescription"></a>`DESCRIPTION` | Description widget. |
|
|
| <a id="workitemwidgettypehierarchy"></a>`HIERARCHY` | Hierarchy widget. |
|
|
|
|
## Scalar types
|
|
|
|
Scalar values are atomic values, and do not have fields of their own.
|
|
Basic scalars include strings, boolean values, and numbers. This schema also
|
|
defines various custom scalar values, such as types for times and dates.
|
|
|
|
This schema includes custom scalar types for identifiers, with a specific type for
|
|
each kind of object.
|
|
|
|
For more information, read about [Scalar Types](https://graphql.org/learn/schema/#scalar-types) on `graphql.org`.
|
|
|
|
### `AlertManagementHttpIntegrationID`
|
|
|
|
A `AlertManagementHttpIntegrationID` is a global ID. It is encoded as a string.
|
|
|
|
An example `AlertManagementHttpIntegrationID` is: `"gid://gitlab/AlertManagement::HttpIntegration/1"`.
|
|
|
|
### `AnalyticsDevopsAdoptionEnabledNamespaceID`
|
|
|
|
A `AnalyticsDevopsAdoptionEnabledNamespaceID` is a global ID. It is encoded as a string.
|
|
|
|
An example `AnalyticsDevopsAdoptionEnabledNamespaceID` is: `"gid://gitlab/Analytics::DevopsAdoption::EnabledNamespace/1"`.
|
|
|
|
### `AppSecFuzzingCoverageCorpusID`
|
|
|
|
A `AppSecFuzzingCoverageCorpusID` is a global ID. It is encoded as a string.
|
|
|
|
An example `AppSecFuzzingCoverageCorpusID` is: `"gid://gitlab/AppSec::Fuzzing::Coverage::Corpus/1"`.
|
|
|
|
### `AuditEventsExternalAuditEventDestinationID`
|
|
|
|
A `AuditEventsExternalAuditEventDestinationID` is a global ID. It is encoded as a string.
|
|
|
|
An example `AuditEventsExternalAuditEventDestinationID` is: `"gid://gitlab/AuditEvents::ExternalAuditEventDestination/1"`.
|
|
|
|
### `AwardableID`
|
|
|
|
A `AwardableID` is a global ID. It is encoded as a string.
|
|
|
|
An example `AwardableID` is: `"gid://gitlab/Awardable/1"`.
|
|
|
|
### `BigInt`
|
|
|
|
Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it's encoded as a string.
|
|
|
|
### `BoardID`
|
|
|
|
A `BoardID` is a global ID. It is encoded as a string.
|
|
|
|
An example `BoardID` is: `"gid://gitlab/Board/1"`.
|
|
|
|
### `BoardsEpicBoardID`
|
|
|
|
A `BoardsEpicBoardID` is a global ID. It is encoded as a string.
|
|
|
|
An example `BoardsEpicBoardID` is: `"gid://gitlab/Boards::EpicBoard/1"`.
|
|
|
|
### `BoardsEpicListID`
|
|
|
|
A `BoardsEpicListID` is a global ID. It is encoded as a string.
|
|
|
|
An example `BoardsEpicListID` is: `"gid://gitlab/Boards::EpicList/1"`.
|
|
|
|
### `Boolean`
|
|
|
|
Represents `true` or `false` values.
|
|
|
|
### `CiBuildID`
|
|
|
|
A `CiBuildID` is a global ID. It is encoded as a string.
|
|
|
|
An example `CiBuildID` is: `"gid://gitlab/Ci::Build/1"`.
|
|
|
|
### `CiPipelineID`
|
|
|
|
A `CiPipelineID` is a global ID. It is encoded as a string.
|
|
|
|
An example `CiPipelineID` is: `"gid://gitlab/Ci::Pipeline/1"`.
|
|
|
|
### `CiRunnerID`
|
|
|
|
A `CiRunnerID` is a global ID. It is encoded as a string.
|
|
|
|
An example `CiRunnerID` is: `"gid://gitlab/Ci::Runner/1"`.
|
|
|
|
### `ClustersAgentID`
|
|
|
|
A `ClustersAgentID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ClustersAgentID` is: `"gid://gitlab/Clusters::Agent/1"`.
|
|
|
|
### `ClustersAgentTokenID`
|
|
|
|
A `ClustersAgentTokenID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ClustersAgentTokenID` is: `"gid://gitlab/Clusters::AgentToken/1"`.
|
|
|
|
### `ClustersClusterID`
|
|
|
|
A `ClustersClusterID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ClustersClusterID` is: `"gid://gitlab/Clusters::Cluster/1"`.
|
|
|
|
### `Color`
|
|
|
|
Color represented as a hex code or named color.
|
|
|
|
For example: "#fefefe".
|
|
|
|
### `ComplianceManagementFrameworkID`
|
|
|
|
A `ComplianceManagementFrameworkID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ComplianceManagementFrameworkID` is: `"gid://gitlab/ComplianceManagement::Framework/1"`.
|
|
|
|
### `ContainerRepositoryID`
|
|
|
|
A `ContainerRepositoryID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ContainerRepositoryID` is: `"gid://gitlab/ContainerRepository/1"`.
|
|
|
|
### `CustomEmojiID`
|
|
|
|
A `CustomEmojiID` is a global ID. It is encoded as a string.
|
|
|
|
An example `CustomEmojiID` is: `"gid://gitlab/CustomEmoji/1"`.
|
|
|
|
### `CustomerRelationsContactID`
|
|
|
|
A `CustomerRelationsContactID` is a global ID. It is encoded as a string.
|
|
|
|
An example `CustomerRelationsContactID` is: `"gid://gitlab/CustomerRelations::Contact/1"`.
|
|
|
|
### `CustomerRelationsOrganizationID`
|
|
|
|
A `CustomerRelationsOrganizationID` is a global ID. It is encoded as a string.
|
|
|
|
An example `CustomerRelationsOrganizationID` is: `"gid://gitlab/CustomerRelations::Organization/1"`.
|
|
|
|
### `DastProfileID`
|
|
|
|
A `DastProfileID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DastProfileID` is: `"gid://gitlab/Dast::Profile/1"`.
|
|
|
|
### `DastProfileScheduleID`
|
|
|
|
A `DastProfileScheduleID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DastProfileScheduleID` is: `"gid://gitlab/Dast::ProfileSchedule/1"`.
|
|
|
|
### `DastScannerProfileID`
|
|
|
|
A `DastScannerProfileID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DastScannerProfileID` is: `"gid://gitlab/DastScannerProfile/1"`.
|
|
|
|
### `DastSiteProfileID`
|
|
|
|
A `DastSiteProfileID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DastSiteProfileID` is: `"gid://gitlab/DastSiteProfile/1"`.
|
|
|
|
### `DastSiteTokenID`
|
|
|
|
A `DastSiteTokenID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DastSiteTokenID` is: `"gid://gitlab/DastSiteToken/1"`.
|
|
|
|
### `DastSiteValidationID`
|
|
|
|
A `DastSiteValidationID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DastSiteValidationID` is: `"gid://gitlab/DastSiteValidation/1"`.
|
|
|
|
### `Date`
|
|
|
|
Date represented in ISO 8601.
|
|
|
|
### `DependencyProxyManifestID`
|
|
|
|
A `DependencyProxyManifestID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DependencyProxyManifestID` is: `"gid://gitlab/DependencyProxy::Manifest/1"`.
|
|
|
|
### `DesignManagementDesignAtVersionID`
|
|
|
|
A `DesignManagementDesignAtVersionID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DesignManagementDesignAtVersionID` is: `"gid://gitlab/DesignManagement::DesignAtVersion/1"`.
|
|
|
|
### `DesignManagementDesignID`
|
|
|
|
A `DesignManagementDesignID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DesignManagementDesignID` is: `"gid://gitlab/DesignManagement::Design/1"`.
|
|
|
|
### `DesignManagementVersionID`
|
|
|
|
A `DesignManagementVersionID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DesignManagementVersionID` is: `"gid://gitlab/DesignManagement::Version/1"`.
|
|
|
|
### `DiffNoteID`
|
|
|
|
A `DiffNoteID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DiffNoteID` is: `"gid://gitlab/DiffNote/1"`.
|
|
|
|
### `DiscussionID`
|
|
|
|
A `DiscussionID` is a global ID. It is encoded as a string.
|
|
|
|
An example `DiscussionID` is: `"gid://gitlab/Discussion/1"`.
|
|
|
|
### `Duration`
|
|
|
|
Duration between two instants, represented as a fractional number of seconds.
|
|
|
|
For example: 12.3334.
|
|
|
|
### `EnvironmentID`
|
|
|
|
A `EnvironmentID` is a global ID. It is encoded as a string.
|
|
|
|
An example `EnvironmentID` is: `"gid://gitlab/Environment/1"`.
|
|
|
|
### `EpicID`
|
|
|
|
A `EpicID` is a global ID. It is encoded as a string.
|
|
|
|
An example `EpicID` is: `"gid://gitlab/Epic/1"`.
|
|
|
|
### `EpicTreeSortingID`
|
|
|
|
A `EpicTreeSortingID` is a global ID. It is encoded as a string.
|
|
|
|
An example `EpicTreeSortingID` is: `"gid://gitlab/EpicTreeSorting/1"`.
|
|
|
|
### `Float`
|
|
|
|
Represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
|
|
|
|
### `GitlabErrorTrackingDetailedErrorID`
|
|
|
|
A `GitlabErrorTrackingDetailedErrorID` is a global ID. It is encoded as a string.
|
|
|
|
An example `GitlabErrorTrackingDetailedErrorID` is: `"gid://gitlab/Gitlab::ErrorTracking::DetailedError/1"`.
|
|
|
|
### `GlobalID`
|
|
|
|
A global identifier.
|
|
|
|
A global identifier represents an object uniquely across the application.
|
|
An example of such an identifier is `"gid://gitlab/User/1"`.
|
|
|
|
Global identifiers are encoded as strings.
|
|
|
|
### `GroupID`
|
|
|
|
A `GroupID` is a global ID. It is encoded as a string.
|
|
|
|
An example `GroupID` is: `"gid://gitlab/Group/1"`.
|
|
|
|
### `ID`
|
|
|
|
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID.
|
|
|
|
### `ISO8601Date`
|
|
|
|
An ISO 8601-encoded date.
|
|
|
|
### `IncidentManagementEscalationPolicyID`
|
|
|
|
A `IncidentManagementEscalationPolicyID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IncidentManagementEscalationPolicyID` is: `"gid://gitlab/IncidentManagement::EscalationPolicy/1"`.
|
|
|
|
### `IncidentManagementEscalationRuleID`
|
|
|
|
A `IncidentManagementEscalationRuleID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IncidentManagementEscalationRuleID` is: `"gid://gitlab/IncidentManagement::EscalationRule/1"`.
|
|
|
|
### `IncidentManagementOncallParticipantID`
|
|
|
|
A `IncidentManagementOncallParticipantID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IncidentManagementOncallParticipantID` is: `"gid://gitlab/IncidentManagement::OncallParticipant/1"`.
|
|
|
|
### `IncidentManagementOncallRotationID`
|
|
|
|
A `IncidentManagementOncallRotationID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IncidentManagementOncallRotationID` is: `"gid://gitlab/IncidentManagement::OncallRotation/1"`.
|
|
|
|
### `IncidentManagementTimelineEventID`
|
|
|
|
A `IncidentManagementTimelineEventID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IncidentManagementTimelineEventID` is: `"gid://gitlab/IncidentManagement::TimelineEvent/1"`.
|
|
|
|
### `Int`
|
|
|
|
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
|
|
|
|
### `IntegrationsPrometheusID`
|
|
|
|
A `IntegrationsPrometheusID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IntegrationsPrometheusID` is: `"gid://gitlab/Integrations::Prometheus/1"`.
|
|
The older format `"gid://gitlab/PrometheusService/1"` was deprecated in 14.1.
|
|
|
|
### `IssuableID`
|
|
|
|
A `IssuableID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IssuableID` is: `"gid://gitlab/Issuable/1"`.
|
|
|
|
### `IssueID`
|
|
|
|
A `IssueID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IssueID` is: `"gid://gitlab/Issue/1"`.
|
|
|
|
### `IterationID`
|
|
|
|
A `IterationID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IterationID` is: `"gid://gitlab/Iteration/1"`.
|
|
The older format `"gid://gitlab/EEIteration/1"` was deprecated in 13.3.
|
|
|
|
### `IterationsCadenceID`
|
|
|
|
A `IterationsCadenceID` is a global ID. It is encoded as a string.
|
|
|
|
An example `IterationsCadenceID` is: `"gid://gitlab/Iterations::Cadence/1"`.
|
|
|
|
### `JSON`
|
|
|
|
Represents untyped JSON.
|
|
|
|
### `JobID`
|
|
|
|
A `CommitStatusID` is a global ID. It is encoded as a string.
|
|
|
|
An example `CommitStatusID` is: `"gid://gitlab/CommitStatus/1"`.
|
|
|
|
### `JsonString`
|
|
|
|
JSON object as raw string.
|
|
|
|
### `LabelID`
|
|
|
|
A `LabelID` is a global ID. It is encoded as a string.
|
|
|
|
An example `LabelID` is: `"gid://gitlab/Label/1"`.
|
|
|
|
### `ListID`
|
|
|
|
A `ListID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ListID` is: `"gid://gitlab/List/1"`.
|
|
|
|
### `MergeRequestID`
|
|
|
|
A `MergeRequestID` is a global ID. It is encoded as a string.
|
|
|
|
An example `MergeRequestID` is: `"gid://gitlab/MergeRequest/1"`.
|
|
|
|
### `MetricsDashboardAnnotationID`
|
|
|
|
A `MetricsDashboardAnnotationID` is a global ID. It is encoded as a string.
|
|
|
|
An example `MetricsDashboardAnnotationID` is: `"gid://gitlab/Metrics::Dashboard::Annotation/1"`.
|
|
|
|
### `MilestoneID`
|
|
|
|
A `MilestoneID` is a global ID. It is encoded as a string.
|
|
|
|
An example `MilestoneID` is: `"gid://gitlab/Milestone/1"`.
|
|
|
|
### `NamespaceID`
|
|
|
|
A `NamespaceID` is a global ID. It is encoded as a string.
|
|
|
|
An example `NamespaceID` is: `"gid://gitlab/Namespace/1"`.
|
|
|
|
### `NoteID`
|
|
|
|
A `NoteID` is a global ID. It is encoded as a string.
|
|
|
|
An example `NoteID` is: `"gid://gitlab/Note/1"`.
|
|
|
|
### `NoteableID`
|
|
|
|
A `NoteableID` is a global ID. It is encoded as a string.
|
|
|
|
An example `NoteableID` is: `"gid://gitlab/Noteable/1"`.
|
|
|
|
### `PackagesConanFileMetadatumID`
|
|
|
|
A `PackagesConanFileMetadatumID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesConanFileMetadatumID` is: `"gid://gitlab/Packages::Conan::FileMetadatum/1"`.
|
|
|
|
### `PackagesConanMetadatumID`
|
|
|
|
A `PackagesConanMetadatumID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesConanMetadatumID` is: `"gid://gitlab/Packages::Conan::Metadatum/1"`.
|
|
|
|
### `PackagesDependencyID`
|
|
|
|
A `PackagesDependencyID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesDependencyID` is: `"gid://gitlab/Packages::Dependency/1"`.
|
|
|
|
### `PackagesDependencyLinkID`
|
|
|
|
A `PackagesDependencyLinkID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesDependencyLinkID` is: `"gid://gitlab/Packages::DependencyLink/1"`.
|
|
|
|
### `PackagesMavenMetadatumID`
|
|
|
|
A `PackagesMavenMetadatumID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesMavenMetadatumID` is: `"gid://gitlab/Packages::Maven::Metadatum/1"`.
|
|
|
|
### `PackagesNugetDependencyLinkMetadatumID`
|
|
|
|
A `PackagesNugetDependencyLinkMetadatumID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesNugetDependencyLinkMetadatumID` is: `"gid://gitlab/Packages::Nuget::DependencyLinkMetadatum/1"`.
|
|
|
|
### `PackagesNugetMetadatumID`
|
|
|
|
A `PackagesNugetMetadatumID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesNugetMetadatumID` is: `"gid://gitlab/Packages::Nuget::Metadatum/1"`.
|
|
|
|
### `PackagesPackageFileID`
|
|
|
|
A `PackagesPackageFileID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesPackageFileID` is: `"gid://gitlab/Packages::PackageFile/1"`.
|
|
|
|
### `PackagesPackageID`
|
|
|
|
A `PackagesPackageID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesPackageID` is: `"gid://gitlab/Packages::Package/1"`.
|
|
|
|
### `PackagesPypiMetadatumID`
|
|
|
|
A `PackagesPypiMetadatumID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PackagesPypiMetadatumID` is: `"gid://gitlab/Packages::Pypi::Metadatum/1"`.
|
|
|
|
### `PathLockID`
|
|
|
|
A `PathLockID` is a global ID. It is encoded as a string.
|
|
|
|
An example `PathLockID` is: `"gid://gitlab/PathLock/1"`.
|
|
|
|
### `PayloadAlertFieldPathSegment`
|
|
|
|
String or integer.
|
|
|
|
### `ProjectID`
|
|
|
|
A `ProjectID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ProjectID` is: `"gid://gitlab/Project/1"`.
|
|
|
|
### `ReleaseID`
|
|
|
|
A `ReleaseID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ReleaseID` is: `"gid://gitlab/Release/1"`.
|
|
|
|
### `ReleasesLinkID`
|
|
|
|
A `ReleasesLinkID` is a global ID. It is encoded as a string.
|
|
|
|
An example `ReleasesLinkID` is: `"gid://gitlab/Releases::Link/1"`.
|
|
|
|
### `SecurityTrainingProviderID`
|
|
|
|
A `SecurityTrainingProviderID` is a global ID. It is encoded as a string.
|
|
|
|
An example `SecurityTrainingProviderID` is: `"gid://gitlab/Security::TrainingProvider/1"`.
|
|
|
|
### `SnippetID`
|
|
|
|
A `SnippetID` is a global ID. It is encoded as a string.
|
|
|
|
An example `SnippetID` is: `"gid://gitlab/Snippet/1"`.
|
|
|
|
### `String`
|
|
|
|
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
|
|
|
|
### `TerraformStateID`
|
|
|
|
A `TerraformStateID` is a global ID. It is encoded as a string.
|
|
|
|
An example `TerraformStateID` is: `"gid://gitlab/Terraform::State/1"`.
|
|
|
|
### `Time`
|
|
|
|
Time represented in ISO 8601.
|
|
|
|
For example: "2021-03-09T14:58:50+00:00".
|
|
|
|
See `https://www.iso.org/iso-8601-date-and-time-format.html`.
|
|
|
|
### `TimelogID`
|
|
|
|
A `TimelogID` is a global ID. It is encoded as a string.
|
|
|
|
An example `TimelogID` is: `"gid://gitlab/Timelog/1"`.
|
|
|
|
### `TodoID`
|
|
|
|
A `TodoID` is a global ID. It is encoded as a string.
|
|
|
|
An example `TodoID` is: `"gid://gitlab/Todo/1"`.
|
|
|
|
### `TodoableID`
|
|
|
|
A `TodoableID` is a global ID. It is encoded as a string.
|
|
|
|
An example `TodoableID` is: `"gid://gitlab/Todoable/1"`.
|
|
|
|
### `UntrustedRegexp`
|
|
|
|
A regexp containing patterns sourced from user input.
|
|
|
|
### `Upload`
|
|
|
|
### `UserID`
|
|
|
|
A `UserID` is a global ID. It is encoded as a string.
|
|
|
|
An example `UserID` is: `"gid://gitlab/User/1"`.
|
|
|
|
### `UsersSavedReplyID`
|
|
|
|
A `UsersSavedReplyID` is a global ID. It is encoded as a string.
|
|
|
|
An example `UsersSavedReplyID` is: `"gid://gitlab/Users::SavedReply/1"`.
|
|
|
|
### `VulnerabilitiesExternalIssueLinkID`
|
|
|
|
A `VulnerabilitiesExternalIssueLinkID` is a global ID. It is encoded as a string.
|
|
|
|
An example `VulnerabilitiesExternalIssueLinkID` is: `"gid://gitlab/Vulnerabilities::ExternalIssueLink/1"`.
|
|
|
|
### `VulnerabilitiesFindingID`
|
|
|
|
A `VulnerabilitiesFindingID` is a global ID. It is encoded as a string.
|
|
|
|
An example `VulnerabilitiesFindingID` is: `"gid://gitlab/Vulnerabilities::Finding/1"`.
|
|
|
|
### `VulnerabilitiesScannerID`
|
|
|
|
A `VulnerabilitiesScannerID` is a global ID. It is encoded as a string.
|
|
|
|
An example `VulnerabilitiesScannerID` is: `"gid://gitlab/Vulnerabilities::Scanner/1"`.
|
|
|
|
### `VulnerabilityID`
|
|
|
|
A `VulnerabilityID` is a global ID. It is encoded as a string.
|
|
|
|
An example `VulnerabilityID` is: `"gid://gitlab/Vulnerability/1"`.
|
|
|
|
### `WorkItemID`
|
|
|
|
A `WorkItemID` is a global ID. It is encoded as a string.
|
|
|
|
An example `WorkItemID` is: `"gid://gitlab/WorkItem/1"`.
|
|
|
|
While we transition from Issues into Work Items this type will temporarily support
|
|
`IssueID` like: `"gid://gitlab/Issue/1"`. This behavior will be removed without notice in the future.
|
|
|
|
### `WorkItemsTypeID`
|
|
|
|
A `WorkItemsTypeID` is a global ID. It is encoded as a string.
|
|
|
|
An example `WorkItemsTypeID` is: `"gid://gitlab/WorkItems::Type/1"`.
|
|
|
|
## Abstract types
|
|
|
|
Abstract types (unions and interfaces) are ways the schema can represent
|
|
values that may be one of several concrete types.
|
|
|
|
- A [`Union`](https://graphql.org/learn/schema/#union-types) is a set of possible types.
|
|
The types might not have any fields in common.
|
|
- An [`Interface`](https://graphql.org/learn/schema/#interfaces) is a defined set of fields.
|
|
Types may `implement` an interface, which
|
|
guarantees that they have all the fields in the set. A type may implement more than
|
|
one interface.
|
|
|
|
See the [GraphQL documentation](https://graphql.org/learn/) for more information on using
|
|
abstract types.
|
|
|
|
### Unions
|
|
|
|
#### `DependencyLinkMetadata`
|
|
|
|
Represents metadata associated with a dependency link.
|
|
|
|
One of:
|
|
|
|
- [`NugetDependencyLinkMetadata`](#nugetdependencylinkmetadata)
|
|
|
|
#### `Issuable`
|
|
|
|
Represents an issuable.
|
|
|
|
One of:
|
|
|
|
- [`Epic`](#epic)
|
|
- [`Issue`](#issue)
|
|
- [`MergeRequest`](#mergerequest)
|
|
- [`WorkItem`](#workitem)
|
|
|
|
#### `JobNeedUnion`
|
|
|
|
One of:
|
|
|
|
- [`CiBuildNeed`](#cibuildneed)
|
|
- [`CiJob`](#cijob)
|
|
|
|
#### `NoteableType`
|
|
|
|
Represents an object that supports notes.
|
|
|
|
One of:
|
|
|
|
- [`Design`](#design)
|
|
- [`Issue`](#issue)
|
|
- [`MergeRequest`](#mergerequest)
|
|
|
|
#### `PackageMetadata`
|
|
|
|
Represents metadata associated with a Package.
|
|
|
|
One of:
|
|
|
|
- [`ComposerMetadata`](#composermetadata)
|
|
- [`ConanMetadata`](#conanmetadata)
|
|
- [`MavenMetadata`](#mavenmetadata)
|
|
- [`NugetMetadata`](#nugetmetadata)
|
|
- [`PypiMetadata`](#pypimetadata)
|
|
|
|
#### `SecurityPolicySource`
|
|
|
|
Represents a policy source. Its fields depend on the source type.
|
|
|
|
One of:
|
|
|
|
- [`GroupSecurityPolicySource`](#groupsecuritypolicysource)
|
|
- [`ProjectSecurityPolicySource`](#projectsecuritypolicysource)
|
|
|
|
#### `VulnerabilityDetail`
|
|
|
|
Represents a vulnerability detail field. The fields with data will depend on the vulnerability detail type.
|
|
|
|
One of:
|
|
|
|
- [`VulnerabilityDetailBase`](#vulnerabilitydetailbase)
|
|
- [`VulnerabilityDetailBoolean`](#vulnerabilitydetailboolean)
|
|
- [`VulnerabilityDetailCode`](#vulnerabilitydetailcode)
|
|
- [`VulnerabilityDetailCommit`](#vulnerabilitydetailcommit)
|
|
- [`VulnerabilityDetailDiff`](#vulnerabilitydetaildiff)
|
|
- [`VulnerabilityDetailFileLocation`](#vulnerabilitydetailfilelocation)
|
|
- [`VulnerabilityDetailInt`](#vulnerabilitydetailint)
|
|
- [`VulnerabilityDetailList`](#vulnerabilitydetaillist)
|
|
- [`VulnerabilityDetailMarkdown`](#vulnerabilitydetailmarkdown)
|
|
- [`VulnerabilityDetailModuleLocation`](#vulnerabilitydetailmodulelocation)
|
|
- [`VulnerabilityDetailTable`](#vulnerabilitydetailtable)
|
|
- [`VulnerabilityDetailText`](#vulnerabilitydetailtext)
|
|
- [`VulnerabilityDetailUrl`](#vulnerabilitydetailurl)
|
|
|
|
#### `VulnerabilityLocation`
|
|
|
|
Represents a vulnerability location. The fields with data will depend on the vulnerability report type.
|
|
|
|
One of:
|
|
|
|
- [`VulnerabilityLocationClusterImageScanning`](#vulnerabilitylocationclusterimagescanning)
|
|
- [`VulnerabilityLocationContainerScanning`](#vulnerabilitylocationcontainerscanning)
|
|
- [`VulnerabilityLocationCoverageFuzzing`](#vulnerabilitylocationcoveragefuzzing)
|
|
- [`VulnerabilityLocationDast`](#vulnerabilitylocationdast)
|
|
- [`VulnerabilityLocationDependencyScanning`](#vulnerabilitylocationdependencyscanning)
|
|
- [`VulnerabilityLocationGeneric`](#vulnerabilitylocationgeneric)
|
|
- [`VulnerabilityLocationSast`](#vulnerabilitylocationsast)
|
|
- [`VulnerabilityLocationSecretDetection`](#vulnerabilitylocationsecretdetection)
|
|
|
|
### Interfaces
|
|
|
|
#### `AlertManagementIntegration`
|
|
|
|
Implementations:
|
|
|
|
- [`AlertManagementHttpIntegration`](#alertmanagementhttpintegration)
|
|
- [`AlertManagementPrometheusIntegration`](#alertmanagementprometheusintegration)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementintegrationactive"></a>`active` | [`Boolean`](#boolean) | Whether the endpoint is currently accepting alerts. |
|
|
| <a id="alertmanagementintegrationapiurl"></a>`apiUrl` | [`String`](#string) | URL at which Prometheus metrics can be queried to populate the metrics dashboard. |
|
|
| <a id="alertmanagementintegrationid"></a>`id` | [`ID!`](#id) | ID of the integration. |
|
|
| <a id="alertmanagementintegrationname"></a>`name` | [`String`](#string) | Name of the integration. |
|
|
| <a id="alertmanagementintegrationtoken"></a>`token` | [`String`](#string) | Token used to authenticate alert notification requests. |
|
|
| <a id="alertmanagementintegrationtype"></a>`type` | [`AlertManagementIntegrationType!`](#alertmanagementintegrationtype) | Type of integration. |
|
|
| <a id="alertmanagementintegrationurl"></a>`url` | [`String`](#string) | Endpoint which accepts alert notifications. |
|
|
|
|
#### `CurrentUserTodos`
|
|
|
|
Implementations:
|
|
|
|
- [`BoardEpic`](#boardepic)
|
|
- [`Design`](#design)
|
|
- [`Epic`](#epic)
|
|
- [`EpicIssue`](#epicissue)
|
|
- [`Issue`](#issue)
|
|
- [`MergeRequest`](#mergerequest)
|
|
|
|
##### Fields with arguments
|
|
|
|
###### `CurrentUserTodos.currentUserTodos`
|
|
|
|
To-do items for the current user.
|
|
|
|
Returns [`TodoConnection!`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="currentusertodoscurrentusertodosstate"></a>`state` | [`TodoStateEnum`](#todostateenum) | State of the to-do items. |
|
|
|
|
#### `DesignFields`
|
|
|
|
Implementations:
|
|
|
|
- [`Design`](#design)
|
|
- [`DesignAtVersion`](#designatversion)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="designfieldsdiffrefs"></a>`diffRefs` | [`DiffRefs!`](#diffrefs) | Diff refs for this design. |
|
|
| <a id="designfieldsevent"></a>`event` | [`DesignVersionEvent!`](#designversionevent) | How this design was changed in the current version. |
|
|
| <a id="designfieldsfilename"></a>`filename` | [`String!`](#string) | Filename of the design. |
|
|
| <a id="designfieldsfullpath"></a>`fullPath` | [`String!`](#string) | Full path to the design file. |
|
|
| <a id="designfieldsid"></a>`id` | [`ID!`](#id) | ID of this design. |
|
|
| <a id="designfieldsimage"></a>`image` | [`String!`](#string) | URL of the full-sized image. |
|
|
| <a id="designfieldsimagev432x230"></a>`imageV432x230` | [`String`](#string) | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated. |
|
|
| <a id="designfieldsissue"></a>`issue` | [`Issue!`](#issue) | Issue the design belongs to. |
|
|
| <a id="designfieldsnotescount"></a>`notesCount` | [`Int!`](#int) | Total count of user-created notes for this design. |
|
|
| <a id="designfieldsproject"></a>`project` | [`Project!`](#project) | Project the design belongs to. |
|
|
|
|
#### `Entry`
|
|
|
|
Implementations:
|
|
|
|
- [`Blob`](#blob)
|
|
- [`Submodule`](#submodule)
|
|
- [`TreeEntry`](#treeentry)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="entryflatpath"></a>`flatPath` | [`String!`](#string) | Flat path of the entry. |
|
|
| <a id="entryid"></a>`id` | [`ID!`](#id) | ID of the entry. |
|
|
| <a id="entryname"></a>`name` | [`String!`](#string) | Name of the entry. |
|
|
| <a id="entrypath"></a>`path` | [`String!`](#string) | Path of the entry. |
|
|
| <a id="entrysha"></a>`sha` | [`String!`](#string) | Last commit SHA for the entry. |
|
|
| <a id="entrytype"></a>`type` | [`EntryType!`](#entrytype) | Type of tree entry. |
|
|
|
|
#### `Eventable`
|
|
|
|
Implementations:
|
|
|
|
- [`BoardEpic`](#boardepic)
|
|
- [`Epic`](#epic)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="eventableevents"></a>`events` | [`EventConnection`](#eventconnection) | List of events associated with the object. (see [Connections](#connections)) |
|
|
|
|
#### `MemberInterface`
|
|
|
|
Implementations:
|
|
|
|
- [`GroupMember`](#groupmember)
|
|
- [`ProjectMember`](#projectmember)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="memberinterfaceaccesslevel"></a>`accessLevel` | [`AccessLevel`](#accesslevel) | GitLab::Access level. |
|
|
| <a id="memberinterfacecreatedat"></a>`createdAt` | [`Time`](#time) | Date and time the membership was created. |
|
|
| <a id="memberinterfacecreatedby"></a>`createdBy` | [`UserCore`](#usercore) | User that authorized membership. |
|
|
| <a id="memberinterfaceexpiresat"></a>`expiresAt` | [`Time`](#time) | Date and time the membership expires. |
|
|
| <a id="memberinterfaceid"></a>`id` | [`ID!`](#id) | ID of the member. |
|
|
| <a id="memberinterfaceupdatedat"></a>`updatedAt` | [`Time`](#time) | Date and time the membership was last updated. |
|
|
| <a id="memberinterfaceuser"></a>`user` | [`UserCore`](#usercore) | User that is associated with the member object. |
|
|
|
|
##### Fields with arguments
|
|
|
|
###### `MemberInterface.mergeRequestInteraction`
|
|
|
|
Find a merge request.
|
|
|
|
Returns [`UserMergeRequestInteraction`](#usermergerequestinteraction).
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="memberinterfacemergerequestinteractionid"></a>`id` | [`MergeRequestID!`](#mergerequestid) | Global ID of the merge request. |
|
|
|
|
#### `NoteableInterface`
|
|
|
|
Implementations:
|
|
|
|
- [`AlertManagementAlert`](#alertmanagementalert)
|
|
- [`BoardEpic`](#boardepic)
|
|
- [`Design`](#design)
|
|
- [`Epic`](#epic)
|
|
- [`EpicIssue`](#epicissue)
|
|
- [`Issue`](#issue)
|
|
- [`MergeRequest`](#mergerequest)
|
|
- [`Snippet`](#snippet)
|
|
- [`Vulnerability`](#vulnerability)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="noteableinterfacediscussions"></a>`discussions` | [`DiscussionConnection!`](#discussionconnection) | All discussions on this noteable. (see [Connections](#connections)) |
|
|
| <a id="noteableinterfacenotes"></a>`notes` | [`NoteConnection!`](#noteconnection) | All notes on this noteable. (see [Connections](#connections)) |
|
|
|
|
#### `OrchestrationPolicy`
|
|
|
|
Implementations:
|
|
|
|
- [`ScanExecutionPolicy`](#scanexecutionpolicy)
|
|
- [`ScanResultPolicy`](#scanresultpolicy)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="orchestrationpolicydescription"></a>`description` | [`String!`](#string) | Description of the policy. |
|
|
| <a id="orchestrationpolicyenabled"></a>`enabled` | [`Boolean!`](#boolean) | Indicates whether this policy is enabled. |
|
|
| <a id="orchestrationpolicyname"></a>`name` | [`String!`](#string) | Name of the policy. |
|
|
| <a id="orchestrationpolicyupdatedat"></a>`updatedAt` | [`Time!`](#time) | Timestamp of when the policy YAML was last updated. |
|
|
| <a id="orchestrationpolicyyaml"></a>`yaml` | [`String!`](#string) | YAML definition of the policy. |
|
|
|
|
#### `PackageFileMetadata`
|
|
|
|
Represents metadata associated with a Package file.
|
|
|
|
Implementations:
|
|
|
|
- [`ConanFileMetadata`](#conanfilemetadata)
|
|
- [`HelmFileMetadata`](#helmfilemetadata)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="packagefilemetadatacreatedat"></a>`createdAt` | [`Time!`](#time) | Date of creation. |
|
|
| <a id="packagefilemetadataupdatedat"></a>`updatedAt` | [`Time!`](#time) | Date of most recent update. |
|
|
|
|
#### `ResolvableInterface`
|
|
|
|
Implementations:
|
|
|
|
- [`Discussion`](#discussion)
|
|
- [`Note`](#note)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="resolvableinterfaceresolvable"></a>`resolvable` | [`Boolean!`](#boolean) | Indicates if the object can be resolved. |
|
|
| <a id="resolvableinterfaceresolved"></a>`resolved` | [`Boolean!`](#boolean) | Indicates if the object is resolved. |
|
|
| <a id="resolvableinterfaceresolvedat"></a>`resolvedAt` | [`Time`](#time) | Timestamp of when the object was resolved. |
|
|
| <a id="resolvableinterfaceresolvedby"></a>`resolvedBy` | [`UserCore`](#usercore) | User who resolved the object. |
|
|
|
|
#### `Service`
|
|
|
|
Implementations:
|
|
|
|
- [`BaseService`](#baseservice)
|
|
- [`JiraService`](#jiraservice)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="serviceactive"></a>`active` | [`Boolean`](#boolean) | Indicates if the service is active. |
|
|
| <a id="serviceservicetype"></a>`serviceType` | [`ServiceType`](#servicetype) | Type of the service. |
|
|
| <a id="servicetype"></a>`type` | [`String`](#string) | Class name of the service. |
|
|
|
|
#### `TimeboxReportInterface`
|
|
|
|
Implementations:
|
|
|
|
- [`Iteration`](#iteration)
|
|
- [`Milestone`](#milestone)
|
|
|
|
##### Fields with arguments
|
|
|
|
###### `TimeboxReportInterface.report`
|
|
|
|
Historically accurate report about the timebox.
|
|
|
|
Returns [`TimeboxReport`](#timeboxreport).
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timeboxreportinterfacereportfullpath"></a>`fullPath` | [`String`](#string) | Full path of the project or group used as a scope for report. For example, `gitlab-org` or `gitlab-org/gitlab`. |
|
|
|
|
#### `Todoable`
|
|
|
|
Implementations:
|
|
|
|
- [`AlertManagementAlert`](#alertmanagementalert)
|
|
- [`BoardEpic`](#boardepic)
|
|
- [`Commit`](#commit)
|
|
- [`Design`](#design)
|
|
- [`Epic`](#epic)
|
|
- [`EpicIssue`](#epicissue)
|
|
- [`Issue`](#issue)
|
|
- [`MergeRequest`](#mergerequest)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="todoableweburl"></a>`webUrl` | [`String`](#string) | URL of this object. |
|
|
|
|
#### `User`
|
|
|
|
Representation of a GitLab user.
|
|
|
|
Implementations:
|
|
|
|
- [`MergeRequestAssignee`](#mergerequestassignee)
|
|
- [`MergeRequestAuthor`](#mergerequestauthor)
|
|
- [`MergeRequestParticipant`](#mergerequestparticipant)
|
|
- [`MergeRequestReviewer`](#mergerequestreviewer)
|
|
- [`UserCore`](#usercore)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="useravatarurl"></a>`avatarUrl` | [`String`](#string) | URL of the user's avatar. |
|
|
| <a id="userbot"></a>`bot` | [`Boolean!`](#boolean) | Indicates if the user is a bot. |
|
|
| <a id="usercallouts"></a>`callouts` | [`UserCalloutConnection`](#usercalloutconnection) | User callouts that belong to the user. (see [Connections](#connections)) |
|
|
| <a id="useremail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). |
|
|
| <a id="usergitpodenabled"></a>`gitpodEnabled` | [`Boolean`](#boolean) | Whether Gitpod is enabled at the user level. |
|
|
| <a id="usergroupcount"></a>`groupCount` | [`Int`](#int) | Group count for the user. |
|
|
| <a id="usergroupmemberships"></a>`groupMemberships` | [`GroupMemberConnection`](#groupmemberconnection) | Group memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="userid"></a>`id` | [`ID!`](#id) | ID of the user. |
|
|
| <a id="userlocation"></a>`location` | [`String`](#string) | Location of the user. |
|
|
| <a id="username"></a>`name` | [`String!`](#string) | Human-readable name of the user. Returns `****` if the user is a project bot and the requester does not have permission to view the project. |
|
|
| <a id="usernamespace"></a>`namespace` | [`Namespace`](#namespace) | Personal namespace of the user. |
|
|
| <a id="userpreferencesgitpodpath"></a>`preferencesGitpodPath` | [`String`](#string) | Web path to the Gitpod section within user preferences. |
|
|
| <a id="userprofileenablegitpodpath"></a>`profileEnableGitpodPath` | [`String`](#string) | Web path to enable Gitpod for the user. |
|
|
| <a id="userprojectmemberships"></a>`projectMemberships` | [`ProjectMemberConnection`](#projectmemberconnection) | Project memberships of the user. (see [Connections](#connections)) |
|
|
| <a id="userpublicemail"></a>`publicEmail` | [`String`](#string) | User's public email. |
|
|
| <a id="usersavedreplies"></a>`savedReplies` | [`SavedReplyConnection`](#savedreplyconnection) | Saved replies authored by the user. Will not return saved replies if `saved_replies` feature flag is disabled. (see [Connections](#connections)) |
|
|
| <a id="userstate"></a>`state` | [`UserState!`](#userstate) | State of the user. |
|
|
| <a id="userstatus"></a>`status` | [`UserStatus`](#userstatus) | User status. |
|
|
| <a id="useruserpermissions"></a>`userPermissions` | [`UserPermissions!`](#userpermissions) | Permissions for the current user on the resource. |
|
|
| <a id="userusername"></a>`username` | [`String!`](#string) | Username of the user. Unique within this instance of GitLab. |
|
|
| <a id="userwebpath"></a>`webPath` | [`String!`](#string) | Web path of the user. |
|
|
| <a id="userweburl"></a>`webUrl` | [`String!`](#string) | Web URL of the user. |
|
|
|
|
##### Fields with arguments
|
|
|
|
###### `User.assignedMergeRequests`
|
|
|
|
Merge requests assigned to the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="userassignedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="userassignedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="userassignedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="userassignedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="userassignedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="userassignedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="userassignedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="userassignedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="userassignedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="userassignedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="userassignedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="userassignedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="userassignedmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="userassignedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="userassignedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="userassignedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="userassignedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="userassignedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="userassignedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
###### `User.authoredMergeRequests`
|
|
|
|
Merge requests authored by the user.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="userauthoredmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="userauthoredmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="userauthoredmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="userauthoredmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="userauthoredmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="userauthoredmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="userauthoredmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="userauthoredmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="userauthoredmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="userauthoredmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="userauthoredmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="userauthoredmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="userauthoredmergerequestsreviewerusername"></a>`reviewerUsername` | [`String`](#string) | Username of the reviewer. |
|
|
| <a id="userauthoredmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="userauthoredmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="userauthoredmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="userauthoredmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="userauthoredmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="userauthoredmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
###### `User.groups`
|
|
|
|
Groups where the user has access.
|
|
|
|
Returns [`GroupConnection`](#groupconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usergroupspermissionscope"></a>`permissionScope` | [`GroupPermission`](#grouppermission) | Filter by permissions the user has on groups. |
|
|
| <a id="usergroupssearch"></a>`search` | [`String`](#string) | Search by group name or path. |
|
|
|
|
###### `User.reviewRequestedMergeRequests`
|
|
|
|
Merge requests assigned to the user for review.
|
|
|
|
Returns [`MergeRequestConnection`](#mergerequestconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="userreviewrequestedmergerequestsassigneeusername"></a>`assigneeUsername` | [`String`](#string) | Username of the assignee. |
|
|
| <a id="userreviewrequestedmergerequestsauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author. |
|
|
| <a id="userreviewrequestedmergerequestscreatedafter"></a>`createdAfter` | [`Time`](#time) | Merge requests created after this timestamp. |
|
|
| <a id="userreviewrequestedmergerequestscreatedbefore"></a>`createdBefore` | [`Time`](#time) | Merge requests created before this timestamp. |
|
|
| <a id="userreviewrequestedmergerequestsdraft"></a>`draft` | [`Boolean`](#boolean) | Limit result to draft merge requests. |
|
|
| <a id="userreviewrequestedmergerequestsiids"></a>`iids` | [`[String!]`](#string) | Array of IIDs of merge requests, for example `[1, 2]`. |
|
|
| <a id="userreviewrequestedmergerequestslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will have all of these labels. |
|
|
| <a id="userreviewrequestedmergerequestsmergedafter"></a>`mergedAfter` | [`Time`](#time) | Merge requests merged after this date. |
|
|
| <a id="userreviewrequestedmergerequestsmergedbefore"></a>`mergedBefore` | [`Time`](#time) | Merge requests merged before this date. |
|
|
| <a id="userreviewrequestedmergerequestsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
| <a id="userreviewrequestedmergerequestsnot"></a>`not` | [`MergeRequestsResolverNegatedParams`](#mergerequestsresolvernegatedparams) | List of negated arguments. Warning: this argument is experimental and a subject to change in future. |
|
|
| <a id="userreviewrequestedmergerequestsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | The global ID of the project the authored merge requests should be in. Incompatible with projectPath. |
|
|
| <a id="userreviewrequestedmergerequestsprojectpath"></a>`projectPath` | [`String`](#string) | The full-path of the project the authored merge requests should be in. Incompatible with projectId. |
|
|
| <a id="userreviewrequestedmergerequestssort"></a>`sort` | [`MergeRequestSort`](#mergerequestsort) | Sort merge requests by this criteria. |
|
|
| <a id="userreviewrequestedmergerequestssourcebranches"></a>`sourceBranches` | [`[String!]`](#string) | Array of source branch names. All resolved merge requests will have one of these branches as their source. |
|
|
| <a id="userreviewrequestedmergerequestsstate"></a>`state` | [`MergeRequestState`](#mergerequeststate) | Merge request state. If provided, all resolved merge requests will have this state. |
|
|
| <a id="userreviewrequestedmergerequeststargetbranches"></a>`targetBranches` | [`[String!]`](#string) | Array of target branch names. All resolved merge requests will have one of these branches as their target. |
|
|
| <a id="userreviewrequestedmergerequestsupdatedafter"></a>`updatedAfter` | [`Time`](#time) | Merge requests updated after this timestamp. |
|
|
| <a id="userreviewrequestedmergerequestsupdatedbefore"></a>`updatedBefore` | [`Time`](#time) | Merge requests updated before this timestamp. |
|
|
|
|
###### `User.snippets`
|
|
|
|
Snippets authored by the user.
|
|
|
|
Returns [`SnippetConnection`](#snippetconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usersnippetsids"></a>`ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. |
|
|
| <a id="usersnippetstype"></a>`type` | [`TypeEnum`](#typeenum) | Type of snippet. |
|
|
| <a id="usersnippetsvisibility"></a>`visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. |
|
|
|
|
###### `User.starredProjects`
|
|
|
|
Projects starred by the user.
|
|
|
|
Returns [`ProjectConnection`](#projectconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="userstarredprojectssearch"></a>`search` | [`String`](#string) | Search query. |
|
|
|
|
###### `User.timelogs`
|
|
|
|
Time logged by the user.
|
|
|
|
Returns [`TimelogConnection`](#timelogconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usertimelogsenddate"></a>`endDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or before endDate. |
|
|
| <a id="usertimelogsendtime"></a>`endTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or before endTime. |
|
|
| <a id="usertimelogsgroupid"></a>`groupId` | [`GroupID`](#groupid) | List timelogs for a group. |
|
|
| <a id="usertimelogsprojectid"></a>`projectId` | [`ProjectID`](#projectid) | List timelogs for a project. |
|
|
| <a id="usertimelogsstartdate"></a>`startDate` | [`Time`](#time) | List timelogs within a date range where the logged date is equal to or after startDate. |
|
|
| <a id="usertimelogsstarttime"></a>`startTime` | [`Time`](#time) | List timelogs within a time range where the logged time is equal to or after startTime. |
|
|
| <a id="usertimelogsusername"></a>`username` | [`String`](#string) | List timelogs for a user. |
|
|
|
|
###### `User.todos`
|
|
|
|
To-do items of the user.
|
|
|
|
Returns [`TodoConnection`](#todoconnection).
|
|
|
|
This field returns a [connection](#connections). It accepts the
|
|
four standard [pagination arguments](#connection-pagination-arguments):
|
|
`before: String`, `after: String`, `first: Int`, `last: Int`.
|
|
|
|
####### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="usertodosaction"></a>`action` | [`[TodoActionEnum!]`](#todoactionenum) | Action to be filtered. |
|
|
| <a id="usertodosauthorid"></a>`authorId` | [`[ID!]`](#id) | ID of an author. |
|
|
| <a id="usertodosgroupid"></a>`groupId` | [`[ID!]`](#id) | ID of a group. |
|
|
| <a id="usertodosprojectid"></a>`projectId` | [`[ID!]`](#id) | ID of a project. |
|
|
| <a id="usertodosstate"></a>`state` | [`[TodoStateEnum!]`](#todostateenum) | State of the todo. |
|
|
| <a id="usertodostype"></a>`type` | [`[TodoTargetEnum!]`](#todotargetenum) | Type of the todo. |
|
|
|
|
#### `WorkItemWidget`
|
|
|
|
Implementations:
|
|
|
|
- [`WorkItemWidgetDescription`](#workitemwidgetdescription)
|
|
- [`WorkItemWidgetHierarchy`](#workitemwidgethierarchy)
|
|
|
|
##### Fields
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemwidgettype"></a>`type` | [`WorkItemWidgetType`](#workitemwidgettype) | Widget type. |
|
|
|
|
## Input types
|
|
|
|
Types that may be used as arguments (all scalar types may also
|
|
be used as arguments).
|
|
|
|
Only general use input types are listed here. For mutation input types,
|
|
see the associated mutation type above.
|
|
|
|
### `AlertManagementPayloadAlertFieldInput`
|
|
|
|
Field that are available while modifying the custom mapping attributes for an HTTP integration.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="alertmanagementpayloadalertfieldinputfieldname"></a>`fieldName` | [`AlertManagementPayloadAlertFieldName!`](#alertmanagementpayloadalertfieldname) | GitLab alert field name. |
|
|
| <a id="alertmanagementpayloadalertfieldinputlabel"></a>`label` | [`String`](#string) | Human-readable label of the payload path. |
|
|
| <a id="alertmanagementpayloadalertfieldinputpath"></a>`path` | [`[PayloadAlertFieldPathSegment!]!`](#payloadalertfieldpathsegment) | Path to value inside payload JSON. |
|
|
| <a id="alertmanagementpayloadalertfieldinputtype"></a>`type` | [`AlertManagementPayloadAlertFieldType!`](#alertmanagementpayloadalertfieldtype) | Type of the parsed value. |
|
|
|
|
### `BoardIssueInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="boardissueinputassigneeusername"></a>`assigneeUsername` | [`[String]`](#string) | Filter by assignee username. |
|
|
| <a id="boardissueinputassigneewildcardid"></a>`assigneeWildcardId` | [`AssigneeWildcardId`](#assigneewildcardid) | Filter by assignee wildcard. Incompatible with assigneeUsername. |
|
|
| <a id="boardissueinputauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. |
|
|
| <a id="boardissueinputconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter by confidentiality. |
|
|
| <a id="boardissueinputepicid"></a>`epicId` | [`EpicID`](#epicid) | Filter by epic ID. Incompatible with epicWildcardId. |
|
|
| <a id="boardissueinputepicwildcardid"></a>`epicWildcardId` | [`EpicWildcardId`](#epicwildcardid) | Filter by epic ID wildcard. Incompatible with epicId. |
|
|
| <a id="boardissueinputiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example `["1", "2"]`. |
|
|
| <a id="boardissueinputiterationcadenceid"></a>`iterationCadenceId` | [`[IterationsCadenceID!]`](#iterationscadenceid) | Filter by a list of iteration cadence IDs. |
|
|
| <a id="boardissueinputiterationid"></a>`iterationId` | [`[IterationID!]`](#iterationid) | Filter by a list of iteration IDs. Incompatible with iterationWildcardId. |
|
|
| <a id="boardissueinputiterationtitle"></a>`iterationTitle` | [`String`](#string) | Filter by iteration title. |
|
|
| <a id="boardissueinputiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by iteration ID wildcard. |
|
|
| <a id="boardissueinputlabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. |
|
|
| <a id="boardissueinputmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter by milestone title. |
|
|
| <a id="boardissueinputmilestonewildcardid"></a>`milestoneWildcardId` | [`MilestoneWildcardId`](#milestonewildcardid) | Filter by milestone ID wildcard. |
|
|
| <a id="boardissueinputmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="boardissueinputnot"></a>`not` | [`NegatedBoardIssueInput`](#negatedboardissueinput) | List of negated arguments. |
|
|
| <a id="boardissueinputreleasetag"></a>`releaseTag` | [`String`](#string) | Filter by release tag. |
|
|
| <a id="boardissueinputsearch"></a>`search` | [`String`](#string) | Search query for issue title or description. |
|
|
| <a id="boardissueinputtypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter by the given issue types. |
|
|
| <a id="boardissueinputweight"></a>`weight` | [`String`](#string) | Filter by weight. |
|
|
| <a id="boardissueinputweightwildcardid"></a>`weightWildcardId` | [`WeightWildcardId`](#weightwildcardid) | Filter by weight ID wildcard. Incompatible with weight. |
|
|
|
|
### `CommitAction`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="commitactionaction"></a>`action` | [`CommitActionMode!`](#commitactionmode) | Action to perform: create, delete, move, update, or chmod. |
|
|
| <a id="commitactioncontent"></a>`content` | [`String`](#string) | Content of the file. |
|
|
| <a id="commitactionencoding"></a>`encoding` | [`CommitEncoding`](#commitencoding) | Encoding of the file. Default is text. |
|
|
| <a id="commitactionexecutefilemode"></a>`executeFilemode` | [`Boolean`](#boolean) | Enables/disables the execute flag on the file. |
|
|
| <a id="commitactionfilepath"></a>`filePath` | [`String!`](#string) | Full path to the file. |
|
|
| <a id="commitactionlastcommitid"></a>`lastCommitId` | [`String`](#string) | Last known file commit ID. |
|
|
| <a id="commitactionpreviouspath"></a>`previousPath` | [`String`](#string) | Original full path to the file being moved. |
|
|
|
|
### `ComplianceFrameworkInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="complianceframeworkinputcolor"></a>`color` | [`String`](#string) | New color representation of the compliance framework in hex format. e.g. #FCA121. |
|
|
| <a id="complianceframeworkinputdescription"></a>`description` | [`String`](#string) | New description for the compliance framework. |
|
|
| <a id="complianceframeworkinputname"></a>`name` | [`String`](#string) | New name for the compliance framework. |
|
|
| <a id="complianceframeworkinputpipelineconfigurationfullpath"></a>`pipelineConfigurationFullPath` | [`String`](#string) | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. |
|
|
|
|
### `ComplianceViolationInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="complianceviolationinputmergedafter"></a>`mergedAfter` | [`Date`](#date) | Merge requests merged after this date (inclusive). |
|
|
| <a id="complianceviolationinputmergedbefore"></a>`mergedBefore` | [`Date`](#date) | Merge requests merged before this date (inclusive). |
|
|
| <a id="complianceviolationinputprojectids"></a>`projectIds` | [`[ProjectID!]`](#projectid) | Filter compliance violations by project. |
|
|
|
|
### `DastProfileCadenceInput`
|
|
|
|
Represents DAST Profile Cadence.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastprofilecadenceinputduration"></a>`duration` | [`Int`](#int) | Duration of the DAST Profile Cadence. |
|
|
| <a id="dastprofilecadenceinputunit"></a>`unit` | [`DastProfileCadenceUnit`](#dastprofilecadenceunit) | Unit for the duration of DAST Profile Cadence. |
|
|
|
|
### `DastProfileScheduleInput`
|
|
|
|
Input type for DAST Profile Schedules.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastprofilescheduleinputactive"></a>`active` | [`Boolean`](#boolean) | Status of a Dast Profile Schedule. |
|
|
| <a id="dastprofilescheduleinputcadence"></a>`cadence` | [`DastProfileCadenceInput`](#dastprofilecadenceinput) | Cadence of a Dast Profile Schedule. |
|
|
| <a id="dastprofilescheduleinputstartsat"></a>`startsAt` | [`Time`](#time) | Start time of a Dast Profile Schedule. |
|
|
| <a id="dastprofilescheduleinputtimezone"></a>`timezone` | [`String`](#string) | Time Zone for the Start time of a Dast Profile Schedule. |
|
|
|
|
### `DastSiteProfileAuthInput`
|
|
|
|
Input type for DastSiteProfile authentication.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="dastsiteprofileauthinputenabled"></a>`enabled` | [`Boolean`](#boolean) | Indicates whether authentication is enabled. |
|
|
| <a id="dastsiteprofileauthinputpassword"></a>`password` | [`String`](#string) | Password to authenticate with on the target website. |
|
|
| <a id="dastsiteprofileauthinputpasswordfield"></a>`passwordField` | [`String`](#string) | Name of password field at the sign-in HTML form. |
|
|
| <a id="dastsiteprofileauthinputsubmitfield"></a>`submitField` | [`String`](#string) | Name or ID of sign-in submit button at the sign-in HTML form. |
|
|
| <a id="dastsiteprofileauthinputurl"></a>`url` | [`String`](#string) | The URL of the page containing the sign-in HTML form on the target website. |
|
|
| <a id="dastsiteprofileauthinputusername"></a>`username` | [`String`](#string) | Username to authenticate with on the target website. |
|
|
| <a id="dastsiteprofileauthinputusernamefield"></a>`usernameField` | [`String`](#string) | Name of username field at the sign-in HTML form. |
|
|
|
|
### `DiffImagePositionInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="diffimagepositioninputbasesha"></a>`baseSha` | [`String`](#string) | Merge base of the branch the comment was made on. |
|
|
| <a id="diffimagepositioninputheadsha"></a>`headSha` | [`String!`](#string) | SHA of the HEAD at the time the comment was made. |
|
|
| <a id="diffimagepositioninputheight"></a>`height` | [`Int!`](#int) | Total height of the image. |
|
|
| <a id="diffimagepositioninputpaths"></a>`paths` | [`DiffPathsInput!`](#diffpathsinput) | The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required. |
|
|
| <a id="diffimagepositioninputstartsha"></a>`startSha` | [`String!`](#string) | SHA of the branch being compared against. |
|
|
| <a id="diffimagepositioninputwidth"></a>`width` | [`Int!`](#int) | Total width of the image. |
|
|
| <a id="diffimagepositioninputx"></a>`x` | [`Int!`](#int) | X position of the note. |
|
|
| <a id="diffimagepositioninputy"></a>`y` | [`Int!`](#int) | Y position of the note. |
|
|
|
|
### `DiffPathsInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="diffpathsinputnewpath"></a>`newPath` | [`String`](#string) | Path of the file on the HEAD SHA. |
|
|
| <a id="diffpathsinputoldpath"></a>`oldPath` | [`String`](#string) | Path of the file on the start SHA. |
|
|
|
|
### `DiffPositionInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="diffpositioninputbasesha"></a>`baseSha` | [`String`](#string) | Merge base of the branch the comment was made on. |
|
|
| <a id="diffpositioninputheadsha"></a>`headSha` | [`String!`](#string) | SHA of the HEAD at the time the comment was made. |
|
|
| <a id="diffpositioninputnewline"></a>`newLine` | [`Int`](#int) | Line on HEAD SHA that was changed. Please see the [REST API Documentation](https://docs.gitlab.com/ee/api/discussions.html#create-a-new-thread-in-the-merge-request-diff) for more information on how to use this field. |
|
|
| <a id="diffpositioninputoldline"></a>`oldLine` | [`Int`](#int) | Line on start SHA that was changed. Please see the [REST API Documentation](https://docs.gitlab.com/ee/api/discussions.html#create-a-new-thread-in-the-merge-request-diff) for more information on how to use this field. |
|
|
| <a id="diffpositioninputpaths"></a>`paths` | [`DiffPathsInput!`](#diffpathsinput) | The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required. |
|
|
| <a id="diffpositioninputstartsha"></a>`startSha` | [`String!`](#string) | SHA of the branch being compared against. |
|
|
|
|
### `EpicFilters`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epicfiltersauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. |
|
|
| <a id="epicfiltersconfidential"></a>`confidential` | [`Boolean`](#boolean) | Filter by confidentiality. |
|
|
| <a id="epicfilterslabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. |
|
|
| <a id="epicfiltersmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="epicfiltersnot"></a>`not` | [`NegatedEpicBoardIssueInput`](#negatedepicboardissueinput) | Negated epic arguments. |
|
|
| <a id="epicfilterssearch"></a>`search` | [`String`](#string) | Search query for epic title or description. |
|
|
|
|
### `EpicTreeNodeFieldsInputType`
|
|
|
|
A node of an epic tree.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="epictreenodefieldsinputtypeadjacentreferenceid"></a>`adjacentReferenceId` | [`EpicTreeSortingID`](#epictreesortingid) | ID of the epic issue or issue the epic or issue is switched with. |
|
|
| <a id="epictreenodefieldsinputtypeid"></a>`id` | [`EpicTreeSortingID!`](#epictreesortingid) | ID of the epic issue or epic that is being moved. |
|
|
| <a id="epictreenodefieldsinputtypenewparentid"></a>`newParentId` | [`EpicID`](#epicid) | ID of the new parent epic. |
|
|
| <a id="epictreenodefieldsinputtyperelativeposition"></a>`relativePosition` | [`MoveType`](#movetype) | Type of switch. Valid values are `after` or `before`. |
|
|
|
|
### `EscalationRuleInput`
|
|
|
|
Represents an escalation rule.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="escalationruleinputelapsedtimeseconds"></a>`elapsedTimeSeconds` | [`Int!`](#int) | Time in seconds before the rule is activated. |
|
|
| <a id="escalationruleinputoncallscheduleiid"></a>`oncallScheduleIid` | [`ID`](#id) | On-call schedule to notify. |
|
|
| <a id="escalationruleinputstatus"></a>`status` | [`EscalationRuleStatus!`](#escalationrulestatus) | Status required to prevent the rule from activating. |
|
|
| <a id="escalationruleinputusername"></a>`username` | [`String`](#string) | Username of the user to notify. |
|
|
|
|
### `JiraUsersMappingInputType`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="jirausersmappinginputtypegitlabid"></a>`gitlabId` | [`Int`](#int) | ID of the GitLab user. |
|
|
| <a id="jirausersmappinginputtypejiraaccountid"></a>`jiraAccountId` | [`String!`](#string) | Jira account ID of the user. |
|
|
|
|
### `MergeRequestsResolverNegatedParams`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="mergerequestsresolvernegatedparamslabels"></a>`labels` | [`[String!]`](#string) | Array of label names. All resolved merge requests will not have these labels. |
|
|
| <a id="mergerequestsresolvernegatedparamsmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Title of the milestone. |
|
|
|
|
### `NegatedBoardIssueInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="negatedboardissueinputassigneeusername"></a>`assigneeUsername` | [`[String]`](#string) | Filter by assignee username. |
|
|
| <a id="negatedboardissueinputauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. |
|
|
| <a id="negatedboardissueinputepicid"></a>`epicId` | [`EpicID`](#epicid) | Filter by epic ID. Incompatible with epicWildcardId. |
|
|
| <a id="negatedboardissueinputiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues. For example `["1", "2"]`. |
|
|
| <a id="negatedboardissueinputiterationid"></a>`iterationId` | [`[IterationID!]`](#iterationid) | Filter by a list of iteration IDs. Incompatible with iterationWildcardId. |
|
|
| <a id="negatedboardissueinputiterationtitle"></a>`iterationTitle` | [`String`](#string) | Filter by iteration title. |
|
|
| <a id="negatedboardissueinputiterationwildcardid"></a>`iterationWildcardId` | [`NegatedIterationWildcardId`](#negatediterationwildcardid) | Filter by iteration ID wildcard. |
|
|
| <a id="negatedboardissueinputlabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. |
|
|
| <a id="negatedboardissueinputmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Filter by milestone title. |
|
|
| <a id="negatedboardissueinputmilestonewildcardid"></a>`milestoneWildcardId` | [`MilestoneWildcardId`](#milestonewildcardid) | Filter by milestone ID wildcard. |
|
|
| <a id="negatedboardissueinputmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
|
|
| <a id="negatedboardissueinputreleasetag"></a>`releaseTag` | [`String`](#string) | Filter by release tag. |
|
|
| <a id="negatedboardissueinputtypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filter by the given issue types. |
|
|
| <a id="negatedboardissueinputweight"></a>`weight` | [`String`](#string) | Filter by weight. |
|
|
|
|
### `NegatedEpicBoardIssueInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="negatedepicboardissueinputauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. |
|
|
| <a id="negatedepicboardissueinputlabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. |
|
|
| <a id="negatedepicboardissueinputmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
|
|
|
|
### `NegatedEpicFilterInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="negatedepicfilterinputauthorusername"></a>`authorUsername` | [`String`](#string) | Filter by author username. |
|
|
| <a id="negatedepicfilterinputlabelname"></a>`labelName` | [`[String]`](#string) | Filter by label name. |
|
|
| <a id="negatedepicfilterinputmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. |
|
|
|
|
### `NegatedIssueFilterInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="negatedissuefilterinputassigneeid"></a>`assigneeId` | [`String`](#string) | ID of a user not assigned to the issues. |
|
|
| <a id="negatedissuefilterinputassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users not assigned to the issue. |
|
|
| <a id="negatedissuefilterinputauthorusername"></a>`authorUsername` | [`String`](#string) | Username of a user who didn't author the issue. |
|
|
| <a id="negatedissuefilterinputepicid"></a>`epicId` | [`String`](#string) | ID of an epic not associated with the issues. |
|
|
| <a id="negatedissuefilterinputiids"></a>`iids` | [`[String!]`](#string) | List of IIDs of issues to exclude. For example, `[1, 2]`. |
|
|
| <a id="negatedissuefilterinputiterationid"></a>`iterationId` | [`[ID!]`](#id) | List of iteration Global IDs not applied to the issue. |
|
|
| <a id="negatedissuefilterinputiterationwildcardid"></a>`iterationWildcardId` | [`IterationWildcardId`](#iterationwildcardid) | Filter by negated iteration ID wildcard. |
|
|
| <a id="negatedissuefilterinputlabelname"></a>`labelName` | [`[String!]`](#string) | Labels not applied to this issue. |
|
|
| <a id="negatedissuefilterinputmilestonetitle"></a>`milestoneTitle` | [`[String!]`](#string) | Milestone not applied to this issue. |
|
|
| <a id="negatedissuefilterinputmilestonewildcardid"></a>`milestoneWildcardId` | [`NegatedMilestoneWildcardId`](#negatedmilestonewildcardid) | Filter by negated milestone wildcard values. |
|
|
| <a id="negatedissuefilterinputmyreactionemoji"></a>`myReactionEmoji` | [`String`](#string) | Filter by reaction emoji applied by the current user. |
|
|
| <a id="negatedissuefilterinputreleasetag"></a>`releaseTag` | [`[String!]`](#string) | Release tag not associated with the issue's milestone. Ignored when parent is a group. |
|
|
| <a id="negatedissuefilterinputtypes"></a>`types` | [`[IssueType!]`](#issuetype) | Filters out issues by the given issue types. |
|
|
| <a id="negatedissuefilterinputweight"></a>`weight` | [`String`](#string) | Weight not applied to the issue. |
|
|
|
|
### `OncallRotationActivePeriodInputType`
|
|
|
|
Active period time range for on-call rotation.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="oncallrotationactiveperiodinputtypeendtime"></a>`endTime` | [`String!`](#string) | End of the rotation active period in 24 hour format. For example, "18:30". |
|
|
| <a id="oncallrotationactiveperiodinputtypestarttime"></a>`startTime` | [`String!`](#string) | Start of the rotation active period in 24 hour format. For example, "18:30". |
|
|
|
|
### `OncallRotationDateInputType`
|
|
|
|
Date input type for on-call rotation.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="oncallrotationdateinputtypedate"></a>`date` | [`String!`](#string) | Date component of the date in YYYY-MM-DD format. |
|
|
| <a id="oncallrotationdateinputtypetime"></a>`time` | [`String!`](#string) | Time component of the date in 24hr HH:MM format. |
|
|
|
|
### `OncallRotationLengthInputType`
|
|
|
|
The rotation length of the on-call rotation.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="oncallrotationlengthinputtypelength"></a>`length` | [`Int!`](#int) | Rotation length of the on-call rotation. |
|
|
| <a id="oncallrotationlengthinputtypeunit"></a>`unit` | [`OncallRotationUnitEnum!`](#oncallrotationunitenum) | Unit of the rotation length of the on-call rotation. |
|
|
|
|
### `OncallUserInputType`
|
|
|
|
The rotation user and color palette.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="oncalluserinputtypecolorpalette"></a>`colorPalette` | [`DataVisualizationColorEnum`](#datavisualizationcolorenum) | Value of DataVisualizationColorEnum. The color from the palette to assign to the on-call user. |
|
|
| <a id="oncalluserinputtypecolorweight"></a>`colorWeight` | [`DataVisualizationWeightEnum`](#datavisualizationweightenum) | Color weight to assign to for the on-call user. To view on-call schedules in GitLab, do not provide a value below 500. A value between 500 and 950 ensures sufficient contrast. |
|
|
| <a id="oncalluserinputtypeusername"></a>`username` | [`String!`](#string) | Username of the user to participate in the on-call rotation. For example, `"user_one"`. |
|
|
|
|
### `ReleaseAssetLinkInput`
|
|
|
|
Fields that are available when modifying a release asset link.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseassetlinkinputdirectassetpath"></a>`directAssetPath` | [`String`](#string) | Relative path for a direct asset link. |
|
|
| <a id="releaseassetlinkinputlinktype"></a>`linkType` | [`ReleaseAssetLinkType`](#releaseassetlinktype) | Type of the asset link. |
|
|
| <a id="releaseassetlinkinputname"></a>`name` | [`String!`](#string) | Name of the asset link. |
|
|
| <a id="releaseassetlinkinputurl"></a>`url` | [`String!`](#string) | URL of the asset link. |
|
|
|
|
### `ReleaseAssetsInput`
|
|
|
|
Fields that are available when modifying release assets.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="releaseassetsinputlinks"></a>`links` | [`[ReleaseAssetLinkInput!]`](#releaseassetlinkinput) | List of asset links to associate to the release. |
|
|
|
|
### `SastCiConfigurationAnalyzersEntityInput`
|
|
|
|
Represents the analyzers entity in SAST CI configuration.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationanalyzersentityinputenabled"></a>`enabled` | [`Boolean!`](#boolean) | State of the analyzer. |
|
|
| <a id="sastciconfigurationanalyzersentityinputname"></a>`name` | [`String!`](#string) | Name of analyzer. |
|
|
| <a id="sastciconfigurationanalyzersentityinputvariables"></a>`variables` | [`[SastCiConfigurationEntityInput!]`](#sastciconfigurationentityinput) | List of variables for the analyzer. |
|
|
|
|
### `SastCiConfigurationEntityInput`
|
|
|
|
Represents an entity in SAST CI configuration.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationentityinputdefaultvalue"></a>`defaultValue` | [`String!`](#string) | Default value that is used if value is empty. |
|
|
| <a id="sastciconfigurationentityinputfield"></a>`field` | [`String!`](#string) | CI keyword of entity. |
|
|
| <a id="sastciconfigurationentityinputvalue"></a>`value` | [`String!`](#string) | Current value of the entity. |
|
|
|
|
### `SastCiConfigurationInput`
|
|
|
|
Represents a CI configuration of SAST.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="sastciconfigurationinputanalyzers"></a>`analyzers` | [`[SastCiConfigurationAnalyzersEntityInput!]`](#sastciconfigurationanalyzersentityinput) | List of analyzers and related variables for the SAST configuration. |
|
|
| <a id="sastciconfigurationinputglobal"></a>`global` | [`[SastCiConfigurationEntityInput!]`](#sastciconfigurationentityinput) | List of global entities related to SAST configuration. |
|
|
| <a id="sastciconfigurationinputpipeline"></a>`pipeline` | [`[SastCiConfigurationEntityInput!]`](#sastciconfigurationentityinput) | List of pipeline entities related to SAST configuration. |
|
|
|
|
### `SnippetBlobActionInputType`
|
|
|
|
Represents an action to perform over a snippet file.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="snippetblobactioninputtypeaction"></a>`action` | [`SnippetBlobActionEnum!`](#snippetblobactionenum) | Type of input action. |
|
|
| <a id="snippetblobactioninputtypecontent"></a>`content` | [`String`](#string) | Snippet file content. |
|
|
| <a id="snippetblobactioninputtypefilepath"></a>`filePath` | [`String!`](#string) | Path of the snippet file. |
|
|
| <a id="snippetblobactioninputtypepreviouspath"></a>`previousPath` | [`String`](#string) | Previous path of the snippet file. |
|
|
|
|
### `Timeframe`
|
|
|
|
A time-frame defined as a closed inclusive range of two dates.
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="timeframeend"></a>`end` | [`Date!`](#date) | End of the range. |
|
|
| <a id="timeframestart"></a>`start` | [`Date!`](#date) | Start of the range. |
|
|
|
|
### `UpdateDiffImagePositionInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="updatediffimagepositioninputheight"></a>`height` | [`Int`](#int) | Total height of the image. |
|
|
| <a id="updatediffimagepositioninputwidth"></a>`width` | [`Int`](#int) | Total width of the image. |
|
|
| <a id="updatediffimagepositioninputx"></a>`x` | [`Int`](#int) | X position of the note. |
|
|
| <a id="updatediffimagepositioninputy"></a>`y` | [`Int`](#int) | Y position of the note. |
|
|
|
|
### `VulnerabilityIdentifierInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityidentifierinputexternalid"></a>`externalId` | [`String`](#string) | External ID of the vulnerability identifier. |
|
|
| <a id="vulnerabilityidentifierinputexternaltype"></a>`externalType` | [`String`](#string) | External type of the vulnerability identifier. |
|
|
| <a id="vulnerabilityidentifierinputname"></a>`name` | [`String!`](#string) | Name of the vulnerability identifier. |
|
|
| <a id="vulnerabilityidentifierinputurl"></a>`url` | [`String!`](#string) | URL of the vulnerability identifier. |
|
|
|
|
### `VulnerabilityScannerInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityscannerinputid"></a>`id` | [`String!`](#string) | Unique ID that identifies the scanner. |
|
|
| <a id="vulnerabilityscannerinputname"></a>`name` | [`String!`](#string) | Human readable value that identifies the analyzer, not required to be unique. |
|
|
| <a id="vulnerabilityscannerinputurl"></a>`url` | [`String!`](#string) | Link to more information about the analyzer. |
|
|
| <a id="vulnerabilityscannerinputvendor"></a>`vendor` | [`VulnerabilityScannerVendorInput`](#vulnerabilityscannervendorinput) | Information about vendor/maintainer of the scanner. |
|
|
| <a id="vulnerabilityscannerinputversion"></a>`version` | [`String!`](#string) | Version of the scanner. |
|
|
|
|
### `VulnerabilityScannerVendorInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="vulnerabilityscannervendorinputname"></a>`name` | [`String!`](#string) | Name of the vendor/maintainer. |
|
|
|
|
### `WorkItemConvertTaskInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemconverttaskinputlinenumberend"></a>`lineNumberEnd` | [`Int!`](#int) | Last line in the Markdown source that defines the list item task. |
|
|
| <a id="workitemconverttaskinputlinenumberstart"></a>`lineNumberStart` | [`Int!`](#int) | First line in the Markdown source that defines the list item task. |
|
|
| <a id="workitemconverttaskinputlockversion"></a>`lockVersion` | [`Int!`](#int) | Current lock version of the work item containing the task in the description. |
|
|
| <a id="workitemconverttaskinputtitle"></a>`title` | [`String!`](#string) | Full string of the task to be replaced. New title for the created work item. |
|
|
| <a id="workitemconverttaskinputworkitemtypeid"></a>`workItemTypeId` | [`WorkItemsTypeID!`](#workitemstypeid) | Global ID of the work item type used to create the new work item. |
|
|
|
|
### `WorkItemDeletedTaskInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemdeletedtaskinputid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the task referenced in the work item's description. |
|
|
| <a id="workitemdeletedtaskinputlinenumberend"></a>`lineNumberEnd` | [`Int!`](#int) | Last line in the Markdown source that defines the list item task. |
|
|
| <a id="workitemdeletedtaskinputlinenumberstart"></a>`lineNumberStart` | [`Int!`](#int) | First line in the Markdown source that defines the list item task. |
|
|
|
|
### `WorkItemUpdatedTaskInput`
|
|
|
|
#### Arguments
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| <a id="workitemupdatedtaskinputid"></a>`id` | [`WorkItemID!`](#workitemid) | Global ID of the work item. |
|
|
| <a id="workitemupdatedtaskinputstateevent"></a>`stateEvent` | [`WorkItemStateEvent`](#workitemstateevent) | Close or reopen a work item. |
|
|
| <a id="workitemupdatedtaskinputtitle"></a>`title` | [`String`](#string) | Title of the work item. |
|