index.md 249 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
<!-- vale gitlab.Spelling = NO -->

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
## Queries

Queries are used to get the resources, filter or query them.

For more information, visit [Queries and Mutations](https://graphql.org/learn/queries/).

### CiApplicationSettings

CI related settings that apply to the entire instance.

### CiConfig

Get linted and processed contents of a CI config. Should not be requested more than once per request.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `content` | Contents of `.gitlab-ci.yml`. | String! |
| `dryRun` | Run pipeline creation simulation, or only do static check. | Boolean |
| `projectPath` | The project of the CI config. | ID! |

### ContainerRepository

Find a container repository.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `id` | The global ID of the container repository. | ContainerRepositoryID! |

### CurrentUser

Get information about current user.

### DesignManagement

Fields related to design management.

65 66 67 68 69 70 71 72 73 74 75
### DevopsAdoptionSegments

Get configured DevOps adoption segments on the instance.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `first` | Returns the first _n_ elements from the list. | Int |
| `last` | Returns the last _n_ elements from the list. | Int |

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
### Echo

Text to echo back.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `text` | Text to echo back. | String! |

### GeoNode

Find a Geo node.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `name` | The name of the Geo node. Defaults to the current Geo node name. | String |

### Group

Find a group.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! |

### InstanceSecurityDashboard

Fields related to Instance Security Dashboard.

104 105
### InstanceStatisticsMeasurements

106
Get statistics on the instance. Deprecated in 13.10: This field was renamed. Use the `usageTrendsMeasurements` field instead.
107 108 109 110 111 112 113 114 115 116 117

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `first` | Returns the first _n_ elements from the list. | Int |
| `identifier` | The type of measurement/statistics to retrieve. | MeasurementIdentifier! |
| `last` | Returns the last _n_ elements from the list. | Int |
| `recordedAfter` | Measurement recorded after this date. | Time |
| `recordedBefore` | Measurement recorded before this date. | Time |

118 119 120 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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
### Issue

Find an Issue.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `id` | The global ID of the Issue. | IssueID! |

### Iteration

Find an iteration.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `id` | Find an iteration by its ID. | IterationID! |

### Metadata

Metadata about GitLab.

### Milestone

Find a milestone.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `id` | Find a milestone by its ID. | MilestoneID! |

### Namespace

Find a namespace.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! |

### Package

Find a package.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `id` | The global ID of the package. | PackagesPackageID! |

### Project

Find a project.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! |

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
### Projects

Find projects visible to the current user.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `first` | Returns the first _n_ elements from the list. | Int |
| `ids` | Filter projects by IDs. | ID! => Array |
| `last` | Returns the last _n_ elements from the list. | Int |
| `membership` | Limit projects that the current user is a member of. | Boolean |
| `search` | Search query for project name, path, or description. | String |
| `searchNamespaces` | Include namespace in project search. | Boolean |
| `sort` | Sort order of results. | String |

### RunnerPlatforms

Supported runner platforms.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `first` | Returns the first _n_ elements from the list. | Int |
| `last` | Returns the last _n_ elements from the list. | Int |

197 198 199 200 201 202 203 204 205 206 207
### RunnerSetup

Get runner setup instructions.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `architecture` | Architecture to generate the instructions for. | String! |
| `groupId` | Group to register the runner for. | GroupID |
| `platform` | Platform to generate the instructions for. | String! |
| `projectId` | Project to register the runner for. | ProjectID |

208 209 210 211 212 213 214 215 216 217 218
### Snippets

Find Snippets visible to the current user.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `authorId` | The ID of an author. | UserID |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `explore` | Explore personal snippets. | Boolean |
| `first` | Returns the first _n_ elements from the list. | Int |
219
| `ids` | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | SnippetID! => Array |
220 221 222 223 224
| `last` | Returns the last _n_ elements from the list. | Int |
| `projectId` | The ID of a project. | ProjectID |
| `type` | The type of snippet. | TypeEnum |
| `visibility` | The visibility of the snippet. | VisibilityScopesEnum |

Sean Arnold's avatar
Sean Arnold committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238
### UsageTrendsMeasurements

Get statistics on the instance.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `first` | Returns the first _n_ elements from the list. | Int |
| `identifier` | The type of measurement/statistics to retrieve. | MeasurementIdentifier! |
| `last` | Returns the last _n_ elements from the list. | Int |
| `recordedAfter` | Measurement recorded after this date. | Time |
| `recordedBefore` | Measurement recorded before this date. | Time |

239 240 241 242 243 244 245 246 247
### User

Find a user.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `id` | ID of the User. | UserID |
| `username` | Username of the User. | String |

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
### Users

Find users.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `admins` | Return only admin users. | Boolean |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `first` | Returns the first _n_ elements from the list. | Int |
| `ids` | List of user Global IDs. | ID! => Array |
| `last` | Returns the last _n_ elements from the list. | Int |
| `search` | Query to search users by name, username, or primary email. | String |
| `sort` | Sort users by this criteria. | Sort |
| `usernames` | List of usernames. | String! => Array |

### Vulnerabilities

Vulnerabilities reported on projects on the current user's instance security dashboard.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `first` | Returns the first _n_ elements from the list. | Int |
| `hasIssues` | Returns only the vulnerabilities which have linked issues. | Boolean |
| `hasResolution` | Returns only the vulnerabilities which have been resolved on default branch. | Boolean |
| `last` | Returns the last _n_ elements from the list. | Int |
| `projectId` | Filter vulnerabilities by project. | ID! => Array |
| `reportType` | Filter vulnerabilities by report type. | VulnerabilityReportType! => Array |
| `scanner` | Filter vulnerabilities by VulnerabilityScanner.externalId. | String! => Array |
| `severity` | Filter vulnerabilities by severity. | VulnerabilitySeverity! => Array |
| `sort` | List vulnerabilities by sort order. | VulnerabilitySort |
| `state` | Filter vulnerabilities by state. | VulnerabilityState! => Array |

### VulnerabilitiesCountByDay

Number of vulnerabilities per day for the projects on the current user's instance security dashboard.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `endDate` | Last day for which to fetch vulnerability history. | ISO8601Date! |
| `first` | Returns the first _n_ elements from the list. | Int |
| `last` | Returns the last _n_ elements from the list. | Int |
| `startDate` | First day for which to fetch vulnerability history. | ISO8601Date! |

### VulnerabilitiesCountByDayAndSeverity

Number of vulnerabilities per severity level, per day, for the projects on the current user's instance security dashboard. Deprecated in 13.3: Use `vulnerabilitiesCountByDay`.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `after` | Returns the elements in the list that come after the specified cursor. | String |
| `before` | Returns the elements in the list that come before the specified cursor. | String |
| `endDate` | Last day for which to fetch vulnerability history. | ISO8601Date! |
| `first` | Returns the first _n_ elements from the list. | Int |
| `last` | Returns the last _n_ elements from the list. | Int |
| `startDate` | First day for which to fetch vulnerability history. | ISO8601Date! |

309 310 311 312 313 314 315 316
### Vulnerability

Find a vulnerability.

| Name | Description | Type |
| ----- | ---- | ----------- |
| `id` | The Global ID of the Vulnerability. | VulnerabilityID! |

317 318
## Object types

319
Object types represent the resources that the GitLab GraphQL API can return.
320 321 322 323 324 325 326 327 328
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
329

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

332 333
| Field | Type | Description |
| ----- | ---- | ----------- |
334 335
| `integerValue` | Int | Integer representation of access level. |
| `stringValue` | AccessLevelEnum | String representation of access level. |
336

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

339
Autogenerated return type of AddAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
340

341 342
| Field | Type | Description |
| ----- | ---- | ----------- |
343
| `awardEmoji` | AwardEmoji | The award emoji after mutation. |
Felipe Artur's avatar
Felipe Artur committed
344
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
345
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
346

347
### AddProjectToSecurityDashboardPayload
348

349
Autogenerated return type of AddProjectToSecurityDashboard.
350

351 352
| Field | Type | Description |
| ----- | ---- | ----------- |
353
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
354
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
355
| `project` | Project | Project that was added to the Instance Security Dashboard. |
356

357
### AdminSidekiqQueuesDeleteJobsPayload
358

359
Autogenerated return type of AdminSidekiqQueuesDeleteJobs.
360

361 362
| Field | Type | Description |
| ----- | ---- | ----------- |
363
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
364
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
365
| `result` | DeleteJobsResponse | Information about the status of the deletion request. |
366

367
### AlertManagementAlert
368

369
Describes an alert from the project's Alert Management.
370

371 372
| Field | Type | Description |
| ----- | ---- | ----------- |
373 374 375 376 377
| `assignees` | UserConnection | Assignees of the alert. |
| `createdAt` | Time | Timestamp the alert was created. |
| `description` | String | Description of the alert. |
| `details` | JSON | Alert details. |
| `detailsUrl` | String! | The URL of the alert detail page. |
378
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
379 380 381 382 383 384 385 386
| `endedAt` | Time | Timestamp the alert ended. |
| `environment` | Environment | Environment for the alert. |
| `eventCount` | Int | Number of events of this alert. |
| `hosts` | String! => Array | List of hosts the alert came from. |
| `iid` | ID! | Internal ID of the alert. |
| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert. |
| `metricsDashboardUrl` | String | URL for metrics embed for the alert. |
| `monitoringTool` | String | Monitoring tool the alert came from. |
387
| `notes` | NoteConnection! | All notes on this noteable. |
388 389 390 391 392 393 394
| `prometheusAlert` | PrometheusAlert | The alert condition for Prometheus. |
| `runbook` | String | Runbook for the alert as defined in alert details. |
| `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. |
395
| `todos` | TodoConnection | To-do items of the current user for the alert. |
396
| `updatedAt` | Time | Timestamp the alert was last updated. |
397

398
### AlertManagementAlertStatusCountsType
399

400
Represents total number of alerts for the represented categories.
401

402 403
| Field | Type | Description |
| ----- | ---- | ----------- |
404
| `acknowledged` | Int | Number of alerts with status ACKNOWLEDGED for the project |
405
| `all` | Int | Total number of alerts for the project. |
406
| `ignored` | Int | Number of alerts with status IGNORED for the project |
407
| `open` | Int | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project. |
408 409 410
| `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
411 412 413 414 415 416
### AlertManagementHttpIntegration

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

| Field | Type | Description |
| ----- | ---- | ----------- |
417 418 419 420
| `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. |
421
| `payloadAlertFields` | AlertManagementPayloadAlertField! => Array | Extract alert fields from payload example for custom mapping. |
422 423
| `payloadAttributeMappings` | AlertManagementPayloadAlertMappingField! => Array | The custom mapping of GitLab alert attributes to fields from the payload_example. |
| `payloadExample` | JsonString | The example of an alert payload. |
424 425 426
| `token` | String | Token used to authenticate alert notification requests. |
| `type` | AlertManagementIntegrationType! | Type of integration. |
| `url` | String | Endpoint which accepts alert notifications. |
Sarah Yasonik's avatar
Sarah Yasonik committed
427

428 429 430 431 432 433 434 435 436 437
### AlertManagementPayloadAlertField

Parsed field from an alert used for custom mappings.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `label` | String | Human-readable label of the payload path. |
| `path` | String! => Array | Path to value inside payload JSON. |
| `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. |

438 439 440 441 442 443 444 445 446 447 448
### AlertManagementPayloadAlertMappingField

Parsed field (with its name) from an alert used for custom mappings.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `fieldName` | AlertManagementPayloadAlertFieldName | A GitLab alert field name. |
| `label` | String | Human-readable label of the payload path. |
| `path` | String! => Array | Path to value inside payload JSON. |
| `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. |

Sarah Yasonik's avatar
Sarah Yasonik committed
449 450 451 452 453 454
### AlertManagementPrometheusIntegration

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

| Field | Type | Description |
| ----- | ---- | ----------- |
455 456 457 458 459 460 461
| `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. |
Sarah Yasonik's avatar
Sarah Yasonik committed
462

463
### AlertSetAssigneesPayload
464

465
Autogenerated return type of AlertSetAssignees.
466

467 468
| Field | Type | Description |
| ----- | ---- | ----------- |
469
| `alert` | AlertManagementAlert | The alert after mutation. |
470 471
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
472
| `issue` | Issue | The issue created after mutation. |
473
| `todo` | Todo | The to-do item after mutation. |
Allison Browne's avatar
Allison Browne committed
474

475
### AlertTodoCreatePayload
Allison Browne's avatar
Allison Browne committed
476

477
Autogenerated return type of AlertTodoCreate.
Allison Browne's avatar
Allison Browne committed
478

479 480
| Field | Type | Description |
| ----- | ---- | ----------- |
481
| `alert` | AlertManagementAlert | The alert after mutation. |
Allison Browne's avatar
Allison Browne committed
482 483
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
484
| `issue` | Issue | The issue created after mutation. |
485
| `todo` | Todo | The to-do item after mutation. |
486

487 488 489 490 491 492 493 494 495
### ApiFuzzingCiConfiguration

Data associated with configuring API fuzzing scans in GitLab CI.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `scanModes` | ApiFuzzingScanMode! => Array | All available scan modes. |
| `scanProfiles` | ApiFuzzingScanProfile! => Array | All default scan profiles. |

496 497 498 499 500 501 502 503 504 505 506
### ApiFuzzingCiConfigurationCreatePayload

Autogenerated return type of ApiFuzzingCiConfigurationCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `configurationYaml` | String | A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `gitlabCiYamlEditPath` | String | The location at which the project's `.gitlab-ci.yml` file can be edited in the browser. |

507 508
### ApiFuzzingScanProfile

509
An API Fuzzing scan profile.
510 511 512 513 514 515 516

| Field | Type | Description |
| ----- | ---- | ----------- |
| `description` | String | A short description of the profile. |
| `name` | String | The unique name of the profile. |
| `yaml` | String | A syntax highlit HTML representation of the YAML. |

517
### AwardEmoji
518 519

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

521 522
| Field | Type | Description |
| ----- | ---- | ----------- |
523 524 525
| `description` | String! | The emoji description. |
| `emoji` | String! | The emoji as an icon. |
| `name` | String! | The emoji name. |
526 527
| `unicode` | String! | The emoji in Unicode. |
| `unicodeVersion` | String! | The Unicode version for this emoji. |
528
| `user` | User! | The user who awarded the emoji. |
Felipe Artur's avatar
Felipe Artur committed
529

530
### AwardEmojiAddPayload
531

532
Autogenerated return type of AwardEmojiAdd.
533

534 535
| Field | Type | Description |
| ----- | ---- | ----------- |
536
| `awardEmoji` | AwardEmoji | The award emoji after mutation. |
537 538 539
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

540
### AwardEmojiRemovePayload
541

542
Autogenerated return type of AwardEmojiRemove.
543

544 545
| Field | Type | Description |
| ----- | ---- | ----------- |
546
| `awardEmoji` | AwardEmoji | The award emoji after mutation. |
547 548 549
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

550
### AwardEmojiTogglePayload
551

552
Autogenerated return type of AwardEmojiToggle.
553

554 555
| Field | Type | Description |
| ----- | ---- | ----------- |
556
| `awardEmoji` | AwardEmoji | The award emoji after mutation. |
557 558 559 560
| `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. |

561
### BaseService
562

563 564
| Field | Type | Description |
| ----- | ---- | ----------- |
565 566
| `active` | Boolean | Indicates if the service is active. |
| `type` | String | Class name of the service. |
567

568
### Blob
Felipe Artur's avatar
Felipe Artur committed
569

570 571
| Field | Type | Description |
| ----- | ---- | ----------- |
572 573 574 575 576 577 578 579 580 581
| `flatPath` | String! | Flat path of the entry. |
| `id` | ID! | ID of the entry. |
| `lfsOid` | String | LFS ID of the blob. |
| `mode` | String | Blob mode in numeric format. |
| `name` | String! | Name of the entry. |
| `path` | String! | Path of the entry. |
| `sha` | String! | Last commit SHA for the entry. |
| `type` | EntryType! | Type of tree entry. |
| `webPath` | String | Web path of the blob. |
| `webUrl` | String | Web URL of the blob. |
Felipe Artur's avatar
Felipe Artur committed
582

583
### Board
584

585
Represents a project or group issue board.
586

587 588
| Field | Type | Description |
| ----- | ---- | ----------- |
589 590
| `assignee` | User | The board assignee. |
| `epics` | BoardEpicConnection | Epics associated with board issues. |
591 592 593
| `hideBacklogList` | Boolean | Whether or not backlog list is hidden. |
| `hideClosedList` | Boolean | Whether or not closed list is hidden. |
| `id` | ID! | ID (global ID) of the board. |
594
| `iteration` | Iteration | The board iteration. |
595
| `labels` | LabelConnection | Labels of the board. |
596
| `lists` | BoardListConnection | Lists of the board. |
597
| `milestone` | Milestone | The board milestone. |
598
| `name` | String | Name of the board. |
599 600
| `webPath` | String! | Web path of the board. |
| `webUrl` | String! | Web URL of the board. |
601
| `weight` | Int | Weight of the board. |
602

603 604 605 606 607 608
### BoardEpic

Represents an epic on an issue board.

| Field | Type | Description |
| ----- | ---- | ----------- |
609 610 611 612 613 614
| `author` | User! | Author of the epic. |
| `awardEmoji` | AwardEmojiConnection | A list of award emojis associated with the epic. |
| `children` | EpicConnection | Children (sub-epics) of the epic. |
| `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. |
615
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
616 617 618
| `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. |
619
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
620 621 622 623 624
| `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. |
625
| `events` | EventConnection | A list of events associated with the object. |
626 627 628 629 630 631 632 633 634
| `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. |
| `issues` | EpicIssueConnection | A list of issues associated with the epic. |
| `labels` | LabelConnection | Labels assigned to the epic. |
635
| `notes` | NoteConnection! | All notes on this noteable. |
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
| `parent` | Epic | Parent epic of the epic. |
| `participants` | UserConnection | List of participants for the epic. |
| `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. |
| `userDiscussionsCount` | Int! | Number of user discussions in the epic. |
| `userNotesCount` | Int! | Number of user notes of the epic. |
652
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
653
| `userPreferences` | BoardEpicUserPreferences | User preferences for the epic on the issue board. |
654 655
| `webPath` | String! | Web path of the epic. |
| `webUrl` | String! | Web URL of the epic. |
656 657 658 659 660 661 662

### BoardEpicUserPreferences

Represents user preferences for a board epic.

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

665
### BoardList
666

667
Represents a list for an issue board.
668

669 670
| Field | Type | Description |
| ----- | ---- | ----------- |
671
| `assignee` | User | Assignee in the list. |
672 673 674 675
| `collapsed` | Boolean | Indicates if list is collapsed for this user. |
| `id` | ID! | ID (global ID) of the list. |
| `issues` | IssueConnection | Board issues. |
| `issuesCount` | Int | Count of issues in the list. |
676
| `iteration` | Iteration | Iteration of the list. |
677
| `label` | Label | Label of the list. |
678
| `limitMetric` | ListLimitMetric | The current limit metric for the list. |
679
| `listType` | String! | Type of the list. |
680 681 682
| `maxIssueCount` | Int | Maximum number of issues in the list. |
| `maxIssueWeight` | Int | Maximum weight of issues in the list. |
| `milestone` | Milestone | Milestone of the list. |
683 684
| `position` | Int | Position of list within the board. |
| `title` | String! | Title of the list. |
685
| `totalWeight` | Int | Total weight of all issues in the list. |
686

687
### BoardListCreatePayload
688

689
Autogenerated return type of BoardListCreate.
690

691 692
| Field | Type | Description |
| ----- | ---- | ----------- |
693 694
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
695
| `list` | BoardList | Issue list in the issue board. |
696

697
### BoardListUpdateLimitMetricsPayload
698

699
Autogenerated return type of BoardListUpdateLimitMetrics.
700

701 702
| Field | Type | Description |
| ----- | ---- | ----------- |
703
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
704
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
705
| `list` | BoardList | The updated list. |
706

707
### Branch
708

709 710
| Field | Type | Description |
| ----- | ---- | ----------- |
711 712
| `commit` | Commit | Commit for the branch. |
| `name` | String! | Name of the branch. |
713

714
### BurnupChartDailyTotals
715 716 717

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

718 719
| Field | Type | Description |
| ----- | ---- | ----------- |
720 721 722 723 724
| `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. |
725

726 727 728 729 730 731
### CiApplicationSettings

| Field | Type | Description |
| ----- | ---- | ----------- |
| `keepLatestArtifact` | Boolean | Whether to keep the latest jobs artifacts. |

732 733 734 735 736 737
### CiBuildNeed

| Field | Type | Description |
| ----- | ---- | ----------- |
| `name` | String | Name of the job we need to complete. |

738 739 740 741 742 743 744 745 746
### CiCdSettingsUpdatePayload

Autogenerated return type of CiCdSettingsUpdate.

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

lauraMon's avatar
lauraMon committed
747 748 749 750
### CiConfig

| Field | Type | Description |
| ----- | ---- | ----------- |
751
| `errors` | String! => Array | Linting errors. |
752
| `mergedYaml` | String | Merged CI configuration YAML. |
753 754
| `stages` | CiConfigStageConnection | Stages of the pipeline. |
| `status` | CiConfigStatus | Status of linting, can be either valid or invalid. |
lauraMon's avatar
lauraMon committed
755 756 757 758 759

### CiConfigGroup

| Field | Type | Description |
| ----- | ---- | ----------- |
760 761 762
| `jobs` | CiConfigJobConnection | Jobs in group. |
| `name` | String | Name of the job group. |
| `size` | Int | Size of the job group. |
lauraMon's avatar
lauraMon committed
763 764 765 766 767

### CiConfigJob

| Field | Type | Description |
| ----- | ---- | ----------- |
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
| `afterScript` | String! => Array | Override a set of commands that are executed after the job. |
| `allowFailure` | Boolean | Allow job to fail. |
| `beforeScript` | String! => Array | Override a set of commands that are executed before the job. |
| `environment` | String | Name of an environment to which the job deploys. |
| `except` | CiConfigJobRestriction | Limit when jobs are not created. |
| `groupName` | String | Name of the job group. |
| `name` | String | Name of the job. |
| `needs` | CiConfigNeedConnection | Builds that must complete before the jobs run. |
| `only` | CiConfigJobRestriction | Jobs are created when these conditions do not apply. |
| `script` | String! => Array | Shell script that is executed by a runner. |
| `stage` | String | Name of the job stage. |
| `tags` | String! => Array | List of tags that are used to select a runner. |
| `when` | String | When to run the job. |

### CiConfigJobRestriction

| Field | Type | Description |
| ----- | ---- | ----------- |
| `refs` | String! => Array | The Git refs the job restriction applies to. |
lauraMon's avatar
lauraMon committed
787 788 789 790 791

### CiConfigNeed

| Field | Type | Description |
| ----- | ---- | ----------- |
792
| `name` | String | Name of the need. |
lauraMon's avatar
lauraMon committed
793 794 795 796 797

### CiConfigStage

| Field | Type | Description |
| ----- | ---- | ----------- |
798 799
| `groups` | CiConfigGroupConnection | Groups of jobs for the stage. |
| `name` | String | Name of the stage. |
lauraMon's avatar
lauraMon committed
800

801
### CiGroup
Laura Montemayor's avatar
Laura Montemayor committed
802

803 804
| Field | Type | Description |
| ----- | ---- | ----------- |
805 806 807 808
| `detailedStatus` | DetailedStatus | Detailed status of the group. |
| `jobs` | CiJobConnection | Jobs in group. |
| `name` | String | Name of the job group. |
| `size` | Int | Size of the group. |
Laura Montemayor's avatar
Laura Montemayor committed
809

810
### CiJob
Laura Montemayor's avatar
Laura Montemayor committed
811

812 813
| Field | Type | Description |
| ----- | ---- | ----------- |
814 815 816 817 818 819
| `artifacts` | CiJobArtifactConnection | Artifacts generated by the job. |
| `detailedStatus` | DetailedStatus | Detailed status of the job. |
| `name` | String | Name of the job. |
| `needs` | CiBuildNeedConnection | References to builds that must complete before the jobs run. |
| `pipeline` | Pipeline | Pipeline the job belongs to. |
| `scheduledAt` | Time | Schedule for the build. |
Laura Montemayor's avatar
Laura Montemayor committed
820

821 822 823 824
### CiJobArtifact

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

828
### CiStage
Laura Montemayor's avatar
Laura Montemayor committed
829

830 831
| Field | Type | Description |
| ----- | ---- | ----------- |
832 833 834
| `detailedStatus` | DetailedStatus | Detailed status of the stage. |
| `groups` | CiGroupConnection | Group of jobs for the stage. |
| `name` | String | Name of the stage. |
Laura Montemayor's avatar
Laura Montemayor committed
835

836
### ClusterAgent
837

838 839
| Field | Type | Description |
| ----- | ---- | ----------- |
840
| `createdAt` | Time | Timestamp the cluster agent was created. |
841
| `createdByUser` | User | User object, containing information about the person who created the agent. |
842 843 844 845 846
| `id` | ID! | ID of the cluster agent. |
| `name` | String | Name of the cluster agent. |
| `project` | Project | The project this cluster agent is associated with. |
| `tokens` | ClusterAgentTokenConnection | Tokens associated with the cluster agent. |
| `updatedAt` | Time | Timestamp the cluster agent was updated. |
847

848
### ClusterAgentDeletePayload
849

850
Autogenerated return type of ClusterAgentDelete.
851

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

857
### ClusterAgentToken
858

859 860
| Field | Type | Description |
| ----- | ---- | ----------- |
861 862
| `clusterAgent` | ClusterAgent | Cluster agent this token is associated with. |
| `createdAt` | Time | Timestamp the token was created. |
863
| `createdByUser` | User | The user who created the token. |
864
| `description` | String | Description of the token. |
865
| `id` | ClustersAgentTokenID! | Global ID of the token. |
866

867
### ClusterAgentTokenCreatePayload
868

869
Autogenerated return type of ClusterAgentTokenCreate.
870

871 872
| Field | Type | Description |
| ----- | ---- | ----------- |
873 874
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
875 876
| `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. |
877

878
### ClusterAgentTokenDeletePayload
879

880
Autogenerated return type of ClusterAgentTokenDelete.
881

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

887 888 889 890 891 892 893 894 895 896 897
### 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. |

898 899 900 901 902 903 904 905
### 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. |
906
| `lastUpdatedOn` | Date | Latest date when the code coverage was created for the project. |
907

908
### Commit
Felipe Artur's avatar
Felipe Artur committed
909

910 911
| Field | Type | Description |
| ----- | ---- | ----------- |
912 913 914 915 916
| `author` | User | Author of the commit. |
| `authorGravatar` | String | Commit authors gravatar. |
| `authorName` | String | Commit authors name. |
| `authoredDate` | Time | Timestamp of when the commit was authored. |
| `description` | String | Description of the commit message. |
917
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
918 919 920 921 922 923 924
| `id` | ID! | ID (global ID) of the commit. |
| `message` | String | Raw commit message. |
| `pipelines` | PipelineConnection | Pipelines of the commit ordered latest first. |
| `sha` | String! | SHA1 ID of the commit. |
| `shortId` | String! | Short SHA1 ID of the commit. |
| `signatureHtml` | String | Rendered HTML of the commit signature. |
| `title` | String | Title of the commit message. |
925
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
926 927
| `webPath` | String! | Web path of the commit. |
| `webUrl` | String! | Web URL of the commit. |
Felipe Artur's avatar
Felipe Artur committed
928

929
### CommitCreatePayload
930

931
Autogenerated return type of CommitCreate.
932

933 934
| Field | Type | Description |
| ----- | ---- | ----------- |
935
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
936
| `commit` | Commit | The commit after mutation. |
937 938
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

939
### ComplianceFramework
940

941
Represents a ComplianceFramework associated with a Project.
942

943 944
| Field | Type | Description |
| ----- | ---- | ----------- |
945 946 947 948
| `color` | String! | Hexadecimal representation of compliance framework's label color. |
| `description` | String! | Description of the compliance framework. |
| `id` | ID! | Compliance framework ID. |
| `name` | String! | Name of the compliance framework. |
949
| `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. |
950

951 952 953 954 955 956 957 958 959
### ComposerMetadata

Composer metadata.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `composerJson` | PackageComposerJsonType! | Data of the Composer JSON file. |
| `targetSha` | String! | Target SHA of the package. |

960
### ConfigureSastPayload
961

962
Autogenerated return type of ConfigureSast.
963

964 965
| Field | Type | Description |
| ----- | ---- | ----------- |
966 967
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
968 969
| `status` | String! | Status of creating the commit for the supplied SAST CI configuration. |
| `successPath` | String | Redirect path to use when the response is successful. |
970

971
### ContainerExpirationPolicy
972

973
A tag expiration policy designed to keep only the images that matter most.
974

975 976
| Field | Type | Description |
| ----- | ---- | ----------- |
977 978 979 980 981 982 983 984 985
| `cadence` | ContainerExpirationPolicyCadenceEnum! | This container expiration policy schedule. |
| `createdAt` | Time! | Timestamp of when the container expiration policy was created. |
| `enabled` | Boolean! | Indicates whether this container expiration policy is enabled. |
| `keepN` | ContainerExpirationPolicyKeepEnum | Number of tags to retain. |
| `nameRegex` | UntrustedRegexp | Tags with names matching this regex pattern will expire. |
| `nameRegexKeep` | UntrustedRegexp | Tags with names matching this regex pattern will be preserved. |
| `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. |
986

987 988 989 990 991 992 993 994
### 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. |
995
| `expirationPolicyCleanupStatus` | ContainerRepositoryCleanupStatus | The tags cleanup status for the container repository. |
996 997 998 999 1000
| `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. |
1001
| `project` | Project! | Project of the container registry. |
1002 1003 1004 1005
| `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. |

1006 1007 1008 1009 1010 1011 1012 1013
### 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. |
1014
| `expirationPolicyCleanupStatus` | ContainerRepositoryCleanupStatus | The tags cleanup status for the container repository. |
1015 1016 1017 1018 1019
| `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. |
1020
| `project` | Project! | Project of the container registry. |
1021
| `status` | ContainerRepositoryStatus | Status of the container repository. |
1022
| `tags` | ContainerRepositoryTagConnection | Tags of the container repository. |
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
| `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. |
1033 1034
| `createdAt` | Time | Timestamp when the tag was created. |
| `digest` | String | Digest of the tag. |
1035 1036 1037
| `location` | String! | URL of the tag. |
| `name` | String! | Name of the tag. |
| `path` | String! | Path of the tag. |
1038 1039
| `revision` | String | Revision of the tag. |
| `shortRevision` | String | Short revision of the tag. |
1040
| `totalSize` | BigInt | The size of the tag. |
1041

1042
### CreateAlertIssuePayload
1043

1044
Autogenerated return type of CreateAlertIssue.
1045

1046 1047
| Field | Type | Description |
| ----- | ---- | ----------- |
1048
| `alert` | AlertManagementAlert | The alert after mutation. |
1049 1050
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1051
| `issue` | Issue | The issue created after mutation. |
1052
| `todo` | Todo | The to-do item after mutation. |
1053

1054
### CreateAnnotationPayload
1055

1056
Autogenerated return type of CreateAnnotation.
1057

1058 1059
| Field | Type | Description |
| ----- | ---- | ----------- |
1060
| `annotation` | MetricsDashboardAnnotation | The created annotation. |
1061 1062 1063
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
### 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. |

1074
### CreateBranchPayload
1075

1076
Autogenerated return type of CreateBranch.
1077

1078 1079
| Field | Type | Description |
| ----- | ---- | ----------- |
1080
| `branch` | Branch | Branch after mutation. |
1081
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1082
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1083

1084
### CreateClusterAgentPayload
1085

1086
Autogenerated return type of CreateClusterAgent.
1087

1088 1089
| Field | Type | Description |
| ----- | ---- | ----------- |
1090
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1091
| `clusterAgent` | ClusterAgent | Cluster agent created after mutation. |
1092
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1093

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
### 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. |

1104 1105 1106 1107 1108 1109 1110
### CreateCustomEmojiPayload

Autogenerated return type of CreateCustomEmoji.

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

1114 1115 1116 1117 1118 1119 1120 1121
### 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. |
1122
| `segment` | DevopsAdoptionSegment | The segment after mutation. |
1123

1124
### CreateDiffNotePayload
1125

1126
Autogenerated return type of CreateDiffNote.
1127

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

1134
### CreateEpicPayload
1135

1136
Autogenerated return type of CreateEpic.
1137

1138 1139
| Field | Type | Description |
| ----- | ---- | ----------- |
1140
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1141
| `epic` | Epic | The created epic. |
1142
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1143

1144
### CreateImageDiffNotePayload
1145

1146
Autogenerated return type of CreateImageDiffNote.
1147

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

1154 1155 1156 1157 1158 1159 1160 1161
### 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. |
1162
| `issue` | Issue | The issue after mutation. |
1163

1164
### CreateIterationPayload
1165

1166
Autogenerated return type of CreateIteration.
1167

1168 1169
| Field | Type | Description |
| ----- | ---- | ----------- |
1170 1171
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1172
| `iteration` | Iteration | The created iteration. |
1173

1174
### CreateNotePayload
1175

1176
Autogenerated return type of CreateNote.
1177

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

1184
### CreateRequirementPayload
Jan Provaznik's avatar
Jan Provaznik committed
1185

1186
Autogenerated return type of CreateRequirement.
Jan Provaznik's avatar
Jan Provaznik committed
1187

1188 1189
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
1190
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1191
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1192
| `requirement` | Requirement | Requirement after mutation. |
Jan Provaznik's avatar
Jan Provaznik committed
1193

1194
### CreateSnippetPayload
1195

1196
Autogenerated return type of CreateSnippet.
1197

1198 1199
| Field | Type | Description |
| ----- | ---- | ----------- |
1200
| `captchaSiteKey` | String | The CAPTCHA site key which must be used to render a challenge for the user to solve to obtain a valid captchaResponse value. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. |
1201
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1202
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1203
| `needsCaptchaResponse` | Boolean | Indicates whether the operation was detected as possible spam and not completed. If CAPTCHA is enabled, the request must be resubmitted with a valid CAPTCHA response and spam_log_id included for the operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. |
1204
| `snippet` | Snippet | The snippet after mutation. |
1205 1206
| `spam` | Boolean | Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response. |
| `spamLogId` | Int | The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. |
1207

1208 1209
### CreateTestCasePayload

1210
Autogenerated return type of CreateTestCase.
1211 1212 1213 1214 1215

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

1218 1219 1220 1221 1222 1223
### CustomEmoji

A custom emoji uploaded by user.

| Field | Type | Description |
| ----- | ---- | ----------- |
1224 1225 1226 1227
| `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. |
1228

1229
### DastOnDemandScanCreatePayload
1230

1231
Autogenerated return type of DastOnDemandScanCreate.
1232

1233 1234
| Field | Type | Description |
| ----- | ---- | ----------- |
1235 1236 1237 1238
| `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. |

1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
### DastProfile

Represents a DAST Profile.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `dastScannerProfile` | DastScannerProfile | The associated scanner profile. |
| `dastSiteProfile` | DastSiteProfile | The associated site profile. |
| `description` | String | The description of the scan. |
| `editPath` | String | Relative web path to the edit page of a profile. |
| `id` | DastProfileID! | ID of the profile. |
| `name` | String | The name of the profile. |

1252 1253 1254 1255 1256 1257 1258 1259 1260
### DastProfileCreatePayload

Autogenerated return type of DastProfileCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `dastProfile` | DastProfile | The created profile. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1261
| `pipelineUrl` | String | The URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`. |
1262

1263 1264 1265 1266 1267 1268 1269 1270 1271
### DastProfileDeletePayload

Autogenerated return type of DastProfileDelete.

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

1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
### DastProfileRunPayload

Autogenerated return type of DastProfileRun.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `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. |

1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
### DastProfileUpdatePayload

Autogenerated return type of DastProfileUpdate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `dastProfile` | DastProfile | The updated profile. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `pipelineUrl` | String | The URL of the pipeline that was created. Requires the input argument `runAfterUpdate` to be set to `true` when calling the mutation, otherwise no pipeline will be created. |

1293
### DastScannerProfile
1294 1295 1296

Represents a DAST scanner profile.

1297 1298
| Field | Type | Description |
| ----- | ---- | ----------- |
1299
| `editPath` | String | Relative web path to the edit page of a scanner profile. |
1300
| `globalId` **{warning-solid}** | DastScannerProfileID! | **Deprecated:** Use `id`. Deprecated in 13.6. |
1301 1302
| `id` | DastScannerProfileID! | ID of the DAST scanner profile. |
| `profileName` | String | Name of the DAST scanner profile. |
1303 1304
| `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. |
1305 1306
| `spiderTimeout` | Int | The maximum number of minutes allowed for the spider to traverse the site. |
| `targetTimeout` | Int | The maximum number of seconds allowed for the site under test to respond to a request. |
1307
| `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. |
1308

1309
### DastScannerProfileCreatePayload
1310

1311
Autogenerated return type of DastScannerProfileCreate.
1312

1313 1314
| Field | Type | Description |
| ----- | ---- | ----------- |
1315 1316
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1317
| `globalId` **{warning-solid}** | DastScannerProfileID | **Deprecated:** Use `id`. Deprecated in 13.6. |
1318
| `id` | DastScannerProfileID | ID of the scanner profile. |
1319

1320
### DastScannerProfileDeletePayload
1321

1322
Autogenerated return type of DastScannerProfileDelete.
1323

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

1329
### DastScannerProfileUpdatePayload
1330

1331
Autogenerated return type of DastScannerProfileUpdate.
1332

1333 1334
| Field | Type | Description |
| ----- | ---- | ----------- |
1335 1336 1337 1338
| `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. |

1339
### DastSiteProfile
1340 1341 1342

Represents a DAST Site Profile.

1343 1344
| Field | Type | Description |
| ----- | ---- | ----------- |
1345 1346 1347 1348 1349
| `editPath` | String | Relative web path to the edit page of a site profile. |
| `id` | DastSiteProfileID! | ID of the site profile. |
| `normalizedTargetUrl` | String | Normalized URL of the target to be scanned. |
| `profileName` | String | The name of the site profile. |
| `targetUrl` | String | The URL of the target to be scanned. |
1350
| `userPermissions` | DastSiteProfilePermissions! | Permissions for the current user on the resource |
1351
| `validationStatus` | DastSiteProfileValidationStatusEnum | The current validation status of the site profile. |
1352

1353
### DastSiteProfileCreatePayload
1354

1355
Autogenerated return type of DastSiteProfileCreate.
1356

1357 1358
| Field | Type | Description |
| ----- | ---- | ----------- |
1359 1360
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1361
| `id` | DastSiteProfileID | ID of the site profile. |
1362

1363
### DastSiteProfileDeletePayload
1364

1365
Autogenerated return type of DastSiteProfileDelete.
1366

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

1372
### DastSiteProfilePermissions
1373

1374
Check permissions for the current user on site profile.
1375

1376 1377
| Field | Type | Description |
| ----- | ---- | ----------- |
1378 1379
| `createOnDemandDastScan` | Boolean! | Indicates the user can perform `create_on_demand_dast_scan` on this resource |

1380
### DastSiteProfileUpdatePayload
1381

1382
Autogenerated return type of DastSiteProfileUpdate.
1383

1384 1385
| Field | Type | Description |
| ----- | ---- | ----------- |
1386 1387 1388 1389
| `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. |

1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
### 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. |

1402 1403 1404 1405 1406 1407
### DastSiteValidation

Represents a DAST Site Validation.

| Field | Type | Description |
| ----- | ---- | ----------- |
1408 1409 1410
| `id` | DastSiteValidationID! | Global ID of the site validation. |
| `normalizedTargetUrl` | String | Normalized URL of the target to be validated. |
| `status` | DastSiteProfileValidationStatusEnum! | Status of the site validation. |
1411

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
### 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. |

1423 1424 1425 1426 1427 1428 1429 1430 1431
### DastSiteValidationRevokePayload

Autogenerated return type of DastSiteValidationRevoke.

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

1432
### DeleteAnnotationPayload
1433

1434
Autogenerated return type of DeleteAnnotation.
1435

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

1441 1442 1443 1444 1445 1446 1447 1448 1449
### 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. |

1450
### DeleteJobsResponse
1451 1452 1453

The response from the AdminSidekiqQueuesDeleteJobs mutation.

1454 1455
| Field | Type | Description |
| ----- | ---- | ----------- |
1456 1457 1458
| `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. |
1459

1460
### Design
1461

1462
A single design.
1463

1464 1465
| Field | Type | Description |
| ----- | ---- | ----------- |
1466
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
1467
| `diffRefs` | DiffRefs! | The diff refs for this design. |
1468
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
1469 1470 1471 1472 1473
| `event` | DesignVersionEvent! | How this design was changed in the current version. |
| `filename` | String! | The filename of the design. |
| `fullPath` | String! | The full path to the design file. |
| `id` | ID! | The ID of this design. |
| `image` | String! | The URL of the full-sized image. |
1474
| `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 |
1475
| `issue` | Issue! | The issue the design belongs to. |
1476
| `notes` | NoteConnection! | All notes on this noteable. |
1477 1478 1479
| `notesCount` | Int! | The total count of user-created notes for this design. |
| `project` | Project! | The project the design belongs to. |
| `versions` | DesignVersionConnection! | All versions related to this design ordered newest first. |
1480

1481
### DesignAtVersion
1482 1483 1484

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

1485 1486
| Field | Type | Description |
| ----- | ---- | ----------- |
1487 1488 1489 1490 1491 1492 1493
| `design` | Design! | The underlying design. |
| `diffRefs` | DiffRefs! | The diff refs for this design. |
| `event` | DesignVersionEvent! | How this design was changed in the current version. |
| `filename` | String! | The filename of the design. |
| `fullPath` | String! | The full path to the design file. |
| `id` | ID! | The ID of this design. |
| `image` | String! | The URL of the full-sized image. |
1494
| `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 |
1495 1496 1497 1498
| `issue` | Issue! | The issue the design belongs to. |
| `notesCount` | Int! | The total count of user-created notes for this design. |
| `project` | Project! | The project the design belongs to. |
| `version` | DesignVersion! | The version this design-at-versions is pinned to. |
1499

1500
### DesignCollection
1501 1502

A collection of designs.
1503

1504 1505
| Field | Type | Description |
| ----- | ---- | ----------- |
1506 1507 1508 1509 1510 1511 1512 1513
| `copyState` | DesignCollectionCopyState | Copy state of the design collection. |
| `design` | Design | Find a specific design. |
| `designAtVersion` | DesignAtVersion | Find a design as of a version. |
| `designs` | DesignConnection! | All designs for the design collection. |
| `issue` | Issue! | Issue associated with the design collection. |
| `project` | Project! | Project associated with the design collection. |
| `version` | DesignVersion | A specific version. |
| `versions` | DesignVersionConnection! | All versions related to all designs, ordered newest first. |
1514

1515
### DesignManagement
1516

1517 1518
| Field | Type | Description |
| ----- | ---- | ----------- |
1519 1520
| `designAtVersion` | DesignAtVersion | Find a design as of a version. |
| `version` | DesignVersion | Find a version. |
1521

1522
### DesignManagementDeletePayload
1523

1524
Autogenerated return type of DesignManagementDelete.
1525

1526 1527
| Field | Type | Description |
| ----- | ---- | ----------- |
1528
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1529
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1530
| `version` | DesignVersion | The new version in which the designs are deleted. |
1531

1532
### DesignManagementMovePayload
1533

1534
Autogenerated return type of DesignManagementMove.
1535

1536 1537
| Field | Type | Description |
| ----- | ---- | ----------- |
1538
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1539
| `designCollection` | DesignCollection | The current state of the collection. |
1540 1541
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

1542
### DesignManagementUploadPayload
1543

1544
Autogenerated return type of DesignManagementUpload.
1545

1546 1547
| Field | Type | Description |
| ----- | ---- | ----------- |
1548
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1549
| `designs` | Design! => Array | The designs that were uploaded by the mutation. |
1550
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1551 1552
| `skippedDesigns` | Design! => Array | Any designs that were skipped from the upload due to there being no change to their content since their last version |

1553
### DesignVersion
1554

1555
A specific version in which designs were added, modified or deleted.
1556

1557 1558
| Field | Type | Description |
| ----- | ---- | ----------- |
1559 1560 1561 1562 1563
| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version. |
| `designs` | DesignConnection! | All designs that were changed in the version. |
| `designsAtVersion` | DesignAtVersionConnection! | All designs that are visible at this version, as of this version. |
| `id` | ID! | ID of the design version. |
| `sha` | ID! | SHA of the design version. |
1564

1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
### 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. |

1575 1576
### DestroyBoardPayload

1577
Autogenerated return type of DestroyBoard.
1578 1579 1580

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

1585 1586 1587 1588 1589 1590 1591 1592 1593
### 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. |

1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
### 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. |

1604 1605 1606 1607 1608 1609 1610
### DestroyContainerRepositoryTagsPayload

Autogenerated return type of DestroyContainerRepositoryTags.

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

1614
### DestroyNotePayload
1615

1616
Autogenerated return type of DestroyNote.
1617

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

1624
### DestroySnippetPayload
1625

1626
Autogenerated return type of DestroySnippet.
1627

1628 1629
| Field | Type | Description |
| ----- | ---- | ----------- |
1630
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1631
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1632
| `snippet` | Snippet | The snippet after mutation. |
1633

1634
### DetailedStatus
Felipe Artur's avatar
Felipe Artur committed
1635

1636 1637
| Field | Type | Description |
| ----- | ---- | ----------- |
1638 1639 1640 1641 1642 1643 1644 1645 1646
| `action` | StatusAction | Action information for the status. This includes method, button title, icon, path, and title. |
| `detailsPath` | String | Path of the details for the status. |
| `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
1647

1648 1649 1650 1651 1652 1653
### DevopsAdoptionSegment

Segment.

| Field | Type | Description |
| ----- | ---- | ----------- |
1654 1655
| `id` | ID! | ID of the segment. |
| `latestSnapshot` | DevopsAdoptionSnapshot | The latest adoption metrics for the segment. |
1656
| `namespace` | Namespace | Segment namespace. |
1657

1658 1659 1660 1661 1662 1663
### DevopsAdoptionSnapshot

Snapshot.

| Field | Type | Description |
| ----- | ---- | ----------- |
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673
| `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. |
1674

1675
### DiffPosition
Felipe Artur's avatar
Felipe Artur committed
1676

1677 1678
| Field | Type | Description |
| ----- | ---- | ----------- |
1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
| `diffRefs` | DiffRefs! | Information about the branch, HEAD, and base at the time of commenting. |
| `filePath` | String! | Path of the file that was changed. |
| `height` | Int | Total height of the image. |
| `newLine` | Int | Line on HEAD SHA that was changed. |
| `newPath` | String | Path of the file on the HEAD SHA. |
| `oldLine` | Int | Line on start SHA that was changed. |
| `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. |
| `x` | Int | X position of the note. |
| `y` | Int | Y position of the note. |
Felipe Artur's avatar
Felipe Artur committed
1690

1691
### DiffRefs
1692

1693 1694
| Field | Type | Description |
| ----- | ---- | ----------- |
1695 1696 1697
| `baseSha` | String | Merge base of the branch the comment was made on. |
| `headSha` | String! | SHA of the HEAD at the time the comment was made. |
| `startSha` | String! | SHA of the branch being compared against. |
1698

1699
### DiffStats
1700

1701
Changes to a single file.
1702

1703 1704
| Field | Type | Description |
| ----- | ---- | ----------- |
1705 1706 1707
| `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. |
1708

1709
### DiffStatsSummary
1710

1711
Aggregated summary of changes.
1712

1713 1714
| Field | Type | Description |
| ----- | ---- | ----------- |
1715 1716 1717 1718
| `additions` | Int! | Number of lines added. |
| `changes` | Int! | Number of lines changed. |
| `deletions` | Int! | Number of lines deleted. |
| `fileCount` | Int! | Number of files changed. |
1719

1720
### Discussion
Felipe Artur's avatar
Felipe Artur committed
1721

1722 1723
| Field | Type | Description |
| ----- | ---- | ----------- |
1724 1725 1726 1727 1728 1729 1730 1731
| `createdAt` | Time! | Timestamp of the discussion's creation. |
| `id` | DiscussionID! | ID of this discussion. |
| `notes` | NoteConnection! | All notes in the discussion. |
| `replyId` | DiscussionID! | ID used to reply to this discussion. |
| `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. |
1732

1733
### DiscussionToggleResolvePayload
1734

1735
Autogenerated return type of DiscussionToggleResolve.
1736

1737 1738
| Field | Type | Description |
| ----- | ---- | ----------- |
1739
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1740
| `discussion` | Discussion | The discussion after mutation. |
1741
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
1742

1743
### DismissVulnerabilityPayload
1744

1745
Autogenerated return type of DismissVulnerability.
1746

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

1753
### Environment
1754

1755
Describes where code is deployed for a project.
1756

1757 1758
| Field | Type | Description |
| ----- | ---- | ----------- |
1759 1760 1761 1762
| `id` | ID! | ID of the environment. |
| `latestOpenedMostSevereAlert` | AlertManagementAlert | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. |
| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment. |
| `name` | String! | Human-readable name of the environment. |
1763
| `path` | String! | The path to the environment. |
1764
| `state` | String! | State of the environment, for example: available/stopped. |
1765

1766 1767 1768 1769 1770 1771 1772 1773 1774
### 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. |

1775
### Epic
1776 1777

Represents an epic.
1778

1779 1780
| Field | Type | Description |
| ----- | ---- | ----------- |
1781 1782 1783 1784 1785 1786
| `author` | User! | Author of the epic. |
| `awardEmoji` | AwardEmojiConnection | A list of award emojis associated with the epic. |
| `children` | EpicConnection | Children (sub-epics) of the epic. |
| `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. |
1787
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
1788 1789 1790
| `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. |
1791
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
1792 1793 1794 1795 1796
| `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. |
1797
| `events` | EventConnection | A list of events associated with the object. |
1798 1799 1800 1801 1802 1803 1804 1805 1806
| `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. |
| `issues` | EpicIssueConnection | A list of issues associated with the epic. |
| `labels` | LabelConnection | Labels assigned to the epic. |
1807
| `notes` | NoteConnection! | All notes on this noteable. |
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
| `parent` | Epic | Parent epic of the epic. |
| `participants` | UserConnection | List of participants for the epic. |
| `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. |
| `userDiscussionsCount` | Int! | Number of user discussions in the epic. |
| `userNotesCount` | Int! | Number of user notes of the epic. |
1824
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
1825 1826
| `webPath` | String! | Web path of the epic. |
| `webUrl` | String! | Web URL of the epic. |
1827

1828
### EpicAddIssuePayload
1829

1830
Autogenerated return type of EpicAddIssue.
1831

1832 1833
| Field | Type | Description |
| ----- | ---- | ----------- |
1834
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1835 1836
| `epic` | Epic | The epic after mutation. |
| `epicIssue` | EpicIssue | The epic-issue relation. |
1837
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1838

1839 1840 1841 1842 1843 1844
### EpicBoard

Represents an epic board.

| Field | Type | Description |
| ----- | ---- | ----------- |
1845 1846
| `hideBacklogList` | Boolean | Whether or not backlog list is hidden. |
| `hideClosedList` | Boolean | Whether or not closed list is hidden. |
1847
| `id` | BoardsEpicBoardID! | Global ID of the epic board. |
Jan Provaznik's avatar
Jan Provaznik committed
1848
| `lists` | EpicListConnection | Epic board lists. |
1849 1850 1851
| `name` | String | Name of the epic board. |
| `webPath` | String! | Web path of the epic board. |
| `webUrl` | String! | Web URL of the epic board. |
1852

charlie ablett's avatar
charlie ablett committed
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
### EpicBoardCreatePayload

Autogenerated return type of EpicBoardCreate.

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

1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
### EpicBoardListCreatePayload

Autogenerated return type of EpicBoardListCreate.

| 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` | EpicList | Epic list in the epic board. |

1873
### EpicDescendantCount
1874 1875

Counts of descendent epics.
1876

1877 1878
| Field | Type | Description |
| ----- | ---- | ----------- |
1879 1880 1881 1882
| `closedEpics` | Int | Number of closed child epics. |
| `closedIssues` | Int | Number of closed epic issues. |
| `openedEpics` | Int | Number of opened child epics. |
| `openedIssues` | Int | Number of opened epic issues. |
1883

1884
### EpicDescendantWeights
1885

1886
Total weight of open and closed descendant issues.
1887

1888 1889
| Field | Type | Description |
| ----- | ---- | ----------- |
1890 1891
| `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. |
1892

1893
### EpicHealthStatus
1894

1895
Health status of child issues.
1896

1897 1898
| Field | Type | Description |
| ----- | ---- | ----------- |
1899 1900 1901
| `issuesAtRisk` | Int | Number of issues at risk. |
| `issuesNeedingAttention` | Int | Number of issues that need attention. |
| `issuesOnTrack` | Int | Number of issues on track. |
1902

1903
### EpicIssue
1904

1905
Relationship between an epic and an issue.
1906

1907 1908
| Field | Type | Description |
| ----- | ---- | ----------- |
1909 1910 1911
| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue. |
| `assignees` | UserConnection | Assignees of the issue. |
| `author` | User! | User that created the issue. |
1912 1913
| `blocked` | Boolean! | Indicates the issue is blocked. |
| `blockedByCount` | Int | Count of issues blocking this issue. |
1914 1915 1916 1917
| `closedAt` | Time | Timestamp of when the issue was closed. |
| `confidential` | Boolean! | Indicates the issue is confidential. |
| `createNoteEmail` | String | User specific email address for the issue. |
| `createdAt` | Time! | Timestamp of when the issue was created. |
1918
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
1919
| `description` | String | Description of the issue. |
1920
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1921 1922 1923 1924 1925 1926
| `designCollection` | DesignCollection | Collection of design images associated with this issue. |
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue. |
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
| `downvotes` | Int! | Number of downvotes the issue has received. |
| `dueDate` | Time | Due date of the issue. |
| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. |
1927
| `epic` | Epic | Epic to which this issue belongs. |
1928
| `epicIssueId` | ID! | ID of the epic-issue relation. |
1929
| `healthStatus` | HealthStatus | Current health status. |
1930 1931
| `humanTimeEstimate` | String | Human-readable time estimate of the issue. |
| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue. |
1932
| `id` | ID | Global ID of the epic-issue relation. |
1933
| `iid` | ID! | Internal ID of the issue. |
1934
| `iteration` | Iteration | Iteration of the issue. |
1935
| `labels` | LabelConnection | Labels of the issue. |
1936
| `metricImages` | MetricImage! => Array | Metric images associated to the issue. |
1937 1938 1939 1940 1941 1942
| `milestone` | Milestone | Milestone of the issue. |
| `moved` | Boolean | Indicates if issue got moved from other project. |
| `movedTo` | Issue | Updated Issue after it got moved to another project. |
| `notes` | NoteConnection! | All notes on this noteable. |
| `participants` | UserConnection | List of participants in the issue. |
| `reference` | String! | Internal reference of the issue. Returned in shortened format by default. |
1943
| `relationPath` | String | URI path of the epic-issue relation. |
1944 1945
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards). |
| `severity` | IssuableSeverity | Severity level of the incident. |
1946
| `slaDueAt` | Time | Timestamp of when the issue SLA expires. |
1947
| `state` | IssueState! | State of the issue. |
1948
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page. |
1949 1950 1951 1952
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue. |
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue. |
| `timeEstimate` | Int! | Time estimate of the issue. |
| `title` | String! | Title of the issue. |
1953
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
1954 1955 1956 1957 1958 1959 1960
| `totalTimeSpent` | Int! | Total time reported as spent on the issue. |
| `type` | IssueType | Type of the issue. |
| `updatedAt` | Time! | Timestamp of when the issue was last updated. |
| `updatedBy` | User | User that last updated the issue. |
| `upvotes` | Int! | Number of upvotes the issue has received. |
| `userDiscussionsCount` | Int! | Number of user discussions in the issue. |
| `userNotesCount` | Int! | Number of user notes of the issue. |
1961
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
1962 1963
| `webPath` | String! | Web path of the issue. |
| `webUrl` | String! | Web URL of the issue. |
1964
| `weight` | Int | Weight of the issue. |
1965

Jan Provaznik's avatar
Jan Provaznik committed
1966 1967 1968 1969 1970 1971
### EpicList

Represents an epic board list.

| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
1972
| `epics` | EpicConnection | List epics. |
Jan Provaznik's avatar
Jan Provaznik committed
1973 1974 1975 1976 1977 1978
| `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. |

1979
### EpicPermissions
1980

1981
Check permissions for the current user on an epic.
1982

1983 1984
| Field | Type | Description |
| ----- | ---- | ----------- |
1985
| `adminEpic` | Boolean! | Indicates the user can perform `admin_epic` on this resource |
1986
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
1987 1988
| `createEpic` | Boolean! | Indicates the user can perform `create_epic` on this resource |
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
1989 1990 1991 1992
| `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 |
1993

1994
### EpicSetSubscriptionPayload
1995

1996
Autogenerated return type of EpicSetSubscription.
1997

1998 1999
| Field | Type | Description |
| ----- | ---- | ----------- |
2000
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2001
| `epic` | Epic | The epic after mutation. |
2002
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2003

2004
### EpicTreeReorderPayload
2005

2006
Autogenerated return type of EpicTreeReorder.
2007

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

2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
### Event

Representing an event.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `action` | EventAction! | Action of the event. |
| `author` | User! | Author of this event. |
| `createdAt` | Time! | When this event was created. |
| `id` | ID! | ID of the event. |
| `updatedAt` | Time! | When this event was updated. |

2025 2026 2027 2028 2029 2030 2031 2032
### ExportRequirementsPayload

Autogenerated return type of ExportRequirements.

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

2034 2035 2036 2037 2038 2039
### ExternalIssue

Represents an external issue.

| Field | Type | Description |
| ----- | ---- | ----------- |
2040 2041 2042 2043 2044 2045 2046
| `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. |
2047

2048
### GeoNode
2049

2050 2051
| Field | Type | Description |
| ----- | ---- | ----------- |
2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070
| `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. |
| `mergeRequestDiffRegistries` | MergeRequestDiffRegistryConnection | Find merge request diff registries on this Geo node. |
| `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. |
| `packageFileRegistries` | PackageFileRegistryConnection | Package file registries of the GeoNode. |
| `primary` | Boolean | Indicates whether this Geo node is the primary. |
| `reposMaxCapacity` | Int | The maximum concurrency of repository backfill for this secondary node. |
| `selectiveSyncNamespaces` | NamespaceConnection | The namespaces that should be synced, if `selective_sync_type` == `namespaces`. |
| `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. |
| `snippetRepositoryRegistries` | SnippetRepositoryRegistryConnection | Find snippet repository registries on this Geo node. |
| `syncObjectStorage` | Boolean | Indicates if this secondary node will replicate blobs in Object Storage. |
| `terraformStateVersionRegistries` | TerraformStateVersionRegistryConnection | Find terraform state version registries on this Geo node. |
| `url` | String | The user-facing URL for this Geo node. |
| `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node. |
2071

2072 2073 2074 2075 2076 2077 2078 2079 2080
### GitlabSubscriptionActivatePayload

Autogenerated return type of GitlabSubscriptionActivate.

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

2081
### GrafanaIntegration
2082

2083 2084
| Field | Type | Description |
| ----- | ---- | ----------- |
2085 2086 2087 2088 2089
| `createdAt` | Time! | Timestamp of the issue's creation. |
| `enabled` | Boolean! | Indicates whether Grafana integration is enabled. |
| `grafanaUrl` | String! | URL for the Grafana host for the Grafana integration. |
| `id` | ID! | Internal ID of the Grafana integration. |
| `updatedAt` | Time! | Timestamp of the issue's last activity. |
2090

2091
### Group
Felipe Artur's avatar
Felipe Artur committed
2092

2093 2094
| Field | Type | Description |
| ----- | ---- | ----------- |
2095 2096
| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes. |
| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes. |
2097 2098 2099 2100
| `autoDevopsEnabled` | Boolean | Indicates whether Auto DevOps is enabled for all projects within this group. |
| `avatarUrl` | String | Avatar URL of the group. |
| `board` | Board | A single board of the group. |
| `boards` | BoardConnection | Boards of the group. |
2101
| `codeCoverageActivities` | CodeCoverageActivityConnection | Represents the code coverage activity for this group. |
2102
| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. |
2103 2104
| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the group. |
| `containerRepositoriesCount` | Int! | Number of container repositories in the group. |
2105
| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit. |
2106
| `customEmoji` | CustomEmojiConnection | Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled. |
2107
| `description` | String | Description of the namespace. |
Felipe Artur's avatar
Felipe Artur committed
2108
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2109
| `emailsDisabled` | Boolean | Indicates if a group has email notifications disabled. |
2110 2111 2112 2113
| `epic` | Epic | Find a single epic. |
| `epicBoard` | EpicBoard | Find a single epic board. |
| `epicBoards` | EpicBoardConnection | Find epic boards. |
| `epics` | EpicConnection | Find epics. |
2114
| `epicsEnabled` | Boolean | Indicates if Epics are enabled for namespace |
2115 2116
| `fullName` | String! | Full name of the namespace. |
| `fullPath` | ID! | Full path of the namespace. |
2117
| `groupMembers` | GroupMemberConnection | A membership of a user within this group. |
2118
| `groupTimelogsEnabled` | Boolean | Indicates if Group timelogs are enabled for namespace |
2119
| `id` | ID! | ID of the namespace. |
2120
| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase. |
2121
| `issues` | IssueConnection | Issues for projects in this group. |
2122
| `iterations` | IterationConnection | Find iterations. |
2123 2124
| `label` | Label | A label available on this group. |
| `labels` | LabelConnection | Labels available on this group. |
2125
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace. |
2126 2127 2128
| `mentionsDisabled` | Boolean | Indicates if a group is disabled from getting mentioned. |
| `mergeRequests` | MergeRequestConnection | Merge requests for projects in this group. |
| `milestones` | MilestoneConnection | Milestones of the group. |
2129 2130
| `name` | String! | Name of the namespace. |
| `packageSettings` | PackageSettings | The package settings for the namespace. |
2131
| `parent` | Group | Parent group. |
2132
| `path` | String! | Path of the namespace. |
2133
| `projectCreationLevel` | String | The permission level required to create projects in the group. |
2134
| `projects` | ProjectConnection! | Projects within this namespace. |
2135
| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit. |
2136
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace. |
2137
| `requireTwoFactorAuthentication` | Boolean | Indicates if all users in this group are required to set up two-factor authentication. |
2138
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces. |
2139
| `shareWithGroupLock` | Boolean | Indicates if sharing a project with another group within this group is prevented. |
2140 2141
| `stats` | GroupStats | Group statistics. |
| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes. |
2142
| `subgroupCreationLevel` | String | The permission level required to create subgroups within the group. |
2143 2144 2145 2146
| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active. |
| `timelogs` | TimelogConnection! | Time logged in issues by group members. |
| `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. |
2147
| `twoFactorGracePeriod` | Int | Time before two-factor authentication is enforced. |
2148
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |
2149
| `visibility` | String | Visibility of the namespace. |
2150 2151
| `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. |
2152
| `vulnerabilitiesCountByDayAndSeverity` **{warning-solid}** | VulnerabilitiesCountByDayAndSeverityConnection | **Deprecated:** Use `vulnerabilitiesCountByDay`. Deprecated in 13.3. |
2153 2154 2155
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade. |
| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. |
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the group and its subgroups. |
2156
| `webUrl` | String! | Web URL of the group. |
Felipe Artur's avatar
Felipe Artur committed
2157

2158
### GroupMember
2159

2160
Represents a Group Membership.
2161

2162 2163
| Field | Type | Description |
| ----- | ---- | ----------- |
2164 2165 2166 2167
| `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. |
2168
| `group` | Group | Group that a User is a member of. |
2169 2170 2171
| `id` | ID! | ID of the member. |
| `updatedAt` | Time | Date and time the membership was last updated. |
| `user` | User! | User that is associated with the member object. |
2172 2173
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |

2174
### GroupPermissions
Felipe Artur's avatar
Felipe Artur committed
2175

2176 2177
| Field | Type | Description |
| ----- | ---- | ----------- |
2178
| `readGroup` | Boolean! | Indicates the user can perform `read_group` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2179

2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194
### 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 |
| ----- | ---- | ----------- |
2195
| `releaseStats` | GroupReleaseStats | Statistics related to releases within the group. |
2196

2197 2198 2199 2200 2201 2202 2203 2204
### 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. |
2205
| `integration` | AlertManagementHttpIntegration | The HTTP integration. |
2206 2207 2208 2209 2210 2211 2212 2213 2214

### 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. |
2215
| `integration` | AlertManagementHttpIntegration | The HTTP integration. |
2216 2217 2218 2219 2220 2221 2222 2223 2224

### 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. |
2225
| `integration` | AlertManagementHttpIntegration | The HTTP integration. |
2226 2227 2228 2229 2230 2231 2232 2233 2234

### 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. |
2235
| `integration` | AlertManagementHttpIntegration | The HTTP integration. |
2236

2237 2238 2239 2240 2241 2242
### IncidentManagementOncallRotation

Describes an incident management on-call rotation.

| Field | Type | Description |
| ----- | ---- | ----------- |
2243
| `endsAt` | Time | End date and time of the on-call rotation. |
2244 2245 2246 2247 2248
| `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. |
2249
| `shifts` | IncidentManagementOncallShiftConnection | Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. |
2250
| `startsAt` | Time | Start date of the on-call rotation. |
2251

2252 2253 2254 2255 2256 2257
### IncidentManagementOncallSchedule

Describes an incident management on-call schedule.

| Field | Type | Description |
| ----- | ---- | ----------- |
2258 2259 2260 2261 2262
| `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. |
| `rotations` | IncidentManagementOncallRotationConnection! | On-call rotations for the on-call schedule. |
| `timezone` | String! | Time zone of the on-call schedule. |
2263

2264 2265
### IncidentManagementOncallShift

2266
A block of time for which a participant is on-call.
2267 2268 2269 2270 2271 2272 2273

| Field | Type | Description |
| ----- | ---- | ----------- |
| `endsAt` | Time | End time of the on-call shift. |
| `participant` | OncallParticipantType | Participant assigned to the on-call shift. |
| `startsAt` | Time | Start time of the on-call shift. |

2274
### InstanceSecurityDashboard
2275

2276 2277
| Field | Type | Description |
| ----- | ---- | ----------- |
2278 2279 2280 2281
| `projects` | ProjectConnection! | Projects selected in Instance Security Dashboard. |
| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade. |
| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. |
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard. |
2282

2283
### Issue
Felipe Artur's avatar
Felipe Artur committed
2284

2285 2286
| Field | Type | Description |
| ----- | ---- | ----------- |
2287 2288 2289
| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue. |
| `assignees` | UserConnection | Assignees of the issue. |
| `author` | User! | User that created the issue. |
2290 2291
| `blocked` | Boolean! | Indicates the issue is blocked. |
| `blockedByCount` | Int | Count of issues blocking this issue. |
2292 2293 2294 2295
| `closedAt` | Time | Timestamp of when the issue was closed. |
| `confidential` | Boolean! | Indicates the issue is confidential. |
| `createNoteEmail` | String | User specific email address for the issue. |
| `createdAt` | Time! | Timestamp of when the issue was created. |
2296
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
2297
| `description` | String | Description of the issue. |
2298
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2299 2300 2301 2302 2303 2304
| `designCollection` | DesignCollection | Collection of design images associated with this issue. |
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue. |
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
| `downvotes` | Int! | Number of downvotes the issue has received. |
| `dueDate` | Time | Due date of the issue. |
| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. |
2305
| `epic` | Epic | Epic to which this issue belongs. |
2306
| `healthStatus` | HealthStatus | Current health status. |
2307 2308 2309 2310
| `humanTimeEstimate` | String | Human-readable time estimate of the issue. |
| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue. |
| `id` | ID! | ID of the issue. |
| `iid` | ID! | Internal ID of the issue. |
2311
| `iteration` | Iteration | Iteration of the issue. |
2312
| `labels` | LabelConnection | Labels of the issue. |
2313
| `metricImages` | MetricImage! => Array | Metric images associated to the issue. |
2314 2315 2316 2317 2318 2319 2320 2321
| `milestone` | Milestone | Milestone of the issue. |
| `moved` | Boolean | Indicates if issue got moved from other project. |
| `movedTo` | Issue | Updated Issue after it got moved to another project. |
| `notes` | NoteConnection! | All notes on this noteable. |
| `participants` | UserConnection | List of participants in the issue. |
| `reference` | String! | Internal reference of the issue. Returned in shortened format by default. |
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards). |
| `severity` | IssuableSeverity | Severity level of the incident. |
2322
| `slaDueAt` | Time | Timestamp of when the issue SLA expires. |
2323
| `state` | IssueState! | State of the issue. |
2324
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page. |
2325 2326 2327 2328
| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue. |
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue. |
| `timeEstimate` | Int! | Time estimate of the issue. |
| `title` | String! | Title of the issue. |
2329
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
2330 2331 2332 2333 2334 2335 2336
| `totalTimeSpent` | Int! | Total time reported as spent on the issue. |
| `type` | IssueType | Type of the issue. |
| `updatedAt` | Time! | Timestamp of when the issue was last updated. |
| `updatedBy` | User | User that last updated the issue. |
| `upvotes` | Int! | Number of upvotes the issue has received. |
| `userDiscussionsCount` | Int! | Number of user discussions in the issue. |
| `userNotesCount` | Int! | Number of user notes of the issue. |
2337
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
2338 2339
| `webPath` | String! | Web path of the issue. |
| `webUrl` | String! | Web URL of the issue. |
2340
| `weight` | Int | Weight of the issue. |
Felipe Artur's avatar
Felipe Artur committed
2341

2342
### IssueMoveListPayload
2343

2344
Autogenerated return type of IssueMoveList.
2345

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

Felipe Artur's avatar
Felipe Artur committed
2352 2353 2354 2355 2356 2357 2358 2359
### 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. |
2360
| `issue` | Issue | The issue after mutation. |
2361

2362
### IssuePermissions
2363

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

2366 2367
| Field | Type | Description |
| ----- | ---- | ----------- |
2368 2369
| `adminIssue` | Boolean! | Indicates the user can perform `admin_issue` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
2370
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
2371
| `destroyDesign` | Boolean! | Indicates the user can perform `destroy_design` on this resource |
2372 2373 2374 2375
| `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
2376

2377
### IssueSetAssigneesPayload
2378

2379
Autogenerated return type of IssueSetAssignees.
2380

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

2387
### IssueSetConfidentialPayload
2388

2389
Autogenerated return type of IssueSetConfidential.
2390

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

2397
### IssueSetDueDatePayload
2398

2399
Autogenerated return type of IssueSetDueDate.
2400

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

2407
### IssueSetEpicPayload
2408

2409
Autogenerated return type of IssueSetEpic.
2410

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

2417
### IssueSetIterationPayload
2418

2419
Autogenerated return type of IssueSetIteration.
2420

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

2427
### IssueSetLockedPayload
2428

2429
Autogenerated return type of IssueSetLocked.
2430

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

2437
### IssueSetSeverityPayload
2438

2439
Autogenerated return type of IssueSetSeverity.
2440

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

2447
### IssueSetSubscriptionPayload
2448

2449
Autogenerated return type of IssueSetSubscription.
2450

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

2457
### IssueSetWeightPayload
2458

2459
Autogenerated return type of IssueSetWeight.
2460

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

2467
### IssueStatusCountsType
Sean Arnold's avatar
Sean Arnold committed
2468

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

2471 2472
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
2473 2474 2475 2476
| `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 |

2477
### Iteration
2478 2479 2480

Represents an iteration object.

2481 2482
| Field | Type | Description |
| ----- | ---- | ----------- |
2483 2484
| `createdAt` | Time! | Timestamp of iteration creation. |
| `description` | String | Description of the iteration. |
2485
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497
| `dueDate` | Time | Timestamp of the iteration due date. |
| `id` | ID! | ID of the iteration. |
| `iid` | ID! | Internal ID of the iteration. |
| `report` | TimeboxReport | Historically accurate report about the timebox. |
| `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. |
| `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. |
2498

2499
### JiraImport
2500

2501 2502
| Field | Type | Description |
| ----- | ---- | ----------- |
2503 2504 2505 2506 2507 2508 2509
| `createdAt` | Time | Timestamp of when the Jira import was created. |
| `failedToImportCount` | Int! | Count of issues that failed to import. |
| `importedIssuesCount` | Int! | Count of issues that were successfully imported. |
| `jiraProjectKey` | String! | Project key for the imported Jira project. |
| `scheduledAt` | Time | Timestamp of when the Jira import was scheduled. |
| `scheduledBy` | User | User that started the Jira import. |
| `totalIssueCount` | Int! | Total count of issues that were attempted to import. |
2510

2511
### JiraImportStartPayload
2512

2513
Autogenerated return type of JiraImportStart.
2514

2515 2516
| Field | Type | Description |
| ----- | ---- | ----------- |
2517
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2518
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2519
| `jiraImport` | JiraImport | The Jira import data after mutation. |
2520

2521
### JiraImportUsersPayload
2522

2523
Autogenerated return type of JiraImportUsers.
2524

2525 2526
| Field | Type | Description |
| ----- | ---- | ----------- |
2527 2528 2529 2530
| `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. |

2531
### JiraProject
2532

2533 2534
| Field | Type | Description |
| ----- | ---- | ----------- |
2535 2536 2537
| `key` | String! | Key of the Jira project. |
| `name` | String | Name of the Jira project. |
| `projectId` | Int! | ID of the Jira project. |
2538

2539
### JiraService
2540

2541 2542
| Field | Type | Description |
| ----- | ---- | ----------- |
2543 2544 2545
| `active` | Boolean | Indicates if the service is active. |
| `projects` | JiraProjectConnection | List of all Jira projects fetched through Jira REST API. |
| `type` | String | Class name of the service. |
2546

2547
### JiraUser
2548

2549 2550
| Field | Type | Description |
| ----- | ---- | ----------- |
2551 2552 2553 2554 2555 2556
| `gitlabId` | Int | ID of the matched GitLab user. |
| `gitlabName` | String | Name of the matched GitLab user. |
| `gitlabUsername` | String | Username of the matched GitLab user. |
| `jiraAccountId` | String! | Account ID of the Jira user. |
| `jiraDisplayName` | String! | Display name of the Jira user. |
| `jiraEmail` | String | Email of the Jira user, returned only for users with public emails. |
2557

2558
### Label
Felipe Artur's avatar
Felipe Artur committed
2559

2560 2561
| Field | Type | Description |
| ----- | ---- | ----------- |
2562
| `color` | String! | Background color of the label. |
2563
| `createdAt` | Time! | When this label was created. |
2564
| `description` | String | Description of the label (Markdown rendered as HTML for caching). |
Felipe Artur's avatar
Felipe Artur committed
2565
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2566 2567 2568
| `id` | ID! | Label ID. |
| `textColor` | String! | Text color of the label. |
| `title` | String! | Content of the label. |
2569
| `updatedAt` | Time! | When this label was last updated. |
Felipe Artur's avatar
Felipe Artur committed
2570

2571 2572 2573 2574 2575 2576 2577 2578
### 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. |
2579
| `label` | Label | The label after mutation. |
2580

2581
### MarkAsSpamSnippetPayload
2582

2583
Autogenerated return type of MarkAsSpamSnippet.
2584

2585 2586
| Field | Type | Description |
| ----- | ---- | ----------- |
2587
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2588
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2589
| `snippet` | Snippet | The snippet after mutation. |
2590

2591
### MergeRequest
Felipe Artur's avatar
Felipe Artur committed
2592

2593 2594
| Field | Type | Description |
| ----- | ---- | ----------- |
2595
| `allowCollaboration` | Boolean | Indicates if members of the target project can push to the fork. |
2596 2597
| `approvalsLeft` | Int | Number of approvals left. |
| `approvalsRequired` | Int | Number of approvals required. |
2598
| `approved` | Boolean! | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. |
2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
| `approvedBy` | UserConnection | Users who approved the merge request. |
| `assignees` | UserConnection | Assignees of the merge request. |
| `author` | User | User who created this merge request. |
| `autoMergeEnabled` | Boolean! | Indicates if auto merge is enabled for the merge request. |
| `autoMergeStrategy` | String | Selected auto merge strategy. |
| `availableAutoMergeStrategies` | String! => Array | Array of available auto merge strategies. |
| `commitCount` | Int | Number of commits in the merge request. |
| `commitsWithoutMergeCommits` | CommitConnection | Merge request commits excluding merge commits. |
| `conflicts` | Boolean! | Indicates if the merge request has conflicts. |
| `createdAt` | Time! | Timestamp of when the merge request was created. |
2609
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
2610 2611 2612 2613
| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request. |
| `defaultMergeCommitMessageWithDescription` | String | Default merge commit message of the merge request with description. |
| `defaultSquashCommitMessage` | String | Default squash commit message of the merge request. |
| `description` | String | Description of the merge request (Markdown rendered as HTML for caching). |
Felipe Artur's avatar
Felipe Artur committed
2614
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2615 2616 2617 2618 2619 2620
| `diffHeadSha` | String | Diff head SHA of the merge request. |
| `diffRefs` | DiffRefs | References of the base SHA, the head SHA, and the start SHA for this merge request. |
| `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. |
| `discussionLocked` | Boolean! | Indicates if comments on the merge request are locked to members only. |
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
2621
| `divergedFromTargetBranch` | Boolean! | Indicates if the source branch is behind the target branch. |
2622 2623 2624
| `downvotes` | Int! | Number of downvotes for the merge request. |
| `forceRemoveSourceBranch` | Boolean | Indicates if the project settings will lead to source branch deletion after merge. |
| `hasCi` | Boolean! | Indicates if the merge request has CI. |
2625
| `hasSecurityReports` | Boolean! | Indicates if the source branch has any security reports. |
2626 2627 2628 2629 2630 2631 2632 2633 2634
| `headPipeline` | Pipeline | The pipeline running on the branch HEAD of the merge request. |
| `id` | ID! | ID of the merge request. |
| `iid` | String! | Internal ID of the merge request. |
| `inProgressMergeCommitSha` | String | Commit SHA of the merge request if merge is in progress. |
| `labels` | LabelConnection | Labels of the merge request. |
| `mergeCommitSha` | String | SHA of the merge request commit (set once merged). |
| `mergeError` | String | Error message due to a merge error. |
| `mergeOngoing` | Boolean! | Indicates if a merge is currently occurring. |
| `mergeStatus` | String | Status of the merge request. |
2635
| `mergeTrainsCount` | Int | Number of merge requests in the merge train. |
2636 2637 2638 2639 2640 2641 2642
| `mergeUser` | User | User who merged this merge request. |
| `mergeWhenPipelineSucceeds` | Boolean | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS). |
| `mergeable` | Boolean! | Indicates if the merge request is mergeable. |
| `mergeableDiscussionsState` | Boolean | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged. |
| `mergedAt` | Time | Timestamp of when the merge request was merged, null if not merged. |
| `milestone` | Milestone | The milestone of the merge request. |
| `notes` | NoteConnection! | All notes on this noteable. |
2643
| `participants` | UserConnection | Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. |
2644
| `pipelines` | PipelineConnection | Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned. |
2645 2646 2647 2648 2649
| `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. |
2650
| `reviewers` | UserConnection | Users from whom a review has been requested. |
2651
| `securityAutoFix` | Boolean | Indicates if the merge request is created by @GitLab-Security-Bot. |
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666
| `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. |
| `sourceBranchProtected` | Boolean! | Indicates if the source branch is protected. |
| `sourceProject` | Project | Source project of the merge request. |
| `sourceProjectId` | Int | ID of the merge request source project. |
| `squash` | Boolean! | Indicates if squash on merge is enabled. |
| `squashOnMerge` | Boolean! | Indicates if squash on merge is enabled. |
| `state` | MergeRequestState! | State of the merge request. |
| `subscribed` | Boolean! | Indicates if the currently logged in user is subscribed to this merge request. |
| `targetBranch` | String! | Target branch of the merge request. |
| `targetBranchExists` | Boolean! | Indicates if the target branch of the merge request exists. |
| `targetProject` | Project! | Target project of the merge request. |
| `targetProjectId` | Int! | ID of the merge request target project. |
2667
| `taskCompletionStatus` | TaskCompletionStatus! | Completion status of tasks |
2668 2669
| `timeEstimate` | Int! | Time estimate of the merge request. |
| `title` | String! | Title of the merge request. |
2670
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
2671 2672 2673 2674 2675
| `totalTimeSpent` | Int! | Total time reported as spent on the merge request. |
| `updatedAt` | Time! | Timestamp of when the merge request was last updated. |
| `upvotes` | Int! | Number of upvotes for the merge request. |
| `userDiscussionsCount` | Int | Number of user discussions in the merge request. |
| `userNotesCount` | Int | User notes count of the merge request. |
2676
| `userPermissions` | MergeRequestPermissions! | Permissions for the current user on the resource |
2677 2678
| `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
2679

2680
### MergeRequestCreatePayload
2681

2682
Autogenerated return type of MergeRequestCreate.
2683

2684 2685
| Field | Type | Description |
| ----- | ---- | ----------- |
2686 2687
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2688
| `mergeRequest` | MergeRequest | The merge request after mutation. |
2689

2690 2691
### MergeRequestDiffRegistry

2692
Represents the Geo sync and verification state of a Merge Request diff.
2693 2694 2695 2696 2697 2698 2699

| 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 |
2700
| `mergeRequestDiffId` | ID! | ID of the Merge Request diff. |
2701 2702 2703 2704
| `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 |

2705
### MergeRequestPermissions
2706

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

2709 2710
| Field | Type | Description |
| ----- | ---- | ----------- |
2711
| `adminMergeRequest` | Boolean! | Indicates the user can perform `admin_merge_request` on this resource |
2712
| `canMerge` | Boolean! | Indicates the user can perform `can_merge` on this resource |
2713
| `cherryPickOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource |
2714 2715
| `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 |
2716
| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource |
2717 2718
| `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 |
2719
| `updateMergeRequest` | Boolean! | Indicates the user can perform `update_merge_request` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2720

2721 2722 2723 2724 2725 2726 2727 2728 2729 2730
### MergeRequestReviewerRereviewPayload

Autogenerated return type of MergeRequestReviewerRereview.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `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. |

2731
### MergeRequestSetAssigneesPayload
2732

2733
Autogenerated return type of MergeRequestSetAssignees.
2734

2735 2736
| Field | Type | Description |
| ----- | ---- | ----------- |
2737
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2738
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2739
| `mergeRequest` | MergeRequest | The merge request after mutation. |
2740

2741
### MergeRequestSetLabelsPayload
2742

2743
Autogenerated return type of MergeRequestSetLabels.
Mario de la Ossa's avatar
Mario de la Ossa committed
2744

2745 2746
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
2747
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2748
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2749
| `mergeRequest` | MergeRequest | The merge request after mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
2750

2751
### MergeRequestSetLockedPayload
2752

2753
Autogenerated return type of MergeRequestSetLocked.
Mario de la Ossa's avatar
Mario de la Ossa committed
2754

2755 2756
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
2757
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2758
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2759
| `mergeRequest` | MergeRequest | The merge request after mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
2760

2761
### MergeRequestSetMilestonePayload
2762

2763
Autogenerated return type of MergeRequestSetMilestone.
2764

2765 2766
| Field | Type | Description |
| ----- | ---- | ----------- |
2767
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2768
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2769
| `mergeRequest` | MergeRequest | The merge request after mutation. |
Mario de la Ossa's avatar
Mario de la Ossa committed
2770

2771
### MergeRequestSetSubscriptionPayload
2772

2773
Autogenerated return type of MergeRequestSetSubscription.
Mario de la Ossa's avatar
Mario de la Ossa committed
2774

2775 2776
| Field | Type | Description |
| ----- | ---- | ----------- |
Mario de la Ossa's avatar
Mario de la Ossa committed
2777
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2778
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2779
| `mergeRequest` | MergeRequest | The merge request after mutation. |
2780

2781
### MergeRequestSetWipPayload
2782

2783
Autogenerated return type of MergeRequestSetWip.
Felipe Artur's avatar
Felipe Artur committed
2784

2785 2786
| Field | Type | Description |
| ----- | ---- | ----------- |
Felipe Artur's avatar
Felipe Artur committed
2787
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2788
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2789
| `mergeRequest` | MergeRequest | The merge request after mutation. |
Felipe Artur's avatar
Felipe Artur committed
2790

2791
### MergeRequestUpdatePayload
2792

2793
Autogenerated return type of MergeRequestUpdate.
2794

2795 2796
| Field | Type | Description |
| ----- | ---- | ----------- |
2797
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2798
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2799
| `mergeRequest` | MergeRequest | The merge request after mutation. |
Felipe Artur's avatar
Felipe Artur committed
2800

2801
### Metadata
Felipe Artur's avatar
Felipe Artur committed
2802

2803 2804
| Field | Type | Description |
| ----- | ---- | ----------- |
2805 2806
| `revision` | String! | Revision. |
| `version` | String! | Version. |
Felipe Artur's avatar
Felipe Artur committed
2807

2808 2809 2810 2811 2812 2813
### MetricImage

Represents a metric image upload.

| Field | Type | Description |
| ----- | ---- | ----------- |
2814 2815 2816 2817 2818
| `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. |
2819

2820
### MetricsDashboard
2821

2822 2823
| Field | Type | Description |
| ----- | ---- | ----------- |
2824 2825 2826
| `annotations` | MetricsDashboardAnnotationConnection | Annotations added to the dashboard. |
| `path` | String | Path to a file with the dashboard definition. |
| `schemaValidationWarnings` | String! => Array | Dashboard schema validation warnings. |
2827

2828
### MetricsDashboardAnnotation
2829

2830 2831
| Field | Type | Description |
| ----- | ---- | ----------- |
2832 2833 2834 2835 2836
| `description` | String | Description of the annotation. |
| `endingAt` | Time | Timestamp marking end of annotated time span. |
| `id` | ID! | ID of the annotation. |
| `panelId` | String | ID of a dashboard panel to which the annotation should be scoped. |
| `startingAt` | Time | Timestamp marking start of annotated time span. |
2837

2838
### Milestone
Felipe Artur's avatar
Felipe Artur committed
2839

2840 2841
Represents a milestone.

2842 2843
| Field | Type | Description |
| ----- | ---- | ----------- |
2844 2845 2846 2847 2848 2849
| `createdAt` | Time! | Timestamp of milestone creation. |
| `description` | String | Description of the milestone. |
| `dueDate` | Time | Timestamp of the milestone due date. |
| `groupMilestone` | Boolean! | Indicates if milestone is at group level. |
| `id` | ID! | ID of the milestone. |
| `projectMilestone` | Boolean! | Indicates if milestone is at project level. |
2850
| `report` | TimeboxReport | Historically accurate report about the timebox. |
2851 2852 2853 2854 2855 2856 2857
| `startDate` | Time | Timestamp of the milestone start date. |
| `state` | MilestoneStateEnum! | State of the milestone. |
| `stats` | MilestoneStats | Milestone statistics. |
| `subgroupMilestone` | Boolean! | Indicates if milestone is at subgroup level. |
| `title` | String! | Title of the milestone. |
| `updatedAt` | Time! | Timestamp of last milestone update. |
| `webPath` | String! | Web path of the milestone. |
Felipe Artur's avatar
Felipe Artur committed
2858

2859
### MilestoneStats
2860

2861
Contains statistics about a milestone.
2862

2863 2864
| Field | Type | Description |
| ----- | ---- | ----------- |
2865 2866
| `closedIssuesCount` | Int | Number of closed issues associated with the milestone. |
| `totalIssuesCount` | Int | Total number of issues associated with the milestone. |
2867

2868
### Namespace
Felipe Artur's avatar
Felipe Artur committed
2869

2870 2871
| Field | Type | Description |
| ----- | ---- | ----------- |
2872 2873
| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes. |
| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes. |
2874
| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. |
2875
| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit. |
2876
| `description` | String | Description of the namespace. |
Felipe Artur's avatar
Felipe Artur committed
2877
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2878 2879 2880
| `fullName` | String! | Full name of the namespace. |
| `fullPath` | ID! | Full path of the namespace. |
| `id` | ID! | ID of the namespace. |
2881
| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase. |
2882 2883 2884 2885 2886
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace. |
| `name` | String! | Name of the namespace. |
| `packageSettings` | PackageSettings | The package settings for the namespace. |
| `path` | String! | Path of the namespace. |
| `projects` | ProjectConnection! | Projects within this namespace. |
2887
| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit. |
2888 2889
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace. |
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces. |
2890 2891 2892 2893
| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes. |
| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active. |
| `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. |
2894
| `visibility` | String | Visibility of the namespace. |
Felipe Artur's avatar
Felipe Artur committed
2895

2896
### NamespaceIncreaseStorageTemporarilyPayload
2897

2898
Autogenerated return type of NamespaceIncreaseStorageTemporarily.
2899

2900 2901
| Field | Type | Description |
| ----- | ---- | ----------- |
2902 2903
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2904
| `namespace` | Namespace | The namespace after mutation. |
2905

2906
### Note
Felipe Artur's avatar
Felipe Artur committed
2907

2908 2909
| Field | Type | Description |
| ----- | ---- | ----------- |
2910 2911
| `author` | User! | User who wrote this note. |
| `body` | String! | Content of the note. |
Felipe Artur's avatar
Felipe Artur committed
2912
| `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` |
2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926
| `confidential` | Boolean | Indicates if this note is confidential. |
| `createdAt` | Time! | Timestamp of the note creation. |
| `discussion` | Discussion | The discussion this note is a part of. |
| `id` | NoteID! | ID of the note. |
| `position` | DiffPosition | The position of this note on a diff. |
| `project` | Project | Project associated with the note. |
| `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. |
| `system` | Boolean! | Indicates whether this note was created by the system or by a user. |
| `systemNoteIconName` | String | Name of the icon corresponding to a system note. |
| `updatedAt` | Time! | Timestamp of the note's last activity. |
| `url` | String | URL to view this Note in the Web UI. |
2927
| `userPermissions` | NotePermissions! | Permissions for the current user on the resource |
Felipe Artur's avatar
Felipe Artur committed
2928

2929
### NotePermissions
Felipe Artur's avatar
Felipe Artur committed
2930

2931 2932
| Field | Type | Description |
| ----- | ---- | ----------- |
2933 2934
| `adminNote` | Boolean! | Indicates the user can perform `admin_note` on this resource |
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
2935 2936
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
| `readNote` | Boolean! | Indicates the user can perform `read_note` on this resource |
2937
| `repositionNote` | Boolean! | Indicates the user can perform `reposition_note` on this resource |
2938
| `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2939

2940 2941 2942 2943 2944 2945 2946 2947
### 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. |
2948 2949
| `id` | IncidentManagementOncallParticipantID! | ID of the on-call participant. |
| `user` | User! | The user who is participating. |
2950

2951 2952 2953 2954 2955 2956 2957 2958
### 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. |
2959
| `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation. |
2960

Sean Arnold's avatar
Sean Arnold committed
2961 2962 2963 2964 2965 2966 2967 2968 2969 2970
### OncallRotationDestroyPayload

Autogenerated return type of OncallRotationDestroy.

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

2971 2972 2973 2974 2975 2976 2977
### OncallScheduleCreatePayload

Autogenerated return type of OncallScheduleCreate.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2978
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2979
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. |
2980 2981 2982 2983 2984 2985 2986 2987

### OncallScheduleDestroyPayload

Autogenerated return type of OncallScheduleDestroy.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2988
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2989
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. |
2990 2991 2992 2993 2994 2995 2996

### OncallScheduleUpdatePayload

Autogenerated return type of OncallScheduleUpdate.

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

3001
### Package
3002

3003
Represents a package in the Package Registry.
3004

3005 3006
| Field | Type | Description |
| ----- | ---- | ----------- |
3007 3008 3009 3010 3011
| `createdAt` | Time! | Date of creation. |
| `id` | PackagesPackageID! | ID of the package. |
| `metadata` | PackageMetadata | Package metadata. |
| `name` | String! | Name of the package. |
| `packageType` | PackageTypeEnum! | Package type. |
3012 3013
| `pipelines` | PipelineConnection | Pipelines that built the package. |
| `project` | Project! | Project where the package is stored. |
3014 3015 3016 3017
| `tags` | PackageTagConnection | Package tags. |
| `updatedAt` | Time! | Date of most recent update. |
| `version` | String | Version string. |
| `versions` | PackageWithoutVersionsConnection | The other versions of the package. |
3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029

### PackageComposerJsonType

Represents a composer JSON file.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `license` | String | The license set in the Composer JSON file. |
| `name` | String | The name set in the Composer JSON file. |
| `type` | String | The type set in the Composer JSON file. |
| `version` | String | The version set in the Composer JSON file. |

3030
### PackageFileRegistry
3031

3032
Represents the Geo sync and verification state of a package file.
3033

3034 3035
| Field | Type | Description |
| ----- | ---- | ----------- |
3036 3037 3038 3039
| `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 |
3040
| `packageFileId` | ID! | ID of the PackageFile. |
3041 3042 3043 3044
| `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 |

3045 3046 3047 3048 3049 3050 3051 3052 3053
### 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. |

3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064
### PackageTag

Represents a package tag.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time! | The created date. |
| `id` | ID! | The ID of the tag. |
| `name` | String! | The name of the tag. |
| `updatedAt` | Time! | The updated date. |

3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081
### PackageWithoutVersions

Represents a version of a package in the Package Registry.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time! | Date of creation. |
| `id` | PackagesPackageID! | ID of the package. |
| `metadata` | PackageMetadata | Package metadata. |
| `name` | String! | Name of the package. |
| `packageType` | PackageTypeEnum! | Package type. |
| `pipelines` | PipelineConnection | Pipelines that built the package. |
| `project` | Project! | Project where the package is stored. |
| `tags` | PackageTagConnection | Package tags. |
| `updatedAt` | Time! | Date of most recent update. |
| `version` | String | Version string. |

3082
### PageInfo
3083

3084
Information about pagination in a connection.
Felipe Artur's avatar
Felipe Artur committed
3085

3086 3087
| Field | Type | Description |
| ----- | ---- | ----------- |
3088
| `endCursor` | String | When paginating forwards, the cursor to continue. |
Felipe Artur's avatar
Felipe Artur committed
3089 3090 3091 3092
| `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. |

3093
### Pipeline
Felipe Artur's avatar
Felipe Artur committed
3094

3095 3096
| Field | Type | Description |
| ----- | ---- | ----------- |
3097 3098 3099 3100
| `active` | Boolean! | Indicates if the pipeline is active. |
| `beforeSha` | String | Base SHA of the source branch. |
| `cancelable` | Boolean! | Specifies if a pipeline can be canceled. |
| `committedAt` | Time | Timestamp of the pipeline's commit. |
3101
| `configSource` | PipelineConfigSourceEnum | Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE) |
3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113
| `coverage` | Float | Coverage percentage. |
| `createdAt` | Time! | Timestamp of the pipeline's creation. |
| `detailedStatus` | DetailedStatus! | Detailed status of the pipeline. |
| `downstream` | PipelineConnection | Pipelines this pipeline will trigger. |
| `duration` | Int | Duration of the pipeline in seconds. |
| `finishedAt` | Time | Timestamp of the pipeline's completion. |
| `id` | ID! | ID of the pipeline. |
| `iid` | String! | Internal ID of the pipeline. |
| `jobs` | CiJobConnection | Jobs belonging to the pipeline. |
| `path` | String | Relative path to the pipeline's page. |
| `project` | Project | Project the pipeline belongs to. |
| `retryable` | Boolean! | Specifies if a pipeline can be retried. |
3114
| `securityReportFindings` | PipelineSecurityReportFindingConnection | Vulnerability findings reported on the pipeline. |
3115
| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline. |
3116 3117 3118 3119
| `sha` | String! | SHA of the pipeline's commit. |
| `sourceJob` | CiJob | Job where pipeline was triggered from. |
| `stages` | CiStageConnection | Stages of the pipeline. |
| `startedAt` | Time | Timestamp when the pipeline was started. |
3120
| `status` | PipelineStatusEnum! | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED) |
3121 3122 3123
| `updatedAt` | Time! | Timestamp of the pipeline's last activity. |
| `upstream` | Pipeline | Pipeline that triggered the pipeline. |
| `user` | User | Pipeline user. |
3124
| `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource |
3125
| `warnings` | Boolean! | Indicates if a pipeline has warnings. |
Felipe Artur's avatar
Felipe Artur committed
3126

3127 3128 3129 3130
### PipelineAnalytics

| Field | Type | Description |
| ----- | ---- | ----------- |
3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141
| `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. |
3142

3143
### PipelineCancelPayload
lauraMon's avatar
lauraMon committed
3144

3145
Autogenerated return type of PipelineCancel.
lauraMon's avatar
lauraMon committed
3146

3147 3148
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
3149 3150 3151
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

3152
### PipelineDestroyPayload
lauraMon's avatar
lauraMon committed
3153

3154
Autogenerated return type of PipelineDestroy.
lauraMon's avatar
lauraMon committed
3155

3156 3157
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
3158 3159 3160
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

3161
### PipelinePermissions
Felipe Artur's avatar
Felipe Artur committed
3162

3163 3164
| Field | Type | Description |
| ----- | ---- | ----------- |
3165 3166
| `adminPipeline` | Boolean! | Indicates the user can perform `admin_pipeline` on this resource |
| `destroyPipeline` | Boolean! | Indicates the user can perform `destroy_pipeline` on this resource |
3167
| `updatePipeline` | Boolean! | Indicates the user can perform `update_pipeline` on this resource |
Felipe Artur's avatar
Felipe Artur committed
3168

3169
### PipelineRetryPayload
lauraMon's avatar
lauraMon committed
3170

3171
Autogenerated return type of PipelineRetry.
lauraMon's avatar
lauraMon committed
3172

3173 3174
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
3175 3176
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3177
| `pipeline` | Pipeline | The pipeline after mutation. |
lauraMon's avatar
lauraMon committed
3178

3179 3180 3181 3182 3183 3184
### PipelineSecurityReportFinding

Represents vulnerability finding of a security report on the pipeline.

| Field | Type | Description |
| ----- | ---- | ----------- |
3185 3186
| `confidence` | String | Type of the security report that found the vulnerability. |
| `description` | String | Description of the vulnerability finding. |
3187
| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerabilit finding. |
3188 3189 3190 3191 3192
| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. |
| `name` | String | Name of the vulnerability finding. |
| `project` | Project | The project on which the vulnerability finding was found. |
| `projectFingerprint` | String | Name of the vulnerability finding. |
| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability finding. |
3193
| `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. |
3194 3195 3196
| `severity` | VulnerabilitySeverity | Severity of the vulnerability finding. |
| `solution` | String | URL to the vulnerability's details page. |
| `uuid` | String | Name of the vulnerability finding. |
3197

3198
### Project
Felipe Artur's avatar
Felipe Artur committed
3199

3200 3201
| Field | Type | Description |
| ----- | ---- | ----------- |
3202
| `actualRepositorySizeLimit` | Float | Size limit for the repository in bytes. |
3203 3204 3205
| `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project. |
| `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project. |
| `alertManagementAlerts` | AlertManagementAlertConnection | Alert Management alerts of the project. |
3206
| `alertManagementHttpIntegrations` | AlertManagementHttpIntegrationConnection | HTTP Integrations which can receive alerts for the project. |
3207
| `alertManagementIntegrations` | AlertManagementIntegrationConnection | Integrations which can receive alerts for the project. |
3208
| `alertManagementPayloadFields` | AlertManagementPayloadAlertField! => Array | Extract alert fields from payload for custom mapping. |
3209
| `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. |
3210
| `apiFuzzingCiConfiguration` | ApiFuzzingCiConfiguration | API fuzzing configuration for the project. Available only when feature flag `api_fuzzing_configuration_ui` is enabled. |
3211 3212 3213 3214 3215 3216
| `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. |
| `board` | Board | A single board of the project. |
| `boards` | BoardConnection | Boards of the project. |
| `ciCdSettings` | ProjectCiCdSetting | CI/CD settings for the project. |
3217 3218 3219 3220
| `clusterAgent` | ClusterAgent | Find a single cluster agent by name. |
| `clusterAgents` | ClusterAgentConnection | Cluster agents associated with the project. |
| `codeCoverageSummary` | CodeCoverageSummary | Code coverage summary associated with the project. |
| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks associated with the project. |
3221 3222 3223 3224 3225
| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy of the project. |
| `containerRegistryEnabled` | Boolean | Indicates if the project stores Docker container images in a container registry. |
| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the project. |
| `containerRepositoriesCount` | Int! | Number of container repositories in the project. |
| `createdAt` | Time | Timestamp of the project creation. |
3226 3227 3228 3229
| `dastProfiles` | DastProfileConnection | DAST Profiles associated with the project. Always returns no nodes if `dast_saved_scans` is disabled. |
| `dastScannerProfiles` | DastScannerProfileConnection | The DAST scanner profiles associated with the project. |
| `dastSiteProfile` | DastSiteProfile | DAST Site Profile associated with the project. |
| `dastSiteProfiles` | DastSiteProfileConnection | DAST Site Profiles associated with the project. |
3230
| `dastSiteValidations` | DastSiteValidationConnection | DAST Site Validations associated with the project. |
3231
| `description` | String | Short description of the project. |
Felipe Artur's avatar
Felipe Artur committed
3232
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3233 3234 3235 3236 3237 3238 3239 3240 3241
| `environment` | Environment | A single environment of the project. |
| `environments` | EnvironmentConnection | Environments of the project. |
| `forksCount` | Int! | Number of times the project has been forked. |
| `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. |
| `importStatus` | String | Status of import background job of the project. |
3242
| `incidentManagementOncallSchedules` | IncidentManagementOncallScheduleConnection | Incident Management On-call schedules of the project. |
3243 3244 3245
| `issue` | Issue | A single issue of the project. |
| `issueStatusCounts` | IssueStatusCountsType | Counts of issues by status for the project. |
| `issues` | IssueConnection | Issues of the project. |
3246
| `issuesEnabled` | Boolean | Indicates if Issues are enabled for the current user |
3247
| `iterations` | IterationConnection | Find iterations. |
3248 3249 3250 3251 3252 3253 3254 3255 3256
| `jiraImportStatus` | String | Status of Jira import background job of the project. |
| `jiraImports` | JiraImportConnection | Jira imports into the project. |
| `jobsEnabled` | Boolean | Indicates if CI/CD pipeline jobs are enabled for the current user. |
| `label` | Label | A label available on this project. |
| `labels` | LabelConnection | Labels available on this project. |
| `lastActivityAt` | Time | Timestamp of the project last activity. |
| `lfsEnabled` | Boolean | Indicates if the project has Large File Storage (LFS) enabled. |
| `mergeRequest` | MergeRequest | A single merge request of the project. |
| `mergeRequests` | MergeRequestConnection | Merge requests of the project. |
3257
| `mergeRequestsEnabled` | Boolean | Indicates if Merge Requests are enabled for the current user |
3258
| `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. |
3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277
| `milestones` | MilestoneConnection | Milestones of the project. |
| `name` | String! | Name of the project (without namespace). |
| `nameWithNamespace` | String! | Full name of the project with its namespace. |
| `namespace` | Namespace | Namespace of the project. |
| `onlyAllowMergeIfAllDiscussionsAreResolved` | Boolean | Indicates if merge requests of the project can only be merged when all the discussions are resolved. |
| `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. |
| `packages` | PackageConnection | Packages of the project. |
| `path` | String! | Path of the project. |
| `pipeline` | Pipeline | Build pipeline of the project. |
| `pipelineAnalytics` | PipelineAnalytics | Pipeline analytics. |
| `pipelines` | PipelineConnection | Build pipelines of the project. |
| `printingMergeRequestLinkEnabled` | Boolean | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line. |
| `projectMembers` | MemberInterfaceConnection | Members of the project. |
| `publicJobs` | Boolean | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. |
| `release` | Release | A single release of the project. |
| `releases` | ReleaseConnection | Releases of the project. |
| `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. |
3278
| `repositorySizeExcess` | Float | Size of repository that exceeds the limit in bytes. |
3279
| `requestAccessEnabled` | Boolean | Indicates if users can request member access to the project. |
3280 3281 3282
| `requirement` | Requirement | Find a single requirement. |
| `requirementStatesCount` | RequirementStatesCount | Number of requirements for the project by their state. |
| `requirements` | RequirementConnection | Find requirements. |
3283
| `sastCiConfiguration` | SastCiConfiguration | SAST CI configuration for the project. |
3284 3285
| `securityDashboardPath` | String | Path to project's security dashboard. |
| `securityScanners` | SecurityScanners | Information about security analyzers used in the project. |
3286 3287
| `sentryDetailedError` | SentryDetailedError | Detailed version of a Sentry error on the project. |
| `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project. |
3288
| `serviceDeskAddress` | String | E-mail address of the service desk. |
3289
| `serviceDeskEnabled` | Boolean | Indicates if the project has service desk enabled. |
3290 3291 3292
| `services` | ServiceConnection | Project services. |
| `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project. |
| `snippets` | SnippetConnection | Snippets of the project. |
3293
| `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user |
3294 3295 3296 3297 3298 3299
| `squashReadOnly` | Boolean! | Indicates if `squashReadOnly` is enabled. |
| `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. |
| `tagList` | String | List of project topics (not Git tags). |
3300 3301
| `terraformState` | TerraformState | Find a single Terraform state by name. |
| `terraformStates` | TerraformStateConnection | Terraform states associated with the project. |
3302
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
3303
| `visibility` | String | Visibility of the project. |
3304 3305 3306 3307
| `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 vulnerabilities. |
| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the project. |
3308
| `webUrl` | String | Web URL of the project. |
3309
| `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user |
Felipe Artur's avatar
Felipe Artur committed
3310

3311 3312 3313 3314
### ProjectCiCdSetting

| Field | Type | Description |
| ----- | ---- | ----------- |
3315
| `keepLatestArtifact` | Boolean | Whether to keep the latest builds artifacts. |
3316 3317 3318 3319
| `mergePipelinesEnabled` | Boolean | Whether merge pipelines are enabled. |
| `mergeTrainsEnabled` | Boolean | Whether merge trains are enabled. |
| `project` | Project | Project the CI/CD settings belong to. |

3320
### ProjectMember
3321

3322
Represents a Project Membership.
3323

3324 3325
| Field | Type | Description |
| ----- | ---- | ----------- |
3326 3327 3328 3329 3330 3331 3332 3333
| `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. |
| `id` | ID! | ID of the member. |
| `project` | Project | Project that User is a member of. |
| `updatedAt` | Time | Date and time the membership was last updated. |
| `user` | User! | User that is associated with the member object. |
3334
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
3335

3336
### ProjectPermissions
Felipe Artur's avatar
Felipe Artur committed
3337

3338 3339
| Field | Type | Description |
| ----- | ---- | ----------- |
3340 3341 3342 3343 3344
| `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 |
3345 3346
| `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 |
3347 3348
| `createDeployment` | Boolean! | Indicates the user can perform `create_deployment` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
3349
| `createIssue` | Boolean! | Indicates the user can perform `create_issue` on this resource |
3350 3351 3352 3353
| `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 |
3354 3355
| `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 |
3356
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
3357
| `createWiki` | Boolean! | Indicates the user can perform `create_wiki` on this resource |
3358 3359 3360 3361 3362 3363
| `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 |
3364 3365
| `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 |
3366 3367 3368
| `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 |
3369
| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource |
3370 3371 3372 3373 3374 3375 3376 3377 3378
| `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 |
3379 3380
| `updatePages` | Boolean! | Indicates the user can perform `update_pages` on this resource |
| `updateWiki` | Boolean! | Indicates the user can perform `update_wiki` on this resource |
3381
| `uploadFile` | Boolean! | Indicates the user can perform `upload_file` on this resource |
Felipe Artur's avatar
Felipe Artur committed
3382

3383
### ProjectStatistics
Felipe Artur's avatar
Felipe Artur committed
3384

3385 3386
| Field | Type | Description |
| ----- | ---- | ----------- |
3387 3388 3389 3390 3391 3392 3393 3394 3395
| `buildArtifactsSize` | Float! | Build artifacts size of the project in bytes. |
| `commitCount` | Float! | Commit count of the project. |
| `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
3396

3397
### PrometheusAlert
3398

3399
The alert condition for Prometheus.
3400

3401 3402
| Field | Type | Description |
| ----- | ---- | ----------- |
3403 3404
| `humanizedText` | String! | The human-readable text of the alert condition. |
| `id` | ID! | ID of the alert condition. |
3405

3406 3407 3408 3409 3410 3411 3412 3413
### 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. |
3414
| `integration` | AlertManagementPrometheusIntegration | The newly created integration. |
3415 3416 3417 3418 3419 3420 3421 3422 3423

### 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. |
3424
| `integration` | AlertManagementPrometheusIntegration | The newly created integration. |
3425 3426 3427 3428 3429 3430 3431 3432 3433

### 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. |
3434
| `integration` | AlertManagementPrometheusIntegration | The newly created integration. |
3435

3436 3437 3438 3439 3440 3441 3442
### PromoteToEpicPayload

Autogenerated return type of PromoteToEpic.

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

3447
### Release
3448

3449
Represents a release.
3450

3451 3452
| Field | Type | Description |
| ----- | ---- | ----------- |
3453 3454 3455 3456 3457
| `assets` | ReleaseAssets | Assets of the release. |
| `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. |
3458
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3459 3460 3461 3462 3463 3464 3465 3466
| `evidences` | ReleaseEvidenceConnection | Evidence for the release. |
| `links` | ReleaseLinks | Links of the release. |
| `milestones` | MilestoneConnection | Milestones associated to the release. |
| `name` | String | Name of the release. |
| `releasedAt` | Time | Timestamp of when the release was released. |
| `tagName` | String | Name of the tag associated with the release. |
| `tagPath` | String | Relative web path to the tag associated with the release. |
| `upcomingRelease` | Boolean | Indicates the release is an upcoming release. |
3467

3468
### ReleaseAssetLink
3469

3470
Represents an asset link associated with a release.
3471

3472 3473
| Field | Type | Description |
| ----- | ---- | ----------- |
3474 3475 3476 3477 3478 3479
| `directAssetUrl` | String | Direct asset URL of the link. |
| `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. |
3480

3481
### ReleaseAssets
3482

3483
A container for all assets associated with a release.
3484

3485 3486
| Field | Type | Description |
| ----- | ---- | ----------- |
3487 3488 3489
| `count` | Int | Number of assets of the release. |
| `links` | ReleaseAssetLinkConnection | Asset links of the release. |
| `sources` | ReleaseSourceConnection | Sources of the release. |
3490

3491 3492 3493 3494 3495 3496 3497 3498
### 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. |
3499
| `release` | Release | The release after mutation. |
3500

3501 3502 3503 3504 3505 3506 3507 3508 3509 3510
### 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. |

3511
### ReleaseEvidence
3512

3513
Evidence for a release.
3514

3515 3516
| Field | Type | Description |
| ----- | ---- | ----------- |
3517 3518 3519 3520
| `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. |
3521

3522
### ReleaseLinks
3523

3524 3525
| Field | Type | Description |
| ----- | ---- | ----------- |
3526 3527 3528 3529 3530 3531 3532
| `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`. |
| `editUrl` | String | HTTP URL of the release's edit page. |
| `mergedMergeRequestsUrl` | String | HTTP URL of the merge request page , filtered by this release and `state=merged`. |
| `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`. |
| `selfUrl` | String | HTTP URL of the release. |
3533

3534
### ReleaseSource
3535

3536
Represents the source code attached to a release in a particular format.
3537

3538 3539
| Field | Type | Description |
| ----- | ---- | ----------- |
3540 3541
| `format` | String | Format of the source. |
| `url` | String | Download URL of the source. |
3542

3543 3544 3545 3546 3547 3548 3549 3550 3551 3552
### 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. |

3553
### RemoveAwardEmojiPayload
3554

3555
Autogenerated return type of RemoveAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
3556

3557 3558
| Field | Type | Description |
| ----- | ---- | ----------- |
3559
| `awardEmoji` | AwardEmoji | The award emoji after mutation. |
Felipe Artur's avatar
Felipe Artur committed
3560
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3561
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
3562

3563
### RemoveProjectFromSecurityDashboardPayload
3564

3565
Autogenerated return type of RemoveProjectFromSecurityDashboard.
3566

3567 3568
| Field | Type | Description |
| ----- | ---- | ----------- |
3569
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3570
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
3571

3572 3573 3574 3575 3576 3577 3578 3579
### 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. |
3580
| `note` | Note | The note after mutation. |
3581

3582
### Repository
Felipe Artur's avatar
Felipe Artur committed
3583

3584 3585
| Field | Type | Description |
| ----- | ---- | ----------- |
3586 3587 3588 3589
| `empty` | Boolean! | Indicates repository has no visible content. |
| `exists` | Boolean! | Indicates a corresponding Git repository exists on disk. |
| `rootRef` | String | Default branch of the repository. |
| `tree` | Tree | Tree of the repository. |
Felipe Artur's avatar
Felipe Artur committed
3590

3591
### Requirement
Jan Provaznik's avatar
Jan Provaznik committed
3592

3593
Represents a requirement.
Jan Provaznik's avatar
Jan Provaznik committed
3594

3595 3596
| Field | Type | Description |
| ----- | ---- | ----------- |
3597 3598 3599
| `author` | User! | Author of the requirement. |
| `createdAt` | Time! | Timestamp of when the requirement was created. |
| `description` | String | Description of the requirement. |
3600
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3601 3602 3603 3604 3605 3606 3607 3608
| `id` | ID! | ID of the requirement. |
| `iid` | ID! | Internal ID of the requirement. |
| `lastTestReportManuallyCreated` | Boolean | Indicates if latest test report was created by user. |
| `lastTestReportState` | TestReportState | Latest requirement test report state. |
| `project` | Project! | Project to which the requirement belongs. |
| `state` | RequirementState! | State of the requirement. |
| `testReports` | TestReportConnection | Test reports of the requirement. |
| `title` | String | Title of the requirement. |
3609
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
3610
| `updatedAt` | Time! | Timestamp of when the requirement was last updated. |
Jan Provaznik's avatar
Jan Provaznik committed
3611 3612
| `userPermissions` | RequirementPermissions! | Permissions for the current user on the resource |

3613
### RequirementPermissions
Jan Provaznik's avatar
Jan Provaznik committed
3614

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

3617 3618
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
3619 3620 3621 3622 3623 3624
| `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 |

3625
### RequirementStatesCount
3626 3627 3628

Counts of requirements by their state.

3629 3630
| Field | Type | Description |
| ----- | ---- | ----------- |
3631 3632
| `archived` | Int | Number of archived requirements. |
| `opened` | Int | Number of opened requirements. |
3633

3634 3635 3636 3637 3638 3639 3640 3641
### 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. |
3642
| `vulnerability` | Vulnerability | The vulnerability after revert. |
3643

3644
### RootStorageStatistics
3645

3646 3647
| Field | Type | Description |
| ----- | ---- | ----------- |
3648 3649 3650 3651 3652 3653 3654 3655 3656
| `buildArtifactsSize` | Float! | The CI artifacts size in bytes. |
| `lfsObjectsSize` | Float! | The LFS objects size in bytes. |
| `packagesSize` | Float! | The packages size in bytes. |
| `pipelineArtifactsSize` | Float! | The CI pipeline artifacts size in bytes. |
| `repositorySize` | Float! | The Git repository size in bytes. |
| `snippetsSize` | Float! | The snippets size in bytes. |
| `storageSize` | Float! | The total storage in bytes. |
| `uploadsSize` | Float! | The uploads size in bytes. |
| `wikiSize` | Float! | The wiki size in bytes. |
3657

3658
### RunDASTScanPayload
3659

3660
Autogenerated return type of RunDASTScan.
3661

3662 3663
| Field | Type | Description |
| ----- | ---- | ----------- |
3664 3665 3666 3667
| `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. |

3668 3669 3670 3671
### RunnerArchitecture

| Field | Type | Description |
| ----- | ---- | ----------- |
3672 3673
| `downloadLocation` | String! | Download location for the runner for the platform architecture. |
| `name` | String! | Name of the runner platform architecture. |
3674 3675 3676 3677 3678

### RunnerPlatform

| Field | Type | Description |
| ----- | ---- | ----------- |
3679 3680 3681
| `architectures` | RunnerArchitectureConnection | Runner architectures supported for the platform. |
| `humanReadableName` | String! | Human readable name of the runner platform. |
| `name` | String! | Name slug of the runner platform. |
3682

3683 3684 3685 3686
### RunnerSetup

| Field | Type | Description |
| ----- | ---- | ----------- |
3687 3688
| `installInstructions` | String! | Instructions for installing the runner on the specified architecture. |
| `registerInstructions` | String | Instructions for registering the runner. |
3689

3690 3691 3692 3693 3694 3695 3696 3697 3698 3699
### 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. |

3700
### SastCiConfigurationAnalyzersEntity
3701

3702
Represents an analyzer entity in SAST CI configuration.
3703

3704 3705
| Field | Type | Description |
| ----- | ---- | ----------- |
3706 3707 3708 3709 3710
| `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. |
| `variables` | SastCiConfigurationEntityConnection | List of supported variables. |
3711

3712
### SastCiConfigurationEntity
3713

3714
Represents an entity in SAST CI configuration.
3715

3716 3717
| Field | Type | Description |
| ----- | ---- | ----------- |
3718 3719 3720 3721
| `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. |
3722
| `options` | SastCiConfigurationOptionsEntityConnection | Different possible values of the field. |
3723
| `size` | SastUiComponentSize | Size of the UI component. |
3724 3725 3726
| `type` | String | Type of the field value. |
| `value` | String | Current value of the entity. |

3727
### SastCiConfigurationOptionsEntity
3728

3729
Represents an entity for options in SAST CI configuration.
3730

3731 3732
| Field | Type | Description |
| ----- | ---- | ----------- |
3733 3734 3735
| `label` | String | Label of option entity. |
| `value` | String | Value of option entity. |

3736
### ScannedResource
3737

3738
Represents a resource scanned by a security scan.
3739

3740 3741
| Field | Type | Description |
| ----- | ---- | ----------- |
3742 3743
| `requestMethod` | String | The HTTP request method used to access the URL. |
| `url` | String | The URL scanned by the scanner. |
3744

3745
### SecurityReportSummary
3746

3747
Represents summary of a security report.
3748

3749 3750
| Field | Type | Description |
| ----- | ---- | ----------- |
3751 3752 3753 3754 3755 3756 3757
| `apiFuzzing` | SecurityReportSummarySection | Aggregated counts for the `api_fuzzing` scan |
| `containerScanning` | SecurityReportSummarySection | Aggregated counts for the `container_scanning` scan |
| `coverageFuzzing` | SecurityReportSummarySection | Aggregated counts for the `coverage_fuzzing` scan |
| `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 |
3758

3759
### SecurityReportSummarySection
3760

3761
Represents a section of a summary of a security report.
3762

3763 3764
| Field | Type | Description |
| ----- | ---- | ----------- |
3765 3766 3767 3768
| `scannedResources` | ScannedResourceConnection | A list of the first 20 scanned resources. |
| `scannedResourcesCount` | Int | Total number of scanned resources. |
| `scannedResourcesCsvPath` | String | Path to download all the scanned resources in CSV format. |
| `vulnerabilitiesCount` | Int | Total number of vulnerabilities. |
3769

3770
### SecurityScanners
3771

3772
Represents a list of security scanners.
3773

3774 3775
| Field | Type | Description |
| ----- | ---- | ----------- |
3776 3777 3778 3779
| `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. |

3780
### SentryDetailedError
3781

Sean Arnold's avatar
Sean Arnold committed
3782 3783
A Sentry error.

3784 3785
| Field | Type | Description |
| ----- | ---- | ----------- |
3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813
| `count` | Int! | Count of occurrences. |
| `culprit` | String! | Culprit of the error. |
| `externalBaseUrl` | String! | External Base URL of the Sentry Instance. |
| `externalUrl` | String! | External URL of the error. |
| `firstReleaseLastCommit` | String | Commit the error was first seen. |
| `firstReleaseShortVersion` | String | Release short version the error was first seen. |
| `firstReleaseVersion` | String | Release version the error was first seen. |
| `firstSeen` | Time! | Timestamp when the error was first seen. |
| `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. |
| `gitlabIssuePath` | String | URL of GitLab Issue. |
| `id` | ID! | ID (global ID) of the error. |
| `lastReleaseLastCommit` | String | Commit the error was last seen. |
| `lastReleaseShortVersion` | String | Release short version the error was last seen. |
| `lastReleaseVersion` | String | Release version the error was last seen. |
| `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. |
| `tags` | SentryErrorTags! | Tags associated with the Sentry Error. |
| `title` | String! | Title of the error. |
| `type` | String! | Type of the error. |
| `userCount` | Int! | Count of users affected by the error. |
3814

3815
### SentryError
Sean Arnold's avatar
Sean Arnold committed
3816 3817 3818

A Sentry error. A simplified version of SentryDetailedError.

3819 3820
| Field | Type | Description |
| ----- | ---- | ----------- |
3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837
| `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. |
Sean Arnold's avatar
Sean Arnold committed
3838

3839
### SentryErrorCollection
Sean Arnold's avatar
Sean Arnold committed
3840 3841 3842

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

3843 3844
| Field | Type | Description |
| ----- | ---- | ----------- |
3845 3846 3847 3848
| `detailedError` | SentryDetailedError | Detailed version of a Sentry error on the project. |
| `errorStackTrace` | SentryErrorStackTrace | Stack Trace of Sentry Error. |
| `errors` | SentryErrorConnection | Collection of Sentry Errors. |
| `externalUrl` | String | External URL for Sentry. |
Sean Arnold's avatar
Sean Arnold committed
3849

3850
### SentryErrorFrequency
3851

3852 3853
| Field | Type | Description |
| ----- | ---- | ----------- |
3854 3855
| `count` | Int! | Count of errors received since the previously recorded time. |
| `time` | Time! | Time the error frequency stats were recorded. |
3856

3857
### SentryErrorStackTrace
Sean Arnold's avatar
Sean Arnold committed
3858 3859 3860

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

3861 3862
| Field | Type | Description |
| ----- | ---- | ----------- |
3863 3864 3865
| `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. |
Sean Arnold's avatar
Sean Arnold committed
3866

3867
### SentryErrorStackTraceContext
Sean Arnold's avatar
Sean Arnold committed
3868

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

3871 3872
| Field | Type | Description |
| ----- | ---- | ----------- |
3873 3874
| `code` | String! | Code number of the context. |
| `line` | Int! | Line number of the context. |
Sean Arnold's avatar
Sean Arnold committed
3875

3876
### SentryErrorStackTraceEntry
Sean Arnold's avatar
Sean Arnold committed
3877 3878 3879

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

3880 3881
| Field | Type | Description |
| ----- | ---- | ----------- |
3882 3883 3884 3885 3886
| `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. |
Sean Arnold's avatar
Sean Arnold committed
3887

3888
### SentryErrorTags
3889

3890
State of a Sentry error.
3891

3892 3893
| Field | Type | Description |
| ----- | ---- | ----------- |
3894 3895
| `level` | String | Severity level of the Sentry Error. |
| `logger` | String | Logger of the Sentry Error. |
3896

3897
### Snippet
3898

3899
Represents a snippet entry.
3900

3901 3902
| Field | Type | Description |
| ----- | ---- | ----------- |
3903
| `author` | User | The owner of the snippet. |
3904
| `blob` **{warning-solid}** | SnippetBlob! | **Deprecated:** Use `blobs`. Deprecated in 13.3. |
3905 3906 3907
| `blobs` | SnippetBlobConnection | Snippet blobs. |
| `createdAt` | Time! | Timestamp this snippet was created. |
| `description` | String | Description of the snippet. |
3908
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3909 3910 3911 3912 3913 3914 3915 3916 3917 3918
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
| `fileName` | String | File Name of the snippet. |
| `httpUrlToRepo` | String | HTTP URL to the snippet repository. |
| `id` | SnippetID! | ID of the snippet. |
| `notes` | NoteConnection! | All notes on this noteable. |
| `project` | Project | The project the snippet is associated with. |
| `rawUrl` | String! | Raw URL of the snippet. |
| `sshUrlToRepo` | String | SSH URL to the snippet repository. |
| `title` | String! | Title of the snippet. |
| `updatedAt` | Time! | Timestamp this snippet was updated. |
3919
| `userPermissions` | SnippetPermissions! | Permissions for the current user on the resource |
3920 3921
| `visibilityLevel` | VisibilityLevelsEnum! | Visibility Level of the snippet. |
| `webUrl` | String! | Web URL of the snippet. |
3922

3923
### SnippetBlob
3924

3925
Represents the snippet blob.
3926

3927 3928
| Field | Type | Description |
| ----- | ---- | ----------- |
3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940
| `binary` | Boolean! | Shows whether the blob is binary. |
| `externalStorage` | String | Blob external storage. |
| `mode` | String | Blob mode. |
| `name` | String | Blob name. |
| `path` | String | Blob path. |
| `plainData` | String | Blob plain highlighted data. |
| `rawPath` | String! | Blob raw content endpoint path. |
| `renderedAsText` | Boolean! | Shows whether the blob is rendered as text. |
| `richData` | String | Blob highlighted data. |
| `richViewer` | SnippetBlobViewer | Blob content rich viewer. |
| `simpleViewer` | SnippetBlobViewer! | Blob content simple viewer. |
| `size` | Int! | Blob size. |
3941

3942
### SnippetBlobViewer
3943

3944
Represents how the blob content should be displayed.
3945

3946 3947
| Field | Type | Description |
| ----- | ---- | ----------- |
3948 3949 3950 3951 3952 3953 3954
| `collapsed` | Boolean! | Shows whether the blob should be displayed collapsed. |
| `fileType` | String! | Content file type. |
| `loadAsync` | Boolean! | Shows whether the blob content is loaded asynchronously. |
| `loadingPartialName` | String! | Loading partial name. |
| `renderError` | String | Error rendering the blob content. |
| `tooLarge` | Boolean! | Shows whether the blob too large to be displayed. |
| `type` | BlobViewersType! | Type of blob viewer. |
3955

3956
### SnippetPermissions
3957

3958 3959
| Field | Type | Description |
| ----- | ---- | ----------- |
3960
| `adminSnippet` | Boolean! | Indicates the user can perform `admin_snippet` on this resource |
3961
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
3962
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
3963 3964
| `readSnippet` | Boolean! | Indicates the user can perform `read_snippet` on this resource |
| `reportSnippet` | Boolean! | Indicates the user can perform `report_snippet` on this resource |
3965
| `updateSnippet` | Boolean! | Indicates the user can perform `update_snippet` on this resource |
3966

3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978
### 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 |
3979
| `snippetRepositoryId` | ID! | ID of the Snippet Repository. |
3980 3981
| `state` | RegistryState | Sync state of the SnippetRepositoryRegistry |

3982 3983 3984 3985
### StatusAction

| Field | Type | Description |
| ----- | ---- | ----------- |
3986 3987 3988 3989 3990
| `buttonTitle` | String | Title for the button, for example: Retry this job. |
| `icon` | String | Icon used in the action button. |
| `method` | String | Method for the action, for example: :post. |
| `path` | String | Path for the action. |
| `title` | String | Title for the action, for example: Retry. |
3991

3992
### Submodule
Felipe Artur's avatar
Felipe Artur committed
3993

3994 3995
| Field | Type | Description |
| ----- | ---- | ----------- |
3996 3997 3998 3999 4000 4001 4002 4003
| `flatPath` | String! | Flat path of the entry. |
| `id` | ID! | ID of the entry. |
| `name` | String! | Name of the entry. |
| `path` | String! | Path of the entry. |
| `sha` | String! | Last commit SHA for the entry. |
| `treeUrl` | String | Tree URL for the sub-module. |
| `type` | EntryType! | Type of tree entry. |
| `webUrl` | String | Web URL for the sub-module. |
Felipe Artur's avatar
Felipe Artur committed
4004

4005
### TaskCompletionStatus
4006

4007
Completion status of tasks.
Felipe Artur's avatar
Felipe Artur committed
4008

4009 4010
| Field | Type | Description |
| ----- | ---- | ----------- |
4011 4012
| `completedCount` | Int! | Number of completed tasks. |
| `count` | Int! | Number of total tasks. |
Felipe Artur's avatar
Felipe Artur committed
4013

4014 4015 4016 4017
### TerraformState

| Field | Type | Description |
| ----- | ---- | ----------- |
4018 4019 4020 4021 4022 4023 4024
| `createdAt` | Time! | Timestamp the Terraform state was created. |
| `id` | ID! | ID of the Terraform state. |
| `latestVersion` | TerraformStateVersion | The latest version of the Terraform state. |
| `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. |
4025

4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052
### 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. |

4053 4054 4055 4056
### TerraformStateVersion

| Field | Type | Description |
| ----- | ---- | ----------- |
4057 4058 4059 4060 4061 4062 4063
| `createdAt` | Time! | Timestamp the version was created. |
| `createdByUser` | User | The user that created this version. |
| `downloadPath` | String | URL for downloading the version's JSON file. |
| `id` | ID! | ID of the Terraform state version. |
| `job` | CiJob | The job that created this version. |
| `serial` | Int | Serial number of the version. |
| `updatedAt` | Time! | Timestamp the version was updated. |
4064

4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077
### 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 |
4078
| `terraformStateVersionId` | ID! | ID of the terraform state version. |
4079

4080
### TestReport
4081 4082 4083

Represents a requirement test report.

4084 4085
| Field | Type | Description |
| ----- | ---- | ----------- |
4086 4087 4088 4089
| `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. |
4090

4091 4092 4093 4094 4095 4096
### TimeReportStats

Represents the time report stats for timeboxes.

| Field | Type | Description |
| ----- | ---- | ----------- |
4097 4098 4099
| `complete` | TimeboxMetrics | Completed issues metrics. |
| `incomplete` | TimeboxMetrics | Incomplete issues metrics. |
| `total` | TimeboxMetrics | Total issues metrics. |
4100 4101 4102 4103 4104 4105 4106

### TimeboxMetrics

Represents measured stats metrics for timeboxes.

| Field | Type | Description |
| ----- | ---- | ----------- |
4107 4108
| `count` | Int! | The count metric. |
| `weight` | Int! | The weight metric. |
4109

4110 4111 4112 4113 4114 4115
### TimeboxReport

Represents a historically accurate report about the timebox.

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

4119
### Timelog
4120

4121 4122
| Field | Type | Description |
| ----- | ---- | ----------- |
4123 4124 4125 4126 4127
| `issue` | Issue | The issue that logged time was added to. |
| `note` | Note | The note where the quick action to add the logged time was executed. |
| `spentAt` | Time | Timestamp of when the time tracked was spent at. |
| `timeSpent` | Int! | The time spent displayed in seconds. |
| `user` | User! | The user that logged the time. |
4128

4129
### Todo
4130

4131
Representing a to-do entry.
4132

4133 4134
| Field | Type | Description |
| ----- | ---- | ----------- |
4135 4136 4137 4138 4139 4140 4141 4142 4143
| `action` | TodoActionEnum! | Action of the to-do item. |
| `author` | User! | The author of this to-do item. |
| `body` | String! | Body of the to-do item. |
| `createdAt` | Time! | Timestamp this to-do item was created. |
| `group` | Group | Group this to-do item is associated with. |
| `id` | ID! | ID of the to-do item. |
| `project` | Project | The project this to-do item is associated with. |
| `state` | TodoStateEnum! | State of the to-do item. |
| `targetType` | TodoTargetEnum! | Target type of the to-do item. |
4144

4145 4146 4147 4148 4149 4150 4151 4152
### 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. |
4153
| `todo` | Todo | The to-do item created. |
4154

4155
### TodoMarkDonePayload
4156

4157
Autogenerated return type of TodoMarkDone.
4158

4159 4160
| Field | Type | Description |
| ----- | ---- | ----------- |
4161
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4162
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4163
| `todo` | Todo! | The requested to-do item. |
4164

4165
### TodoRestoreManyPayload
4166

4167
Autogenerated return type of TodoRestoreMany.
4168

4169 4170
| Field | Type | Description |
| ----- | ---- | ----------- |
4171
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4172
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4173 4174
| `todos` | Todo! => Array | Updated to-do items. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. |
4175

4176
### TodoRestorePayload
4177

4178
Autogenerated return type of TodoRestore.
4179

4180 4181
| Field | Type | Description |
| ----- | ---- | ----------- |
4182
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4183
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4184
| `todo` | Todo! | The requested to-do item. |
4185

4186
### TodosMarkAllDonePayload
4187

4188
Autogenerated return type of TodosMarkAllDone.
4189

4190 4191
| Field | Type | Description |
| ----- | ---- | ----------- |
4192
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4193
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4194 4195
| `todos` | Todo! => Array | Updated to-do items. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. |
4196

4197
### ToggleAwardEmojiPayload
4198

4199
Autogenerated return type of ToggleAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
4200

4201 4202
| Field | Type | Description |
| ----- | ---- | ----------- |
4203
| `awardEmoji` | AwardEmoji | The award emoji after mutation. |
Felipe Artur's avatar
Felipe Artur committed
4204
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4205
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4206
| `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
4207

4208
### Tree
Felipe Artur's avatar
Felipe Artur committed
4209

4210 4211
| Field | Type | Description |
| ----- | ---- | ----------- |
4212 4213 4214 4215
| `blobs` | BlobConnection! | Blobs of the tree. |
| `lastCommit` | Commit | Last commit for the tree. |
| `submodules` | SubmoduleConnection! | Sub-modules of the tree. |
| `trees` | TreeEntryConnection! | Trees of the tree. |
Felipe Artur's avatar
Felipe Artur committed
4216

4217
### TreeEntry
4218

4219
Represents a directory.
Felipe Artur's avatar
Felipe Artur committed
4220

4221 4222
| Field | Type | Description |
| ----- | ---- | ----------- |
4223 4224 4225 4226 4227 4228 4229 4230
| `flatPath` | String! | Flat path of the entry. |
| `id` | ID! | ID of the entry. |
| `name` | String! | Name of the entry. |
| `path` | String! | Path of the entry. |
| `sha` | String! | Last commit SHA for the entry. |
| `type` | EntryType! | Type of tree entry. |
| `webPath` | String | Web path for the tree entry (directory). |
| `webUrl` | String | Web URL for the tree entry (directory). |
Felipe Artur's avatar
Felipe Artur committed
4231

4232
### UpdateAlertStatusPayload
Sean Arnold's avatar
Sean Arnold committed
4233

4234
Autogenerated return type of UpdateAlertStatus.
Sean Arnold's avatar
Sean Arnold committed
4235

4236 4237
| Field | Type | Description |
| ----- | ---- | ----------- |
4238
| `alert` | AlertManagementAlert | The alert after mutation. |
Sean Arnold's avatar
Sean Arnold committed
4239
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4240
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4241
| `issue` | Issue | The issue created after mutation. |
4242
| `todo` | Todo | The to-do item after mutation. |
Sean Arnold's avatar
Sean Arnold committed
4243

4244 4245 4246 4247 4248 4249 4250
### UpdateBoardEpicUserPreferencesPayload

Autogenerated return type of UpdateBoardEpicUserPreferences.

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

4254
### UpdateBoardListPayload
4255

4256
Autogenerated return type of UpdateBoardList.
4257

4258 4259
| Field | Type | Description |
| ----- | ---- | ----------- |
4260 4261
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4262
| `list` | BoardList | Mutated list. |
4263

4264
### UpdateBoardPayload
4265

4266
Autogenerated return type of UpdateBoard.
4267

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

4274 4275 4276 4277 4278 4279 4280
### UpdateComplianceFrameworkPayload

Autogenerated return type of UpdateComplianceFramework.

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

4284
### UpdateContainerExpirationPolicyPayload
4285

4286
Autogenerated return type of UpdateContainerExpirationPolicy.
4287

4288 4289
| Field | Type | Description |
| ----- | ---- | ----------- |
4290
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4291
| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy after mutation. |
4292 4293
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

4294
### UpdateEpicPayload
4295

4296
Autogenerated return type of UpdateEpic.
4297

4298 4299
| Field | Type | Description |
| ----- | ---- | ----------- |
4300
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4301
| `epic` | Epic | The epic after mutation. |
4302
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4303

4304
### UpdateImageDiffNotePayload
4305

4306
Autogenerated return type of UpdateImageDiffNote.
4307

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

4314
### UpdateIssuePayload
4315

4316
Autogenerated return type of UpdateIssue.
4317

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

4324
### UpdateIterationPayload
4325

4326
Autogenerated return type of UpdateIteration.
4327

4328 4329
| Field | Type | Description |
| ----- | ---- | ----------- |
4330 4331
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4332
| `iteration` | Iteration | Updated iteration. |
4333

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

4344
### UpdateNotePayload
4345

4346
Autogenerated return type of UpdateNote.
4347

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

4354
### UpdateRequirementPayload
4355

4356
Autogenerated return type of UpdateRequirement.
4357

4358 4359
| Field | Type | Description |
| ----- | ---- | ----------- |
4360
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4361
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4362
| `requirement` | Requirement | Requirement after mutation. |
4363

4364
### UpdateSnippetPayload
4365

4366
Autogenerated return type of UpdateSnippet.
4367

4368 4369
| Field | Type | Description |
| ----- | ---- | ----------- |
4370
| `captchaSiteKey` | String | The CAPTCHA site key which must be used to render a challenge for the user to solve to obtain a valid captchaResponse value. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. |
4371
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4372
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4373
| `needsCaptchaResponse` | Boolean | Indicates whether the operation was detected as possible spam and not completed. If CAPTCHA is enabled, the request must be resubmitted with a valid CAPTCHA response and spam_log_id included for the operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. |
4374
| `snippet` | Snippet | The snippet after mutation. |
4375 4376
| `spam` | Boolean | Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response. |
| `spamLogId` | Int | The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. |
4377

4378 4379 4380 4381 4382 4383 4384 4385 4386 4387
### UsageTrendsMeasurement

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

| Field | Type | Description |
| ----- | ---- | ----------- |
| `count` | Int! | Object count. |
| `identifier` | MeasurementIdentifier! | The type of objects being measured. |
| `recordedAt` | Time | The time the measurement was recorded. |

4388
### User
Felipe Artur's avatar
Felipe Artur committed
4389

4390 4391
| Field | Type | Description |
| ----- | ---- | ----------- |
4392 4393 4394
| `assignedMergeRequests` | MergeRequestConnection | Merge Requests assigned to the user. |
| `authoredMergeRequests` | MergeRequestConnection | Merge Requests authored by the user. |
| `avatarUrl` | String | URL of the user's avatar. |
Tetiana Chupryna's avatar
Tetiana Chupryna committed
4395
| `bot` | Boolean! | Indicates if the user is a bot. |
4396
| `email` **{warning-solid}** | String | **Deprecated:** Use public_email. Deprecated in 13.7. |
4397 4398 4399
| `groupCount` | Int | Group count for the user. Available only when feature flag `user_group_counts` is enabled. |
| `groupMemberships` | GroupMemberConnection | Group memberships of the user. |
| `id` | ID! | ID of the user. |
4400
| `location` | String | The location of the user. |
4401 4402 4403 4404 4405 4406 4407 4408 4409
| `name` | String! | Human-readable name of the user. |
| `projectMemberships` | ProjectMemberConnection | Project memberships of the user. |
| `publicEmail` | String | User's public email. |
| `reviewRequestedMergeRequests` | MergeRequestConnection | Merge Requests assigned to the user for review. |
| `snippets` | SnippetConnection | Snippets authored by the user. |
| `starredProjects` | ProjectConnection | Projects starred by the user. |
| `state` | UserState! | State of the user. |
| `status` | UserStatus | User status. |
| `todos` | TodoConnection! | To-do items of the user. |
4410
| `userPermissions` | UserPermissions! | Permissions for the current user on the resource |
4411 4412 4413
| `username` | String! | Username of the user. Unique within this instance of GitLab. |
| `webPath` | String! | Web path of the user. |
| `webUrl` | String! | Web URL of the user. |
4414

4415
### UserPermissions
4416

4417 4418
| Field | Type | Description |
| ----- | ---- | ----------- |
4419
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
4420

4421
### UserStatus
lauraMon's avatar
lauraMon committed
4422

4423 4424
| Field | Type | Description |
| ----- | ---- | ----------- |
4425 4426 4427
| `availability` | AvailabilityEnum! | User availability status. |
| `emoji` | String | String representation of emoji. |
| `message` | String | User status message. |
lauraMon's avatar
lauraMon committed
4428 4429
| `messageHtml` | String | HTML of the user status message |

4430
### VulnerabilitiesCountByDay
4431

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

4434 4435
| Field | Type | Description |
| ----- | ---- | ----------- |
4436
| `critical` | Int! | Total number of vulnerabilities on a particular day with critical severity |
4437
| `date` | ISO8601Date! | Date for the count. |
4438 4439 4440 4441
| `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 |
4442
| `total` | Int! | Total number of vulnerabilities on a particular day. |
4443 4444
| `unknown` | Int! | Total number of vulnerabilities on a particular day with unknown severity |

4445
### VulnerabilitiesCountByDayAndSeverity
4446

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

4449 4450
| Field | Type | Description |
| ----- | ---- | ----------- |
4451 4452 4453
| `count` | Int | Number of vulnerabilities. |
| `day` | ISO8601Date | Date for the count. |
| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities. |
4454

4455
### Vulnerability
4456 4457 4458

Represents a vulnerability.

4459 4460
| Field | Type | Description |
| ----- | ---- | ----------- |
4461
| `confirmedAt` | Time | Timestamp of when the vulnerability state was changed to confirmed. |
4462
| `confirmedBy` | User | The user that confirmed the vulnerability. |
4463 4464 4465
| `description` | String | Description of the vulnerability. |
| `details` | VulnerabilityDetail! => Array | Details of the vulnerability. |
| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected. |
4466
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
4467
| `dismissedAt` | Time | Timestamp of when the vulnerability state was changed to dismissed. |
4468
| `dismissedBy` | User | The user that dismissed the vulnerability. |
4469
| `externalIssueLinks` | VulnerabilityExternalIssueLinkConnection! | List of external issue links related to the vulnerability. |
4470
| `hasSolutions` | Boolean | Indicates whether there is a solution available for this vulnerability. |
4471
| `id` | ID! | GraphQL ID of the vulnerability. |
4472
| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerability. |
4473 4474
| `issueLinks` | VulnerabilityIssueLinkConnection! | List of issue links related to the vulnerability. |
| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. |
4475
| `mergeRequest` | MergeRequest | Merge request that fixes the vulnerability. |
4476
| `notes` | NoteConnection! | All notes on this noteable. |
4477
| `primaryIdentifier` | VulnerabilityIdentifier | Primary identifier of the vulnerability. |
4478
| `project` | Project | The project on which the vulnerability was found. |
4479
| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING) |
4480
| `resolvedAt` | Time | Timestamp of when the vulnerability state was changed to resolved. |
4481
| `resolvedBy` | User | The user that resolved the vulnerability. |
4482
| `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not. |
4483
| `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. |
4484
| `severity` | VulnerabilitySeverity | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL) |
4485
| `state` | VulnerabilityState | State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED) |
4486 4487
| `title` | String | Title of the vulnerability. |
| `userNotesCount` | Int! | Number of user notes attached to the vulnerability. |
4488
| `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource |
4489
| `vulnerabilityPath` | String | URL to the vulnerability's details page. |
Avielle Wolfe's avatar
Avielle Wolfe committed
4490

4491 4492 4493 4494 4495 4496 4497 4498
### 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. |
4499
| `vulnerability` | Vulnerability | The vulnerability after state change. |
4500

4501 4502 4503 4504 4505 4506
### VulnerabilityDetailBase

Represents the vulnerability details base.

| Field | Type | Description |
| ----- | ---- | ----------- |
4507
| `description` | String | Description of the field. |
4508
| `fieldName` | String | Name of the field. |
4509
| `name` | String | Name of the field. |
4510 4511 4512 4513 4514 4515 4516

### VulnerabilityDetailBoolean

Represents the vulnerability details boolean value.

| Field | Type | Description |
| ----- | ---- | ----------- |
4517
| `description` | String | Description of the field. |
4518
| `fieldName` | String | Name of the field. |
4519
| `name` | String | Name of the field. |
4520 4521 4522 4523 4524 4525 4526 4527
| `value` | Boolean! | Value of the field. |

### VulnerabilityDetailCode

Represents the vulnerability details code field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4528
| `description` | String | Description of the field. |
4529 4530
| `fieldName` | String | Name of the field. |
| `lang` | String | Language of the code. |
4531
| `name` | String | Name of the field. |
4532 4533 4534 4535 4536 4537 4538 4539
| `value` | String! | Source code. |

### VulnerabilityDetailCommit

Represents the vulnerability details commit field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4540
| `description` | String | Description of the field. |
4541
| `fieldName` | String | Name of the field. |
4542
| `name` | String | Name of the field. |
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552
| `value` | String! | The commit SHA value. |

### VulnerabilityDetailDiff

Represents the vulnerability details diff field.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `after` | String! | Value of the field after the change. |
| `before` | String! | Value of the field before the change. |
4553
| `description` | String | Description of the field. |
4554
| `fieldName` | String | Name of the field. |
4555
| `name` | String | Name of the field. |
4556 4557 4558 4559 4560 4561 4562

### VulnerabilityDetailFileLocation

Represents the vulnerability details location within a file in the project.

| Field | Type | Description |
| ----- | ---- | ----------- |
4563
| `description` | String | Description of the field. |
4564 4565 4566 4567
| `fieldName` | String | Name of the field. |
| `fileName` | String! | File name. |
| `lineEnd` | Int! | End line number of the file location. |
| `lineStart` | Int! | Start line number of the file location. |
4568
| `name` | String | Name of the field. |
4569 4570 4571 4572 4573 4574 4575

### VulnerabilityDetailInt

Represents the vulnerability details integer value.

| Field | Type | Description |
| ----- | ---- | ----------- |
4576
| `description` | String | Description of the field. |
4577
| `fieldName` | String | Name of the field. |
4578
| `name` | String | Name of the field. |
4579 4580 4581 4582 4583 4584 4585 4586
| `value` | Int! | Value of the field. |

### VulnerabilityDetailList

Represents the vulnerability details list value.

| Field | Type | Description |
| ----- | ---- | ----------- |
4587
| `description` | String | Description of the field. |
4588 4589
| `fieldName` | String | Name of the field. |
| `items` | VulnerabilityDetail! => Array | List of details. |
4590
| `name` | String | Name of the field. |
4591 4592 4593 4594 4595 4596 4597

### VulnerabilityDetailMarkdown

Represents the vulnerability details Markdown field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4598
| `description` | String | Description of the field. |
4599
| `fieldName` | String | Name of the field. |
4600
| `name` | String | Name of the field. |
4601 4602 4603 4604 4605 4606 4607 4608
| `value` | String! | Value of the Markdown field. |

### VulnerabilityDetailModuleLocation

Represents the vulnerability details location within a file in the project.

| Field | Type | Description |
| ----- | ---- | ----------- |
4609
| `description` | String | Description of the field. |
4610 4611
| `fieldName` | String | Name of the field. |
| `moduleName` | String! | Module name. |
4612
| `name` | String | Name of the field. |
4613 4614 4615 4616 4617 4618 4619 4620
| `offset` | Int! | Offset of the module location. |

### VulnerabilityDetailTable

Represents the vulnerability details table value.

| Field | Type | Description |
| ----- | ---- | ----------- |
4621
| `description` | String | Description of the field. |
4622 4623
| `fieldName` | String | Name of the field. |
| `headers` | VulnerabilityDetail! => Array | Table headers. |
4624
| `name` | String | Name of the field. |
4625 4626 4627 4628 4629 4630 4631 4632
| `rows` | VulnerabilityDetail! => Array | Table rows. |

### VulnerabilityDetailText

Represents the vulnerability details text field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4633
| `description` | String | Description of the field. |
4634
| `fieldName` | String | Name of the field. |
4635
| `name` | String | Name of the field. |
4636 4637 4638 4639 4640 4641 4642 4643
| `value` | String! | Value of the text field. |

### VulnerabilityDetailUrl

Represents the vulnerability details URL field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4644
| `description` | String | Description of the field. |
4645 4646
| `fieldName` | String | Name of the field. |
| `href` | String! | Href of the URL. |
4647
| `name` | String | Name of the field. |
4648 4649
| `text` | String | Text of the URL. |

4650 4651 4652 4653 4654 4655 4656 4657
### 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. |
4658
| `vulnerability` | Vulnerability | The vulnerability after dismissal. |
4659

4660 4661 4662 4663 4664 4665
### VulnerabilityExternalIssueLink

Represents an external issue link of a vulnerability.

| Field | Type | Description |
| ----- | ---- | ----------- |
4666 4667 4668
| `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. |
4669

4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688
### 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. |

4689
### VulnerabilityIdentifier
4690 4691 4692

Represents a vulnerability identifier.

4693 4694
| Field | Type | Description |
| ----- | ---- | ----------- |
4695 4696 4697 4698
| `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. |
4699

4700
### VulnerabilityIssueLink
4701 4702 4703

Represents an issue link of a vulnerability.

4704 4705
| Field | Type | Description |
| ----- | ---- | ----------- |
4706 4707 4708
| `id` | ID! | GraphQL ID of the vulnerability. |
| `issue` | Issue! | The issue attached to issue link. |
| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link. |
4709

4710
### VulnerabilityLocationContainerScanning
4711

4712
Represents the location of a vulnerability found by a container security scan.
4713

4714 4715
| Field | Type | Description |
| ----- | ---- | ----------- |
4716 4717 4718
| `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. |
4719

4720
### VulnerabilityLocationCoverageFuzzing
4721

4722
Represents the location of a vulnerability found by a Coverage Fuzzing scan.
4723

4724 4725
| Field | Type | Description |
| ----- | ---- | ----------- |
4726 4727 4728 4729 4730 4731
| `blobPath` | String | Blob path to the vulnerable file. |
| `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. |
4732

4733
### VulnerabilityLocationDast
4734

4735
Represents the location of a vulnerability found by a DAST scan.
4736

4737 4738
| Field | Type | Description |
| ----- | ---- | ----------- |
4739 4740 4741 4742
| `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. |
4743

