merge_requests.md 59.5 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
    "squash": false,
111 112 113 114 115 116 117
    "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
    }
118 119 120 121 122 123
  }
]
```

## List project merge requests

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

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

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

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

Hiroyuki Sato's avatar
Hiroyuki Sato committed
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                                                                |
164 165 166 167
| `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                                                                      |
168
| `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
169 170 171
| `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)_         |
172 173
| `source_branch`     | string   | no       | Return merge requests with the given source branch                                                                     |
| `target_branch`     | string   | no       | Return merge requests with the given target branch                                                                     |
174
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |
Valeriy Sizov's avatar
Valeriy Sizov committed
175 176 177

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

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
## List group merge requests

Get all merge requests for this group and its subgroups.
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.

```
GET /groups/:id/merge_requests
GET /groups/:id/merge_requests?state=opened
GET /groups/:id/merge_requests?state=all
GET /groups/:id/merge_requests?milestone=release
GET /groups/:id/merge_requests?labels=bug,reproduced
GET /groups/:id/merge_requests?my_reaction_emoji=star
```

`group_id` represents the ID of the group which contains the project where the MR resides.

Parameters:

| Attribute           | Type           | Required | Description                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `id`                | integer        | yes      | The ID of a group                                                                                                           |
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, or `merged`                                               |
| `order_by`          | string         | no       | Return merge requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                        |
| `sort`              | string         | no       | Return merge 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 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                                                                      |
| `scope`             | string         | no       | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br>                                     |
| `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)_         |
| `source_branch`     | string   | no       | Return merge requests with the given source branch                                                                     |
| `target_branch`     | string   | no       | Return merge requests with the given target branch                                                                     |
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |

```json
[
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
    "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,
    "changes_count": "1",
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1",
    "discussion_locked": false,
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
  }
]
```

349 350
## Get single MR

351
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
352 353

```
354
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
355 356 357 358
```

Parameters:

359
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
360
- `merge_request_iid` (required) - The internal ID of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
361 362 363

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
364 365 366 367 368 369 370
  "id": 1,
  "iid": 1,
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
371 372
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
373 374 375
  "upvotes": 0,
  "downvotes": 0,
  "author": {
haseeb's avatar
haseeb committed
376 377 378 379 380 381
    "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
382 383
  },
  "assignee": {
haseeb's avatar
haseeb committed
384 385 386 387 388 389
    "state" : "active",
    "web_url" : "https://gitlab.example.com/root",
    "avatar_url" : null,
    "username" : "root",
    "id" : 1,
    "name" : "Administrator"
390
  },
Ben Boeckel's avatar
Ben Boeckel committed
391 392
  "source_project_id": 2,
  "target_project_id": 3,
393
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
394
  "description": "fixed login page css paddings",
395 396 397 398 399 400 401 402 403 404 405 406
  "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
  },
407
  "merge_when_pipeline_succeeds": true,
408
  "merge_status": "can_be_merged",
409
  "subscribed" : true,
410 411
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
412
  "user_notes_count": 1,
413
  "changes_count": "1",
414
  "should_remove_source_branch": true,
415
  "force_remove_source_branch": false,
416
  "squash": false,
417
  "web_url": "http://example.com/example/example/merge_requests/1",
418
  "discussion_locked": false,
419 420 421 422 423
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
haseeb's avatar
haseeb committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  },
  "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"
444
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
445 446 447
}
```

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
## 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"
  },
]
```

483 484
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
485
Get a list of merge request commits.
486 487

```
488
GET /projects/:id/merge_requests/:merge_request_iid/commits
489 490 491 492
```

Parameters:

493
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
494
- `merge_request_iid` (required) - The internal ID of the merge request
495 496 497 498 499 500 501 502 503 504 505


```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
506
    "message": "Replace sanitize with escape once"
507 508 509 510 511 512 513 514
  },
  {
    "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
515
    "message": "Sanitize for network graph"
516 517 518 519
  }
]
```

520 521
## Get single MR changes

522
Shows information about the merge request including its files and changes.
523 524

```
525
GET /projects/:id/merge_requests/:merge_request_iid/changes
526 527 528 529
```

Parameters:

530
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
531
- `merge_request_iid` (required) - The internal ID of the merge request
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562

```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": [ ],
563 564
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
565 566 567 568 569 570 571 572 573 574 575
  "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
  },
576
  "merge_when_pipeline_succeeds": true,
577
  "merge_status": "can_be_merged",
578
  "subscribed" : true,
579 580
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
581
  "user_notes_count": 1,
582
  "changes_count": "1",
583 584
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
585
  "web_url": "http://example.com/example/example/merge_requests/1",
586
  "discussion_locked": false,
587 588 589 590 591 592
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
593
  "changes": [
594 595 596 597 598 599 600 601 602 603 604 605 606 607
    {
    "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
    }
  ]
}
```

608 609
## List MR pipelines

610 611
> [Introduced][ce-15454] in GitLab 10.5.0.

612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
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
634 635
## Create MR

636
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
637
```
638
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
639 640
```

641 642 643 644 645 646 647 648 649 650
| 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                                         |
651
| `milestone_id`             | integer | no       | The global ID of a milestone                                                           |
652
| `remove_source_branch`     | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
653 654
| `allow_maintainer_to_push` | boolean | no       | Whether or not a maintainer of the target project can push to the source branch |
| `squash`                   | boolean | no       | Squash commits into a single commit when merging                                |
Valeriy Sizov's avatar
Valeriy Sizov committed
655 656 657

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
658
  "id": 1,
659
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
660 661
  "target_branch": "master",
  "source_branch": "test1",
662
  "project_id": 4,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
663 664 665 666 667 668 669
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
670
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
671 672 673 674 675 676 677
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
678
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
679 680 681
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
682
  },
683
  "source_project_id": 3,
684 685
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
686
  "description": "fixed login page css paddings",
687 688 689 690 691 692 693 694 695 696 697 698
  "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
  },
699
  "merge_when_pipeline_succeeds": true,
700
  "merge_status": "can_be_merged",
701
  "subscribed" : true,
702 703
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
704
  "user_notes_count": 0,
705
  "changes_count": "1",
706
  "should_remove_source_branch": true,
707
  "force_remove_source_branch": false,
708
  "squash": false,
709
  "web_url": "http://example.com/example/example/merge_requests/1",
710
  "discussion_locked": false,
711
  "allow_maintainer_to_push": false,
712 713 714 715 716 717
  "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
718 719 720 721 722
}
```

## Update MR

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

```
726
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
727 728
```

729 730 731 732 733 734 735
| 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.  |
736
| `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.|
737 738 739 740
| `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 |
741
| `squash`                   | boolean | no       | Squash commits into a single commit when merging |
742
| `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. |
743
| `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
744

745 746
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
747 748
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
749
  "id": 1,
750
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
751
  "target_branch": "master",
752
  "project_id": 4,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
753 754 755 756 757 758 759
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
760
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
761 762 763 764 765 766 767
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
768
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
769 770 771
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
772
  },
773
  "source_project_id": 3,
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
  "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
  },
789
  "merge_when_pipeline_succeeds": true,
790
  "merge_status": "can_be_merged",
791
  "subscribed" : true,
792 793
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
794
  "user_notes_count": 1,
795
  "changes_count": "1",
796
  "should_remove_source_branch": true,
797
  "force_remove_source_branch": false,
798
  "squash": false,
799
  "web_url": "http://example.com/example/example/merge_requests/1",
800
  "discussion_locked": false,
801
  "allow_maintainer_to_push": false,
802 803 804 805 806 807
  "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
808 809
}
```
810

811 812 813
## 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
814 815

```
816
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
817 818
```

819 820 821
| 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 |
822
| `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
823

824
```bash
825
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
826 827
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
828 829
## Accept MR

830
Merge changes submitted with MR using this API.
831 832


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

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

837
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'
838

839
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
840 841

```
842
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
843 844 845 846
```

Parameters:

847
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
848
- `merge_request_iid` (required)            - Internal ID of MR
849 850
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
851
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
852
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
853 854 855 856

```json
{
  "id": 1,
857
  "iid": 1,
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
  "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"
880 881 882 883
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
884
  "description": "fixed login page css paddings",
885 886 887 888 889 890 891 892 893 894 895 896
  "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
  },
897
  "merge_when_pipeline_succeeds": true,
898
  "merge_status": "can_be_merged",
899
  "subscribed" : true,
900 901
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
902
  "user_notes_count": 1,
903
  "changes_count": "1",
904
  "should_remove_source_branch": true,
905
  "force_remove_source_branch": false,
906
  "squash": false,
907
  "web_url": "http://example.com/example/example/merge_requests/1",
908
  "discussion_locked": false,
909 910 911 912 913 914
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
915 916 917
}
```

918
## Cancel Merge When Pipeline Succeeds
919

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

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

924
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
925
```
926
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
927 928 929
```
Parameters:

930
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
931
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
932 933 934 935

```json
{
  "id": 1,
936
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
937 938 939 940
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
941
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
942 943 944 945 946
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
947
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
948 949 950 951 952 953 954
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
955
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
956 957 958
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
959 960 961 962
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
963
  "description": "fixed login page css paddings",
964 965 966 967 968 969 970 971 972 973 974 975
  "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
  },
976
  "merge_when_pipeline_succeeds": true,
977
  "merge_status": "can_be_merged",
978
  "subscribed" : true,
979 980
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
981
  "user_notes_count": 1,
982
  "changes_count": "1",
983
  "should_remove_source_branch": true,
984
  "force_remove_source_branch": false,
985
  "squash": false,
986
  "web_url": "http://example.com/example/example/merge_requests/1",
987
  "discussion_locked": false,
988 989 990 991 992 993
  "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
994 995 996
}
```

bb-froggy's avatar
typo  
bb-froggy committed
997
## Comments on merge requests
998

999
Comments are done via the [notes](notes.md) resource.
1000 1001 1002 1003 1004 1005

## List issues that will close on merge

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

```
1006
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
1007 1008
```

1009 1010
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1011
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1012
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1013 1014

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

1018
Example response when the GitLab issue tracker is used:
1019 1020 1021 1022 1023 1024 1025 1026 1027

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
1028
         "web_url" : "https://gitlab.example.com/eileen.lowe",
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
         "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",
1049
         "web_url" : "https://gitlab.example.com/root",
1050 1051 1052 1053 1054 1055 1056 1057
         "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,
1058
      "labels" : [],
1059 1060
      "user_notes_count": 1,
      "changes_count": "1"
1061 1062 1063
   },
]
```
1064

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
Example response when an external issue tracker (e.g. JIRA) is used:

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

1076 1077
## Subscribe to a merge request

1078 1079
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.
1080 1081

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

1085 1086
| Attribute           | Type    | Required | Description                 |
| ---------           | ----    | -------- | -----------                 |
1087
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user         |
1088
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1089 1090

```bash
1091
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
```

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",
1116
    "web_url": "https://gitlab.example.com/leila"
1117 1118 1119 1120 1121 1122 1123
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
1124
    "web_url": "https://gitlab.example.com/carli"
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
  },
  "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
  },
1141
  "merge_when_pipeline_succeeds": false,
1142
  "merge_status": "cannot_be_merged",
1143 1144 1145
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
1146 1147
}
```
1148

1149 1150
## Unsubscribe from a merge request

1151
Unsubscribes the authenticated user from a merge request to not receive
1152 1153
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
1154 1155

```
1156
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
1157 1158
```

1159 1160
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1161
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1162
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1163 1164

```bash
1165
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
```

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",
1190
    "web_url": "https://gitlab.example.com/leila"
1191 1192 1193 1194 1195 1196 1197
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
1198
    "web_url": "https://gitlab.example.com/carli"
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
  },
  "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
  },
1215
  "merge_when_pipeline_succeeds": false,
1216
  "merge_status": "cannot_be_merged",
1217 1218 1219
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
1220 1221
}
```
1222 1223 1224

## Create a todo

1225
Manually creates a todo for the current user on a merge request.
1226
If there already exists a todo for the user on that merge request,
1227 1228 1229
status code `304` is returned.

```
1230
POST /projects/:id/merge_requests/:merge_request_iid/todo
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
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1237 1238

```bash
1239
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
```

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",
1260
    "web_url": "https://gitlab.example.com/root"
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
  },
  "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",
1283 1284
      "web_url": "https://gitlab.example.com/francisca",
      "discussion_locked": false
1285 1286 1287 1288 1289 1290 1291
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
1292
      "web_url": "https://gitlab.example.com/barrett.krajcik"
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
    },
    "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
    },
1309
    "merge_when_pipeline_succeeds": false,
1310 1311
    "merge_status": "unchecked",
    "subscribed": true,
1312 1313
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
1314
    "user_notes_count": 7,
1315
    "changes_count": "1",
1316
    "should_remove_source_branch": true,