index.md 251 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. |
charlie ablett's avatar
charlie ablett committed
672
| `collapsed` | Boolean | Indicates if the list is collapsed for this user. |
673 674 675
| `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
| `artifacts` | CiJobArtifactConnection | Artifacts generated by the job. |
| `detailedStatus` | DetailedStatus | Detailed status of the job. |
816 817
| `duration` | Int | Duration of the job in seconds. |
| `finishedAt` | Time | When a job has finished running. |
818 819 820 821
| `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
822

823 824 825 826
### CiJobArtifact

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

830
### CiStage
Laura Montemayor's avatar
Laura Montemayor committed
831

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

838
### ClusterAgent
839

840 841
| Field | Type | Description |
| ----- | ---- | ----------- |
842
| `createdAt` | Time | Timestamp the cluster agent was created. |
843
| `createdByUser` | User | User object, containing information about the person who created the agent. |
844 845 846 847 848
| `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. |
849

850
### ClusterAgentDeletePayload
851

852
Autogenerated return type of ClusterAgentDelete.
853

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

859
### ClusterAgentToken
860

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

870
### ClusterAgentTokenCreatePayload
871

872
Autogenerated return type of ClusterAgentTokenCreate.
873

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

881
### ClusterAgentTokenDeletePayload
882

883
Autogenerated return type of ClusterAgentTokenDelete.
884

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

890 891 892 893 894 895 896 897 898 899 900
### 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. |

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

911
### Commit
Felipe Artur's avatar
Felipe Artur committed
912

913 914
| Field | Type | Description |
| ----- | ---- | ----------- |
915 916 917 918 919
| `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. |
920
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
921 922 923 924 925 926 927
| `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. |
928
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
929 930
| `webPath` | String! | Web path of the commit. |
| `webUrl` | String! | Web URL of the commit. |
Felipe Artur's avatar
Felipe Artur committed
931

932
### CommitCreatePayload
933

934
Autogenerated return type of CommitCreate.
935

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

942
### ComplianceFramework
943

944
Represents a ComplianceFramework associated with a Project.
945

946 947
| Field | Type | Description |
| ----- | ---- | ----------- |
948 949 950 951
| `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. |
952
| `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hipaa` **(ULTIMATE)**. |
953

954 955 956 957 958 959 960 961 962
### ComposerMetadata

Composer metadata.

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

963
### ConfigureSastPayload
964

965
Autogenerated return type of ConfigureSast.
966

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

974
### ContainerExpirationPolicy
975

976
A tag expiration policy designed to keep only the images that matter most.
977

978 979
| Field | Type | Description |
| ----- | ---- | ----------- |
980 981 982 983 984 985 986 987 988
| `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. |
989

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

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

1045
### CreateAlertIssuePayload
1046

1047
Autogenerated return type of CreateAlertIssue.
1048

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

1057
### CreateAnnotationPayload
1058

1059
Autogenerated return type of CreateAnnotation.
1060

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

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
### 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. |

1077
### CreateBranchPayload
1078

1079
Autogenerated return type of CreateBranch.
1080

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

1087
### CreateClusterAgentPayload
1088

1089
Autogenerated return type of CreateClusterAgent.
1090

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

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
### 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. |

1107 1108 1109 1110 1111 1112 1113
### CreateCustomEmojiPayload

Autogenerated return type of CreateCustomEmoji.

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

1117 1118 1119 1120 1121 1122 1123 1124
### 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. |
1125
| `segment` | DevopsAdoptionSegment | The segment after mutation. |
1126

1127
### CreateDiffNotePayload
1128

1129
Autogenerated return type of CreateDiffNote.
1130

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

1137
### CreateEpicPayload
1138

1139
Autogenerated return type of CreateEpic.
1140

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

1147
### CreateImageDiffNotePayload
1148

1149
Autogenerated return type of CreateImageDiffNote.
1150

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

1157 1158 1159 1160 1161 1162 1163 1164
### 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. |
1165
| `issue` | Issue | The issue after mutation. |
1166

1167
### CreateIterationPayload
1168

1169
Autogenerated return type of CreateIteration.
1170

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

1177
### CreateNotePayload
1178

1179
Autogenerated return type of CreateNote.
1180

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

1187
### CreateRequirementPayload
Jan Provaznik's avatar
Jan Provaznik committed
1188

1189
Autogenerated return type of CreateRequirement.
Jan Provaznik's avatar
Jan Provaznik committed
1190

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

1197
### CreateSnippetPayload
1198

1199
Autogenerated return type of CreateSnippet.
1200

1201 1202
| Field | Type | Description |
| ----- | ---- | ----------- |
1203
| `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. |
1204
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
1205
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
1206
| `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. |
1207
| `snippet` | Snippet | The snippet after mutation. |
1208 1209
| `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. |
1210

1211 1212
### CreateTestCasePayload

1213
Autogenerated return type of CreateTestCase.
1214 1215 1216 1217 1218

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

1221 1222 1223 1224 1225 1226
### CustomEmoji

A custom emoji uploaded by user.

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

1232
### DastOnDemandScanCreatePayload
1233

1234
Autogenerated return type of DastOnDemandScanCreate.
1235

1236 1237
| Field | Type | Description |
| ----- | ---- | ----------- |
1238 1239 1240 1241
| `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. |

1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
### 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. |

1255 1256 1257 1258 1259 1260 1261 1262 1263
### 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. |
1264
| `pipelineUrl` | String | The URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`. |
1265

1266 1267 1268 1269 1270 1271 1272 1273 1274
### 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. |

1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
### 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. |

1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
### 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. |

1296
### DastScannerProfile
1297 1298 1299

Represents a DAST scanner profile.

1300 1301
| Field | Type | Description |
| ----- | ---- | ----------- |
1302
| `editPath` | String | Relative web path to the edit page of a scanner profile. |
1303
| `globalId` **{warning-solid}** | DastScannerProfileID! | **Deprecated:** Use `id`. Deprecated in 13.6. |
1304 1305
| `id` | DastScannerProfileID! | ID of the DAST scanner profile. |
| `profileName` | String | Name of the DAST scanner profile. |
1306 1307
| `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. |
1308 1309
| `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. |
1310
| `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. |
1311

1312
### DastScannerProfileCreatePayload
1313

1314
Autogenerated return type of DastScannerProfileCreate.
1315

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

1323
### DastScannerProfileDeletePayload
1324

1325
Autogenerated return type of DastScannerProfileDelete.
1326

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

1332
### DastScannerProfileUpdatePayload
1333

1334
Autogenerated return type of DastScannerProfileUpdate.
1335

1336 1337
| Field | Type | Description |
| ----- | ---- | ----------- |
1338 1339 1340 1341
| `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. |

1342
### DastSiteProfile
1343 1344 1345

Represents a DAST Site Profile.

1346 1347
| Field | Type | Description |
| ----- | ---- | ----------- |
1348 1349 1350 1351 1352
| `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. |
1353
| `userPermissions` | DastSiteProfilePermissions! | Permissions for the current user on the resource |
1354
| `validationStatus` | DastSiteProfileValidationStatusEnum | The current validation status of the site profile. |
1355

1356
### DastSiteProfileCreatePayload
1357

1358
Autogenerated return type of DastSiteProfileCreate.
1359

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

1366
### DastSiteProfileDeletePayload
1367

1368
Autogenerated return type of DastSiteProfileDelete.
1369

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

1375
### DastSiteProfilePermissions
1376

1377
Check permissions for the current user on site profile.
1378

1379 1380
| Field | Type | Description |
| ----- | ---- | ----------- |
1381 1382
| `createOnDemandDastScan` | Boolean! | Indicates the user can perform `create_on_demand_dast_scan` on this resource |

1383
### DastSiteProfileUpdatePayload
1384

1385
Autogenerated return type of DastSiteProfileUpdate.
1386

1387 1388
| Field | Type | Description |
| ----- | ---- | ----------- |
1389 1390 1391 1392
| `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. |

1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
### 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. |

1405 1406 1407 1408 1409 1410
### DastSiteValidation

Represents a DAST Site Validation.

| Field | Type | Description |
| ----- | ---- | ----------- |
1411 1412 1413
| `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. |
1414

1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
### 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. |

1426 1427 1428 1429 1430 1431 1432 1433 1434
### 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. |

1435
### DeleteAnnotationPayload
1436

1437
Autogenerated return type of DeleteAnnotation.
1438

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

1444 1445 1446 1447 1448 1449 1450 1451 1452
### 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. |

1453
### DeleteJobsResponse
1454 1455 1456

The response from the AdminSidekiqQueuesDeleteJobs mutation.

1457 1458
| Field | Type | Description |
| ----- | ---- | ----------- |
1459 1460 1461
| `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. |
1462

1463
### Design
1464

1465
A single design.
1466

1467 1468
| Field | Type | Description |
| ----- | ---- | ----------- |
1469
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
1470
| `diffRefs` | DiffRefs! | The diff refs for this design. |
1471
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
1472 1473 1474 1475 1476
| `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. |
1477
| `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 |
1478
| `issue` | Issue! | The issue the design belongs to. |
1479
| `notes` | NoteConnection! | All notes on this noteable. |
1480 1481 1482
| `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. |
1483

1484
### DesignAtVersion
1485 1486 1487

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

1488 1489
| Field | Type | Description |
| ----- | ---- | ----------- |
1490 1491 1492 1493 1494 1495 1496
| `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. |
1497
| `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 |
1498 1499 1500 1501
| `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. |
1502

1503
### DesignCollection
1504 1505

A collection of designs.
1506

1507 1508
| Field | Type | Description |
| ----- | ---- | ----------- |
1509 1510 1511 1512 1513 1514 1515 1516
| `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. |
1517

1518
### DesignManagement
1519

1520 1521
| Field | Type | Description |
| ----- | ---- | ----------- |
1522 1523
| `designAtVersion` | DesignAtVersion | Find a design as of a version. |
| `version` | DesignVersion | Find a version. |
1524

1525
### DesignManagementDeletePayload
1526

1527
Autogenerated return type of DesignManagementDelete.
1528

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

1535
### DesignManagementMovePayload
1536

1537
Autogenerated return type of DesignManagementMove.
1538

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

1545
### DesignManagementUploadPayload
1546

1547
Autogenerated return type of DesignManagementUpload.
1548

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

1556
### DesignVersion
1557

1558
A specific version in which designs were added, modified or deleted.
1559

1560 1561
| Field | Type | Description |
| ----- | ---- | ----------- |
1562 1563 1564 1565 1566
| `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. |
1567

1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
### 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. |

1578 1579
### DestroyBoardPayload

1580
Autogenerated return type of DestroyBoard.
1581 1582 1583

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

1588 1589 1590 1591 1592 1593 1594 1595 1596
### 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. |

1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
### 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. |

1607 1608 1609 1610 1611 1612 1613
### DestroyContainerRepositoryTagsPayload

Autogenerated return type of DestroyContainerRepositoryTags.

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

1617
### DestroyNotePayload
1618

1619
Autogenerated return type of DestroyNote.
1620

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

1627
### DestroySnippetPayload
1628

1629
Autogenerated return type of DestroySnippet.
1630

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

1637
### DetailedStatus
Felipe Artur's avatar
Felipe Artur committed
1638

1639 1640
| Field | Type | Description |
| ----- | ---- | ----------- |
1641 1642 1643 1644 1645 1646 1647 1648 1649
| `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
1650

1651 1652 1653 1654 1655 1656
### DevopsAdoptionSegment

Segment.

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

1661 1662 1663 1664 1665 1666
### DevopsAdoptionSnapshot

Snapshot.

| Field | Type | Description |
| ----- | ---- | ----------- |
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
| `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. |
1677

1678
### DiffPosition
Felipe Artur's avatar
Felipe Artur committed
1679

1680 1681
| Field | Type | Description |
| ----- | ---- | ----------- |
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
| `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
1693

1694
### DiffRefs
1695

1696 1697
| Field | Type | Description |
| ----- | ---- | ----------- |
1698 1699 1700
| `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. |
1701