4744
### VulnerabilityLocationDependencyScanning
4745

4746
Represents the location of a vulnerability found by a dependency security scan.
4747

4748 4749
| Field | Type | Description |
| ----- | ---- | ----------- |
4750 4751 4752
| `blobPath` | String | Blob path to the vulnerable file. |
| `dependency` | VulnerableDependency | Dependency containing the vulnerability. |
| `file` | String | Path to the vulnerable file. |
4753

4754
### VulnerabilityLocationSast
4755

4756
Represents the location of a vulnerability found by a SAST scan.
4757

4758 4759
| Field | Type | Description |
| ----- | ---- | ----------- |
4760 4761 4762 4763 4764 4765
| `blobPath` | String | Blob path to the vulnerable file. |
| `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. |
4766

4767
### VulnerabilityLocationSecretDetection
4768

4769
Represents the location of a vulnerability found by a secret detection scan.
4770

4771 4772
| Field | Type | Description |
| ----- | ---- | ----------- |
4773 4774 4775 4776 4777 4778
| `blobPath` | String | Blob path to the vulnerable file. |
| `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. |
4779

4780
### VulnerabilityPermissions
4781

4782
Check permissions for the current user on a vulnerability.
4783

4784 4785
| Field | Type | Description |
| ----- | ---- | ----------- |
4786
| `adminVulnerability` | Boolean! | Indicates the user can perform `admin_vulnerability` on this resource |
4787
| `adminVulnerabilityExternalIssueLink` | Boolean! | Indicates the user can perform `admin_vulnerability_external_issue_link` on this resource |
4788 4789 4790 4791 4792 4793 4794 4795
| `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 |

4796 4797 4798 4799 4800 4801 4802 4803
### 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. |
4804
| `vulnerability` | Vulnerability | The vulnerability after state change. |
4805

4806 4807 4808 4809 4810 4811 4812 4813
### 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. |
4814
| `vulnerability` | Vulnerability | The vulnerability after revert. |
4815

4816
### VulnerabilityScanner
4817 4818 4819

Represents a vulnerability scanner.

4820 4821
| Field | Type | Description |
| ----- | ---- | ----------- |
4822 4823 4824 4825
| `externalId` | String | External ID of the vulnerability scanner. |
| `name` | String | Name of the vulnerability scanner. |
| `reportType` | VulnerabilityReportType | Type of the vulnerability report. |
| `vendor` | String | Vendor of the vulnerability scanner. |
4826

4827
### VulnerabilitySeveritiesCount
Avielle Wolfe's avatar
Avielle Wolfe committed
4828

4829
Represents vulnerability counts by severity.
Avielle Wolfe's avatar
Avielle Wolfe committed
4830

4831 4832
| Field | Type | Description |
| ----- | ---- | ----------- |
Avielle Wolfe's avatar
Avielle Wolfe committed
4833 4834 4835 4836 4837 4838
| `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 |
4839

