merge_requests.md 33.9 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 68
    "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
    },
    "merge_when_build_succeeds": true,
69
    "merge_status": "can_be_merged",
70
    "subscribed" : false,
71 72
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
73 74
    "user_notes_count": 1,
    "should_remove_source_branch": true,
75 76
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
77
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
78 79 80
]
```

81 82
## Get single MR

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

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

Parameters:

91 92
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of MR
Valeriy Sizov's avatar
Valeriy Sizov committed
93 94 95

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
96 97 98 99 100 101 102 103 104 105 106 107
  "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",
108
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
109 110 111 112 113 114 115
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
116
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
117 118 119
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
120
  },
Ben Boeckel's avatar
Ben Boeckel committed
121 122
  "source_project_id": 2,
  "target_project_id": 3,
123
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
124
  "description": "fixed login page css paddings",
125 126 127 128 129 130 131 132 133 134 135 136 137
  "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
  },
  "merge_when_build_succeeds": true,
138
  "merge_status": "can_be_merged",
139
  "subscribed" : true,
140 141
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
142 143
  "user_notes_count": 1,
  "should_remove_source_branch": true,
144 145
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
146 147 148
}
```

149 150
## Get single MR commits

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

```
154
GET /projects/:id/merge_requests/:merge_request_id/commits
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
```

Parameters:

- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of MR


```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
172
    "message": "Replace sanitize with escape once"
173 174 175 176 177 178 179 180
  },
  {
    "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
181
    "message": "Sanitize for network graph"
182 183 184 185
  }
]
```

186 187
## Get single MR changes

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

```
191
GET /projects/:id/merge_requests/:merge_request_id/changes
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 222 223 224 225 226 227 228
```

Parameters:

- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of MR

```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": [ ],
229 230
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
231 232 233 234 235 236 237 238 239 240 241
  "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
  },
242 243
  "merge_when_build_succeeds": true,
  "merge_status": "can_be_merged",
244
  "subscribed" : true,
245 246
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
247
  "user_notes_count": 1,
248 249
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
250
  "web_url": "http://example.com/example/example/merge_requests/1",
251
  "changes": [
252 253 254 255 256 257 258 259 260 261 262 263 264 265
    {
    "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
266 267
## Create MR

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

273 274 275 276 277 278 279 280 281 282 283 284
| 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
285 286 287

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

## Update MR

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

```
346
PUT /projects/:id/merge_requests/:merge_request_id
Valeriy Sizov's avatar
Valeriy Sizov committed
347 348
```

349 350 351 352
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`            | string  | yes | The ID of a project |
| `merge_request_id` | integer  | yes | The ID of a merge request |
353 354
| `target_branch` | string  | no | The target branch |
| `title`         | string  | no | Title of MR |
355 356
| `assignee_id`   | integer | no  | Assignee user ID |
| `description`   | string  | no  | Description of MR |
357
| `state_event` | string  | no | New state (close/reopen) |
358 359 360
| `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
361

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

Valeriy Sizov's avatar
Valeriy Sizov committed
364 365
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
366
  "id": 1,
367
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
368 369 370 371 372 373 374 375 376
  "target_branch": "master",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
377
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
378 379 380 381 382 383 384
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
385
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
386 387 388
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
  },
  "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
  },
  "merge_when_build_succeeds": true,
407
  "merge_status": "can_be_merged",
408
  "subscribed" : true,
409 410
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
411 412
  "user_notes_count": 1,
  "should_remove_source_branch": true,
413 414
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
415 416
}
```
417

418 419 420
## 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
421 422 423 424 425 426 427 428 429 430

```
DELETE /projects/:id/merge_requests/:merge_request_id
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`            | integer | yes | The ID of a project |
| `merge_request_id` | integer | yes | The ID of a project's merge request |

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

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

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


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

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

444
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'
445

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

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

Parameters:

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

```json
{
  "id": 1,
464
  "iid": 1,
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
  "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"
487 488 489 490
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
491
  "description": "fixed login page css paddings",
492 493 494 495 496 497 498 499 500 501 502 503 504
  "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
  },
  "merge_when_build_succeeds": true,
505
  "merge_status": "can_be_merged",
506
  "subscribed" : true,
507 508
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
509 510
  "user_notes_count": 1,
  "should_remove_source_branch": true,
511 512
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
513 514 515
}
```

516
## Cancel Merge When Pipeline Succeeds
517

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

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

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

- `id` (required)                           - The ID of a project
- `merge_request_id` (required)             - ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
530 531 532 533

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

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

588
Comments are done via the [notes](notes.md) resource.
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603

## List issues that will close on merge

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