1702
### DiffStats
1703

1704
Changes to a single file.
1705

1706 1707
| Field | Type | Description |
| ----- | ---- | ----------- |
1708 1709 1710
| `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. |
1711

1712
### DiffStatsSummary
1713

1714
Aggregated summary of changes.
1715

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

1723
### Discussion
Felipe Artur's avatar
Felipe Artur committed
1724

1725 1726
| Field | Type | Description |
| ----- | ---- | ----------- |
1727 1728 1729 1730 1731 1732 1733 1734
| `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. |
1735

1736
### DiscussionToggleResolvePayload
1737

1738
Autogenerated return type of DiscussionToggleResolve.
1739

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

1746
### DismissVulnerabilityPayload
1747

1748
Autogenerated return type of DismissVulnerability.
1749

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

1756
### Environment
1757

1758
Describes where code is deployed for a project.
1759

1760 1761
| Field | Type | Description |
| ----- | ---- | ----------- |
1762 1763 1764 1765
| `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. |
1766
| `path` | String! | The path to the environment. |
1767
| `state` | String! | State of the environment, for example: available/stopped. |
1768

1769 1770 1771 1772 1773 1774 1775 1776 1777
### 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. |

1778
### Epic
1779 1780

Represents an epic.
1781

1782 1783
| Field | Type | Description |
| ----- | ---- | ----------- |
1784 1785 1786 1787 1788 1789
| `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. |
1790
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
1791 1792 1793
| `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. |
1794
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
1795 1796 1797 1798 1799
| `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. |
1800
| `events` | EventConnection | A list of events associated with the object. |
1801 1802 1803 1804 1805 1806 1807 1808 1809
| `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. |
1810
| `notes` | NoteConnection! | All notes on this noteable. |
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826
| `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. |
1827
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
1828 1829
| `webPath` | String! | Web path of the epic. |
| `webUrl` | String! | Web URL of the epic. |
1830

1831
### EpicAddIssuePayload
1832

1833
Autogenerated return type of EpicAddIssue.
1834

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

1842 1843 1844 1845 1846 1847
### EpicBoard

Represents an epic board.

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

charlie ablett's avatar
charlie ablett committed
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865
### 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. |

1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
### 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. |

1876
### EpicDescendantCount
1877 1878

Counts of descendent epics.
1879

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

1887
### EpicDescendantWeights
1888

1889
Total weight of open and closed descendant issues.
1890

1891 1892
| Field | Type | Description |
| ----- | ---- | ----------- |
1893 1894
| `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. |
1895

1896
### EpicHealthStatus
1897

1898
Health status of child issues.
1899

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

1906
### EpicIssue
1907

1908
Relationship between an epic and an issue.
1909

1910 1911
| Field | Type | Description |
| ----- | ---- | ----------- |
1912 1913 1914
| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue. |
| `assignees` | UserConnection | Assignees of the issue. |
| `author` | User! | User that created the issue. |
1915 1916
| `blocked` | Boolean! | Indicates the issue is blocked. |
| `blockedByCount` | Int | Count of issues blocking this issue. |
1917
| `blockedByIssues` | IssueConnection | Issues blocking this issue. |
1918 1919 1920 1921
| `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. |
1922
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
1923
| `description` | String | Description of the issue. |
1924
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
1925 1926 1927 1928 1929 1930
| `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. |
1931
| `epic` | Epic | Epic to which this issue belongs. |
1932
| `epicIssueId` | ID! | ID of the epic-issue relation. |
1933
| `healthStatus` | HealthStatus | Current health status. |
1934 1935
| `humanTimeEstimate` | String | Human-readable time estimate of the issue. |
| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue. |
1936
| `id` | ID | Global ID of the epic-issue relation. |
1937
| `iid` | ID! | Internal ID of the issue. |
1938
| `iteration` | Iteration | Iteration of the issue. |
1939
| `labels` | LabelConnection | Labels of the issue. |
1940
| `metricImages` | MetricImage! => Array | Metric images associated to the issue. |
1941 1942 1943 1944 1945 1946
| `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. |
1947
| `relationPath` | String | URI path of the epic-issue relation. |
1948 1949
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards). |
| `severity` | IssuableSeverity | Severity level of the incident. |
1950
| `slaDueAt` | Time | Timestamp of when the issue SLA expires. |
1951
| `state` | IssueState! | State of the issue. |
1952
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page. |
1953 1954 1955 1956
| `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. |
1957
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
1958 1959 1960 1961 1962 1963 1964
| `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. |
1965
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
1966 1967
| `webPath` | String! | Web path of the issue. |
| `webUrl` | String! | Web URL of the issue. |
1968
| `weight` | Int | Weight of the issue. |
1969

Jan Provaznik's avatar
Jan Provaznik committed
1970 1971 1972 1973 1974 1975
### EpicList

Represents an epic board list.

| Field | Type | Description |
| ----- | ---- | ----------- |
charlie ablett's avatar
charlie ablett committed
1976
| `collapsed` | Boolean | Indicates if this list is collapsed for this user. |
Jan Provaznik's avatar
Jan Provaznik committed
1977
| `epics` | EpicConnection | List epics. |
1978
| `epicsCount` | Int | Count of epics in the list. |
Jan Provaznik's avatar
Jan Provaznik committed
1979 1980 1981 1982 1983 1984
| `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. |

1985
### EpicPermissions
1986

1987
Check permissions for the current user on an epic.
1988

1989 1990
| Field | Type | Description |
| ----- | ---- | ----------- |
1991
| `adminEpic` | Boolean! | Indicates the user can perform `admin_epic` on this resource |
1992
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
1993 1994
| `createEpic` | Boolean! | Indicates the user can perform `create_epic` on this resource |
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
1995 1996 1997 1998
| `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 |
1999

2000
### EpicSetSubscriptionPayload
2001

2002
Autogenerated return type of EpicSetSubscription.
2003

2004 2005
| Field | Type | Description |
| ----- | ---- | ----------- |
2006
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2007
| `epic` | Epic | The epic after mutation. |
2008
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2009

2010
### EpicTreeReorderPayload
2011

2012
Autogenerated return type of EpicTreeReorder.
2013

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

2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030
### 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. |

2031 2032 2033 2034 2035 2036 2037 2038
### 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. |
2039

2040 2041 2042 2043 2044 2045
### ExternalIssue

Represents an external issue.

| Field | Type | Description |
| ----- | ---- | ----------- |
2046 2047 2048 2049 2050 2051 2052
| `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. |
2053

2054
### GeoNode
2055

2056 2057
| Field | Type | Description |
| ----- | ---- | ----------- |
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076
| `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. |
2077

2078 2079 2080 2081 2082 2083 2084 2085 2086
### 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. |

2087
### GrafanaIntegration
2088

2089 2090
| Field | Type | Description |
| ----- | ---- | ----------- |
2091 2092 2093 2094 2095
| `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. |
2096

2097
### Group
Felipe Artur's avatar
Felipe Artur committed
2098

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

2164
### GroupMember
2165

2166
Represents a Group Membership.
2167

2168 2169
| Field | Type | Description |
| ----- | ---- | ----------- |
2170 2171 2172 2173
| `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. |
2174
| `group` | Group | Group that a User is a member of. |
2175 2176 2177
| `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. |
2178 2179
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |

2180
### GroupPermissions
Felipe Artur's avatar
Felipe Artur committed
2181

2182 2183
| Field | Type | Description |
| ----- | ---- | ----------- |
2184
| `readGroup` | Boolean! | Indicates the user can perform `read_group` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2185

2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200
### 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 |
| ----- | ---- | ----------- |
2201
| `releaseStats` | GroupReleaseStats | Statistics related to releases within the group. |
2202

2203 2204 2205 2206 2207 2208 2209 2210
### 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. |
2211
| `integration` | AlertManagementHttpIntegration | The HTTP integration. |
2212 2213 2214 2215 2216 2217 2218 2219 2220

### 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. |
2221
| `integration` | AlertManagementHttpIntegration | The HTTP integration. |
2222 2223 2224 2225 2226 2227 2228 2229 2230

### 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. |
2231
| `integration` | AlertManagementHttpIntegration | The HTTP integration. |
2232 2233 2234 2235 2236 2237 2238 2239 2240

### 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. |
2241
| `integration` | AlertManagementHttpIntegration | The HTTP integration. |
2242

2243 2244 2245 2246 2247 2248
### IncidentManagementOncallRotation

Describes an incident management on-call rotation.

| Field | Type | Description |
| ----- | ---- | ----------- |
2249
| `activePeriod` | OncallRotationActivePeriodType | Active period for the on-call rotation. |
2250
| `endsAt` | Time | End date and time of the on-call rotation. |
2251 2252 2253 2254 2255
| `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. |
2256
| `shifts` | IncidentManagementOncallShiftConnection | Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. |
2257
| `startsAt` | Time | Start date of the on-call rotation. |
2258

2259 2260 2261 2262 2263 2264
### IncidentManagementOncallSchedule

Describes an incident management on-call schedule.

| Field | Type | Description |
| ----- | ---- | ----------- |
2265 2266 2267 2268 2269
| `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. |
2270

2271 2272
### IncidentManagementOncallShift

2273
A block of time for which a participant is on-call.
2274 2275 2276 2277 2278 2279 2280

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

2281
### InstanceSecurityDashboard
2282

2283 2284
| Field | Type | Description |
| ----- | ---- | ----------- |
2285 2286 2287 2288
| `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. |
2289

2290
### Issue
Felipe Artur's avatar
Felipe Artur committed
2291

2292 2293
| Field | Type | Description |
| ----- | ---- | ----------- |
2294 2295 2296
| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue. |
| `assignees` | UserConnection | Assignees of the issue. |
| `author` | User! | User that created the issue. |
2297 2298
| `blocked` | Boolean! | Indicates the issue is blocked. |
| `blockedByCount` | Int | Count of issues blocking this issue. |
2299
| `blockedByIssues` | IssueConnection | Issues blocking this issue. |
2300 2301 2302 2303
| `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. |
2304
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
2305
| `description` | String | Description of the issue. |
2306
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2307 2308 2309 2310 2311 2312
| `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. |
2313
| `epic` | Epic | Epic to which this issue belongs. |
2314
| `healthStatus` | HealthStatus | Current health status. |
2315 2316 2317 2318
| `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. |
2319
| `iteration` | Iteration | Iteration of the issue. |
2320
| `labels` | LabelConnection | Labels of the issue. |
2321
| `metricImages` | MetricImage! => Array | Metric images associated to the issue. |
2322 2323 2324 2325 2326 2327 2328 2329
| `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. |
2330
| `slaDueAt` | Time | Timestamp of when the issue SLA expires. |
2331
| `state` | IssueState! | State of the issue. |
2332
| `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page. |
2333 2334 2335 2336
| `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. |
2337
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
2338 2339 2340 2341 2342 2343 2344
| `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. |
2345
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
2346 2347
| `webPath` | String! | Web path of the issue. |
| `webUrl` | String! | Web URL of the issue. |
2348
| `weight` | Int | Weight of the issue. |
Felipe Artur's avatar
Felipe Artur committed
2349

2350
### IssueMoveListPayload
2351

2352
Autogenerated return type of IssueMoveList.
2353

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

Felipe Artur's avatar
Felipe Artur committed
2360 2361 2362 2363 2364 2365 2366 2367
### 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. |
2368
| `issue` | Issue | The issue after mutation. |
2369

2370
### IssuePermissions
2371

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

2374 2375
| Field | Type | Description |
| ----- | ---- | ----------- |
2376 2377
| `adminIssue` | Boolean! | Indicates the user can perform `admin_issue` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
2378
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
2379
| `destroyDesign` | Boolean! | Indicates the user can perform `destroy_design` on this resource |
2380 2381 2382 2383
| `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
2384

2385
### IssueSetAssigneesPayload
2386

2387
Autogenerated return type of IssueSetAssignees.
2388

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

2395
### IssueSetConfidentialPayload
2396

2397
Autogenerated return type of IssueSetConfidential.
2398

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