4840
### VulnerableDependency
4841

4842
Represents a vulnerable dependency. Used in vulnerability location data.
4843

4844 4845
| Field | Type | Description |
| ----- | ---- | ----------- |
4846 4847
| `package` | VulnerablePackage | The package associated with the vulnerable dependency. |
| `version` | String | The version of the vulnerable dependency. |
4848

4849
### VulnerablePackage
4850

4851
Represents a vulnerable package. Used in vulnerability dependency data.
4852

4853 4854
| Field | Type | Description |
| ----- | ---- | ----------- |
4855
| `name` | String | The name of the vulnerable package. |
4856

4857
### VulnerableProjectsByGrade
4858

4859
Represents vulnerability letter grades with associated projects.
4860

4861 4862
| Field | Type | Description |
| ----- | ---- | ----------- |
4863 4864 4865
| `count` | Int! | Number of projects within this grade. |
| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present. |
| `projects` | ProjectConnection! | Projects within this grade. |
4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877

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

4878
Access level to a resource.
4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890

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

### AlertManagementAlertSort

4891
Values for sorting alerts.
4892 4893 4894

| Value | Description |
| ----- | ----------- |
4895 4896
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908
| `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 |
4909 4910
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
4911 4912
| `UPDATED_TIME_ASC` | Created time by ascending order |
| `UPDATED_TIME_DESC` | Created time by descending order |
4913 4914 4915 4916
| `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. |
4917

