index.md 212 KB
Newer Older
1 2 3 4 5 6
---
stage: Plan
group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---

Felipe Artur's avatar
Felipe Artur committed
7 8 9 10 11 12 13 14 15 16 17
<!---
  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).
18

19 20
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
21

22
WARNING:
23
Fields that are deprecated are marked with **{warning-solid}**.
24 25
Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-process) can be found
in [Removed Items](../removed_items.md).
26

27 28
## Object types

29
Object types represent the resources that the GitLab GraphQL API can return.
30 31 32 33 34 35 36 37 38
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
39

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

42 43
| Field | Type | Description |
| ----- | ---- | ----------- |
44 45 46
| `integerValue` | Int | Integer representation of access level |
| `stringValue` | AccessLevelEnum | String representation of access level |

47
### AddAwardEmojiPayload
Felipe Artur's avatar
Felipe Artur committed
48

49
Autogenerated return type of AddAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
50

51 52
| Field | Type | Description |
| ----- | ---- | ----------- |
53
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
Felipe Artur's avatar
Felipe Artur committed
54
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
55
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
56

57
### AddProjectToSecurityDashboardPayload
58

59
Autogenerated return type of AddProjectToSecurityDashboard.
60

61 62
| Field | Type | Description |
| ----- | ---- | ----------- |
63
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
64
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
65
| `project` | Project | Project that was added to the Instance Security Dashboard |
66

67
### AdminSidekiqQueuesDeleteJobsPayload
68

69
Autogenerated return type of AdminSidekiqQueuesDeleteJobs.
70

71 72
| Field | Type | Description |
| ----- | ---- | ----------- |
73
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
74
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
75 76
| `result` | DeleteJobsResponse | Information about the status of the deletion request |

77
### AlertManagementAlert
78

79
Describes an alert from the project's Alert Management.
80

81 82
| Field | Type | Description |
| ----- | ---- | ----------- |
83
| `assignees` | UserConnection | Assignees of the alert |
84 85 86
| `createdAt` | Time | Timestamp the alert was created |
| `description` | String | Description of the alert |
| `details` | JSON | Alert details |
87
| `detailsUrl` | String! | The URL of the alert detail page |
88
| `discussions` | DiscussionConnection! | All discussions on this noteable |
89
| `endedAt` | Time | Timestamp the alert ended |
90
| `environment` | Environment | Environment for the alert |
91
| `eventCount` | Int | Number of events of this alert |
92
| `hosts` | String! => Array | List of hosts the alert came from |
93
| `iid` | ID! | Internal ID of the alert |
94
| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert |
95
| `metricsDashboardUrl` | String | URL for metrics embed for the alert |
96
| `monitoringTool` | String | Monitoring tool the alert came from |
97
| `notes` | NoteConnection! | All notes on this noteable |
98
| `prometheusAlert` | PrometheusAlert | The alert condition for Prometheus |
99
| `runbook` | String | Runbook for the alert as defined in alert details |
100 101 102 103 104
| `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 |
105
| `todos` | TodoConnection | Todos of the current user for the alert |
106
| `updatedAt` | Time | Timestamp the alert was last updated |
107

108
### AlertManagementAlertStatusCountsType
109

110
Represents total number of alerts for the represented categories.
111

112 113
| Field | Type | Description |
| ----- | ---- | ----------- |
114 115 116 117 118 119 120
| `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 |

Sarah Yasonik's avatar
Sarah Yasonik committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
### AlertManagementHttpIntegration

An endpoint and credentials used to accept alerts for a project.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `active` | Boolean | Whether the endpoint is currently accepting alerts |
| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard |
| `id` | ID! | ID of the integration |
| `name` | String | Name of the integration |
| `token` | String | Token used to authenticate alert notification requests |
| `type` | AlertManagementIntegrationType! | Type of integration |
| `url` | String | Endpoint which accepts alert notifications |

### AlertManagementPrometheusIntegration

An endpoint and credentials used to accept Prometheus alerts for a project.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `active` | Boolean | Whether the endpoint is currently accepting alerts |
| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard |
| `id` | ID! | ID of the integration |
| `name` | String | Name of the integration |
| `token` | String | Token used to authenticate alert notification requests |
| `type` | AlertManagementIntegrationType! | Type of integration |
| `url` | String | Endpoint which accepts alert notifications |

149
### AlertSetAssigneesPayload
150

151
Autogenerated return type of AlertSetAssignees.
152

153 154
| Field | Type | Description |
| ----- | ---- | ----------- |
155 156 157 158
| `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
159 160
| `todo` | Todo | The todo after mutation |

161
### AlertTodoCreatePayload
Allison Browne's avatar
Allison Browne committed
162

163
Autogenerated return type of AlertTodoCreate.
Allison Browne's avatar
Allison Browne committed
164

165 166
| Field | Type | Description |
| ----- | ---- | ----------- |
Allison Browne's avatar
Allison Browne committed
167 168 169 170 171
| `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 |
172

173
### AwardEmoji
174 175

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

177 178
| Field | Type | Description |
| ----- | ---- | ----------- |
Felipe Artur's avatar
Felipe Artur committed
179 180
| `description` | String! | The emoji description |
| `emoji` | String! | The emoji as an icon |
181 182
| `name` | String! | The emoji name |
| `unicode` | String! | The emoji in unicode |
Felipe Artur's avatar
Felipe Artur committed
183 184 185
| `unicodeVersion` | String! | The unicode version for this emoji |
| `user` | User! | The user who awarded the emoji |

186
### AwardEmojiAddPayload
187

188
Autogenerated return type of AwardEmojiAdd.
189

190 191
| Field | Type | Description |
| ----- | ---- | ----------- |
192 193 194 195
| `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. |

196
### AwardEmojiRemovePayload
197

198
Autogenerated return type of AwardEmojiRemove.
199

200 201
| Field | Type | Description |
| ----- | ---- | ----------- |
202 203 204 205
| `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. |

206
### AwardEmojiTogglePayload
207

208
Autogenerated return type of AwardEmojiToggle.
209

210 211
| Field | Type | Description |
| ----- | ---- | ----------- |
212 213 214 215 216
| `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. |

217
### BaseService
218

219 220
| Field | Type | Description |
| ----- | ---- | ----------- |
221 222 223
| `active` | Boolean | Indicates if the service is active |
| `type` | String | Class name of the service |

224
### Blob
Felipe Artur's avatar
Felipe Artur committed
225

226 227
| Field | Type | Description |
| ----- | ---- | ----------- |
228
| `flatPath` | String! | Flat path of the entry |
229
| `id` | ID! | ID of the entry |
230
| `lfsOid` | String | LFS ID of the blob |
231
| `mode` | String | Blob mode in numeric format |
232 233
| `name` | String! | Name of the entry |
| `path` | String! | Path of the entry |
234 235
| `sha` | String! | Last commit sha for the entry |
| `type` | EntryType! | Type of tree entry |
236
| `webPath` | String | Web path of the blob |
237
| `webUrl` | String | Web URL of the blob |
Felipe Artur's avatar
Felipe Artur committed
238

239
### Board
240

241
Represents a project or group board.
242

243 244
| Field | Type | Description |
| ----- | ---- | ----------- |
245 246 247 248
| `assignee` | User | The board assignee |
| `epics` | BoardEpicConnection | Epics associated with board issues |
| `hideBacklogList` | Boolean | Whether or not backlog list is hidden |
| `hideClosedList` | Boolean | Whether or not closed list is hidden |
249
| `id` | ID! | ID (global ID) of the board |
250
| `iteration` | Iteration | The board iteration. |
251 252
| `labels` | LabelConnection | Labels of the board |
| `lists` | BoardListConnection | Lists of the board |
253
| `milestone` | Milestone | The board milestone |
254
| `name` | String | Name of the board |
255
| `weight` | Int | Weight of the board |
256

257 258 259 260 261 262 263
### BoardEpic

Represents an epic on an issue board.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `author` | User! | Author of the epic |
264
| `children` | EpicConnection | Children (sub-epics) of the epic |
265 266 267
| `closedAt` | Time | Timestamp of when the epic was closed |
| `confidential` | Boolean | Indicates if the epic is confidential |
| `createdAt` | Time | Timestamp of when the epic was created |
268
| `currentUserTodos` | TodoConnection! | Todos for the current user |
269 270 271
| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues |
| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants |
| `description` | String | Description of the epic |
272
| `discussions` | DiscussionConnection! | All discussions on this noteable |
273 274 275 276 277 278 279 280 281 282 283 284
| `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 |
| `group` | Group! | Group to which the epic belongs |
| `hasChildren` | Boolean! | Indicates if the epic has children |
| `hasIssues` | Boolean! | Indicates if the epic has direct issues |
| `hasParent` | Boolean! | Indicates if the epic has a parent epic |
| `healthStatus` | EpicHealthStatus | Current health status of the epic |
| `id` | ID! | ID of the epic |
| `iid` | ID! | Internal ID of the epic |
285 286 287
| `issues` | EpicIssueConnection | A list of issues associated with the epic |
| `labels` | LabelConnection | Labels assigned to the epic |
| `notes` | NoteConnection! | All notes on this noteable |
288
| `parent` | Epic | Parent epic of the epic |
289
| `participants` | UserConnection | List of participants for the epic |
290 291 292 293 294 295 296 297 298 299 300 301
| `reference` | String! | Internal reference of the epic. Returned in shortened format by default |
| `relationPath` | String | URI path of the epic-issue relationship |
| `relativePosition` | Int | The relative position of the epic in the epic tree |
| `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 |
| `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 |
| `updatedAt` | Time | Timestamp of when the epic was updated |
| `upvotes` | Int! | Number of upvotes the epic has received |
302 303
| `userDiscussionsCount` | Int! | Number of user discussions in the epic |
| `userNotesCount` | Int! | Number of user notes of the epic |
304 305 306 307 308 309 310 311 312 313 314 315 316
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
| `userPreferences` | BoardEpicUserPreferences | User preferences for the epic on the issue board |
| `webPath` | String! | Web path of the epic |
| `webUrl` | String! | Web URL of the epic |

### BoardEpicUserPreferences

Represents user preferences for a board epic.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `collapsed` | Boolean! | Indicates epic should be displayed as collapsed |

317
### BoardList
318

319
Represents a list for an issue board.
320

321 322
| Field | Type | Description |
| ----- | ---- | ----------- |
323 324 325
| `assignee` | User | Assignee in the list |
| `collapsed` | Boolean | Indicates if list is collapsed for this user |
| `id` | ID! | ID (global ID) of the list |
326
| `issues` | IssueConnection | Board issues |
327
| `issuesCount` | Int | Count of issues in the list |
328
| `iteration` | Iteration | Iteration of the list |
329
| `label` | Label | Label of the list |
330
| `limitMetric` | ListLimitMetric | The current limit metric for the list |
331 332 333 334 335 336
| `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 |
337
| `totalWeight` | Int | Total weight of all issues in the list |
338

339
### BoardListCreatePayload
340

341
Autogenerated return type of BoardListCreate.
342

343 344
| Field | Type | Description |
| ----- | ---- | ----------- |
345 346 347 348
| `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 |

349
### BoardListUpdateLimitMetricsPayload
350

351
Autogenerated return type of BoardListUpdateLimitMetrics.
352

353 354
| Field | Type | Description |
| ----- | ---- | ----------- |
355
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
356
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
357 358
| `list` | BoardList | The updated list |

359
### Branch
360

361 362
| Field | Type | Description |
| ----- | ---- | ----------- |
363 364 365
| `commit` | Commit | Commit for the branch |
| `name` | String! | Name of the branch |

366
### BurnupChartDailyTotals
367 368 369

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

370 371
| Field | Type | Description |
| ----- | ---- | ----------- |
372 373 374 375 376 377
| `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 |

lauraMon's avatar
lauraMon committed
378 379 380 381
### CiConfig

| Field | Type | Description |
| ----- | ---- | ----------- |
382
| `errors` | String! => Array | Linting errors |
lauraMon's avatar
lauraMon committed
383
| `mergedYaml` | String | Merged CI config YAML |
lauraMon's avatar
lauraMon committed
384
| `stages` | CiConfigStageConnection | Stages of the pipeline |
lauraMon's avatar
lauraMon committed
385 386 387 388 389 390
| `status` | CiConfigStatus | Status of linting, can be either valid or invalid |

### CiConfigGroup

| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
391
| `jobs` | CiConfigJobConnection | Jobs in group |
lauraMon's avatar
lauraMon committed
392 393 394 395 396 397 398
| `name` | String | Name of the job group |
| `size` | Int | Size of the job group |

### CiConfigJob

| Field | Type | Description |
| ----- | ---- | ----------- |
399
| `groupName` | String | Name of the job group |
lauraMon's avatar
lauraMon committed
400
| `name` | String | Name of the job |
lauraMon's avatar
lauraMon committed
401
| `needs` | CiConfigNeedConnection | Builds that must complete before the jobs run |
402
| `stage` | String | Name of the job stage |
lauraMon's avatar
lauraMon committed
403 404 405 406 407

### CiConfigNeed

| Field | Type | Description |
| ----- | ---- | ----------- |
408
| `name` | String | Name of the need |
lauraMon's avatar
lauraMon committed
409 410 411 412 413

### CiConfigStage

| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
414
| `groups` | CiConfigGroupConnection | Groups of jobs for the stage |
lauraMon's avatar
lauraMon committed
415 416
| `name` | String | Name of the stage |

417
### CiGroup
Laura Montemayor's avatar
Laura Montemayor committed
418

419 420
| Field | Type | Description |
| ----- | ---- | ----------- |
421
| `detailedStatus` | DetailedStatus | Detailed status of the group |
422
| `jobs` | CiJobConnection | Jobs in group |
Laura Montemayor's avatar
Laura Montemayor committed
423 424 425
| `name` | String | Name of the job group |
| `size` | Int | Size of the group |

426
### CiJob
Laura Montemayor's avatar
Laura Montemayor committed
427

428 429
| Field | Type | Description |
| ----- | ---- | ----------- |
430
| `artifacts` | CiJobArtifactConnection | Artifacts generated by the job |
431
| `detailedStatus` | DetailedStatus | Detailed status of the job |
Laura Montemayor's avatar
Laura Montemayor committed
432
| `name` | String | Name of the job |
433
| `needs` | CiJobConnection | Builds that must complete before the jobs run |
434
| `pipeline` | Pipeline | Pipeline the job belongs to |
435
| `scheduledAt` | Time | Schedule for the build |
Laura Montemayor's avatar
Laura Montemayor committed
436

437 438 439 440 441 442 443
### CiJobArtifact

| Field | Type | Description |
| ----- | ---- | ----------- |
| `downloadPath` | String | URL for downloading the artifact's file |
| `fileType` | JobArtifactFileType | File type of the artifact |

444
### CiStage
Laura Montemayor's avatar
Laura Montemayor committed
445

446 447
| Field | Type | Description |
| ----- | ---- | ----------- |
448
| `detailedStatus` | DetailedStatus | Detailed status of the stage |
449
| `groups` | CiGroupConnection | Group of jobs for the stage |
Laura Montemayor's avatar
Laura Montemayor committed
450 451
| `name` | String | Name of the stage |

452
### ClusterAgent
453

454 455
| Field | Type | Description |
| ----- | ---- | ----------- |
456 457 458 459
| `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 |
460
| `tokens` | ClusterAgentTokenConnection | Tokens associated with the cluster agent |
461 462
| `updatedAt` | Time | Timestamp the cluster agent was updated |

463
### ClusterAgentDeletePayload
464

465
Autogenerated return type of ClusterAgentDelete.
466

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

472
### ClusterAgentToken
473

474 475
| Field | Type | Description |
| ----- | ---- | ----------- |
476 477 478 479
| `clusterAgent` | ClusterAgent | Cluster agent this token is associated with |
| `createdAt` | Time | Timestamp the token was created |
| `id` | ClustersAgentTokenID! | Global ID of the token |

480
### ClusterAgentTokenCreatePayload
481

482
Autogenerated return type of ClusterAgentTokenCreate.
483

484 485
| Field | Type | Description |
| ----- | ---- | ----------- |
486 487 488 489 490
| `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 |

491
### ClusterAgentTokenDeletePayload
492

493
Autogenerated return type of ClusterAgentTokenDelete.
494

495 496
| Field | Type | Description |
| ----- | ---- | ----------- |
497 498 499
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

500 501 502 503 504 505 506 507 508 509 510
### CodeCoverageActivity

Represents the code coverage activity for a group.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `averageCoverage` | Float | Average percentage of the different code coverage results available for the group. |
| `coverageCount` | Int | Number of different code coverage results available for the group. |
| `date` | Date! | Date when the code coverage was created. |
| `projectCount` | Int | Number of projects with code coverage results for the group. |

511 512 513 514 515 516 517 518
### CodeCoverageSummary

Represents the code coverage summary for a project.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `averageCoverage` | Float | Average percentage of the different code coverage results available for the project. |
| `coverageCount` | Int | Number of different code coverage results available. |
519
| `lastUpdatedOn` | Date | Latest date when the code coverage was created for the project. |
520

521
### Commit
Felipe Artur's avatar
Felipe Artur committed
522

523 524
| Field | Type | Description |
| ----- | ---- | ----------- |
525
| `author` | User | Author of the commit |
526
| `authorGravatar` | String | Commit authors gravatar |
527 528 529
| `authorName` | String | Commit authors name |
| `authoredDate` | Time | Timestamp of when the commit was authored |
| `description` | String | Description of the commit message |
530
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
531
| `id` | ID! | ID (global ID) of the commit |
532
| `message` | String | Raw commit message |
533
| `pipelines` | PipelineConnection | Pipelines of the commit ordered latest first |
534
| `sha` | String! | SHA1 ID of the commit |
535
| `shortId` | String! | Short SHA1 ID of the commit |
536
| `signatureHtml` | String | Rendered HTML of the commit signature |
537
| `title` | String | Title of the commit message |
538
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
539
| `webPath` | String! | Web path of the commit |
540
| `webUrl` | String! | Web URL of the commit |
Felipe Artur's avatar
Felipe Artur committed
541

542
### CommitCreatePayload
543

544
Autogenerated return type of CommitCreate.
545

546 547
| Field | Type | Description |
| ----- | ---- | ----------- |
548 549 550 551
| `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. |

552
### ComplianceFramework
553

554
Represents a ComplianceFramework associated with a Project.
555

556 557
| Field | Type | Description |
| ----- | ---- | ----------- |
558 559 560
| `color` | String! | Hexadecimal representation of compliance framework's label color |
| `description` | String! | Description of the compliance framework |
| `id` | ID! | Compliance framework ID |
561
| `name` | String! | Name of the compliance framework |
562

563
### ConfigureSastPayload
564

565
Autogenerated return type of ConfigureSast.
566

567 568
| Field | Type | Description |
| ----- | ---- | ----------- |
569 570
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
571 572
| `status` | String! | Status of creating the commit for the supplied SAST CI configuration |
| `successPath` | String | Redirect path to use when the response is successful |
573

574
### ContainerExpirationPolicy
575

576
A tag expiration policy designed to keep only the images that matter most.
577

578 579
| Field | Type | Description |
| ----- | ---- | ----------- |
580 581
| `cadence` | ContainerExpirationPolicyCadenceEnum! | This container expiration policy schedule |
| `createdAt` | Time! | Timestamp of when the container expiration policy was created |
582
| `enabled` | Boolean! | Indicates whether this container expiration policy is enabled |
583
| `keepN` | ContainerExpirationPolicyKeepEnum | Number of tags to retain |
584 585
| `nameRegex` | UntrustedRegexp | Tags with names matching this regex pattern will expire |
| `nameRegexKeep` | UntrustedRegexp | Tags with names matching this regex pattern will be preserved |
586 587 588 589
| `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 |

590 591 592 593 594 595 596 597
### ContainerRepository

A container repository.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `canDelete` | Boolean! | Can the current user delete the container repository. |
| `createdAt` | Time! | Timestamp when the container repository was created. |
598
| `expirationPolicyCleanupStatus` | ContainerRepositoryCleanupStatus | The tags cleanup status for the container repository. |
599 600 601 602 603
| `expirationPolicyStartedAt` | Time | Timestamp when the cleanup done by the expiration policy was started on the container repository. |
| `id` | ID! | ID of the container repository. |
| `location` | String! | URL of the container repository. |
| `name` | String! | Name of the container repository. |
| `path` | String! | Path of the container repository. |
604
| `project` | Project! | Project of the container registry |
605 606 607 608
| `status` | ContainerRepositoryStatus | Status of the container repository. |
| `tagsCount` | Int! | Number of tags associated with this image. |
| `updatedAt` | Time! | Timestamp when the container repository was updated. |

609 610 611 612 613 614 615 616
### ContainerRepositoryDetails

Details of a container repository.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `canDelete` | Boolean! | Can the current user delete the container repository. |
| `createdAt` | Time! | Timestamp when the container repository was created. |
617
| `expirationPolicyCleanupStatus` | ContainerRepositoryCleanupStatus | The tags cleanup status for the container repository. |
618 619 620 621 622
| `expirationPolicyStartedAt` | Time | Timestamp when the cleanup done by the expiration policy was started on the container repository. |
| `id` | ID! | ID of the container repository. |
| `location` | String! | URL of the container repository. |
| `name` | String! | Name of the container repository. |
| `path` | String! | Path of the container repository. |
623
| `project` | Project! | Project of the container registry |
624 625 626 627 628 629 630 631 632 633 634 635
| `status` | ContainerRepositoryStatus | Status of the container repository. |
| `tags` | ContainerRepositoryTagConnection | Tags of the container repository |
| `tagsCount` | Int! | Number of tags associated with this image. |
| `updatedAt` | Time! | Timestamp when the container repository was updated. |

### ContainerRepositoryTag

A tag from a container repository.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `canDelete` | Boolean! | Can the current user delete this tag. |
636 637
| `createdAt` | Time | Timestamp when the tag was created. |
| `digest` | String | Digest of the tag. |
638 639 640
| `location` | String! | URL of the tag. |
| `name` | String! | Name of the tag. |
| `path` | String! | Path of the tag. |
641 642
| `revision` | String | Revision of the tag. |
| `shortRevision` | String | Short revision of the tag. |
643
| `totalSize` | BigInt | The size of the tag. |
644

645
### CreateAlertIssuePayload
646

647
Autogenerated return type of CreateAlertIssue.
648

649 650
| Field | Type | Description |
| ----- | ---- | ----------- |
651 652 653 654
| `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
655
| `todo` | Todo | The todo after mutation |
656

657
### CreateAnnotationPayload
658

659
Autogenerated return type of CreateAnnotation.
660

661 662
| Field | Type | Description |
| ----- | ---- | ----------- |
663 664 665 666
| `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. |

667 668 669 670 671 672 673 674 675 676
### CreateBoardPayload

Autogenerated return type of CreateBoard.

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

677
### CreateBranchPayload
678

679
Autogenerated return type of CreateBranch.
680

681 682
| Field | Type | Description |
| ----- | ---- | ----------- |
683 684
| `branch` | Branch | Branch after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
685
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
686

687
### CreateClusterAgentPayload
688

689
Autogenerated return type of CreateClusterAgent.
690

691 692
| Field | Type | Description |
| ----- | ---- | ----------- |
693 694 695
| `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. |
696

697 698 699 700 701 702 703 704 705 706
### CreateComplianceFrameworkPayload

Autogenerated return type of CreateComplianceFramework.

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

707 708 709 710 711 712 713 714 715 716
### CreateCustomEmojiPayload

Autogenerated return type of CreateCustomEmoji.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `customEmoji` | CustomEmoji | The new custom emoji |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

717 718 719 720 721 722 723 724 725 726
### CreateDevopsAdoptionSegmentPayload

Autogenerated return type of CreateDevopsAdoptionSegment.

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

727
### CreateDiffNotePayload
728

729
Autogenerated return type of CreateDiffNote.
730

731 732
| Field | Type | Description |
| ----- | ---- | ----------- |
733
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
734
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
735 736
| `note` | Note | The note after mutation |

737
### CreateEpicPayload
738

739
Autogenerated return type of CreateEpic.
740

741 742
| Field | Type | Description |
| ----- | ---- | ----------- |
743 744
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The created epic |
745
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
746

747
### CreateImageDiffNotePayload
748

749
Autogenerated return type of CreateImageDiffNote.
750

751 752
| Field | Type | Description |
| ----- | ---- | ----------- |
753
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
754
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
755 756
| `note` | Note | The note after mutation |

757 758 759 760 761 762 763 764 765 766
### CreateIssuePayload

Autogenerated return type of CreateIssue.

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

767
### CreateIterationPayload
768

769
Autogenerated return type of CreateIteration.
770

771 772
| Field | Type | Description |
| ----- | ---- | ----------- |
773 774 775 776
| `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 |

777
### CreateNotePayload
778

779
Autogenerated return type of CreateNote.
780

781 782
| Field | Type | Description |
| ----- | ---- | ----------- |
783
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
784
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
785 786
| `note` | Note | The note after mutation |

787
### CreateRequirementPayload
Jan Provaznik's avatar
Jan Provaznik committed
788

789
Autogenerated return type of CreateRequirement.
Jan Provaznik's avatar
Jan Provaznik committed
790

791 792
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
793
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
794
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
795
| `requirement` | Requirement | Requirement after mutation |
Jan Provaznik's avatar
Jan Provaznik committed
796

797
### CreateSnippetPayload
798

799
Autogenerated return type of CreateSnippet.
800

801 802
| Field | Type | Description |
| ----- | ---- | ----------- |
803
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
804
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
805
| `snippet` | Snippet | The snippet after mutation |
806
| `spam` | Boolean | Indicates whether the operation returns a record detected as spam |
807

808 809
### CreateTestCasePayload

810
Autogenerated return type of CreateTestCase.
811 812 813 814 815 816 817

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

818 819 820 821 822 823 824 825 826 827 828
### CustomEmoji

A custom emoji uploaded by user.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `external` | Boolean! | Whether the emoji is an external link |
| `id` | CustomEmojiID! | The ID of the emoji |
| `name` | String! | The name of the emoji |
| `url` | String! | The link to file of the emoji |

829
### DastOnDemandScanCreatePayload
830

831
Autogenerated return type of DastOnDemandScanCreate.
832

833 834
| Field | Type | Description |
| ----- | ---- | ----------- |
835 836 837 838
| `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. |

839
### DastScannerProfile
840 841 842

Represents a DAST scanner profile.

843 844
| Field | Type | Description |
| ----- | ---- | ----------- |
845
| `editPath` | String | Relative web path to the edit page of a scanner profile |
846
| `globalId` **{warning-solid}** | DastScannerProfileID! | **Deprecated:** Use `id`. Deprecated in 13.6. |
847
| `id` | DastScannerProfileID! | ID of the DAST scanner profile |
848
| `profileName` | String | Name of the DAST scanner profile |
849 850
| `scanType` | DastScanTypeEnum | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. |
| `showDebugMessages` | Boolean! | Indicates if debug messages should be included in DAST console output. True to include the debug messages. |
851
| `spiderTimeout` | Int | The maximum number of minutes allowed for the spider to traverse the site |
852
| `targetTimeout` | Int | The maximum number of seconds allowed for the site under test to respond to a request |
853
| `useAjaxSpider` | Boolean! | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. |
854

855
### DastScannerProfileCreatePayload
856

857
Autogenerated return type of DastScannerProfileCreate.
858

859 860
| Field | Type | Description |
| ----- | ---- | ----------- |
861 862
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
863
| `globalId` **{warning-solid}** | DastScannerProfileID | **Deprecated:** Use `id`. Deprecated in 13.6. |
864
| `id` | DastScannerProfileID | ID of the scanner profile. |
865

866
### DastScannerProfileDeletePayload
867

868
Autogenerated return type of DastScannerProfileDelete.
869

870 871
| Field | Type | Description |
| ----- | ---- | ----------- |
872 873 874
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

875
### DastScannerProfileUpdatePayload
876

877
Autogenerated return type of DastScannerProfileUpdate.
878

879 880
| Field | Type | Description |
| ----- | ---- | ----------- |
881 882 883 884
| `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. |

885
### DastSiteProfile
886 887 888

Represents a DAST Site Profile.

889 890
| Field | Type | Description |
| ----- | ---- | ----------- |
891
| `editPath` | String | Relative web path to the edit page of a site profile |
892
| `id` | DastSiteProfileID! | ID of the site profile |
893
| `normalizedTargetUrl` | String | Normalized URL of the target to be scanned |
894 895 896 897 898
| `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 |

899
### DastSiteProfileCreatePayload
900

901
Autogenerated return type of DastSiteProfileCreate.
902

903 904
| Field | Type | Description |
| ----- | ---- | ----------- |
905 906
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
907
| `id` | DastSiteProfileID | ID of the site profile. |
908

909
### DastSiteProfileDeletePayload
910

911
Autogenerated return type of DastSiteProfileDelete.
912

913 914
| Field | Type | Description |
| ----- | ---- | ----------- |
915 916 917
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

918
### DastSiteProfilePermissions
919

920
Check permissions for the current user on site profile.
921

922 923
| Field | Type | Description |
| ----- | ---- | ----------- |
924 925
| `createOnDemandDastScan` | Boolean! | Indicates the user can perform `create_on_demand_dast_scan` on this resource |

926
### DastSiteProfileUpdatePayload
927

928
Autogenerated return type of DastSiteProfileUpdate.
929

930 931
| Field | Type | Description |
| ----- | ---- | ----------- |
932 933 934 935
| `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. |

936 937 938 939 940 941 942 943 944 945 946 947
### DastSiteTokenCreatePayload

Autogenerated return type of DastSiteTokenCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `id` | DastSiteTokenID | ID of the site token. |
| `status` | DastSiteProfileValidationStatusEnum | The current validation status of the target. |
| `token` | String | Token string. |

948 949 950 951 952 953
### DastSiteValidation

Represents a DAST Site Validation.

| Field | Type | Description |
| ----- | ---- | ----------- |
954
| `id` | DastSiteValidationID! | Global ID of the site validation |
955
| `normalizedTargetUrl` | String | Normalized URL of the target to be validated |
956
| `status` | DastSiteProfileValidationStatusEnum! | Status of the site validation |
957

958 959 960 961 962 963 964 965 966 967 968
### DastSiteValidationCreatePayload

Autogenerated return type of DastSiteValidationCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `id` | DastSiteValidationID | ID of the site validation. |
| `status` | DastSiteProfileValidationStatusEnum | The current validation status. |

969
### DeleteAnnotationPayload
970

971
Autogenerated return type of DeleteAnnotation.
972

973 974
| Field | Type | Description |
| ----- | ---- | ----------- |
975 976 977
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

978 979 980 981 982 983 984 985 986
### DeleteDevopsAdoptionSegmentPayload

Autogenerated return type of DeleteDevopsAdoptionSegment.

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

987
### DeleteJobsResponse
988 989 990

The response from the AdminSidekiqQueuesDeleteJobs mutation.

991 992
| Field | Type | Description |
| ----- | ---- | ----------- |
993 994 995 996
| `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 |

997
### Design
998

999
A single design.
1000

1001 1002
| Field | Type | Description |
| ----- | ---- | ----------- |
1003
| `currentUserTodos` | TodoConnection! | Todos for the current user |
1004
| `diffRefs` | DiffRefs! | The diff refs for this design |
1005
| `discussions` | DiscussionConnection! | All discussions on this noteable |
1006
| `event` | DesignVersionEvent! | How this design was changed in the current version |
1007 1008
| `filename` | String! | The filename of the design |
| `fullPath` | String! | The full path to the design file |
1009
| `id` | ID! | The ID of this design |
1010 1011
| `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 |
1012
| `issue` | Issue! | The issue the design belongs to |
1013
| `notes` | NoteConnection! | All notes on this noteable |
1014
| `notesCount` | Int! | The total count of user-created notes for this design |
1015
| `project` | Project! | The project the design belongs to |
1016
| `versions` | DesignVersionConnection! | All versions related to this design ordered newest first |
1017

1018
### DesignAtVersion
1019 1020 1021

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

1022 1023
| Field | Type | Description |
| ----- | ---- | ----------- |
1024
| `design` | Design! | The underlying design |
1025 1026
| `diffRefs` | DiffRefs! | The diff refs for this design |
| `event` | DesignVersionEvent! | How this design was changed in the current version |
1027 1028
| `filename` | String! | The filename of the design |
| `fullPath` | String! | The full path to the design file |
1029
| `id` | ID! | The ID of this design |
1030 1031
| `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 |
1032
| `issue` | Issue! | The issue the design belongs to |
1033
| `notesCount` | Int! | The total count of user-created notes for this design |
1034
| `project` | Project! | The project the design belongs to |
1035 1036
| `version` | DesignVersion! | The version this design-at-versions is pinned to |

1037
### DesignCollection
1038 1039

A collection of designs.
1040

1041 1042
| Field | Type | Description |
| ----- | ---- | ----------- |
1043
| `copyState` | DesignCollectionCopyState | Copy state of the design collection |
1044 1045
| `design` | Design | Find a specific design |
| `designAtVersion` | DesignAtVersion | Find a design as of a version |
1046
| `designs` | DesignConnection! | All designs for the design collection |
1047
| `issue` | Issue! | Issue associated with the design collection |
1048
| `project` | Project! | Project associated with the design collection |
1049
| `version` | DesignVersion | A specific version |
1050
| `versions` | DesignVersionConnection! | All versions related to all designs, ordered newest first |
1051

1052
### DesignManagement
1053

1054 1055
| Field | Type | Description |
| ----- | ---- | ----------- |
1056
| `designAtVersion` | DesignAtVersion | Find a design as of a version |
1057
| `version` | DesignVersion | Find a version |
1058

1059
### DesignManagementDeletePayload
1060

1061
Autogenerated return type of DesignManagementDelete.
1062

1063 1064
| Field | Type | Description |
| ----- | ---- | ----------- |
1065
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1066
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1067 1068
| `version` | DesignVersion | The new version in which the designs are deleted |

1069
### DesignManagementMovePayload
1070

1071
Autogenerated return type of DesignManagementMove.
1072

1073 1074
| Field | Type | Description |
| ----- | ---- | ----------- |
1075 1076 1077 1078
| `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. |

1079
### DesignManagementUploadPayload
1080

1081
Autogenerated return type of DesignManagementUpload.
1082

1083 1084
| Field | Type | Description |
| ----- | ---- | ----------- |
1085 1086
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `designs` | Design! => Array | The designs that were uploaded by the mutation |
1087
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1088 1089
| `skippedDesigns` | Design! => Array | Any designs that were skipped from the upload due to there being no change to their content since their last version |

1090
### DesignVersion
1091

1092
A specific version in which designs were added, modified or deleted.
1093

1094 1095
| Field | Type | Description |
| ----- | ---- | ----------- |
1096
| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version |
1097 1098
| `designs` | DesignConnection! | All designs that were changed in the version |
| `designsAtVersion` | DesignAtVersionConnection! | All designs that are visible at this version, as of this version |
1099 1100
| `id` | ID! | ID of the design version |
| `sha` | ID! | SHA of the design version |
1101

1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
### 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. |

1112 1113
### DestroyBoardPayload

1114
Autogenerated return type of DestroyBoard.
1115 1116 1117 1118 1119 1120 1121

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

1122 1123 1124 1125 1126 1127 1128 1129 1130
### DestroyComplianceFrameworkPayload

Autogenerated return type of DestroyComplianceFramework.

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

1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
### DestroyContainerRepositoryPayload

Autogenerated return type of DestroyContainerRepository.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `containerRepository` | ContainerRepository! | The container repository policy after scheduling the deletion. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
### DestroyContainerRepositoryTagsPayload

Autogenerated return type of DestroyContainerRepositoryTags.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `deletedTagNames` | String! => Array | Deleted container repository tags |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

1151
### DestroyNotePayload
1152

1153
Autogenerated return type of DestroyNote.
1154

1155 1156
| Field | Type | Description |
| ----- | ---- | ----------- |
1157
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1158
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1159 1160
| `note` | Note | The note after mutation |

1161
### DestroySnippetPayload
1162

1163
Autogenerated return type of DestroySnippet.
1164

1165 1166
| Field | Type | Description |
| ----- | ---- | ----------- |
1167
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1168
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1169 1170
| `snippet` | Snippet | The snippet after mutation |

1171
### DetailedStatus
Felipe Artur's avatar
Felipe Artur committed
1172

1173 1174
| Field | Type | Description |
| ----- | ---- | ----------- |
1175
| `action` | StatusAction | Action information for the status. This includes method, button title, icon, path, and title |
1176
| `detailsPath` | String | Path of the details for the status |
1177 1178 1179 1180 1181 1182 1183
| `favicon` | String | Favicon of the status |
| `group` | String | Group of the status |
| `hasDetails` | Boolean | Indicates if the status has further details |
| `icon` | String | Icon of the status |
| `label` | String | Label of the status |
| `text` | String | Text of the status |
| `tooltip` | String | Tooltip associated with the status |
Felipe Artur's avatar
Felipe Artur committed
1184

1185 1186 1187 1188 1189 1190
### DevopsAdoptionSegment

Segment.

| Field | Type | Description |
| ----- | ---- | ----------- |
1191
| `groups` | Group! => Array | Assigned groups |
1192
| `id` | ID! | ID of the segment |
1193
| `latestSnapshot` | DevopsAdoptionSnapshot | The latest adoption metrics for the segment |
1194 1195
| `name` | String! | Name of the segment |

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
### DevopsAdoptionSnapshot

Snapshot.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `deploySucceeded` | Boolean! | At least one deployment succeeded |
| `endTime` | Time! | The end time for the snapshot where the data points were collected |
| `issueOpened` | Boolean! | At least one issue was opened |
| `mergeRequestApproved` | Boolean! | At least one merge request was approved |
| `mergeRequestOpened` | Boolean! | At least one merge request was opened |
| `pipelineSucceeded` | Boolean! | At least one pipeline succeeded |
| `recordedAt` | Time! | The time the snapshot was recorded |
| `runnerConfigured` | Boolean! | At least one runner was used |
| `securityScanSucceeded` | Boolean! | At least one security scan succeeded |
| `startTime` | Time! | The start time for the snapshot where the data points were collected |

1213
### DiffPosition
Felipe Artur's avatar
Felipe Artur committed
1214

1215 1216
| Field | Type | Description |
| ----- | ---- | ----------- |
1217 1218
| `diffRefs` | DiffRefs! | Information about the branch, HEAD, and base at the time of commenting |
| `filePath` | String! | Path of the file that was changed |
1219 1220
| `height` | Int | Total height of the image |
| `newLine` | Int | Line on HEAD SHA that was changed |
1221 1222
| `newPath` | String | Path of the file on the HEAD SHA |
| `oldLine` | Int | Line on start SHA that was changed |
1223 1224 1225
| `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 |
1226 1227
| `x` | Int | X position of the note |
| `y` | Int | Y position of the note |
Felipe Artur's avatar
Felipe Artur committed
1228

1229
### DiffRefs
1230

1231 1232
| Field | Type | Description |
| ----- | ---- | ----------- |
1233
| `baseSha` | String | Merge base of the branch the comment was made on |
1234
| `headSha` | String! | SHA of the HEAD at the time the comment was made |
1235
| `startSha` | String! | SHA of the branch being compared against |
1236

1237
### DiffStats
1238

1239
Changes to a single file.
1240

1241 1242
| Field | Type | Description |
| ----- | ---- | ----------- |
1243 1244 1245 1246
| `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 |

1247
### DiffStatsSummary
1248

1249
Aggregated summary of changes.
1250

1251 1252
| Field | Type | Description |
| ----- | ---- | ----------- |
1253 1254 1255
| `additions` | Int! | Number of lines added |
| `changes` | Int! | Number of lines changed |
| `deletions` | Int! | Number of lines deleted |
1256
| `fileCount` | Int! | Number of files changed |
1257

1258
### Discussion
Felipe Artur's avatar
Felipe Artur committed
1259

1260 1261
| Field | Type | Description |
| ----- | ---- | ----------- |
1262
| `createdAt` | Time! | Timestamp of the discussion's creation |
1263
| `id` | ID! | ID of this discussion |
1264
| `notes` | NoteConnection! | All notes in the discussion |
1265
| `replyId` | ID! | ID used to reply to this discussion |
1266 1267 1268 1269 1270
| `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 |

1271
### DiscussionToggleResolvePayload
1272

1273
Autogenerated return type of DiscussionToggleResolve.
1274

1275 1276
| Field | Type | Description |
| ----- | ---- | ----------- |
1277 1278 1279
| `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
1280

1281
### DismissVulnerabilityPayload
1282

1283
Autogenerated return type of DismissVulnerability.
1284

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

1291
### Environment
1292

1293
Describes where code is deployed for a project.
1294

1295 1296
| Field | Type | Description |
| ----- | ---- | ----------- |
1297
| `id` | ID! | ID of the environment |
1298
| `latestOpenedMostSevereAlert` | AlertManagementAlert | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned |
1299
| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment |
1300
| `name` | String! | Human-readable name of the environment |
1301
| `path` | String! | The path to the environment. |
1302
| `state` | String! | State of the environment, for example: available/stopped |
1303

1304 1305 1306 1307 1308 1309 1310 1311 1312
### EnvironmentsCanaryIngressUpdatePayload

Autogenerated return type of EnvironmentsCanaryIngressUpdate.

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

1313
### Epic
1314 1315

Represents an epic.
1316

1317 1318
| Field | Type | Description |
| ----- | ---- | ----------- |
1319
| `author` | User! | Author of the epic |
1320
| `children` | EpicConnection | Children (sub-epics) of the epic |
1321
| `closedAt` | Time | Timestamp of when the epic was closed |
1322
| `confidential` | Boolean | Indicates if the epic is confidential |
1323
| `createdAt` | Time | Timestamp of when the epic was created |
1324
| `currentUserTodos` | TodoConnection! | Todos for the current user |
1325
| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues |
1326
| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants |
1327
| `description` | String | Description of the epic |
1328
| `discussions` | DiscussionConnection! | All discussions on this noteable |
1329 1330 1331 1332 1333
| `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 |
1334
| `group` | Group! | Group to which the epic belongs |
1335 1336
| `hasChildren` | Boolean! | Indicates if the epic has children |
| `hasIssues` | Boolean! | Indicates if the epic has direct issues |
Florie Guibert's avatar
Florie Guibert committed
1337
| `hasParent` | Boolean! | Indicates if the epic has a parent epic |
1338
| `healthStatus` | EpicHealthStatus | Current health status of the epic |
1339 1340
| `id` | ID! | ID of the epic |
| `iid` | ID! | Internal ID of the epic |
1341 1342 1343
| `issues` | EpicIssueConnection | A list of issues associated with the epic |
| `labels` | LabelConnection | Labels assigned to the epic |
| `notes` | NoteConnection! | All notes on this noteable |
1344
| `parent` | Epic | Parent epic of the epic |
1345
| `participants` | UserConnection | List of participants for the epic |
1346 1347
| `reference` | String! | Internal reference of the epic. Returned in shortened format by default |
| `relationPath` | String | URI path of the epic-issue relationship |
1348
| `relativePosition` | Int | The relative position of the epic in the epic tree |
1349 1350 1351
| `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 |
1352 1353 1354 1355
| `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 |
1356
| `updatedAt` | Time | Timestamp of when the epic was updated |
1357
| `upvotes` | Int! | Number of upvotes the epic has received |
1358 1359
| `userDiscussionsCount` | Int! | Number of user discussions in the epic |
| `userNotesCount` | Int! | Number of user notes of the epic |
1360
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
1361 1362
| `webPath` | String! | Web path of the epic |
| `webUrl` | String! | Web URL of the epic |
1363

1364
### EpicAddIssuePayload
1365

1366
Autogenerated return type of EpicAddIssue.
1367

1368 1369
| Field | Type | Description |
| ----- | ---- | ----------- |
1370 1371 1372
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
| `epicIssue` | EpicIssue | The epic-issue relation |
1373
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1374

1375 1376 1377 1378 1379 1380
### EpicBoard

Represents an epic board.

| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
1381 1382 1383
| `id` | BoardsEpicBoardID! | Global ID of the board. |
| `lists` | EpicListConnection | Epic board lists. |
| `name` | String | Name of the board. |
1384

1385
### EpicDescendantCount
1386 1387

Counts of descendent epics.
1388

1389 1390
| Field | Type | Description |
| ----- | ---- | ----------- |
1391
| `closedEpics` | Int | Number of closed child epics |
1392
| `closedIssues` | Int | Number of closed epic issues |
1393
| `openedEpics` | Int | Number of opened child epics |
1394
| `openedIssues` | Int | Number of opened epic issues |
1395

1396
### EpicDescendantWeights
1397

1398
Total weight of open and closed descendant issues.
1399

1400 1401
| Field | Type | Description |
| ----- | ---- | ----------- |
1402 1403 1404
| `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 |

1405
### EpicHealthStatus
1406

1407
Health status of child issues.
1408

1409 1410
| Field | Type | Description |
| ----- | ---- | ----------- |
1411 1412 1413 1414
| `issuesAtRisk` | Int | Number of issues at risk |
| `issuesNeedingAttention` | Int | Number of issues that need attention |
| `issuesOnTrack` | Int | Number of issues on track |

1415
### EpicIssue
1416

1417
Relationship between an epic and an issue.
1418

1419 1420
| Field | Type | Description |
| ----- | ---- | ----------- |
1421
| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue |
1422
| `assignees` | UserConnection | Assignees of the issue |
1423
| `author` | User! | User that created the issue |
1424 1425
| `blocked` | Boolean! | Indicates the issue is blocked. |
| `blockedByCount` | Int | Count of issues blocking this issue. |
1426
| `closedAt` | Time | Timestamp of when the issue was closed |
1427
| `confidential` | Boolean! | Indicates the issue is confidential |
1428
| `createNoteEmail` | String | User specific email address for the issue |
1429
| `createdAt` | Time! | Timestamp of when the issue was created |
1430
| `currentUserTodos` | TodoConnection! | Todos for the current user |
1431 1432 1433
| `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 |
1434
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue |
1435
| `discussions` | DiscussionConnection! | All discussions on this noteable |
1436
| `downvotes` | Int! | Number of downvotes the issue has received |
1437
| `dueDate` | Time | Due date of the issue |
1438
| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled |
1439
| `epic` | Epic | Epic to which this issue belongs. |
1440
| `epicIssueId` | ID! | ID of the epic-issue relation |
1441
| `healthStatus` | HealthStatus | Current health status. |
1442 1443
| `humanTimeEstimate` | String | Human-readable time estimate of the issue |
| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue |
1444 1445
| `id` | ID | Global ID of the epic-issue relation |
| `iid` | ID! | Internal ID of the issue |
1446
| `iteration` | Iteration | Iteration of the issue. |
1447
| `labels` | LabelConnection | Labels of the issue |
1448
| `metricImages` | MetricImage! => Array | Metric images associated to the issue. |
1449
| `milestone` | Milestone | Milestone of the issue |
1450 1451
| `moved` | Boolean | Indicates if issue got moved from other project |
| `movedTo` | Issue | Updated Issue after it got moved to another project |
1452 1453
| `notes` | NoteConnection! | All notes on this noteable |
| `participants` | UserConnection | List of participants in the issue |
1454 1455
| `reference` | String! | Internal reference of the issue. Returned in shortened format by default |
| `relationPath` | String | URI path of the epic-issue relation |
1456
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) |
1457
| `severity` | IssuableSeverity | Severity level of the incident |
1458
| `slaDueAt` | Time | Timestamp of when the issue SLA expires. |
1459
| `state` | IssueState! | State of the issue |
1460
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page. |
1461
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue |
1462
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
1463
| `timeEstimate` | Int! | Time estimate of the issue |
1464 1465
| `title` | String! | Title of the issue |
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
1466
| `totalTimeSpent` | Int! | Total time reported as spent on the issue |
1467
| `type` | IssueType | Type of the issue |
1468
| `updatedAt` | Time! | Timestamp of when the issue was last updated |
1469
| `updatedBy` | User | User that last updated the issue |
1470
| `upvotes` | Int! | Number of upvotes the issue has received |
1471
| `userDiscussionsCount` | Int! | Number of user discussions in the issue |
1472 1473 1474 1475
| `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 |
1476
| `weight` | Int | Weight of the issue. |
1477

Jan Provaznik's avatar
Jan Provaznik committed
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
### EpicList

Represents an epic board list.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `id` | BoardsEpicListID! | Global ID of the board list. |
| `label` | Label | Label of the list. |
| `listType` | String! | Type of the list. |
| `position` | Int | Position of the list within the board. |
| `title` | String! | Title of the list. |

1490
### EpicPermissions
1491

1492
Check permissions for the current user on an epic.
1493

1494 1495
| Field | Type | Description |
| ----- | ---- | ----------- |
1496
| `adminEpic` | Boolean! | Indicates the user can perform `admin_epic` on this resource |
1497
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
1498 1499
| `createEpic` | Boolean! | Indicates the user can perform `create_epic` on this resource |
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
1500 1501 1502 1503
| `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 |
1504

1505
### EpicSetSubscriptionPayload
1506

1507
Autogenerated return type of EpicSetSubscription.
1508

1509 1510
| Field | Type | Description |
| ----- | ---- | ----------- |
1511 1512
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
1513
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1514

1515
### EpicTreeReorderPayload
1516

1517
Autogenerated return type of EpicTreeReorder.
1518

1519 1520
| Field | Type | Description |
| ----- | ---- | ----------- |
1521
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1522
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1523

1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
### ExternalIssue

Represents an external issue.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time | Timestamp of when the issue was created |
| `externalTracker` | String | Type of external tracker |
| `relativeReference` | String | Relative reference of the issue in the external tracker |
| `status` | String | Status of the issue in the external tracker |
| `title` | String | Title of the issue in the external tracker |
| `updatedAt` | Time | Timestamp of when the issue was updated |
| `webUrl` | String | URL to the issue in the external tracker |

1538
### GeoNode
1539

1540 1541
| Field | Type | Description |
| ----- | ---- | ----------- |
1542 1543 1544 1545 1546
| `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 |
1547
| `mergeRequestDiffRegistries` | MergeRequestDiffRegistryConnection | Find merge request diff registries on this Geo node |
1548 1549
| `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 |
1550
| `packageFileRegistries` | PackageFileRegistryConnection | Package file registries of the GeoNode |
1551 1552
| `primary` | Boolean | Indicates whether this Geo node is the primary |
| `reposMaxCapacity` | Int | The maximum concurrency of repository backfill for this secondary node |
1553
| `selectiveSyncNamespaces` | NamespaceConnection | The namespaces that should be synced, if `selective_sync_type` == `namespaces` |
1554 1555
| `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 |
1556
| `snippetRepositoryRegistries` | SnippetRepositoryRegistryConnection | Find snippet repository registries on this Geo node |
1557
| `syncObjectStorage` | Boolean | Indicates if this secondary node will replicate blobs in Object Storage |
1558
| `terraformStateVersionRegistries` | TerraformStateVersionRegistryConnection | Find terraform state version registries on this Geo node |
1559 1560 1561
| `url` | String | The user-facing URL for this Geo node |
| `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node |

1562
### GrafanaIntegration
1563

1564 1565
| Field | Type | Description |
| ----- | ---- | ----------- |
1566 1567
| `createdAt` | Time! | Timestamp of the issue's creation |
| `enabled` | Boolean! | Indicates whether Grafana integration is enabled |
1568
| `grafanaUrl` | String! | URL for the Grafana host for the Grafana integration |
1569
| `id` | ID! | Internal ID of the Grafana integration |
1570 1571
| `updatedAt` | Time! | Timestamp of the issue's last activity |

1572
### Group
Felipe Artur's avatar
Felipe Artur committed
1573

1574 1575
| Field | Type | Description |
| ----- | ---- | ----------- |
1576
| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes |
1577
| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes |
1578 1579
| `autoDevopsEnabled` | Boolean | Indicates whether Auto DevOps is enabled for all projects within this group |
| `avatarUrl` | String | Avatar URL of the group |
1580
| `board` | Board | A single board of the group |
1581
| `boards` | BoardConnection | Boards of the group |
1582
| `codeCoverageActivities` | CodeCoverageActivityConnection | Represents the code coverage activity for this group |
1583
| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. |
1584 1585
| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the group |
| `containerRepositoriesCount` | Int! | Number of container repositories in the group |
1586
| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit |
1587
| `customEmoji` | CustomEmojiConnection | Custom emoji within this namespace Available only when feature flag `custom_emoji` is enabled. |
1588
| `description` | String | Description of the namespace |
Felipe Artur's avatar
Felipe Artur committed
1589
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1590 1591
| `emailsDisabled` | Boolean | Indicates if a group has email notifications disabled |
| `epic` | Epic | Find a single epic |
1592 1593
| `epicBoard` | EpicBoard | Find a single epic board |
| `epicBoards` | EpicBoardConnection | Find epic boards |
1594
| `epics` | EpicConnection | Find epics |
1595 1596 1597
| `epicsEnabled` | Boolean | Indicates if Epics are enabled for namespace |
| `fullName` | String! | Full name of the namespace |
| `fullPath` | ID! | Full path of the namespace |
1598
| `groupMembers` | GroupMemberConnection | A membership of a user within this group |
1599 1600
| `groupTimelogsEnabled` | Boolean | Indicates if Group timelogs are enabled for namespace |
| `id` | ID! | ID of the namespace |
1601
| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase |
1602 1603
| `issues` | IssueConnection | Issues for projects in this group |
| `iterations` | IterationConnection | Find iterations |
1604
| `label` | Label | A label available on this group |
1605
| `labels` | LabelConnection | Labels available on this group |
1606
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace |
1607
| `mentionsDisabled` | Boolean | Indicates if a group is disabled from getting mentioned |
1608 1609
| `mergeRequests` | MergeRequestConnection | Merge requests for projects in this group |
| `milestones` | MilestoneConnection | Milestones of the group |
1610
| `name` | String! | Name of the namespace |
1611
| `packageSettings` | PackageSettings | The package settings for the namespace |
1612 1613 1614
| `parent` | Group | Parent group |
| `path` | String! | Path of the namespace |
| `projectCreationLevel` | String | The permission level required to create projects in the group |
1615
| `projects` | ProjectConnection! | Projects within this namespace |
1616
| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit |
1617
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace |
1618
| `requireTwoFactorAuthentication` | Boolean | Indicates if all users in this group are required to set up two-factor authentication |
1619
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces |
1620
| `shareWithGroupLock` | Boolean | Indicates if sharing a project with another group within this group is prevented |
1621
| `stats` | GroupStats | Group statistics |
1622
| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes |
1623
| `subgroupCreationLevel` | String | The permission level required to create subgroups within the group |
1624
| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active |
1625
| `timelogs` | TimelogConnection! | Time logged in issues by group members |
1626 1627
| `totalRepositorySize` | Float | Total repository size of all projects in the root namespace in bytes |
| `totalRepositorySizeExcess` | Float | Total excess repository size of all projects in the root namespace in bytes |
1628
| `twoFactorGracePeriod` | Int | Time before two-factor authentication is enforced |
1629 1630
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |
| `visibility` | String | Visibility of the namespace |
1631 1632
| `vulnerabilities` | VulnerabilityConnection | Vulnerabilities reported on the projects in the group and its subgroups |
| `vulnerabilitiesCountByDay` | VulnerabilitiesCountByDayConnection | Number of vulnerabilities per day for the projects in the group and its subgroups |
1633
| `vulnerabilitiesCountByDayAndSeverity` **{warning-solid}** | VulnerabilitiesCountByDayAndSeverityConnection | **Deprecated:** Use `vulnerabilitiesCountByDay`. Deprecated in 13.3. |
1634
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade |
1635
| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the project vulnerabilties of the group and its subgroups |
1636
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the group and its subgroups |
1637
| `webUrl` | String! | Web URL of the group |
Felipe Artur's avatar
Felipe Artur committed
1638

1639
### GroupMember
1640

1641
Represents a Group Membership.
1642

