index.md 148 KB
Newer Older
Felipe Artur's avatar
Felipe Artur committed
1 2 3 4 5 6 7 8 9 10 11
<!---
  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).
12

13 14
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.
Felipe Artur's avatar
Felipe Artur committed
15

16 17 18
CAUTION: **Caution:**
Fields that are deprecated are marked with **{warning-solid}**.

19 20 21 22 23 24 25 26 27 28 29 30
## Object types

Object types represent the resources that GitLab's GraphQL API can return.
They contain _fields_. Each field has its own type, which will either be one of the
basic GraphQL [scalar types](https://graphql.org/learn/schema/#scalar-types)
(e.g.: `String` or `Boolean`) or other object types.

For more information, see
[Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields)
on `graphql.org`.

### AccessLevel
31

32
Represents the access level of a relationship between a User and object that it is related to.
33

34 35
| Field | Type | Description |
| ----- | ---- | ----------- |
36 37 38
| `integerValue` | Int | Integer representation of access level |
| `stringValue` | AccessLevelEnum | String representation of access level |

39
### AddAwardEmojiPayload
Felipe Artur's avatar
Felipe Artur committed
40

41
Autogenerated return type of AddAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
42

43 44
| Field | Type | Description |
| ----- | ---- | ----------- |
45
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
Felipe Artur's avatar
Felipe Artur committed
46
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
47
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
48

49
### AddProjectToSecurityDashboardPayload
50

51
Autogenerated return type of AddProjectToSecurityDashboard.
52

53 54
| Field | Type | Description |
| ----- | ---- | ----------- |
55
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
56
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
57
| `project` | Project | Project that was added to the Instance Security Dashboard |
58

59
### AdminSidekiqQueuesDeleteJobsPayload
60

61
Autogenerated return type of AdminSidekiqQueuesDeleteJobs.
62

63 64
| Field | Type | Description |
| ----- | ---- | ----------- |
65
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
66
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
67 68
| `result` | DeleteJobsResponse | Information about the status of the deletion request |

69
### AlertManagementAlert
70

71
Describes an alert from the project's Alert Management.
72

73 74
| Field | Type | Description |
| ----- | ---- | ----------- |
75 76 77
| `createdAt` | Time | Timestamp the alert was created |
| `description` | String | Description of the alert |
| `details` | JSON | Alert details |
78
| `detailsUrl` | String! | The URL of the alert detail page |
79 80
| `endedAt` | Time | Timestamp the alert ended |
| `eventCount` | Int | Number of events of this alert |
81
| `hosts` | String! => Array | List of hosts the alert came from |
82
| `iid` | ID! | Internal ID of the alert |
83
| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert |
84
| `metricsDashboardUrl` | String | URL for metrics embed for the alert |
85
| `monitoringTool` | String | Monitoring tool the alert came from |
86
| `prometheusAlert` | PrometheusAlert | The alert condition for Prometheus |
87
| `runbook` | String | Runbook for the alert as defined in alert details |
88 89 90 91 92
| `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 |
93
| `updatedAt` | Time | Timestamp the alert was last updated |
94

95
### AlertManagementAlertStatusCountsType
96

97
Represents total number of alerts for the represented categories.
98

99 100
| Field | Type | Description |
| ----- | ---- | ----------- |
101 102 103 104 105 106 107
| `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 |

108
### AlertSetAssigneesPayload
109

110
Autogenerated return type of AlertSetAssignees.
111

112 113
| Field | Type | Description |
| ----- | ---- | ----------- |
114 115 116 117
| `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 |
Allison Browne's avatar
Allison Browne committed
118 119
| `todo` | Todo | The todo after mutation |

120
### AlertTodoCreatePayload
Allison Browne's avatar
Allison Browne committed
121

122
Autogenerated return type of AlertTodoCreate.
Allison Browne's avatar
Allison Browne committed
123

124 125
| Field | Type | Description |
| ----- | ---- | ----------- |
Allison Browne's avatar
Allison Browne committed
126 127 128 129 130
| `alert` | AlertManagementAlert | The alert after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation |
| `todo` | Todo | The todo after mutation |
131

132
### AwardEmoji
133 134

An emoji awarded by a user.
Felipe Artur's avatar
Felipe Artur committed
135

136 137
| Field | Type | Description |
| ----- | ---- | ----------- |
Felipe Artur's avatar
Felipe Artur committed
138 139
| `description` | String! | The emoji description |
| `emoji` | String! | The emoji as an icon |
140 141
| `name` | String! | The emoji name |
| `unicode` | String! | The emoji in unicode |
Felipe Artur's avatar
Felipe Artur committed
142 143 144
| `unicodeVersion` | String! | The unicode version for this emoji |
| `user` | User! | The user who awarded the emoji |

145
### AwardEmojiAddPayload
146

147
Autogenerated return type of AwardEmojiAdd.
148

149 150
| Field | Type | Description |
| ----- | ---- | ----------- |
151 152 153 154
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

155
### AwardEmojiRemovePayload
156

157
Autogenerated return type of AwardEmojiRemove.
158

159 160
| Field | Type | Description |
| ----- | ---- | ----------- |
161 162 163 164
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

165
### AwardEmojiTogglePayload
166

167
Autogenerated return type of AwardEmojiToggle.
168

169 170
| Field | Type | Description |
| ----- | ---- | ----------- |
171 172 173 174 175
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `toggledOn` | Boolean! | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. |

176
### BaseService
177

178 179
| Field | Type | Description |
| ----- | ---- | ----------- |
180 181 182
| `active` | Boolean | Indicates if the service is active |
| `type` | String | Class name of the service |

183
### Blob
Felipe Artur's avatar
Felipe Artur committed
184

185 186
| Field | Type | Description |
| ----- | ---- | ----------- |
187
| `flatPath` | String! | Flat path of the entry |
188
| `id` | ID! | ID of the entry |
189
| `lfsOid` | String | LFS ID of the blob |
190
| `mode` | String | Blob mode in numeric format |
191 192
| `name` | String! | Name of the entry |
| `path` | String! | Path of the entry |
193 194
| `sha` | String! | Last commit sha for the entry |
| `type` | EntryType! | Type of tree entry |
195
| `webPath` | String | Web path of the blob |
196
| `webUrl` | String | Web URL of the blob |
Felipe Artur's avatar
Felipe Artur committed
197

198
### Board
199

200
Represents a project or group board.
201

202 203
| Field | Type | Description |
| ----- | ---- | ----------- |
204 205 206
| `assignee` | User | The board assignee. |
| `hideBacklogList` | Boolean | Whether or not backlog list is hidden. |
| `hideClosedList` | Boolean | Whether or not closed list is hidden. |
207
| `id` | ID! | ID (global ID) of the board |
208
| `milestone` | Milestone | The board milestone. |
209
| `name` | String | Name of the board |
210
| `weight` | Int | Weight of the board. |
211

212
### BoardList
213

214
Represents a list for an issue board.
215

216 217
| Field | Type | Description |
| ----- | ---- | ----------- |
218 219 220
| `assignee` | User | Assignee in the list |
| `collapsed` | Boolean | Indicates if list is collapsed for this user |
| `id` | ID! | ID (global ID) of the list |
221
| `issuesCount` | Int | Count of issues in the list |
222
| `label` | Label | Label of the list |
223
| `limitMetric` | ListLimitMetric | The current limit metric for the list |
224 225 226 227 228 229
| `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 |
230
| `totalWeight` | Int | Total weight of all issues in the list |
231

232
### BoardListCreatePayload
233

234
Autogenerated return type of BoardListCreate.
235

236 237
| Field | Type | Description |
| ----- | ---- | ----------- |
238 239 240 241
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `list` | BoardList | List of the issue board |

242
### BoardListUpdateLimitMetricsPayload
243

244
Autogenerated return type of BoardListUpdateLimitMetrics.
245

246 247
| Field | Type | Description |
| ----- | ---- | ----------- |
248
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
249
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
250 251
| `list` | BoardList | The updated list |

252
### Branch
253

254 255
| Field | Type | Description |
| ----- | ---- | ----------- |
256 257 258
| `commit` | Commit | Commit for the branch |
| `name` | String! | Name of the branch |

259
### BurnupChartDailyTotals
260 261 262

Represents the total number of issues and their weights for a particular day.

263 264
| Field | Type | Description |
| ----- | ---- | ----------- |
265 266 267 268 269 270
| `completedCount` | Int! | Number of closed issues as of this day |
| `completedWeight` | Int! | Total weight of closed issues as of this day |
| `date` | ISO8601Date! | Date for burnup totals |
| `scopeCount` | Int! | Number of issues as of this day |
| `scopeWeight` | Int! | Total weight of issues as of this day |

271
### CiGroup
Laura Montemayor's avatar
Laura Montemayor committed
272

273 274
| Field | Type | Description |
| ----- | ---- | ----------- |
Laura Montemayor's avatar
Laura Montemayor committed
275 276 277
| `name` | String | Name of the job group |
| `size` | Int | Size of the group |

278
### CiJob
Laura Montemayor's avatar
Laura Montemayor committed
279

280 281
| Field | Type | Description |
| ----- | ---- | ----------- |
Laura Montemayor's avatar
Laura Montemayor committed
282 283
| `name` | String | Name of the job |

284
### CiStage
Laura Montemayor's avatar
Laura Montemayor committed
285

286 287
| Field | Type | Description |
| ----- | ---- | ----------- |
Laura Montemayor's avatar
Laura Montemayor committed
288 289
| `name` | String | Name of the stage |

290
### ClusterAgent
291

292 293
| Field | Type | Description |
| ----- | ---- | ----------- |
294 295 296 297 298 299
| `createdAt` | Time | Timestamp the cluster agent was created |
| `id` | ID! | ID of the cluster agent |
| `name` | String | Name of the cluster agent |
| `project` | Project | The project this cluster agent is associated with |
| `updatedAt` | Time | Timestamp the cluster agent was updated |

300
### ClusterAgentDeletePayload
301

302
Autogenerated return type of ClusterAgentDelete.
303

304 305
| Field | Type | Description |
| ----- | ---- | ----------- |
306 307 308
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

309
### ClusterAgentToken
310

311 312
| Field | Type | Description |
| ----- | ---- | ----------- |
313 314 315 316
| `clusterAgent` | ClusterAgent | Cluster agent this token is associated with |
| `createdAt` | Time | Timestamp the token was created |
| `id` | ClustersAgentTokenID! | Global ID of the token |

317
### ClusterAgentTokenCreatePayload
318

319
Autogenerated return type of ClusterAgentTokenCreate.
320

321 322
| Field | Type | Description |
| ----- | ---- | ----------- |
323 324 325 326 327
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `secret` | String | Token secret value. Make sure you save it - you won't be able to access it again |
| `token` | ClusterAgentToken | Token created after mutation |

328
### ClusterAgentTokenDeletePayload
329

330
Autogenerated return type of ClusterAgentTokenDelete.
331

332 333
| Field | Type | Description |
| ----- | ---- | ----------- |
334 335 336
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

337
### Commit
Felipe Artur's avatar
Felipe Artur committed
338

339 340
| Field | Type | Description |
| ----- | ---- | ----------- |
341
| `author` | User | Author of the commit |
342
| `authorGravatar` | String | Commit authors gravatar |
343 344 345
| `authorName` | String | Commit authors name |
| `authoredDate` | Time | Timestamp of when the commit was authored |
| `description` | String | Description of the commit message |
346
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
347
| `id` | ID! | ID (global ID) of the commit |
348
| `latestPipeline` **{warning-solid}** | Pipeline | **Deprecated:** Use `pipelines`. Deprecated in 12.5 |
349
| `message` | String | Raw commit message |
350
| `sha` | String! | SHA1 ID of the commit |
351
| `signatureHtml` | String | Rendered HTML of the commit signature |
352
| `title` | String | Title of the commit message |
353
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
354
| `webPath` | String! | Web path of the commit |
355
| `webUrl` | String! | Web URL of the commit |
Felipe Artur's avatar
Felipe Artur committed
356

357
### CommitCreatePayload
358

359
Autogenerated return type of CommitCreate.
360

361 362
| Field | Type | Description |
| ----- | ---- | ----------- |
363 364 365 366
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `commit` | Commit | The commit after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

367
### ComplianceFramework
368

369
Represents a ComplianceFramework associated with a Project.
370

371 372
| Field | Type | Description |
| ----- | ---- | ----------- |
373 374
| `name` | ProjectSettingEnum! | Name of the compliance framework |

375
### ConfigureSastPayload
376

377
Autogenerated return type of ConfigureSast.
378

379 380
| Field | Type | Description |
| ----- | ---- | ----------- |
381 382
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
383 384
| `status` | String! | Status of creating the commit for the supplied SAST CI configuration |
| `successPath` | String | Redirect path to use when the response is successful |
385

386
### ContainerExpirationPolicy
387

388
A tag expiration policy designed to keep only the images that matter most.
389

390 391
| Field | Type | Description |
| ----- | ---- | ----------- |
392 393
| `cadence` | ContainerExpirationPolicyCadenceEnum! | This container expiration policy schedule |
| `createdAt` | Time! | Timestamp of when the container expiration policy was created |
394
| `enabled` | Boolean! | Indicates whether this container expiration policy is enabled |
395
| `keepN` | ContainerExpirationPolicyKeepEnum | Number of tags to retain |
396 397
| `nameRegex` | UntrustedRegexp | Tags with names matching this regex pattern will expire |
| `nameRegexKeep` | UntrustedRegexp | Tags with names matching this regex pattern will be preserved |
398 399 400 401
| `nextRunAt` | Time | Next time that this container expiration policy will get executed |
| `olderThan` | ContainerExpirationPolicyOlderThanEnum | Tags older that this will expire |
| `updatedAt` | Time! | Timestamp of when the container expiration policy was updated |

402
### CreateAlertIssuePayload
403

404
Autogenerated return type of CreateAlertIssue.
405

406 407
| Field | Type | Description |
| ----- | ---- | ----------- |
408 409 410 411
| `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 |
Allison Browne's avatar
Allison Browne committed
412
| `todo` | Todo | The todo after mutation |
413

414
### CreateAnnotationPayload
415

416
Autogenerated return type of CreateAnnotation.
417

418 419
| Field | Type | Description |
| ----- | ---- | ----------- |
420 421 422 423
| `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. |

424
### CreateBranchPayload
425

426
Autogenerated return type of CreateBranch.
427

428 429
| Field | Type | Description |
| ----- | ---- | ----------- |
430 431
| `branch` | Branch | Branch after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
432
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
433

434
### CreateClusterAgentPayload
435

436
Autogenerated return type of CreateClusterAgent.
437

438 439
| Field | Type | Description |
| ----- | ---- | ----------- |
440 441 442
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `clusterAgent` | ClusterAgent | Cluster agent created after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
443

444
### CreateDiffNotePayload
445

446
Autogenerated return type of CreateDiffNote.
447

448 449
| Field | Type | Description |
| ----- | ---- | ----------- |
450
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
451
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
452 453
| `note` | Note | The note after mutation |

454
### CreateEpicPayload
455

456
Autogenerated return type of CreateEpic.
457

458 459
| Field | Type | Description |
| ----- | ---- | ----------- |
460 461
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The created epic |
462
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
463

464
### CreateImageDiffNotePayload
465

466
Autogenerated return type of CreateImageDiffNote.
467

468 469
| Field | Type | Description |
| ----- | ---- | ----------- |
470
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
471
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
472 473
| `note` | Note | The note after mutation |

474
### CreateIterationPayload
475

476
Autogenerated return type of CreateIteration.
477

478 479
| Field | Type | Description |
| ----- | ---- | ----------- |
480 481 482 483
| `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 |

484
### CreateNotePayload
485

486
Autogenerated return type of CreateNote.
487

488 489
| Field | Type | Description |
| ----- | ---- | ----------- |
490
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
491
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
492 493
| `note` | Note | The note after mutation |

494
### CreateRequirementPayload
Jan Provaznik's avatar
Jan Provaznik committed
495

496
Autogenerated return type of CreateRequirement.
Jan Provaznik's avatar
Jan Provaznik committed
497

498 499
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
500
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
501
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Jan Provaznik's avatar
Jan Provaznik committed
502 503
| `requirement` | Requirement | The requirement after mutation |

504
### CreateSnippetPayload
505

506
Autogenerated return type of CreateSnippet.
507

508 509
| Field | Type | Description |
| ----- | ---- | ----------- |
510
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
511
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
512 513
| `snippet` | Snippet | The snippet after mutation |

514 515
### CreateTestCasePayload

516
Autogenerated return type of CreateTestCase.
517 518 519 520 521 522 523

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `testCase` | Issue | The test case created |

524
### DastOnDemandScanCreatePayload
525

526
Autogenerated return type of DastOnDemandScanCreate.
527

528 529
| Field | Type | Description |
| ----- | ---- | ----------- |
530 531 532 533
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `pipelineUrl` | String | URL of the pipeline that was created. |

534
### DastScannerProfile
535 536 537

Represents a DAST scanner profile.

538 539
| Field | Type | Description |
| ----- | ---- | ----------- |
540
| `editPath` | String | Relative web path to the edit page of a scanner profile |
541 542
| `globalId` | DastScannerProfileID! | ID of the DAST scanner profile |
| `id` **{warning-solid}** | ID! | **Deprecated:** Use `global_id`. Deprecated in 13.4 |
543
| `profileName` | String | Name of the DAST scanner profile |
544
| `spiderTimeout` | Int | The maximum number of minutes allowed for the spider to traverse the site |
545 546
| `targetTimeout` | Int | The maximum number of seconds allowed for the site under test to respond to a request |

547
### DastScannerProfileCreatePayload
548

549
Autogenerated return type of DastScannerProfileCreate.
550

551 552
| Field | Type | Description |
| ----- | ---- | ----------- |
553 554
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
555 556
| `globalId` | DastScannerProfileID | ID of the scanner profile. |
| `id` **{warning-solid}** | ID | **Deprecated:** Use `global_id`. Deprecated in 13.4 |
557

558
### DastScannerProfileDeletePayload
559

560
Autogenerated return type of DastScannerProfileDelete.
561

562 563
| Field | Type | Description |
| ----- | ---- | ----------- |
564 565 566
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

567
### DastScannerProfileUpdatePayload
568

569
Autogenerated return type of DastScannerProfileUpdate.
570

571 572
| Field | Type | Description |
| ----- | ---- | ----------- |
573 574 575 576
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `id` | DastScannerProfileID | ID of the scanner profile. |

577
### DastSiteProfile
578 579 580

Represents a DAST Site Profile.

581 582
| Field | Type | Description |
| ----- | ---- | ----------- |
583
| `editPath` | String | Relative web path to the edit page of a site profile |
584
| `id` | DastSiteProfileID! | ID of the site profile |
585 586 587 588 589
| `profileName` | String | The name of the site profile |
| `targetUrl` | String | The URL of the target to be scanned |
| `userPermissions` | DastSiteProfilePermissions! | Permissions for the current user on the resource |
| `validationStatus` | DastSiteProfileValidationStatusEnum | The current validation status of the site profile |

590
### DastSiteProfileCreatePayload
591

592
Autogenerated return type of DastSiteProfileCreate.
593

594 595
| Field | Type | Description |
| ----- | ---- | ----------- |
596 597
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
598
| `id` | DastSiteProfileID | ID of the site profile. |
599

600
### DastSiteProfileDeletePayload
601

602
Autogenerated return type of DastSiteProfileDelete.
603

604 605
| Field | Type | Description |
| ----- | ---- | ----------- |
606 607 608
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

609
### DastSiteProfilePermissions
610

611
Check permissions for the current user on site profile.
612

613 614
| Field | Type | Description |
| ----- | ---- | ----------- |
615 616
| `createOnDemandDastScan` | Boolean! | Indicates the user can perform `create_on_demand_dast_scan` on this resource |

617
### DastSiteProfileUpdatePayload
618

619
Autogenerated return type of DastSiteProfileUpdate.
620

621 622
| Field | Type | Description |
| ----- | ---- | ----------- |
623 624 625 626
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `id` | DastSiteProfileID | ID of the site profile. |

627
### DeleteAnnotationPayload
628

629
Autogenerated return type of DeleteAnnotation.
630

631 632
| Field | Type | Description |
| ----- | ---- | ----------- |
633 634 635
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

636
### DeleteJobsResponse
637 638 639

The response from the AdminSidekiqQueuesDeleteJobs mutation.

640 641
| Field | Type | Description |
| ----- | ---- | ----------- |
642 643 644 645
| `completed` | Boolean | Whether or not the entire queue was processed in time; if not, retrying the same request is safe |
| `deletedJobs` | Int | The number of matching jobs deleted |
| `queueSize` | Int | The queue size after processing |

646
### Design
647

648
A single design.
649

650 651
| Field | Type | Description |
| ----- | ---- | ----------- |
652 653
| `diffRefs` | DiffRefs! | The diff refs for this design |
| `event` | DesignVersionEvent! | How this design was changed in the current version |
654 655
| `filename` | String! | The filename of the design |
| `fullPath` | String! | The full path to the design file |
656
| `id` | ID! | The ID of this design |
657 658
| `image` | String! | The URL of the full-sized image |
| `imageV432x230` | 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 |
659
| `issue` | Issue! | The issue the design belongs to |
660
| `notesCount` | Int! | The total count of user-created notes for this design |
661
| `project` | Project! | The project the design belongs to |
662

663
### DesignAtVersion
664 665 666

A design pinned to a specific version. The image field reflects the design as of the associated version.

667 668
| Field | Type | Description |
| ----- | ---- | ----------- |
669
| `design` | Design! | The underlying design |
670 671
| `diffRefs` | DiffRefs! | The diff refs for this design |
| `event` | DesignVersionEvent! | How this design was changed in the current version |
672 673
| `filename` | String! | The filename of the design |
| `fullPath` | String! | The full path to the design file |
674
| `id` | ID! | The ID of this design |
675 676
| `image` | String! | The URL of the full-sized image |
| `imageV432x230` | 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 |
677
| `issue` | Issue! | The issue the design belongs to |
678
| `notesCount` | Int! | The total count of user-created notes for this design |
679
| `project` | Project! | The project the design belongs to |
680 681
| `version` | DesignVersion! | The version this design-at-versions is pinned to |

682
### DesignCollection
683 684

A collection of designs.
685

686 687
| Field | Type | Description |
| ----- | ---- | ----------- |
688
| `copyState` | DesignCollectionCopyState | Copy state of the design collection |
689 690
| `design` | Design | Find a specific design |
| `designAtVersion` | DesignAtVersion | Find a design as of a version |
691
| `issue` | Issue! | Issue associated with the design collection |
692
| `project` | Project! | Project associated with the design collection |
693 694
| `version` | DesignVersion | A specific version |

695
### DesignManagement
696

697 698
| Field | Type | Description |
| ----- | ---- | ----------- |
699
| `designAtVersion` | DesignAtVersion | Find a design as of a version |
700
| `version` | DesignVersion | Find a version |
701

702
### DesignManagementDeletePayload
703

704
Autogenerated return type of DesignManagementDelete.
705

706 707
| Field | Type | Description |
| ----- | ---- | ----------- |
708
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
709
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
710 711
| `version` | DesignVersion | The new version in which the designs are deleted |

712
### DesignManagementMovePayload
713

714
Autogenerated return type of DesignManagementMove.
715

716 717
| Field | Type | Description |
| ----- | ---- | ----------- |
718 719 720 721
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `designCollection` | DesignCollection | The current state of the collection |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

722
### DesignManagementUploadPayload
723

724
Autogenerated return type of DesignManagementUpload.
725

726 727
| Field | Type | Description |
| ----- | ---- | ----------- |
728 729
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `designs` | Design! => Array | The designs that were uploaded by the mutation |
730
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
731 732
| `skippedDesigns` | Design! => Array | Any designs that were skipped from the upload due to there being no change to their content since their last version |

733
### DesignVersion
734

735
A specific version in which designs were added, modified or deleted.
736

737 738
| Field | Type | Description |
| ----- | ---- | ----------- |
739
| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version |
740 741
| `id` | ID! | ID of the design version |
| `sha` | ID! | SHA of the design version |
742

743 744 745 746 747 748 749 750 751 752
### DestroyBoardListPayload

Autogenerated return type of DestroyBoardList.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `list` | BoardList | The list after mutation. |

753 754
### DestroyBoardPayload

755
Autogenerated return type of DestroyBoard.
756 757 758 759 760 761 762

| Field | Type | Description |
| ----- | ---- | ----------- |
| `board` | Board | The board after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

763
### DestroyNotePayload
764

765
Autogenerated return type of DestroyNote.
766

767 768
| Field | Type | Description |
| ----- | ---- | ----------- |
769
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
770
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
771 772
| `note` | Note | The note after mutation |

773
### DestroySnippetPayload
774

775
Autogenerated return type of DestroySnippet.
776

777 778
| Field | Type | Description |
| ----- | ---- | ----------- |
779
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
780
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
781 782
| `snippet` | Snippet | The snippet after mutation |

783
### DetailedStatus
Felipe Artur's avatar
Felipe Artur committed
784

785 786
| Field | Type | Description |
| ----- | ---- | ----------- |
787
| `detailsPath` | String! | Path of the details for the pipeline status |
788 789
| `favicon` | String! | Favicon of the pipeline status |
| `group` | String! | Group of the pipeline status |
790
| `hasDetails` | Boolean! | Indicates if the pipeline status has further details |
791
| `icon` | String! | Icon of the pipeline status |
792 793 794
| `label` | String! | Label of the pipeline status |
| `text` | String! | Text of the pipeline status |
| `tooltip` | String! | Tooltip associated with the pipeline status |
Felipe Artur's avatar
Felipe Artur committed
795

796
### DiffPosition
Felipe Artur's avatar
Felipe Artur committed
797

798 799
| Field | Type | Description |
| ----- | ---- | ----------- |
800 801
| `diffRefs` | DiffRefs! | Information about the branch, HEAD, and base at the time of commenting |
| `filePath` | String! | Path of the file that was changed |
802 803
| `height` | Int | Total height of the image |
| `newLine` | Int | Line on HEAD SHA that was changed |
804 805
| `newPath` | String | Path of the file on the HEAD SHA |
| `oldLine` | Int | Line on start SHA that was changed |
806 807 808
| `oldPath` | String | Path of the file on the start SHA |
| `positionType` | DiffPositionType! | Type of file the position refers to |
| `width` | Int | Total width of the image |
809 810
| `x` | Int | X position of the note |
| `y` | Int | Y position of the note |
Felipe Artur's avatar
Felipe Artur committed
811

812
### DiffRefs
813

814 815
| Field | Type | Description |
| ----- | ---- | ----------- |
816
| `baseSha` | String | Merge base of the branch the comment was made on |
817
| `headSha` | String! | SHA of the HEAD at the time the comment was made |
818
| `startSha` | String! | SHA of the branch being compared against |
819

820
### DiffStats
821

822
Changes to a single file.
823

824 825
| Field | Type | Description |
| ----- | ---- | ----------- |
826 827 828 829
| `additions` | Int! | Number of lines added to this file |
| `deletions` | Int! | Number of lines deleted from this file |
| `path` | String! | File path, relative to repository root |

830
### DiffStatsSummary
831

832
Aggregated summary of changes.
833

834 835
| Field | Type | Description |
| ----- | ---- | ----------- |
836 837 838
| `additions` | Int! | Number of lines added |
| `changes` | Int! | Number of lines changed |
| `deletions` | Int! | Number of lines deleted |
839
| `fileCount` | Int! | Number of files changed |
840

841
### Discussion
Felipe Artur's avatar
Felipe Artur committed
842

843 844
| Field | Type | Description |
| ----- | ---- | ----------- |
845
| `createdAt` | Time! | Timestamp of the discussion's creation |
846 847
| `id` | ID! | ID of this discussion |
| `replyId` | ID! | ID used to reply to this discussion |
848 849 850 851 852
| `resolvable` | Boolean! | Indicates if the object can be resolved |
| `resolved` | Boolean! | Indicates if the object is resolved |
| `resolvedAt` | Time | Timestamp of when the object was resolved |
| `resolvedBy` | User | User who resolved the object |

853
### DiscussionToggleResolvePayload
854

855
Autogenerated return type of DiscussionToggleResolve.
856

857 858
| Field | Type | Description |
| ----- | ---- | ----------- |
859 860 861
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `discussion` | Discussion | The discussion after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
862

863
### DismissVulnerabilityPayload
864

865
Autogenerated return type of DismissVulnerability.
866

867 868
| Field | Type | Description |
| ----- | ---- | ----------- |
869
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
870
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
871 872
| `vulnerability` | Vulnerability | The vulnerability after dismissal |

873
### Environment
874

875
Describes where code is deployed for a project.
876

877 878
| Field | Type | Description |
| ----- | ---- | ----------- |
879
| `id` | ID! | ID of the environment |
880
| `latestOpenedMostSevereAlert` | AlertManagementAlert | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. |
881
| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment |
882
| `name` | String! | Human-readable name of the environment |
883
| `state` | String! | State of the environment, for example: available/stopped |
884

885
### Epic
886 887

Represents an epic.
888

889 890
| Field | Type | Description |
| ----- | ---- | ----------- |
891 892
| `author` | User! | Author of the epic |
| `closedAt` | Time | Timestamp of the epic's closure |
893
| `confidential` | Boolean | Indicates if the epic is confidential |
894 895
| `createdAt` | Time | Timestamp of the epic's creation |
| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues |
896
| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants |
897
| `description` | String | Description of the epic |
898 899 900 901 902
| `downvotes` | Int! | Number of downvotes the epic has received |
| `dueDate` | Time | Due date of the epic |
| `dueDateFixed` | Time | Fixed due date of the epic |
| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones |
| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set |
903
| `group` | Group! | Group to which the epic belongs |
904 905
| `hasChildren` | Boolean! | Indicates if the epic has children |
| `hasIssues` | Boolean! | Indicates if the epic has direct issues |
Florie Guibert's avatar
Florie Guibert committed
906
| `hasParent` | Boolean! | Indicates if the epic has a parent epic |
907
| `healthStatus` | EpicHealthStatus | Current health status of the epic |
908 909
| `id` | ID! | ID of the epic |
| `iid` | ID! | Internal ID of the epic |
910
| `parent` | Epic | Parent epic of the epic |
911 912
| `reference` | String! | Internal reference of the epic. Returned in shortened format by default |
| `relationPath` | String | URI path of the epic-issue relationship |
913
| `relativePosition` | Int | The relative position of the epic in the epic tree |
914 915 916
| `startDate` | Time | Start date of the epic |
| `startDateFixed` | Time | Fixed start date of the epic |
| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones |
917 918 919 920
| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set |
| `state` | EpicState! | State of the epic |
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic |
| `title` | String | Title of the epic |
921
| `updatedAt` | Time | Timestamp of the epic's last activity |
922 923
| `upvotes` | Int! | Number of upvotes the epic has received |
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
924 925
| `webPath` | String! | Web path of the epic |
| `webUrl` | String! | Web URL of the epic |
926

927
### EpicAddIssuePayload
928

929
Autogenerated return type of EpicAddIssue.
930

931 932
| Field | Type | Description |
| ----- | ---- | ----------- |
933 934 935
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
| `epicIssue` | EpicIssue | The epic-issue relation |
936
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
937

938
### EpicDescendantCount
939 940

Counts of descendent epics.
941

942 943
| Field | Type | Description |
| ----- | ---- | ----------- |
944
| `closedEpics` | Int | Number of closed child epics |
945
| `closedIssues` | Int | Number of closed epic issues |
946
| `openedEpics` | Int | Number of opened child epics |
947
| `openedIssues` | Int | Number of opened epic issues |
948

949
### EpicDescendantWeights
950

951
Total weight of open and closed descendant issues.
952

953 954
| Field | Type | Description |
| ----- | ---- | ----------- |
955 956 957
| `closedIssues` | Int | Total weight of completed (closed) issues in this epic, including epic descendants |
| `openedIssues` | Int | Total weight of opened issues in this epic, including epic descendants |

958
### EpicHealthStatus
959

960
Health status of child issues.
961

962 963
| Field | Type | Description |
| ----- | ---- | ----------- |
964 965 966 967
| `issuesAtRisk` | Int | Number of issues at risk |
| `issuesNeedingAttention` | Int | Number of issues that need attention |
| `issuesOnTrack` | Int | Number of issues on track |

968
### EpicIssue
969

970
Relationship between an epic and an issue.
971

972 973
| Field | Type | Description |
| ----- | ---- | ----------- |
974
| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue |
975
| `author` | User! | User that created the issue |
976
| `blocked` | Boolean! | Indicates the issue is blocked |
977
| `closedAt` | Time | Timestamp of when the issue was closed |
978
| `confidential` | Boolean! | Indicates the issue is confidential |
979 980 981 982
| `createdAt` | Time! | Timestamp of when the issue was created |
| `description` | String | Description of the issue |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `designCollection` | DesignCollection | Collection of design images associated with this issue |
983
| `designs` **{warning-solid}** | DesignCollection | **Deprecated:** Use `designCollection`. Deprecated in 12.2 |
984 985
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue |
| `downvotes` | Int! | Number of downvotes the issue has received |
986 987 988
| `dueDate` | Time | Due date of the issue |
| `epic` | Epic | Epic to which this issue belongs |
| `epicIssueId` | ID! | ID of the epic-issue relation |
989
| `healthStatus` | HealthStatus | Current health status. Returns null if `save_issuable_health_status` feature flag is disabled. |
990 991
| `id` | ID | Global ID of the epic-issue relation |
| `iid` | ID! | Internal ID of the issue |
992
| `iteration` | Iteration | Iteration of the issue |
993 994 995
| `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 |
996
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) |
997
| `severity` | IssuableSeverity | Severity level of the incident |
998
| `state` | IssueState! | State of the issue |
David O'Regan's avatar
David O'Regan committed
999
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page |
1000
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue |
1001
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
1002
| `timeEstimate` | Int! | Time estimate of the issue |
1003 1004
| `title` | String! | Title of the issue |
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
1005
| `totalTimeSpent` | Int! | Total time reported as spent on the issue |
1006
| `type` | IssueType | Type of the issue |
1007
| `updatedAt` | Time! | Timestamp of when the issue was last updated |
1008 1009 1010 1011 1012
| `upvotes` | Int! | Number of upvotes the issue has received |
| `userNotesCount` | Int! | Number of user notes of the issue |
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
| `webPath` | String! | Web path of the issue |
| `webUrl` | String! | Web URL of the issue |
1013
| `weight` | Int | Weight of the issue |
1014

