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

3 4
Every API call to merge requests must be authenticated.

Valeriy Sizov's avatar
Valeriy Sizov committed
5 6
## List merge requests

7 8 9 10 11 12
> [Introduced][ce-13060] in GitLab 9.5.

Get all merge requests the authenticated user has access to. By
default it returns only merge requests created by the current user. To
get all merge requests, use parameter `scope=all`.

13 14 15 16 17
The `state` parameter can be used to get only merge requests with a
given state (`opened`, `closed`, or `merged`) or all of them (`all`).
The pagination parameters `page` and `per_page` can be used to
restrict the list of merge requests.

18 19 20 21 22
**Note**: the `changes_count` value in the response is a string, not an
integer. This is because when an MR has too many changes to display and store,
it will be capped at 1,000. In that case, the API will return the string
`"1000+"` for the changes count.

23 24 25 26 27 28 29
```
GET /merge_requests
GET /merge_requests?state=opened
GET /merge_requests?state=all
GET /merge_requests?milestone=release
GET /merge_requests?labels=bug,reproduced
GET /merge_requests?author_id=5
30
GET /merge_requests?my_reaction_emoji=star
31 32 33 34 35
GET /merge_requests?scope=assigned-to-me
```

Parameters:

36 37 38 39 40 41 42 43 44 45 46 47 48
| Attribute           | Type     | Required | Description                                                                                                            |
| ------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `state`             | string   | no       | Return all merge requests or just those that are `opened`, `closed`, or `merged`                                       |
| `order_by`          | string   | no       | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                |
| `sort`              | string   | no       | Return requests sorted in `asc` or `desc` order. Default is `desc`                                                     |
| `milestone`         | string   | no       | Return merge requests for a specific milestone                                                                         |
| `view`              | string   | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                              |
| `labels`            | string   | no       | Return merge requests matching a comma separated list of labels                                                        |
| `created_after`     | datetime | no       | Return merge requests created after the given time (inclusive)                                                         |
| `created_before`    | datetime | no       | Return merge requests created before the given time (inclusive)                                                        |
| `scope`             | string   | no       | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all`. Defaults to `created-by-me`     |
| `author_id`         | integer  | no       | Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned-to-me`              |
| `assignee_id`       | integer  | no       | Returns merge requests assigned to the given user `id`                                                                 |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
49
| `my_reaction_emoji` | string   | no       | Return merge requests reacted by the authenticated user by the given `emoji` _([Introduced][ce-14016] in GitLab 10.0)_ |
50 51 52 53 54 55 56 57 58 59 60

```json
[
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
61 62
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    "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"
    },
    "source_project_id": 2,
    "target_project_id": 3,
    "labels": [ ],
    "description": "fixed login page css paddings",
    "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_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
102
    "changes_count": "1",
103 104
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
105 106 107 108 109 110 111
    "web_url": "http://example.com/example/example/merge_requests/1",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
112 113 114 115 116 117
  }
]
```

## List project merge requests

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

```
123
GET /projects/:id/merge_requests
124 125
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
126
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
127
GET /projects/:id/merge_requests?milestone=release
128
GET /projects/:id/merge_requests?labels=bug,reproduced
129
GET /projects/:id/merge_requests?my_reaction_emoji=star
Valeriy Sizov's avatar
Valeriy Sizov committed
130 131
```

132 133 134 135 136 137 138 139 140
`project_id` represents the ID of the project where the MR resides.
`project_id` will always equal `target_project_id`.

In the case of a merge request from the same project,
`source_project_id`, `target_project_id` and `project_id`
will be the same. In the case of a merge request from a fork,
`target_project_id` and `project_id` will be the same and
`source_project_id` will be the fork project's ID.

141 142 143 144 145
**Note**: the `changes_count` value in the response is a string, not an
integer. This is because when an MR has too many changes to display and store,
it will be capped at 1,000. In that case, the API will return the string
`"1000+"` for the changes count.

Valeriy Sizov's avatar
Valeriy Sizov committed
146 147
Parameters:

