merge_requests.md 37 KB
Newer Older
Marin Jankovski's avatar
Marin Jankovski committed
1 2
# Merge requests

Valeriy Sizov's avatar
Valeriy Sizov committed
3 4
## List merge requests

5
Get all merge requests for this project.
6
The `state` parameter can be used to get only merge requests with a given state (`opened`, `closed`, or `merged`) or all of them (`all`).
7
The pagination parameters `page` and `per_page` can be used to restrict the list of merge requests.
Valeriy Sizov's avatar
Valeriy Sizov committed
8 9

```
10
GET /projects/:id/merge_requests
11 12
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
13
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
Valeriy Sizov's avatar
Valeriy Sizov committed
14 15 16 17
```

Parameters:

18
- `id` (required) - The ID of a project
19
- `iid` (optional) - Return the request having the given `iid`
20
- `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed`
21 22
- `order_by` (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
Valeriy Sizov's avatar
Valeriy Sizov committed
23 24 25

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
26 27 28 29 30 31 32 33 34 35 36 37 38
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "username": "admin",
39
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
40 41 42 43 44 45 46
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
47
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
48 49 50
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
51
    },
Ben Boeckel's avatar
Ben Boeckel committed
52 53
    "source_project_id": 2,
    "target_project_id": 3,
54
    "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
55
    "description": "fixed login page css paddings",
56 57 58 59 60 61 62 63 64 65 66 67
    "work_in_progress": false,
    "milestone": {
      "id": 5,
      "iid": 1,
      "project_id": 3,
      "title": "v2.0",
      "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
      "state": "closed",
      "created_at": "2015-02-02T19:49:26.013Z",
      "updated_at": "2015-02-02T19:49:26.013Z",
      "due_date": null
    },
68
    "merge_when_pipeline_succeeds": true,
69
    "merge_status": "can_be_merged",
70 71
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
72 73
    "user_notes_count": 1,
    "should_remove_source_branch": true,
74 75
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
76
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
77 78 79
]
```

80 81
## Get single MR

82
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
83 84

```
85
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
86 87 88 89
```

Parameters:

90 91
- `iid` (required) - The ID of a project
- `merge_request_iid` (required) - The internal ID of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
92 93 94

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
95 96 97 98 99 100 101 102 103 104 105 106
  "id": 1,
  "iid": 1,
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
107
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
108 109 110 111 112 113 114
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
115
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
116 117 118
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
119
  },
Ben Boeckel's avatar
Ben Boeckel committed
120 121
  "source_project_id": 2,
  "target_project_id": 3,
122
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
123
  "description": "fixed login page css paddings",
124 125 126 127 128 129 130 131 132 133 134 135
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 3,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
136
  "merge_when_pipeline_succeeds": true,
137
  "merge_status": "can_be_merged",
138
  "subscribed" : true,
139 140
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
141 142
  "user_notes_count": 1,
  "should_remove_source_branch": true,
143 144
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
145 146 147
}
```

148 149
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
150
Get a list of merge request commits.
151 152

```
153
GET /projects/:id/merge_requests/:merge_request_iid/commits
154 155 156 157 158
```

Parameters:

- `id` (required) - The ID of a project
159
- `merge_request_iid` (required) - The internal ID of the merge request
160 161 162 163 164 165 166 167 168 169 170


```json
[
  {
    "id": "ed899a2f4b50b4370feeea94676502b42383c746",
    "short_id": "ed899a2f4b5",
    "title": "Replace sanitize with escape once",
    "author_name": "Dmitriy Zaporozhets",
    "author_email": "dzaporozhets@sphereconsultinginc.com",
    "created_at": "2012-09-20T11:50:22+03:00",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
171
    "message": "Replace sanitize with escape once"
172 173 174 175 176 177 178 179
  },
  {
    "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
    "short_id": "6104942438c",
    "title": "Sanitize for network graph",
    "author_name": "randx",
    "author_email": "dmitriy.zaporozhets@gmail.com",
    "created_at": "2012-09-20T09:06:12+03:00",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
180
    "message": "Sanitize for network graph"
181 182 183 184
  }
]
```

185 186
## Get single MR changes