```
GET /projects/:id/merge_requests/:merge_request_id/closes_issues
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `merge_request_id` | integer | yes   | The ID of the merge request |

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

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

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
617
         "web_url" : "https://gitlab.example.com/eileen.lowe",
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
         "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",
638
         "web_url" : "https://gitlab.example.com/root",
639 640 641 642 643 644 645 646
         "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,
647 648
      "labels" : [],
      "user_notes_count": 1
649 650 651
   },
]
```
652

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

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

664 665
## Subscribe to a merge request

666 667
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.
668 669

```
Robert Schilling's avatar
Robert Schilling committed
670
POST /projects/:id/merge_requests/:merge_request_id/subscribe
671 672 673 674 675 676 677 678
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `merge_request_id` | integer | yes   | The ID of the merge request |

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

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",
704
    "web_url": "https://gitlab.example.com/leila"
705 706 707 708 709 710 711
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
712
    "web_url": "https://gitlab.example.com/carli"
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
  },
  "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
  },
  "merge_when_build_succeeds": false,
  "merge_status": "cannot_be_merged",
731 732 733
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
734 735
}
```
736

737 738
## Unsubscribe from a merge request

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

```
744
POST /projects/:id/merge_requests/:merge_request_id/unsubscribe
745 746 747 748 749 750 751 752
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `merge_request_id` | integer | yes   | The ID of the merge request |

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

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",
778
    "web_url": "https://gitlab.example.com/leila"
779 780 781 782 783 784 785
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
786
    "web_url": "https://gitlab.example.com/carli"
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
  },
  "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
  },
  "merge_when_build_succeeds": false,
  "merge_status": "cannot_be_merged",
805 806 807
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
808 809
}
```
810 811 812

## Create a todo

813
Manually creates a todo for the current user on a merge request.
814
If there already exists a todo for the user on that merge request,
815 816 817 818 819 820 821 822 823 824 825 826
status code `304` is returned.

```
POST /projects/:id/merge_requests/:merge_request_id/todo
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `merge_request_id` | integer | yes   | The ID of the merge request |

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

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",
848
    "web_url": "https://gitlab.example.com/root"
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
  },
  "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",
871
      "web_url": "https://gitlab.example.com/francisca"
872 873 874 875 876 877 878
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
879
      "web_url": "https://gitlab.example.com/barrett.krajcik"
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
    },
    "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
    },
    "merge_when_build_succeeds": false,
    "merge_status": "unchecked",
    "subscribed": true,
899 900
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
901 902
    "user_notes_count": 7,
    "should_remove_source_branch": true,
903 904
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
905 906 907 908 909 910 911
  },
  "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"
}
```
912 913 914 915 916 917 918 919 920

## Get MR diff versions

Get a list of merge request diff versions.

```
GET /projects/:id/merge_requests/:merge_request_id/versions
```

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

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

930
Example response:
931 932 933

```json
[{
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
  "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.

```
GET /projects/:id/merge_requests/:merge_request_id/versions/:version_id
```

| Attribute | Type    | Required | Description           |
| --------- | ------- | -------- | --------------------- |
| `id`      | String  | yes      | The ID of the project |
| `merge_request_id` | integer | yes | The ID of the merge request |
| `version_id` | integer | yes | The ID of the merge request diff version |

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

Example response:

```json
{
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 1018
  "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
  }]
1019
}
1020
```
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
## Set a time estimate for a merge request

Sets an estimated time of work for this merge request.

```
POST /projects/:id/merge_requests/:merge_request_id/time_estimate
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `merge_request_id` | integer | yes | The ID of a project's merge request |
| `duration` | string | yes | The duration in human format. e.g: 3h30m |

```bash
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/93/time_estimate?duration=3h30m
```

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.

```
POST /projects/:id/merge_requests/:merge_request_id/reset_time_estimate
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `merge_request_id` | integer | yes | The ID of a project's merge_request |

```bash
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/93/reset_time_estimate
```

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

```
POST /projects/:id/merge_requests/:merge_request_id/add_spent_time
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `merge_request_id` | integer | yes | The ID of a project's merge request |
| `duration` | string | yes | The duration in human format. e.g: 3h30m |

```bash
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/93/add_spent_time?duration=1h
```

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.

```
POST /projects/:id/merge_requests/:merge_request_id/reset_spent_time
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `merge_request_id` | integer | yes | The ID of a project's merge_request |

```bash
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/93/reset_spent_time
```

Example response:

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

## Get time tracking stats

```
GET /projects/:id/merge_requests/:merge_request_id/time_stats
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `merge_request_id` | integer | yes | The ID of a project's merge request |

```bash
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/93/time_stats
```

Example response:

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