1015
### EpicPermissions
1016

1017
Check permissions for the current user on an epic.
1018

1019 1020
| Field | Type | Description |
| ----- | ---- | ----------- |
1021
| `adminEpic` | Boolean! | Indicates the user can perform `admin_epic` on this resource |
1022
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
1023 1024
| `createEpic` | Boolean! | Indicates the user can perform `create_epic` on this resource |
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
1025 1026 1027 1028
| `destroyEpic` | Boolean! | Indicates the user can perform `destroy_epic` on this resource |
| `readEpic` | Boolean! | Indicates the user can perform `read_epic` on this resource |
| `readEpicIid` | Boolean! | Indicates the user can perform `read_epic_iid` on this resource |
| `updateEpic` | Boolean! | Indicates the user can perform `update_epic` on this resource |
1029

1030
### EpicSetSubscriptionPayload
1031

1032
Autogenerated return type of EpicSetSubscription.
1033

1034 1035
| Field | Type | Description |
| ----- | ---- | ----------- |
1036 1037
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
1038
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1039

1040
### EpicTreeReorderPayload
1041

1042
Autogenerated return type of EpicTreeReorder.
1043

1044 1045
| Field | Type | Description |
| ----- | ---- | ----------- |
1046
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1047
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1048

1049
### GeoNode
1050