187
Shows information about the merge request including its files and changes.
188 189

```
190
GET /projects/:id/merge_requests/:merge_request_iid/changes
191 192 193 194 195
```

Parameters:

- `id` (required) - The ID of a project
196
- `merge_request_iid` (required) - The internal ID of the merge request
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 222 223 224 225 226 227

```json
{
  "id": 21,
  "iid": 1,
  "project_id": 4,
  "title": "Blanditiis beatae suscipit hic assumenda et molestias nisi asperiores repellat et.",
  "state": "reopened",
  "created_at": "2015-02-02T19:49:39.159Z",
  "updated_at": "2015-02-02T20:08:49.959Z",
  "target_branch": "secret_token",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Chad Hamill",
    "username": "jarrett",
    "id": 5,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/b95567800f828948baf5f4160ebb2473?s=40&d=identicon"
  },
  "assignee": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon"
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
228 229
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
230 231 232 233 234 235 236 237 238 239 240
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
241
  "merge_when_pipeline_succeeds": true,
242
  "merge_status": "can_be_merged",
243
  "subscribed" : true,
244 245
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
246
  "user_notes_count": 1,
247 248
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
249
  "web_url": "http://example.com/example/example/merge_requests/1",
250
  "changes": [
251 252 253 254 255 256 257 258 259 260 261 262 263 264
    {
    "old_path": "VERSION",
    "new_path": "VERSION",
    "a_mode": "100644",
    "b_mode": "100644",
    "diff": "--- a/VERSION\ +++ b/VERSION\ @@ -1 +1 @@\ -1.9.7\ +1.9.8",
    "new_file": false,
    "renamed_file": false,
    "deleted_file": false
    }
  ]
}
```

Valeriy Sizov's avatar
Valeriy Sizov committed
265 266
## Create MR

267
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
268
```
269
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
270 271
```

272 273 274 275 276 277 278 279 280 281 282 283
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
| `id`                   | string  | yes      | The ID of a project                                                             |
| `source_branch`        | string  | yes      | The source branch                                                               |
| `target_branch`        | string  | yes      | The target branch                                                               |
| `title`                | string  | yes      | Title of MR                                                                     |
| `assignee_id`          | integer | no       | Assignee user ID                                                                |
| `description`          | string  | no       | Description of MR                                                               |
| `target_project_id`    | integer | no       | The target project (numeric id)                                                 |
| `labels`               | string  | no       | Labels for MR as a comma-separated list                                         |
| `milestone_id`         | integer | no       | The ID of a milestone                                                           |
| `remove_source_branch` | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
Valeriy Sizov's avatar
Valeriy Sizov committed
284 285 286

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
287
  "id": 1,
288
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
289 290 291 292 293 294 295 296 297 298
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
299
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
300 301 302 303 304 305 306
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
307
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
308 309 310
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
311
  },
312 313 314
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
315
  "description": "fixed login page css paddings",
316 317 318 319 320 321 322 323 324 325 326 327
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
328
  "merge_when_pipeline_succeeds": true,
329
  "merge_status": "can_be_merged",
330
  "subscribed" : true,
331 332
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
333 334
  "user_notes_count": 0,
  "should_remove_source_branch": true,
335 336
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
337 338 339 340 341
}
```

## Update MR

342
Updates an existing merge request. You can change the target branch, title, or even close the MR.
Valeriy Sizov's avatar
Valeriy Sizov committed
343 344

```
345
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
346 347
```

348 349 350 351 352 353 354 355 356 357 358 359
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
| `id`                   | string  | yes      | The ID of a project                                                             |
| `merge_request_iid`    | integer | yes      | The ID of a merge request                                                       |
| `target_branch`        | string  | no       | The target branch                                                               |
| `title`                | string  | no       | Title of MR                                                                     |
| `assignee_id`          | integer | no       | Assignee user ID                                                                |
| `description`          | string  | no       | Description of MR                                                               |
| `state_event`          | string  | no       | New state (close/reopen)                                                        |
| `labels`               | string  | no       | Labels for MR as a comma-separated list                                         |
| `milestone_id`         | integer | no       | The ID of a milestone                                                           |
| `remove_source_branch` | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
Valeriy Sizov's avatar
Valeriy Sizov committed
360

361 362
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
363 364
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
365
  "id": 1,
366
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
367 368 369 370 371 372 373 374 375
  "target_branch": "master",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
376
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
377 378 379 380 381 382 383
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
384
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
385 386 387
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
  "description": "description1",
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
405
  "merge_when_pipeline_succeeds": true,
406
  "merge_status": "can_be_merged",
407
  "subscribed" : true,
408 409
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
410 411
  "user_notes_count": 1,
  "should_remove_source_branch": true,
412 413
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
414 415
}
```
416

417 418 419
## Delete a merge request

Only for admins and project owners. Soft deletes the merge request in question.
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
420 421

```
422
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
423 424
```

425 426 427 428
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
| `id`                | integer | yes      | The ID of a project                  |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
429

430
```bash
431
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/4/merge_requests/85
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
432 433
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
434 435
## Accept MR

436
Merge changes submitted with MR using this API.
437 438


439
If it has some conflicts and can not be merged - you'll get a `405` and the error message 'Branch cannot be merged'
440

441
If merge request is already merged or closed - you'll get a `406` and the error message 'Method Not Allowed'
442

443
If the `sha` parameter is passed and does not match the HEAD of the source - you'll get a `409` and the error message 'SHA does not match HEAD of source branch'
444

445
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
446 447

```
448
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
449 450 451 452
```

Parameters:

453
- `id` (required)                           - The ID of a project
454
- `merge_request_iid` (required)            - Internal ID of MR
455 456
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
457
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
458
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
459 460 461 462

```json
{
  "id": 1,
463
  "iid": 1,
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
    "email": "admin@example.com",
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
    "email": "admin@example.com",
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
486 487 488 489
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
490
  "description": "fixed login page css paddings",
491 492 493 494 495 496 497 498 499 500 501 502
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
503
  "merge_when_pipeline_succeeds": true,
504
  "merge_status": "can_be_merged",
505
  "subscribed" : true,
506 507
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
508 509
  "user_notes_count": 1,
  "should_remove_source_branch": true,
510 511
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
512 513 514
}
```

515
## Cancel Merge When Pipeline Succeeds
516

517
If you don't have permissions to accept this merge request - you'll get a `401`
518

519
If the merge request is already merged or closed - you get `405` and error message 'Method Not Allowed'
520

521
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
522
```
523
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
524 525 526 527
```
Parameters:

- `id` (required)                           - The ID of a project
528
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
529 530 531 532

```json
{
  "id": 1,
533
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
534 535 536 537
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
538
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
539 540 541 542 543
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
544
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
545 546 547 548 549 550 551
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
552
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
553 554 555
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
556 557 558 559
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
560
  "description": "fixed login page css paddings",
561 562 563 564 565 566 567 568 569 570 571 572
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
573
  "merge_when_pipeline_succeeds": true,
574
  "merge_status": "can_be_merged",
575
  "subscribed" : true,
576 577
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
578 579
  "user_notes_count": 1,
  "should_remove_source_branch": true,
580 581
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
582 583 584
}
```

bb-froggy's avatar
typo  
bb-froggy committed
585
## Comments on merge requests
586

587
Comments are done via the [notes](notes.md) resource.
588 589 590 591 592 593

## List issues that will close on merge

Get all the issues that would be closed by merging the provided merge request.

```
594
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
595 596
```

597 598 599 600
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
| `id`                | integer | yes      | The ID of a project                  |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
601 602

```bash
603
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/76/merge_requests/1/closes_issues
604 605
```

606
Example response when the GitLab issue tracker is used:
607 608 609 610 611 612 613 614 615

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
616
         "web_url" : "https://gitlab.example.com/eileen.lowe",
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
         "name" : "Alexandra Bashirian",
         "avatar_url" : null,
         "username" : "eileen.lowe"
      },
      "milestone" : {
         "project_id" : 1,
         "description" : "Ducimus nam enim ex consequatur cumque ratione.",
         "state" : "closed",
         "due_date" : null,
         "iid" : 2,
         "created_at" : "2016-01-04T15:31:39.996Z",
         "title" : "v4.0",
         "id" : 17,
         "updated_at" : "2016-01-04T15:31:39.996Z"
      },
      "project_id" : 1,
      "assignee" : {
         "state" : "active",
         "id" : 1,
         "name" : "Administrator",
637
         "web_url" : "https://gitlab.example.com/root",
638 639 640 641 642 643 644 645
         "avatar_url" : null,
         "username" : "root"
      },
      "updated_at" : "2016-01-04T15:31:51.081Z",
      "id" : 76,
      "title" : "Consequatur vero maxime deserunt laboriosam est voluptas dolorem.",
      "created_at" : "2016-01-04T15:31:51.081Z",
      "iid" : 6,
646 647
      "labels" : [],
      "user_notes_count": 1
648 649 650
   },
]
```
651

652 653 654 655 656 657 658 659 660 661 662
Example response when an external issue tracker (e.g. JIRA) is used:

```json
[
   {
       "id" : "PROJECT-123",
       "title" : "Title of this issue"
   }
]
```

663 664
## Subscribe to a merge request

665 666
Subscribes the authenticated user to a merge request to receive notification. If the user is already subscribed to the merge request, the
status code `304` is returned.
667 668

```
669
POST /projects/:id/merge_requests/:merge_request_iid/subscribe
670 671
```

672 673 674 675
| Attribute           | Type    | Required | Description                 |
| ---------           | ----    | -------- | -----------                 |
| `id`                | integer | yes      | The ID of a project         |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
676 677

```bash
678
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
```

Example response:

```json
{
  "id": 17,
  "iid": 1,
  "project_id": 5,
  "title": "Et et sequi est impedit nulla ut rem et voluptatem.",
  "description": "Consequatur velit eos rerum optio autem. Quia id officia quaerat dolorum optio. Illo laudantium aut ipsum dolorem.",
  "state": "opened",
  "created_at": "2016-04-05T21:42:23.233Z",
  "updated_at": "2016-04-05T22:11:52.900Z",
  "target_branch": "ui-dev-kit",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Eileen Skiles",
    "username": "leila",
    "id": 19,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/39ce4a2822cc896933ffbd68c1470e55?s=80&d=identicon",
703
    "web_url": "https://gitlab.example.com/leila"
704 705 706 707 708 709 710
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
711
    "web_url": "https://gitlab.example.com/carli"
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
  },
  "source_project_id": 5,
  "target_project_id": 5,
  "labels": [],
  "work_in_progress": false,
  "milestone": {
    "id": 7,
    "iid": 1,
    "project_id": 5,
    "title": "v2.0",
    "description": "Corrupti eveniet et velit occaecati dolorem est rerum aut.",
    "state": "closed",
    "created_at": "2016-04-05T21:41:40.905Z",
    "updated_at": "2016-04-05T21:41:40.905Z",
    "due_date": null
  },
728
  "merge_when_pipeline_succeeds": false,
729
  "merge_status": "cannot_be_merged",
730 731 732
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
733 734
}
```
735

736 737
## Unsubscribe from a merge request

738
Unsubscribes the authenticated user from a merge request to not receive
739 740
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
741 742

```
743
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
744 745
```

746 747 748 749
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
| `id`                | integer | yes      | The ID of a project                  |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
750 751

```bash
752
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
```

Example response:

```json
{
  "id": 17,
  "iid": 1,
  "project_id": 5,
  "title": "Et et sequi est impedit nulla ut rem et voluptatem.",
  "description": "Consequatur velit eos rerum optio autem. Quia id officia quaerat dolorum optio. Illo laudantium aut ipsum dolorem.",
  "state": "opened",
  "created_at": "2016-04-05T21:42:23.233Z",
  "updated_at": "2016-04-05T22:11:52.900Z",
  "target_branch": "ui-dev-kit",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Eileen Skiles",
    "username": "leila",
    "id": 19,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/39ce4a2822cc896933ffbd68c1470e55?s=80&d=identicon",
777
    "web_url": "https://gitlab.example.com/leila"
778 779 780 781 782 783 784
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
785
    "web_url": "https://gitlab.example.com/carli"
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
  },
  "source_project_id": 5,
  "target_project_id": 5,
  "labels": [],
  "work_in_progress": false,
  "milestone": {
    "id": 7,
    "iid": 1,
    "project_id": 5,
    "title": "v2.0",
    "description": "Corrupti eveniet et velit occaecati dolorem est rerum aut.",
    "state": "closed",
    "created_at": "2016-04-05T21:41:40.905Z",
    "updated_at": "2016-04-05T21:41:40.905Z",
    "due_date": null
  },
802
  "merge_when_pipeline_succeeds": false,
803
  "merge_status": "cannot_be_merged",
804 805 806
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
807 808
}
```
809 810 811

