index.md 38.9 KB
Newer Older
Felipe Artur's avatar
Felipe Artur committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
<!---
  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).

## Objects

### AddAwardEmojiPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |

### AwardEmoji

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `name` | String! | The emoji name |
| `description` | String! | The emoji description |
| `unicode` | String! | The emoji in unicode |
| `emoji` | String! | The emoji as an icon |
| `unicodeVersion` | String! | The unicode version for this emoji |
| `user` | User! | The user who awarded the emoji |

### Blob

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `id` | ID! |  |
| `name` | String! |  |
| `type` | EntryType! |  |
| `path` | String! |  |
| `flatPath` | String! |  |
| `webUrl` | String |  |
| `lfsOid` | String |  |

### Commit

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
50 51 52 53 54 55 56 57 58 59
| `id` | ID! | ID (global ID) of the commit |
| `sha` | String! | SHA1 ID of the commit |
| `title` | String | Title of the commit message |
| `description` | String | Description of the commit message |
| `message` | String | Raw commit message |
| `authoredDate` | Time | Timestamp of when the commit was authored |
| `webUrl` | String! | Web URL of the commit |
| `signatureHtml` | String | Rendered HTML of the commit signature |
| `author` | User | Author of the commit |
| `latestPipeline` | Pipeline | Latest pipeline of the commit |
Felipe Artur's avatar
Felipe Artur committed
60

61 62 63 64 65 66 67 68
### CreateDiffNotePayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `note` | Note | The note after mutation |

69 70 71 72 73 74 75 76
### CreateEpicPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `epic` | Epic | The created epic |

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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 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
### CreateImageDiffNotePayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `note` | Note | The note after mutation |

### CreateNotePayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `note` | Note | The note after mutation |

### Design

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `id` | ID! |  |
| `project` | Project! |  |
| `issue` | Issue! |  |
| `notesCount` | Int! | The total count of user-created notes for this design |
| `filename` | String! |  |
| `fullPath` | String! |  |
| `event` | DesignVersionEvent! | The change that happened to the design at this version |
| `image` | String! |  |
| `diffRefs` | DiffRefs! |  |

### DesignCollection

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `project` | Project! |  |
| `issue` | Issue! |  |

### DesignManagementDeletePayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `version` | DesignVersion | The new version in which the designs are deleted |

### DesignManagementUploadPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `designs` | Design! => Array | The designs that were uploaded by the mutation |
| `skippedDesigns` | Design! => Array | Any designs that were skipped from the upload due to there being no change to their content since their last version |

### DesignVersion

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `id` | ID! |  |
| `sha` | ID! |  |

### DestroyNotePayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `note` | Note | The note after mutation |

Felipe Artur's avatar
Felipe Artur committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
### DetailedStatus

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `group` | String! |  |
| `icon` | String! |  |
| `favicon` | String! |  |
| `detailsPath` | String! |  |
| `hasDetails` | Boolean! |  |
| `label` | String! |  |
| `text` | String! |  |
| `tooltip` | String! |  |

### DiffPosition

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
163
| `diffRefs` | DiffRefs! |  |
Felipe Artur's avatar
Felipe Artur committed
164 165 166 167 168 169 170 171 172 173 174
| `filePath` | String! | The path of the file that was changed |
| `oldPath` | String | The path of the file on the start sha. |
| `newPath` | String | The path of the file on the head sha. |
| `positionType` | DiffPositionType! |  |
| `oldLine` | Int | The line on start sha that was changed |
| `newLine` | Int | The line on head sha that was changed |
| `x` | Int | The X postion on which the comment was made |
| `y` | Int | The Y position on which the comment was made |
| `width` | Int | The total width of the image |
| `height` | Int | The total height of the image |

175 176 177 178 179 180 181 182
### DiffRefs

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `headSha` | String! | The sha of the head at the time the comment was made |
| `baseSha` | String! | The merge base of the branch the comment was made on |
| `startSha` | String! | The sha of the branch being compared against |