2405
### IssueSetDueDatePayload
2406

2407
Autogenerated return type of IssueSetDueDate.
2408

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

2415
### IssueSetEpicPayload
2416

2417
Autogenerated return type of IssueSetEpic.
2418

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

2425
### IssueSetIterationPayload
2426

2427
Autogenerated return type of IssueSetIteration.
2428

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

2435
### IssueSetLockedPayload
2436

2437
Autogenerated return type of IssueSetLocked.
2438

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

2445
### IssueSetSeverityPayload
2446

2447
Autogenerated return type of IssueSetSeverity.
2448

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

2455
### IssueSetSubscriptionPayload
2456

2457
Autogenerated return type of IssueSetSubscription.
2458

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

2465
### IssueSetWeightPayload
2466

2467
Autogenerated return type of IssueSetWeight.
2468

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

2475
### IssueStatusCountsType
Sean Arnold's avatar
Sean Arnold committed
2476

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

2479 2480
| Field | Type | Description |
| ----- | ---- | ----------- |
Sean Arnold's avatar
Sean Arnold committed
2481 2482 2483 2484
| `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 |

2485
### Iteration
2486 2487 2488

Represents an iteration object.

2489 2490
| Field | Type | Description |
| ----- | ---- | ----------- |
2491 2492
| `createdAt` | Time! | Timestamp of iteration creation. |
| `description` | String | Description of the iteration. |
2493
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505
| `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. |
2506

2507
### JiraImport
2508

2509 2510
| Field | Type | Description |
| ----- | ---- | ----------- |
2511 2512 2513 2514 2515 2516 2517
| `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. |
2518

2519
### JiraImportStartPayload
2520

2521
Autogenerated return type of JiraImportStart.
2522

2523 2524
| Field | Type | Description |
| ----- | ---- | ----------- |
2525
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2526
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2527
| `jiraImport` | JiraImport | The Jira import data after mutation. |
2528

2529
### JiraImportUsersPayload
2530

2531
Autogenerated return type of JiraImportUsers.
2532

2533 2534
| Field | Type | Description |
| ----- | ---- | ----------- |
2535 2536 2537 2538
| `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. |

2539
### JiraProject
2540

2541 2542
| Field | Type | Description |
| ----- | ---- | ----------- |
2543 2544 2545
| `key` | String! | Key of the Jira project. |
| `name` | String | Name of the Jira project. |
| `projectId` | Int! | ID of the Jira project. |
2546

2547
### JiraService
2548

2549 2550
| Field | Type | Description |
| ----- | ---- | ----------- |
2551 2552 2553
| `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. |
2554

2555
### JiraUser
2556

2557 2558
| Field | Type | Description |
| ----- | ---- | ----------- |
2559 2560 2561 2562 2563 2564
| `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. |
2565

2566
### Label
Felipe Artur's avatar
Felipe Artur committed
2567

2568 2569
| Field | Type | Description |
| ----- | ---- | ----------- |
2570
| `color` | String! | Background color of the label. |
2571
| `createdAt` | Time! | When this label was created. |
2572
| `description` | String | Description of the label (Markdown rendered as HTML for caching). |
Felipe Artur's avatar
Felipe Artur committed
2573
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2574 2575 2576
| `id` | ID! | Label ID. |
| `textColor` | String! | Text color of the label. |
| `title` | String! | Content of the label. |
2577
| `updatedAt` | Time! | When this label was last updated. |
Felipe Artur's avatar
Felipe Artur committed
2578

2579 2580 2581 2582 2583 2584 2585 2586
### 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. |
2587
| `label` | Label | The label after mutation. |
2588

2589
### MarkAsSpamSnippetPayload
2590

2591
Autogenerated return type of MarkAsSpamSnippet.
2592

2593 2594
| Field | Type | Description |
| ----- | ---- | ----------- |
2595
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2596
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2597
| `snippet` | Snippet | The snippet after mutation. |
2598

2599
### MergeRequest
Felipe Artur's avatar
Felipe Artur committed
2600

2601 2602
| Field | Type | Description |
| ----- | ---- | ----------- |
2603
| `allowCollaboration` | Boolean | Indicates if members of the target project can push to the fork. |
2604 2605
| `approvalsLeft` | Int | Number of approvals left. |
| `approvalsRequired` | Int | Number of approvals required. |
2606
| `approved` | Boolean! | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. |
2607 2608 2609 2610 2611 2612 2613 2614 2615 2616
| `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. |
2617
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
2618 2619 2620 2621
| `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
2622
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2623 2624 2625 2626 2627 2628
| `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. |
2629
| `divergedFromTargetBranch` | Boolean! | Indicates if the source branch is behind the target branch. |
2630 2631 2632
| `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. |
2633
| `hasSecurityReports` | Boolean! | Indicates if the source branch has any security reports. |
2634 2635 2636 2637 2638 2639 2640 2641 2642
| `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. |
2643
| `mergeTrainsCount` | Int | Number of merge requests in the merge train. |
2644 2645 2646 2647 2648 2649 2650
| `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. |
2651
| `participants` | UserConnection | Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. |
2652
| `pipelines` | PipelineConnection | Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned. |
2653 2654 2655 2656 2657
| `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. |
2658
| `reviewers` | UserConnection | Users from whom a review has been requested. |
2659
| `securityAutoFix` | Boolean | Indicates if the merge request is created by @GitLab-Security-Bot. |
2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674
| `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. |
2675
| `taskCompletionStatus` | TaskCompletionStatus! | Completion status of tasks |
2676 2677
| `timeEstimate` | Int! | Time estimate of the merge request. |
| `title` | String! | Title of the merge request. |
2678
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
2679 2680 2681 2682 2683
| `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. |
2684
| `userPermissions` | MergeRequestPermissions! | Permissions for the current user on the resource |
2685
| `webUrl` | String | Web URL of the merge request. |
2686
| `workInProgress` | Boolean! | Indicates if the merge request is a draft. |
Felipe Artur's avatar
Felipe Artur committed
2687

2688
### MergeRequestCreatePayload
2689

2690
Autogenerated return type of MergeRequestCreate.
2691

2692 2693
| Field | Type | Description |
| ----- | ---- | ----------- |
2694 2695
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2696
| `mergeRequest` | MergeRequest | The merge request after mutation. |
2697

2698 2699
### MergeRequestDiffRegistry

2700
Represents the Geo sync and verification state of a Merge Request diff.
2701 2702 2703 2704 2705 2706 2707

| 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 |
2708
| `mergeRequestDiffId` | ID! | ID of the Merge Request diff. |
2709 2710 2711 2712
| `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 |

2713
### MergeRequestPermissions
2714

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

2717 2718
| Field | Type | Description |
| ----- | ---- | ----------- |
2719
| `adminMergeRequest` | Boolean! | Indicates the user can perform `admin_merge_request` on this resource |
2720
| `canMerge` | Boolean! | Indicates the user can perform `can_merge` on this resource |
2721
| `cherryPickOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource |
2722 2723
| `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 |
2724
| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource |
2725 2726
| `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 |
2727
| `updateMergeRequest` | Boolean! | Indicates the user can perform `update_merge_request` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2728

2729 2730 2731 2732 2733 2734 2735 2736 2737 2738
### 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. |

2739
### MergeRequestSetAssigneesPayload
2740

2741
Autogenerated return type of MergeRequestSetAssignees.
2742

2743 2744
| Field | Type | Description |
| ----- | ---- | ----------- |
2745
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2746
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2747
| `mergeRequest` | MergeRequest | The merge request after mutation. |
2748

2749
### MergeRequestSetLabelsPayload
2750

2751
Autogenerated return type of MergeRequestSetLabels.
Mario de la Ossa's avatar
Mario de la Ossa committed
2752

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

2759
### MergeRequestSetLockedPayload
2760

2761
Autogenerated return type of MergeRequestSetLocked.
Mario de la Ossa's avatar
Mario de la Ossa committed
2762

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

2769
### MergeRequestSetMilestonePayload
2770

2771
Autogenerated return type of MergeRequestSetMilestone.
2772

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

2779
### MergeRequestSetSubscriptionPayload
2780

2781
Autogenerated return type of MergeRequestSetSubscription.
Mario de la Ossa's avatar
Mario de la Ossa committed
2782

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

2789
### MergeRequestSetWipPayload
2790

2791
Autogenerated return type of MergeRequestSetWip.
Felipe Artur's avatar
Felipe Artur committed
2792

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

2799
### MergeRequestUpdatePayload
2800

2801
Autogenerated return type of MergeRequestUpdate.
2802

2803 2804
| Field | Type | Description |
| ----- | ---- | ----------- |
2805
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
2806
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2807
| `mergeRequest` | MergeRequest | The merge request after mutation. |
Felipe Artur's avatar
Felipe Artur committed
2808

2809
### Metadata
Felipe Artur's avatar
Felipe Artur committed
2810

2811 2812
| Field | Type | Description |
| ----- | ---- | ----------- |
2813 2814
| `revision` | String! | Revision. |
| `version` | String! | Version. |
Felipe Artur's avatar
Felipe Artur committed
2815

2816 2817 2818 2819 2820 2821
### MetricImage

Represents a metric image upload.

| Field | Type | Description |
| ----- | ---- | ----------- |
2822 2823 2824 2825 2826
| `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. |
2827

2828
### MetricsDashboard
2829

2830 2831
| Field | Type | Description |
| ----- | ---- | ----------- |
2832 2833 2834
| `annotations` | MetricsDashboardAnnotationConnection | Annotations added to the dashboard. |
| `path` | String | Path to a file with the dashboard definition. |
| `schemaValidationWarnings` | String! => Array | Dashboard schema validation warnings. |
2835

2836
### MetricsDashboardAnnotation
2837

2838 2839
| Field | Type | Description |
| ----- | ---- | ----------- |
2840 2841 2842 2843 2844
| `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. |
2845

2846
### Milestone
Felipe Artur's avatar
Felipe Artur committed
2847

2848 2849
Represents a milestone.

2850 2851
| Field | Type | Description |
| ----- | ---- | ----------- |
2852 2853 2854 2855 2856 2857
| `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. |
2858
| `report` | TimeboxReport | Historically accurate report about the timebox. |
2859 2860 2861 2862 2863 2864 2865
| `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
2866

2867
### MilestoneStats
2868

2869
Contains statistics about a milestone.
2870

2871 2872
| Field | Type | Description |
| ----- | ---- | ----------- |
2873 2874
| `closedIssuesCount` | Int | Number of closed issues associated with the milestone. |
| `totalIssuesCount` | Int | Total number of issues associated with the milestone. |
2875

2876
### Namespace
Felipe Artur's avatar
Felipe Artur committed
2877

2878 2879
| Field | Type | Description |
| ----- | ---- | ----------- |
2880 2881
| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes. |
| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes. |
2882
| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. |
2883
| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit. |
2884
| `description` | String | Description of the namespace. |
Felipe Artur's avatar
Felipe Artur committed
2885
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
2886 2887 2888
| `fullName` | String! | Full name of the namespace. |
| `fullPath` | ID! | Full path of the namespace. |
| `id` | ID! | ID of the namespace. |
2889
| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase. |
2890 2891 2892 2893 2894
| `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. |
2895
| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit. |
2896 2897
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace. |
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces. |
2898 2899 2900 2901
| `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. |
2902
| `visibility` | String | Visibility of the namespace. |
Felipe Artur's avatar
Felipe Artur committed
2903

2904
### NamespaceIncreaseStorageTemporarilyPayload
2905

2906
Autogenerated return type of NamespaceIncreaseStorageTemporarily.
2907

2908 2909
| Field | Type | Description |
| ----- | ---- | ----------- |
2910 2911
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
2912
| `namespace` | Namespace | The namespace after mutation. |
2913

2914
### Note
Felipe Artur's avatar
Felipe Artur committed
2915

2916 2917
| Field | Type | Description |
| ----- | ---- | ----------- |
2918 2919
| `author` | User! | User who wrote this note. |
| `body` | String! | Content of the note. |
Felipe Artur's avatar
Felipe Artur committed
2920
| `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` |
2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934
| `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. |
2935
| `userPermissions` | NotePermissions! | Permissions for the current user on the resource |
Felipe Artur's avatar
Felipe Artur committed
2936