## Create a todo

812
Manually creates a todo for the current user on a merge request.
813
If there already exists a todo for the user on that merge request,
814 815 816
status code `304` is returned.

```
817
POST /projects/:id/merge_requests/:merge_request_iid/todo
818 819
```

820 821 822 823
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
| `id`                | integer | yes      | The ID of a project                  |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
824 825

```bash
826
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
```

Example response:

```json
{
  "id": 113,
  "project": {
    "id": 3,
    "name": "Gitlab Ci",
    "name_with_namespace": "Gitlab Org / Gitlab Ci",
    "path": "gitlab-ci",
    "path_with_namespace": "gitlab-org/gitlab-ci"
  },
  "author": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
847
    "web_url": "https://gitlab.example.com/root"
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
  },
  "action_name": "marked",
  "target_type": "MergeRequest",
  "target": {
    "id": 27,
    "iid": 7,
    "project_id": 3,
    "title": "Et voluptas laudantium minus nihil recusandae ut accusamus earum aut non.",
    "description": "Veniam sunt nihil modi earum cumque illum delectus. Nihil ad quis distinctio quia. Autem eligendi at quibusdam repellendus.",
    "state": "opened",
    "created_at": "2016-06-17T07:48:04.330Z",
    "updated_at": "2016-07-01T11:14:15.537Z",
    "target_branch": "allow_regex_for_project_skip_ref",
    "source_branch": "backup",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "name": "Jarret O'Keefe",
      "username": "francisca",
      "id": 14,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon",
870
      "web_url": "https://gitlab.example.com/francisca"
871 872 873 874 875 876 877
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
878
      "web_url": "https://gitlab.example.com/barrett.krajcik"
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
    },
    "source_project_id": 3,
    "target_project_id": 3,
    "labels": [],
    "work_in_progress": false,
    "milestone": {
      "id": 27,
      "iid": 2,
      "project_id": 3,
      "title": "v1.0",
      "description": "Quis ea accusantium animi hic fuga assumenda.",
      "state": "active",
      "created_at": "2016-06-17T07:47:33.840Z",
      "updated_at": "2016-06-17T07:47:33.840Z",
      "due_date": null
    },
895
    "merge_when_pipeline_succeeds": false,
896 897
    "merge_status": "unchecked",
    "subscribed": true,
898 899
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
900 901
    "user_notes_count": 7,
    "should_remove_source_branch": true,
902 903
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
904 905 906 907 908 909 910
  },
  "target_url": "https://gitlab.example.com/gitlab-org/gitlab-ci/merge_requests/7",
  "body": "Et voluptas laudantium minus nihil recusandae ut accusamus earum aut non.",
  "state": "pending",
  "created_at": "2016-07-01T11:14:15.530Z"
}
```
911 912 913 914 915 916

## Get MR diff versions

Get a list of merge request diff versions.

```
917
GET /projects/:id/merge_requests/:merge_request_iid/versions
918 919
```

920 921 922 923
| Attribute           | Type    | Required | Description                 |
| ---------           | ------- | -------- | ---------------------       |
| `id`                | String  | yes      | The ID of the project       |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
924

925
```bash
926
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions
927
```
928

929
Example response:
930 931 932

```json
[{
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
  "id": 110,
  "head_commit_sha": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-26T14:44:48.926Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1"
}, {
  "id": 108,
  "head_commit_sha": "3eed087b29835c48015768f839d76e5ea8f07a24",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-25T14:21:33.028Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1"
}]
```

## Get a single MR diff version

Get a single merge request diff version.

```
958
GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id
959 960
```

