merge_requests.md 53.2 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
GET /merge_requests?scope=assigned_to_me
32 33 34 35
```

Parameters:

36 37 38 39 40 41 42 43
| 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                                                        |
44 45 46 47
| `created_after`     | datetime | no       | Return merge requests created on or after the given time                                                               |
| `created_before`    | datetime | no       | Return merge requests created on or before the given time                                                              |
| `updated_after`     | datetime | no       | Return merge requests updated on or after the given time                                                               |
| `updated_before`    | datetime | no       | Return merge requests updated on or before the given time                                                              |
48 49
| `scope`             | string   | no       | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead. |
| `author_id`         | integer  | no       | Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`              |
50
| `assignee_id`       | integer  | no       | Returns merge requests assigned to the given user `id`                                                                 |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
51
| `my_reaction_emoji` | string   | no       | Return merge requests reacted by the authenticated user by the given `emoji` _([Introduced][ce-14016] in GitLab 10.0)_ |
52 53
| `source_branch`     | string   | no       | Return merge requests with the given source branch                                                                     |
| `target_branch`     | string   | no       | Return merge requests with the given target branch                                                                     |
54
| `search`            | string   | no       | Search merge requests against their `title` and `description`                                                          |
55 56 57 58 59 60 61 62 63 64 65

```json
[
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
66 67
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
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 102 103 104 105 106
    "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,
107
    "changes_count": "1",
108 109
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
110 111 112 113 114 115 116
    "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
    }
117 118 119 120 121 122
  }
]
```

## List project merge requests

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

```
128
GET /projects/:id/merge_requests
129 130
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
131
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
132
GET /projects/:id/merge_requests?milestone=release
133
GET /projects/:id/merge_requests?labels=bug,reproduced
134
GET /projects/:id/merge_requests?my_reaction_emoji=star
Valeriy Sizov's avatar
Valeriy Sizov committed
135 136
```

137 138 139 140 141 142 143 144 145
`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.

146 147 148 149 150
**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
151 152
Parameters:

Hiroyuki Sato's avatar
Hiroyuki Sato committed
153 154 155 156 157 158 159 160 161 162
| 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                                                                |
163 164 165 166
| `created_after`     | datetime       | no       | Return merge requests created on or after the given time                                                                       |
| `created_before`    | datetime       | no       | Return merge requests created on or before the given time                                                                      |
| `updated_after`     | datetime       | no       | Return merge requests updated on or after the given time                                                                       |
| `updated_before`    | datetime       | no       | Return merge requests updated on or before the given time                                                                      |
167
| `scope`             | string         | no       | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13060] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
168 169 170
| `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)_         |
171 172
| `source_branch`     | string   | no       | Return merge requests with the given source branch                                                                     |
| `target_branch`     | string   | no       | Return merge requests with the given target branch                                                                     |
173
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |
Valeriy Sizov's avatar
Valeriy Sizov committed
174 175 176

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

241 242
## Get single MR

243
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
244 245

```
246
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
247 248 249 250
```

Parameters:

251
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
252
- `merge_request_iid` (required) - The internal ID of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
253 254 255

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
256 257 258 259 260 261 262
  "id": 1,
  "iid": 1,
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
263 264
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
265 266 267
  "upvotes": 0,
  "downvotes": 0,
  "author": {
haseeb's avatar
haseeb committed
268 269 270 271 272 273
    "state" : "active",
    "web_url" : "https://gitlab.example.com/root",
    "avatar_url" : null,
    "username" : "root",
    "id" : 1,
    "name" : "Administrator"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
274 275
  },
  "assignee": {
haseeb's avatar
haseeb committed
276 277 278 279 280 281
    "state" : "active",
    "web_url" : "https://gitlab.example.com/root",
    "avatar_url" : null,
    "username" : "root",
    "id" : 1,
    "name" : "Administrator"
282
  },
Ben Boeckel's avatar
Ben Boeckel committed
283 284
  "source_project_id": 2,
  "target_project_id": 3,
285
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
286
  "description": "fixed login page css paddings",
287 288 289 290 291 292 293 294 295 296 297 298
  "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
  },
299
  "merge_when_pipeline_succeeds": true,
300
  "merge_status": "can_be_merged",
301
  "subscribed" : true,
302 303
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
304
  "user_notes_count": 1,
305
  "changes_count": "1",
306
  "should_remove_source_branch": true,