4918 4919 4920 4921 4922 4923
### AlertManagementDomainFilter

Filters the alerts based on given domain.

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

Sarah Yasonik's avatar
Sarah Yasonik committed
4927 4928 4929 4930 4931 4932 4933 4934 4935
### AlertManagementIntegrationType

Values of types of integrations.

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

4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962
### AlertManagementPayloadAlertFieldName

Values for alert field names used in the custom mapping.

| Value | Description |
| ----- | ----------- |
| `DESCRIPTION` | A high-level summary of the problem. |
| `END_TIME` | The resolved time of the incident. |
| `FINGERPRINT` | The unique identifier of the alert. This can be used to group occurrences of the same alert. |
| `GITLAB_ENVIRONMENT_NAME` | The name of the associated GitLab environment. |
| `HOSTS` | One or more hosts, as to where this incident occurred. |
| `MONITORING_TOOL` | The name of the associated monitoring tool. |
| `SERVICE` | The affected service. |
| `SEVERITY` | The severity of the alert. |
| `START_TIME` | The time of the incident. |
| `TITLE` | The title of the incident. |

### AlertManagementPayloadAlertFieldType

Values for alert field types used in the custom mapping.

| Value | Description |
| ----- | ----------- |
| `ARRAY` | Array field type |
| `DATETIME` | DateTime field type |
| `STRING` | String field type |

4963 4964
### AlertManagementSeverity

4965
Alert severity values.
4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977

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

### AlertManagementStatus

4978
Alert status values.
4979 4980 4981 4982 4983 4984 4985 4986

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

4987 4988 4989 4990 4991 4992 4993 4994 4995
### ApiFuzzingScanMode

All possible ways to specify the API surface for an API fuzzing scan.

| Value | Description |
| ----- | ----------- |
| `HAR` | The API surface is specified by a HAR file. |
| `OPENAPI` | The API surface is specified by a OPENAPI file. |

4996 4997 4998 4999 5000 5001
### AvailabilityEnum

User availability status.

| Value | Description |
| ----- | ----------- |
5002 5003
| `BUSY` | Busy |
| `NOT_SET` | Not Set |
5004

5005 5006
### BlobViewersType

5007
Types of blob viewers.
5008 5009 5010 5011 5012 5013 5014

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

lauraMon's avatar
lauraMon committed
5015 5016 5017 5018 5019 5020
### CiConfigStatus

Values for YAML processor result.

| Value | Description |
| ----- | ----------- |
5021 5022
| `INVALID` | The configuration file is not valid |
| `VALID` | The configuration file is valid |
lauraMon's avatar
lauraMon committed
5023

5024 5025
### CommitActionMode