1643 1644
| Field | Type | Description |
| ----- | ---- | ----------- |
1645 1646 1647 1648 1649
| `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 |
1650
| `id` | ID! | ID of the member |
1651
| `updatedAt` | Time | Date and time the membership was last updated |
1652
| `user` | User! | User that is associated with the member object |
1653 1654
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |

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

1657 1658
| Field | Type | Description |
| ----- | ---- | ----------- |
1659
| `readGroup` | Boolean! | Indicates the user can perform `read_group` on this resource |
Felipe Artur's avatar
Felipe Artur committed
1660

1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
### GroupReleaseStats

Contains release-related statistics about a group.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `releasesCount` | Int | Total number of releases in all descendant projects of the group. Will always return `null` if `group_level_release_statistics` feature flag is disabled |
| `releasesPercentage` | Int | Percentage of the group's descendant projects that have at least one release. Will always return `null` if `group_level_release_statistics` feature flag is disabled |

### GroupStats

Contains statistics about a group.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `releaseStats` | GroupReleaseStats | Statistics related to releases within the group |

1678 1679 1680 1681 1682 1683 1684 1685
### HttpIntegrationCreatePayload

Autogenerated return type of HttpIntegrationCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
| `integration` | AlertManagementHttpIntegration | The HTTP integration |

### HttpIntegrationDestroyPayload

Autogenerated return type of HttpIntegrationDestroy.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `integration` | AlertManagementHttpIntegration | The HTTP integration |
1697 1698 1699 1700 1701 1702 1703 1704 1705

### HttpIntegrationResetTokenPayload

Autogenerated return type of HttpIntegrationResetToken.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1706
| `integration` | AlertManagementHttpIntegration | The HTTP integration |
1707 1708 1709 1710 1711 1712 1713 1714 1715

### HttpIntegrationUpdatePayload

Autogenerated return type of HttpIntegrationUpdate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1716
| `integration` | AlertManagementHttpIntegration | The HTTP integration |
1717

1718 1719 1720 1721 1722 1723
### IncidentManagementOncallRotation

Describes an incident management on-call rotation.

| Field | Type | Description |
| ----- | ---- | ----------- |
1724 1725 1726 1727 1728 1729
| `id` | IncidentManagementOncallRotationID! | ID of the on-call rotation. |
| `length` | Int | Length of the on-call schedule, in the units specified by lengthUnit. |
| `lengthUnit` | OncallRotationUnitEnum | Unit of the on-call rotation length. |
| `name` | String! | Name of the on-call rotation. |
| `participants` | OncallParticipantTypeConnection | Participants of the on-call rotation. |
| `startsAt` | Time | Start date of the on-call rotation. |
1730

1731 1732 1733 1734 1735 1736 1737 1738 1739
### IncidentManagementOncallSchedule

Describes an incident management on-call schedule.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `description` | String | Description of the on-call schedule |
| `iid` | ID! | Internal ID of the on-call schedule |
| `name` | String! | Name of the on-call schedule |
1740
| `rotations` | IncidentManagementOncallRotationConnection! | On-call rotations for the on-call schedule |
1741 1742
| `timezone` | String! | Time zone of the on-call schedule |

1743
### InstanceSecurityDashboard
1744

1745 1746
| Field | Type | Description |
| ----- | ---- | ----------- |
1747
| `projects` | ProjectConnection! | Projects selected in Instance Security Dashboard |
1748
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade |
1749
| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the vulnerabilties from projects selected in Instance Security Dashboard |
1750
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard |
1751

1752
### InstanceStatisticsMeasurement
1753

1754
Represents a recorded measurement (object count) for the Admins.
1755

1756 1757
| Field | Type | Description |
| ----- | ---- | ----------- |
1758 1759 1760 1761
| `count` | Int! | Object count |
| `identifier` | MeasurementIdentifier! | The type of objects being measured |
| `recordedAt` | Time | The time the measurement was recorded |

1762
### Issue
Felipe Artur's avatar
Felipe Artur committed
1763

1764 1765
| Field | Type | Description |
| ----- | ---- | ----------- |
1766
| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue |
1767
| `assignees` | UserConnection | Assignees of the issue |
1768
| `author` | User! | User that created the issue |
1769 1770
| `blocked` | Boolean! | Indicates the issue is blocked. |
| `blockedByCount` | Int | Count of issues blocking this issue. |
1771
| `closedAt` | Time | Timestamp of when the issue was closed |
1772
| `confidential` | Boolean! | Indicates the issue is confidential |
1773
| `createNoteEmail` | String | User specific email address for the issue |
1774
| `createdAt` | Time! | Timestamp of when the issue was created |
1775
| `currentUserTodos` | TodoConnection! | Todos for the current user |
1776 1777 1778
| `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 |
1779
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue |
1780
| `discussions` | DiscussionConnection! | All discussions on this noteable |
1781
| `downvotes` | Int! | Number of downvotes the issue has received |
1782
| `dueDate` | Time | Due date of the issue |
1783
| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled |
1784
| `epic` | Epic | Epic to which this issue belongs. |
1785
| `healthStatus` | HealthStatus | Current health status. |
1786 1787
| `humanTimeEstimate` | String | Human-readable time estimate of the issue |
| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue |
1788
| `id` | ID! | ID of the issue |
1789
| `iid` | ID! | Internal ID of the issue |
1790
| `iteration` | Iteration | Iteration of the issue. |
1791
| `labels` | LabelConnection | Labels of the issue |
1792
| `metricImages` | MetricImage! => Array | Metric images associated to the issue. |
1793
| `milestone` | Milestone | Milestone of the issue |
1794 1795
| `moved` | Boolean | Indicates if issue got moved from other project |
| `movedTo` | Issue | Updated Issue after it got moved to another project |
1796 1797
| `notes` | NoteConnection! | All notes on this noteable |
| `participants` | UserConnection | List of participants in the issue |
1798 1799
| `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) |
1800
| `severity` | IssuableSeverity | Severity level of the incident |
1801
| `slaDueAt` | Time | Timestamp of when the issue SLA expires. |
1802
| `state` | IssueState! | State of the issue |
1803
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page. |
1804 1805
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue |
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
1806
| `timeEstimate` | Int! | Time estimate of the issue |
1807 1808
| `title` | String! | Title of the issue |
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
1809
| `totalTimeSpent` | Int! | Total time reported as spent on the issue |
1810
| `type` | IssueType | Type of the issue |
1811
| `updatedAt` | Time! | Timestamp of when the issue was last updated |
1812
| `updatedBy` | User | User that last updated the issue |
1813
| `upvotes` | Int! | Number of upvotes the issue has received |
1814
| `userDiscussionsCount` | Int! | Number of user discussions in the issue |
1815 1816 1817 1818
| `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 |
1819
| `weight` | Int | Weight of the issue. |
Felipe Artur's avatar
Felipe Artur committed
1820

1821
### IssueMoveListPayload
1822

1823
Autogenerated return type of IssueMoveList.
1824

1825 1826
| Field | Type | Description |
| ----- | ---- | ----------- |
1827 1828 1829 1830
| `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 |

Felipe Artur's avatar
Felipe Artur committed
1831 1832 1833 1834 1835 1836 1837 1838
### IssueMovePayload

Autogenerated return type of IssueMove.

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

1841
### IssuePermissions
1842

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

1845 1846
| Field | Type | Description |
| ----- | ---- | ----------- |
1847 1848
| `adminIssue` | Boolean! | Indicates the user can perform `admin_issue` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
1849
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
1850
| `destroyDesign` | Boolean! | Indicates the user can perform `destroy_design` on this resource |
1851 1852 1853 1854
| `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
1855

1856
### IssueSetAssigneesPayload
1857

1858
Autogenerated return type of IssueSetAssignees.
1859

1860 1861
| Field | Type | Description |
| ----- | ---- | ----------- |
1862 1863 1864 1865
| `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 |

1866
### IssueSetConfidentialPayload
1867

1868
Autogenerated return type of IssueSetConfidential.
1869

1870 1871
| Field | Type | Description |
| ----- | ---- | ----------- |
1872
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1873
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1874 1875
| `issue` | Issue | The issue after mutation |

1876
### IssueSetDueDatePayload
1877

1878
Autogenerated return type of IssueSetDueDate.
1879

1880 1881
| Field | Type | Description |
| ----- | ---- | ----------- |
1882 1883 1884 1885
| `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 |

1886
### IssueSetEpicPayload
1887

1888
Autogenerated return type of IssueSetEpic.
1889

1890 1891
| Field | Type | Description |
| ----- | ---- | ----------- |
1892
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1893
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1894 1895
| `issue` | Issue | The issue after mutation |

1896
### IssueSetIterationPayload
1897

1898
Autogenerated return type of IssueSetIteration.
1899

1900 1901
| Field | Type | Description |
| ----- | ---- | ----------- |
1902 1903 1904 1905
| `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 |

1906
### IssueSetLockedPayload
1907

1908
Autogenerated return type of IssueSetLocked.
1909

1910 1911
| Field | Type | Description |
| ----- | ---- | ----------- |
1912
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1913 1914 1915
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |

1916
### IssueSetSeverityPayload
1917

1918
Autogenerated return type of IssueSetSeverity.
1919

1920 1921
| Field | Type | Description |
| ----- | ---- | ----------- |
1922
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1923 1924 1925
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue after mutation |

1926
### IssueSetSubscriptionPayload
1927

1928
Autogenerated return type of IssueSetSubscription.
1929

1930 1931
| Field | Type | Description |
| ----- | ---- | ----------- |
1932 1933 1934 1935
| `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 |

1936
### IssueSetWeightPayload
1937

1938
Autogenerated return type of IssueSetWeight.
1939

1940 1941
| Field | Type | Description |
| ----- | ---- | ----------- |
1942
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1943
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1944 1945
| `issue` | Issue | The issue after mutation |

1946
### IssueStatusCountsType
Sean Arnold's avatar
Sean Arnold committed
1947

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

1950 1951
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
1952 1953 1954 1955
| `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 |

1956
### Iteration
1957 1958 1959

Represents an iteration object.

1960 1961
| Field | Type | Description |
| ----- | ---- | ----------- |
1962 1963
| `createdAt` | Time! | Timestamp of iteration creation |
| `description` | String | Description of the iteration |
1964
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1965 1966
| `dueDate` | Time | Timestamp of the iteration due date |
| `id` | ID! | ID of the iteration |
1967
| `iid` | ID! | Internal ID of the iteration |
1968
| `report` | TimeboxReport | Historically accurate report about the timebox |
1969 1970
| `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 |
1971 1972 1973 1974 1975 1976 1977
| `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 |

1978
### JiraImport
1979

1980 1981
| Field | Type | Description |
| ----- | ---- | ----------- |
1982
| `createdAt` | Time | Timestamp of when the Jira import was created |
1983 1984
| `failedToImportCount` | Int! | Count of issues that failed to import |
| `importedIssuesCount` | Int! | Count of issues that were successfully imported |
1985
| `jiraProjectKey` | String! | Project key for the imported Jira project |
1986
| `scheduledAt` | Time | Timestamp of when the Jira import was scheduled |
1987
| `scheduledBy` | User | User that started the Jira import |
1988
| `totalIssueCount` | Int! | Total count of issues that were attempted to import |
1989

1990
### JiraImportStartPayload
1991

1992
Autogenerated return type of JiraImportStart.
1993

1994 1995
| Field | Type | Description |
| ----- | ---- | ----------- |
1996
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1997
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1998 1999
| `jiraImport` | JiraImport | The Jira import data after mutation |

2000
### JiraImportUsersPayload
2001

2002
Autogenerated return type of JiraImportUsers.
2003

2004 2005
| Field | Type | Description |
| ----- | ---- | ----------- |
2006 2007 2008 2009
| `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. |

2010
### JiraProject
2011

2012 2013
| Field | Type | Description |
| ----- | ---- | ----------- |
2014 2015 2016 2017
| `key` | String! | Key of the Jira project |
| `name` | String | Name of the Jira project |
| `projectId` | Int! | ID of the Jira project |

2018
### JiraService
2019

2020 2021
| Field | Type | Description |
| ----- | ---- | ----------- |
2022
| `active` | Boolean | Indicates if the service is active |
2023
| `projects` | JiraProjectConnection | List of all Jira projects fetched through Jira REST API |
2024 2025
| `type` | String | Class name of the service |

2026
### JiraUser
2027

2028 2029
| Field | Type | Description |
| ----- | ---- | ----------- |
2030 2031 2032
| `gitlabId` | Int | ID of the matched GitLab user |
| `gitlabName` | String | Name of the matched GitLab user |
| `gitlabUsername` | String | Username of the matched GitLab user |
2033
| `jiraAccountId` | String! | Account ID of the Jira user |
2034 2035 2036
| `jiraDisplayName` | String! | Display name of the Jira user |
| `jiraEmail` | String | Email of the Jira user, returned only for users with public emails |

2037
### Label
Felipe Artur's avatar
Felipe Artur committed
2038

2039 2040
| Field | Type | Description |
| ----- | ---- | ----------- |
2041
| `color` | String! | Background color of the label |
Marcel Amirault's avatar
Marcel Amirault committed
2042
| `description` | String | Description of the label (Markdown rendered as HTML for caching) |
Felipe Artur's avatar
Felipe Artur committed
2043
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2044
| `id` | ID! | Label ID |
2045
| `textColor` | String! | Text color of the label |
2046
| `title` | String! | Content of the label |
Felipe Artur's avatar
Felipe Artur committed
2047

2048 2049 2050 2051 2052 2053 2054 2055 2056 2057
### LabelCreatePayload

Autogenerated return type of LabelCreate.

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

2058
### MarkAsSpamSnippetPayload
2059

2060
Autogenerated return type of MarkAsSpamSnippet.
2061

2062 2063
| Field | Type | Description |
| ----- | ---- | ----------- |
2064
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2065
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2066 2067
| `snippet` | Snippet | The snippet after mutation |

2068
### MergeRequest
Felipe Artur's avatar
Felipe Artur committed
2069

2070 2071
| Field | Type | Description |
| ----- | ---- | ----------- |
2072
| `allowCollaboration` | Boolean | Indicates if members of the target project can push to the fork |
2073 2074
| `approvalsLeft` | Int | Number of approvals left |
| `approvalsRequired` | Int | Number of approvals required |
2075
| `approved` | Boolean! | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. |
2076 2077
| `approvedBy` | UserConnection | Users who approved the merge request |
| `assignees` | UserConnection | Assignees of the merge request |
2078
| `author` | User | User who created this merge request |
2079
| `autoMergeEnabled` | Boolean! | Indicates if auto merge is enabled for the merge request |
2080
| `availableAutoMergeStrategies` | String! => Array | Array of available auto merge strategies |
2081
| `commitCount` | Int | Number of commits in the merge request |
2082
| `commitsWithoutMergeCommits` | CommitConnection | Merge request commits excluding merge commits |
2083
| `conflicts` | Boolean! | Indicates if the merge request has conflicts |
2084
| `createdAt` | Time! | Timestamp of when the merge request was created |
2085
| `currentUserTodos` | TodoConnection! | Todos for the current user |
2086
| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request |
2087
| `defaultMergeCommitMessageWithDescription` | String | Default merge commit message of the merge request with description |
2088
| `defaultSquashCommitMessage` | String | Default squash commit message of the merge request |
Marcel Amirault's avatar
Marcel Amirault committed
2089
| `description` | String | Description of the merge request (Markdown rendered as HTML for caching) |
Felipe Artur's avatar
Felipe Artur committed
2090
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2091
| `diffHeadSha` | String | Diff head SHA of the merge request |
2092
| `diffRefs` | DiffRefs | References of the base SHA, the head SHA, and the start SHA for this merge request |
2093 2094
| `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 |
2095
| `discussionLocked` | Boolean! | Indicates if comments on the merge request are locked to members only |
2096
| `discussions` | DiscussionConnection! | All discussions on this noteable |
2097
| `downvotes` | Int! | Number of downvotes for the merge request |
2098
| `forceRemoveSourceBranch` | Boolean | Indicates if the project settings will lead to source branch deletion after merge |
2099
| `hasCi` | Boolean! | Indicates if the merge request has CI |
2100 2101
| `headPipeline` | Pipeline | The pipeline running on the branch HEAD of the merge request |
| `id` | ID! | ID of the merge request |
2102
| `iid` | String! | Internal ID of the merge request |
2103
| `inProgressMergeCommitSha` | String | Commit SHA of the merge request if merge is in progress |
2104
| `labels` | LabelConnection | Labels of the merge request |
2105 2106
| `mergeCommitSha` | String | SHA of the merge request commit (set once merged) |
| `mergeError` | String | Error message due to a merge error |
2107
| `mergeOngoing` | Boolean! | Indicates if a merge is currently occurring |
2108
| `mergeStatus` | String | Status of the merge request |
2109
| `mergeTrainsCount` | Int |  |
2110
| `mergeWhenPipelineSucceeds` | Boolean | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS) |
2111
| `mergeable` | Boolean! | Indicates if the merge request is mergeable |
2112
| `mergeableDiscussionsState` | Boolean | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged |
2113
| `mergedAt` | Time | Timestamp of when the merge request was merged, null if not merged |
2114
| `milestone` | Milestone | The milestone of the merge request |
2115
| `notes` | NoteConnection! | All notes on this noteable |
2116
| `participants` | UserConnection | Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. |
2117
| `pipelines` | PipelineConnection | Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned. |
2118 2119 2120 2121 2122
| `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 |
2123
| `reviewers` | UserConnection | Users from whom a review has been requested. |
2124
| `securityAutoFix` | Boolean | Indicates if the merge request is created by @GitLab-Security-Bot. |
2125 2126 2127 2128
| `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 |
2129
| `sourceBranchProtected` | Boolean! | Indicates if the source branch is protected |
2130 2131
| `sourceProject` | Project | Source project of the merge request |
| `sourceProjectId` | Int | ID of the merge request source project |
2132
| `squash` | Boolean! | Indicates if squash on merge is enabled |
2133
| `squashOnMerge` | Boolean! | Indicates if squash on merge is enabled |
2134
| `state` | MergeRequestState! | State of the merge request |
2135
| `subscribed` | Boolean! | Indicates if the currently logged in user is subscribed to this merge request |
2136
| `targetBranch` | String! | Target branch of the merge request |
2137
| `targetBranchExists` | Boolean! | Indicates if the target branch of the merge request exists |
2138 2139 2140
| `targetProject` | Project! | Target project of the merge request |
| `targetProjectId` | Int! | ID of the merge request target project |
| `taskCompletionStatus` | TaskCompletionStatus! | Completion status of tasks |
2141
| `timeEstimate` | Int! | Time estimate of the merge request |
2142 2143
| `title` | String! | Title of the merge request |
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
2144
| `totalTimeSpent` | Int! | Total time reported as spent on the merge request |
2145 2146
| `updatedAt` | Time! | Timestamp of when the merge request was last updated |
| `upvotes` | Int! | Number of upvotes for the merge request |
2147
| `userDiscussionsCount` | Int | Number of user discussions in the merge request |
2148 2149 2150 2151
| `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
2152

2153
### MergeRequestCreatePayload
2154

2155
Autogenerated return type of MergeRequestCreate.
2156

2157 2158
| Field | Type | Description |
| ----- | ---- | ----------- |
2159 2160 2161 2162
| `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 |

2163 2164
### MergeRequestDiffRegistry

2165
Represents the Geo sync and verification state of a Merge Request diff.
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177

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

2178
### MergeRequestPermissions
2179

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

2182 2183
| Field | Type | Description |
| ----- | ---- | ----------- |
2184
| `adminMergeRequest` | Boolean! | Indicates the user can perform `admin_merge_request` on this resource |
2185
| `canMerge` | Boolean! | Indicates the user can perform `can_merge` on this resource |
2186
| `cherryPickOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource |
2187 2188
| `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 |
2189
| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource |
2190 2191
| `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 |
2192
| `updateMergeRequest` | Boolean! | Indicates the user can perform `update_merge_request` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2193

2194
### MergeRequestSetAssigneesPayload
2195

2196
Autogenerated return type of MergeRequestSetAssignees.
2197

2198 2199
| Field | Type | Description |
| ----- | ---- | ----------- |
2200
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2201
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2202 2203
| `mergeRequest` | MergeRequest | The merge request after mutation |

2204
### MergeRequestSetLabelsPayload
2205

2206
Autogenerated return type of MergeRequestSetLabels.
Mario de la Ossa's avatar
Mario de la Ossa committed
2207

2208 2209
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
2210
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2211
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
2212 2213
| `mergeRequest` | MergeRequest | The merge request after mutation |

2214
### MergeRequestSetLockedPayload
2215

2216
Autogenerated return type of MergeRequestSetLocked.
Mario de la Ossa's avatar
Mario de la Ossa committed
2217

2218 2219
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
2220
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2221
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
2222 2223
| `mergeRequest` | MergeRequest | The merge request after mutation |

2224
### MergeRequestSetMilestonePayload
2225

2226
Autogenerated return type of MergeRequestSetMilestone.
2227

2228 2229
| Field | Type | Description |
| ----- | ---- | ----------- |
2230
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2231
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
2232 2233
| `mergeRequest` | MergeRequest | The merge request after mutation |

2234
### MergeRequestSetSubscriptionPayload
2235

2236
Autogenerated return type of MergeRequestSetSubscription.
Mario de la Ossa's avatar
Mario de la Ossa committed
2237

2238 2239
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
2240
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2241
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2242 2243
| `mergeRequest` | MergeRequest | The merge request after mutation |

2244
### MergeRequestSetWipPayload
2245

2246
Autogenerated return type of MergeRequestSetWip.
Felipe Artur's avatar
Felipe Artur committed
2247

2248 2249
| Field | Type | Description |
| ----- | ---- | ----------- |
Felipe Artur's avatar
Felipe Artur committed
2250
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2251
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
2252 2253
| `mergeRequest` | MergeRequest | The merge request after mutation |

2254
### MergeRequestUpdatePayload
2255

2256
Autogenerated return type of MergeRequestUpdate.
2257

2258 2259
| Field | Type | Description |
| ----- | ---- | ----------- |
2260
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2261
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
2262 2263
| `mergeRequest` | MergeRequest | The merge request after mutation |

2264
### Metadata
Felipe Artur's avatar
Felipe Artur committed
2265

2266 2267
| Field | Type | Description |
| ----- | ---- | ----------- |
2268
| `revision` | String! | Revision |
2269
| `version` | String! | Version |
Felipe Artur's avatar
Felipe Artur committed
2270

2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282
### MetricImage

Represents a metric image upload.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `fileName` | String | File name of the metric image |
| `filePath` | String | File path of the metric image |
| `id` | ID! | ID of the metric upload |
| `iid` | ID! | Internal ID of the metric upload |
| `url` | String! | URL of the metric source |

2283
### MetricsDashboard
2284

2285 2286
| Field | Type | Description |
| ----- | ---- | ----------- |
2287
| `annotations` | MetricsDashboardAnnotationConnection | Annotations added to the dashboard |
2288
| `path` | String | Path to a file with the dashboard definition |
2289
| `schemaValidationWarnings` | String! => Array | Dashboard schema validation warnings |
2290

2291
### MetricsDashboardAnnotation
2292

2293 2294
| Field | Type | Description |
| ----- | ---- | ----------- |
2295
| `description` | String | Description of the annotation |
2296
| `endingAt` | Time | Timestamp marking end of annotated time span |
2297 2298
| `id` | ID! | ID of the annotation |
| `panelId` | String | ID of a dashboard panel to which the annotation should be scoped |
2299
| `startingAt` | Time | Timestamp marking start of annotated time span |
2300

2301
### Milestone
Felipe Artur's avatar
Felipe Artur committed
2302

2303 2304
Represents a milestone.

2305 2306
| Field | Type | Description |
| ----- | ---- | ----------- |
2307
| `createdAt` | Time! | Timestamp of milestone creation |
2308 2309
| `description` | String | Description of the milestone |
| `dueDate` | Time | Timestamp of the milestone due date |
2310
| `groupMilestone` | Boolean! | Indicates if milestone is at group level |
2311
| `id` | ID! | ID of the milestone |
2312
| `projectMilestone` | Boolean! | Indicates if milestone is at project level |
2313
| `report` | TimeboxReport | Historically accurate report about the timebox |
2314
| `startDate` | Time | Timestamp of the milestone start date |
2315
| `state` | MilestoneStateEnum! | State of the milestone |
2316
| `stats` | MilestoneStats | Milestone statistics |
2317
| `subgroupMilestone` | Boolean! | Indicates if milestone is at subgroup level |
2318
| `title` | String! | Title of the milestone |
2319
| `updatedAt` | Time! | Timestamp of last milestone update |
2320
| `webPath` | String! | Web path of the milestone |
Felipe Artur's avatar
Felipe Artur committed
2321

2322
### MilestoneStats
2323

2324
Contains statistics about a milestone.
2325

2326 2327
| Field | Type | Description |
| ----- | ---- | ----------- |
2328 2329 2330
| `closedIssuesCount` | Int | Number of closed issues associated with the milestone |
| `totalIssuesCount` | Int | Total number of issues associated with the milestone |

2331
### Namespace
Felipe Artur's avatar
Felipe Artur committed
2332

2333 2334
| Field | Type | Description |
| ----- | ---- | ----------- |
2335
| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes |
2336
| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes |
2337
| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. |
2338
| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit |
2339
| `description` | String | Description of the namespace |
Felipe Artur's avatar
Felipe Artur committed
2340
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2341 2342 2343
| `fullName` | String! | Full name of the namespace |
| `fullPath` | ID! | Full path of the namespace |
| `id` | ID! | ID of the namespace |
2344
| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase |
2345
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace |
2346
| `name` | String! | Name of the namespace |
2347
| `packageSettings` | PackageSettings | The package settings for the namespace |
2348
| `path` | String! | Path of the namespace |
2349
| `projects` | ProjectConnection! | Projects within this namespace |
2350
| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit |
2351 2352
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace |
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces |
2353
| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes |
2354
| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active |
2355 2356
| `totalRepositorySize` | Float | Total repository size of all projects in the root namespace in bytes |
| `totalRepositorySizeExcess` | Float | Total excess repository size of all projects in the root namespace in bytes |
2357
| `visibility` | String | Visibility of the namespace |
Felipe Artur's avatar
Felipe Artur committed
2358

2359
### NamespaceIncreaseStorageTemporarilyPayload
2360

2361
Autogenerated return type of NamespaceIncreaseStorageTemporarily.
2362

2363 2364
| Field | Type | Description |
| ----- | ---- | ----------- |
2365 2366 2367 2368
| `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 |

2369
### Note
Felipe Artur's avatar
Felipe Artur committed
2370

2371 2372
| Field | Type | Description |
| ----- | ---- | ----------- |
2373 2374
| `author` | User! | User who wrote this note |
| `body` | String! | Content of the note |
Felipe Artur's avatar
Felipe Artur committed
2375
| `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` |
2376
| `confidential` | Boolean | Indicates if this note is confidential |
2377
| `createdAt` | Time! | Timestamp of the note creation |
Felipe Artur's avatar
Felipe Artur committed
2378
| `discussion` | Discussion | The discussion this note is a part of |
2379 2380 2381
| `id` | ID! | ID of the note |
| `position` | DiffPosition | The position of this note on a diff |
| `project` | Project | Project associated with the note |
2382 2383 2384 2385
| `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 |
2386
| `system` | Boolean! | Indicates whether this note was created by the system or by a user |
2387
| `systemNoteIconName` | String | Name of the icon corresponding to a system note |
2388 2389
| `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
2390

2391
### NotePermissions
Felipe Artur's avatar
Felipe Artur committed
2392

2393 2394
| Field | Type | Description |
| ----- | ---- | ----------- |
2395 2396
| `adminNote` | Boolean! | Indicates the user can perform `admin_note` on this resource |
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
2397 2398
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
| `readNote` | Boolean! | Indicates the user can perform `read_note` on this resource |
2399
| `repositionNote` | Boolean! | Indicates the user can perform `reposition_note` on this resource |
2400
| `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2401

2402 2403 2404 2405 2406 2407 2408 2409
### OncallParticipantType

The rotation participant and color palette.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `colorPalette` | String | The color palette to assign to the on-call user. For example "blue". |
| `colorWeight` | String | The color weight to assign to for the on-call user, for example "500". Max 4 chars. For easy identification of the user. |
2410 2411
| `id` | IncidentManagementOncallParticipantID! | ID of the on-call participant. |
| `user` | User! | The user who is participating. |
2412

2413 2414 2415 2416 2417 2418 2419 2420
### OncallRotationCreatePayload

Autogenerated return type of OncallRotationCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2421
| `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation. |
2422

2423 2424 2425 2426 2427 2428 2429
### OncallScheduleCreatePayload

Autogenerated return type of OncallScheduleCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule |

### OncallScheduleDestroyPayload

Autogenerated return type of OncallScheduleDestroy.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2440
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2441 2442 2443 2444 2445 2446 2447 2448
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule |

### OncallScheduleUpdatePayload

Autogenerated return type of OncallScheduleUpdate.

| Field | Type | Description |
| ----- | ---- | ----------- |
2449
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2450 2451 2452
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule |

2453
### Package
2454

2455
Represents a package.
2456

2457 2458
| Field | Type | Description |
| ----- | ---- | ----------- |
2459 2460 2461 2462 2463 2464 2465
| `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 |

2466
### PackageFileRegistry
2467

2468
Represents the Geo sync and verification state of a package file.
2469

2470 2471
| Field | Type | Description |
| ----- | ---- | ----------- |
2472 2473 2474 2475 2476 2477 2478 2479 2480
| `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 |

2481 2482 2483 2484 2485 2486 2487 2488 2489
### PackageSettings

Namespace-level Package Registry settings.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `mavenDuplicateExceptionRegex` | UntrustedRegexp | When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
| `mavenDuplicatesAllowed` | Boolean! | Indicates whether duplicate Maven packages are allowed for this namespace. |

2490
### PageInfo
2491

2492
Information about pagination in a connection..
Felipe Artur's avatar
Felipe Artur committed
2493

2494 2495
| Field | Type | Description |
| ----- | ---- | ----------- |
2496
| `endCursor` | String | When paginating forwards, the cursor to continue. |
Felipe Artur's avatar
Felipe Artur committed
2497 2498 2499 2500
| `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. |

2501
### Pipeline
Felipe Artur's avatar
Felipe Artur committed
2502

2503 2504
| Field | Type | Description |
| ----- | ---- | ----------- |
2505
| `active` | Boolean! | Indicates if the pipeline is active |
2506
| `beforeSha` | String | Base SHA of the source branch |
lauraMon's avatar
lauraMon committed
2507
| `cancelable` | Boolean! | Specifies if a pipeline can be canceled |
2508
| `committedAt` | Time | Timestamp of the pipeline's commit |
2509
| `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) |
2510 2511 2512
| `coverage` | Float | Coverage percentage |
| `createdAt` | Time! | Timestamp of the pipeline's creation |
| `detailedStatus` | DetailedStatus! | Detailed status of the pipeline |
2513
| `downstream` | PipelineConnection | Pipelines this pipeline will trigger |
2514 2515
| `duration` | Int | Duration of the pipeline in seconds |
| `finishedAt` | Time | Timestamp of the pipeline's completion |
2516
| `id` | ID! | ID of the pipeline |
2517
| `iid` | String! | Internal ID of the pipeline |
2518
| `jobs` | CiJobConnection | Jobs belonging to the pipeline |
2519 2520
| `path` | String | Relative path to the pipeline's page |
| `project` | Project | Project the pipeline belongs to |
lauraMon's avatar
lauraMon committed
2521
| `retryable` | Boolean! | Specifies if a pipeline can be retried |
2522
| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline |
2523
| `sha` | String! | SHA of the pipeline's commit |
2524
| `sourceJob` | CiJob | Job where pipeline was triggered from |
2525
| `stages` | CiStageConnection | Stages of the pipeline |
2526
| `startedAt` | Time | Timestamp when the pipeline was started |
2527
| `status` | PipelineStatusEnum! | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED) |
2528
| `updatedAt` | Time! | Timestamp of the pipeline's last activity |
2529
| `upstream` | Pipeline | Pipeline that triggered the pipeline |
lauraMon's avatar
lauraMon committed
2530
| `user` | User | Pipeline user |
2531
| `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource |
Felipe Artur's avatar
Felipe Artur committed
2532

2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548
### PipelineAnalytics

| Field | Type | Description |
| ----- | ---- | ----------- |
| `monthPipelinesLabels` | String! => Array | Labels for the monthly pipeline count |
| `monthPipelinesSuccessful` | Int! => Array | Total monthly successful pipeline count |
| `monthPipelinesTotals` | Int! => Array | Total monthly pipeline count |
| `pipelineTimesLabels` | String! => Array | Pipeline times labels |
| `pipelineTimesValues` | Int! => Array | Pipeline times |
| `weekPipelinesLabels` | String! => Array | Labels for the weekly pipeline count |
| `weekPipelinesSuccessful` | Int! => Array | Total weekly successful pipeline count |
| `weekPipelinesTotals` | Int! => Array | Total weekly pipeline count |
| `yearPipelinesLabels` | String! => Array | Labels for the yearly pipeline count |
| `yearPipelinesSuccessful` | Int! => Array | Total yearly successful pipeline count |
| `yearPipelinesTotals` | Int! => Array | Total yearly pipeline count |

2549
### PipelineCancelPayload
lauraMon's avatar
lauraMon committed
2550

2551
Autogenerated return type of PipelineCancel.
lauraMon's avatar
lauraMon committed
2552

2553 2554
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
2555 2556 2557
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

2558
### PipelineDestroyPayload
lauraMon's avatar
lauraMon committed
2559

2560
Autogenerated return type of PipelineDestroy.
lauraMon's avatar
lauraMon committed
2561

2562 2563
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
2564 2565 2566
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

2567
### PipelinePermissions
Felipe Artur's avatar
Felipe Artur committed
2568

2569 2570
| Field | Type | Description |
| ----- | ---- | ----------- |
2571 2572
| `adminPipeline` | Boolean! | Indicates the user can perform `admin_pipeline` on this resource |
| `destroyPipeline` | Boolean! | Indicates the user can perform `destroy_pipeline` on this resource |
2573
| `updatePipeline` | Boolean! | Indicates the user can perform `update_pipeline` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2574

2575
### PipelineRetryPayload
lauraMon's avatar
lauraMon committed
2576

2577
Autogenerated return type of PipelineRetry.
lauraMon's avatar
lauraMon committed
2578

2579 2580
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
2581 2582
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2583
| `pipeline` | Pipeline | The pipeline after mutation. |
lauraMon's avatar
lauraMon committed
2584

2585
### Project
Felipe Artur's avatar
Felipe Artur committed
2586

2587 2588
| Field | Type | Description |
| ----- | ---- | ----------- |
2589
| `actualRepositorySizeLimit` | Float | Size limit for the repository in bytes |
2590
| `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project |
2591
| `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project |
2592 2593
| `alertManagementAlerts` | AlertManagementAlertConnection | Alert Management alerts of the project |
| `alertManagementIntegrations` | AlertManagementIntegrationConnection | Integrations which can receive alerts for the project |
2594
| `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 |
2595 2596 2597
| `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 |
2598
| `board` | Board | A single board of the project |
2599
| `boards` | BoardConnection | Boards of the project |
2600
| `ciCdSettings` | ProjectCiCdSetting | CI/CD settings for the project |
2601
| `clusterAgent` | ClusterAgent | Find a single cluster agent by name |
2602
| `clusterAgents` | ClusterAgentConnection | Cluster agents associated with the project |
2603
| `codeCoverageSummary` | CodeCoverageSummary | Code coverage summary associated with the project |
2604
| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks associated with the project |
2605
| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy of the project |
2606
| `containerRegistryEnabled` | Boolean | Indicates if the project stores Docker container images in a container registry |
2607
| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the project |
2608
| `containerRepositoriesCount` | Int! | Number of container repositories in the project |
2609
| `createdAt` | Time | Timestamp of the project creation |
2610
| `dastScannerProfiles` | DastScannerProfileConnection | The DAST scanner profiles associated with the project |
2611
| `dastSiteProfile` | DastSiteProfile | DAST Site Profile associated with the project |
2612
| `dastSiteProfiles` | DastSiteProfileConnection | DAST Site Profiles associated with the project |
2613
| `dastSiteValidations` | DastSiteValidationConnection | DAST Site Validations associated with the project. Will always return no nodes if `security_on_demand_scans_site_validation` is disabled |
2614
| `description` | String | Short description of the project |
Felipe Artur's avatar
Felipe Artur committed
2615
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2616
| `environment` | Environment | A single environment of the project |
2617
| `environments` | EnvironmentConnection | Environments of the project |
2618
| `forksCount` | Int! | Number of times the project has been forked |
2619 2620 2621 2622 2623
| `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 |
2624
| `importStatus` | String | Status of import background job of the project |
2625
| `incidentManagementOncallSchedules` | IncidentManagementOncallScheduleConnection | Incident Management On-call schedules of the project |
2626
| `issue` | Issue | A single issue of the project |
Sean Arnold's avatar
Sean Arnold committed
2627
| `issueStatusCounts` | IssueStatusCountsType | Counts of issues by status for the project |
2628
| `issues` | IssueConnection | Issues of the project |
2629
| `issuesEnabled` | Boolean | Indicates if Issues are enabled for the current user |
2630
| `iterations` | IterationConnection | Find iterations |
2631
| `jiraImportStatus` | String | Status of Jira import background job of the project |
2632
| `jiraImports` | JiraImportConnection | Jira imports into the project |
2633
| `jobsEnabled` | Boolean | Indicates if CI/CD pipeline jobs are enabled for the current user |
2634
| `label` | Label | A label available on this project |
2635
| `labels` | LabelConnection | Labels available on this project |
2636 2637
| `lastActivityAt` | Time | Timestamp of the project last activity |
| `lfsEnabled` | Boolean | Indicates if the project has Large File Storage (LFS) enabled |
2638
| `mergeRequest` | MergeRequest | A single merge request of the project |
2639
| `mergeRequests` | MergeRequestConnection | Merge requests of the project |
2640
| `mergeRequestsEnabled` | Boolean | Indicates if Merge Requests are enabled for the current user |
2641
| `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. |
2642
| `milestones` | MilestoneConnection | Milestones of the project |
2643 2644 2645
| `name` | String! | Name of the project (without namespace) |
| `nameWithNamespace` | String! | Full name of the project with its namespace |
| `namespace` | Namespace | Namespace of the project |
2646
| `onlyAllowMergeIfAllDiscussionsAreResolved` | Boolean | Indicates if merge requests of the project can only be merged when all the discussions are resolved |
2647 2648
| `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 |
2649
| `packages` | PackageConnection | Packages of the project |
2650
| `path` | String! | Path of the project |
2651
| `pipeline` | Pipeline | Build pipeline of the project |
2652
| `pipelineAnalytics` | PipelineAnalytics | Pipeline analytics |
2653
| `pipelines` | PipelineConnection | Build pipelines of the project |
2654
| `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 |
2655
| `projectMembers` | MemberInterfaceConnection | Members of the project |
2656
| `publicJobs` | Boolean | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts |
2657
| `release` | Release | A single release of the project |
2658
| `releases` | ReleaseConnection | Releases of the project |
2659 2660
| `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 |
2661
| `repositorySizeExcess` | Float | Size of repository that exceeds the limit in bytes |
2662
| `requestAccessEnabled` | Boolean | Indicates if users can request member access to the project |
2663
| `requirement` | Requirement | Find a single requirement |
2664
| `requirementStatesCount` | RequirementStatesCount | Number of requirements for the project by their state |
2665
| `requirements` | RequirementConnection | Find requirements |
2666
| `sastCiConfiguration` | SastCiConfiguration | SAST CI configuration for the project |
2667
| `securityDashboardPath` | String | Path to project's security dashboard |
2668
| `securityScanners` | SecurityScanners | Information about security analyzers used in the project |
2669
| `sentryDetailedError` | SentryDetailedError | Detailed version of a Sentry error on the project |
Sean Arnold's avatar
Sean Arnold committed
2670
| `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project |
2671
| `serviceDeskAddress` | String | E-mail address of the service desk. |
2672
| `serviceDeskEnabled` | Boolean | Indicates if the project has service desk enabled. |
2673
| `services` | ServiceConnection | Project services |
2674
| `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project |
2675
| `snippets` | SnippetConnection | Snippets of the project |
2676
| `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user |
2677
| `squashReadOnly` | Boolean! | Indicates if squash readonly is enabled |
2678 2679 2680 2681
| `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 |
2682
| `tagList` | String | List of project topics (not Git tags) |
2683
| `terraformStates` | TerraformStateConnection | Terraform states associated with the project |
2684
| `totalPipelineDuration` | Int | Total pipeline duration for all of the pipelines in a project |
2685 2686
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
| `visibility` | String | Visibility of the project |
2687 2688 2689
| `vulnerabilities` | VulnerabilityConnection | Vulnerabilities reported on the project |
| `vulnerabilitiesCountByDay` | VulnerabilitiesCountByDayConnection | Number of vulnerabilities per day for the project |
| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the project vulnerabilties |
2690
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the project |
2691
| `webUrl` | String | Web URL of the project |
2692
| `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user |
Felipe Artur's avatar
Felipe Artur committed
2693

2694 2695 2696 2697 2698 2699 2700 2701
### ProjectCiCdSetting

| Field | Type | Description |
| ----- | ---- | ----------- |
| `mergePipelinesEnabled` | Boolean | Whether merge pipelines are enabled. |
| `mergeTrainsEnabled` | Boolean | Whether merge trains are enabled. |
| `project` | Project | Project the CI/CD settings belong to. |

2702
### ProjectMember
2703

2704
Represents a Project Membership.
2705