2937
### NotePermissions
Felipe Artur's avatar
Felipe Artur committed
2938

2939 2940
| Field | Type | Description |
| ----- | ---- | ----------- |
2941 2942
| `adminNote` | Boolean! | Indicates the user can perform `admin_note` on this resource |
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
2943 2944
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
| `readNote` | Boolean! | Indicates the user can perform `read_note` on this resource |
2945
| `repositionNote` | Boolean! | Indicates the user can perform `reposition_note` on this resource |
2946
| `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource |
Felipe Artur's avatar
Felipe Artur committed
2947

2948 2949 2950 2951 2952 2953 2954 2955
### 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. |
2956 2957
| `id` | IncidentManagementOncallParticipantID! | ID of the on-call participant. |
| `user` | User! | The user who is participating. |
2958

2959 2960 2961 2962 2963 2964
### OncallRotationActivePeriodType

Active period time range for on-call rotation.

| Field | Type | Description |
| ----- | ---- | ----------- |
2965 2966
| `endTime` | String | The end of the rotation active period. |
| `startTime` | String | The start of the rotation active period. |
2967

2968 2969 2970 2971 2972 2973 2974 2975
### 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. |
2976
| `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation. |
2977

Sean Arnold's avatar
Sean Arnold committed
2978 2979 2980 2981 2982 2983 2984 2985 2986 2987
### 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. |

2988 2989 2990 2991 2992 2993 2994
### OncallScheduleCreatePayload

Autogenerated return type of OncallScheduleCreate.

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

### OncallScheduleDestroyPayload

Autogenerated return type of OncallScheduleDestroy.

| Field | Type | Description |
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3005
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3006
| `oncallSchedule` | IncidentManagementOncallSchedule | The on-call schedule. |
3007 3008 3009 3010 3011 3012 3013

### OncallScheduleUpdatePayload

Autogenerated return type of OncallScheduleUpdate.

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

3018
### Package
3019

3020
Represents a package in the Package Registry.
3021

3022 3023
| Field | Type | Description |
| ----- | ---- | ----------- |
3024 3025 3026 3027 3028
| `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. |
3029 3030
| `pipelines` | PipelineConnection | Pipelines that built the package. |
| `project` | Project! | Project where the package is stored. |
3031 3032 3033 3034
| `tags` | PackageTagConnection | Package tags. |
| `updatedAt` | Time! | Date of most recent update. |
| `version` | String | Version string. |
| `versions` | PackageWithoutVersionsConnection | The other versions of the package. |
3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046

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

3047
### PackageFileRegistry
3048

3049
Represents the Geo sync and verification state of a package file.
3050

3051 3052
| Field | Type | Description |
| ----- | ---- | ----------- |
3053 3054 3055 3056
| `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 |
3057
| `packageFileId` | ID! | ID of the PackageFile. |
3058 3059 3060 3061
| `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 |

3062 3063 3064 3065 3066 3067 3068 3069 3070
### 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. |

3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081
### 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. |

3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098
### 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. |

3099
### PageInfo
3100

3101
Information about pagination in a connection.
Felipe Artur's avatar
Felipe Artur committed
3102

3103 3104
| Field | Type | Description |
| ----- | ---- | ----------- |
3105
| `endCursor` | String | When paginating forwards, the cursor to continue. |
Felipe Artur's avatar
Felipe Artur committed
3106 3107 3108 3109
| `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. |

3110
### Pipeline
Felipe Artur's avatar
Felipe Artur committed
3111

3112 3113
| Field | Type | Description |
| ----- | ---- | ----------- |
3114 3115 3116 3117
| `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. |
3118
| `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) |
3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130
| `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. |
3131
| `securityReportFindings` | PipelineSecurityReportFindingConnection | Vulnerability findings reported on the pipeline. |
3132
| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline. |
3133 3134 3135 3136
| `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. |
3137
| `status` | PipelineStatusEnum! | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED) |
3138 3139 3140
| `updatedAt` | Time! | Timestamp of the pipeline's last activity. |
| `upstream` | Pipeline | Pipeline that triggered the pipeline. |
| `user` | User | Pipeline user. |
3141
| `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource |
3142
| `warnings` | Boolean! | Indicates if a pipeline has warnings. |
Felipe Artur's avatar
Felipe Artur committed
3143

3144 3145 3146 3147
### PipelineAnalytics

| Field | Type | Description |
| ----- | ---- | ----------- |
3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158
| `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. |
3159

3160
### PipelineCancelPayload
lauraMon's avatar
lauraMon committed
3161

3162
Autogenerated return type of PipelineCancel.
lauraMon's avatar
lauraMon committed
3163

3164 3165
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
3166 3167 3168
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

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

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

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

3178
### PipelinePermissions
Felipe Artur's avatar
Felipe Artur committed
3179

3180 3181
| Field | Type | Description |
| ----- | ---- | ----------- |
3182 3183
| `adminPipeline` | Boolean! | Indicates the user can perform `admin_pipeline` on this resource |
| `destroyPipeline` | Boolean! | Indicates the user can perform `destroy_pipeline` on this resource |
3184
| `updatePipeline` | Boolean! | Indicates the user can perform `update_pipeline` on this resource |
Felipe Artur's avatar
Felipe Artur committed
3185

3186
### PipelineRetryPayload
lauraMon's avatar
lauraMon committed
3187

3188
Autogenerated return type of PipelineRetry.
lauraMon's avatar
lauraMon committed
3189

3190 3191
| Field | Type | Description |
| ----- | ---- | ----------- |
lauraMon's avatar
lauraMon committed
3192 3193
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
3194
| `pipeline` | Pipeline | The pipeline after mutation. |
lauraMon's avatar
lauraMon committed
3195

3196 3197 3198 3199 3200 3201
### PipelineSecurityReportFinding

Represents vulnerability finding of a security report on the pipeline.

| Field | Type | Description |
| ----- | ---- | ----------- |
3202 3203
| `confidence` | String | Type of the security report that found the vulnerability. |
| `description` | String | Description of the vulnerability finding. |
3204
| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerabilit finding. |
3205 3206 3207 3208 3209
| `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. |
3210
| `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. |
3211 3212 3213
| `severity` | VulnerabilitySeverity | Severity of the vulnerability finding. |
| `solution` | String | URL to the vulnerability's details page. |
| `uuid` | String | Name of the vulnerability finding. |
3214

3215
### Project
Felipe Artur's avatar
Felipe Artur committed
3216

3217 3218
| Field | Type | Description |
| ----- | ---- | ----------- |
3219
| `actualRepositorySizeLimit` | Float | Size limit for the repository in bytes. |
3220 3221 3222
| `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. |
3223
| `alertManagementHttpIntegrations` | AlertManagementHttpIntegrationConnection | HTTP Integrations which can receive alerts for the project. |
3224
| `alertManagementIntegrations` | AlertManagementIntegrationConnection | Integrations which can receive alerts for the project. |
3225
| `alertManagementPayloadFields` | AlertManagementPayloadAlertField! => Array | Extract alert fields from payload for custom mapping. |
3226
| `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. |
3227
| `apiFuzzingCiConfiguration` | ApiFuzzingCiConfiguration | API fuzzing configuration for the project. Available only when feature flag `api_fuzzing_configuration_ui` is enabled. |
3228 3229 3230 3231 3232 3233
| `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. |
3234 3235 3236 3237
| `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. |
3238 3239 3240 3241 3242
| `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. |
3243 3244 3245 3246
| `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. |
3247
| `dastSiteValidations` | DastSiteValidationConnection | DAST Site Validations associated with the project. |
3248
| `description` | String | Short description of the project. |
Felipe Artur's avatar
Felipe Artur committed
3249
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3250 3251 3252 3253 3254 3255 3256 3257 3258
| `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. |
3259
| `incidentManagementOncallSchedules` | IncidentManagementOncallScheduleConnection | Incident Management On-call schedules of the project. |
3260 3261 3262
| `issue` | Issue | A single issue of the project. |
| `issueStatusCounts` | IssueStatusCountsType | Counts of issues by status for the project. |
| `issues` | IssueConnection | Issues of the project. |
3263
| `issuesEnabled` | Boolean | Indicates if Issues are enabled for the current user |
3264
| `iterations` | IterationConnection | Find iterations. |
3265 3266 3267 3268 3269 3270 3271 3272 3273
| `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. |
3274
| `mergeRequestsEnabled` | Boolean | Indicates if Merge Requests are enabled for the current user |
3275
| `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. |
3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294
| `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. |
3295
| `repositorySizeExcess` | Float | Size of repository that exceeds the limit in bytes. |
3296
| `requestAccessEnabled` | Boolean | Indicates if users can request member access to the project. |
3297 3298 3299
| `requirement` | Requirement | Find a single requirement. |
| `requirementStatesCount` | RequirementStatesCount | Number of requirements for the project by their state. |
| `requirements` | RequirementConnection | Find requirements. |
3300
| `sastCiConfiguration` | SastCiConfiguration | SAST CI configuration for the project. |
3301 3302
| `securityDashboardPath` | String | Path to project's security dashboard. |
| `securityScanners` | SecurityScanners | Information about security analyzers used in the project. |
3303 3304
| `sentryDetailedError` | SentryDetailedError | Detailed version of a Sentry error on the project. |
| `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project. |
3305
| `serviceDeskAddress` | String | E-mail address of the service desk. |
3306
| `serviceDeskEnabled` | Boolean | Indicates if the project has service desk enabled. |
3307 3308 3309
| `services` | ServiceConnection | Project services. |
| `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project. |
| `snippets` | SnippetConnection | Snippets of the project. |
3310
| `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user |
3311 3312 3313 3314 3315 3316
| `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). |
3317 3318
| `terraformState` | TerraformState | Find a single Terraform state by name. |
| `terraformStates` | TerraformStateConnection | Terraform states associated with the project. |
3319
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
3320
| `visibility` | String | Visibility of the project. |
3321 3322 3323 3324
| `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. |
3325
| `webUrl` | String | Web URL of the project. |
3326
| `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user |
Felipe Artur's avatar
Felipe Artur committed
3327

3328 3329 3330 3331
### ProjectCiCdSetting

| Field | Type | Description |
| ----- | ---- | ----------- |
3332
| `keepLatestArtifact` | Boolean | Whether to keep the latest builds artifacts. |
3333 3334 3335 3336
| `mergePipelinesEnabled` | Boolean | Whether merge pipelines are enabled. |
| `mergeTrainsEnabled` | Boolean | Whether merge trains are enabled. |
| `project` | Project | Project the CI/CD settings belong to. |

3337
### ProjectMember
3338

3339
Represents a Project Membership.
3340

3341 3342
| Field | Type | Description |
| ----- | ---- | ----------- |
3343 3344 3345 3346 3347 3348 3349 3350
| `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. |
3351
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
3352

3353
### ProjectPermissions
Felipe Artur's avatar
Felipe Artur committed
3354

3355 3356
| Field | Type | Description |
| ----- | ---- | ----------- |
3357 3358 3359 3360 3361
| `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 |
3362 3363
| `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 |
3364 3365
| `createDeployment` | Boolean! | Indicates the user can perform `create_deployment` on this resource |
| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource |
3366
| `createIssue` | Boolean! | Indicates the user can perform `create_issue` on this resource |
3367 3368 3369 3370
| `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 |
3371 3372
| `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 |
3373
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
3374
| `createWiki` | Boolean! | Indicates the user can perform `create_wiki` on this resource |
3375 3376 3377 3378 3379 3380
| `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 |
3381 3382
| `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 |
3383 3384 3385
| `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 |
3386
| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource |
3387 3388 3389 3390 3391 3392 3393 3394 3395
| `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 |
3396 3397
| `updatePages` | Boolean! | Indicates the user can perform `update_pages` on this resource |
| `updateWiki` | Boolean! | Indicates the user can perform `update_wiki` on this resource |
3398
| `uploadFile` | Boolean! | Indicates the user can perform `upload_file` on this resource |
Felipe Artur's avatar
Felipe Artur committed
3399

3400
### ProjectStatistics
Felipe Artur's avatar
Felipe Artur committed
3401

3402 3403
| Field | Type | Description |
| ----- | ---- | ----------- |
3404 3405 3406 3407 3408 3409 3410 3411 3412
| `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
3413