Felipe Artur's avatar
Felipe Artur committed
183 184 185 186 187
### Discussion

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `id` | ID! |  |
188
| `replyId` | ID! | The ID used to reply to this discussion |
Felipe Artur's avatar
Felipe Artur committed
189 190
| `createdAt` | Time! |  |

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
### Epic

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `userPermissions` | EpicPermissions! | Permissions for the current user on the resource |
| `id` | ID! |  |
| `iid` | ID! |  |
| `title` | String |  |
| `description` | String |  |
| `state` | EpicState! |  |
| `group` | Group! |  |
| `parent` | Epic |  |
| `author` | User! |  |
| `startDate` | Time |  |
| `startDateIsFixed` | Boolean |  |
| `startDateFixed` | Time |  |
| `startDateFromMilestones` | Time |  |
| `dueDate` | Time |  |
| `dueDateIsFixed` | Boolean |  |
| `dueDateFixed` | Time |  |
| `dueDateFromMilestones` | Time |  |
| `closedAt` | Time |  |
| `createdAt` | Time |  |
| `updatedAt` | Time |  |
| `hasChildren` | Boolean! |  |
| `hasIssues` | Boolean! |  |
| `webPath` | String! |  |
| `webUrl` | String! |  |
| `relativePosition` | Int | The relative position of the epic in the Epic tree |
| `relationPath` | String |  |
| `reference` | String! |  |
222
| `subscribed` | Boolean! | Boolean flag for whether the currently logged in user is subscribed to this epic |
223 224 225 226 227 228

### EpicIssue

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
229 230
| `iid` | ID! | Internal ID of the issue |
| `title` | String! | Title of the issue |
231
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
232
| `description` | String | Description of the issue |
233
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
234 235 236 237 238 239 240 241 242 243 244 245 246 247
| `state` | IssueState! | State of the issue |
| `reference` | String! | Internal reference of the issue. Returned in shortened format by default |
| `author` | User! | User that created the issue |
| `milestone` | Milestone | Milestone of the issue |
| `dueDate` | Time | Due date of the issue |
| `confidential` | Boolean! | Indicates the issue is confidential |
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue |
| `upvotes` | Int! | Number of upvotes the issue has received |
| `downvotes` | Int! | Number of downvotes the issue has received |
| `userNotesCount` | Int! | Number of user notes of the issue |
| `webPath` | String! | Web path of the issue |
| `webUrl` | String! | Web URL of the issue |
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) |
| `timeEstimate` | Int! | Time estimate of the issue |
248
| `totalTimeSpent` | Int! | Total time reported as spent on the issue |
249 250 251 252
| `closedAt` | Time | Timestamp of when the issue was closed |
| `createdAt` | Time! | Timestamp of when the issue was created |
| `updatedAt` | Time! | Timestamp of when the issue was last updated |
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
| `epic` | Epic | The epic to which issue belongs |
| `weight` | Int |  |
| `designs` | DesignCollection |  |
| `designCollection` | DesignCollection |  |
| `epicIssueId` | ID! |  |
| `relationPath` | String |  |
| `id` | ID | The global id of the epic-issue relation |

### EpicPermissions

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `readEpic` | Boolean! | Whether or not a user can perform `read_epic` on this resource |
| `readEpicIid` | Boolean! | Whether or not a user can perform `read_epic_iid` on this resource |
| `updateEpic` | Boolean! | Whether or not a user can perform `update_epic` on this resource |
| `destroyEpic` | Boolean! | Whether or not a user can perform `destroy_epic` on this resource |
| `adminEpic` | Boolean! | Whether or not a user can perform `admin_epic` on this resource |
| `createEpic` | Boolean! | Whether or not a user can perform `create_epic` on this resource |
| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource |
| `awardEmoji` | Boolean! | Whether or not a user can perform `award_emoji` on this resource |

274 275 276 277 278 279 280 281
### EpicSetSubscriptionPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `epic` | Epic | The epic after mutation |

282 283 284 285 286 287 288 289 290 291 292 293
### EpicTreeReorderPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |

### ExtendedIssue

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
294 295
| `iid` | ID! | Internal ID of the issue |
| `title` | String! | Title of the issue |
296
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
297
| `description` | String | Description of the issue |
298
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
299 300 301 302 303 304 305 306 307 308 309 310 311 312
| `state` | IssueState! | State of the issue |
| `reference` | String! | Internal reference of the issue. Returned in shortened format by default |
| `author` | User! | User that created the issue |
| `milestone` | Milestone | Milestone of the issue |
| `dueDate` | Time | Due date of the issue |
| `confidential` | Boolean! | Indicates the issue is confidential |
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue |
| `upvotes` | Int! | Number of upvotes the issue has received |
| `downvotes` | Int! | Number of downvotes the issue has received |
| `userNotesCount` | Int! | Number of user notes of the issue |
| `webPath` | String! | Web path of the issue |
| `webUrl` | String! | Web URL of the issue |
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) |
| `timeEstimate` | Int! | Time estimate of the issue |
313
| `totalTimeSpent` | Int! | Total time reported as spent on the issue |
314 315 316 317
| `closedAt` | Time | Timestamp of when the issue was closed |
| `createdAt` | Time! | Timestamp of when the issue was created |
| `updatedAt` | Time! | Timestamp of when the issue was last updated |
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
318 319 320 321 322 323
| `epic` | Epic | The epic to which issue belongs |
| `weight` | Int |  |
| `designs` | DesignCollection |  |
| `designCollection` | DesignCollection |  |
| `subscribed` | Boolean! | Boolean flag for whether the currently logged in user is subscribed to this issue |