Hiroyuki Sato's avatar
Hiroyuki Sato committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
| Attribute           | Type           | Required | Description                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `id`                | integer        | yes      | The ID of a project                                                                                                            |
| `iids[]`            | Array[integer] | no       | Return the request having the given `iid`                                                                                      |
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, or `merged`                                               |
| `order_by`          | string         | no       | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                        |
| `sort`              | string         | no       | Return requests sorted in `asc` or `desc` order. Default is `desc`                                                             |
| `milestone`         | string         | no       | Return merge requests for a specific milestone                                                                                 |
| `view`              | string         | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                                      |
| `labels`            | string         | no       | Return merge requests matching a comma separated list of labels                                                                |
| `created_after`     | datetime       | no       | Return merge requests created after the given time (inclusive)                                                                 |
| `created_before`    | datetime       | no       | Return merge requests created before the given time (inclusive)                                                                |
| `scope`             | string         | no       | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all` _([Introduced][ce-13060] in GitLab 9.5)_ |
| `author_id`         | integer        | no       | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_                                 |
| `assignee_id`       | integer        | no       | Returns merge requests assigned to the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_                                |
| `my_reaction_emoji` | string         | no       | Return merge requests reacted by the authenticated user by the given `emoji` _([Introduced][ce-14016] in GitLab 10.0)_         |
Valeriy Sizov's avatar
Valeriy Sizov committed
164 165 166

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
167 168 169 170 171 172 173 174
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
175 176
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
177 178 179 180 181
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "username": "admin",
182
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
183 184 185 186 187 188 189
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
190
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
191 192 193
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
194
    },
Ben Boeckel's avatar
Ben Boeckel committed
195 196
    "source_project_id": 2,
    "target_project_id": 3,
197
    "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
198
    "description": "fixed login page css paddings",
199 200 201 202 203 204 205 206 207 208 209 210
    "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
    },
211
    "merge_when_pipeline_succeeds": true,
212
    "merge_status": "can_be_merged",
213 214
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
215
    "user_notes_count": 1,
216
    "changes_count": "1",
217
    "should_remove_source_branch": true,
218
    "force_remove_source_branch": false,
219
    "web_url": "http://example.com/example/example/merge_requests/1",
220
    "discussion_locked": false,
221 222 223 224 225 226
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
227
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
228 229 230
]
```

231 232
## Get single MR

233
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
234 235

```
236
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
237 238 239 240
```

Parameters:

241
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
242
- `merge_request_iid` (required) - The internal ID of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
243 244 245

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
246 247 248 249 250 251 252
  "id": 1,
  "iid": 1,
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
253 254
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
255 256 257 258 259
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
260
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
261 262 263 264 265 266 267
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
268
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
269 270 271
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
272
  },
Ben Boeckel's avatar
Ben Boeckel committed
273 274
  "source_project_id": 2,
  "target_project_id": 3,
275
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
276
  "description": "fixed login page css paddings",
277 278 279 280 281 282 283 284 285 286 287 288
  "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
  },
289
  "merge_when_pipeline_succeeds": true,
290
  "merge_status": "can_be_merged",
291
  "subscribed" : true,
292 293
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
294
  "user_notes_count": 1,
295
  "changes_count": "1",
296
  "should_remove_source_branch": true,
297
  "force_remove_source_branch": false,
298
  "web_url": "http://example.com/example/example/merge_requests/1",
299
  "discussion_locked": false,
300 301 302 303 304 305
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
306 307 308
}
```

309 310
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
311
Get a list of merge request commits.
312 313

```
314
GET /projects/:id/merge_requests/:merge_request_iid/commits
315 316 317 318
```

Parameters:

319
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
320
- `merge_request_iid` (required) - The internal ID of the merge request
321 322 323 324 325 326 327 328 329 330 331


```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
332
    "message": "Replace sanitize with escape once"
333 334 335 336 337 338 339 340
  },
  {
    "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
341
    "message": "Sanitize for network graph"
342 343 344 345
  }
]
```

346 347
## Get single MR changes

348
Shows information about the merge request including its files and changes.
349 350

```
351
GET /projects/:id/merge_requests/:merge_request_iid/changes
352 353 354 355
```

Parameters:

356
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
357
- `merge_request_iid` (required) - The internal ID of the merge request
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388

```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": [ ],
389 390
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
391 392 393 394 395 396 397 398 399 400 401
  "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
  },
402
  "merge_when_pipeline_succeeds": true,
403
  "merge_status": "can_be_merged",
404
  "subscribed" : true,
405 406
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
407
  "user_notes_count": 1,
408
  "changes_count": "1",
409 410
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
411
  "web_url": "http://example.com/example/example/merge_requests/1",
412
  "discussion_locked": false,