3414
### PrometheusAlert
3415

3416
The alert condition for Prometheus.
3417

3418 3419
| Field | Type | Description |
| ----- | ---- | ----------- |
3420 3421
| `humanizedText` | String! | The human-readable text of the alert condition. |
| `id` | ID! | ID of the alert condition. |
3422

3423 3424 3425 3426 3427 3428 3429 3430
### 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. |
3431
| `integration` | AlertManagementPrometheusIntegration | The newly created integration. |
3432 3433 3434 3435 3436 3437 3438 3439 3440

### 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. |
3441
| `integration` | AlertManagementPrometheusIntegration | The newly created integration. |
3442 3443 3444 3445 3446 3447 3448 3449 3450

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

3453 3454 3455 3456 3457 3458 3459
### PromoteToEpicPayload

Autogenerated return type of PromoteToEpic.

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

3464
### Release
3465

3466
Represents a release.
3467

3468 3469
| Field | Type | Description |
| ----- | ---- | ----------- |
3470 3471 3472 3473 3474
| `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. |
3475
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3476 3477 3478 3479 3480 3481 3482 3483
| `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. |
3484

3485
### ReleaseAssetLink
3486

3487
Represents an asset link associated with a release.
3488

3489 3490
| Field | Type | Description |
| ----- | ---- | ----------- |
3491 3492 3493 3494 3495 3496
| `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. |
3497

3498 3499 3500 3501 3502 3503 3504 3505 3506 3507
### ReleaseAssetLinkCreatePayload

Autogenerated return type of ReleaseAssetLinkCreate.

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

3508
### ReleaseAssets
3509

3510
A container for all assets associated with a release.
3511

3512 3513
| Field | Type | Description |
| ----- | ---- | ----------- |
3514 3515 3516
| `count` | Int | Number of assets of the release. |
| `links` | ReleaseAssetLinkConnection | Asset links of the release. |
| `sources` | ReleaseSourceConnection | Sources of the release. |
3517

3518 3519 3520 3521 3522 3523 3524 3525
### 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. |
3526
| `release` | Release | The release after mutation. |
3527

3528 3529 3530 3531 3532 3533 3534 3535 3536 3537
### 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. |

3538
### ReleaseEvidence
3539

3540
Evidence for a release.
3541

3542 3543
| Field | Type | Description |
| ----- | ---- | ----------- |
3544 3545 3546 3547
| `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. |
3548

3549
### ReleaseLinks
3550

3551 3552
| Field | Type | Description |
| ----- | ---- | ----------- |
3553 3554 3555 3556 3557 3558 3559
| `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. |
3560

3561
### ReleaseSource
3562

3563
Represents the source code attached to a release in a particular format.
3564

3565 3566
| Field | Type | Description |
| ----- | ---- | ----------- |
3567 3568
| `format` | String | Format of the source. |
| `url` | String | Download URL of the source. |
3569

3570 3571 3572 3573 3574 3575 3576 3577 3578 3579
### 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. |

3580
### RemoveAwardEmojiPayload
3581

3582
Autogenerated return type of RemoveAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
3583

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

3590
### RemoveProjectFromSecurityDashboardPayload
3591

3592
Autogenerated return type of RemoveProjectFromSecurityDashboard.
3593

3594 3595
| Field | Type | Description |
| ----- | ---- | ----------- |
3596
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
3597
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
Felipe Artur's avatar
Felipe Artur committed
3598

3599 3600 3601 3602 3603 3604 3605 3606
### 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. |
3607
| `note` | Note | The note after mutation. |
3608

3609
### Repository
Felipe Artur's avatar
Felipe Artur committed
3610

3611 3612
| Field | Type | Description |
| ----- | ---- | ----------- |
3613 3614 3615 3616
| `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
3617

3618
### Requirement
Jan Provaznik's avatar
Jan Provaznik committed
3619

3620
Represents a requirement.
Jan Provaznik's avatar
Jan Provaznik committed
3621

3622 3623
| Field | Type | Description |
| ----- | ---- | ----------- |
3624 3625 3626
| `author` | User! | Author of the requirement. |
| `createdAt` | Time! | Timestamp of when the requirement was created. |
| `description` | String | Description of the requirement. |
3627
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3628 3629 3630 3631 3632 3633 3634 3635
| `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. |
3636
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
3637
| `updatedAt` | Time! | Timestamp of when the requirement was last updated. |
Jan Provaznik's avatar
Jan Provaznik committed
3638 3639
| `userPermissions` | RequirementPermissions! | Permissions for the current user on the resource |

3640
### RequirementPermissions
Jan Provaznik's avatar
Jan Provaznik committed
3641

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

3644 3645
| Field | Type | Description |
| ----- | ---- | ----------- |
Jan Provaznik's avatar
Jan Provaznik committed
3646 3647 3648 3649 3650 3651
| `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 |

3652
### RequirementStatesCount
3653 3654 3655

Counts of requirements by their state.

3656 3657
| Field | Type | Description |
| ----- | ---- | ----------- |
3658 3659
| `archived` | Int | Number of archived requirements. |
| `opened` | Int | Number of opened requirements. |
3660

3661 3662 3663 3664 3665 3666 3667 3668
### 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. |
3669
| `vulnerability` | Vulnerability | The vulnerability after revert. |
3670

3671
### RootStorageStatistics
3672

3673 3674
| Field | Type | Description |
| ----- | ---- | ----------- |
3675 3676 3677 3678 3679 3680 3681 3682 3683
| `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. |
3684

3685
### RunDASTScanPayload
3686

3687
Autogenerated return type of RunDASTScan.
3688

3689 3690
| Field | Type | Description |
| ----- | ---- | ----------- |
3691 3692 3693 3694
| `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. |

3695 3696 3697 3698
### RunnerArchitecture

| Field | Type | Description |
| ----- | ---- | ----------- |
3699 3700
| `downloadLocation` | String! | Download location for the runner for the platform architecture. |
| `name` | String! | Name of the runner platform architecture. |
3701 3702 3703 3704 3705

### RunnerPlatform

| Field | Type | Description |
| ----- | ---- | ----------- |
3706 3707 3708
| `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. |
3709

3710 3711 3712 3713
### RunnerSetup

| Field | Type | Description |
| ----- | ---- | ----------- |
3714 3715
| `installInstructions` | String! | Instructions for installing the runner on the specified architecture. |
| `registerInstructions` | String | Instructions for registering the runner. |
3716

3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
### 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. |

3727
### SastCiConfigurationAnalyzersEntity
3728

3729
Represents an analyzer entity in SAST CI configuration.
3730

3731 3732
| Field | Type | Description |
| ----- | ---- | ----------- |
3733 3734 3735 3736 3737
| `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. |
3738

3739
### SastCiConfigurationEntity
3740

3741
Represents an entity in SAST CI configuration.
3742

3743 3744
| Field | Type | Description |
| ----- | ---- | ----------- |
3745 3746 3747 3748
| `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. |
3749
| `options` | SastCiConfigurationOptionsEntityConnection | Different possible values of the field. |
3750
| `size` | SastUiComponentSize | Size of the UI component. |
3751 3752 3753
| `type` | String | Type of the field value. |
| `value` | String | Current value of the entity. |

3754
### SastCiConfigurationOptionsEntity
3755

3756
Represents an entity for options in SAST CI configuration.
3757

3758 3759
| Field | Type | Description |
| ----- | ---- | ----------- |
3760 3761 3762
| `label` | String | Label of option entity. |
| `value` | String | Value of option entity. |

3763
### ScannedResource
3764

3765
Represents a resource scanned by a security scan.
3766

3767 3768
| Field | Type | Description |
| ----- | ---- | ----------- |
3769 3770
| `requestMethod` | String | The HTTP request method used to access the URL. |
| `url` | String | The URL scanned by the scanner. |
3771

3772
### SecurityReportSummary
3773

3774
Represents summary of a security report.
3775

3776 3777
| Field | Type | Description |
| ----- | ---- | ----------- |
3778 3779 3780 3781 3782 3783 3784
| `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 |
3785

3786
### SecurityReportSummarySection
3787

3788
Represents a section of a summary of a security report.
3789

3790 3791
| Field | Type | Description |
| ----- | ---- | ----------- |
3792 3793 3794 3795
| `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. |
3796

3797
### SecurityScanners
3798

3799
Represents a list of security scanners.
3800

3801 3802
| Field | Type | Description |
| ----- | ---- | ----------- |
3803 3804 3805 3806
| `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. |

3807
### SentryDetailedError
3808

Sean Arnold's avatar
Sean Arnold committed
3809 3810
A Sentry error.

3811 3812
| Field | Type | Description |
| ----- | ---- | ----------- |
3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840
| `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. |
3841

3842
### SentryError
Sean Arnold's avatar
Sean Arnold committed
3843 3844 3845

A Sentry error. A simplified version of SentryDetailedError.

3846 3847
| Field | Type | Description |
| ----- | ---- | ----------- |
3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864
| `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
3865

3866
### SentryErrorCollection
Sean Arnold's avatar
Sean Arnold committed
3867 3868 3869

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

3870 3871
| Field | Type | Description |
| ----- | ---- | ----------- |
3872 3873 3874 3875
| `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
3876

3877
### SentryErrorFrequency
3878

3879 3880
| Field | Type | Description |
| ----- | ---- | ----------- |
3881 3882
| `count` | Int! | Count of errors received since the previously recorded time. |
| `time` | Time! | Time the error frequency stats were recorded. |
3883

3884
### SentryErrorStackTrace
Sean Arnold's avatar
Sean Arnold committed
3885 3886 3887

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

3888 3889
| Field | Type | Description |
| ----- | ---- | ----------- |
3890 3891 3892
| `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
3893

3894
### SentryErrorStackTraceContext
Sean Arnold's avatar
Sean Arnold committed
3895

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

3898 3899
| Field | Type | Description |
| ----- | ---- | ----------- |
3900 3901
| `code` | String! | Code number of the context. |
| `line` | Int! | Line number of the context. |
Sean Arnold's avatar
Sean Arnold committed
3902

3903
### SentryErrorStackTraceEntry
Sean Arnold's avatar
Sean Arnold committed
3904 3905 3906

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

3907 3908
| Field | Type | Description |
| ----- | ---- | ----------- |
3909 3910 3911 3912 3913
| `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
3914

3915
### SentryErrorTags
3916

3917
State of a Sentry error.
3918

3919 3920
| Field | Type | Description |
| ----- | ---- | ----------- |
3921 3922
| `level` | String | Severity level of the Sentry Error. |
| `logger` | String | Logger of the Sentry Error. |
3923

3924
### Snippet
3925

3926
Represents a snippet entry.
3927

3928 3929
| Field | Type | Description |
| ----- | ---- | ----------- |
3930
| `author` | User | The owner of the snippet. |
3931
| `blob` **{warning-solid}** | SnippetBlob! | **Deprecated:** Use `blobs`. Deprecated in 13.3. |
3932 3933 3934
| `blobs` | SnippetBlobConnection | Snippet blobs. |
| `createdAt` | Time! | Timestamp this snippet was created. |
| `description` | String | Description of the snippet. |
3935
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
3936 3937 3938 3939 3940 3941 3942 3943 3944 3945
| `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. |
3946
| `userPermissions` | SnippetPermissions! | Permissions for the current user on the resource |
3947 3948
| `visibilityLevel` | VisibilityLevelsEnum! | Visibility Level of the snippet. |
| `webUrl` | String! | Web URL of the snippet. |
3949

3950
### SnippetBlob
3951

3952
Represents the snippet blob.
3953

3954 3955
| Field | Type | Description |
| ----- | ---- | ----------- |
3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967
| `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. |
3968

3969
### SnippetBlobViewer
3970

3971
Represents how the blob content should be displayed.
3972

3973 3974
| Field | Type | Description |
| ----- | ---- | ----------- |
3975 3976 3977 3978 3979 3980 3981
| `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. |
3982

3983
### SnippetPermissions
3984

3985 3986
| Field | Type | Description |
| ----- | ---- | ----------- |
3987
| `adminSnippet` | Boolean! | Indicates the user can perform `admin_snippet` on this resource |
3988
| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource |
3989
| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource |
3990 3991
| `readSnippet` | Boolean! | Indicates the user can perform `read_snippet` on this resource |
| `reportSnippet` | Boolean! | Indicates the user can perform `report_snippet` on this resource |
3992
| `updateSnippet` | Boolean! | Indicates the user can perform `update_snippet` on this resource |
3993

3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005
### 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 |
4006
| `snippetRepositoryId` | ID! | ID of the Snippet Repository. |
4007 4008
| `state` | RegistryState | Sync state of the SnippetRepositoryRegistry |

4009 4010 4011 4012
### StatusAction

| Field | Type | Description |
| ----- | ---- | ----------- |
4013 4014 4015 4016 4017
| `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. |
4018

4019
### Submodule
Felipe Artur's avatar
Felipe Artur committed
4020

4021 4022
| Field | Type | Description |
| ----- | ---- | ----------- |
4023 4024 4025 4026 4027 4028 4029 4030
| `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
4031

4032
### TaskCompletionStatus
4033

4034
Completion status of tasks.
Felipe Artur's avatar
Felipe Artur committed
4035

4036 4037
| Field | Type | Description |
| ----- | ---- | ----------- |
4038 4039
| `completedCount` | Int! | Number of completed tasks. |
| `count` | Int! | Number of total tasks. |
Felipe Artur's avatar
Felipe Artur committed
4040

4041 4042 4043 4044
### TerraformState

| Field | Type | Description |
| ----- | ---- | ----------- |
4045 4046 4047 4048 4049 4050 4051
| `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. |
4052

4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079
### 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. |

4080 4081 4082 4083
### TerraformStateVersion

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

4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104
### 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 |
4105
| `terraformStateVersionId` | ID! | ID of the terraform state version. |
4106

4107
### TestReport
4108 4109 4110

Represents a requirement test report.

4111 4112
| Field | Type | Description |
| ----- | ---- | ----------- |
4113 4114 4115 4116
| `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. |
4117

4118 4119 4120 4121 4122 4123
### TimeReportStats

Represents the time report stats for timeboxes.

| Field | Type | Description |
| ----- | ---- | ----------- |
4124 4125 4126
| `complete` | TimeboxMetrics | Completed issues metrics. |
| `incomplete` | TimeboxMetrics | Incomplete issues metrics. |
| `total` | TimeboxMetrics | Total issues metrics. |
4127 4128 4129 4130 4131 4132 4133

### TimeboxMetrics

Represents measured stats metrics for timeboxes.

| Field | Type | Description |
| ----- | ---- | ----------- |
4134 4135
| `count` | Int! | The count metric. |
| `weight` | Int! | The weight metric. |
4136

4137 4138 4139 4140 4141 4142
### TimeboxReport

Represents a historically accurate report about the timebox.

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

4146
### Timelog
4147

4148 4149
| Field | Type | Description |
| ----- | ---- | ----------- |
4150 4151 4152 4153 4154
| `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. |
4155

4156
### Todo
4157

4158
Representing a to-do entry.
4159

4160 4161
| Field | Type | Description |
| ----- | ---- | ----------- |
4162 4163 4164 4165 4166 4167 4168 4169 4170
| `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. |
4171

4172 4173 4174 4175 4176 4177 4178 4179
### 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. |
4180
| `todo` | Todo | The to-do item created. |
4181

4182
### TodoMarkDonePayload
4183

4184
Autogenerated return type of TodoMarkDone.
4185

4186 4187
| Field | Type | Description |
| ----- | ---- | ----------- |
4188
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4189
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4190
| `todo` | Todo! | The requested to-do item. |
4191

4192
### TodoRestoreManyPayload
4193

4194
Autogenerated return type of TodoRestoreMany.
4195

4196 4197
| Field | Type | Description |
| ----- | ---- | ----------- |
4198
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4199
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4200 4201
| `todos` | Todo! => Array | Updated to-do items. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. |
4202

4203
### TodoRestorePayload
4204

4205
Autogenerated return type of TodoRestore.
4206

4207 4208
| Field | Type | Description |
| ----- | ---- | ----------- |
4209
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4210
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4211
| `todo` | Todo! | The requested to-do item. |
4212

4213
### TodosMarkAllDonePayload
4214

4215
Autogenerated return type of TodosMarkAllDone.
4216

4217 4218
| Field | Type | Description |
| ----- | ---- | ----------- |
4219
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4220
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4221 4222
| `todos` | Todo! => Array | Updated to-do items. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. |
4223

4224
### ToggleAwardEmojiPayload
4225

4226
Autogenerated return type of ToggleAwardEmoji.
Felipe Artur's avatar
Felipe Artur committed
4227

4228 4229
| Field | Type | Description |
| ----- | ---- | ----------- |
4230
| `awardEmoji` | AwardEmoji | The award emoji after mutation. |
Felipe Artur's avatar
Felipe Artur committed
4231
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4232
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4233
| `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
4234

4235
### Tree
Felipe Artur's avatar
Felipe Artur committed
4236

4237 4238
| Field | Type | Description |
| ----- | ---- | ----------- |
4239 4240 4241 4242
| `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
4243

4244
### TreeEntry
4245

4246
Represents a directory.
Felipe Artur's avatar
Felipe Artur committed
4247

4248 4249
| Field | Type | Description |
| ----- | ---- | ----------- |
4250 4251 4252 4253 4254 4255 4256 4257
| `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
4258

4259
### UpdateAlertStatusPayload
Sean Arnold's avatar
Sean Arnold committed
4260

4261
Autogenerated return type of UpdateAlertStatus.
Sean Arnold's avatar
Sean Arnold committed
4262

4263 4264
| Field | Type | Description |
| ----- | ---- | ----------- |
4265
| `alert` | AlertManagementAlert | The alert after mutation. |
Sean Arnold's avatar
Sean Arnold committed
4266
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4267
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4268
| `issue` | Issue | The issue created after mutation. |
4269
| `todo` | Todo | The to-do item after mutation. |
Sean Arnold's avatar
Sean Arnold committed
4270

4271 4272 4273 4274 4275 4276 4277
### UpdateBoardEpicUserPreferencesPayload

Autogenerated return type of UpdateBoardEpicUserPreferences.

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

4281
### UpdateBoardListPayload
4282

4283
Autogenerated return type of UpdateBoardList.
4284

4285 4286
| Field | Type | Description |
| ----- | ---- | ----------- |
4287 4288
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4289
| `list` | BoardList | Mutated list. |
4290

4291
### UpdateBoardPayload
4292

4293
Autogenerated return type of UpdateBoard.
4294

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

4301 4302 4303 4304 4305 4306 4307
### UpdateComplianceFrameworkPayload

Autogenerated return type of UpdateComplianceFramework.

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

4311
### UpdateContainerExpirationPolicyPayload
4312

4313
Autogenerated return type of UpdateContainerExpirationPolicy.
4314

4315 4316
| Field | Type | Description |
| ----- | ---- | ----------- |
4317
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4318
| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy after mutation. |
4319 4320
| `errors` | String! => Array | Errors encountered during execution of the mutation. |

4321
### UpdateEpicPayload
4322

4323
Autogenerated return type of UpdateEpic.
4324

4325 4326
| Field | Type | Description |
| ----- | ---- | ----------- |
4327
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4328
| `epic` | Epic | The epic after mutation. |
4329
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4330

4331
### UpdateImageDiffNotePayload
4332

4333
Autogenerated return type of UpdateImageDiffNote.
4334

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

4341
### UpdateIssuePayload
4342

4343
Autogenerated return type of UpdateIssue.
4344

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

4351
### UpdateIterationPayload
4352

4353
Autogenerated return type of UpdateIteration.
4354

4355 4356
| Field | Type | Description |
| ----- | ---- | ----------- |
4357 4358
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4359
| `iteration` | Iteration | Updated iteration. |
4360

4361 4362 4363 4364 4365 4366 4367 4368 4369 4370
### 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. |

4371
### UpdateNotePayload
4372

4373
Autogenerated return type of UpdateNote.
4374

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

4381
### UpdateRequirementPayload
4382

4383
Autogenerated return type of UpdateRequirement.
4384

4385 4386
| Field | Type | Description |
| ----- | ---- | ----------- |
4387
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4388
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4389
| `requirement` | Requirement | Requirement after mutation. |
4390

4391
### UpdateSnippetPayload
4392

4393
Autogenerated return type of UpdateSnippet.
4394

4395 4396
| Field | Type | Description |
| ----- | ---- | ----------- |
4397
| `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. |
4398
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
4399
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
4400
| `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. |
4401
| `snippet` | Snippet | The snippet after mutation. |
4402 4403
| `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. |
4404

4405 4406 4407 4408 4409 4410 4411 4412 4413 4414
### 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. |

4415
### User
Felipe Artur's avatar
Felipe Artur committed
4416

4417 4418
| Field | Type | Description |
| ----- | ---- | ----------- |
4419 4420 4421
| `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
4422
| `bot` | Boolean! | Indicates if the user is a bot. |
4423
| `email` **{warning-solid}** | String | **Deprecated:** Use public_email. Deprecated in 13.7. |
4424 4425 4426
| `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. |
4427
| `location` | String | The location of the user. |
4428 4429 4430 4431 4432 4433 4434 4435 4436
| `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. |
4437
| `userPermissions` | UserPermissions! | Permissions for the current user on the resource |
4438 4439 4440
| `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. |
4441

4442
### UserPermissions
4443

4444 4445
| Field | Type | Description |
| ----- | ---- | ----------- |
4446
| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource |
4447

4448
### UserStatus
lauraMon's avatar
lauraMon committed
4449

4450 4451
| Field | Type | Description |
| ----- | ---- | ----------- |
4452 4453 4454
| `availability` | AvailabilityEnum! | User availability status. |
| `emoji` | String | String representation of emoji. |
| `message` | String | User status message. |
lauraMon's avatar
lauraMon committed
4455 4456
| `messageHtml` | String | HTML of the user status message |

4457
### VulnerabilitiesCountByDay
4458

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