Felipe Artur's avatar
Felipe Artur committed
324 325 326 327
### Group

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
328 329 330 331 332 333
| `id` | ID! | ID of the namespace |
| `name` | String! | Name of the namespace |
| `path` | String! | Path of the namespace |
| `fullName` | String! | Full name of the namespace |
| `fullPath` | ID! | Full path of the namespace |
| `description` | String | Description of the namespace |
Felipe Artur's avatar
Felipe Artur committed
334
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
335 336 337 338
| `visibility` | String | Visibility of the namespace |
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace |
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace |
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces |
Felipe Artur's avatar
Felipe Artur committed
339
| `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |
340 341 342
| `webUrl` | String! | Web URL of the group |
| `avatarUrl` | String | Avatar URL of the group |
| `parent` | Group | Parent group |
343 344
| `epicsEnabled` | Boolean |  |
| `epic` | Epic |  |
Felipe Artur's avatar
Felipe Artur committed
345 346 347 348 349 350 351 352 353 354 355 356

### GroupPermissions

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `readGroup` | Boolean! | Whether or not a user can perform `read_group` on this resource |

### Issue

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `userPermissions` | IssuePermissions! | Permissions for the current user on the resource |
357 358
| `iid` | ID! | Internal ID of the issue |
| `title` | String! | Title of the issue |
Felipe Artur's avatar
Felipe Artur committed
359
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
360
| `description` | String | Description of the issue |
Felipe Artur's avatar
Felipe Artur committed
361
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
362 363 364 365 366 367 368 369 370 371 372 373 374 375
| `state` | IssueState! | State of the issue |
| `reference` | String! | Internal reference of the issue. Returned in shortened format by default |
| `author` | User! | User that created the issue |
| `milestone` | Milestone | Milestone of the issue |
| `dueDate` | Time | Due date of the issue |
| `confidential` | Boolean! | Indicates the issue is confidential |
| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue |
| `upvotes` | Int! | Number of upvotes the issue has received |
| `downvotes` | Int! | Number of downvotes the issue has received |
| `userNotesCount` | Int! | Number of user notes of the issue |
| `webPath` | String! | Web path of the issue |
| `webUrl` | String! | Web URL of the issue |
| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) |
| `timeEstimate` | Int! | Time estimate of the issue |
376
| `totalTimeSpent` | Int! | Total time reported as spent on the issue |
377 378 379 380
| `closedAt` | Time | Timestamp of when the issue was closed |
| `createdAt` | Time! | Timestamp of when the issue was created |
| `updatedAt` | Time! | Timestamp of when the issue was last updated |
| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue |
381 382 383 384
| `epic` | Epic | The epic to which issue belongs |
| `weight` | Int |  |
| `designs` | DesignCollection |  |
| `designCollection` | DesignCollection |  |
Felipe Artur's avatar
Felipe Artur committed
385 386 387 388 389 390 391 392 393 394

### IssuePermissions

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `readIssue` | Boolean! | Whether or not a user can perform `read_issue` on this resource |
| `adminIssue` | Boolean! | Whether or not a user can perform `admin_issue` on this resource |
| `updateIssue` | Boolean! | Whether or not a user can perform `update_issue` on this resource |
| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource |
| `reopenIssue` | Boolean! | Whether or not a user can perform `reopen_issue` on this resource |
395 396 397
| `readDesign` | Boolean! | Whether or not a user can perform `read_design` on this resource |
| `createDesign` | Boolean! | Whether or not a user can perform `create_design` on this resource |
| `destroyDesign` | Boolean! | Whether or not a user can perform `destroy_design` on this resource |
Felipe Artur's avatar
Felipe Artur committed
398 399 400 401 402

### Label

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
403
| `description` | String | Description of the label (markdown rendered as HTML for caching) |
Felipe Artur's avatar
Felipe Artur committed
404
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
405 406 407
| `title` | String! | Content of the label |
| `color` | String! | Background color of the label |
| `textColor` | String! | Text color of the label |
Felipe Artur's avatar
Felipe Artur committed
408 409 410 411 412 413

### MergeRequest

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `userPermissions` | MergeRequestPermissions! | Permissions for the current user on the resource |
414 415 416
| `id` | ID! | ID of the merge request |
| `iid` | String! | Internal ID of the merge request |
| `title` | String! | Title of the merge request |
Felipe Artur's avatar
Felipe Artur committed
417
| `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` |
418
| `description` | String | Description of the merge request (markdown rendered as HTML for caching) |
Felipe Artur's avatar
Felipe Artur committed
419
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
| `state` | MergeRequestState! | State of the merge request |
| `createdAt` | Time! | Timestamp of when the merge request was created |
| `updatedAt` | Time! | Timestamp of when the merge request was last updated |
| `sourceProject` | Project | Source project of the merge request |
| `targetProject` | Project! | Target project of the merge request |
| `diffRefs` | DiffRefs | References of the base SHA, the head SHA, and the start SHA for this merge request |
| `project` | Project! | Alias for target_project |
| `projectId` | Int! | ID of the merge request project |
| `sourceProjectId` | Int | ID of the merge request source project |
| `targetProjectId` | Int! | ID of the merge request target project |
| `sourceBranch` | String! | Source branch of the merge request |
| `targetBranch` | String! | Target branch of the merge request |
| `workInProgress` | Boolean! | Indicates if the merge request is a work in progress (WIP) |
| `mergeWhenPipelineSucceeds` | Boolean | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS) |
| `diffHeadSha` | String | Diff head SHA of the merge request |
| `mergeCommitSha` | String | SHA of the merge request commit (set once merged) |
| `userNotesCount` | Int | User notes count of the merge request |
| `shouldRemoveSourceBranch` | Boolean | Indicates if the source branch of the merge request will be deleted after merge |
| `forceRemoveSourceBranch` | Boolean | Indicates if the project settings will lead to source branch deletion after merge |
| `mergeStatus` | String | Status of the merge request |
| `inProgressMergeCommitSha` | String | Commit SHA of the merge request if merge is in progress |
| `mergeError` | String | Error message due to a merge error |
| `allowCollaboration` | Boolean | Indicates if members of the target project can push to the fork |
| `shouldBeRebased` | Boolean! | Indicates if the merge request will be rebased |
| `rebaseCommitSha` | String | Rebase commit SHA of the merge request |
| `rebaseInProgress` | Boolean! | Indicates if there is a rebase currently in progress for the merge request |
| `mergeCommitMessage` | String | Deprecated - renamed to defaultMergeCommitMessage |
| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request |
| `mergeOngoing` | Boolean! | Indicates if a merge is currently occurring |
| `sourceBranchExists` | Boolean! | Indicates if the source branch of the merge request exists |
| `mergeableDiscussionsState` | Boolean | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged |
| `webUrl` | String | Web URL of the merge request |
| `upvotes` | Int! | Number of upvotes for the merge request |
| `downvotes` | Int! | Number of downvotes for the merge request |
| `headPipeline` | Pipeline | The pipeline running on the branch HEAD of the merge request |
| `milestone` | Milestone | The milestone of the merge request |
| `subscribed` | Boolean! | Indicates if the currently logged in user is subscribed to this merge request |
| `discussionLocked` | Boolean! | Indicates if comments on the merge request are locked to members only |
| `timeEstimate` | Int! | Time estimate of the merge request |
459
| `totalTimeSpent` | Int! | Total time reported as spent on the merge request |
460 461
| `reference` | String! | Internal reference of the merge request. Returned in shortened format by default |
| `taskCompletionStatus` | TaskCompletionStatus! | Completion status of tasks |
Felipe Artur's avatar
Felipe Artur committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475

### MergeRequestPermissions

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `readMergeRequest` | Boolean! | Whether or not a user can perform `read_merge_request` on this resource |
| `adminMergeRequest` | Boolean! | Whether or not a user can perform `admin_merge_request` on this resource |
| `updateMergeRequest` | Boolean! | Whether or not a user can perform `update_merge_request` on this resource |
| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource |
| `pushToSourceBranch` | Boolean! | Whether or not a user can perform `push_to_source_branch` on this resource |
| `removeSourceBranch` | Boolean! | Whether or not a user can perform `remove_source_branch` on this resource |
| `cherryPickOnCurrentMergeRequest` | Boolean! | Whether or not a user can perform `cherry_pick_on_current_merge_request` on this resource |
| `revertOnCurrentMergeRequest` | Boolean! | Whether or not a user can perform `revert_on_current_merge_request` on this resource |

476 477 478 479 480 481 482 483
### MergeRequestSetMilestonePayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `mergeRequest` | MergeRequest | The merge request after mutation |

Felipe Artur's avatar
Felipe Artur committed
484 485 486 487 488 489 490 491 492 493 494 495
### MergeRequestSetWipPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `mergeRequest` | MergeRequest | The merge request after mutation |

### Metadata

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
496 497
| `version` | String! | Version |
| `revision` | String! | Revision |
Felipe Artur's avatar
Felipe Artur committed
498 499 500 501 502

### Milestone

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
503
| `id` | ID! | ID of the milestone |
504 505 506 507 508 509 510
| `description` | String | Description of the milestone |
| `title` | String! | Title of the milestone |
| `state` | String! | State of the milestone |
| `dueDate` | Time | Timestamp of the milestone due date |
| `startDate` | Time | Timestamp of the milestone start date |
| `createdAt` | Time! | Timestamp of milestone creation |
| `updatedAt` | Time! | Timestamp of last milestone update |
Felipe Artur's avatar
Felipe Artur committed
511 512 513 514 515

### Namespace

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
516 517 518 519 520 521
| `id` | ID! | ID of the namespace |
| `name` | String! | Name of the namespace |
| `path` | String! | Path of the namespace |
| `fullName` | String! | Full name of the namespace |
| `fullPath` | ID! | Full path of the namespace |
| `description` | String | Description of the namespace |
Felipe Artur's avatar
Felipe Artur committed
522
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
523 524 525 526
| `visibility` | String | Visibility of the namespace |
| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace |
| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace |
| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces |
Felipe Artur's avatar
Felipe Artur committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597

### Note

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `userPermissions` | NotePermissions! | Permissions for the current user on the resource |
| `id` | ID! |  |
| `project` | Project | The project this note is associated to |
| `author` | User! | The user who wrote this note |
| `resolvedBy` | User | The user that resolved the discussion |
| `system` | Boolean! | Whether or not this note was created by the system or by a user |
| `body` | String! | The content note itself |
| `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` |
| `createdAt` | Time! |  |
| `updatedAt` | Time! |  |
| `discussion` | Discussion | The discussion this note is a part of |
| `resolvable` | Boolean! |  |
| `resolvedAt` | Time | The time the discussion was resolved |
| `position` | DiffPosition | The position of this note on a diff |

### NotePermissions

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `readNote` | Boolean! | Whether or not a user can perform `read_note` on this resource |
| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource |
| `adminNote` | Boolean! | Whether or not a user can perform `admin_note` on this resource |
| `resolveNote` | Boolean! | Whether or not a user can perform `resolve_note` on this resource |
| `awardEmoji` | Boolean! | Whether or not a user can perform `award_emoji` on this resource |

### PageInfo

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `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. |
| `endCursor` | String | When paginating forwards, the cursor to continue. |