413 414 415 416 417 418
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
419
  "changes": [
420 421 422 423 424 425 426 427 428 429 430 431 432 433
    {
    "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
434 435
## Create MR

436
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
437
```
438
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
439 440
```

441 442
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
443
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
444 445 446 447 448 449 450 451 452
| `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
453 454 455

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
456
  "id": 1,
457
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
458 459 460 461 462 463 464 465 466 467
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
468
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
469 470 471 472 473 474 475
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
476
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
477 478 479
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
480
  },
481 482 483
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
484
  "description": "fixed login page css paddings",
485 486 487 488 489 490 491 492 493 494 495 496
  "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
  },
497
  "merge_when_pipeline_succeeds": true,
498
  "merge_status": "can_be_merged",
499
  "subscribed" : true,
500 501
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
502
  "user_notes_count": 0,
503
  "changes_count": "1",
504
  "should_remove_source_branch": true,
505
  "force_remove_source_branch": false,
506
  "web_url": "http://example.com/example/example/merge_requests/1",
507
  "discussion_locked": false,
508 509 510 511 512 513
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
514 515 516 517 518
}
```

## Update MR

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

```
522
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
523 524
```

525 526
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
527
| `id`                   | integer/string | yes  | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
528 529 530
| `merge_request_iid`    | integer | yes      | The ID of a merge request                                                       |
| `target_branch`        | string  | no       | The target branch                                                               |
| `title`                | string  | no       | Title of MR                                                                     |
531 532 533
| `assignee_id`          | integer | no       | The ID of the user to assign the merge request to. Set to `0` or provide an empty value to unassign all assignees.  |
| `milestone_id`         | integer | no       | The ID of a milestone to assign the merge request to. Set to `0` or provide an empty value to unassign a milestone.|
| `labels`               | string  | no       | Comma-separated label names for an merge request. Set to an empty string to unassign all labels.                   |
534 535 536
| `description`          | string  | no       | Description of MR                                                               |
| `state_event`          | string  | no       | New state (close/reopen)                                                        |
| `remove_source_branch` | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
537
| `discussion_locked`    | boolean | no       | Flag indicating if the merge request's discussion is locked. If the discussion is locked only project members can add, edit or resolve comments. |
Valeriy Sizov's avatar
Valeriy Sizov committed
538

539 540
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
541 542
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
543
  "id": 1,
544
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
545 546 547 548 549 550 551 552 553
  "target_branch": "master",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
554
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
555 556 557 558 559 560 561
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
562
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
563 564 565
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
  },
  "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
  },
583
  "merge_when_pipeline_succeeds": true,
584
  "merge_status": "can_be_merged",
585
  "subscribed" : true,
586 587
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
588
  "user_notes_count": 1,
589
  "changes_count": "1",
590
  "should_remove_source_branch": true,
591
  "force_remove_source_branch": false,
592
  "web_url": "http://example.com/example/example/merge_requests/1",
593
  "discussion_locked": false,
594 595 596 597 598 599
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
600 601
}
```
602

603 604 605
## 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
606 607

```
608
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
609 610
```

611 612 613
| Attribute | Type    | Required | Description                          |
| --------- | ----    | -------- | -----------                          |
| `id`      | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
614
| `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
615

616
```bash
617
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
618 619
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
620 621
## Accept MR

622
Merge changes submitted with MR using this API.
623 624


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

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

629
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'
630

631
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
632 633

```
634
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
635 636 637 638
```

Parameters:

639
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
640
- `merge_request_iid` (required)            - Internal ID of MR
641 642
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
643
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
644
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
645 646 647 648

```json
{
  "id": 1,
649
  "iid": 1,
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
  "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"
672 673 674 675
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
676
  "description": "fixed login page css paddings",
677 678 679 680 681 682 683 684 685 686 687 688
  "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
  },
689
  "merge_when_pipeline_succeeds": true,
690
  "merge_status": "can_be_merged",
691
  "subscribed" : true,
692 693
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
694
  "user_notes_count": 1,
695
  "changes_count": "1",
696
  "should_remove_source_branch": true,
697
  "force_remove_source_branch": false,
698
  "web_url": "http://example.com/example/example/merge_requests/1",
699
  "discussion_locked": false,
700 701 702 703 704 705
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
706 707 708
}
```

709
## Cancel Merge When Pipeline Succeeds
710

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

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

715
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
716
```
717
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
718 719 720
```
Parameters:

721
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
722
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
723 724 725 726

```json
{
  "id": 1,
727
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
728 729 730 731
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
732
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
733 734 735 736 737
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
738
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
739 740 741 742 743 744 745
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
746
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
747 748 749
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
750 751 752 753
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
754
  "description": "fixed login page css paddings",
755 756 757 758 759 760 761 762 763 764 765 766
  "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
  },
767
  "merge_when_pipeline_succeeds": true,
768
  "merge_status": "can_be_merged",
769
  "subscribed" : true,
770 771
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
772
  "user_notes_count": 1,
773
  "changes_count": "1",
774
  "should_remove_source_branch": true,
775
  "force_remove_source_branch": false,
776
  "web_url": "http://example.com/example/example/merge_requests/1",
777
  "discussion_locked": false,