2706 2707
| Field | Type | Description |
| ----- | ---- | ----------- |
2708 2709 2710 2711
| `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 |
2712
| `id` | ID! | ID of the member |
2713 2714
| `project` | Project | Project that User is a member of |
| `updatedAt` | Time | Date and time the membership was last updated |
2715
| `user` | User! | User that is associated with the member object |
2716
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
2717

2718
### ProjectPermissions
Felipe Artur's avatar
Felipe Artur committed
2719

2720 2721
| Field | Type | Description |
| ----- | ---- | ----------- |
2722 2723 2724 2725 2726
| `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 |
2727 2728
| `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 |
2729 2730
| `createDeployment` | Boolean! | Indicates the user can perform `create_deployment` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
2731
| `createIssue` | Boolean! | Indicates the user can perform `create_issue` on this resource |
2732 2733 2734 2735
| `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 |
2736 2737
| `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 |
2738
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
2739
| `createWiki` | Boolean! | Indicates the user can perform `create_wiki` on this resource |
2740 2741 2742 2743 2744 2745
| `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 |
2746 2747
| `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 |
2748 2749 2750
| `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 |
2751
| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource |
2752 2753 2754 2755 2756 2757 2758 2759 2760
| `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 |
2761 2762
| `updatePages` | Boolean! | Indicates the user can perform `update_pages` on this resource |
| `updateWiki` | Boolean! | Indicates the user can perform `update_wiki` on this resource |
2763
| `uploadFile` | Boolean! | Indicates the user can perform `upload_file` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2764

2765
### ProjectStatistics
Felipe Artur's avatar
Felipe Artur committed
2766

2767 2768
| Field | Type | Description |
| ----- | ---- | ----------- |
2769
| `buildArtifactsSize` | Float! | Build artifacts size of the project in bytes |
Matthias van de Meent's avatar
Matthias van de Meent committed
2770
| `commitCount` | Float! | Commit count of the project |
2771 2772 2773 2774 2775 2776 2777
| `lfsObjectsSize` | Float! | Large File Storage (LFS) object size of the project in bytes |
| `packagesSize` | Float! | Packages size of the project in bytes |
| `repositorySize` | Float! | Repository size of the project in bytes |
| `snippetsSize` | Float | Snippets size of the project in bytes |
| `storageSize` | Float! | Storage size of the project in bytes |
| `uploadsSize` | Float | Uploads size of the project in bytes |
| `wikiSize` | Float | Wiki size of the project in bytes |
Felipe Artur's avatar
Felipe Artur committed
2778

2779
### PrometheusAlert
2780

2781
The alert condition for Prometheus.
2782

2783 2784
| Field | Type | Description |
| ----- | ---- | ----------- |
2785 2786 2787
| `humanizedText` | String! | The human-readable text of the alert condition |
| `id` | ID! | ID of the alert condition |

2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817
### PrometheusIntegrationCreatePayload

Autogenerated return type of PrometheusIntegrationCreate.

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

### PrometheusIntegrationResetTokenPayload

Autogenerated return type of PrometheusIntegrationResetToken.

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

### PrometheusIntegrationUpdatePayload

Autogenerated return type of PrometheusIntegrationUpdate.

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

2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828
### PromoteToEpicPayload

Autogenerated return type of PromoteToEpic.

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

2829
### Release
2830

2831
Represents a release.
2832

2833 2834
| Field | Type | Description |
| ----- | ---- | ----------- |
2835
| `assets` | ReleaseAssets | Assets of the release |
2836 2837 2838 2839 2840
| `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` |
2841
| `evidences` | ReleaseEvidenceConnection | Evidence for the release |
2842
| `links` | ReleaseLinks | Links of the release |
2843
| `milestones` | MilestoneConnection | Milestones associated to the release |
2844 2845
| `name` | String | Name of the release |
| `releasedAt` | Time | Timestamp of when the release was released |
2846
| `tagName` | String | Name of the tag associated with the release |
2847
| `tagPath` | String | Relative web path to the tag associated with the release |
2848
| `upcomingRelease` | Boolean | Indicates the release is an upcoming release |
2849

2850
### ReleaseAssetLink
2851

2852
Represents an asset link associated with a release.
2853

2854 2855
| Field | Type | Description |
| ----- | ---- | ----------- |
2856
| `directAssetUrl` | String | Direct asset URL of the link |
2857 2858 2859 2860 2861 2862
| `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 |

2863
### ReleaseAssets
2864

2865
A container for all assets associated with a release.
2866

2867 2868
| Field | Type | Description |
| ----- | ---- | ----------- |
2869
| `count` | Int | Number of assets of the release |
2870 2871
| `links` | ReleaseAssetLinkConnection | Asset links of the release |
| `sources` | ReleaseSourceConnection | Sources of the release |
2872

2873 2874 2875 2876 2877 2878 2879 2880 2881 2882
### ReleaseCreatePayload

Autogenerated return type of ReleaseCreate.

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

2883 2884 2885 2886 2887 2888 2889 2890 2891 2892
### ReleaseDeletePayload

Autogenerated return type of ReleaseDelete.

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

2893
### ReleaseEvidence
2894

2895
Evidence for a release.
2896

2897 2898
| Field | Type | Description |
| ----- | ---- | ----------- |
2899 2900 2901 2902 2903
| `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 |

2904
### ReleaseLinks
2905

2906 2907
| Field | Type | Description |
| ----- | ---- | ----------- |
2908 2909
| `closedIssuesUrl` | String | HTTP URL of the issues page, filtered by this release and `state=closed` |
| `closedMergeRequestsUrl` | String | HTTP URL of the merge request page , filtered by this release and `state=closed` |
2910
| `editUrl` | String | HTTP URL of the release's edit page |
2911
| `mergedMergeRequestsUrl` | String | HTTP URL of the merge request page , filtered by this release and `state=merged` |
2912 2913
| `openedIssuesUrl` | String | HTTP URL of the issues page, filtered by this release and `state=open` |
| `openedMergeRequestsUrl` | String | HTTP URL of the merge request page, filtered by this release and `state=open` |
2914 2915
| `selfUrl` | String | HTTP URL of the release |

2916
### ReleaseSource
2917

2918
Represents the source code attached to a release in a particular format.
2919

2920 2921
| Field | Type | Description |
| ----- | ---- | ----------- |
2922 2923 2924
| `format` | String | Format of the source |
| `url` | String | Download URL of the source |

2925 2926 2927 2928 2929 2930 2931 2932 2933 2934
### ReleaseUpdatePayload

Autogenerated return type of ReleaseUpdate.

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

2935
### RemoveAwardEmojiPayload
2936

2937
Autogenerated return type of RemoveAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
2938

2939 2940
| Field | Type | Description |
| ----- | ---- | ----------- |
2941
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
Felipe Artur's avatar
Felipe Artur committed
2942
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2943
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
2944

2945
### RemoveProjectFromSecurityDashboardPayload
2946

2947
Autogenerated return type of RemoveProjectFromSecurityDashboard.
2948

2949 2950
| Field | Type | Description |
| ----- | ---- | ----------- |
2951
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2952
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
2953

2954 2955 2956 2957 2958 2959 2960 2961 2962 2963
### RepositionImageDiffNotePayload

Autogenerated return type of RepositionImageDiffNote.

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

2964
### Repository
Felipe Artur's avatar
Felipe Artur committed
2965

2966 2967
| Field | Type | Description |
| ----- | ---- | ----------- |
2968 2969
| `empty` | Boolean! | Indicates repository has no visible content |
| `exists` | Boolean! | Indicates a corresponding Git repository exists on disk |
2970
| `rootRef` | String | Default branch of the repository |
2971
| `tree` | Tree | Tree of the repository |
Felipe Artur's avatar
Felipe Artur committed
2972

2973
### Requirement
Jan Provaznik's avatar
Jan Provaznik committed
2974

2975
Represents a requirement.
Jan Provaznik's avatar
Jan Provaznik committed
2976

2977 2978
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
2979 2980
| `author` | User! | Author of the requirement |
| `createdAt` | Time! | Timestamp of when the requirement was created |
2981 2982
| `description` | String | Description of the requirement |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
Jan Provaznik's avatar
Jan Provaznik committed
2983 2984
| `id` | ID! | ID of the requirement |
| `iid` | ID! | Internal ID of the requirement |
2985
| `lastTestReportManuallyCreated` | Boolean | Indicates if latest test report was created by user |
2986
| `lastTestReportState` | TestReportState | Latest requirement test report state |
Jan Provaznik's avatar
Jan Provaznik committed
2987 2988
| `project` | Project! | Project to which the requirement belongs |
| `state` | RequirementState! | State of the requirement |
2989
| `testReports` | TestReportConnection | Test reports of the requirement |
Jan Provaznik's avatar
Jan Provaznik committed
2990
| `title` | String | Title of the requirement |
2991
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
Jan Provaznik's avatar
Jan Provaznik committed
2992 2993 2994
| `updatedAt` | Time! | Timestamp of when the requirement was last updated |
| `userPermissions` | RequirementPermissions! | Permissions for the current user on the resource |

2995
### RequirementPermissions
Jan Provaznik's avatar
Jan Provaznik committed
2996

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

2999 3000
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
3001 3002 3003 3004 3005 3006
| `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 |

3007
### RequirementStatesCount
3008 3009 3010

Counts of requirements by their state.

3011 3012
| Field | Type | Description |
| ----- | ---- | ----------- |
3013 3014 3015
| `archived` | Int | Number of archived requirements |
| `opened` | Int | Number of opened requirements |

3016 3017 3018 3019 3020 3021 3022 3023 3024 3025
### RevertVulnerabilityToDetectedPayload

Autogenerated return type of RevertVulnerabilityToDetected.

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

3026
### RootStorageStatistics
3027

3028 3029
| Field | Type | Description |
| ----- | ---- | ----------- |
Matthias van de Meent's avatar
Matthias van de Meent committed
3030 3031 3032
| `buildArtifactsSize` | Float! | The CI artifacts size in bytes |
| `lfsObjectsSize` | Float! | The LFS objects size in bytes |
| `packagesSize` | Float! | The packages size in bytes |
3033
| `pipelineArtifactsSize` | Float! | The CI pipeline artifacts size in bytes |
Matthias van de Meent's avatar
Matthias van de Meent committed
3034
| `repositorySize` | Float! | The Git repository size in bytes |
3035
| `snippetsSize` | Float! | The snippets size in bytes |
Matthias van de Meent's avatar
Matthias van de Meent committed
3036
| `storageSize` | Float! | The total storage in bytes |
3037
| `uploadsSize` | Float! | The uploads size in bytes |
Matthias van de Meent's avatar
Matthias van de Meent committed
3038
| `wikiSize` | Float! | The wiki size in bytes |
3039

3040
### RunDASTScanPayload
3041

3042
Autogenerated return type of RunDASTScan.
3043

3044 3045
| Field | Type | Description |
| ----- | ---- | ----------- |
3046 3047 3048 3049
| `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. |

3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060
### RunnerArchitecture

| Field | Type | Description |
| ----- | ---- | ----------- |
| `downloadLocation` | String! | Download location for the runner for the platform architecture |
| `name` | String! | Name of the runner platform architecture |

### RunnerPlatform

| Field | Type | Description |
| ----- | ---- | ----------- |
3061
| `architectures` | RunnerArchitectureConnection | Runner architectures supported for the platform |
3062 3063 3064
| `humanReadableName` | String! | Human readable name of the runner platform |
| `name` | String! | Name slug of the runner platform |

3065 3066 3067 3068 3069
### RunnerSetup

| Field | Type | Description |
| ----- | ---- | ----------- |
| `installInstructions` | String! | Instructions for installing the runner on the specified architecture |
3070
| `registerInstructions` | String | Instructions for registering the runner |
3071

3072 3073 3074 3075 3076 3077 3078 3079 3080 3081
### SastCiConfiguration

Represents a CI configuration of SAST.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `analyzers` | SastCiConfigurationAnalyzersEntityConnection | List of analyzers entities attached to SAST configuration. |
| `global` | SastCiConfigurationEntityConnection | List of global entities related to SAST configuration. |
| `pipeline` | SastCiConfigurationEntityConnection | List of pipeline entities related to SAST configuration. |

3082
### SastCiConfigurationAnalyzersEntity
3083

3084
Represents an analyzer entity in SAST CI configuration.
3085

3086 3087
| Field | Type | Description |
| ----- | ---- | ----------- |
3088 3089 3090 3091
| `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 |
3092
| `variables` | SastCiConfigurationEntityConnection | List of supported variables |
3093

3094
### SastCiConfigurationEntity
3095

3096
Represents an entity in SAST CI configuration.
3097

3098 3099
| Field | Type | Description |
| ----- | ---- | ----------- |
3100 3101 3102 3103
| `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. |
3104
| `options` | SastCiConfigurationOptionsEntityConnection | Different possible values of the field. |
3105
| `size` | SastUiComponentSize | Size of the UI component. |
3106 3107 3108
| `type` | String | Type of the field value. |
| `value` | String | Current value of the entity. |

3109
### SastCiConfigurationOptionsEntity
3110

3111
Represents an entity for options in SAST CI configuration.
3112

3113 3114
| Field | Type | Description |
| ----- | ---- | ----------- |
3115 3116 3117
| `label` | String | Label of option entity. |
| `value` | String | Value of option entity. |

3118
### ScannedResource
3119

3120
Represents a resource scanned by a security scan.
3121

3122 3123
| Field | Type | Description |
| ----- | ---- | ----------- |
3124 3125 3126
| `requestMethod` | String | The HTTP request method used to access the URL |
| `url` | String | The URL scanned by the scanner |

3127
### SecurityReportSummary
3128

3129
Represents summary of a security report.
3130

3131 3132
| Field | Type | Description |
| ----- | ---- | ----------- |
3133
| `apiFuzzing` | SecurityReportSummarySection | Aggregated counts for the api_fuzzing scan |
3134
| `containerScanning` | SecurityReportSummarySection | Aggregated counts for the container_scanning scan |
3135
| `coverageFuzzing` | SecurityReportSummarySection | Aggregated counts for the coverage_fuzzing scan |
3136 3137 3138 3139 3140
| `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 |

3141
### SecurityReportSummarySection
3142

3143
Represents a section of a summary of a security report.
3144

3145 3146
| Field | Type | Description |
| ----- | ---- | ----------- |
3147
| `scannedResources` | ScannedResourceConnection | A list of the first 20 scanned resources |
3148
| `scannedResourcesCount` | Int | Total number of scanned resources |
3149
| `scannedResourcesCsvPath` | String | Path to download all the scanned resources in CSV format |
3150 3151
| `vulnerabilitiesCount` | Int | Total number of vulnerabilities |

3152
### SecurityScanners
3153

3154
Represents a list of security scanners.
3155

3156 3157
| Field | Type | Description |
| ----- | ---- | ----------- |
3158 3159 3160 3161
| `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. |

3162
### SentryDetailedError
3163

Sean Arnold's avatar
Sean Arnold committed
3164 3165
A Sentry error.

3166 3167
| Field | Type | Description |
| ----- | ---- | ----------- |
3168
| `count` | Int! | Count of occurrences |
3169
| `culprit` | String! | Culprit of the error |
3170
| `externalBaseUrl` | String! | External Base URL of the Sentry Instance |
3171 3172
| `externalUrl` | String! | External URL of the error |
| `firstReleaseLastCommit` | String | Commit the error was first seen |
3173 3174
| `firstReleaseShortVersion` | String | Release short version the error was first seen |
| `firstReleaseVersion` | String | Release version the error was first seen |
3175
| `firstSeen` | Time! | Timestamp when the error was first seen |
3176 3177 3178
| `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 |
3179
| `gitlabIssuePath` | String | URL of GitLab Issue |
3180 3181
| `id` | ID! | ID (global ID) of the error |
| `lastReleaseLastCommit` | String | Commit the error was last seen |
3182 3183
| `lastReleaseShortVersion` | String | Release short version the error was last seen |
| `lastReleaseVersion` | String | Release version the error was last seen |
3184 3185
| `lastSeen` | Time! | Timestamp when the error was last seen |
| `message` | String | Sentry metadata message of the error |
3186
| `sentryId` | String! | ID (Sentry ID) of the error |
3187 3188 3189 3190 3191
| `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 |
3192
| `tags` | SentryErrorTags! | Tags associated with the Sentry Error |
3193 3194 3195
| `title` | String! | Title of the error |
| `type` | String! | Type of the error |
| `userCount` | Int! | Count of users affected by the error |
3196

3197
### SentryError
Sean Arnold's avatar
Sean Arnold committed
3198 3199 3200

A Sentry error. A simplified version of SentryDetailedError.

3201 3202
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220
| `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 |

3221
### SentryErrorCollection
Sean Arnold's avatar
Sean Arnold committed
3222 3223 3224

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

3225 3226
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
3227
| `detailedError` | SentryDetailedError | Detailed version of a Sentry error on the project |
Sean Arnold's avatar
Sean Arnold committed
3228
| `errorStackTrace` | SentryErrorStackTrace | Stack Trace of Sentry Error |
Sean Arnold's avatar
Sean Arnold committed
3229 3230 3231
| `errors` | SentryErrorConnection | Collection of Sentry Errors |
| `externalUrl` | String | External URL for Sentry |

3232
### SentryErrorFrequency
3233

3234 3235
| Field | Type | Description |
| ----- | ---- | ----------- |
3236
| `count` | Int! | Count of errors received since the previously recorded time |
3237
| `time` | Time! | Time the error frequency stats were recorded |
3238

3239
### SentryErrorStackTrace
Sean Arnold's avatar
Sean Arnold committed
3240 3241 3242

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

3243 3244
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
3245 3246 3247 3248
| `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 |

3249
### SentryErrorStackTraceContext
Sean Arnold's avatar
Sean Arnold committed
3250

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

3253 3254
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
3255 3256 3257
| `code` | String! | Code number of the context |
| `line` | Int! | Line number of the context |

3258
### SentryErrorStackTraceEntry
Sean Arnold's avatar
Sean Arnold committed
3259 3260 3261

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

3262 3263
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
3264 3265 3266 3267 3268 3269
| `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 |

3270
### SentryErrorTags
3271

3272
State of a Sentry error.
3273

3274 3275
| Field | Type | Description |
| ----- | ---- | ----------- |
3276 3277 3278
| `level` | String | Severity level of the Sentry Error |
| `logger` | String | Logger of the Sentry Error |

3279
### Snippet
3280

3281
Represents a snippet entry.
3282

3283 3284
| Field | Type | Description |
| ----- | ---- | ----------- |
3285
| `author` | User | The owner of the snippet |
3286
| `blob` **{warning-solid}** | SnippetBlob! | **Deprecated:** Use `blobs`. Deprecated in 13.3. |
3287
| `blobs` | SnippetBlobConnection | Snippet blobs |
3288
| `createdAt` | Time! | Timestamp this snippet was created |
3289 3290
| `description` | String | Description of the snippet |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3291
| `discussions` | DiscussionConnection! | All discussions on this noteable |
3292
| `fileName` | String | File Name of the snippet |
3293
| `httpUrlToRepo` | String | HTTP URL to the snippet repository |
3294
| `id` | SnippetID! | ID of the snippet |
3295
| `notes` | NoteConnection! | All notes on this noteable |
3296 3297
| `project` | Project | The project the snippet is associated with |
| `rawUrl` | String! | Raw URL of the snippet |
3298
| `sshUrlToRepo` | String | SSH URL to the snippet repository |
3299
| `title` | String! | Title of the snippet |
3300
| `updatedAt` | Time! | Timestamp this snippet was updated |
3301 3302
| `userPermissions` | SnippetPermissions! | Permissions for the current user on the resource |
| `visibilityLevel` | VisibilityLevelsEnum! | Visibility Level of the snippet |
3303 3304
| `webUrl` | String! | Web URL of the snippet |

3305
### SnippetBlob
3306

3307
Represents the snippet blob.
3308

3309 3310
| Field | Type | Description |
| ----- | ---- | ----------- |
3311
| `binary` | Boolean! | Shows whether the blob is binary |
3312
| `externalStorage` | String | Blob external storage |
3313
| `mode` | String | Blob mode |
3314 3315
| `name` | String | Blob name |
| `path` | String | Blob path |
3316
| `plainData` | String | Blob plain highlighted data |
3317
| `rawPath` | String! | Blob raw content endpoint path |
3318
| `renderedAsText` | Boolean! | Shows whether the blob is rendered as text |
3319
| `richData` | String | Blob highlighted data |
3320
| `richViewer` | SnippetBlobViewer | Blob content rich viewer |
3321 3322
| `simpleViewer` | SnippetBlobViewer! | Blob content simple viewer |
| `size` | Int! | Blob size |
3323