### Pipeline

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource |
| `id` | ID! |  |
| `iid` | String! |  |
| `sha` | String! |  |
| `beforeSha` | String |  |
| `status` | PipelineStatusEnum! |  |
| `detailedStatus` | DetailedStatus! |  |
| `duration` | Int | Duration of the pipeline in seconds |
| `coverage` | Float | Coverage percentage |
| `createdAt` | Time! |  |
| `updatedAt` | Time! |  |
| `startedAt` | Time |  |
| `finishedAt` | Time |  |
| `committedAt` | Time |  |

### PipelinePermissions

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `updatePipeline` | Boolean! | Whether or not a user can perform `update_pipeline` on this resource |
| `adminPipeline` | Boolean! | Whether or not a user can perform `admin_pipeline` on this resource |
| `destroyPipeline` | Boolean! | Whether or not a user can perform `destroy_pipeline` on this resource |

### Project

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource |
598 599 600 601 602 603
| `id` | ID! | ID of the project |
| `fullPath` | ID! | Full path of the project |
| `path` | String! | Path of the project |
| `nameWithNamespace` | String! | Full name of the project with its namespace |
| `name` | String! | Name of the project (without namespace) |
| `description` | String | Short description of the project |
Felipe Artur's avatar
Felipe Artur committed
604
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
| `tagList` | String | List of project tags |
| `sshUrlToRepo` | String | URL to connect to the project via SSH |
| `httpUrlToRepo` | String | URL to connect to the project via HTTPS |
| `webUrl` | String | Web URL of the project |
| `starCount` | Int! | Number of times the project has been starred |
| `forksCount` | Int! | Number of times the project has been forked |
| `createdAt` | Time | Timestamp of the project creation |
| `lastActivityAt` | Time | Timestamp of the project last activity |
| `archived` | Boolean | Archived status of the project |
| `visibility` | String | Visibility of the project |
| `containerRegistryEnabled` | Boolean | Indicates if the project stores Docker container images in a container registry |
| `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled on the project |
| `lfsEnabled` | Boolean | Indicates if the project has Large File Storage (LFS) enabled |
| `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. |
| `avatarUrl` | String | URL to avatar image file of the project |
| `issuesEnabled` | Boolean | (deprecated) Does this project have issues enabled?. Use `issues_access_level` instead |
| `mergeRequestsEnabled` | Boolean | (deprecated) Does this project have merge_requests enabled?. Use `merge_requests_access_level` instead |
| `wikiEnabled` | Boolean | (deprecated) Does this project have wiki enabled?. Use `wiki_access_level` instead |
| `snippetsEnabled` | Boolean | (deprecated) Does this project have snippets enabled?. Use `snippets_access_level` instead |
| `jobsEnabled` | Boolean | (deprecated) Enable jobs for this project. Use `builds_access_level` instead |
| `publicJobs` | Boolean | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts |
| `openIssuesCount` | Int | Number of open issues for the project |
| `importStatus` | String | Status of project import background job of the project |
| `onlyAllowMergeIfPipelineSucceeds` | Boolean | Indicates if merge requests of the project can only be merged with successful jobs |
| `requestAccessEnabled` | Boolean | Indicates if users can request member access to the project |
| `onlyAllowMergeIfAllDiscussionsAreResolved` | Boolean | Indicates if merge requests of the project can only be merged when all the discussions are resolved |
| `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 |
| `removeSourceBranchAfterMerge` | Boolean | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project |
| `namespace` | Namespace | Namespace of the project |
| `group` | Group | Group of the project |
| `statistics` | ProjectStatistics | Statistics of the project |
| `repository` | Repository | Git repository of the project |
| `mergeRequest` | MergeRequest | A single merge request of the project |
| `issue` | ExtendedIssue | A single issue of the project |
Felipe Artur's avatar
Felipe Artur committed
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680

### ProjectPermissions

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `changeNamespace` | Boolean! | Whether or not a user can perform `change_namespace` on this resource |
| `changeVisibilityLevel` | Boolean! | Whether or not a user can perform `change_visibility_level` on this resource |
| `renameProject` | Boolean! | Whether or not a user can perform `rename_project` on this resource |
| `removeProject` | Boolean! | Whether or not a user can perform `remove_project` on this resource |
| `archiveProject` | Boolean! | Whether or not a user can perform `archive_project` on this resource |
| `removeForkProject` | Boolean! | Whether or not a user can perform `remove_fork_project` on this resource |
| `removePages` | Boolean! | Whether or not a user can perform `remove_pages` on this resource |
| `readProject` | Boolean! | Whether or not a user can perform `read_project` on this resource |
| `createMergeRequestIn` | Boolean! | Whether or not a user can perform `create_merge_request_in` on this resource |
| `readWiki` | Boolean! | Whether or not a user can perform `read_wiki` on this resource |
| `readProjectMember` | Boolean! | Whether or not a user can perform `read_project_member` on this resource |
| `createIssue` | Boolean! | Whether or not a user can perform `create_issue` on this resource |
| `uploadFile` | Boolean! | Whether or not a user can perform `upload_file` on this resource |
| `readCycleAnalytics` | Boolean! | Whether or not a user can perform `read_cycle_analytics` on this resource |
| `downloadCode` | Boolean! | Whether or not a user can perform `download_code` on this resource |
| `downloadWikiCode` | Boolean! | Whether or not a user can perform `download_wiki_code` on this resource |
| `forkProject` | Boolean! | Whether or not a user can perform `fork_project` on this resource |
| `createProjectSnippet` | Boolean! | Whether or not a user can perform `create_project_snippet` on this resource |
| `readCommitStatus` | Boolean! | Whether or not a user can perform `read_commit_status` on this resource |
| `requestAccess` | Boolean! | Whether or not a user can perform `request_access` on this resource |
| `createPipeline` | Boolean! | Whether or not a user can perform `create_pipeline` on this resource |
| `createPipelineSchedule` | Boolean! | Whether or not a user can perform `create_pipeline_schedule` on this resource |
| `createMergeRequestFrom` | Boolean! | Whether or not a user can perform `create_merge_request_from` on this resource |
| `createWiki` | Boolean! | Whether or not a user can perform `create_wiki` on this resource |
| `pushCode` | Boolean! | Whether or not a user can perform `push_code` on this resource |
| `createDeployment` | Boolean! | Whether or not a user can perform `create_deployment` on this resource |
| `pushToDeleteProtectedBranch` | Boolean! | Whether or not a user can perform `push_to_delete_protected_branch` on this resource |
| `adminWiki` | Boolean! | Whether or not a user can perform `admin_wiki` on this resource |
| `adminProject` | Boolean! | Whether or not a user can perform `admin_project` on this resource |
| `updatePages` | Boolean! | Whether or not a user can perform `update_pages` on this resource |
| `adminRemoteMirror` | Boolean! | Whether or not a user can perform `admin_remote_mirror` on this resource |
| `createLabel` | Boolean! | Whether or not a user can perform `create_label` on this resource |
| `updateWiki` | Boolean! | Whether or not a user can perform `update_wiki` on this resource |
| `destroyWiki` | Boolean! | Whether or not a user can perform `destroy_wiki` on this resource |
| `createPages` | Boolean! | Whether or not a user can perform `create_pages` on this resource |
| `destroyPages` | Boolean! | Whether or not a user can perform `destroy_pages` on this resource |
| `readPagesContent` | Boolean! | Whether or not a user can perform `read_pages_content` on this resource |
681 682 683 684
| `adminOperations` | Boolean! | Whether or not a user can perform `admin_operations` on this resource |
| `readDesign` | Boolean! | Whether or not a user can perform `read_design` on this resource |
| `createDesign` | Boolean! | Whether or not a user can perform `create_design` on this resource |
| `destroyDesign` | Boolean! | Whether or not a user can perform `destroy_design` on this resource |
Felipe Artur's avatar
Felipe Artur committed
685 686 687 688 689

### ProjectStatistics

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
690 691 692 693 694 695 696
| `commitCount` | Int! | Commit count of the project |
| `storageSize` | Int! | Storage size of the project |
| `repositorySize` | Int! | Repository size of the project |
| `lfsObjectsSize` | Int! | Large File Storage (LFS) object size of the project |
| `buildArtifactsSize` | Int! | Build artifacts size of the project |
| `packagesSize` | Int! | Packages size of the project |
| `wikiSize` | Int | Wiki size of the project |
Felipe Artur's avatar
Felipe Artur committed
697 698 699 700 701 702 703 704 705 706 707 708 709

### RemoveAwardEmojiPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |

### Repository

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
710 711 712 713
| `rootRef` | String | Default branch of the repository |
| `empty` | Boolean! | Indicates repository has no visible content |
| `exists` | Boolean! | Indicates a corresponding Git repository exists on disk |
| `tree` | Tree | Tree of the repository |
Felipe Artur's avatar
Felipe Artur committed
714

715 716 717 718
### RootStorageStatistics

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
719 720 721 722 723 724
| `storageSize` | Int! | The total storage in bytes |
| `repositorySize` | Int! | The git repository size in bytes |
| `lfsObjectsSize` | Int! | The LFS objects size in bytes |
| `buildArtifactsSize` | Int! | The CI artifacts size in bytes |
| `packagesSize` | Int! | The packages size in bytes |
| `wikiSize` | Int! | The wiki size in bytes |
725

Felipe Artur's avatar
Felipe Artur committed
726 727 728 729 730 731 732 733 734
### Submodule

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `id` | ID! |  |
| `name` | String! |  |
| `type` | EntryType! |  |
| `path` | String! |  |
| `flatPath` | String! |  |
735 736
| `webUrl` | String |  |
| `treeUrl` | String |  |
Felipe Artur's avatar
Felipe Artur committed
737 738 739 740 741

### TaskCompletionStatus

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
742 743
| `count` | Int! | Number of total tasks |
| `completedCount` | Int! | Number of completed tasks |
Felipe Artur's avatar
Felipe Artur committed
744

745 746 747 748 749 750 751 752 753 754 755 756 757 758
### Todo

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `id` | ID! | Id of the todo |
| `project` | Project | The project this todo is associated with |
| `group` | Group | Group this todo is associated with |
| `author` | User! | The owner of this todo |
| `action` | TodoActionEnum! | Action of the todo |
| `targetType` | TodoTargetEnum! | Target type of the todo |
| `body` | String! | Body of the todo |
| `state` | TodoStateEnum! | State of the todo |
| `createdAt` | Time! | Timestamp this todo was created |

Felipe Artur's avatar
Felipe Artur committed
759 760 761 762 763 764 765 766 767 768 769 770 771
### ToggleAwardEmojiPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `awardEmoji` | AwardEmoji | The award emoji after mutation |
| `toggledOn` | Boolean! | True when the emoji was awarded, false when it was removed |

### Tree

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
772
| `lastCommit` | Commit | Last commit for the tree |
Felipe Artur's avatar
Felipe Artur committed
773 774 775 776 777 778 779 780 781 782 783 784

### TreeEntry

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `id` | ID! |  |
| `name` | String! |  |
| `type` | EntryType! |  |
| `path` | String! |  |
| `flatPath` | String! |  |
| `webUrl` | String |  |

785 786 787 788 789 790 791 792
### UpdateEpicPayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `epic` | Epic | The epic after mutation |

793 794 795 796 797 798 799 800
### UpdateNotePayload

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Reasons why the mutation failed. |
| `note` | Note | The note after mutation |

Felipe Artur's avatar
Felipe Artur committed
801 802 803 804
### User

| Name  | Type  | Description |
| ---   |  ---- | ----------  |
805 806 807 808
| `name` | String! | Human-readable name of the user |
| `username` | String! | Username of the user. Unique within this instance of GitLab |
| `avatarUrl` | String! | URL of the user's avatar |
| `webUrl` | String! | Web URL of the user |