307
  "force_remove_source_branch": false,
308
  "web_url": "http://example.com/example/example/merge_requests/1",
309
  "discussion_locked": false,
310 311 312 313 314
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
haseeb's avatar
haseeb committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
  },
  "closed_at": "2018-01-19T14:36:11.086Z",
  "latest_build_started_at": null,
  "latest_build_finished_at": null,
  "first_deployed_to_production_at": null,
  "pipeline": {
    "id": 8,
    "ref": "master",
    "sha": "2dc6aa325a317eda67812f05600bdf0fcdc70ab0",
    "status": "created"
  },
  "merged_by": null,
  "merged_at": null,
  "closed_by": {
    "state" : "active",
    "web_url" : "https://gitlab.example.com/root",
    "avatar_url" : null,
    "username" : "root",
    "id" : 1,
    "name" : "Administrator"
335
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
336 337 338
}
```

339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
## Get single MR participants

Get a list of merge request participants.

```
GET /projects/:id/merge_requests/:merge_request_iid/participants
```

Parameters:

- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `merge_request_iid` (required) - The internal ID of the merge request


```json
[
  {
    "id": 1,
    "name": "John Doe1",
    "username": "user1",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
    "web_url": "http://localhost/user1"
  },
  {
    "id": 2,
    "name": "John Doe2",
    "username": "user2",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/10fc7f102be8de7657fb4d80898bbfe3?s=80&d=identicon",
    "web_url": "http://localhost/user2"
  },
]
```

374 375
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
376
Get a list of merge request commits.
377 378

```
379
GET /projects/:id/merge_requests/:merge_request_iid/commits
380 381 382 383
```

Parameters:

384
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
385
- `merge_request_iid` (required) - The internal ID of the merge request
386 387 388 389 390 391 392 393 394 395 396


```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
397
    "message": "Replace sanitize with escape once"
398 399 400 401 402 403 404 405
  },
  {
    "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
406
    "message": "Sanitize for network graph"
407 408 409 410
  }
]
```

411 412
## Get single MR changes

413
Shows information about the merge request including its files and changes.
414 415

```
416
GET /projects/:id/merge_requests/:merge_request_iid/changes
417 418 419 420
```

Parameters:

421
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
422
- `merge_request_iid` (required) - The internal ID of the merge request
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453

```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": [ ],
454 455
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
456 457 458 459 460 461 462 463 464 465 466
  "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
  },
467
  "merge_when_pipeline_succeeds": true,
468
  "merge_status": "can_be_merged",
469
  "subscribed" : true,
470 471
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
472
  "user_notes_count": 1,
473
  "changes_count": "1",
474 475
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
476
  "web_url": "http://example.com/example/example/merge_requests/1",
477
  "discussion_locked": false,
478 479 480 481 482 483
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
484
  "changes": [
485 486 487 488 489 490 491 492 493 494 495 496 497 498
    {
    "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
    }
  ]
}
```

499 500
## List MR pipelines

501 502
> [Introduced][ce-15454] in GitLab 10.5.0.

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
Get a list of merge request pipelines.

```
GET /projects/:id/merge_requests/:merge_request_iid/pipelines
```

Parameters:

- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `merge_request_iid` (required) - The internal ID of the merge request

```json
[
  {
    "id": 77,
    "sha": "959e04d7c7a30600c894bd3c0cd0e1ce7f42c11d",
    "ref": "master",
    "status": "success"
  }
]
```

Valeriy Sizov's avatar
Valeriy Sizov committed
525 526
## Create MR

527
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
528
```
529
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
530 531
```

532 533 534 535 536 537 538 539 540 541
| 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 |
| `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                                         |
542
| `milestone_id`             | integer | no       | The global ID of a milestone                                                           |
543
| `remove_source_branch`     | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
544
| `allow_maintainer_to_push` | boolean | no       | Whether or not a maintainer of the target project can push to the source branch  |
Valeriy Sizov's avatar
Valeriy Sizov committed
545 546 547

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
548
  "id": 1,
549
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
550 551
  "target_branch": "master",
  "source_branch": "test1",
552
  "project_id": 4,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
553 554 555 556 557 558 559
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
560
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
561 562 563 564 565 566 567
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
568
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
569 570 571
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
572
  },
573
  "source_project_id": 3,
574 575
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
576
  "description": "fixed login page css paddings",
577 578 579 580 581 582 583 584 585 586 587 588
  "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
  },
589
  "merge_when_pipeline_succeeds": true,
590
  "merge_status": "can_be_merged",
591
  "subscribed" : true,
592 593
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
594
  "user_notes_count": 0,
595
  "changes_count": "1",
596
  "should_remove_source_branch": true,
597
  "force_remove_source_branch": false,
598
  "web_url": "http://example.com/example/example/merge_requests/1",
599
  "discussion_locked": false,
600
  "allow_maintainer_to_push": false,
601 602 603 604 605 606
  "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
607 608 609 610 611
}
```

## Update MR

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

```
615
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
616 617
```

618 619 620 621 622 623 624
| 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 |
| `merge_request_iid`        | integer | yes      | The ID of a merge request                                                       |
| `target_branch`            | string  | no       | The target branch                                                               |
| `title`                    | string  | no       | Title of MR                                                                     |
| `assignee_id`              | integer | no       | The ID of the user to assign the merge request to. Set to `0` or provide an empty value to unassign all assignees.  |
625
| `milestone_id`             | integer | no       | The global ID of a milestone to assign the merge request to. Set to `0` or provide an empty value to unassign a milestone.|
626 627 628 629 630
| `labels`                   | string  | no       | Comma-separated label names for a merge request. Set to an empty string to unassign all labels.                    |
| `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 |
| `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. |
631
| `allow_maintainer_to_push` | boolean | no       | Whether or not a maintainer of the target project can push to the source branch |
Valeriy Sizov's avatar
Valeriy Sizov committed
632

633 634
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
635 636
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
637
  "id": 1,
638
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
639
  "target_branch": "master",
640
  "project_id": 4,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
641 642 643 644 645 646 647
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
648
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
649 650 651 652 653 654 655
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
656
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
657 658 659
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
660
  },
661
  "source_project_id": 3,
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
  "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
  },
677
  "merge_when_pipeline_succeeds": true,
678
  "merge_status": "can_be_merged",
679
  "subscribed" : true,
680 681
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
682
  "user_notes_count": 1,
683
  "changes_count": "1",
684
  "should_remove_source_branch": true,
685
  "force_remove_source_branch": false,
686
  "web_url": "http://example.com/example/example/merge_requests/1",
687
  "discussion_locked": false,
688
  "allow_maintainer_to_push": false,
689 690 691 692 693 694
  "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
695 696
}
```
697

698 699 700
## 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
701 702

```
703
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
704 705
```

706 707 708
| 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 |
709
| `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
710

711
```bash
712
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
713 714
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
715 716
## Accept MR

717
Merge changes submitted with MR using this API.
718 719


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

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

724
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'
725

726
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
727 728

```
729
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
730 731 732 733
```

Parameters:

734
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
735
- `merge_request_iid` (required)            - Internal ID of MR
736 737
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
738
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
739
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
740 741 742 743

```json
{
  "id": 1,
744
  "iid": 1,
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
  "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"
767 768 769 770
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
771
  "description": "fixed login page css paddings",
772 773 774 775 776 777 778 779 780 781 782 783
  "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
  },
784
  "merge_when_pipeline_succeeds": true,
785
  "merge_status": "can_be_merged",
786
  "subscribed" : true,
787 788
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
789
  "user_notes_count": 1,
790
  "changes_count": "1",
791
  "should_remove_source_branch": true,
792
  "force_remove_source_branch": false,
793
  "web_url": "http://example.com/example/example/merge_requests/1",
794
  "discussion_locked": false,
795 796 797 798 799 800
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
801 802 803
}
```

804
## Cancel Merge When Pipeline Succeeds
805

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

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

810
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
811
```
812
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
813 814 815
```
Parameters:

816
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
817
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
818 819 820 821

```json
{
  "id": 1,
822
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
823 824 825 826
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
827
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
828 829 830 831 832
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
833
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
834 835 836 837 838 839 840
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
841
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
842 843 844
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
845 846 847 848
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
849
  "description": "fixed login page css paddings",
850 851 852 853 854 855 856 857 858 859 860 861
  "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
  },
862
  "merge_when_pipeline_succeeds": true,
863
  "merge_status": "can_be_merged",
864
  "subscribed" : true,
865 866
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
867
  "user_notes_count": 1,
868
  "changes_count": "1",
869
  "should_remove_source_branch": true,
870
  "force_remove_source_branch": false,
871
  "web_url": "http://example.com/example/example/merge_requests/1",
872
  "discussion_locked": false,
873 874 875 876 877 878
  "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
879 880 881
}
```

bb-froggy's avatar
typo  
bb-froggy committed
882
## Comments on merge requests
883

884
Comments are done via the [notes](notes.md) resource.
885 886 887 888 889 890

## List issues that will close on merge

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

```
891
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
892 893
```

894 895
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
896
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
897
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
898 899

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

903
Example response when the GitLab issue tracker is used:
904 905 906 907 908 909 910 911 912

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
913
         "web_url" : "https://gitlab.example.com/eileen.lowe",
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
         "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",
934
         "web_url" : "https://gitlab.example.com/root",
935 936 937 938 939 940 941 942
         "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,
943
      "labels" : [],
944 945
      "user_notes_count": 1,
      "changes_count": "1"
946 947 948
   },
]
```
949

950 951 952 953 954 955 956 957 958 959 960
Example response when an external issue tracker (e.g. JIRA) is used:

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

961 962
## Subscribe to a merge request

963 964
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.
965 966

```
967
POST /projects/:id/merge_requests/:merge_request_iid/subscribe
968 969
```

970 971
| Attribute           | Type    | Required | Description                 |
| ---------           | ----    | -------- | -----------                 |
972
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user         |
973
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
974 975

```bash
976
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
```

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",
1001
    "web_url": "https://gitlab.example.com/leila"
1002 1003 1004 1005 1006 1007 1008
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
1009
    "web_url": "https://gitlab.example.com/carli"
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
  },
  "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
  },
1026
  "merge_when_pipeline_succeeds": false,
1027
  "merge_status": "cannot_be_merged",
1028 1029 1030
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
1031 1032
}
```
1033

1034 1035
## Unsubscribe from a merge request

1036
Unsubscribes the authenticated user from a merge request to not receive
1037 1038
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
1039 1040

```
1041
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
1042 1043
```

1044 1045
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1046
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1047
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1048 1049

```bash
1050
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
```

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",
1075
    "web_url": "https://gitlab.example.com/leila"
1076 1077 1078 1079 1080 1081 1082
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
1083
    "web_url": "https://gitlab.example.com/carli"
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
  },
  "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
  },
1100
  "merge_when_pipeline_succeeds": false,
1101
  "merge_status": "cannot_be_merged",
1102 1103 1104
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
1105 1106
}
```
1107 1108 1109

## Create a todo

1110
Manually creates a todo for the current user on a merge request.
1111
If there already exists a todo for the user on that merge request,
1112 1113 1114
status code `304` is returned.

```
1115
POST /projects/:id/merge_requests/:merge_request_iid/todo
1116 1117
```

1118 1119
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1120
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1121
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1122 1123

```bash
1124
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
```

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",
1145
    "web_url": "https://gitlab.example.com/root"
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
  },
  "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",
1168 1169
      "web_url": "https://gitlab.example.com/francisca",
      "discussion_locked": false
1170 1171 1172 1173 1174 1175 1176
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
1177
      "web_url": "https://gitlab.example.com/barrett.krajcik"
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
    },
    "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
    },
1194
    "merge_when_pipeline_succeeds": false,
1195 1196
    "merge_status": "unchecked",
    "subscribed": true,
1197 1198
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
1199
    "user_notes_count": 7,
1200
    "changes_count": "1",
1201
    "should_remove_source_branch": true,
1202 1203
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
1204 1205 1206 1207 1208 1209 1210
  },
  "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"
}
```
1211 1212 1213 1214 1215 1216

## Get MR diff versions

Get a list of merge request diff versions.

```
1217
GET /projects/:id/merge_requests/:merge_request_iid/versions
1218 1219
```

1220 1221 1222 1223
| Attribute           | Type    | Required | Description                 |
| ---------           | ------- | -------- | ---------------------       |
| `id`                | String  | yes      | The ID of the project       |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1224

1225
```bash
1226
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions
1227
```
1228

1229
Example response:
1230 1231 1232

```json
[{
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
  "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.

```
1258
GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id
1259 1260
```

1261 1262 1263 1264 1265
| 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 |
1266 1267

```bash
1268
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1
1269 1270 1271 1272 1273 1274
```

Example response:

```json
{
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293