1051 1052
| Field | Type | Description |
| ----- | ---- | ----------- |
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
| `containerRepositoriesMaxCapacity` | Int | The maximum concurrency of container repository sync for this secondary node |
| `enabled` | Boolean | Indicates whether this Geo node is enabled |
| `filesMaxCapacity` | Int | The maximum concurrency of LFS/attachment backfill for this secondary node |
| `id` | ID! | ID of this GeoNode |
| `internalUrl` | String | The URL defined on the primary node that secondary nodes should use to contact it |
| `minimumReverificationInterval` | Int | The interval (in days) in which the repository verification is valid. Once expired, it will be reverified |
| `name` | String | The unique identifier for this Geo node |
| `primary` | Boolean | Indicates whether this Geo node is the primary |
| `reposMaxCapacity` | Int | The maximum concurrency of repository backfill for this secondary node |
| `selectiveSyncShards` | String! => Array | The repository storages whose projects should be synced, if `selective_sync_type` == `shards` |
| `selectiveSyncType` | String | Indicates if syncing is limited to only specific groups, or shards |
| `syncObjectStorage` | Boolean | Indicates if this secondary node will replicate blobs in Object Storage |
| `url` | String | The user-facing URL for this Geo node |
| `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node |

1068
### GrafanaIntegration
1069

1070 1071
| Field | Type | Description |
| ----- | ---- | ----------- |
1072 1073
| `createdAt` | Time! | Timestamp of the issue's creation |
| `enabled` | Boolean! | Indicates whether Grafana integration is enabled |
1074
| `grafanaUrl` | String! | URL for the Grafana host for the Grafana integration |
1075
| `id` | ID! | Internal ID of the Grafana integration |
1076
| `token` **{warning-solid}** | String! | **Deprecated:** Plain text token has been masked for security reasons. Deprecated in 12.7 |
1077 1078
| `updatedAt` | Time! | Timestamp of the issue's last activity |

1079
### Group
Felipe Artur's avatar
Felipe Artur committed
1080

1081 1082
| Field | Type | Description |
| ----- | ---- | ----------- |
1083 1084
| `autoDevopsEnabled` | Boolean | Indicates whether Auto DevOps is enabled for all projects within this group |
| `avatarUrl` | String | Avatar URL of the group |
1085
| `board` | Board | A single board of the group |
1086
| `description` | String | Description of the namespace |
Felipe Artur's avatar
Felipe Artur committed
1087
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1088 1089 1090 1091 1092 1093 1094
| `emailsDisabled` | Boolean | Indicates if a group has email notifications disabled |
| `epic` | Epic | Find a single epic |
| `epicsEnabled` | Boolean | Indicates if Epics are enabled for namespace |
| `fullName` | String! | Full name of the namespace |
| `fullPath` | ID! | Full path of the namespace |
| `groupTimelogsEnabled` | Boolean | Indicates if Group timelogs are enabled for namespace |
| `id` | ID! | ID of the namespace |
1095
| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase |
1096
| `label` | Label | A label available on this group |
1097
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace |
1098 1099 1100 1101 1102
| `mentionsDisabled` | Boolean | Indicates if a group is disabled from getting mentioned |
| `name` | String! | Name of the namespace |
| `parent` | Group | Parent group |
| `path` | String! | Path of the namespace |
| `projectCreationLevel` | String | The permission level required to create projects in the group |
1103
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace |
1104
| `requireTwoFactorAuthentication` | Boolean | Indicates if all users in this group are required to set up two-factor authentication |
1105
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces |
1106
| `shareWithGroupLock` | Boolean | Indicates if sharing a project with another group within this group is prevented |
1107
| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes |
1108
| `subgroupCreationLevel` | String | The permission level required to create subgroups within the group |
1109
| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active |
1110
| `twoFactorGracePeriod` | Int | Time before two-factor authentication is enforced |
1111 1112
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |
| `visibility` | String | Visibility of the namespace |
1113
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade |
1114
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the group and its subgroups |
1115
| `webUrl` | String! | Web URL of the group |
Felipe Artur's avatar
Felipe Artur committed
1116

1117
### GroupMember
1118

1119
Represents a Group Membership.
1120

1121 1122
| Field | Type | Description |
| ----- | ---- | ----------- |
1123 1124 1125 1126 1127
| `accessLevel` | AccessLevel | GitLab::Access level |
| `createdAt` | Time | Date and time the membership was created |
| `createdBy` | User | User that authorized membership |
| `expiresAt` | Time | Date and time the membership expires |
| `group` | Group | Group that a User is a member of |
1128
| `id` | ID! | ID of the member |
1129
| `updatedAt` | Time | Date and time the membership was last updated |
1130
| `user` | User! | User that is associated with the member object |
1131 1132
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |

1133
### GroupPermissions
Felipe Artur's avatar
Felipe Artur committed
1134

1135 1136
| Field | Type | Description |
| ----- | ---- | ----------- |
1137
| `readGroup` | Boolean! | Indicates the user can perform `read_group` on this resource |
Felipe Artur's avatar
Felipe Artur committed
1138

1139
### InstanceSecurityDashboard
1140

1141 1142
| Field | Type | Description |
| ----- | ---- | ----------- |
1143
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade |
1144
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard |
1145

1146
### InstanceStatisticsMeasurement
1147

1148
Represents a recorded measurement (object count) for the Admins.
1149

1150 1151
| Field | Type | Description |
| ----- | ---- | ----------- |
1152 1153 1154 1155
| `count` | Int! | Object count |
| `identifier` | MeasurementIdentifier! | The type of objects being measured |
| `recordedAt` | Time | The time the measurement was recorded |

1156
### Issue
Felipe Artur's avatar
Felipe Artur committed
1157

1158 1159
| Field | Type | Description |
| ----- | ---- | ----------- |
1160
| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue |
1161
| `author` | User! | User that created the issue |
1162
| `blocked` | Boolean! | Indicates the issue is blocked |
1163
| `closedAt` | Time | Timestamp of when the issue was closed |
1164
| `confidential` | Boolean! | Indicates the issue is confidential |
1165 1166 1167 1168
| `createdAt` | Time! | Timestamp of when the issue was created |
| `description` | String | Description of the issue |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `designCollection` | DesignCollection | Collection of design images associated with this issue |
1169
| `designs` **{warning-solid}** | DesignCollection | **Deprecated:** Use `designCollection`. Deprecated in 12.2 |
1170 1171
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue |
| `downvotes` | Int! | Number of downvotes the issue has received |
1172 1173
| `dueDate` | Time | Due date of the issue |
| `epic` | Epic | Epic to which this issue belongs |
1174
| `healthStatus` | HealthStatus | Current health status. Returns null if `save_issuable_health_status` feature flag is disabled. |
1175
| `id` | ID! | ID of the issue |
1176
| `iid` | ID! | Internal ID of the issue |
1177
| `iteration` | Iteration | Iteration of the issue |
1178 1179 1180
| `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) |
1181
| `severity` | IssuableSeverity | Severity level of the incident |
1182
| `state` | IssueState! | State of the issue |
David O'Regan's avatar
David O'Regan committed
1183
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page |
1184 1185
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue |
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
1186
| `timeEstimate` | Int! | Time estimate of the issue |
1187 1188
| `title` | String! | Title of the issue |
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
1189
| `totalTimeSpent` | Int! | Total time reported as spent on the issue |
1190
| `type` | IssueType | Type of the issue |
1191
| `updatedAt` | Time! | Timestamp of when the issue was last updated |
1192 1193 1194 1195 1196
| `upvotes` | Int! | Number of upvotes the issue has received |
| `userNotesCount` | Int! | Number of user notes of the issue |
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
| `webPath` | String! | Web path of the issue |
| `webUrl` | String! | Web URL of the issue |
1197
| `weight` | Int | Weight of the issue |
Felipe Artur's avatar
Felipe Artur committed
1198

1199
### IssueMoveListPayload
1200

1201
Autogenerated return type of IssueMoveList.
1202

1203 1204
| Field | Type | Description |
| ----- | ---- | ----------- |
1205 1206 1207 1208
| `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 |

1209
### IssuePermissions
1210

1211
Check permissions for the current user on a issue.
Felipe Artur's avatar
Felipe Artur committed
1212

1213 1214
| Field | Type | Description |
| ----- | ---- | ----------- |
1215 1216
| `adminIssue` | Boolean! | Indicates the user can perform `admin_issue` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
1217
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
1218
| `destroyDesign` | Boolean! | Indicates the user can perform `destroy_design` on this resource |
1219 1220 1221 1222
| `readDesign` | Boolean! | Indicates the user can perform `read_design` on this resource |
| `readIssue` | Boolean! | Indicates the user can perform `read_issue` on this resource |
| `reopenIssue` | Boolean! | Indicates the user can perform `reopen_issue` on this resource |
| `updateIssue` | Boolean! | Indicates the user can perform `update_issue` on this resource |
Felipe Artur's avatar
Felipe Artur committed
1223

1224
### IssueSetAssigneesPayload
1225

1226
Autogenerated return type of IssueSetAssignees.
1227

1228 1229
| Field | Type | Description |
| ----- | ---- | ----------- |
1230 1231 1232 1233
| `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 |

1234
### IssueSetConfidentialPayload
1235

1236
Autogenerated return type of IssueSetConfidential.
1237

1238 1239
| Field | Type | Description |
| ----- | ---- | ----------- |
1240
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1241
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1242 1243
| `issue` | Issue | The issue after mutation |

1244
### IssueSetDueDatePayload
1245

1246
Autogenerated return type of IssueSetDueDate.
1247

1248 1249
| Field | Type | Description |
| ----- | ---- | ----------- |
1250 1251 1252 1253
| `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 |

1254
### IssueSetEpicPayload
1255

1256
Autogenerated return type of IssueSetEpic.
1257

1258 1259
| Field | Type | Description |
| ----- | ---- | ----------- |
1260
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1261
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1262 1263
| `issue` | Issue | The issue after mutation |

1264
### IssueSetIterationPayload
1265

1266
Autogenerated return type of IssueSetIteration.
1267

1268 1269
| Field | Type | Description |
| ----- | ---- | ----------- |
1270 1271 1272 1273
| `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 |

1274
### IssueSetLockedPayload
1275

1276
Autogenerated return type of IssueSetLocked.
1277

1278 1279
| Field | Type | Description |
| ----- | ---- | ----------- |
1280
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1281 1282 1283
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |

1284
### IssueSetSeverityPayload
1285

1286
Autogenerated return type of IssueSetSeverity.
1287

1288 1289
| Field | Type | Description |
| ----- | ---- | ----------- |
1290
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1291 1292 1293
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |

1294
### IssueSetSubscriptionPayload
1295

1296
Autogenerated return type of IssueSetSubscription.
1297

1298 1299
| Field | Type | Description |
| ----- | ---- | ----------- |
1300 1301 1302 1303
| `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 |

1304
### IssueSetWeightPayload
1305

1306
Autogenerated return type of IssueSetWeight.
1307

1308 1309
| Field | Type | Description |
| ----- | ---- | ----------- |
1310
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1311
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1312 1313
| `issue` | Issue | The issue after mutation |

1314
### IssueStatusCountsType
Sean Arnold's avatar
Sean Arnold committed
1315

Sean Arnold's avatar
Sean Arnold committed
1316
Represents total number of issues for the represented statuses.
Sean Arnold's avatar
Sean Arnold committed
1317

1318 1319
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
1320 1321 1322 1323
| `all` | Int | Number of issues with status ALL for the project |
| `closed` | Int | Number of issues with status CLOSED for the project |
| `opened` | Int | Number of issues with status OPENED for the project |

1324
### Iteration
1325 1326 1327

Represents an iteration object.

1328 1329
| Field | Type | Description |
| ----- | ---- | ----------- |
1330
| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts |
1331 1332
| `createdAt` | Time! | Timestamp of iteration creation |
| `description` | String | Description of the iteration |
1333
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1334 1335
| `dueDate` | Time | Timestamp of the iteration due date |
| `id` | ID! | ID of the iteration |
1336
| `iid` | ID! | Internal ID of the iteration |
1337 1338
| `scopedPath` | String | Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts |
| `scopedUrl` | String | Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts |
1339 1340 1341 1342 1343 1344 1345
| `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 |

1346
### JiraImport
1347

1348 1349
| Field | Type | Description |
| ----- | ---- | ----------- |
1350
| `createdAt` | Time | Timestamp of when the Jira import was created |
1351 1352
| `failedToImportCount` | Int! | Count of issues that failed to import |
| `importedIssuesCount` | Int! | Count of issues that were successfully imported |
1353
| `jiraProjectKey` | String! | Project key for the imported Jira project |
1354
| `scheduledAt` | Time | Timestamp of when the Jira import was scheduled |
1355
| `scheduledBy` | User | User that started the Jira import |
1356
| `totalIssueCount` | Int! | Total count of issues that were attempted to import |
1357

1358
### JiraImportStartPayload
1359

1360
Autogenerated return type of JiraImportStart.
1361

1362 1363
| Field | Type | Description |
| ----- | ---- | ----------- |
1364
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1365
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1366 1367
| `jiraImport` | JiraImport | The Jira import data after mutation |

1368
### JiraImportUsersPayload
1369

1370
Autogenerated return type of JiraImportUsers.
1371

1372 1373
| Field | Type | Description |
| ----- | ---- | ----------- |
1374 1375 1376 1377
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `jiraUsers` | JiraUser! => Array | Users returned from Jira, matched by email and name if possible. |

1378
### JiraProject
1379

1380 1381
| Field | Type | Description |
| ----- | ---- | ----------- |
1382 1383 1384 1385
| `key` | String! | Key of the Jira project |
| `name` | String | Name of the Jira project |
| `projectId` | Int! | ID of the Jira project |

1386
### JiraService
1387

1388 1389
| Field | Type | Description |
| ----- | ---- | ----------- |
1390 1391 1392
| `active` | Boolean | Indicates if the service is active |
| `type` | String | Class name of the service |

1393
### JiraUser
1394

1395 1396
| Field | Type | Description |
| ----- | ---- | ----------- |
1397 1398 1399
| `gitlabId` | Int | ID of the matched GitLab user |
| `gitlabName` | String | Name of the matched GitLab user |
| `gitlabUsername` | String | Username of the matched GitLab user |
1400
| `jiraAccountId` | String! | Account ID of the Jira user |
1401 1402 1403
| `jiraDisplayName` | String! | Display name of the Jira user |
| `jiraEmail` | String | Email of the Jira user, returned only for users with public emails |

1404
### Label
Felipe Artur's avatar
Felipe Artur committed
1405

1406 1407
| Field | Type | Description |
| ----- | ---- | ----------- |
1408
| `color` | String! | Background color of the label |
Marcel Amirault's avatar
Marcel Amirault committed
1409
| `description` | String | Description of the label (Markdown rendered as HTML for caching) |
Felipe Artur's avatar
Felipe Artur committed
1410
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1411
| `id` | ID! | Label ID |
1412
| `textColor` | String! | Text color of the label |
1413
| `title` | String! | Content of the label |
Felipe Artur's avatar
Felipe Artur committed
1414

1415
### MarkAsSpamSnippetPayload
1416

1417
Autogenerated return type of MarkAsSpamSnippet.
1418

1419 1420
| Field | Type | Description |
| ----- | ---- | ----------- |
1421
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1422
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1423 1424
| `snippet` | Snippet | The snippet after mutation |

1425
### MergeRequest
Felipe Artur's avatar
Felipe Artur committed
1426