3324
### SnippetBlobViewer
3325

3326
Represents how the blob content should be displayed.
3327

3328 3329
| Field | Type | Description |
| ----- | ---- | ----------- |
3330 3331
| `collapsed` | Boolean! | Shows whether the blob should be displayed collapsed |
| `fileType` | String! | Content file type |
3332
| `loadAsync` | Boolean! | Shows whether the blob content is loaded async |
3333
| `loadingPartialName` | String! | Loading partial name |
3334 3335 3336
| `renderError` | String | Error rendering the blob content |
| `tooLarge` | Boolean! | Shows whether the blob too large to be displayed |
| `type` | BlobViewersType! | Type of blob viewer |
3337

3338
### SnippetPermissions
3339

3340 3341
| Field | Type | Description |
| ----- | ---- | ----------- |
3342
| `adminSnippet` | Boolean! | Indicates the user can perform `admin_snippet` on this resource |
3343
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
3344
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
3345 3346
| `readSnippet` | Boolean! | Indicates the user can perform `read_snippet` on this resource |
| `reportSnippet` | Boolean! | Indicates the user can perform `report_snippet` on this resource |
3347
| `updateSnippet` | Boolean! | Indicates the user can perform `update_snippet` on this resource |
3348

3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363
### SnippetRepositoryRegistry

Represents the Geo sync and verification state of a snippet repository.

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

3364 3365 3366 3367 3368 3369
### StatusAction

| Field | Type | Description |
| ----- | ---- | ----------- |
| `buttonTitle` | String | Title for the button, for example: Retry this job |
| `icon` | String | Icon used in the action button |
3370
| `method` | String | Method for the action, for example: :post |
3371 3372 3373
| `path` | String | Path for the action |
| `title` | String | Title for the action, for example: Retry |

3374
### Submodule
Felipe Artur's avatar
Felipe Artur committed
3375

3376 3377
| Field | Type | Description |
| ----- | ---- | ----------- |
3378
| `flatPath` | String! | Flat path of the entry |
3379 3380 3381
| `id` | ID! | ID of the entry |
| `name` | String! | Name of the entry |
| `path` | String! | Path of the entry |
3382
| `sha` | String! | Last commit sha for the entry |
3383
| `treeUrl` | String | Tree URL for the sub-module |
3384 3385
| `type` | EntryType! | Type of tree entry |
| `webUrl` | String | Web URL for the sub-module |
Felipe Artur's avatar
Felipe Artur committed
3386

3387
### TaskCompletionStatus
3388

3389
Completion status of tasks.
Felipe Artur's avatar
Felipe Artur committed
3390

3391 3392
| Field | Type | Description |
| ----- | ---- | ----------- |
3393
| `completedCount` | Int! | Number of completed tasks |
3394
| `count` | Int! | Number of total tasks |
Felipe Artur's avatar
Felipe Artur committed
3395

3396 3397 3398 3399 3400 3401
### TerraformState

| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time! | Timestamp the Terraform state was created |
| `id` | ID! | ID of the Terraform state |
3402
| `latestVersion` | TerraformStateVersion | The latest version of the Terraform state |
3403 3404 3405 3406 3407
| `lockedAt` | Time | Timestamp the Terraform state was locked |
| `lockedByUser` | User | The user currently holding a lock on the Terraform state |
| `name` | String! | Name of the Terraform state |
| `updatedAt` | Time! | Timestamp the Terraform state was updated |

3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434
### TerraformStateDeletePayload

Autogenerated return type of TerraformStateDelete.

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

### TerraformStateLockPayload

Autogenerated return type of TerraformStateLock.

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

### TerraformStateUnlockPayload

Autogenerated return type of TerraformStateUnlock.

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

3435 3436 3437 3438 3439 3440
### TerraformStateVersion

| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time! | Timestamp the version was created |
| `createdByUser` | User | The user that created this version |
3441
| `downloadPath` | String | URL for downloading the version's JSON file |
3442
| `id` | ID! | ID of the Terraform state version |
3443
| `job` | CiJob | The job that created this version |
3444
| `serial` | Int | Serial number of the version |
3445 3446
| `updatedAt` | Time! | Timestamp the version was updated |

3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461
### 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 |

3462
### TestReport
3463 3464 3465

Represents a requirement test report.

3466 3467
| Field | Type | Description |
| ----- | ---- | ----------- |
3468 3469 3470 3471 3472
| `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 |

3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491
### TimeReportStats

Represents the time report stats for timeboxes.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `complete` | TimeboxMetrics | Completed issues metrics |
| `incomplete` | TimeboxMetrics | Incomplete issues metrics |
| `total` | TimeboxMetrics | Total issues metrics |

### TimeboxMetrics

Represents measured stats metrics for timeboxes.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `count` | Int! | The count metric |
| `weight` | Int! | The weight metric |

3492 3493 3494 3495 3496 3497 3498
### TimeboxReport

Represents a historically accurate report about the timebox.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts |
3499
| `stats` | TimeReportStats | Represents the time report stats for the timebox |
3500

3501
### Timelog
3502

3503 3504
| Field | Type | Description |
| ----- | ---- | ----------- |
3505
| `issue` | Issue | The issue that logged time was added to |
3506
| `note` | Note | The note where the quick action to add the logged time was executed |
3507
| `spentAt` | Time | Timestamp of when the time tracked was spent at |
3508 3509 3510
| `timeSpent` | Int! | The time spent displayed in seconds |
| `user` | User! | The user that logged the time |

3511
### Todo
3512

3513
Representing a todo entry.
3514

3515 3516
| Field | Type | Description |
| ----- | ---- | ----------- |
3517
| `action` | TodoActionEnum! | Action of the todo |
3518
| `author` | User! | The author of this todo |
3519 3520
| `body` | String! | Body of the todo |
| `createdAt` | Time! | Timestamp this todo was created |
3521
| `group` | Group | Group this todo is associated with |
3522
| `id` | ID! | ID of the todo |
3523 3524 3525
| `project` | Project | The project this todo is associated with |
| `state` | TodoStateEnum! | State of the todo |
| `targetType` | TodoTargetEnum! | Target type of the todo |
3526

3527 3528 3529 3530 3531 3532 3533 3534 3535 3536
### TodoCreatePayload

Autogenerated return type of TodoCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todo` | Todo | The to-do created |

3537
### TodoMarkDonePayload
3538

3539
Autogenerated return type of TodoMarkDone.
3540

3541 3542
| Field | Type | Description |
| ----- | ---- | ----------- |
3543
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3544
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3545 3546
| `todo` | Todo! | The requested todo |

3547
### TodoRestoreManyPayload
3548

3549
Autogenerated return type of TodoRestoreMany.
3550

3551 3552
| Field | Type | Description |
| ----- | ---- | ----------- |
3553
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3554
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3555
| `todos` | Todo! => Array | Updated todos |
3556
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use todos. Deprecated in 13.2. |
3557

3558
### TodoRestorePayload
3559

3560
Autogenerated return type of TodoRestore.
3561

3562 3563
| Field | Type | Description |
| ----- | ---- | ----------- |
3564
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3565
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3566 3567
| `todo` | Todo! | The requested todo |

3568
### TodosMarkAllDonePayload
3569

3570
Autogenerated return type of TodosMarkAllDone.
3571

3572 3573
| Field | Type | Description |
| ----- | ---- | ----------- |
3574
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3575
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3576
| `todos` | Todo! => Array | Updated todos |
3577
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use todos. Deprecated in 13.2. |
3578

3579
### ToggleAwardEmojiPayload
3580

3581
Autogenerated return type of ToggleAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
3582

3583 3584
| Field | Type | Description |
| ----- | ---- | ----------- |
3585
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
Felipe Artur's avatar
Felipe Artur committed
3586
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3587
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3588
| `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
3589

3590
### Tree
Felipe Artur's avatar
Felipe Artur committed
3591

3592 3593
| Field | Type | Description |
| ----- | ---- | ----------- |
3594
| `blobs` | BlobConnection! | Blobs of the tree |
3595
| `lastCommit` | Commit | Last commit for the tree |
3596 3597
| `submodules` | SubmoduleConnection! | Sub-modules of the tree |
| `trees` | TreeEntryConnection! | Trees of the tree |
Felipe Artur's avatar
Felipe Artur committed
3598

3599
### TreeEntry
3600

3601
Represents a directory.
Felipe Artur's avatar
Felipe Artur committed
3602

3603 3604
| Field | Type | Description |
| ----- | ---- | ----------- |
3605
| `flatPath` | String! | Flat path of the entry |
3606 3607 3608
| `id` | ID! | ID of the entry |
| `name` | String! | Name of the entry |
| `path` | String! | Path of the entry |
3609 3610
| `sha` | String! | Last commit sha for the entry |
| `type` | EntryType! | Type of tree entry |
3611
| `webPath` | String | Web path for the tree entry (directory) |
3612
| `webUrl` | String | Web URL for the tree entry (directory) |
Felipe Artur's avatar
Felipe Artur committed
3613

3614
### UpdateAlertStatusPayload
Sean Arnold's avatar
Sean Arnold committed
3615

3616
Autogenerated return type of UpdateAlertStatus.
Sean Arnold's avatar
Sean Arnold committed
3617

3618 3619
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
3620 3621
| `alert` | AlertManagementAlert | The alert after mutation |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3622
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3623
| `issue` | Issue | The issue created after mutation |
Allison Browne's avatar
Allison Browne committed
3624
| `todo` | Todo | The todo after mutation |
Sean Arnold's avatar
Sean Arnold committed
3625

3626 3627 3628 3629 3630 3631 3632 3633 3634 3635
### UpdateBoardEpicUserPreferencesPayload

Autogenerated return type of UpdateBoardEpicUserPreferences.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epicUserPreferences` | BoardEpicUserPreferences | User preferences for the epic in the board after mutation |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

3636
### UpdateBoardListPayload
3637

3638
Autogenerated return type of UpdateBoardList.
3639

3640 3641
| Field | Type | Description |
| ----- | ---- | ----------- |
3642 3643 3644 3645
| `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 |

3646
### UpdateBoardPayload
3647

3648
Autogenerated return type of UpdateBoard.
3649

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

3656 3657 3658 3659 3660 3661 3662
### UpdateComplianceFrameworkPayload

Autogenerated return type of UpdateComplianceFramework.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3663
| `complianceFramework` | ComplianceFramework | The compliance framework after mutation. |
3664 3665
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

3666
### UpdateContainerExpirationPolicyPayload
3667

3668
Autogenerated return type of UpdateContainerExpirationPolicy.
3669

3670 3671
| Field | Type | Description |
| ----- | ---- | ----------- |
3672 3673 3674 3675
| `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. |

3676 3677 3678 3679 3680 3681 3682 3683 3684 3685
### UpdateDevopsAdoptionSegmentPayload

Autogenerated return type of UpdateDevopsAdoptionSegment.

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

3686
### UpdateEpicPayload
3687

3688
Autogenerated return type of UpdateEpic.
3689

3690 3691
| Field | Type | Description |
| ----- | ---- | ----------- |
3692 3693
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `epic` | Epic | The epic after mutation |
3694
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3695

3696
### UpdateImageDiffNotePayload
3697

3698
Autogenerated return type of UpdateImageDiffNote.
3699

3700 3701
| Field | Type | Description |
| ----- | ---- | ----------- |
3702
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3703
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3704 3705
| `note` | Note | The note after mutation |

3706
### UpdateIssuePayload
3707

3708
Autogenerated return type of UpdateIssue.
3709

3710 3711
| Field | Type | Description |
| ----- | ---- | ----------- |
3712
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3713
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3714 3715
| `issue` | Issue | The issue after mutation |

3716
### UpdateIterationPayload
3717

3718
Autogenerated return type of UpdateIteration.
3719

3720 3721
| Field | Type | Description |
| ----- | ---- | ----------- |
3722 3723
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3724
| `iteration` | Iteration | Updated iteration. |
3725

3726 3727 3728 3729 3730 3731 3732 3733 3734 3735
### UpdateNamespacePackageSettingsPayload

Autogenerated return type of UpdateNamespacePackageSettings.

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

3736
### UpdateNotePayload
3737

3738
Autogenerated return type of UpdateNote.
3739

3740 3741
| Field | Type | Description |
| ----- | ---- | ----------- |
3742
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3743
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3744 3745
| `note` | Note | The note after mutation |

3746
### UpdateRequirementPayload
3747

3748
Autogenerated return type of UpdateRequirement.
3749

3750 3751
| Field | Type | Description |
| ----- | ---- | ----------- |
3752
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3753
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3754
| `requirement` | Requirement | Requirement after mutation |
3755

3756
### UpdateSnippetPayload
3757

3758
Autogenerated return type of UpdateSnippet.
3759

3760 3761
| Field | Type | Description |
| ----- | ---- | ----------- |
3762
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3763
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3764
| `snippet` | Snippet | The snippet after mutation |
3765
| `spam` | Boolean | Indicates whether the operation returns a record detected as spam |
3766

3767
### User
Felipe Artur's avatar
Felipe Artur committed
3768

3769 3770
| Field | Type | Description |
| ----- | ---- | ----------- |
3771 3772
| `assignedMergeRequests` | MergeRequestConnection | Merge Requests assigned to the user |
| `authoredMergeRequests` | MergeRequestConnection | Merge Requests authored by the user |
3773
| `avatarUrl` | String | URL of the user's avatar |
3774 3775
| `email` **{warning-solid}** | String | **Deprecated:** Use public_email. Deprecated in 13.7. |
| `groupCount` | Int | Group count for the user Available only when feature flag `user_group_counts` is enabled. |
3776
| `groupMemberships` | GroupMemberConnection | Group memberships of the user |
3777
| `id` | ID! | ID of the user |
3778
| `location` | String | The location of the user. |
3779
| `name` | String! | Human-readable name of the user |
3780
| `projectMemberships` | ProjectMemberConnection | Project memberships of the user |
3781
| `publicEmail` | String | User's public email |
3782
| `reviewRequestedMergeRequests` | MergeRequestConnection | Merge Requests assigned to the user for review |
3783 3784
| `snippets` | SnippetConnection | Snippets authored by the user |
| `starredProjects` | ProjectConnection | Projects starred by the user |
3785
| `state` | UserState! | State of the user |
lauraMon's avatar
lauraMon committed
3786
| `status` | UserStatus | User status |
3787
| `todos` | TodoConnection! | Todos of the user |
3788
| `userPermissions` | UserPermissions! | Permissions for the current user on the resource |
3789
| `username` | String! | Username of the user. Unique within this instance of GitLab |
3790
| `webPath` | String! | Web path of the user |
3791
| `webUrl` | String! | Web URL of the user |
3792

3793
### UserPermissions
3794

3795 3796
| Field | Type | Description |
| ----- | ---- | ----------- |
3797
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
3798

3799
### UserStatus
lauraMon's avatar
lauraMon committed
3800

3801 3802
| Field | Type | Description |
| ----- | ---- | ----------- |
3803
| `availability` | AvailabilityEnum! | User availability status |
lauraMon's avatar
lauraMon committed
3804 3805
| `emoji` | String | String representation of emoji |
| `message` | String | User status message |
lauraMon's avatar
lauraMon committed
3806 3807
| `messageHtml` | String | HTML of the user status message |

3808
### VulnerabilitiesCountByDay
3809

3810
Represents the count of vulnerabilities by severity on a particular day. This data is retained for 365 days.
3811

3812 3813
| Field | Type | Description |
| ----- | ---- | ----------- |
3814 3815 3816 3817 3818 3819 3820 3821 3822
| `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 |

3823
### VulnerabilitiesCountByDayAndSeverity
3824

3825
Represents the number of vulnerabilities for a particular severity on a particular day. This data is retained for 365 days.
3826

3827 3828
| Field | Type | Description |
| ----- | ---- | ----------- |
3829 3830 3831 3832
| `count` | Int | Number of vulnerabilities |
| `day` | ISO8601Date | Date for the count |
| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities |

3833
### Vulnerability
3834 3835 3836

Represents a vulnerability.

3837 3838
| Field | Type | Description |
| ----- | ---- | ----------- |
3839
| `confirmedAt` | Time | Timestamp of when the vulnerability state was changed to confirmed |
3840
| `confirmedBy` | User | The user that confirmed the vulnerability. |
3841
| `description` | String | Description of the vulnerability |
3842
| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected |
3843
| `discussions` | DiscussionConnection! | All discussions on this noteable |
3844
| `dismissedAt` | Time | Timestamp of when the vulnerability state was changed to dismissed |
3845
| `dismissedBy` | User | The user that dismissed the vulnerability. |
3846
| `externalIssueLinks` | VulnerabilityExternalIssueLinkConnection! | List of external issue links related to the vulnerability |
3847
| `hasSolutions` | Boolean | Indicates whether there is a solution available for this vulnerability. |
3848
| `id` | ID! | GraphQL ID of the vulnerability |
3849
| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerability. |
3850
| `issueLinks` | VulnerabilityIssueLinkConnection! | List of issue links related to the vulnerability |
3851
| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability |
3852
| `mergeRequest` | MergeRequest | Merge request that fixes the vulnerability. |
3853
| `notes` | NoteConnection! | All notes on this noteable |
3854
| `primaryIdentifier` | VulnerabilityIdentifier | Primary identifier of the vulnerability. |
3855
| `project` | Project | The project on which the vulnerability was found |
3856
| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING) |
3857
| `resolvedAt` | Time | Timestamp of when the vulnerability state was changed to resolved |
3858
| `resolvedBy` | User | The user that resolved the vulnerability. |
3859
| `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not |
3860
| `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. |
3861
| `severity` | VulnerabilitySeverity | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL) |
3862
| `state` | VulnerabilityState | State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED) |
3863
| `title` | String | Title of the vulnerability |
3864
| `userNotesCount` | Int! | Number of user notes attached to the vulnerability |
3865
| `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource |
3866
| `vulnerabilityPath` | String | URL to the vulnerability's details page |
Avielle Wolfe's avatar
Avielle Wolfe committed
3867

3868 3869 3870 3871 3872 3873 3874 3875 3876 3877
### 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 |

3878 3879 3880 3881 3882 3883 3884 3885 3886 3887
### 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 |

3888 3889 3890 3891 3892 3893 3894 3895 3896 3897
### VulnerabilityExternalIssueLink

Represents an external issue link of a vulnerability.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `externalIssue` | ExternalIssue | The external issue attached to the issue link |
| `id` | VulnerabilitiesExternalIssueLinkID! | GraphQL ID of the external issue link |
| `linkType` | VulnerabilityExternalIssueLinkType! | Type of the external issue link |

3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916
### VulnerabilityExternalIssueLinkCreatePayload

Autogenerated return type of VulnerabilityExternalIssueLinkCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `externalIssueLink` | VulnerabilityExternalIssueLink | The created external issue link. |

### VulnerabilityExternalIssueLinkDestroyPayload

Autogenerated return type of VulnerabilityExternalIssueLinkDestroy.

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

3917
### VulnerabilityIdentifier
3918 3919 3920

Represents a vulnerability identifier.

3921 3922
| Field | Type | Description |
| ----- | ---- | ----------- |
3923 3924 3925 3926 3927
| `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 |

3928
### VulnerabilityIssueLink
3929 3930 3931

Represents an issue link of a vulnerability.

3932 3933
| Field | Type | Description |
| ----- | ---- | ----------- |
3934 3935 3936 3937
| `id` | ID! | GraphQL ID of the vulnerability |
| `issue` | Issue! | The issue attached to issue link |
| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link |

3938
### VulnerabilityLocationContainerScanning
3939

3940
Represents the location of a vulnerability found by a container security scan.
3941

3942 3943
| Field | Type | Description |
| ----- | ---- | ----------- |
3944 3945 3946 3947
| `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 |

3948
### VulnerabilityLocationCoverageFuzzing
3949

3950
Represents the location of a vulnerability found by a Coverage Fuzzing scan.
3951

