diff options
Diffstat (limited to 'doc/api/graphql/reference/index.md')
| -rw-r--r-- | doc/api/graphql/reference/index.md | 384 |
1 files changed, 337 insertions, 47 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 4d3d77ba35f..4164c26e751 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -24,7 +24,17 @@ Autogenerated return type of AddAwardEmoji | --- | ---- | ---------- | | `awardEmoji` | AwardEmoji | The award emoji after mutation | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + +## AddProjectToSecurityDashboardPayload + +Autogenerated return type of AddProjectToSecurityDashboard + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `project` | Project | Project that was added to the Instance Security Dashboard | ## AdminSidekiqQueuesDeleteJobsPayload @@ -33,9 +43,44 @@ Autogenerated return type of AdminSidekiqQueuesDeleteJobs | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `result` | DeleteJobsResponse | Information about the status of the deletion request | +## AlertManagementAlert + +Describes an alert from the project's Alert Management + +| Name | Type | Description | +| --- | ---- | ---------- | +| `createdAt` | Time | Timestamp the alert was created | +| `description` | String | Description of the alert | +| `details` | JSON | Alert details | +| `endedAt` | Time | Timestamp the alert ended | +| `eventCount` | Int | Number of events of this alert | +| `hosts` | String! => Array | List of hosts the alert came from | +| `iid` | ID! | Internal ID of the alert | +| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert | +| `monitoringTool` | String | Monitoring tool the alert came from | +| `service` | String | Service the alert came from | +| `severity` | AlertManagementSeverity | Severity of the alert | +| `startedAt` | Time | Timestamp the alert was raised | +| `status` | AlertManagementStatus | Status of the alert | +| `title` | String | Title of the alert | +| `updatedAt` | Time | Timestamp the alert was last updated | + +## AlertManagementAlertStatusCountsType + +Represents total number of alerts for the represented categories + +| Name | Type | Description | +| --- | ---- | ---------- | +| `acknowledged` | Int | Number of alerts with status ACKNOWLEDGED for the project | +| `all` | Int | Total number of alerts for the project | +| `ignored` | Int | Number of alerts with status IGNORED for the project | +| `open` | Int | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project | +| `resolved` | Int | Number of alerts with status RESOLVED for the project | +| `triggered` | Int | Number of alerts with status TRIGGERED for the project | + ## AwardEmoji An emoji awarded by a user. @@ -79,6 +124,41 @@ Represents a project or group board | `name` | String | Name of the board | | `weight` | Int | Weight of the board | +## BoardList + +Represents a list for an issue board + +| Name | Type | Description | +| --- | ---- | ---------- | +| `assignee` | User | Assignee in the list | +| `collapsed` | Boolean | Indicates if list is collapsed for this user | +| `id` | ID! | ID (global ID) of the list | +| `label` | Label | Label of the list | +| `limitMetric` | ListLimitMetric | The current limit metric for the list | +| `listType` | String! | Type of the list | +| `maxIssueCount` | Int | Maximum number of issues in the list | +| `maxIssueWeight` | Int | Maximum weight of issues in the list | +| `milestone` | Milestone | Milestone of the list | +| `position` | Int | Position of list within the board | +| `title` | String! | Title of the list | + +## BoardListUpdateLimitMetricsPayload + +Autogenerated return type of BoardListUpdateLimitMetrics + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `list` | BoardList | The updated list | + +## Branch + +| Name | Type | Description | +| --- | ---- | ---------- | +| `commit` | Commit | Commit for the branch | +| `name` | String! | Name of the branch | + ## Commit | Name | Type | Description | @@ -94,8 +174,40 @@ Represents a project or group board | `sha` | String! | SHA1 ID of the commit | | `signatureHtml` | String | Rendered HTML of the commit signature | | `title` | String | Title of the commit message | +| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` | | `webUrl` | String! | Web URL of the commit | +## CreateAlertIssuePayload + +Autogenerated return type of CreateAlertIssue + +| Name | Type | Description | +| --- | ---- | ---------- | +| `alert` | AlertManagementAlert | The alert after mutation | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `issue` | Issue | The issue created after mutation | + +## CreateAnnotationPayload + +Autogenerated return type of CreateAnnotation + +| Name | Type | Description | +| --- | ---- | ---------- | +| `annotation` | MetricsDashboardAnnotation | The created annotation | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + +## CreateBranchPayload + +Autogenerated return type of CreateBranch + +| Name | Type | Description | +| --- | ---- | ---------- | +| `branch` | Branch | Branch after mutation | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + ## CreateDiffNotePayload Autogenerated return type of CreateDiffNote @@ -103,7 +215,7 @@ Autogenerated return type of CreateDiffNote | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation | ## CreateEpicPayload @@ -114,7 +226,7 @@ Autogenerated return type of CreateEpic | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `epic` | Epic | The created epic | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | ## CreateImageDiffNotePayload @@ -123,9 +235,19 @@ Autogenerated return type of CreateImageDiffNote | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation | +## CreateIterationPayload + +Autogenerated return type of CreateIteration + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `iteration` | Iteration | The created iteration | + ## CreateNotePayload Autogenerated return type of CreateNote @@ -133,7 +255,7 @@ Autogenerated return type of CreateNote | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation | ## CreateRequirementPayload @@ -143,7 +265,7 @@ Autogenerated return type of CreateRequirement | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `requirement` | Requirement | The requirement after mutation | ## CreateSnippetPayload @@ -153,7 +275,7 @@ Autogenerated return type of CreateSnippet | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `snippet` | Snippet | The snippet after mutation | ## DeleteJobsResponse @@ -228,7 +350,7 @@ Autogenerated return type of DesignManagementDelete | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `version` | DesignVersion | The new version in which the designs are deleted | ## DesignManagementUploadPayload @@ -239,7 +361,7 @@ Autogenerated return type of DesignManagementUpload | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `designs` | Design! => Array | The designs that were uploaded by the mutation | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `skippedDesigns` | Design! => Array | Any designs that were skipped from the upload due to there being no change to their content since their last version | ## DesignVersion @@ -259,7 +381,7 @@ Autogenerated return type of DestroyNote | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation | ## DestroySnippetPayload @@ -269,7 +391,7 @@ Autogenerated return type of DestroySnippet | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `snippet` | Snippet | The snippet after mutation | ## DetailedStatus @@ -324,7 +446,7 @@ Autogenerated return type of DismissVulnerability | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `vulnerability` | Vulnerability | The vulnerability after dismissal | ## Environment @@ -389,7 +511,7 @@ Autogenerated return type of EpicAddIssue | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `epic` | Epic | The epic after mutation | | `epicIssue` | EpicIssue | The epic-issue relation | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | ## EpicDescendantCount @@ -443,6 +565,7 @@ Relationship between an epic and an issue | `healthStatus` | HealthStatus | Current health status. Returns null if `save_issuable_health_status` feature flag is disabled. | | `id` | ID | Global ID of the epic-issue relation | | `iid` | ID! | Internal ID of the issue | +| `iteration` | Iteration | Iteration of the issue | | `milestone` | Milestone | Milestone of the issue | | `reference` | String! | Internal reference of the issue. Returned in shortened format by default | | `relationPath` | String | URI path of the epic-issue relation | @@ -485,7 +608,7 @@ Autogenerated return type of EpicSetSubscription | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `epic` | Epic | The epic after mutation | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | ## EpicTreeReorderPayload @@ -494,7 +617,7 @@ Autogenerated return type of EpicTreeReorder | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | ## GeoNode @@ -521,7 +644,7 @@ Autogenerated return type of EpicTreeReorder | --- | ---- | ---------- | | `createdAt` | Time! | Timestamp of the issue's creation | | `enabled` | Boolean! | Indicates whether Grafana integration is enabled | -| `grafanaUrl` | String! | Url for the Grafana host for the Grafana integration | +| `grafanaUrl` | String! | URL for the Grafana host for the Grafana integration | | `id` | ID! | Internal ID of the Grafana integration | | `token` **{warning-solid}** | String! | **Deprecated:** Plain text token has been masked for security reasons. Deprecated in 12.7 | | `updatedAt` | Time! | Timestamp of the issue's last activity | @@ -582,6 +705,7 @@ Autogenerated return type of EpicTreeReorder | `epic` | Epic | Epic to which this issue belongs | | `healthStatus` | HealthStatus | Current health status. Returns null if `save_issuable_health_status` feature flag is disabled. | | `iid` | ID! | Internal ID of the issue | +| `iteration` | Iteration | Iteration of the issue | | `milestone` | Milestone | Milestone of the issue | | `reference` | String! | Internal reference of the issue. Returned in shortened format by default | | `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) | @@ -622,7 +746,7 @@ Autogenerated return type of IssueSetConfidential | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation | ## IssueSetDueDatePayload @@ -632,7 +756,17 @@ Autogenerated return type of IssueSetDueDate | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `issue` | Issue | The issue after mutation | + +## IssueSetIterationPayload + +Autogenerated return type of IssueSetIteration + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation | ## IssueSetWeightPayload @@ -642,15 +776,33 @@ Autogenerated return type of IssueSetWeight | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation | +## Iteration + +Represents an iteration object. + +| Name | Type | Description | +| --- | ---- | ---------- | +| `createdAt` | Time! | Timestamp of iteration creation | +| `description` | String | Description of the iteration | +| `dueDate` | Time | Timestamp of the iteration due date | +| `id` | ID! | ID of the iteration | +| `startDate` | Time | Timestamp of the iteration start date | +| `state` | IterationState! | State of the iteration | +| `title` | String! | Title of the iteration | +| `updatedAt` | Time! | Timestamp of last iteration update | +| `webPath` | String! | Web path of the iteration | +| `webUrl` | String! | Web URL of the iteration | + ## JiraImport | Name | Type | Description | | --- | ---- | ---------- | +| `createdAt` | Time | Timestamp of when the Jira import was created | | `jiraProjectKey` | String! | Project key for the imported Jira project | -| `scheduledAt` | Time | Timestamp of when the Jira import was created | +| `scheduledAt` | Time | Timestamp of when the Jira import was scheduled | | `scheduledBy` | User | User that started the Jira import | ## JiraImportStartPayload @@ -660,7 +812,7 @@ Autogenerated return type of JiraImportStart | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `jiraImport` | JiraImport | The Jira import data after mutation | ## JiraService @@ -688,7 +840,7 @@ Autogenerated return type of MarkAsSpamSnippet | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `snippet` | Snippet | The snippet after mutation | ## MergeRequest @@ -767,7 +919,7 @@ Autogenerated return type of MergeRequestSetAssignees | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation | ## MergeRequestSetLabelsPayload @@ -777,7 +929,7 @@ Autogenerated return type of MergeRequestSetLabels | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation | ## MergeRequestSetLockedPayload @@ -787,7 +939,7 @@ Autogenerated return type of MergeRequestSetLocked | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation | ## MergeRequestSetMilestonePayload @@ -797,7 +949,7 @@ Autogenerated return type of MergeRequestSetMilestone | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation | ## MergeRequestSetSubscriptionPayload @@ -807,7 +959,7 @@ Autogenerated return type of MergeRequestSetSubscription | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation | ## MergeRequestSetWipPayload @@ -817,7 +969,7 @@ Autogenerated return type of MergeRequestSetWip | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `mergeRequest` | MergeRequest | The merge request after mutation | ## Metadata @@ -838,10 +990,10 @@ Autogenerated return type of MergeRequestSetWip | Name | Type | Description | | --- | ---- | ---------- | | `description` | String | Description of the annotation | -| `endingAt` | String | Timestamp marking end of annotated time span | +| `endingAt` | Time | Timestamp marking end of annotated time span | | `id` | ID! | ID of the annotation | | `panelId` | String | ID of a dashboard panel to which the annotation should be scoped | -| `startingAt` | String | Timestamp marking start of annotated time span | +| `startingAt` | Time | Timestamp marking start of annotated time span | ## Milestone @@ -905,6 +1057,34 @@ Represents a milestone. | `readNote` | Boolean! | Indicates the user can perform `read_note` on this resource | | `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource | +## Package + +Represents a package + +| Name | Type | Description | +| --- | ---- | ---------- | +| `createdAt` | Time! | The created date | +| `id` | ID! | The ID of the package | +| `name` | String! | The name of the package | +| `packageType` | PackageTypeEnum! | The type of the package | +| `updatedAt` | Time! | The update date | +| `version` | String | The version of the package | + +## PackageFileRegistry + +Represents the sync and verification state of a package file + +| Name | Type | Description | +| --- | ---- | ---------- | +| `createdAt` | Time | Timestamp when the PackageFileRegistry was created | +| `id` | ID! | ID of the PackageFileRegistry | +| `lastSyncFailure` | String | Error message during sync of the PackageFileRegistry | +| `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the PackageFileRegistry | +| `packageFileId` | ID! | ID of the PackageFile | +| `retryAt` | Time | Timestamp after which the PackageFileRegistry should be resynced | +| `retryCount` | Int | Number of consecutive failed sync attempts of the PackageFileRegistry | +| `state` | RegistryState | Sync state of the PackageFileRegistry | + ## PageInfo Information about pagination in a connection. @@ -947,6 +1127,8 @@ Information about pagination in a connection. | Name | Type | Description | | --- | ---- | ---------- | +| `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project | +| `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project | | `archived` | Boolean | Indicates the archived status of the project | | `autocloseReferencedIssues` | Boolean | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically | | `avatarUrl` | String | URL to avatar image file of the project | @@ -980,6 +1162,7 @@ Information about pagination in a connection. | `path` | String! | Path of the project | | `printingMergeRequestLinkEnabled` | Boolean | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line | | `publicJobs` | Boolean | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts | +| `release` | Release | A single release of the project. Available only when feature flag `graphql_release_data` is enabled | | `removeSourceBranchAfterMerge` | Boolean | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project | | `repository` | Repository | Git repository of the project | | `requestAccessEnabled` | Boolean | Indicates if users can request member access to the project | @@ -998,7 +1181,7 @@ Information about pagination in a connection. | `tagList` | String | List of project topics (not Git tags) | | `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource | | `visibility` | String | Visibility of the project | -| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each severity of vulnerability of the project. Available only when feature flag `first_class_vulnerabilities` is enabled | +| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each severity of vulnerability of the project | | `webUrl` | String | Web URL of the project | | `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user | @@ -1061,6 +1244,20 @@ Information about pagination in a connection. | `storageSize` | Float! | Storage size of the project | | `wikiSize` | Float | Wiki size of the project | +## Release + +| Name | Type | Description | +| --- | ---- | ---------- | +| `author` | User | User that created the release | +| `commit` | Commit | The commit associated with the release | +| `createdAt` | Time | Timestamp of when the release was created | +| `description` | String | Description (also known as "release notes") of the release | +| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | +| `name` | String | Name of the release | +| `releasedAt` | Time | Timestamp of when the release was released | +| `tagName` | String! | Name of the tag associated with the release | +| `tagPath` | String | Relative web path to the tag associated with the release | + ## RemoveAwardEmojiPayload Autogenerated return type of RemoveAwardEmoji @@ -1069,7 +1266,16 @@ Autogenerated return type of RemoveAwardEmoji | --- | ---- | ---------- | | `awardEmoji` | AwardEmoji | The award emoji after mutation | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + +## RemoveProjectFromSecurityDashboardPayload + +Autogenerated return type of RemoveProjectFromSecurityDashboard + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | ## Repository @@ -1256,7 +1462,7 @@ Represents a snippet entry | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `fileName` | String | File Name of the snippet | | `httpUrlToRepo` | String | HTTP URL to the snippet repository | -| `id` | ID! | Id of the snippet | +| `id` | ID! | ID of the snippet | | `project` | Project | The project the snippet is associated with | | `rawUrl` | String! | Raw URL of the snippet | | `sshUrlToRepo` | String | SSH URL to the snippet repository | @@ -1273,11 +1479,13 @@ Represents the snippet blob | Name | Type | Description | | --- | ---- | ---------- | | `binary` | Boolean! | Shows whether the blob is binary | +| `externalStorage` | String | Blob external storage | | `mode` | String | Blob mode | | `name` | String | Blob name | | `path` | String | Blob path | | `plainData` | String | Blob plain highlighted data | | `rawPath` | String! | Blob raw content endpoint path | +| `renderedAsText` | Boolean! | Shows whether the blob is rendered as text | | `richData` | String | Blob highlighted data | | `richViewer` | SnippetBlobViewer | Blob content rich viewer | | `simpleViewer` | SnippetBlobViewer! | Blob content simple viewer | @@ -1351,7 +1559,7 @@ Representing a todo entry | `body` | String! | Body of the todo | | `createdAt` | Time! | Timestamp this todo was created | | `group` | Group | Group this todo is associated with | -| `id` | ID! | Id of the todo | +| `id` | ID! | ID of the todo | | `project` | Project | The project this todo is associated with | | `state` | TodoStateEnum! | State of the todo | | `targetType` | TodoTargetEnum! | Target type of the todo | @@ -1363,7 +1571,7 @@ Autogenerated return type of TodoMarkDone | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `todo` | Todo! | The requested todo | ## TodoRestoreManyPayload @@ -1373,7 +1581,7 @@ Autogenerated return type of TodoRestoreMany | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `updatedIds` | ID! => Array | The ids of the updated todo items | ## TodoRestorePayload @@ -1383,7 +1591,7 @@ Autogenerated return type of TodoRestore | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `todo` | Todo! | The requested todo | ## TodosMarkAllDonePayload @@ -1393,7 +1601,7 @@ Autogenerated return type of TodosMarkAllDone | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `updatedIds` | ID! => Array | Ids of the updated todos | ## ToggleAwardEmojiPayload @@ -1404,7 +1612,7 @@ Autogenerated return type of ToggleAwardEmoji | --- | ---- | ---------- | | `awardEmoji` | AwardEmoji | The award emoji after mutation | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `toggledOn` | Boolean! | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. | ## Tree @@ -1427,6 +1635,17 @@ Represents a directory | `type` | EntryType! | Type of tree entry | | `webUrl` | String | Web URL for the tree entry (directory) | +## UpdateAlertStatusPayload + +Autogenerated return type of UpdateAlertStatus + +| Name | Type | Description | +| --- | ---- | ---------- | +| `alert` | AlertManagementAlert | The alert after mutation | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `issue` | Issue | The issue created after mutation | + ## UpdateEpicPayload Autogenerated return type of UpdateEpic @@ -1435,7 +1654,7 @@ Autogenerated return type of UpdateEpic | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `epic` | Epic | The epic after mutation | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | ## UpdateImageDiffNotePayload @@ -1444,7 +1663,7 @@ Autogenerated return type of UpdateImageDiffNote | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation | ## UpdateIssuePayload @@ -1454,7 +1673,7 @@ Autogenerated return type of UpdateIssue | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue after mutation | ## UpdateNotePayload @@ -1464,7 +1683,7 @@ Autogenerated return type of UpdateNote | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `note` | Note | The note after mutation | ## UpdateRequirementPayload @@ -1474,7 +1693,7 @@ Autogenerated return type of UpdateRequirement | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `requirement` | Requirement | The requirement after mutation | ## UpdateSnippetPayload @@ -1484,7 +1703,7 @@ Autogenerated return type of UpdateSnippet | Name | Type | Description | | --- | ---- | ---------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Reasons why the mutation failed. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | | `snippet` | Snippet | The snippet after mutation | ## User @@ -1492,7 +1711,9 @@ Autogenerated return type of UpdateSnippet | Name | Type | Description | | --- | ---- | ---------- | | `avatarUrl` | String | URL of the user's avatar | +| `id` | ID! | ID of the user | | `name` | String! | Human-readable name of the user | +| `state` | String! | State of the issue | | `userPermissions` | UserPermissions! | Permissions for the current user on the resource | | `username` | String! | Username of the user. Unique within this instance of GitLab | | `webUrl` | String! | Web URL of the user | @@ -1503,6 +1724,16 @@ Autogenerated return type of UpdateSnippet | --- | ---- | ---------- | | `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource | +## VulnerabilitiesCountByDayAndSeverity + +Represents the number of vulnerabilities for a particular severity on a particular day + +| Name | Type | Description | +| --- | ---- | ---------- | +| `count` | Int | Number of vulnerabilities | +| `day` | ISO8601Date | Date for the count | +| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities | + ## Vulnerability Represents a vulnerability. @@ -1511,7 +1742,7 @@ Represents a vulnerability. | --- | ---- | ---------- | | `description` | String | Description of the vulnerability | | `id` | ID! | GraphQL ID of the vulnerability | -| `location` | JSON | The JSON location metadata for the vulnerability. Its format depends on the type of the security scan that found the vulnerability | +| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability | | `project` | Project | The project on which the vulnerability was found | | `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST) | | `severity` | VulnerabilitySeverity | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL) | @@ -1520,6 +1751,48 @@ Represents a vulnerability. | `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource | | `vulnerabilityPath` | String | URL to the vulnerability's details page | +## VulnerabilityLocationContainerScanning + +Represents the location of a vulnerability found by a container security scan + +| Name | Type | Description | +| --- | ---- | ---------- | +| `dependency` | VulnerableDependency | Dependency containing the vulnerability | +| `image` | String | Name of the vulnerable container image | +| `operatingSystem` | String | Operating system that runs on the vulnerable container image | + +## VulnerabilityLocationDast + +Represents the location of a vulnerability found by a DAST scan + +| Name | Type | Description | +| --- | ---- | ---------- | +| `hostname` | String | Domain name of the vulnerable request | +| `param` | String | Query parameter for the URL on which the vulnerability occurred | +| `path` | String | URL path and query string of the vulnerable request | +| `requestMethod` | String | HTTP method of the vulnerable request | + +## VulnerabilityLocationDependencyScanning + +Represents the location of a vulnerability found by a dependency security scan + +| Name | Type | Description | +| --- | ---- | ---------- | +| `dependency` | VulnerableDependency | Dependency containing the vulnerability | +| `file` | String | Path to the vulnerable file | + +## VulnerabilityLocationSast + +Represents the location of a vulnerability found by a SAST scan + +| Name | Type | Description | +| --- | ---- | ---------- | +| `endLine` | String | Number of the last relevant line in the vulnerable file | +| `file` | String | Path to the vulnerable file | +| `startLine` | String | Number of the first relevant line in the vulnerable file | +| `vulnerableClass` | String | Class containing the vulnerability | +| `vulnerableMethod` | String | Method containing the vulnerability | + ## VulnerabilityPermissions Check permissions for the current user on a vulnerability @@ -1547,3 +1820,20 @@ Represents vulnerability counts by severity | `low` | Int | Number of vulnerabilities of LOW severity of the project | | `medium` | Int | Number of vulnerabilities of MEDIUM severity of the project | | `unknown` | Int | Number of vulnerabilities of UNKNOWN severity of the project | + +## VulnerableDependency + +Represents a vulnerable dependency. Used in vulnerability location data + +| Name | Type | Description | +| --- | ---- | ---------- | +| `package` | VulnerablePackage | The package associated with the vulnerable dependency | +| `version` | String | The version of the vulnerable dependency | + +## VulnerablePackage + +Represents a vulnerable package. Used in vulnerability dependency data + +| Name | Type | Description | +| --- | ---- | ---------- | +| `name` | String | The name of the vulnerable package | |