5026
Mode of a commit action.
5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072

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

5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083
### 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. |

5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100
### ContainerRepositorySort

Values for sorting container repositories.

| Value | Description |
| ----- | ----------- |
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
| `NAME_ASC` | Name by ascending order |
| `NAME_DESC` | Name by descending order |
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
| `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. |

5101 5102 5103 5104 5105 5106 5107 5108 5109
### ContainerRepositoryStatus

Status of a container repository.

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

5110 5111 5112 5113
### DastScanTypeEnum

| Value | Description |
| ----- | ----------- |
5114
| `ACTIVE` | Active DAST scan. This scan will make active attacks against the target site. |
5115 5116 5117 5118 5119 5120 5121 5122
| `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 |
5123
| `NONE` | No site validation exists |
5124 5125 5126
| `PASSED_VALIDATION` | Site validation process finished successfully |
| `PENDING_VALIDATION` | Site validation process has not started |

5127 5128 5129 5130 5131 5132 5133
### DastSiteValidationStrategyEnum

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

5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163
### 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 |

5164 5165 5166 5167 5168 5169 5170 5171 5172 5173
### 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 |

5174 5175
### DesignVersionEvent

5176
Mutation event of a design within a version.
5177 5178 5179 5180 5181 5182 5183 5184 5185 5186

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