4461 4462
| Field | Type | Description |
| ----- | ---- | ----------- |
4463
| `critical` | Int! | Total number of vulnerabilities on a particular day with critical severity |
4464
| `date` | ISO8601Date! | Date for the count. |
4465 4466 4467 4468
| `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 |
4469
| `total` | Int! | Total number of vulnerabilities on a particular day. |
4470 4471
| `unknown` | Int! | Total number of vulnerabilities on a particular day with unknown severity |

4472
### VulnerabilitiesCountByDayAndSeverity
4473

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

4476 4477
| Field | Type | Description |
| ----- | ---- | ----------- |
4478 4479 4480
| `count` | Int | Number of vulnerabilities. |
| `day` | ISO8601Date | Date for the count. |
| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities. |
4481

4482
### Vulnerability
4483 4484 4485

Represents a vulnerability.

4486 4487
| Field | Type | Description |
| ----- | ---- | ----------- |
4488
| `confirmedAt` | Time | Timestamp of when the vulnerability state was changed to confirmed. |
4489
| `confirmedBy` | User | The user that confirmed the vulnerability. |
4490 4491 4492
| `description` | String | Description of the vulnerability. |
| `details` | VulnerabilityDetail! => Array | Details of the vulnerability. |
| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected. |
4493
| `discussions` | DiscussionConnection! | All discussions on this noteable. |
4494
| `dismissedAt` | Time | Timestamp of when the vulnerability state was changed to dismissed. |
4495
| `dismissedBy` | User | The user that dismissed the vulnerability. |
4496
| `externalIssueLinks` | VulnerabilityExternalIssueLinkConnection! | List of external issue links related to the vulnerability. |
4497
| `hasSolutions` | Boolean | Indicates whether there is a solution available for this vulnerability. |
4498
| `id` | ID! | GraphQL ID of the vulnerability. |
4499
| `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerability. |
4500 4501
| `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. |
4502
| `mergeRequest` | MergeRequest | Merge request that fixes the vulnerability. |
4503
| `notes` | NoteConnection! | All notes on this noteable. |
4504
| `primaryIdentifier` | VulnerabilityIdentifier | Primary identifier of the vulnerability. |
4505
| `project` | Project | The project on which the vulnerability was found. |
4506
| `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING) |
4507
| `resolvedAt` | Time | Timestamp of when the vulnerability state was changed to resolved. |
4508
| `resolvedBy` | User | The user that resolved the vulnerability. |
4509
| `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not. |
4510
| `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. |
4511
| `severity` | VulnerabilitySeverity | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL) |
4512
| `state` | VulnerabilityState | State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED) |
4513 4514
| `title` | String | Title of the vulnerability. |
| `userNotesCount` | Int! | Number of user notes attached to the vulnerability. |
4515
| `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource |
4516
| `vulnerabilityPath` | String | URL to the vulnerability's details page. |
Avielle Wolfe's avatar
Avielle Wolfe committed
4517

4518 4519 4520 4521 4522 4523 4524 4525
### 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. |
4526
| `vulnerability` | Vulnerability | The vulnerability after state change. |
4527

4528 4529 4530 4531 4532 4533
### VulnerabilityDetailBase

Represents the vulnerability details base.

| Field | Type | Description |
| ----- | ---- | ----------- |
4534
| `description` | String | Description of the field. |
4535
| `fieldName` | String | Name of the field. |
4536
| `name` | String | Name of the field. |
4537 4538 4539 4540 4541 4542 4543

### VulnerabilityDetailBoolean

Represents the vulnerability details boolean value.

| Field | Type | Description |
| ----- | ---- | ----------- |
4544
| `description` | String | Description of the field. |
4545
| `fieldName` | String | Name of the field. |
4546
| `name` | String | Name of the field. |
4547 4548 4549 4550 4551 4552 4553 4554
| `value` | Boolean! | Value of the field. |

### VulnerabilityDetailCode

Represents the vulnerability details code field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4555
| `description` | String | Description of the field. |
4556 4557
| `fieldName` | String | Name of the field. |
| `lang` | String | Language of the code. |
4558
| `name` | String | Name of the field. |
4559 4560 4561 4562 4563 4564 4565 4566
| `value` | String! | Source code. |

### VulnerabilityDetailCommit

Represents the vulnerability details commit field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4567
| `description` | String | Description of the field. |
4568
| `fieldName` | String | Name of the field. |
4569
| `name` | String | Name of the field. |
4570 4571 4572 4573 4574 4575 4576 4577 4578 4579
| `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. |
4580
| `description` | String | Description of the field. |
4581
| `fieldName` | String | Name of the field. |
4582
| `name` | String | Name of the field. |
4583 4584 4585 4586 4587 4588 4589

### VulnerabilityDetailFileLocation

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

| Field | Type | Description |
| ----- | ---- | ----------- |
4590
| `description` | String | Description of the field. |
4591 4592 4593 4594
| `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. |
4595
| `name` | String | Name of the field. |
4596 4597 4598 4599 4600 4601 4602

### VulnerabilityDetailInt

Represents the vulnerability details integer value.

| Field | Type | Description |
| ----- | ---- | ----------- |
4603
| `description` | String | Description of the field. |
4604
| `fieldName` | String | Name of the field. |
4605
| `name` | String | Name of the field. |
4606 4607 4608 4609 4610 4611 4612 4613
| `value` | Int! | Value of the field. |

### VulnerabilityDetailList

Represents the vulnerability details list value.

| Field | Type | Description |
| ----- | ---- | ----------- |
4614
| `description` | String | Description of the field. |
4615 4616
| `fieldName` | String | Name of the field. |
| `items` | VulnerabilityDetail! => Array | List of details. |
4617
| `name` | String | Name of the field. |
4618 4619 4620 4621 4622 4623 4624

### VulnerabilityDetailMarkdown

Represents the vulnerability details Markdown field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4625
| `description` | String | Description of the field. |
4626
| `fieldName` | String | Name of the field. |
4627
| `name` | String | Name of the field. |
4628 4629 4630 4631 4632 4633 4634 4635
| `value` | String! | Value of the Markdown field. |

### VulnerabilityDetailModuleLocation

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

| Field | Type | Description |
| ----- | ---- | ----------- |
4636
| `description` | String | Description of the field. |
4637 4638
| `fieldName` | String | Name of the field. |
| `moduleName` | String! | Module name. |
4639
| `name` | String | Name of the field. |
4640 4641 4642 4643 4644 4645 4646 4647
| `offset` | Int! | Offset of the module location. |

### VulnerabilityDetailTable

Represents the vulnerability details table value.

| Field | Type | Description |
| ----- | ---- | ----------- |
4648
| `description` | String | Description of the field. |
4649 4650
| `fieldName` | String | Name of the field. |
| `headers` | VulnerabilityDetail! => Array | Table headers. |
4651
| `name` | String | Name of the field. |
4652 4653 4654 4655 4656 4657 4658 4659
| `rows` | VulnerabilityDetail! => Array | Table rows. |

### VulnerabilityDetailText

Represents the vulnerability details text field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4660
| `description` | String | Description of the field. |
4661
| `fieldName` | String | Name of the field. |
4662
| `name` | String | Name of the field. |
4663 4664 4665 4666 4667 4668 4669 4670
| `value` | String! | Value of the text field. |

### VulnerabilityDetailUrl

Represents the vulnerability details URL field.

| Field | Type | Description |
| ----- | ---- | ----------- |
4671
| `description` | String | Description of the field. |
4672 4673
| `fieldName` | String | Name of the field. |
| `href` | String! | Href of the URL. |
4674
| `name` | String | Name of the field. |
4675 4676
| `text` | String | Text of the URL. |

4677 4678 4679 4680 4681 4682 4683 4684
### 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. |
4685
| `vulnerability` | Vulnerability | The vulnerability after dismissal. |
4686

4687 4688 4689 4690 4691 4692
### VulnerabilityExternalIssueLink

Represents an external issue link of a vulnerability.

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

4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715
### 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. |

4716
### VulnerabilityIdentifier
4717 4718 4719

Represents a vulnerability identifier.

4720 4721
| Field | Type | Description |
| ----- | ---- | ----------- |
4722 4723 4724 4725
| `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. |
4726

4727
### VulnerabilityIssueLink
4728 4729 4730

Represents an issue link of a vulnerability.

4731 4732
| Field | Type | Description |
| ----- | ---- | ----------- |
4733 4734 4735
| `id` | ID! | GraphQL ID of the vulnerability. |
| `issue` | Issue! | The issue attached to issue link. |
| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link. |
4736

4737
### VulnerabilityLocationContainerScanning
4738

4739
Represents the location of a vulnerability found by a container security scan.
4740

4741 4742
| Field | Type | Description |
| ----- | ---- | ----------- |
4743 4744 4745
| `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. |
4746

4747
### VulnerabilityLocationCoverageFuzzing
4748

4749
Represents the location of a vulnerability found by a Coverage Fuzzing scan.
4750

4751 4752
| Field | Type | Description |
| ----- | ---- | ----------- |
4753 4754 4755 4756 4757 4758
| `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. |
4759

4760
### VulnerabilityLocationDast
4761

4762
Represents the location of a vulnerability found by a DAST scan.
4763

4764 4765
| Field | Type | Description |
| ----- | ---- | ----------- |
4766 4767 4768 4769
| `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. |
4770

4771
### VulnerabilityLocationDependencyScanning
4772

4773
Represents the location of a vulnerability found by a dependency security scan.
4774

4775 4776
| Field | Type | Description |
| ----- | ---- | ----------- |
4777 4778 4779
| `blobPath` | String | Blob path to the vulnerable file. |
| `dependency` | VulnerableDependency | Dependency containing the vulnerability. |
| `file` | String | Path to the vulnerable file. |
4780

4781
### VulnerabilityLocationSast
4782

4783
Represents the location of a vulnerability found by a SAST scan.
4784

4785 4786
| Field | Type | Description |
| ----- | ---- | ----------- |
4787 4788 4789 4790 4791 4792
| `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. |
4793

4794
### VulnerabilityLocationSecretDetection
4795

4796
Represents the location of a vulnerability found by a secret detection scan.
4797

4798 4799
| Field | Type | Description |
| ----- | ---- | ----------- |
4800 4801 4802 4803 4804 4805
| `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. |
4806

4807
### VulnerabilityPermissions
4808

4809
Check permissions for the current user on a vulnerability.
4810

4811 4812
| Field | Type | Description |
| ----- | ---- | ----------- |
4813
| `adminVulnerability` | Boolean! | Indicates the user can perform `admin_vulnerability` on this resource |
4814
| `adminVulnerabilityExternalIssueLink` | Boolean! | Indicates the user can perform `admin_vulnerability_external_issue_link` on this resource |
4815 4816 4817 4818 4819 4820 4821 4822
| `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 |

4823 4824 4825 4826 4827 4828 4829 4830
### 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. |
4831
| `vulnerability` | Vulnerability | The vulnerability after state change. |
4832

4833 4834 4835 4836 4837 4838 4839 4840
### 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. |
4841
| `vulnerability` | Vulnerability | The vulnerability after revert. |
4842

4843
### VulnerabilityScanner
4844 4845 4846

Represents a vulnerability scanner.

4847 4848
| Field | Type | Description |
| ----- | ---- | ----------- |
4849 4850 4851 4852
| `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. |
4853

4854
### VulnerabilitySeveritiesCount
Avielle Wolfe's avatar
Avielle Wolfe committed
4855

4856
Represents vulnerability counts by severity.
Avielle Wolfe's avatar
Avielle Wolfe committed
4857

4858 4859
| Field | Type | Description |
| ----- | ---- | ----------- |
Avielle Wolfe's avatar
Avielle Wolfe committed
4860 4861 4862 4863 4864 4865
| `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 |
4866

4867
### VulnerableDependency
4868

4869
Represents a vulnerable dependency. Used in vulnerability location data.
4870

4871 4872
| Field | Type | Description |
| ----- | ---- | ----------- |
4873 4874
| `package` | VulnerablePackage | The package associated with the vulnerable dependency. |
| `version` | String | The version of the vulnerable dependency. |
4875

4876
### VulnerablePackage
4877

4878
Represents a vulnerable package. Used in vulnerability dependency data.
4879

4880 4881
| Field | Type | Description |
| ----- | ---- | ----------- |
4882
| `name` | String | The name of the vulnerable package. |
4883

4884
### VulnerableProjectsByGrade
4885

4886
Represents vulnerability letter grades with associated projects.
4887

4888 4889
| Field | Type | Description |
| ----- | ---- | ----------- |
4890 4891 4892
| `count` | Int! | Number of projects within this grade. |
| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present. |
| `projects` | ProjectConnection! | Projects within this grade. |
4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904

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

4905
Access level to a resource.
4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917

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

### AlertManagementAlertSort

4918
Values for sorting alerts.
4919 4920 4921

| Value | Description |
| ----- | ----------- |
4922 4923
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935
| `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 |
4936 4937
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
4938 4939
| `UPDATED_TIME_ASC` | Created time by ascending order |
| `UPDATED_TIME_DESC` | Created time by descending order |
4940 4941 4942 4943
| `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. |
4944

4945 4946 4947 4948 4949 4950
### AlertManagementDomainFilter

Filters the alerts based on given domain.

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