961 962 963 964 965
| Attribute           | Type    | Required | Description                              |
| ---------           | ------- | -------- | ---------------------                    |
| `id`                | String  | yes      | The ID of the project                    |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `version_id`        | integer | yes      | The ID of the merge request diff version |
966 967

```bash
968
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1
969 970 971 972 973 974
```

Example response:

```json
{
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
  "id": 110,
  "head_commit_sha": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-26T14:44:48.926Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1",
  "commits": [{
    "id": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
    "short_id": "33e2ee85",
    "title": "Change year to 2018",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-26T17:44:29.000+03:00",
    "message": "Change year to 2018"
  }, {
    "id": "aa24655de48b36335556ac8a3cd8bb521f977cbd",
    "short_id": "aa24655d",
    "title": "Update LICENSE",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-25T17:21:53.000+03:00",
    "message": "Update LICENSE"
  }, {
    "id": "3eed087b29835c48015768f839d76e5ea8f07a24",
    "short_id": "3eed087b",
    "title": "Add license",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-25T17:21:20.000+03:00",
    "message": "Add license"
  }],
  "diffs": [{
    "old_path": "LICENSE",
    "new_path": "LICENSE",
    "a_mode": "0",
    "b_mode": "100644",
    "diff": "--- /dev/null\n+++ b/LICENSE\n@@ -0,0 +1,21 @@\n+The MIT License (MIT)\n+\n+Copyright (c) 2018 Administrator\n+\n+Permission is hereby granted, free of charge, to any person obtaining a copy\n+of this software and associated documentation files (the \"Software\"), to deal\n+in the Software without restriction, including without limitation the rights\n+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n+copies of the Software, and to permit persons to whom the Software is\n+furnished to do so, subject to the following conditions:\n+\n+The above copyright notice and this permission notice shall be included in all\n+copies or substantial portions of the Software.\n+\n+THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n+SOFTWARE.\n",
    "new_file": true,
    "renamed_file": false,
    "deleted_file": false
  }]
1018
}
1019
```
1020 1021 1022 1023 1024
## Set a time estimate for a merge request

Sets an estimated time of work for this merge request.

```
1025
POST /projects/:id/merge_requests/:merge_request_iid/time_estimate
1026 1027
```

1028 1029 1030 1031 1032
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
| `id`                | integer | yes      | The ID of a project                      |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1033 1034

```bash
1035
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_estimate?duration=3h30m
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
```

Example response:

```json
{
  "human_time_estimate": "3h 30m",
  "human_total_time_spent": null,
  "time_estimate": 12600,
  "total_time_spent": 0
}
```

## Reset the time estimate for a merge request

Resets the estimated time for this merge request to 0 seconds.

```
1054
POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate
1055 1056
```

1057 1058 1059 1060
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
| `id`                | integer | yes      | The ID of a project                          |
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1061 1062

```bash
1063
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_time_estimate
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": null,
  "time_estimate": 0,
  "total_time_spent": 0
}
```

## Add spent time for a merge request

Adds spent time for this merge request

```
1082
POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time
1083 1084
```

1085 1086 1087 1088 1089
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
| `id`                | integer | yes      | The ID of a project                      |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1090 1091

```bash
1092
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/add_spent_time?duration=1h
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": "1h",
  "time_estimate": 0,
  "total_time_spent": 3600
}
```

## Reset spent time for a merge request

Resets the total spent time for this merge request to 0 seconds.

```
1111
POST /projects/:id/merge_requests/:merge_request_iid/reset_spent_time
1112 1113
```

1114 1115 1116 1117
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
| `id`                | integer | yes      | The ID of a project                          |
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1118 1119

```bash
1120
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_spent_time
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": null,
  "time_estimate": 0,
  "total_time_spent": 0
}
```

## Get time tracking stats

```
1137
GET /projects/:id/merge_requests/:merge_request_iid/time_stats
1138 1139
```

1140 1141 1142 1143
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
| `id`                | integer | yes      | The ID of a project                  |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1144 1145

```bash
1146
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
```

Example response:

```json
{
  "human_time_estimate": "2h",
  "human_total_time_spent": "1h",
  "time_estimate": 7200,
  "total_time_spent": 3600
}
```