3952 3953
| Field | Type | Description |
| ----- | ---- | ----------- |
3954 3955 3956 3957 3958 3959
| `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 |

3960
### VulnerabilityLocationDast
3961

3962
Represents the location of a vulnerability found by a DAST scan.
3963

3964 3965
| Field | Type | Description |
| ----- | ---- | ----------- |
3966 3967 3968 3969 3970
| `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 |

3971
### VulnerabilityLocationDependencyScanning
3972

3973
Represents the location of a vulnerability found by a dependency security scan.
3974

3975 3976
| Field | Type | Description |
| ----- | ---- | ----------- |
3977 3978 3979
| `dependency` | VulnerableDependency | Dependency containing the vulnerability |
| `file` | String | Path to the vulnerable file |

3980
### VulnerabilityLocationSast
3981

3982
Represents the location of a vulnerability found by a SAST scan.
3983

3984 3985
| Field | Type | Description |
| ----- | ---- | ----------- |
3986 3987 3988 3989 3990 3991
| `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 |

3992
### VulnerabilityLocationSecretDetection
3993

3994
Represents the location of a vulnerability found by a secret detection scan.
3995

3996 3997
| Field | Type | Description |
| ----- | ---- | ----------- |
3998 3999 4000 4001 4002 4003
| `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 |

4004
### VulnerabilityPermissions
4005

4006
Check permissions for the current user on a vulnerability.
4007

4008 4009
| Field | Type | Description |
| ----- | ---- | ----------- |
4010
| `adminVulnerability` | Boolean! | Indicates the user can perform `admin_vulnerability` on this resource |
4011
| `adminVulnerabilityExternalIssueLink` | Boolean! | Indicates the user can perform `admin_vulnerability_external_issue_link` on this resource |
4012 4013 4014 4015 4016 4017 4018 4019
| `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 |

4020 4021 4022 4023 4024 4025 4026 4027 4028 4029
### 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 |

4030 4031 4032 4033 4034 4035 4036 4037 4038 4039
### VulnerabilityRevertToDetectedPayload

Autogenerated return type of VulnerabilityRevertToDetected.

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

4040
### VulnerabilityScanner
4041 4042 4043

Represents a vulnerability scanner.

4044 4045
| Field | Type | Description |
| ----- | ---- | ----------- |
4046 4047
| `externalId` | String | External ID of the vulnerability scanner |
| `name` | String | Name of the vulnerability scanner |
4048 4049
| `reportType` | VulnerabilityReportType | Type of the vulnerability report |
| `vendor` | String | Vendor of the vulnerability scanner |
4050

4051
### VulnerabilitySeveritiesCount
Avielle Wolfe's avatar
Avielle Wolfe committed
4052

4053
Represents vulnerability counts by severity.
Avielle Wolfe's avatar
Avielle Wolfe committed
4054

4055 4056
| Field | Type | Description |
| ----- | ---- | ----------- |
Avielle Wolfe's avatar
Avielle Wolfe committed
4057 4058 4059 4060 4061 4062
| `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 |
4063

4064
### VulnerableDependency
4065

4066
Represents a vulnerable dependency. Used in vulnerability location data.
4067

4068 4069
| Field | Type | Description |
| ----- | ---- | ----------- |
4070 4071 4072
| `package` | VulnerablePackage | The package associated with the vulnerable dependency |
| `version` | String | The version of the vulnerable dependency |

4073
### VulnerablePackage
4074

4075
Represents a vulnerable package. Used in vulnerability dependency data.
4076

4077 4078
| Field | Type | Description |
| ----- | ---- | ----------- |
4079
| `name` | String | The name of the vulnerable package |
4080

4081
### VulnerableProjectsByGrade
4082

4083
Represents vulnerability letter grades with associated projects.
4084

4085 4086
| Field | Type | Description |
| ----- | ---- | ----------- |
4087 4088
| `count` | Int! | Number of projects within this grade |
| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present |
4089
| `projects` | ProjectConnection! | Projects within this grade |
4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101

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

4102
Access level to a resource.
4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114

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

### AlertManagementAlertSort

4115
Values for sorting alerts.
4116 4117 4118

| Value | Description |
| ----- | ----------- |
4119 4120
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132
| `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 |
4133 4134
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
4135 4136
| `UPDATED_TIME_ASC` | Created time by ascending order |
| `UPDATED_TIME_DESC` | Created time by descending order |
4137 4138 4139 4140
| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. |
| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. |
| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. |
| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. |
4141

4142 4143 4144 4145 4146 4147 4148 4149 4150
### AlertManagementDomainFilter

Filters the alerts based on given domain.

| Value | Description |
| ----- | ----------- |
| `operations` | Alerts for operations domain  |
| `threat_monitoring` | Alerts for threat monitoring domain |

Sarah Yasonik's avatar
Sarah Yasonik committed
4151 4152 4153 4154 4155 4156 4157 4158 4159
### AlertManagementIntegrationType

Values of types of integrations.

| Value | Description |
| ----- | ----------- |
| `HTTP` | Integration with any monitoring tool |
| `PROMETHEUS` | Prometheus integration |

4160 4161
### AlertManagementSeverity

4162
Alert severity values.
4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174

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

### AlertManagementStatus

4175
Alert status values.
4176 4177 4178 4179 4180 4181 4182 4183

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

4184 4185 4186 4187 4188 4189
### AvailabilityEnum

User availability status.

| Value | Description |
| ----- | ----------- |
4190 4191
| `BUSY` | Busy |
| `NOT_SET` | Not Set |
4192

4193 4194
### BlobViewersType

4195
Types of blob viewers.
4196 4197 4198 4199 4200 4201 4202

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

lauraMon's avatar
lauraMon committed
4203 4204 4205 4206 4207 4208
### CiConfigStatus

Values for YAML processor result.

| Value | Description |
| ----- | ----------- |
4209 4210
| `INVALID` | The configuration file is not valid |
| `VALID` | The configuration file is valid |
lauraMon's avatar
lauraMon committed
4211

4212 4213
### CommitActionMode

4214
Mode of a commit action.
4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260

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

4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271
### ContainerRepositoryCleanupStatus

Status of the tags cleanup of a container repository.

| Value | Description |
| ----- | ----------- |
| `ONGOING` | The tags cleanup is ongoing. |
| `SCHEDULED` | The tags cleanup is scheduled and is going to be executed shortly. |
| `UNFINISHED` | The tags cleanup has been partially executed. There are still remaining tags to delete. |
| `UNSCHEDULED` | The tags cleanup is not scheduled. This is the default state. |

4272 4273 4274 4275 4276 4277 4278 4279 4280
### ContainerRepositoryStatus

Status of a container repository.

| Value | Description |
| ----- | ----------- |
| `DELETE_FAILED` | Delete Failed status. |
| `DELETE_SCHEDULED` | Delete Scheduled status. |

4281 4282 4283 4284
### DastScanTypeEnum

| Value | Description |
| ----- | ----------- |
4285
| `ACTIVE` | Active DAST scan. This scan will make active attacks against the target site. |
4286 4287 4288 4289 4290 4291 4292 4293
| `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 |
4294
| `NONE` | No site validation exists |
4295 4296 4297
| `PASSED_VALIDATION` | Site validation process finished successfully |
| `PENDING_VALIDATION` | Site validation process has not started |

4298 4299 4300 4301 4302 4303 4304
### DastSiteValidationStrategyEnum

| Value | Description |
| ----- | ----------- |
| `HEADER` | Header validation |
| `TEXT_FILE` | Text file validation |

4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334
### DataVisualizationColorEnum

Color of the data visualization palette.

| Value | Description |
| ----- | ----------- |
| `AQUA` | Aqua color |
| `BLUE` | Blue color |
| `GREEN` | Green color |
| `MAGENTA` | Magenta color |
| `ORANGE` | Orange color |

### DataVisualizationWeightEnum

Weight of the data visualization palette.

| Value | Description |
| ----- | ----------- |
| `WEIGHT_100` | 100 weight |
| `WEIGHT_200` | 200 weight |
| `WEIGHT_300` | 300 weight |
| `WEIGHT_400` | 400 weight |
| `WEIGHT_50` | 50 weight |
| `WEIGHT_500` | 500 weight |
| `WEIGHT_600` | 600 weight |
| `WEIGHT_700` | 700 weight |
| `WEIGHT_800` | 800 weight |
| `WEIGHT_900` | 900 weight |
| `WEIGHT_950` | 950 weight |

4335 4336 4337 4338 4339 4340 4341 4342 4343 4344
### 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 |

4345 4346
### DesignVersionEvent

4347
Mutation event of a design within a version.
4348 4349 4350 4351 4352 4353 4354 4355 4356 4357

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

### DiffPositionType

4358
Type of file the position refers to.
4359 4360 4361 4362 4363 4364 4365 4366

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

### EntryType

4367
Type of a tree entry.
4368 4369 4370 4371 4372 4373 4374 4375 4376

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

### EpicSort

4377
Roadmap sort values.
4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397

| 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

4398
State event of an epic.
4399 4400 4401 4402 4403 4404 4405 4406

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

### EpicWildcardId

4407
Epic ID wildcard values.
4408 4409 4410 4411 4412 4413

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

4414 4415 4416 4417 4418 4419 4420 4421 4422 4423
### GroupMemberRelation

Group member relation.

| Value | Description |
| ----- | ----------- |
| `DESCENDANTS` | Descendants members |
| `DIRECT` | Direct members |
| `INHERITED` | Inherited members |

4424 4425
### HealthStatus

4426
Health status of an issue or epic.
4427 4428 4429 4430 4431 4432 4433 4434 4435

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

### IssuableSeverity

4436
Incident severity.
4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447

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

### IssuableState

4448
State of a GitLab issue or merge request.
4449 4450 4451 4452 4453 4454 4455 4456 4457 4458

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

### IssueSort

4459
Values for sorting issues.
4460 4461 4462

| Value | Description |
| ----- | ----------- |
4463 4464
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
4465 4466 4467 4468 4469 4470 4471 4472
| `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 |
4473 4474
| `PUBLISHED_ASC` | Published issues shown last |
| `PUBLISHED_DESC` | Published issues shown first |
4475
| `RELATIVE_POSITION_ASC` | Relative position by ascending order |
4476 4477
| `SEVERITY_ASC` | Severity from less critical to more critical |
| `SEVERITY_DESC` | Severity from more critical to less critical |
Tristan Read's avatar
Tristan Read committed
4478 4479
| `SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first |
| `SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first |
4480 4481
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
4482 4483
| `WEIGHT_ASC` | Weight by ascending order |
| `WEIGHT_DESC` | Weight by descending order |
4484 4485 4486 4487
| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. |
| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. |
| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. |
| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. |
4488 4489 4490

### IssueState

4491
State of a GitLab issue.
4492 4493 4494 4495 4496 4497 4498 4499

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

4500 4501 4502 4503 4504 4505 4506 4507 4508
### IssueStateEvent

Values for issue state events.

| Value | Description |
| ----- | ----------- |
| `CLOSE` | Closes the issue |
| `REOPEN` | Reopens the issue |

4509 4510
### IssueType

4511
Issue type.
4512 4513 4514 4515 4516 4517 4518 4519 4520

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

### IterationState

4521
State of a GitLab iteration.
4522 4523 4524 4525 4526 4527 4528 4529 4530

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

4531 4532 4533 4534 4535 4536 4537
### IterationWildcardId

Iteration ID wildcard values.

| Value | Description |
| ----- | ----------- |
| `ANY` | An iteration is assigned |
4538
| `CURRENT` | Current iteration |
4539 4540
| `NONE` | No iteration is assigned |

4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572
### JobArtifactFileType

| Value | Description |
| ----- | ----------- |
| `ACCESSIBILITY` |  |
| `API_FUZZING` |  |
| `ARCHIVE` |  |
| `BROWSER_PERFORMANCE` |  |
| `CLUSTER_APPLICATIONS` |  |
| `COBERTURA` |  |
| `CODEQUALITY` |  |
| `CONTAINER_SCANNING` |  |
| `COVERAGE_FUZZING` |  |
| `DAST` |  |
| `DEPENDENCY_SCANNING` |  |
| `DOTENV` |  |
| `JUNIT` |  |
| `LICENSE_MANAGEMENT` |  |
| `LICENSE_SCANNING` |  |
| `LOAD_PERFORMANCE` |  |
| `LSIF` |  |
| `METADATA` |  |
| `METRICS` |  |
| `METRICS_REFEREE` |  |
| `NETWORK_REFEREE` |  |
| `PERFORMANCE` |  |
| `REQUIREMENTS` |  |
| `SAST` |  |
| `SECRET_DETECTION` |  |
| `TERRAFORM` |  |
| `TRACE` |  |

4573 4574
### ListLimitMetric

4575
List limit metric setting.
4576 4577 4578 4579 4580 4581 4582 4583 4584

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

### MeasurementIdentifier

4585
Possible identifier types for a measurement.
4586 4587 4588 4589 4590 4591 4592

| Value | Description |
| ----- | ----------- |
| `GROUPS` | Group count |
| `ISSUES` | Issue count |
| `MERGE_REQUESTS` | Merge request count |
| `PIPELINES` | Pipeline count |
4593 4594 4595 4596
| `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 |
4597 4598 4599 4600 4601
| `PROJECTS` | Project count |
| `USERS` | User count |

### MergeRequestSort

4602
Values for sorting merge requests.
4603 4604 4605

| Value | Description |
| ----- | ----------- |
4606 4607
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
4608 4609 4610 4611 4612 4613 4614 4615
| `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 |
4616 4617
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
4618 4619 4620 4621
| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. |
| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. |
| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. |
| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. |
4622 4623 4624

### MergeRequestState

4625
State of a GitLab merge request.
4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643

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

### MilestoneStateEnum

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

### MoveType

4644
The position to which the adjacent object should be moved.
4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662

| 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

4663
Values for sorting projects.
4664 4665 4666 4667

| Value | Description |
| ----- | ----------- |
| `SIMILARITY` | Most similar to the search query |
4668
| `STORAGE` | Sort by storage size |
4669

4670 4671 4672 4673 4674 4675
### OncallRotationUnitEnum

Rotation length unit of an on-call rotation.

| Value | Description |
| ----- | ----------- |
4676 4677 4678
| `DAYS` | Days |
| `HOURS` | Hours |
| `WEEKS` | Weeks |
4679

4680 4681 4682 4683
### PackageTypeEnum

| Value | Description |
| ----- | ----------- |
ggelatti's avatar
ggelatti committed
4684 4685 4686 4687 4688 4689
| `COMPOSER` | Packages from the Composer package manager |
| `CONAN` | Packages from the Conan package manager |
| `DEBIAN` | Packages from the Debian package manager |
| `GENERIC` | Packages from the Generic package manager |
| `GOLANG` | Packages from the Golang package manager |
| `MAVEN` | Packages from the Maven package manager |
4690
| `NPM` | Packages from the NPM package manager |
ggelatti's avatar
ggelatti committed
4691
| `NUGET` | Packages from the Nuget package manager |
4692
| `PYPI` | Packages from the PyPI package manager |
4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722

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

4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733
### ProjectMemberRelation

Project member relation.

| Value | Description |
| ----- | ----------- |
| `DESCENDANTS` | Descendants members |
| `DIRECT` | Direct members |
| `INHERITED` | Inherited members |
| `INVITED_GROUPS` | Invited Groups members |

4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746
### 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

4747
Type of the link: `other`, `runbook`, `image`, `package`.
4748 4749 4750 4751 4752 4753 4754 4755

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

4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766
### ReleaseSort

Values for sorting releases.

| Value | Description |
| ----- | ----------- |
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
| `RELEASED_AT_ASC` | Released at by ascending order |
| `RELEASED_AT_DESC` | Released at by descending order |

4767 4768
### RequirementState

4769
State of a requirement.
4770 4771 4772 4773 4774 4775 4776 4777

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

### SastUiComponentSize

4778
Size of UI component in SAST configuration page.
4779 4780 4781 4782 4783 4784 4785

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

4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797
### SecurityReportTypeEnum

| Value | Description |
| ----- | ----------- |
| `API_FUZZING` | API FUZZING scan report |
| `CONTAINER_SCANNING` | CONTAINER SCANNING scan report |
| `COVERAGE_FUZZING` | COVERAGE FUZZING scan report |
| `DAST` | DAST scan report |
| `DEPENDENCY_SCANNING` | DEPENDENCY SCANNING scan report |
| `SAST` | SAST scan report |
| `SECRET_DETECTION` | SECRET DETECTION scan report |

4798 4799 4800 4801 4802 4803
### SecurityScannerType

The type of the security scanner.

| Value | Description |
| ----- | ----------- |
4804
| `API_FUZZING` |  |
4805 4806 4807 4808 4809 4810 4811 4812 4813
| `CONTAINER_SCANNING` |  |
| `COVERAGE_FUZZING` |  |
| `DAST` |  |
| `DEPENDENCY_SCANNING` |  |
| `SAST` |  |
| `SECRET_DETECTION` |  |

### SentryErrorStatus

4814
State of a Sentry error.
4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835

| 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` |  |
4836
| `DATADOG_SERVICE` |  |
4837 4838 4839
| `DISCORD_SERVICE` |  |
| `DRONE_CI_SERVICE` |  |
| `EMAILS_ON_PUSH_SERVICE` |  |
4840
| `EWM_SERVICE` |  |
4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866
| `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

4867
Type of a snippet blob input action.
4868 4869 4870 4871 4872 4873 4874 4875 4876 4877

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

### Sort

4878
Common sort values.
4879 4880 4881

| Value | Description |
| ----- | ----------- |
4882 4883 4884 4885
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
4886 4887 4888 4889
| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. |
| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. |
| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. |
| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. |
4890 4891 4892

### TestReportState

4893
State of a test report.
4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938

| 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

4939
Possible states of a user.
4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962

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

4963 4964 4965 4966 4967 4968
### VulnerabilityDismissalReason

The dismissal reason of the Vulnerability.

| Value | Description |
| ----- | ----------- |
4969 4970 4971 4972 4973
| `ACCEPTABLE_RISK` | The likelihood of the Vulnerability occurring and its impact are deemed acceptable |
| `FALSE_POSITIVE` | The Vulnerability was incorrectly identified as being present |
| `MITIGATING_CONTROL` | There is a mitigating control that eliminates the Vulnerability or makes its risk acceptable |
| `NOT_APPLICABLE` | Other reasons for dismissal |
| `USED_IN_TESTS` | The Vulnerability is used in tests and does not pose an actual risk |
4974

4975 4976 4977 4978 4979 4980 4981 4982
### VulnerabilityExternalIssueLinkExternalTracker

The external tracker of the external issue link related to a vulnerability.

| Value | Description |
| ----- | ----------- |
| `JIRA` | Jira external tracker |

4983 4984 4985 4986 4987 4988 4989 4990
### VulnerabilityExternalIssueLinkType

The type of the external issue link related to a vulnerability.

| Value | Description |
| ----- | ----------- |
| `CREATED` | Created link type |

4991 4992
### VulnerabilityGrade

4993
The grade of the vulnerable project.
4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017

| 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 |
| ----- | ----------- |
5018
| `API_FUZZING` |  |
5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040
| `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

5041
Vulnerability sort values.
5042 5043 5044

| Value | Description |
| ----- | ----------- |
5045 5046
| `detected_asc` | Detection timestamp in ascending order |
| `detected_desc` | Detection timestamp in descending order |
5047 5048
| `report_type_asc` | Report Type in ascending order |
| `report_type_desc` | Report Type in descending order |
5049 5050
| `severity_asc` | Severity in ascending order |
| `severity_desc` | Severity in descending order |
5051 5052
| `state_asc` | State in ascending order |
| `state_desc` | State in descending order |
5053 5054
| `title_asc` | Title in ascending order |
| `title_desc` | Title in descending order |
5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065

### VulnerabilityState

The state of the vulnerability.

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