Sarah Yasonik's avatar
Sarah Yasonik committed
4954 4955 4956 4957 4958 4959 4960 4961 4962
### AlertManagementIntegrationType

Values of types of integrations.

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

4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989
### 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 |

4990 4991
### AlertManagementSeverity

4992
Alert severity values.
4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004

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

### AlertManagementStatus

5005
Alert status values.
5006 5007 5008 5009 5010 5011 5012 5013

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

5014 5015 5016 5017 5018 5019 5020 5021 5022
### 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. |

5023 5024 5025 5026 5027 5028
### AvailabilityEnum

User availability status.

| Value | Description |
| ----- | ----------- |
5029 5030
| `BUSY` | Busy |
| `NOT_SET` | Not Set |
5031

5032 5033
### BlobViewersType

5034
Types of blob viewers.
5035 5036 5037

| Value | Description |
| ----- | ----------- |
Subashis's avatar
Subashis committed
5038 5039 5040
| `auxiliary` | Auxiliary blob viewers type. |
| `rich` | Rich blob viewers type. |
| `simple` | Simple blob viewers type. |
5041

lauraMon's avatar
lauraMon committed
5042 5043 5044 5045 5046 5047
### CiConfigStatus

Values for YAML processor result.

| Value | Description |
| ----- | ----------- |
5048 5049
| `INVALID` | The configuration file is not valid |
| `VALID` | The configuration file is valid |
lauraMon's avatar
lauraMon committed
5050

5051 5052
### CommitActionMode

5053
Mode of a commit action.
5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099

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

5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110
### 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. |

5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127
### 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. |

5128 5129 5130 5131 5132 5133 5134 5135 5136
### ContainerRepositoryStatus

Status of a container repository.

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

5137 5138 5139 5140
### DastScanTypeEnum

| Value | Description |
| ----- | ----------- |
5141
| `ACTIVE` | Active DAST scan. This scan will make active attacks against the target site. |
5142 5143 5144 5145 5146 5147 5148 5149
| `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 |
5150
| `NONE` | No site validation exists |
5151 5152 5153
| `PASSED_VALIDATION` | Site validation process finished successfully |
| `PENDING_VALIDATION` | Site validation process has not started |

5154 5155 5156 5157 5158 5159 5160
### DastSiteValidationStrategyEnum

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

5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190
### 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 |

5191 5192 5193 5194 5195 5196 5197 5198 5199 5200
### 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 |

5201 5202
### DesignVersionEvent

5203
Mutation event of a design within a version.
5204 5205 5206 5207 5208 5209 5210 5211 5212 5213

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

### DiffPositionType

5214
Type of file the position refers to.
5215 5216 5217 5218 5219 5220 5221 5222

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

### EntryType

5223
Type of a tree entry.
5224 5225 5226 5227 5228 5229 5230 5231 5232

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

### EpicSort

5233
Roadmap sort values.
5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253

| 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

5254
State event of an epic.
5255 5256 5257 5258 5259 5260 5261 5262

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

### EpicWildcardId

5263
Epic ID wildcard values.
5264 5265 5266 5267 5268 5269

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

5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289
### 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 |

5290 5291 5292 5293 5294 5295 5296 5297 5298 5299
### GroupMemberRelation

Group member relation.

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

5300 5301
### HealthStatus

5302
Health status of an issue or epic.
5303 5304 5305 5306 5307 5308 5309 5310 5311

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

### IssuableSeverity

5312
Incident severity.
5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323

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

### IssuableState

5324
State of a GitLab issue or merge request.
5325 5326 5327

| Value | Description |
| ----- | ----------- |
5328 5329 5330 5331
| `all` | All available |
| `closed` | In closed state |
| `locked` | Discussion has been locked |
| `opened` | In open state |
5332 5333 5334

### IssueSort

5335
Values for sorting issues.
5336 5337 5338

| Value | Description |
| ----- | ----------- |
5339 5340
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
5341 5342 5343 5344 5345 5346 5347 5348
| `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 |
5349 5350
| `PUBLISHED_ASC` | Published issues shown last |
| `PUBLISHED_DESC` | Published issues shown first |
5351
| `RELATIVE_POSITION_ASC` | Relative position by ascending order |
5352 5353
| `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
5354 5355
| `SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first |
| `SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first |
5356 5357
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
5358 5359
| `WEIGHT_ASC` | Weight by ascending order |
| `WEIGHT_DESC` | Weight by descending order |
5360 5361 5362 5363
| `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. |
5364 5365 5366

### IssueState

5367
State of a GitLab issue.
5368 5369 5370

| Value | Description |
| ----- | ----------- |
5371 5372 5373 5374
| `all` | All available |
| `closed` | In closed state |
| `locked` | Discussion has been locked |
| `opened` | In open state |
5375

5376 5377 5378 5379 5380 5381 5382 5383 5384
### IssueStateEvent

Values for issue state events.

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

5385 5386
### IssueType

5387
Issue type.
5388 5389 5390 5391 5392 5393 5394 5395 5396

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

### IterationState

5397
State of a GitLab iteration.
5398 5399 5400 5401 5402 5403 5404 5405 5406

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

5407 5408 5409 5410 5411 5412 5413
### IterationWildcardId

Iteration ID wildcard values.

| Value | Description |
| ----- | ----------- |
| `ANY` | An iteration is assigned |
5414
| `CURRENT` | Current iteration |
5415 5416
| `NONE` | No iteration is assigned |

5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448
### 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` |  |

5449 5450
### ListLimitMetric

5451
List limit metric setting.
5452 5453 5454 5455 5456 5457 5458 5459 5460

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

### MeasurementIdentifier

5461
Possible identifier types for a measurement.
5462 5463 5464 5465 5466 5467 5468

| Value | Description |
| ----- | ----------- |
| `GROUPS` | Group count |
| `ISSUES` | Issue count |
| `MERGE_REQUESTS` | Merge request count |
| `PIPELINES` | Pipeline count |
5469 5470 5471 5472
| `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 |
5473 5474 5475
| `PROJECTS` | Project count |
| `USERS` | User count |

5476 5477
### MergeRequestNewState

5478
New state to apply to a merge request.
5479 5480 5481 5482 5483 5484

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

5485 5486
### MergeRequestSort

5487
Values for sorting merge requests.
5488 5489 5490

| Value | Description |
| ----- | ----------- |
5491 5492
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
5493 5494 5495 5496 5497 5498 5499 5500
| `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 |
5501 5502
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
5503 5504 5505 5506
| `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. |
5507 5508 5509

### MergeRequestState

5510
State of a GitLab merge request.
5511 5512 5513

| Value | Description |
| ----- | ----------- |
5514 5515 5516
| `all` | All available |
| `closed` | In closed state |
| `locked` | Discussion has been locked |
5517
| `merged` | Merge Request has been merged |
5518
| `opened` | In open state |
5519 5520 5521

### MilestoneStateEnum

5522 5523
Current state of milestone.

5524 5525
| Value | Description |
| ----- | ----------- |
5526 5527
| `active` | Milestone is currently active |
| `closed` | Milestone is closed |
5528 5529 5530

### MoveType

5531
The position to which the adjacent object should be moved.
5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549

| 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

5550
Values for sorting projects.
5551 5552 5553 5554

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

5557 5558 5559 5560 5561 5562
### OncallRotationUnitEnum

Rotation length unit of an on-call rotation.

| Value | Description |
| ----- | ----------- |
5563 5564 5565
| `DAYS` | Days |
| `HOURS` | Hours |
| `WEEKS` | Weeks |
5566

5567 5568 5569 5570
### PackageTypeEnum

| Value | Description |
| ----- | ----------- |
ggelatti's avatar
ggelatti committed
5571 5572 5573 5574 5575 5576
| `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 |
5577
| `NPM` | Packages from the npm package manager |
ggelatti's avatar
ggelatti committed
5578
| `NUGET` | Packages from the Nuget package manager |
5579
| `PYPI` | Packages from the PyPI package manager |
5580
| `RUBYGEMS` | Packages from the Rubygems package manager |
5581 5582 5583 5584 5585 5586 5587

### PipelineConfigSourceEnum

| Value | Description |
| ----- | ----------- |
| `AUTO_DEVOPS_SOURCE` |  |
| `BRIDGE_SOURCE` |  |
5588
| `COMPLIANCE_SOURCE` |  |
5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611
| `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` |  |

5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622
### ProjectMemberRelation

Project member relation.

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

5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635
### 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

5636
Type of the link: `other`, `runbook`, `image`, `package`.
5637 5638 5639 5640 5641 5642 5643 5644

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

5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655
### 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 |

5656 5657
### RequirementState

5658
State of a requirement.
5659 5660 5661 5662 5663 5664 5665 5666

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

### SastUiComponentSize

5667
Size of UI component in SAST configuration page.
5668 5669 5670

| Value | Description |
| ----- | ----------- |
5671 5672 5673
| `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. |
5674

5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686
### 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 |

5687 5688 5689 5690 5691 5692
### SecurityScannerType

The type of the security scanner.

| Value | Description |
| ----- | ----------- |
5693
| `API_FUZZING` |  |
5694 5695 5696 5697 5698 5699 5700 5701 5702
| `CONTAINER_SCANNING` |  |
| `COVERAGE_FUZZING` |  |
| `DAST` |  |
| `DEPENDENCY_SCANNING` |  |
| `SAST` |  |
| `SECRET_DETECTION` |  |

### SentryErrorStatus

5703
State of a Sentry error.
5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715

| 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 |
| ----- | ----------- |
5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751
| `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 |
5752 5753 5754

### SnippetBlobActionEnum

5755
Type of a snippet blob input action.
5756 5757 5758 5759 5760 5761 5762 5763 5764 5765

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

### Sort

5766
Common sort values.
5767 5768 5769

| Value | Description |
| ----- | ----------- |
5770 5771 5772 5773
| `CREATED_ASC` | Created at ascending order |
| `CREATED_DESC` | Created at descending order |
| `UPDATED_ASC` | Updated at ascending order |
| `UPDATED_DESC` | Updated at descending order |
5774 5775 5776 5777
| `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. |
5778 5779 5780

### TestReportState

5781
State of a test report.
5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803

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

### TodoActionEnum

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

### TodoStateEnum

| Value | Description |
| ----- | ----------- |
5804 5805
| `done` | The state of the todo is done. |
| `pending` | The state of the todo is pending. |
5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826

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

5827
Possible states of a user.
5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838

| 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 |
| ----- | ----------- |
5839 5840 5841
| `internal` | Internal visibility level. |
| `private` | Private visibility level. |
| `public` | Public visibility level. |
5842 5843 5844 5845 5846 5847 5848 5849 5850

### VisibilityScopesEnum

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

5851 5852 5853 5854 5855 5856
### VulnerabilityDismissalReason

The dismissal reason of the Vulnerability.

| Value | Description |
| ----- | ----------- |
5857 5858 5859 5860 5861
| `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 |
5862

5863 5864 5865 5866 5867 5868 5869 5870
### VulnerabilityExternalIssueLinkExternalTracker

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

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

5871 5872 5873 5874 5875 5876 5877 5878
### VulnerabilityExternalIssueLinkType

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

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

5879 5880
### VulnerabilityGrade

5881
The grade of the vulnerable project.
5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905

| 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 |
| ----- | ----------- |
5906
| `API_FUZZING` |  |
5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928
| `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

5929
Vulnerability sort values.
5930 5931 5932

| Value | Description |
| ----- | ----------- |
5933 5934
| `detected_asc` | Detection timestamp in ascending order |
| `detected_desc` | Detection timestamp in descending order |
5935 5936
| `report_type_asc` | Report Type in ascending order |
| `report_type_desc` | Report Type in descending order |
5937 5938
| `severity_asc` | Severity in ascending order |
| `severity_desc` | Severity in descending order |
5939 5940
| `state_asc` | State in ascending order |
| `state_desc` | State in descending order |
5941 5942
| `title_asc` | Title in ascending order |
| `title_desc` | Title in descending order |
5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953

### VulnerabilityState

The state of the vulnerability.

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