1427 1428
| Field | Type | Description |
| ----- | ---- | ----------- |
1429
| `allowCollaboration` | Boolean | Indicates if members of the target project can push to the fork |
1430 1431
| `approvalsLeft` | Int | Number of approvals left |
| `approvalsRequired` | Int | Number of approvals required |
1432
| `approved` | Boolean! | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. |
1433
| `author` | User | User who created this merge request |
1434
| `autoMergeEnabled` | Boolean! | Indicates if auto merge is enabled for the merge request |
1435
| `commitCount` | Int | Number of commits in the merge request |
1436
| `conflicts` | Boolean! | Indicates if the merge request has conflicts |
1437 1438
| `createdAt` | Time! | Timestamp of when the merge request was created |
| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request |
Marcel Amirault's avatar
Marcel Amirault committed
1439
| `description` | String | Description of the merge request (Markdown rendered as HTML for caching) |
Felipe Artur's avatar
Felipe Artur committed
1440
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1441
| `diffHeadSha` | String | Diff head SHA of the merge request |
1442
| `diffRefs` | DiffRefs | References of the base SHA, the head SHA, and the start SHA for this merge request |
1443 1444
| `diffStats` | DiffStats! => Array | Details about which files were changed in this merge request |
| `diffStatsSummary` | DiffStatsSummary | Summary of which files were changed in this merge request |
1445 1446
| `discussionLocked` | Boolean! | Indicates if comments on the merge request are locked to members only |
| `downvotes` | Int! | Number of downvotes for the merge request |
1447
| `forceRemoveSourceBranch` | Boolean | Indicates if the project settings will lead to source branch deletion after merge |
1448 1449
| `headPipeline` | Pipeline | The pipeline running on the branch HEAD of the merge request |
| `id` | ID! | ID of the merge request |
1450
| `iid` | String! | Internal ID of the merge request |
1451
| `inProgressMergeCommitSha` | String | Commit SHA of the merge request if merge is in progress |
1452
| `mergeCommitMessage` **{warning-solid}** | String | **Deprecated:** Use `defaultMergeCommitMessage`. Deprecated in 11.8 |
1453 1454
| `mergeCommitSha` | String | SHA of the merge request commit (set once merged) |
| `mergeError` | String | Error message due to a merge error |
1455
| `mergeOngoing` | Boolean! | Indicates if a merge is currently occurring |
1456 1457
| `mergeStatus` | String | Status of the merge request |
| `mergeWhenPipelineSucceeds` | Boolean | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS) |
1458
| `mergeableDiscussionsState` | Boolean | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged |
1459
| `mergedAt` | Time | Timestamp of when the merge request was merged, null if not merged |
1460
| `milestone` | Milestone | The milestone of the merge request |
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
| `project` | Project! | Alias for target_project |
| `projectId` | Int! | ID of the merge request project |
| `rebaseCommitSha` | String | Rebase commit SHA of the merge request |
| `rebaseInProgress` | Boolean! | Indicates if there is a rebase currently in progress for the merge request |
| `reference` | String! | Internal reference of the merge request. Returned in shortened format by default |
| `shouldBeRebased` | Boolean! | Indicates if the merge request will be rebased |
| `shouldRemoveSourceBranch` | Boolean | Indicates if the source branch of the merge request will be deleted after merge |
| `sourceBranch` | String! | Source branch of the merge request |
| `sourceBranchExists` | Boolean! | Indicates if the source branch of the merge request exists |
| `sourceProject` | Project | Source project of the merge request |
| `sourceProjectId` | Int | ID of the merge request source project |
| `state` | MergeRequestState! | State of the merge request |
1473
| `subscribed` | Boolean! | Indicates if the currently logged in user is subscribed to this merge request |
1474
| `targetBranch` | String! | Target branch of the merge request |
1475
| `targetBranchExists` | Boolean! | Indicates if the target branch of the merge request exists |
1476 1477 1478
| `targetProject` | Project! | Target project of the merge request |
| `targetProjectId` | Int! | ID of the merge request target project |
| `taskCompletionStatus` | TaskCompletionStatus! | Completion status of tasks |
1479
| `timeEstimate` | Int! | Time estimate of the merge request |
1480 1481
| `title` | String! | Title of the merge request |
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
1482
| `totalTimeSpent` | Int! | Total time reported as spent on the merge request |
1483 1484 1485 1486 1487 1488
| `updatedAt` | Time! | Timestamp of when the merge request was last updated |
| `upvotes` | Int! | Number of upvotes for the merge request |
| `userNotesCount` | Int | User notes count of the merge request |
| `userPermissions` | MergeRequestPermissions! | Permissions for the current user on the resource |
| `webUrl` | String | Web URL of the merge request |
| `workInProgress` | Boolean! | Indicates if the merge request is a work in progress (WIP) |
Felipe Artur's avatar
Felipe Artur committed
1489

1490
### MergeRequestCreatePayload
1491

1492
Autogenerated return type of MergeRequestCreate.
1493

1494 1495
| Field | Type | Description |
| ----- | ---- | ----------- |
1496 1497 1498 1499
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `mergeRequest` | MergeRequest | The merge request after mutation |

1500 1501
### MergeRequestDiffRegistry

1502
Represents the Geo sync and verification state of a Merge Request diff.
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514

| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time | Timestamp when the MergeRequestDiffRegistry was created |
| `id` | ID! | ID of the MergeRequestDiffRegistry |
| `lastSyncFailure` | String | Error message during sync of the MergeRequestDiffRegistry |
| `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the MergeRequestDiffRegistry |
| `mergeRequestDiffId` | ID! | ID of the Merge Request diff |
| `retryAt` | Time | Timestamp after which the MergeRequestDiffRegistry should be resynced |
| `retryCount` | Int | Number of consecutive failed sync attempts of the MergeRequestDiffRegistry |
| `state` | RegistryState | Sync state of the MergeRequestDiffRegistry |

1515
### MergeRequestPermissions
1516

1517
Check permissions for the current user on a merge request.
Felipe Artur's avatar
Felipe Artur committed
1518

1519 1520
| Field | Type | Description |
| ----- | ---- | ----------- |
1521
| `adminMergeRequest` | Boolean! | Indicates the user can perform `admin_merge_request` on this resource |
1522
| `canMerge` | Boolean! | Indicates the user can perform `can_merge` on this resource |
1523
| `cherryPickOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource |
1524 1525
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
| `pushToSourceBranch` | Boolean! | Indicates the user can perform `push_to_source_branch` on this resource |
1526
| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource |
1527 1528
| `removeSourceBranch` | Boolean! | Indicates the user can perform `remove_source_branch` on this resource |
| `revertOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `revert_on_current_merge_request` on this resource |
1529
| `updateMergeRequest` | Boolean! | Indicates the user can perform `update_merge_request` on this resource |
Felipe Artur's avatar
Felipe Artur committed
1530

1531
### MergeRequestSetAssigneesPayload
1532

1533
Autogenerated return type of MergeRequestSetAssignees.
1534

1535 1536
| Field | Type | Description |
| ----- | ---- | ----------- |
1537
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1538
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1539 1540
| `mergeRequest` | MergeRequest | The merge request after mutation |

1541
### MergeRequestSetLabelsPayload
1542

1543
Autogenerated return type of MergeRequestSetLabels.
Mario de la Ossa's avatar
Mario de la Ossa committed
1544

1545 1546
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
1547
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1548
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
1549 1550
| `mergeRequest` | MergeRequest | The merge request after mutation |

1551
### MergeRequestSetLockedPayload
1552

1553
Autogenerated return type of MergeRequestSetLocked.
Mario de la Ossa's avatar
Mario de la Ossa committed
1554

1555 1556
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
1557
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1558
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
1559 1560
| `mergeRequest` | MergeRequest | The merge request after mutation |

1561
### MergeRequestSetMilestonePayload
1562

1563
Autogenerated return type of MergeRequestSetMilestone.
1564

1565 1566
| Field | Type | Description |
| ----- | ---- | ----------- |
1567
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1568
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
1569 1570
| `mergeRequest` | MergeRequest | The merge request after mutation |

1571
### MergeRequestSetSubscriptionPayload
1572

1573
Autogenerated return type of MergeRequestSetSubscription.
Mario de la Ossa's avatar
Mario de la Ossa committed
1574

1575 1576
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
1577
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1578
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1579 1580
| `mergeRequest` | MergeRequest | The merge request after mutation |

1581
### MergeRequestSetWipPayload
1582

1583
Autogenerated return type of MergeRequestSetWip.
Felipe Artur's avatar
Felipe Artur committed
1584

1585 1586
| Field | Type | Description |
| ----- | ---- | ----------- |
Felipe Artur's avatar
Felipe Artur committed
1587
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1588
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
1589 1590
| `mergeRequest` | MergeRequest | The merge request after mutation |

1591
### MergeRequestUpdatePayload
1592

1593
Autogenerated return type of MergeRequestUpdate.
1594

1595 1596
| Field | Type | Description |
| ----- | ---- | ----------- |
1597
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1598
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
1599 1600
| `mergeRequest` | MergeRequest | The merge request after mutation |

1601
### Metadata
Felipe Artur's avatar
Felipe Artur committed
1602

1603 1604
| Field | Type | Description |
| ----- | ---- | ----------- |
1605
| `revision` | String! | Revision |
1606
| `version` | String! | Version |
Felipe Artur's avatar
Felipe Artur committed
1607

1608
### MetricsDashboard
1609

1610 1611
| Field | Type | Description |
| ----- | ---- | ----------- |
1612
| `path` | String | Path to a file with the dashboard definition |
1613
| `schemaValidationWarnings` | String! => Array | Dashboard schema validation warnings |
1614

1615
### MetricsDashboardAnnotation
1616

1617 1618
| Field | Type | Description |
| ----- | ---- | ----------- |
1619
| `description` | String | Description of the annotation |
1620
| `endingAt` | Time | Timestamp marking end of annotated time span |
1621 1622
| `id` | ID! | ID of the annotation |
| `panelId` | String | ID of a dashboard panel to which the annotation should be scoped |
1623
| `startingAt` | Time | Timestamp marking start of annotated time span |
1624

1625
### Milestone
Felipe Artur's avatar
Felipe Artur committed
1626

1627 1628
Represents a milestone.

1629 1630
| Field | Type | Description |
| ----- | ---- | ----------- |
1631
| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts |
1632
| `createdAt` | Time! | Timestamp of milestone creation |
1633 1634
| `description` | String | Description of the milestone |
| `dueDate` | Time | Timestamp of the milestone due date |
1635
| `groupMilestone` | Boolean! | Indicates if milestone is at group level |
1636
| `id` | ID! | ID of the milestone |
1637
| `projectMilestone` | Boolean! | Indicates if milestone is at project level |
1638
| `startDate` | Time | Timestamp of the milestone start date |
1639
| `state` | MilestoneStateEnum! | State of the milestone |
1640
| `stats` | MilestoneStats | Milestone statistics |
1641
| `subgroupMilestone` | Boolean! | Indicates if milestone is at subgroup level |
1642
| `title` | String! | Title of the milestone |
1643
| `updatedAt` | Time! | Timestamp of last milestone update |
1644
| `webPath` | String! | Web path of the milestone |
Felipe Artur's avatar
Felipe Artur committed
1645

1646
### MilestoneStats
1647

1648
Contains statistics about a milestone.
1649

1650 1651
| Field | Type | Description |
| ----- | ---- | ----------- |
1652 1653 1654
| `closedIssuesCount` | Int | Number of closed issues associated with the milestone |
| `totalIssuesCount` | Int | Total number of issues associated with the milestone |

1655
### Namespace
Felipe Artur's avatar
Felipe Artur committed
1656

1657 1658
| Field | Type | Description |
| ----- | ---- | ----------- |
1659
| `description` | String | Description of the namespace |
Felipe Artur's avatar
Felipe Artur committed
1660
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1661 1662 1663
| `fullName` | String! | Full name of the namespace |
| `fullPath` | ID! | Full path of the namespace |
| `id` | ID! | ID of the namespace |
1664
| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase |
1665
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace |
1666 1667
| `name` | String! | Name of the namespace |
| `path` | String! | Path of the namespace |
1668 1669
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace |
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces |
1670
| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes |
1671
| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active |
1672
| `visibility` | String | Visibility of the namespace |
Felipe Artur's avatar
Felipe Artur committed
1673

1674
### NamespaceIncreaseStorageTemporarilyPayload
1675

1676
Autogenerated return type of NamespaceIncreaseStorageTemporarily.
1677

1678 1679
| Field | Type | Description |
| ----- | ---- | ----------- |
1680 1681 1682 1683
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `namespace` | Namespace | The namespace after mutation |

1684
### Note
Felipe Artur's avatar
Felipe Artur committed
1685

1686 1687
| Field | Type | Description |
| ----- | ---- | ----------- |
1688 1689
| `author` | User! | User who wrote this note |
| `body` | String! | Content of the note |
Felipe Artur's avatar
Felipe Artur committed
1690
| `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` |
1691
| `confidential` | Boolean | Indicates if this note is confidential |
1692
| `createdAt` | Time! | Timestamp of the note creation |
Felipe Artur's avatar
Felipe Artur committed
1693
| `discussion` | Discussion | The discussion this note is a part of |
1694 1695 1696
| `id` | ID! | ID of the note |
| `position` | DiffPosition | The position of this note on a diff |
| `project` | Project | Project associated with the note |
1697 1698 1699 1700
| `resolvable` | Boolean! | Indicates if the object can be resolved |
| `resolved` | Boolean! | Indicates if the object is resolved |
| `resolvedAt` | Time | Timestamp of when the object was resolved |
| `resolvedBy` | User | User who resolved the object |
1701
| `system` | Boolean! | Indicates whether this note was created by the system or by a user |
1702
| `systemNoteIconName` | String | Name of the icon corresponding to a system note |
1703 1704
| `updatedAt` | Time! | Timestamp of the note's last activity |
| `userPermissions` | NotePermissions! | Permissions for the current user on the resource |
Felipe Artur's avatar
Felipe Artur committed
1705

1706
### NotePermissions
Felipe Artur's avatar
Felipe Artur committed
1707

1708 1709
| Field | Type | Description |
| ----- | ---- | ----------- |
1710 1711
| `adminNote` | Boolean! | Indicates the user can perform `admin_note` on this resource |
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
1712 1713 1714
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
| `readNote` | Boolean! | Indicates the user can perform `read_note` on this resource |
| `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource |
Felipe Artur's avatar
Felipe Artur committed
1715

1716
### Package
1717

1718
Represents a package.
1719

1720 1721
| Field | Type | Description |
| ----- | ---- | ----------- |
1722 1723 1724 1725 1726 1727 1728
| `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 |

1729
### PackageFileRegistry
1730

1731
Represents the Geo sync and verification state of a package file.
1732

1733 1734
| Field | Type | Description |
| ----- | ---- | ----------- |
1735 1736 1737 1738 1739 1740 1741 1742 1743
| `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 |

1744
### PageInfo
1745

1746
Information about pagination in a connection..
Felipe Artur's avatar
Felipe Artur committed
1747

1748 1749
| Field | Type | Description |
| ----- | ---- | ----------- |
1750
| `endCursor` | String | When paginating forwards, the cursor to continue. |
Felipe Artur's avatar
Felipe Artur committed
1751 1752 1753 1754
| `hasNextPage` | Boolean! | When paginating forwards, are there more items? |
| `hasPreviousPage` | Boolean! | When paginating backwards, are there more items? |
| `startCursor` | String | When paginating backwards, the cursor to continue. |

1755
### Pipeline
Felipe Artur's avatar
Felipe Artur committed
1756

1757 1758
| Field | Type | Description |
| ----- | ---- | ----------- |
1759
| `beforeSha` | String | Base SHA of the source branch |
lauraMon's avatar
lauraMon committed
1760
| `cancelable` | Boolean! | Specifies if a pipeline can be canceled |
1761
| `committedAt` | Time | Timestamp of the pipeline's commit |
1762
| `configSource` | PipelineConfigSourceEnum | Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE) |
1763 1764 1765 1766 1767
| `coverage` | Float | Coverage percentage |
| `createdAt` | Time! | Timestamp of the pipeline's creation |
| `detailedStatus` | DetailedStatus! | Detailed status of the pipeline |
| `duration` | Int | Duration of the pipeline in seconds |
| `finishedAt` | Time | Timestamp of the pipeline's completion |
1768
| `id` | ID! | ID of the pipeline |
1769
| `iid` | String! | Internal ID of the pipeline |
lauraMon's avatar
lauraMon committed
1770
| `retryable` | Boolean! | Specifies if a pipeline can be retried |
1771
| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline |
1772
| `sha` | String! | SHA of the pipeline's commit |
1773
| `startedAt` | Time | Timestamp when the pipeline was started |
1774
| `status` | PipelineStatusEnum! | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED) |
1775
| `updatedAt` | Time! | Timestamp of the pipeline's last activity |
lauraMon's avatar
lauraMon committed
1776
| `user` | User | Pipeline user |
1777
| `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource |
Felipe Artur's avatar
Felipe Artur committed
1778

1779
### PipelineCancelPayload
lauraMon's avatar
lauraMon committed
1780

1781
Autogenerated return type of PipelineCancel.
lauraMon's avatar
lauraMon committed
1782

1783 1784
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
1785 1786 1787
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

1788
### PipelineDestroyPayload
lauraMon's avatar
lauraMon committed
1789

1790
Autogenerated return type of PipelineDestroy.
lauraMon's avatar
lauraMon committed
1791

1792 1793
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
1794 1795 1796
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

1797
### PipelinePermissions
Felipe Artur's avatar
Felipe Artur committed
1798

1799 1800
| Field | Type | Description |
| ----- | ---- | ----------- |
1801 1802
| `adminPipeline` | Boolean! | Indicates the user can perform `admin_pipeline` on this resource |
| `destroyPipeline` | Boolean! | Indicates the user can perform `destroy_pipeline` on this resource |
1803
| `updatePipeline` | Boolean! | Indicates the user can perform `update_pipeline` on this resource |
Felipe Artur's avatar
Felipe Artur committed
1804

1805
### PipelineRetryPayload
lauraMon's avatar
lauraMon committed
1806

1807
Autogenerated return type of PipelineRetry.
lauraMon's avatar
lauraMon committed
1808

1809 1810
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
1811 1812 1813 1814
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `pipeline` | Pipeline | The pipeline after mutation |

1815
### Project
Felipe Artur's avatar
Felipe Artur committed
1816

1817 1818
| Field | Type | Description |
| ----- | ---- | ----------- |
1819
| `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project |
1820
| `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project |
1821
| `allowMergeOnSkippedPipeline` | Boolean | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs |
1822 1823 1824
| `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 |
1825
| `board` | Board | A single board of the project |
1826
| `clusterAgent` | ClusterAgent | Find a single cluster agent by name |
1827
| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy of the project |
1828 1829
| `containerRegistryEnabled` | Boolean | Indicates if the project stores Docker container images in a container registry |
| `createdAt` | Time | Timestamp of the project creation |
1830
| `dastSiteProfile` | DastSiteProfile | DAST Site Profile associated with the project |
1831
| `description` | String | Short description of the project |
Felipe Artur's avatar
Felipe Artur committed
1832
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1833
| `environment` | Environment | A single environment of the project |
1834
| `forksCount` | Int! | Number of times the project has been forked |
1835 1836 1837 1838 1839
| `fullPath` | ID! | Full path of the project |
| `grafanaIntegration` | GrafanaIntegration | Grafana integration details for the project |
| `group` | Group | Group of the project |
| `httpUrlToRepo` | String | URL to connect to the project via HTTPS |
| `id` | ID! | ID of the project |
1840
| `importStatus` | String | Status of import background job of the project |
1841
| `issue` | Issue | A single issue of the project |
Sean Arnold's avatar
Sean Arnold committed
1842
| `issueStatusCounts` | IssueStatusCountsType | Counts of issues by status for the project |
1843
| `issuesEnabled` | Boolean | Indicates if Issues are enabled for the current user |
1844
| `jiraImportStatus` | String | Status of Jira import background job of the project |
1845
| `jobsEnabled` | Boolean | Indicates if CI/CD pipeline jobs are enabled for the current user |
1846
| `label` | Label | A label available on this project |
1847 1848
| `lastActivityAt` | Time | Timestamp of the project last activity |
| `lfsEnabled` | Boolean | Indicates if the project has Large File Storage (LFS) enabled |
1849
| `mergeRequest` | MergeRequest | A single merge request of the project |
1850
| `mergeRequestsEnabled` | Boolean | Indicates if Merge Requests are enabled for the current user |
1851 1852 1853 1854
| `mergeRequestsFfOnlyEnabled` | 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. |
| `name` | String! | Name of the project (without namespace) |
| `nameWithNamespace` | String! | Full name of the project with its namespace |
| `namespace` | Namespace | Namespace of the project |
1855
| `onlyAllowMergeIfAllDiscussionsAreResolved` | Boolean | Indicates if merge requests of the project can only be merged when all the discussions are resolved |
1856 1857 1858
| `onlyAllowMergeIfPipelineSucceeds` | Boolean | Indicates if merge requests of the project can only be merged with successful jobs |
| `openIssuesCount` | Int | Number of open issues for the project |
| `path` | String! | Path of the project |
1859
| `pipeline` | Pipeline | Build pipeline of the project |
1860
| `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 |
1861
| `publicJobs` | Boolean | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts |
1862
| `release` | Release | A single release of the project |
1863 1864
| `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 |
1865
| `requestAccessEnabled` | Boolean | Indicates if users can request member access to the project |
1866
| `requirement` | Requirement | Find a single requirement. Available only when feature flag `requirements_management` is enabled. |
1867
| `requirementStatesCount` | RequirementStatesCount | Number of requirements for the project by their state |
1868
| `sastCiConfiguration` | SastCiConfiguration | SAST CI configuration for the project |
1869
| `securityDashboardPath` | String | Path to project's security dashboard |
1870
| `securityScanners` | SecurityScanners | Information about security analyzers used in the project |
1871
| `sentryDetailedError` | SentryDetailedError | Detailed version of a Sentry error on the project |
Sean Arnold's avatar
Sean Arnold committed
1872
| `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project |
1873
| `serviceDeskAddress` | String | E-mail address of the service desk. |
1874
| `serviceDeskEnabled` | Boolean | Indicates if the project has service desk enabled. |
1875
| `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project |
1876
| `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user |
1877 1878 1879 1880
| `sshUrlToRepo` | String | URL to connect to the project via SSH |
| `starCount` | Int! | Number of times the project has been starred |
| `statistics` | ProjectStatistics | Statistics of the project |
| `suggestionCommitMessage` | String | The commit message used to apply merge request suggestions |
1881
| `tagList` | String | List of project topics (not Git tags) |
1882 1883
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
| `visibility` | String | Visibility of the project |
1884
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the project |
1885
| `webUrl` | String | Web URL of the project |
1886
| `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user |
Felipe Artur's avatar
Felipe Artur committed
1887

1888
### ProjectMember
1889

1890
Represents a Project Membership.
1891

1892 1893
| Field | Type | Description |
| ----- | ---- | ----------- |
1894 1895 1896 1897
| `accessLevel` | AccessLevel | GitLab::Access level |
| `createdAt` | Time | Date and time the membership was created |
| `createdBy` | User | User that authorized membership |
| `expiresAt` | Time | Date and time the membership expires |
1898
| `id` | ID! | ID of the member |
1899 1900
| `project` | Project | Project that User is a member of |
| `updatedAt` | Time | Date and time the membership was last updated |
1901
| `user` | User! | User that is associated with the member object |
1902
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
1903

1904
### ProjectPermissions
Felipe Artur's avatar
Felipe Artur committed
1905

1906 1907
| Field | Type | Description |
| ----- | ---- | ----------- |
1908 1909 1910 1911 1912
| `adminOperations` | Boolean! | Indicates the user can perform `admin_operations` on this resource |
| `adminProject` | Boolean! | Indicates the user can perform `admin_project` on this resource |
| `adminRemoteMirror` | Boolean! | Indicates the user can perform `admin_remote_mirror` on this resource |
| `adminWiki` | Boolean! | Indicates the user can perform `admin_wiki` on this resource |
| `archiveProject` | Boolean! | Indicates the user can perform `archive_project` on this resource |
1913 1914
| `changeNamespace` | Boolean! | Indicates the user can perform `change_namespace` on this resource |
| `changeVisibilityLevel` | Boolean! | Indicates the user can perform `change_visibility_level` on this resource |
1915 1916
| `createDeployment` | Boolean! | Indicates the user can perform `create_deployment` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
1917
| `createIssue` | Boolean! | Indicates the user can perform `create_issue` on this resource |
1918 1919 1920 1921
| `createLabel` | Boolean! | Indicates the user can perform `create_label` on this resource |
| `createMergeRequestFrom` | Boolean! | Indicates the user can perform `create_merge_request_from` on this resource |
| `createMergeRequestIn` | Boolean! | Indicates the user can perform `create_merge_request_in` on this resource |
| `createPages` | Boolean! | Indicates the user can perform `create_pages` on this resource |
1922 1923
| `createPipeline` | Boolean! | Indicates the user can perform `create_pipeline` on this resource |
| `createPipelineSchedule` | Boolean! | Indicates the user can perform `create_pipeline_schedule` on this resource |
1924
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
1925
| `createWiki` | Boolean! | Indicates the user can perform `create_wiki` on this resource |
1926 1927 1928 1929 1930 1931
| `destroyDesign` | Boolean! | Indicates the user can perform `destroy_design` on this resource |
| `destroyPages` | Boolean! | Indicates the user can perform `destroy_pages` on this resource |
| `destroyWiki` | Boolean! | Indicates the user can perform `destroy_wiki` on this resource |
| `downloadCode` | Boolean! | Indicates the user can perform `download_code` on this resource |
| `downloadWikiCode` | Boolean! | Indicates the user can perform `download_wiki_code` on this resource |
| `forkProject` | Boolean! | Indicates the user can perform `fork_project` on this resource |
1932 1933
| `pushCode` | Boolean! | Indicates the user can perform `push_code` on this resource |
| `pushToDeleteProtectedBranch` | Boolean! | Indicates the user can perform `push_to_delete_protected_branch` on this resource |
1934 1935 1936
| `readCommitStatus` | Boolean! | Indicates the user can perform `read_commit_status` on this resource |
| `readCycleAnalytics` | Boolean! | Indicates the user can perform `read_cycle_analytics` on this resource |
| `readDesign` | Boolean! | Indicates the user can perform `read_design` on this resource |
1937
| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource |
1938 1939 1940 1941 1942 1943 1944 1945 1946
| `readPagesContent` | Boolean! | Indicates the user can perform `read_pages_content` on this resource |
| `readProject` | Boolean! | Indicates the user can perform `read_project` on this resource |
| `readProjectMember` | Boolean! | Indicates the user can perform `read_project_member` on this resource |
| `readWiki` | Boolean! | Indicates the user can perform `read_wiki` on this resource |
| `removeForkProject` | Boolean! | Indicates the user can perform `remove_fork_project` on this resource |
| `removePages` | Boolean! | Indicates the user can perform `remove_pages` on this resource |
| `removeProject` | Boolean! | Indicates the user can perform `remove_project` on this resource |
| `renameProject` | Boolean! | Indicates the user can perform `rename_project` on this resource |
| `requestAccess` | Boolean! | Indicates the user can perform `request_access` on this resource |
1947 1948
| `updatePages` | Boolean! | Indicates the user can perform `update_pages` on this resource |
| `updateWiki` | Boolean! | Indicates the user can perform `update_wiki` on this resource |
1949
| `uploadFile` | Boolean! | Indicates the user can perform `upload_file` on this resource |
Felipe Artur's avatar
Felipe Artur committed
1950

1951
### ProjectStatistics
Felipe Artur's avatar
Felipe Artur committed
1952

1953 1954
| Field | Type | Description |
| ----- | ---- | ----------- |
Matthias van de Meent's avatar
Matthias van de Meent committed
1955 1956 1957 1958 1959
| `buildArtifactsSize` | Float! | Build artifacts size of the project |
| `commitCount` | Float! | Commit count of the project |
| `lfsObjectsSize` | Float! | Large File Storage (LFS) object size of the project |
| `packagesSize` | Float! | Packages size of the project |
| `repositorySize` | Float! | Repository size of the project |
1960
| `snippetsSize` | Float | Snippets size of the project |
Matthias van de Meent's avatar
Matthias van de Meent committed
1961 1962
| `storageSize` | Float! | Storage size of the project |
| `wikiSize` | Float | Wiki size of the project |
Felipe Artur's avatar
Felipe Artur committed
1963

1964
### PrometheusAlert
1965

1966
The alert condition for Prometheus.
1967

1968 1969
| Field | Type | Description |
| ----- | ---- | ----------- |
1970 1971 1972
| `humanizedText` | String! | The human-readable text of the alert condition |
| `id` | ID! | ID of the alert condition |

1973
### Release
1974

1975
Represents a release.
1976

1977 1978
| Field | Type | Description |
| ----- | ---- | ----------- |
1979
| `assets` | ReleaseAssets | Assets of the release |
1980 1981 1982 1983 1984
| `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` |
1985
| `links` | ReleaseLinks | Links of the release |
1986 1987
| `name` | String | Name of the release |
| `releasedAt` | Time | Timestamp of when the release was released |
1988
| `tagName` | String | Name of the tag associated with the release |
1989
| `tagPath` | String | Relative web path to the tag associated with the release |
1990
| `upcomingRelease` | Boolean | Indicates the release is an upcoming release |
1991

1992
### ReleaseAssetLink
1993

1994
Represents an asset link associated with a release.
1995

1996 1997
| Field | Type | Description |
| ----- | ---- | ----------- |
1998
| `directAssetUrl` | String | Direct asset URL of the link |
1999 2000 2001 2002 2003 2004
| `external` | Boolean | Indicates the link points to an external resource |
| `id` | ID! | ID of the link |
| `linkType` | ReleaseAssetLinkType | Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other` |
| `name` | String | Name of the link |
| `url` | String | URL of the link |

2005
### ReleaseAssets
2006

2007
A container for all assets associated with a release.
2008

2009 2010
| Field | Type | Description |
| ----- | ---- | ----------- |
2011
| `count` | Int | Number of assets of the release |
2012

2013
### ReleaseEvidence
2014

2015
Evidence for a release.
2016

2017 2018
| Field | Type | Description |
| ----- | ---- | ----------- |
2019 2020 2021 2022 2023
| `collectedAt` | Time | Timestamp when the evidence was collected |
| `filepath` | String | URL from where the evidence can be downloaded |
| `id` | ID! | ID of the evidence |
| `sha` | String | SHA1 ID of the evidence hash |

2024
### ReleaseLinks
2025

2026 2027
| Field | Type | Description |
| ----- | ---- | ----------- |
2028 2029 2030 2031 2032
| `editUrl` | String | HTTP URL of the release's edit page |
| `issuesUrl` | String | HTTP URL of the issues page filtered by this release |
| `mergeRequestsUrl` | String | HTTP URL of the merge request page filtered by this release |
| `selfUrl` | String | HTTP URL of the release |

2033
### ReleaseSource
2034

2035
Represents the source code attached to a release in a particular format.
2036

2037 2038
| Field | Type | Description |
| ----- | ---- | ----------- |
2039 2040 2041
| `format` | String | Format of the source |
| `url` | String | Download URL of the source |

2042
### RemoveAwardEmojiPayload
2043

2044
Autogenerated return type of RemoveAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
2045

2046 2047
| Field | Type | Description |
| ----- | ---- | ----------- |
2048
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
Felipe Artur's avatar
Felipe Artur committed
2049
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2050
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
2051

2052
### RemoveProjectFromSecurityDashboardPayload
2053

2054
Autogenerated return type of RemoveProjectFromSecurityDashboard.
2055

2056 2057
| Field | Type | Description |
| ----- | ---- | ----------- |
2058
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2059
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
2060

2061
### Repository
Felipe Artur's avatar
Felipe Artur committed
2062

2063 2064
| Field | Type | Description |
| ----- | ---- | ----------- |
2065 2066
| `empty` | Boolean! | Indicates repository has no visible content |
| `exists` | Boolean! | Indicates a corresponding Git repository exists on disk |
2067
| `rootRef` | String | Default branch of the repository |
2068
| `tree` | Tree | Tree of the repository |
Felipe Artur's avatar
Felipe Artur committed
2069

2070
### Requirement
Jan Provaznik's avatar
Jan Provaznik committed
2071

2072
Represents a requirement.
Jan Provaznik's avatar
Jan Provaznik committed
2073

2074 2075
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
2076 2077 2078 2079
| `author` | User! | Author of the requirement |
| `createdAt` | Time! | Timestamp of when the requirement was created |
| `id` | ID! | ID of the requirement |
| `iid` | ID! | Internal ID of the requirement |
2080
| `lastTestReportState` | TestReportState | Latest requirement test report state |
Jan Provaznik's avatar
Jan Provaznik committed
2081 2082 2083 2084 2085 2086
| `project` | Project! | Project to which the requirement belongs |
| `state` | RequirementState! | State of the requirement |
| `title` | String | Title of the requirement |
| `updatedAt` | Time! | Timestamp of when the requirement was last updated |
| `userPermissions` | RequirementPermissions! | Permissions for the current user on the resource |

2087
### RequirementPermissions
Jan Provaznik's avatar
Jan Provaznik committed
2088

2089
Check permissions for the current user on a requirement.
Jan Provaznik's avatar
Jan Provaznik committed
2090

2091 2092
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
2093 2094 2095 2096 2097 2098
| `adminRequirement` | Boolean! | Indicates the user can perform `admin_requirement` on this resource |
| `createRequirement` | Boolean! | Indicates the user can perform `create_requirement` on this resource |
| `destroyRequirement` | Boolean! | Indicates the user can perform `destroy_requirement` on this resource |
| `readRequirement` | Boolean! | Indicates the user can perform `read_requirement` on this resource |
| `updateRequirement` | Boolean! | Indicates the user can perform `update_requirement` on this resource |

2099
### RequirementStatesCount
2100 2101 2102

Counts of requirements by their state.

2103 2104
| Field | Type | Description |
| ----- | ---- | ----------- |
2105 2106 2107
| `archived` | Int | Number of archived requirements |
| `opened` | Int | Number of opened requirements |

2108
### RootStorageStatistics
2109

2110 2111
| Field | Type | Description |
| ----- | ---- | ----------- |
Matthias van de Meent's avatar
Matthias van de Meent committed
2112 2113 2114 2115
| `buildArtifactsSize` | Float! | The CI artifacts size in bytes |
| `lfsObjectsSize` | Float! | The LFS objects size in bytes |
| `packagesSize` | Float! | The packages size in bytes |
| `repositorySize` | Float! | The Git repository size in bytes |
2116
| `snippetsSize` | Float! | The snippets size in bytes |
Matthias van de Meent's avatar
Matthias van de Meent committed
2117 2118
| `storageSize` | Float! | The total storage in bytes |
| `wikiSize` | Float! | The wiki size in bytes |
2119

2120
### RunDASTScanPayload
2121

2122
Autogenerated return type of RunDASTScan.
2123

2124 2125
| Field | Type | Description |
| ----- | ---- | ----------- |
2126 2127 2128 2129
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `pipelineUrl` | String | URL of the pipeline that was created. |

2130
### SastCiConfigurationAnalyzersEntity
2131

2132
Represents an analyzer entity in SAST CI configuration.
2133

2134 2135
| Field | Type | Description |
| ----- | ---- | ----------- |
2136 2137 2138 2139
| `description` | String | Analyzer description that is displayed on the form |
| `enabled` | Boolean | Indicates whether an analyzer is enabled |
| `label` | String | Analyzer label used in the config UI |
| `name` | String | Name of the analyzer |
2140

2141
### SastCiConfigurationEntity
2142

2143
Represents an entity in SAST CI configuration.
2144

2145 2146
| Field | Type | Description |
| ----- | ---- | ----------- |
2147 2148 2149 2150
| `defaultValue` | String | Default value that is used if value is empty. |
| `description` | String | Entity description that is displayed on the form. |
| `field` | String | CI keyword of entity. |
| `label` | String | Label for entity used in the form. |
2151
| `size` | SastUiComponentSize | Size of the UI component. |
2152 2153 2154
| `type` | String | Type of the field value. |
| `value` | String | Current value of the entity. |

2155
### SastCiConfigurationOptionsEntity
2156

2157
Represents an entity for options in SAST CI configuration.
2158

2159 2160
| Field | Type | Description |
| ----- | ---- | ----------- |
2161 2162 2163
| `label` | String | Label of option entity. |
| `value` | String | Value of option entity. |

2164
### ScannedResource
2165

2166
Represents a resource scanned by a security scan.
2167

2168 2169
| Field | Type | Description |
| ----- | ---- | ----------- |
2170 2171 2172
| `requestMethod` | String | The HTTP request method used to access the URL |
| `url` | String | The URL scanned by the scanner |

2173
### SecurityReportSummary
2174

2175
Represents summary of a security report.
2176

2177 2178
| Field | Type | Description |
| ----- | ---- | ----------- |
2179
| `containerScanning` | SecurityReportSummarySection | Aggregated counts for the container_scanning scan |
2180
| `coverageFuzzing` | SecurityReportSummarySection | Aggregated counts for the coverage_fuzzing scan |
2181 2182 2183 2184 2185
| `dast` | SecurityReportSummarySection | Aggregated counts for the dast scan |
| `dependencyScanning` | SecurityReportSummarySection | Aggregated counts for the dependency_scanning scan |
| `sast` | SecurityReportSummarySection | Aggregated counts for the sast scan |
| `secretDetection` | SecurityReportSummarySection | Aggregated counts for the secret_detection scan |

2186
### SecurityReportSummarySection
2187

2188
Represents a section of a summary of a security report.
2189

2190 2191
| Field | Type | Description |
| ----- | ---- | ----------- |
2192
| `scannedResourcesCount` | Int | Total number of scanned resources |
2193
| `scannedResourcesCsvPath` | String | Path to download all the scanned resources in CSV format |
2194 2195
| `vulnerabilitiesCount` | Int | Total number of vulnerabilities |

2196
### SecurityScanners
2197

2198
Represents a list of security scanners.
2199

2200 2201
| Field | Type | Description |
| ----- | ---- | ----------- |
2202 2203 2204 2205
| `available` | SecurityScannerType! => Array | List of analyzers which are available for the project. |
| `enabled` | SecurityScannerType! => Array | List of analyzers which are enabled for the project. |
| `pipelineRun` | SecurityScannerType! => Array | List of analyzers which ran successfully in the latest pipeline. |

2206
### SentryDetailedError
2207

Sean Arnold's avatar
Sean Arnold committed
2208 2209
A Sentry error.

2210 2211
| Field | Type | Description |
| ----- | ---- | ----------- |
2212
| `count` | Int! | Count of occurrences |
2213
| `culprit` | String! | Culprit of the error |
2214
| `externalBaseUrl` | String! | External Base URL of the Sentry Instance |
2215 2216
| `externalUrl` | String! | External URL of the error |
| `firstReleaseLastCommit` | String | Commit the error was first seen |
2217 2218
| `firstReleaseShortVersion` | String | Release short version the error was first seen |
| `firstReleaseVersion` | String | Release version the error was first seen |
2219
| `firstSeen` | Time! | Timestamp when the error was first seen |
2220 2221 2222
| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error |
| `gitlabCommit` | String | GitLab commit SHA attributed to the Error based on the release version |
| `gitlabCommitPath` | String | Path to the GitLab page for the GitLab commit attributed to the error |
2223
| `gitlabIssuePath` | String | URL of GitLab Issue |
2224 2225
| `id` | ID! | ID (global ID) of the error |
| `lastReleaseLastCommit` | String | Commit the error was last seen |
2226 2227
| `lastReleaseShortVersion` | String | Release short version the error was last seen |
| `lastReleaseVersion` | String | Release version the error was last seen |
2228 2229
| `lastSeen` | Time! | Timestamp when the error was last seen |
| `message` | String | Sentry metadata message of the error |
2230
| `sentryId` | String! | ID (Sentry ID) of the error |
2231 2232 2233 2234 2235
| `sentryProjectId` | ID! | ID of the project (Sentry project) |
| `sentryProjectName` | String! | Name of the project affected by the error |
| `sentryProjectSlug` | String! | Slug of the project affected by the error |
| `shortId` | String! | Short ID (Sentry ID) of the error |
| `status` | SentryErrorStatus! | Status of the error |
2236
| `tags` | SentryErrorTags! | Tags associated with the Sentry Error |
2237 2238 2239
| `title` | String! | Title of the error |
| `type` | String! | Type of the error |
| `userCount` | Int! | Count of users affected by the error |
2240

2241
### SentryError
Sean Arnold's avatar
Sean Arnold committed
2242 2243 2244

A Sentry error. A simplified version of SentryDetailedError.

2245 2246
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
| `count` | Int! | Count of occurrences |
| `culprit` | String! | Culprit of the error |
| `externalUrl` | String! | External URL of the error |
| `firstSeen` | Time! | Timestamp when the error was first seen |
| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error |
| `id` | ID! | ID (global ID) of the error |
| `lastSeen` | Time! | Timestamp when the error was last seen |
| `message` | String | Sentry metadata message of the error |
| `sentryId` | String! | ID (Sentry ID) of the error |
| `sentryProjectId` | ID! | ID of the project (Sentry project) |
| `sentryProjectName` | String! | Name of the project affected by the error |
| `sentryProjectSlug` | String! | Slug of the project affected by the error |
| `shortId` | String! | Short ID (Sentry ID) of the error |
| `status` | SentryErrorStatus! | Status of the error |
| `title` | String! | Title of the error |
| `type` | String! | Type of the error |
| `userCount` | Int! | Count of users affected by the error |

2265
### SentryErrorCollection
Sean Arnold's avatar
Sean Arnold committed
2266 2267 2268

An object containing a collection of Sentry errors, and a detailed error.

2269 2270
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
2271
| `detailedError` | SentryDetailedError | Detailed version of a Sentry error on the project |
Sean Arnold's avatar
Sean Arnold committed
2272
| `errorStackTrace` | SentryErrorStackTrace | Stack Trace of Sentry Error |
Sean Arnold's avatar
Sean Arnold committed
2273 2274 2275
| `errors` | SentryErrorConnection | Collection of Sentry Errors |
| `externalUrl` | String | External URL for Sentry |

2276
### SentryErrorFrequency
2277

2278 2279
| Field | Type | Description |
| ----- | ---- | ----------- |
2280
| `count` | Int! | Count of errors received since the previously recorded time |
2281
| `time` | Time! | Time the error frequency stats were recorded |
2282

2283
### SentryErrorStackTrace
Sean Arnold's avatar
Sean Arnold committed
2284 2285 2286

An object containing a stack trace entry for a Sentry error.

2287 2288
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
2289 2290 2291 2292
| `dateReceived` | String! | Time the stack trace was received by Sentry |
| `issueId` | String! | ID of the Sentry error |
| `stackTraceEntries` | SentryErrorStackTraceEntry! => Array | Stack trace entries for the Sentry error |

2293
### SentryErrorStackTraceContext
Sean Arnold's avatar
Sean Arnold committed
2294

2295
An object context for a Sentry error stack trace.
Sean Arnold's avatar
Sean Arnold committed
2296

2297 2298
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
2299 2300 2301
| `code` | String! | Code number of the context |
| `line` | Int! | Line number of the context |

2302
### SentryErrorStackTraceEntry
Sean Arnold's avatar
Sean Arnold committed
2303 2304 2305

An object containing a stack trace entry for a Sentry error.

2306 2307
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
2308 2309 2310 2311 2312 2313
| `col` | String | Function in which the Sentry error occurred |
| `fileName` | String | File in which the Sentry error occurred |
| `function` | String | Function in which the Sentry error occurred |
| `line` | String | Function in which the Sentry error occurred |
| `traceContext` | SentryErrorStackTraceContext! => Array | Context of the Sentry error |

2314
### SentryErrorTags
2315

2316
State of a Sentry error.
2317

2318 2319
| Field | Type | Description |
| ----- | ---- | ----------- |
2320 2321 2322
| `level` | String | Severity level of the Sentry Error |
| `logger` | String | Logger of the Sentry Error |

2323
### Snippet
2324

2325
Represents a snippet entry.
2326

2327 2328
| Field | Type | Description |
| ----- | ---- | ----------- |
2329
| `author` | User | The owner of the snippet |
2330
| `blob` **{warning-solid}** | SnippetBlob! | **Deprecated:** Use `blobs`. Deprecated in 13.3 |
2331
| `createdAt` | Time! | Timestamp this snippet was created |
2332 2333 2334
| `description` | String | Description of the snippet |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `fileName` | String | File Name of the snippet |
2335
| `httpUrlToRepo` | String | HTTP URL to the snippet repository |
2336
| `id` | ID! | ID of the snippet |
2337 2338
| `project` | Project | The project the snippet is associated with |
| `rawUrl` | String! | Raw URL of the snippet |
2339
| `sshUrlToRepo` | String | SSH URL to the snippet repository |
2340
| `title` | String! | Title of the snippet |
2341
| `updatedAt` | Time! | Timestamp this snippet was updated |
2342 2343
| `userPermissions` | SnippetPermissions! | Permissions for the current user on the resource |
| `visibilityLevel` | VisibilityLevelsEnum! | Visibility Level of the snippet |
2344 2345
| `webUrl` | String! | Web URL of the snippet |

2346
### SnippetBlob
2347

2348
Represents the snippet blob.
2349

2350 2351
| Field | Type | Description |
| ----- | ---- | ----------- |
2352
| `binary` | Boolean! | Shows whether the blob is binary |
2353
| `externalStorage` | String | Blob external storage |
2354
| `mode` | String | Blob mode |
2355 2356
| `name` | String | Blob name |
| `path` | String | Blob path |
2357
| `plainData` | String | Blob plain highlighted data |
2358
| `rawPath` | String! | Blob raw content endpoint path |
2359
| `renderedAsText` | Boolean! | Shows whether the blob is rendered as text |
2360
| `richData` | String | Blob highlighted data |
2361
| `richViewer` | SnippetBlobViewer | Blob content rich viewer |
2362 2363
| `simpleViewer` | SnippetBlobViewer! | Blob content simple viewer |
| `size` | Int! | Blob size |
2364

2365
### SnippetBlobViewer
2366

2367
Represents how the blob content should be displayed.
2368

2369 2370
| Field | Type | Description |
| ----- | ---- | ----------- |
2371 2372
| `collapsed` | Boolean! | Shows whether the blob should be displayed collapsed |
| `fileType` | String! | Content file type |
2373
| `loadAsync` | Boolean! | Shows whether the blob content is loaded async |
2374
| `loadingPartialName` | String! | Loading partial name |
2375 2376 2377
| `renderError` | String | Error rendering the blob content |
| `tooLarge` | Boolean! | Shows whether the blob too large to be displayed |
| `type` | BlobViewersType! | Type of blob viewer |
2378

2379
### SnippetPermissions
2380

2381 2382
| Field | Type | Description |
| ----- | ---- | ----------- |
2383
| `adminSnippet` | Boolean! | Indicates the user can perform `admin_snippet` on this resource |
2384
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
2385
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
2386 2387
| `readSnippet` | Boolean! | Indicates the user can perform `read_snippet` on this resource |
| `reportSnippet` | Boolean! | Indicates the user can perform `report_snippet` on this resource |
2388
| `updateSnippet` | Boolean! | Indicates the user can perform `update_snippet` on this resource |
2389

2390
### Submodule
Felipe Artur's avatar
Felipe Artur committed
2391

2392 2393
| Field | Type | Description |
| ----- | ---- | ----------- |
2394
| `flatPath` | String! | Flat path of the entry |
2395 2396 2397
| `id` | ID! | ID of the entry |
| `name` | String! | Name of the entry |
| `path` | String! | Path of the entry |
2398
| `sha` | String! | Last commit sha for the entry |
2399
| `treeUrl` | String | Tree URL for the sub-module |
2400 2401
| `type` | EntryType! | Type of tree entry |
| `webUrl` | String | Web URL for the sub-module |
Felipe Artur's avatar
Felipe Artur committed
2402

2403
### TaskCompletionStatus
2404

2405
Completion status of tasks.
Felipe Artur's avatar
Felipe Artur committed
2406

2407 2408
| Field | Type | Description |
| ----- | ---- | ----------- |
2409
| `completedCount` | Int! | Number of completed tasks |
2410
| `count` | Int! | Number of total tasks |
Felipe Artur's avatar
Felipe Artur committed
2411

2412
### TerraformStateRegistry
2413

2414
Represents the Geo sync and verification state of a terraform state.
2415

2416 2417
| Field | Type | Description |
| ----- | ---- | ----------- |
2418 2419 2420 2421 2422 2423 2424 2425 2426
| `createdAt` | Time | Timestamp when the TerraformStateRegistry was created |
| `id` | ID! | ID of the TerraformStateRegistry |
| `lastSyncFailure` | String | Error message during sync of the TerraformStateRegistry |
| `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the TerraformStateRegistry |
| `retryAt` | Time | Timestamp after which the TerraformStateRegistry should be resynced |
| `retryCount` | Int | Number of consecutive failed sync attempts of the TerraformStateRegistry |
| `state` | RegistryState | Sync state of the TerraformStateRegistry |
| `terraformStateId` | ID! | ID of the TerraformState |

2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
### TerraformStateVersionRegistry

Represents the Geo sync and verification state of a terraform state version.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time | Timestamp when the TerraformStateVersionRegistry was created |
| `id` | ID! | ID of the TerraformStateVersionRegistry |
| `lastSyncFailure` | String | Error message during sync of the TerraformStateVersionRegistry |
| `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the TerraformStateVersionRegistry |
| `retryAt` | Time | Timestamp after which the TerraformStateVersionRegistry should be resynced |
| `retryCount` | Int | Number of consecutive failed sync attempts of the TerraformStateVersionRegistry |
| `state` | RegistryState | Sync state of the TerraformStateVersionRegistry |
| `terraformStateVersionId` | ID! | ID of the terraform state version |

2442
### TestReport
2443 2444 2445

Represents a requirement test report.

2446 2447
| Field | Type | Description |
| ----- | ---- | ----------- |
2448 2449 2450 2451 2452
| `author` | User | Author of the test report |
| `createdAt` | Time! | Timestamp of when the test report was created |
| `id` | ID! | ID of the test report |
| `state` | TestReportState! | State of the test report |

2453
### Timelog
2454

2455 2456
| Field | Type | Description |
| ----- | ---- | ----------- |
2457
| `date` **{warning-solid}** | Time! | **Deprecated:** Use `spentAt`. Deprecated in 12.10 |
2458
| `issue` | Issue | The issue that logged time was added to |
2459
| `note` | Note | The note where the quick action to add the logged time was executed |
2460
| `spentAt` | Time | Timestamp of when the time tracked was spent at |
2461 2462 2463
| `timeSpent` | Int! | The time spent displayed in seconds |
| `user` | User! | The user that logged the time |

2464
### Todo
2465

2466
Representing a todo entry.
2467

2468 2469
| Field | Type | Description |
| ----- | ---- | ----------- |
2470
| `action` | TodoActionEnum! | Action of the todo |
2471
| `author` | User! | The author of this todo |
2472 2473
| `body` | String! | Body of the todo |
| `createdAt` | Time! | Timestamp this todo was created |
2474
| `group` | Group | Group this todo is associated with |
2475
| `id` | ID! | ID of the todo |
2476 2477 2478
| `project` | Project | The project this todo is associated with |
| `state` | TodoStateEnum! | State of the todo |
| `targetType` | TodoTargetEnum! | Target type of the todo |
2479

2480
### TodoMarkDonePayload
2481

2482
Autogenerated return type of TodoMarkDone.
2483

2484 2485
| Field | Type | Description |
| ----- | ---- | ----------- |
2486
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2487
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2488 2489
| `todo` | Todo! | The requested todo |

2490
### TodoRestoreManyPayload
2491

2492
Autogenerated return type of TodoRestoreMany.
2493

2494 2495
| Field | Type | Description |
| ----- | ---- | ----------- |
2496
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2497
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2498 2499
| `todos` | Todo! => Array | Updated todos |
| `updatedIds` **{warning-solid}** | ID! => Array | **Deprecated:** Use todos. Deprecated in 13.2 |
2500

2501
### TodoRestorePayload
2502

2503
Autogenerated return type of TodoRestore.
2504

2505 2506
| Field | Type | Description |
| ----- | ---- | ----------- |
2507
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2508
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2509 2510
| `todo` | Todo! | The requested todo |

2511
### TodosMarkAllDonePayload
2512

2513
Autogenerated return type of TodosMarkAllDone.
2514

2515 2516
| Field | Type | Description |
| ----- | ---- | ----------- |
2517
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2518
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2519 2520
| `todos` | Todo! => Array | Updated todos |
| `updatedIds` **{warning-solid}** | ID! => Array | **Deprecated:** Use todos. Deprecated in 13.2 |
2521

2522
### ToggleAwardEmojiPayload
2523

2524
Autogenerated return type of ToggleAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
2525

2526 2527
| Field | Type | Description |
| ----- | ---- | ----------- |
2528
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
Felipe Artur's avatar
Felipe Artur committed
2529
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2530
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2531
| `toggledOn` | Boolean! | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. |
Felipe Artur's avatar
Felipe Artur committed
2532

2533
### Tree
Felipe Artur's avatar
Felipe Artur committed
2534

2535 2536
| Field | Type | Description |
| ----- | ---- | ----------- |
2537
| `lastCommit` | Commit | Last commit for the tree |
Felipe Artur's avatar
Felipe Artur committed
2538

2539
### TreeEntry
2540

2541
Represents a directory.
Felipe Artur's avatar
Felipe Artur committed
2542

2543 2544
| Field | Type | Description |
| ----- | ---- | ----------- |
2545
| `flatPath` | String! | Flat path of the entry |
2546 2547 2548
| `id` | ID! | ID of the entry |
| `name` | String! | Name of the entry |
| `path` | String! | Path of the entry |
2549 2550
| `sha` | String! | Last commit sha for the entry |
| `type` | EntryType! | Type of tree entry |
2551
| `webPath` | String | Web path for the tree entry (directory) |
2552
| `webUrl` | String | Web URL for the tree entry (directory) |
Felipe Artur's avatar
Felipe Artur committed
2553

2554
### UpdateAlertStatusPayload
Sean Arnold's avatar
Sean Arnold committed
2555

2556
Autogenerated return type of UpdateAlertStatus.
Sean Arnold's avatar
Sean Arnold committed
2557

2558 2559
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
2560 2561
| `alert` | AlertManagementAlert | The alert after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2562
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2563
| `issue` | Issue | The issue created after mutation |
Allison Browne's avatar
Allison Browne committed
2564
| `todo` | Todo | The todo after mutation |
Sean Arnold's avatar
Sean Arnold committed
2565

2566
### UpdateBoardListPayload
2567

2568
Autogenerated return type of UpdateBoardList.
2569

2570 2571
| Field | Type | Description |
| ----- | ---- | ----------- |
2572 2573 2574 2575
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `list` | BoardList | Mutated list |

2576
### UpdateBoardPayload
2577

2578
Autogenerated return type of UpdateBoard.
2579

2580 2581
| Field | Type | Description |
| ----- | ---- | ----------- |
2582 2583 2584 2585
| `board` | Board | The board after mutation. |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

2586
### UpdateContainerExpirationPolicyPayload
2587

2588
Autogenerated return type of UpdateContainerExpirationPolicy.
2589

2590 2591
| Field | Type | Description |
| ----- | ---- | ----------- |
2592 2593 2594 2595
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

2596
### UpdateEpicPayload
2597

2598
Autogenerated return type of UpdateEpic.
2599

2600 2601
| Field | Type | Description |
| ----- | ---- | ----------- |
2602 2603
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
2604
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2605

2606
### UpdateImageDiffNotePayload
2607

2608
Autogenerated return type of UpdateImageDiffNote.
2609

2610 2611
| Field | Type | Description |
| ----- | ---- | ----------- |
2612
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2613
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2614 2615
| `note` | Note | The note after mutation |

2616
### UpdateIssuePayload
2617

2618
Autogenerated return type of UpdateIssue.
2619

2620 2621
| Field | Type | Description |
| ----- | ---- | ----------- |
2622
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2623
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2624 2625
| `issue` | Issue | The issue after mutation |

2626
### UpdateIterationPayload
2627

2628
Autogenerated return type of UpdateIteration.
2629

2630 2631
| Field | Type | Description |
| ----- | ---- | ----------- |
2632 2633 2634 2635
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `iteration` | Iteration | The updated iteration |

2636
### UpdateNotePayload
2637

2638
Autogenerated return type of UpdateNote.
2639

2640 2641
| Field | Type | Description |
| ----- | ---- | ----------- |
2642
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2643
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2644 2645
| `note` | Note | The note after mutation |

2646
### UpdateRequirementPayload
2647

2648
Autogenerated return type of UpdateRequirement.
2649

2650 2651
| Field | Type | Description |
| ----- | ---- | ----------- |
2652
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2653
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2654 2655
| `requirement` | Requirement | The requirement after mutation |

2656
### UpdateSnippetPayload
2657

2658
Autogenerated return type of UpdateSnippet.
2659

2660 2661
| Field | Type | Description |
| ----- | ---- | ----------- |
2662
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2663
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2664 2665
| `snippet` | Snippet | The snippet after mutation |

2666
### User
Felipe Artur's avatar
Felipe Artur committed
2667

2668 2669
| Field | Type | Description |
| ----- | ---- | ----------- |
2670
| `avatarUrl` | String | URL of the user's avatar |
lauraMon's avatar
lauraMon committed
2671
| `email` | String | User email |
2672
| `id` | ID! | ID of the user |
2673
| `name` | String! | Human-readable name of the user |
2674
| `state` | UserState! | State of the user |
lauraMon's avatar
lauraMon committed
2675
| `status` | UserStatus | User status |
2676
| `userPermissions` | UserPermissions! | Permissions for the current user on the resource |
2677
| `username` | String! | Username of the user. Unique within this instance of GitLab |
2678
| `webPath` | String! | Web path of the user |
2679
| `webUrl` | String! | Web URL of the user |
2680

2681
### UserPermissions
2682

2683 2684
| Field | Type | Description |
| ----- | ---- | ----------- |
2685
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
2686

2687
### UserStatus
lauraMon's avatar
lauraMon committed
2688

2689 2690
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
2691 2692
| `emoji` | String | String representation of emoji |
| `message` | String | User status message |
lauraMon's avatar
lauraMon committed
2693 2694
| `messageHtml` | String | HTML of the user status message |

2695
### VulnerabilitiesCountByDay
2696

2697
Represents the count of vulnerabilities by severity on a particular day.
2698

2699 2700
| Field | Type | Description |
| ----- | ---- | ----------- |
2701 2702 2703 2704 2705 2706 2707 2708 2709
| `critical` | Int! | Total number of vulnerabilities on a particular day with critical severity |
| `date` | ISO8601Date! | Date for the count |
| `high` | Int! | Total number of vulnerabilities on a particular day with high severity |
| `info` | Int! | Total number of vulnerabilities on a particular day with info severity |
| `low` | Int! | Total number of vulnerabilities on a particular day with low severity |
| `medium` | Int! | Total number of vulnerabilities on a particular day with medium severity |
| `total` | Int! | Total number of vulnerabilities on a particular day |
| `unknown` | Int! | Total number of vulnerabilities on a particular day with unknown severity |

2710
### VulnerabilitiesCountByDayAndSeverity
2711

2712
Represents the number of vulnerabilities for a particular severity on a particular day.
2713

2714 2715
| Field | Type | Description |
| ----- | ---- | ----------- |
2716 2717 2718 2719
| `count` | Int | Number of vulnerabilities |
| `day` | ISO8601Date | Date for the count |
| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities |

2720
### Vulnerability
2721 2722 2723

Represents a vulnerability.

2724 2725
| Field | Type | Description |
| ----- | ---- | ----------- |
2726
| `description` | String | Description of the vulnerability |
2727
| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected |
2728
| `id` | ID! | GraphQL ID of the vulnerability |
2729
| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerability. |
2730
| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability |
2731
| `primaryIdentifier` | VulnerabilityIdentifier | Primary identifier of the vulnerability. |
2732
| `project` | Project | The project on which the vulnerability was found |
2733
| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING) |
2734
| `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not |
2735
| `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. |
2736 2737 2738
| `severity` | VulnerabilitySeverity | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL) |
| `state` | VulnerabilityState | State of the vulnerability (DETECTED, DISMISSED, RESOLVED, CONFIRMED) |
| `title` | String | Title of the vulnerability |
2739
| `userNotesCount` | Int! | Number of user notes attached to the vulnerability |
2740
| `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource |
2741
| `vulnerabilityPath` | String | URL to the vulnerability's details page |
Avielle Wolfe's avatar
Avielle Wolfe committed
2742

2743 2744 2745 2746 2747 2748 2749 2750 2751 2752
### VulnerabilityConfirmPayload

Autogenerated return type of VulnerabilityConfirm.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after state change |

2753 2754 2755 2756 2757 2758 2759 2760 2761 2762
### VulnerabilityDismissPayload

Autogenerated return type of VulnerabilityDismiss.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after dismissal |

2763
### VulnerabilityIdentifier
2764 2765 2766

Represents a vulnerability identifier.

2767 2768
| Field | Type | Description |
| ----- | ---- | ----------- |
2769 2770 2771 2772 2773
| `externalId` | String | External ID of the vulnerability identifier |
| `externalType` | String | External type of the vulnerability identifier |
| `name` | String | Name of the vulnerability identifier |
| `url` | String | URL of the vulnerability identifier |

2774
### VulnerabilityIssueLink
2775 2776 2777

Represents an issue link of a vulnerability.

2778 2779
| Field | Type | Description |
| ----- | ---- | ----------- |
2780 2781 2782 2783
| `id` | ID! | GraphQL ID of the vulnerability |
| `issue` | Issue! | The issue attached to issue link |
| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link |

2784
### VulnerabilityLocationContainerScanning
2785

2786
Represents the location of a vulnerability found by a container security scan.
2787

2788 2789
| Field | Type | Description |
| ----- | ---- | ----------- |
2790 2791 2792 2793
| `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 |

2794
### VulnerabilityLocationCoverageFuzzing
2795

2796
Represents the location of a vulnerability found by a Coverage Fuzzing scan.
2797

2798 2799
| Field | Type | Description |
| ----- | ---- | ----------- |
2800 2801 2802 2803 2804 2805
| `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 |

2806
### VulnerabilityLocationDast
2807

2808
Represents the location of a vulnerability found by a DAST scan.
2809

2810 2811
| Field | Type | Description |
| ----- | ---- | ----------- |
2812 2813 2814 2815 2816
| `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 |

2817
### VulnerabilityLocationDependencyScanning
2818

2819
Represents the location of a vulnerability found by a dependency security scan.
2820

2821 2822
| Field | Type | Description |
| ----- | ---- | ----------- |
2823 2824 2825
| `dependency` | VulnerableDependency | Dependency containing the vulnerability |
| `file` | String | Path to the vulnerable file |

2826
### VulnerabilityLocationSast
2827

2828
Represents the location of a vulnerability found by a SAST scan.
2829

2830 2831
| Field | Type | Description |
| ----- | ---- | ----------- |
2832 2833 2834 2835 2836 2837
| `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 |

2838
### VulnerabilityLocationSecretDetection
2839

2840
Represents the location of a vulnerability found by a secret detection scan.
2841

2842 2843
| Field | Type | Description |
| ----- | ---- | ----------- |
2844 2845 2846 2847 2848 2849
| `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 |

2850
### VulnerabilityPermissions
2851

2852
Check permissions for the current user on a vulnerability.
2853

2854 2855
| Field | Type | Description |
| ----- | ---- | ----------- |
2856 2857 2858 2859 2860 2861 2862 2863 2864
| `adminVulnerability` | Boolean! | Indicates the user can perform `admin_vulnerability` on this resource |
| `adminVulnerabilityIssueLink` | Boolean! | Indicates the user can perform `admin_vulnerability_issue_link` on this resource |
| `createVulnerability` | Boolean! | Indicates the user can perform `create_vulnerability` on this resource |
| `createVulnerabilityExport` | Boolean! | Indicates the user can perform `create_vulnerability_export` on this resource |
| `createVulnerabilityFeedback` | Boolean! | Indicates the user can perform `create_vulnerability_feedback` on this resource |
| `destroyVulnerabilityFeedback` | Boolean! | Indicates the user can perform `destroy_vulnerability_feedback` on this resource |
| `readVulnerabilityFeedback` | Boolean! | Indicates the user can perform `read_vulnerability_feedback` on this resource |
| `updateVulnerabilityFeedback` | Boolean! | Indicates the user can perform `update_vulnerability_feedback` on this resource |

2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
### VulnerabilityResolvePayload

Autogenerated return type of VulnerabilityResolve.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `vulnerability` | Vulnerability | The vulnerability after state change |

2875
### VulnerabilityScanner
2876 2877 2878

Represents a vulnerability scanner.

2879 2880
| Field | Type | Description |
| ----- | ---- | ----------- |
2881 2882
| `externalId` | String | External ID of the vulnerability scanner |
| `name` | String | Name of the vulnerability scanner |
2883 2884
| `reportType` | VulnerabilityReportType | Type of the vulnerability report |
| `vendor` | String | Vendor of the vulnerability scanner |
2885

2886
### VulnerabilitySeveritiesCount
Avielle Wolfe's avatar
Avielle Wolfe committed
2887

2888
Represents vulnerability counts by severity.
Avielle Wolfe's avatar
Avielle Wolfe committed
2889

2890 2891
| Field | Type | Description |
| ----- | ---- | ----------- |
Avielle Wolfe's avatar
Avielle Wolfe committed
2892 2893 2894 2895 2896 2897
| `critical` | Int | Number of vulnerabilities of CRITICAL severity of the project |
| `high` | Int | Number of vulnerabilities of HIGH severity of the project |
| `info` | Int | Number of vulnerabilities of INFO severity of the project |
| `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 |
2898

2899
### VulnerableDependency
2900

2901
Represents a vulnerable dependency. Used in vulnerability location data.
2902

2903 2904
| Field | Type | Description |
| ----- | ---- | ----------- |
2905 2906 2907
| `package` | VulnerablePackage | The package associated with the vulnerable dependency |
| `version` | String | The version of the vulnerable dependency |

2908
### VulnerablePackage
2909

2910
Represents a vulnerable package. Used in vulnerability dependency data.
2911

2912 2913
| Field | Type | Description |
| ----- | ---- | ----------- |
2914
| `name` | String | The name of the vulnerable package |
2915

2916
### VulnerableProjectsByGrade
2917

2918
Represents vulnerability letter grades with associated projects.
2919

2920 2921
| Field | Type | Description |
| ----- | ---- | ----------- |
2922 2923
| `count` | Int! | Number of projects within this grade |
| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present |
2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935

## 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

2936
Access level to a resource.
2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948

| Value | Description |
| ----- | ----------- |
| `DEVELOPER` |  |
| `GUEST` |  |
| `MAINTAINER` |  |
| `NO_ACCESS` |  |
| `OWNER` |  |
| `REPORTER` |  |

### AlertManagementAlertSort

2949
Values for sorting alerts.
2950 2951 2952

| Value | Description |
| ----- | ----------- |
2953 2954
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966
| `CREATED_TIME_ASC` | Created time by ascending order |
| `CREATED_TIME_DESC` | Created time by descending order |
| `ENDED_AT_ASC` | End time by ascending order |
| `ENDED_AT_DESC` | End time by descending order |
| `EVENT_COUNT_ASC` | Events count by ascending order |
| `EVENT_COUNT_DESC` | Events count by descending order |
| `SEVERITY_ASC` | Severity from less critical to more critical |
| `SEVERITY_DESC` | Severity from more critical to less critical |
| `STARTED_AT_ASC` | Start time by ascending order |
| `STARTED_AT_DESC` | Start time by descending order |
| `STATUS_ASC` | Status by order: Ignored > Resolved > Acknowledged > Triggered |
| `STATUS_DESC` | Status by order: Triggered > Acknowledged > Resolved > Ignored |
2967 2968
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
2969 2970 2971 2972 2973 2974 2975 2976 2977
| `UPDATED_TIME_ASC` | Created time by ascending order |
| `UPDATED_TIME_DESC` | Created time by descending order |
| `created_asc` | Created at ascending order |
| `created_desc` | Created at descending order |
| `updated_asc` | Updated at ascending order |
| `updated_desc` | Updated at descending order |

### AlertManagementSeverity

2978
Alert severity values.
2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990

| Value | Description |
| ----- | ----------- |
| `CRITICAL` | Critical severity |
| `HIGH` | High severity |
| `INFO` | Info severity |
| `LOW` | Low severity |
| `MEDIUM` | Medium severity |
| `UNKNOWN` | Unknown severity |

### AlertManagementStatus

2991
Alert status values.
2992 2993 2994 2995 2996 2997 2998 2999 3000 3001

| Value | Description |
| ----- | ----------- |
| `ACKNOWLEDGED` | Acknowledged status |
| `IGNORED` | Ignored status |
| `RESOLVED` | Resolved status |
| `TRIGGERED` | Triggered status |

### BlobViewersType

3002
Types of blob viewers.
3003 3004 3005 3006 3007 3008 3009 3010 3011

| Value | Description |
| ----- | ----------- |
| `auxiliary` |  |
| `rich` |  |
| `simple` |  |

### CommitActionMode

3012
Mode of a commit action.
3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073

| Value | Description |
| ----- | ----------- |
| `CHMOD` | Chmod command |
| `CREATE` | Create command |
| `DELETE` | Delete command |
| `MOVE` | Move command |
| `UPDATE` | Update command |

### CommitEncoding

| Value | Description |
| ----- | ----------- |
| `BASE64` | Base64 encoding |
| `TEXT` | Text encoding |

### ContainerExpirationPolicyCadenceEnum

| Value | Description |
| ----- | ----------- |
| `EVERY_DAY` | Every day |
| `EVERY_MONTH` | Every month |
| `EVERY_THREE_MONTHS` | Every three months |
| `EVERY_TWO_WEEKS` | Every two weeks |
| `EVERY_WEEK` | Every week |

### ContainerExpirationPolicyKeepEnum

| Value | Description |
| ----- | ----------- |
| `FIFTY_TAGS` | 50 tags per image name |
| `FIVE_TAGS` | 5 tags per image name |
| `ONE_HUNDRED_TAGS` | 100 tags per image name |
| `ONE_TAG` | 1 tag per image name |
| `TEN_TAGS` | 10 tags per image name |
| `TWENTY_FIVE_TAGS` | 25 tags per image name |

### ContainerExpirationPolicyOlderThanEnum

| Value | Description |
| ----- | ----------- |
| `FOURTEEN_DAYS` | 14 days until tags are automatically removed |
| `NINETY_DAYS` | 90 days until tags are automatically removed |
| `SEVEN_DAYS` | 7 days until tags are automatically removed |
| `THIRTY_DAYS` | 30 days until tags are automatically removed |

### DastScanTypeEnum

| Value | Description |
| ----- | ----------- |
| `PASSIVE` | Passive DAST scan. This scan will not make active attacks against the target site. |

### DastSiteProfileValidationStatusEnum

| Value | Description |
| ----- | ----------- |
| `FAILED_VALIDATION` | Site validation process finished but failed |
| `INPROGRESS_VALIDATION` | Site validation process is in progress |
| `PASSED_VALIDATION` | Site validation process finished successfully |
| `PENDING_VALIDATION` | Site validation process has not started |

3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
### DesignCollectionCopyState

Copy state of a DesignCollection.

| Value | Description |
| ----- | ----------- |
| `ERROR` | The DesignCollection encountered an error during a copy |
| `IN_PROGRESS` | The DesignCollection is being copied |
| `READY` | The DesignCollection has no copy in progress |

3084 3085
### DesignVersionEvent

3086
Mutation event of a design within a version.
3087 3088 3089 3090 3091 3092 3093 3094 3095 3096

| Value | Description |
| ----- | ----------- |
| `CREATION` | A creation event |
| `DELETION` | A deletion event |
| `MODIFICATION` | A modification event |
| `NONE` | No change |

### DiffPositionType

3097
Type of file the position refers to.
3098 3099 3100 3101 3102 3103 3104 3105

| Value | Description |
| ----- | ----------- |
| `image` |  |
| `text` |  |

### EntryType

3106
Type of a tree entry.
3107 3108 3109 3110 3111 3112 3113 3114 3115

| Value | Description |
| ----- | ----------- |
| `blob` |  |
| `commit` |  |
| `tree` |  |

### EpicSort

3116
Roadmap sort values.
3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136

| Value | Description |
| ----- | ----------- |
| `end_date_asc` | End date at ascending order |
| `end_date_desc` | End date at descending order |
| `start_date_asc` | Start date at ascending order |
| `start_date_desc` | Start date at descending order |

### EpicState

State of an epic.

| Value | Description |
| ----- | ----------- |
| `all` |  |
| `closed` |  |
| `opened` |  |

### EpicStateEvent

3137
State event of an epic.
3138 3139 3140 3141 3142 3143 3144 3145

| Value | Description |
| ----- | ----------- |
| `CLOSE` | Close the epic |
| `REOPEN` | Reopen the epic |

### EpicWildcardId

3146
Epic ID wildcard values.
3147 3148 3149 3150 3151 3152 3153 3154

| Value | Description |
| ----- | ----------- |
| `ANY` | Any epic is assigned |
| `NONE` | No epic is assigned |

### HealthStatus

3155
Health status of an issue or epic.
3156 3157 3158 3159 3160 3161 3162 3163 3164

| Value | Description |
| ----- | ----------- |
| `atRisk` |  |
| `needsAttention` |  |
| `onTrack` |  |

### IssuableSeverity

3165
Incident severity.
3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176

| Value | Description |
| ----- | ----------- |
| `CRITICAL` | Critical severity |
| `HIGH` | High severity |
| `LOW` | Low severity |
| `MEDIUM` | Medium severity |
| `UNKNOWN` | Unknown severity |

### IssuableState

3177
State of a GitLab issue or merge request.
3178 3179 3180 3181 3182 3183 3184 3185 3186 3187

| Value | Description |
| ----- | ----------- |
| `all` |  |
| `closed` |  |
| `locked` |  |
| `opened` |  |

### IssueSort

3188
Values for sorting issues.
3189 3190 3191

| Value | Description |
| ----- | ----------- |
3192 3193
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
3194 3195 3196 3197 3198 3199 3200 3201
| `DUE_DATE_ASC` | Due date by ascending order |
| `DUE_DATE_DESC` | Due date by descending order |
| `LABEL_PRIORITY_ASC` | Label priority by ascending order |
| `LABEL_PRIORITY_DESC` | Label priority by descending order |
| `MILESTONE_DUE_ASC` | Milestone due date by ascending order |
| `MILESTONE_DUE_DESC` | Milestone due date by descending order |
| `PRIORITY_ASC` | Priority by ascending order |
| `PRIORITY_DESC` | Priority by descending order |
3202 3203
| `PUBLISHED_ASC` | Published issues shown last |
| `PUBLISHED_DESC` | Published issues shown first |
3204
| `RELATIVE_POSITION_ASC` | Relative position by ascending order |
3205 3206 3207 3208
| `SEVERITY_ASC` | Severity from less critical to more critical |
| `SEVERITY_DESC` | Severity from more critical to less critical |
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
3209 3210 3211 3212 3213 3214 3215 3216 3217
| `WEIGHT_ASC` | Weight by ascending order |
| `WEIGHT_DESC` | Weight by descending order |
| `created_asc` | Created at ascending order |
| `created_desc` | Created at descending order |
| `updated_asc` | Updated at ascending order |
| `updated_desc` | Updated at descending order |

### IssueState

3218
State of a GitLab issue.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228

| Value | Description |
| ----- | ----------- |
| `all` |  |
| `closed` |  |
| `locked` |  |
| `opened` |  |

### IssueType

3229
Issue type.
3230 3231 3232 3233 3234 3235 3236 3237 3238

| Value | Description |
| ----- | ----------- |
| `INCIDENT` | Incident issue type |
| `ISSUE` | Issue issue type |
| `TEST_CASE` | Test Case issue type |

### IterationState

3239
State of a GitLab iteration.
3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250

| Value | Description |
| ----- | ----------- |
| `all` |  |
| `closed` |  |
| `opened` |  |
| `started` |  |
| `upcoming` |  |

### ListLimitMetric

3251
List limit metric setting.
3252 3253 3254 3255 3256 3257 3258 3259 3260

| Value | Description |
| ----- | ----------- |
| `all_metrics` |  |
| `issue_count` |  |
| `issue_weights` |  |

### MeasurementIdentifier

3261
Possible identifier types for a measurement.
3262 3263 3264 3265 3266 3267 3268

| Value | Description |
| ----- | ----------- |
| `GROUPS` | Group count |
| `ISSUES` | Issue count |
| `MERGE_REQUESTS` | Merge request count |
| `PIPELINES` | Pipeline count |
3269 3270 3271 3272
| `PIPELINES_CANCELED` | Pipeline count with canceled status |
| `PIPELINES_FAILED` | Pipeline count with failed status |
| `PIPELINES_SKIPPED` | Pipeline count with skipped status |
| `PIPELINES_SUCCEEDED` | Pipeline count with success status |
3273 3274 3275 3276 3277
| `PROJECTS` | Project count |
| `USERS` | User count |

### MergeRequestSort

3278
Values for sorting merge requests.
3279 3280 3281

| Value | Description |
| ----- | ----------- |
3282 3283
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
3284 3285 3286 3287 3288 3289 3290 3291
| `LABEL_PRIORITY_ASC` | Label priority by ascending order |
| `LABEL_PRIORITY_DESC` | Label priority by descending order |
| `MERGED_AT_ASC` | Merge time by ascending order |
| `MERGED_AT_DESC` | Merge time by descending order |
| `MILESTONE_DUE_ASC` | Milestone due date by ascending order |
| `MILESTONE_DUE_DESC` | Milestone due date by descending order |
| `PRIORITY_ASC` | Priority by ascending order |
| `PRIORITY_DESC` | Priority by descending order |
3292 3293
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
3294 3295 3296 3297 3298 3299 3300
| `created_asc` | Created at ascending order |
| `created_desc` | Created at descending order |
| `updated_asc` | Updated at ascending order |
| `updated_desc` | Updated at descending order |

### MergeRequestState

3301
State of a GitLab merge request.
3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319

| Value | Description |
| ----- | ----------- |
| `all` |  |
| `closed` |  |
| `locked` |  |
| `merged` |  |
| `opened` |  |

### MilestoneStateEnum

| Value | Description |
| ----- | ----------- |
| `active` |  |
| `closed` |  |

### MoveType

3320
The position to which the adjacent object should be moved.
3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338

| Value | Description |
| ----- | ----------- |
| `after` | The adjacent object will be moved after the object that is being moved |
| `before` | The adjacent object will be moved before the object that is being moved |

### MutationOperationMode

Different toggles for changing mutator behavior.

| Value | Description |
| ----- | ----------- |
| `APPEND` | Performs an append operation |
| `REMOVE` | Performs a removal operation |
| `REPLACE` | Performs a replace operation |

### NamespaceProjectSort

3339
Values for sorting projects.
3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351

| Value | Description |
| ----- | ----------- |
| `SIMILARITY` | Most similar to the search query |

### PackageTypeEnum

| Value | Description |
| ----- | ----------- |
| `COMPOSER` | Packages from the composer package manager |
| `CONAN` | Packages from the conan package manager |
| `GENERIC` | Packages from the generic package manager |
Ethan Reesor's avatar
Ethan Reesor committed
3352
| `GOLANG` | Packages from the golang package manager |
3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388
| `MAVEN` | Packages from the maven package manager |
| `NPM` | Packages from the npm package manager |
| `NUGET` | Packages from the nuget package manager |
| `PYPI` | Packages from the pypi package manager |

### PipelineConfigSourceEnum

| Value | Description |
| ----- | ----------- |
| `AUTO_DEVOPS_SOURCE` |  |
| `BRIDGE_SOURCE` |  |
| `EXTERNAL_PROJECT_SOURCE` |  |
| `PARAMETER_SOURCE` |  |
| `REMOTE_SOURCE` |  |
| `REPOSITORY_SOURCE` |  |
| `UNKNOWN_SOURCE` |  |
| `WEBIDE_SOURCE` |  |

### PipelineStatusEnum

| Value | Description |
| ----- | ----------- |
| `CANCELED` |  |
| `CREATED` |  |
| `FAILED` |  |
| `MANUAL` |  |
| `PENDING` |  |
| `PREPARING` |  |
| `RUNNING` |  |
| `SCHEDULED` |  |
| `SKIPPED` |  |
| `SUCCESS` |  |
| `WAITING_FOR_RESOURCE` |  |

### ProjectSettingEnum

3389
Names of compliance frameworks that can be assigned to a Project.
3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411

| Value | Description |
| ----- | ----------- |
| `gdpr` |  |
| `hipaa` |  |
| `pci_dss` |  |
| `soc_2` |  |
| `sox` |  |

### RegistryState

State of a Geo registry.

| Value | Description |
| ----- | ----------- |
| `FAILED` | Registry that failed to sync |
| `PENDING` | Registry waiting to be synced |
| `STARTED` | Registry currently syncing |
| `SYNCED` | Registry that is synced |

### ReleaseAssetLinkType

3412
Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`.
3413 3414 3415 3416 3417 3418 3419 3420 3421 3422

| Value | Description |
| ----- | ----------- |
| `IMAGE` | Image link type |
| `OTHER` | Other link type |
| `PACKAGE` | Package link type |
| `RUNBOOK` | Runbook link type |

### RequirementState

3423
State of a requirement.
3424 3425 3426 3427 3428 3429 3430 3431

| Value | Description |
| ----- | ----------- |
| `ARCHIVED` |  |
| `OPENED` |  |

### SastUiComponentSize

3432
Size of UI component in SAST configuration page.
3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454

| Value | Description |
| ----- | ----------- |
| `LARGE` |  |
| `MEDIUM` |  |
| `SMALL` |  |

### SecurityScannerType

The type of the security scanner.

| Value | Description |
| ----- | ----------- |
| `CONTAINER_SCANNING` |  |
| `COVERAGE_FUZZING` |  |
| `DAST` |  |
| `DEPENDENCY_SCANNING` |  |
| `SAST` |  |
| `SECRET_DETECTION` |  |

### SentryErrorStatus

3455
State of a Sentry error.
3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479

| Value | Description |
| ----- | ----------- |
| `IGNORED` | Error has been ignored |
| `RESOLVED` | Error has been resolved |
| `RESOLVED_IN_NEXT_RELEASE` | Error has been ignored until next release |
| `UNRESOLVED` | Error is unresolved |

### ServiceType

| Value | Description |
| ----- | ----------- |
| `ALERTS_SERVICE` |  |
| `ASANA_SERVICE` |  |
| `ASSEMBLA_SERVICE` |  |
| `BAMBOO_SERVICE` |  |
| `BUGZILLA_SERVICE` |  |
| `BUILDKITE_SERVICE` |  |
| `CAMPFIRE_SERVICE` |  |
| `CONFLUENCE_SERVICE` |  |
| `CUSTOM_ISSUE_TRACKER_SERVICE` |  |
| `DISCORD_SERVICE` |  |
| `DRONE_CI_SERVICE` |  |
| `EMAILS_ON_PUSH_SERVICE` |  |
3480
| `EWM_SERVICE` |  |
3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506
| `EXTERNAL_WIKI_SERVICE` |  |
| `FLOWDOCK_SERVICE` |  |
| `GITHUB_SERVICE` |  |
| `HANGOUTS_CHAT_SERVICE` |  |
| `HIPCHAT_SERVICE` |  |
| `IRKER_SERVICE` |  |
| `JENKINS_SERVICE` |  |
| `JIRA_SERVICE` |  |
| `MATTERMOST_SERVICE` |  |
| `MATTERMOST_SLASH_COMMANDS_SERVICE` |  |
| `MICROSOFT_TEAMS_SERVICE` |  |
| `PACKAGIST_SERVICE` |  |
| `PIPELINES_EMAIL_SERVICE` |  |
| `PIVOTALTRACKER_SERVICE` |  |
| `PROMETHEUS_SERVICE` |  |
| `PUSHOVER_SERVICE` |  |
| `REDMINE_SERVICE` |  |
| `SLACK_SERVICE` |  |
| `SLACK_SLASH_COMMANDS_SERVICE` |  |
| `TEAMCITY_SERVICE` |  |
| `UNIFY_CIRCUIT_SERVICE` |  |
| `WEBEX_TEAMS_SERVICE` |  |
| `YOUTRACK_SERVICE` |  |

### SnippetBlobActionEnum

3507
Type of a snippet blob input action.
3508 3509 3510 3511 3512 3513 3514 3515 3516 3517

| Value | Description |
| ----- | ----------- |
| `create` |  |
| `delete` |  |
| `move` |  |
| `update` |  |

### Sort

3518
Common sort values.
3519 3520 3521

| Value | Description |
| ----- | ----------- |
3522 3523 3524 3525
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
3526 3527 3528 3529 3530 3531 3532
| `created_asc` | Created at ascending order |
| `created_desc` | Created at descending order |
| `updated_asc` | Updated at ascending order |
| `updated_desc` | Updated at descending order |

### TestReportState

3533
State of a test report.
3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578

| Value | Description |
| ----- | ----------- |
| `FAILED` |  |
| `PASSED` |  |

### TodoActionEnum

| Value | Description |
| ----- | ----------- |
| `approval_required` |  |
| `assigned` |  |
| `build_failed` |  |
| `directly_addressed` |  |
| `marked` |  |
| `mentioned` |  |
| `unmergeable` |  |

### TodoStateEnum

| Value | Description |
| ----- | ----------- |
| `done` |  |
| `pending` |  |

### TodoTargetEnum

| Value | Description |
| ----- | ----------- |
| `ALERT` | An Alert |
| `COMMIT` | A Commit |
| `DESIGN` | A Design |
| `EPIC` | An Epic |
| `ISSUE` | An Issue |
| `MERGEREQUEST` | A MergeRequest |

### TypeEnum

| Value | Description |
| ----- | ----------- |
| `personal` |  |
| `project` |  |

### UserState

3579
Possible states of a user.
3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604

| Value | Description |
| ----- | ----------- |
| `active` | The user is active and is able to use the system |
| `blocked` | The user has been blocked and is prevented from using the system |
| `deactivated` | The user is no longer active and is unable to use the system |

### VisibilityLevelsEnum

| Value | Description |
| ----- | ----------- |
| `internal` |  |
| `private` |  |
| `public` |  |

### VisibilityScopesEnum

| Value | Description |
| ----- | ----------- |
| `internal` |  |
| `private` |  |
| `public` |  |

### VulnerabilityGrade

3605
The grade of the vulnerable project.
3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651

| Value | Description |
| ----- | ----------- |
| `A` |  |
| `B` |  |
| `C` |  |
| `D` |  |
| `F` |  |

### VulnerabilityIssueLinkType

The type of the issue link related to a vulnerability.

| Value | Description |
| ----- | ----------- |
| `CREATED` |  |
| `RELATED` |  |

### VulnerabilityReportType

The type of the security scan that found the vulnerability.

| Value | Description |
| ----- | ----------- |
| `CONTAINER_SCANNING` |  |
| `COVERAGE_FUZZING` |  |
| `DAST` |  |
| `DEPENDENCY_SCANNING` |  |
| `SAST` |  |
| `SECRET_DETECTION` |  |

### VulnerabilitySeverity

The severity of the vulnerability.

| Value | Description |
| ----- | ----------- |
| `CRITICAL` |  |
| `HIGH` |  |
| `INFO` |  |
| `LOW` |  |
| `MEDIUM` |  |
| `UNKNOWN` |  |

### VulnerabilitySort

3652
Vulnerability sort values.
3653 3654 3655

| Value | Description |
| ----- | ----------- |
3656 3657
| `detected_asc` | Detection timestamp in ascending order |
| `detected_desc` | Detection timestamp in descending order |
3658 3659
| `severity_asc` | Severity in ascending order |
| `severity_desc` | Severity in descending order |
3660 3661
| `title_asc` | Title in ascending order |
| `title_desc` | Title in descending order |
3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672

### VulnerabilityState

The state of the vulnerability.

| Value | Description |
| ----- | ----------- |
| `CONFIRMED` |  |
| `DETECTED` |  |
| `DISMISSED` |  |
| `RESOLVED` |  |