### DiffPositionType

5187
Type of file the position refers to.
5188 5189 5190 5191 5192 5193 5194 5195

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

### EntryType

5196
Type of a tree entry.
5197 5198 5199 5200 5201 5202 5203 5204 5205

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

### EpicSort

5206
Roadmap sort values.
5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226

| 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

5227
State event of an epic.
5228 5229 5230 5231 5232 5233 5234 5235

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

### EpicWildcardId

5236
Epic ID wildcard values.
5237 5238 5239 5240 5241 5242

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

5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262
### EventAction

Event action.

| Value | Description |
| ----- | ----------- |
| `APPROVED` | Approved action |
| `ARCHIVED` | Archived action |
| `CLOSED` | Closed action |
| `COMMENTED` | Commented action |
| `CREATED` | Created action |
| `DESTROYED` | Destroyed action |
| `EXPIRED` | Expired action |
| `JOINED` | Joined action |
| `LEFT` | Left action |
| `MERGED` | Merged action |
| `PUSHED` | Pushed action |
| `REOPENED` | Reopened action |
| `UPDATED` | Updated action |

5263 5264 5265 5266 5267 5268 5269 5270 5271 5272
### GroupMemberRelation

Group member relation.

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

5273 5274
### HealthStatus

5275
Health status of an issue or epic.
5276 5277 5278 5279 5280 5281 5282 5283 5284

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

### IssuableSeverity

5285
Incident severity.
5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296

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

### IssuableState

5297
State of a GitLab issue or merge request.
5298 5299 5300 5301 5302 5303 5304 5305 5306 5307

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

### IssueSort

5308
Values for sorting issues.
5309 5310 5311

| Value | Description |
| ----- | ----------- |
5312 5313
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
5314 5315 5316 5317 5318 5319 5320 5321
| `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 |
5322 5323
| `PUBLISHED_ASC` | Published issues shown last |
| `PUBLISHED_DESC` | Published issues shown first |
5324
| `RELATIVE_POSITION_ASC` | Relative position by ascending order |
5325 5326
| `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
5327 5328
| `SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first |
| `SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first |
5329 5330
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
5331 5332
| `WEIGHT_ASC` | Weight by ascending order |
| `WEIGHT_DESC` | Weight by descending order |
5333 5334 5335 5336
| `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. |
5337 5338 5339

### IssueState

5340
State of a GitLab issue.
5341 5342 5343 5344 5345 5346 5347 5348

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

5349 5350 5351 5352 5353 5354 5355 5356 5357
### IssueStateEvent

Values for issue state events.

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

5358 5359
### IssueType

5360
Issue type.
5361 5362 5363 5364 5365 5366 5367 5368 5369

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

### IterationState

5370
State of a GitLab iteration.
5371 5372 5373 5374 5375 5376 5377 5378 5379

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

5380 5381 5382 5383 5384 5385 5386
### IterationWildcardId

Iteration ID wildcard values.

| Value | Description |
| ----- | ----------- |
| `ANY` | An iteration is assigned |
5387
| `CURRENT` | Current iteration |
5388 5389
| `NONE` | No iteration is assigned |

5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421
### 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` |  |

5422 5423
### ListLimitMetric

5424
List limit metric setting.
5425 5426 5427 5428 5429 5430 5431 5432 5433

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

### MeasurementIdentifier

5434
Possible identifier types for a measurement.
5435 5436 5437 5438 5439 5440 5441

| Value | Description |
| ----- | ----------- |
| `GROUPS` | Group count |
| `ISSUES` | Issue count |
| `MERGE_REQUESTS` | Merge request count |
| `PIPELINES` | Pipeline count |
5442 5443 5444 5445
| `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 |
5446 5447 5448
| `PROJECTS` | Project count |
| `USERS` | User count |

5449 5450
### MergeRequestNewState

5451
New state to apply to a merge request.
5452 5453 5454 5455 5456 5457

| Value | Description |
| ----- | ----------- |
| `CLOSED` | Close the merge request if it is open. |
| `OPEN` | Open the merge request if it is closed. |

5458 5459
### MergeRequestSort

5460
Values for sorting merge requests.
5461 5462 5463

| Value | Description |
| ----- | ----------- |
5464 5465
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
5466 5467 5468 5469 5470 5471 5472 5473
| `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 |
5474 5475
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
5476 5477 5478 5479
| `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. |
5480 5481 5482

### MergeRequestState

5483
State of a GitLab merge request.
5484 5485 5486 5487 5488 5489

| Value | Description |
| ----- | ----------- |
| `all` |  |
| `closed` |  |
| `locked` |  |
5490
| `merged` | Merge Request has been merged |
5491 5492 5493 5494
| `opened` |  |

### MilestoneStateEnum

5495 5496
Current state of milestone.

5497 5498
| Value | Description |
| ----- | ----------- |
5499 5500
| `active` | Milestone is currently active |
| `closed` | Milestone is closed |
5501 5502 5503

### MoveType

5504
The position to which the adjacent object should be moved.
5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522

| 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

5523
Values for sorting projects.
5524 5525 5526 5527

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

5530 5531 5532 5533 5534 5535
### OncallRotationUnitEnum

Rotation length unit of an on-call rotation.

| Value | Description |
| ----- | ----------- |
5536 5537 5538
| `DAYS` | Days |
| `HOURS` | Hours |
| `WEEKS` | Weeks |
5539

5540 5541 5542 5543
### PackageTypeEnum

| Value | Description |
| ----- | ----------- |
ggelatti's avatar
ggelatti committed
5544 5545 5546 5547 5548 5549
| `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 |
5550
| `NPM` | Packages from the npm package manager |
ggelatti's avatar
ggelatti committed
5551
| `NUGET` | Packages from the Nuget package manager |
5552
| `PYPI` | Packages from the PyPI package manager |
5553
| `RUBYGEMS` | Packages from the Rubygems package manager |
5554 5555 5556 5557 5558 5559 5560

### PipelineConfigSourceEnum

| Value | Description |
| ----- | ----------- |
| `AUTO_DEVOPS_SOURCE` |  |
| `BRIDGE_SOURCE` |  |
5561
| `COMPLIANCE_SOURCE` |  |
5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584
| `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` |  |

5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595
### ProjectMemberRelation

Project member relation.

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

5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608
### 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

5609
Type of the link: `other`, `runbook`, `image`, `package`.
5610 5611 5612 5613 5614 5615 5616 5617

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

5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628
### 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 |

5629 5630
### RequirementState

5631
State of a requirement.
5632 5633 5634 5635 5636 5637 5638 5639

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

### SastUiComponentSize

5640
Size of UI component in SAST configuration page.
5641 5642 5643

| Value | Description |
| ----- | ----------- |
5644 5645 5646
| `LARGE` | The size of UI component in SAST configuration page is large. |
| `MEDIUM` | The size of UI component in SAST configuration page is medium. |
| `SMALL` | The size of UI component in SAST configuration page is small. |
5647

5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659
### 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 |

5660 5661 5662 5663 5664 5665
### SecurityScannerType

The type of the security scanner.

| Value | Description |
| ----- | ----------- |
5666
| `API_FUZZING` |  |
5667 5668 5669 5670 5671 5672 5673 5674 5675
| `CONTAINER_SCANNING` |  |
| `COVERAGE_FUZZING` |  |
| `DAST` |  |
| `DEPENDENCY_SCANNING` |  |
| `SAST` |  |
| `SECRET_DETECTION` |  |

### SentryErrorStatus

5676
State of a Sentry error.
5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688

| 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 |
| ----- | ----------- |
5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724
| `ASANA_SERVICE` | AsanaService type |
| `ASSEMBLA_SERVICE` | AssemblaService type |
| `BAMBOO_SERVICE` | BambooService type |
| `BUGZILLA_SERVICE` | BugzillaService type |
| `BUILDKITE_SERVICE` | BuildkiteService type |
| `CAMPFIRE_SERVICE` | CampfireService type |
| `CONFLUENCE_SERVICE` | ConfluenceService type |
| `CUSTOM_ISSUE_TRACKER_SERVICE` | CustomIssueTrackerService type |
| `DATADOG_SERVICE` | DatadogService type |
| `DISCORD_SERVICE` | DiscordService type |
| `DRONE_CI_SERVICE` | DroneCiService type |
| `EMAILS_ON_PUSH_SERVICE` | EmailsOnPushService type |
| `EWM_SERVICE` | EwmService type |
| `EXTERNAL_WIKI_SERVICE` | ExternalWikiService type |
| `FLOWDOCK_SERVICE` | FlowdockService type |
| `GITHUB_SERVICE` | GithubService type |
| `HANGOUTS_CHAT_SERVICE` | HangoutsChatService type |
| `HIPCHAT_SERVICE` | HipchatService type |
| `IRKER_SERVICE` | IrkerService type |
| `JENKINS_SERVICE` | JenkinsService type |
| `JIRA_SERVICE` | JiraService type |
| `MATTERMOST_SERVICE` | MattermostService type |
| `MATTERMOST_SLASH_COMMANDS_SERVICE` | MattermostSlashCommandsService type |
| `MICROSOFT_TEAMS_SERVICE` | MicrosoftTeamsService type |
| `PACKAGIST_SERVICE` | PackagistService type |
| `PIPELINES_EMAIL_SERVICE` | PipelinesEmailService type |
| `PIVOTALTRACKER_SERVICE` | PivotaltrackerService type |
| `PROMETHEUS_SERVICE` | PrometheusService type |
| `PUSHOVER_SERVICE` | PushoverService type |
| `REDMINE_SERVICE` | RedmineService type |
| `SLACK_SERVICE` | SlackService type |
| `SLACK_SLASH_COMMANDS_SERVICE` | SlackSlashCommandsService type |
| `TEAMCITY_SERVICE` | TeamcityService type |
| `UNIFY_CIRCUIT_SERVICE` | UnifyCircuitService type |
| `WEBEX_TEAMS_SERVICE` | WebexTeamsService type |
| `YOUTRACK_SERVICE` | YoutrackService type |
5725 5726 5727

### SnippetBlobActionEnum

5728
Type of a snippet blob input action.
5729 5730 5731 5732 5733 5734 5735 5736 5737 5738

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

### Sort

5739
Common sort values.
5740 5741 5742

| Value | Description |
| ----- | ----------- |
5743 5744 5745 5746
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
5747 5748 5749 5750
| `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. |
5751 5752 5753

### TestReportState

5754
State of a test report.
5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776

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

### TodoActionEnum

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

### TodoStateEnum

| Value | Description |
| ----- | ----------- |
5777 5778
| `done` | The state of the todo is done. |
| `pending` | The state of the todo is pending. |
5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799

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

5800
Possible states of a user.
5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823

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

5824 5825 5826 5827 5828 5829
### VulnerabilityDismissalReason

The dismissal reason of the Vulnerability.

| Value | Description |
| ----- | ----------- |
5830 5831 5832 5833 5834
| `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 |
5835

5836 5837 5838 5839 5840 5841 5842 5843
### VulnerabilityExternalIssueLinkExternalTracker

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

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

5844 5845 5846 5847 5848 5849 5850 5851
### VulnerabilityExternalIssueLinkType

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

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

5852 5853
### VulnerabilityGrade

5854
The grade of the vulnerable project.
5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878

| 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 |
| ----- | ----------- |
5879
| `API_FUZZING` |  |
5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901
| `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

5902
Vulnerability sort values.
5903 5904 5905

| Value | Description |
| ----- | ----------- |
5906 5907
| `detected_asc` | Detection timestamp in ascending order |
| `detected_desc` | Detection timestamp in descending order |
5908 5909
| `report_type_asc` | Report Type in ascending order |
| `report_type_desc` | Report Type in descending order |
5910 5911
| `severity_asc` | Severity in ascending order |
| `severity_desc` | Severity in descending order |
5912 5913
| `state_asc` | State in ascending order |
| `state_desc` | State in descending order |
5914 5915
| `title_asc` | Title in ascending order |
| `title_desc` | Title in descending order |
5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926

### VulnerabilityState

The state of the vulnerability.

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