778 779 780 781 782 783
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
784 785 786
}
```

bb-froggy's avatar
typo  
bb-froggy committed
787
## Comments on merge requests
788

789
Comments are done via the [notes](notes.md) resource.
790 791 792 793 794 795

## List issues that will close on merge

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

```
796
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
797 798
```

799 800
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
801
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
802
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
803 804

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

808
Example response when the GitLab issue tracker is used:
809 810 811 812 813 814 815 816 817

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
818
         "web_url" : "https://gitlab.example.com/eileen.lowe",
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
         "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",
839
         "web_url" : "https://gitlab.example.com/root",
840 841 842 843 844 845 846 847
         "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,
848
      "labels" : [],
849 850
      "user_notes_count": 1,
      "changes_count": "1"
851 852 853
   },
]
```
854

855 856 857 858 859 860 861 862 863 864 865
Example response when an external issue tracker (e.g. JIRA) is used:

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

866 867
## Subscribe to a merge request

868 869
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.
870 871

```
872
POST /projects/:id/merge_requests/:merge_request_iid/subscribe
873 874
```

875 876
| Attribute           | Type    | Required | Description                 |
| ---------           | ----    | -------- | -----------                 |
877
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user         |
878
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
879 880

```bash
881
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
```

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",
906
    "web_url": "https://gitlab.example.com/leila"
907 908 909 910 911 912 913
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
914
    "web_url": "https://gitlab.example.com/carli"
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
  },
  "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
  },
931
  "merge_when_pipeline_succeeds": false,
932
  "merge_status": "cannot_be_merged",
933 934 935
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
936 937
}
```
938

939 940
## Unsubscribe from a merge request

941
Unsubscribes the authenticated user from a merge request to not receive
942 943
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
944 945

```
946
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
947 948
```

949 950
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
951
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
952
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
953 954

```bash
955
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
```

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",
980
    "web_url": "https://gitlab.example.com/leila"
981 982 983 984 985 986 987
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
988
    "web_url": "https://gitlab.example.com/carli"
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
  },
  "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
  },
1005
  "merge_when_pipeline_succeeds": false,
1006
  "merge_status": "cannot_be_merged",
1007 1008 1009
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
1010 1011
}
```
1012 1013 1014

## Create a todo

1015
Manually creates a todo for the current user on a merge request.
1016
If there already exists a todo for the user on that merge request,
1017 1018 1019
status code `304` is returned.

```
1020
POST /projects/:id/merge_requests/:merge_request_iid/todo
1021 1022
```

1023 1024
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1025
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1026
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1027 1028

```bash
1029
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
```

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",
1050
    "web_url": "https://gitlab.example.com/root"
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
  },
  "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",
1073 1074
      "web_url": "https://gitlab.example.com/francisca",
      "discussion_locked": false
1075 1076 1077 1078 1079 1080 1081
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
1082
      "web_url": "https://gitlab.example.com/barrett.krajcik"
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
    },
    "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
    },
1099
    "merge_when_pipeline_succeeds": false,
1100 1101
    "merge_status": "unchecked",
    "subscribed": true,
1102 1103
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
1104
    "user_notes_count": 7,
1105
    "changes_count": "1",
1106
    "should_remove_source_branch": true,
1107 1108
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
1109 1110 1111 1112 1113 1114 1115
  },
  "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"
}
```
1116 1117 1118 1119 1120 1121

## Get MR diff versions

Get a list of merge request diff versions.

```
1122
GET /projects/:id/merge_requests/:merge_request_iid/versions
1123 1124
```

1125 1126 1127 1128
| Attribute           | Type    | Required | Description                 |
| ---------           | ------- | -------- | ---------------------       |
| `id`                | String  | yes      | The ID of the project       |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1129

1130
```bash
1131
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions
1132
```
1133

1134
Example response:
1135 1136 1137

```json
[{
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
  "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.

```
1163
GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id
1164 1165
```

1166 1167 1168 1169 1170
| 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 |
1171 1172

```bash
1173
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1
1174 1175 1176 1177 1178 1179
```

Example response:

```json
{
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
  "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
  }]
1223
}
1224
```
1225 1226 1227 1228 1229
## Set a time estimate for a merge request

Sets an estimated time of work for this merge request.

```
1230
POST /projects/:id/merge_requests/:merge_request_iid/time_estimate
1231 1232
```

1233 1234
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
1235
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                      |
1236 1237
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1238 1239

```bash
1240
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_estimate?duration=3h30m
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
```

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.

```
1259
POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate
1260 1261
```

1262 1263
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
1264
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                          |
1265
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1266 1267

```bash
1268
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_time_estimate
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
```

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

```
1287
POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time
1288 1289
```

1290 1291
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |