merge_requests.md 59.9 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
The `state` parameter can be used to get only merge requests with a
14
given state (`opened`, `closed`, `locked`, or `merged`) or all of them (`all`). It should be noted that when searching by `locked` it will mostly return no results as it is a short-lived, transitional state.
15 16 17 18 19 20 21 22 23 24
The pagination parameters `page` and `per_page` can be used to
restrict the list of merge requests.

```
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
25
GET /merge_requests?my_reaction_emoji=star
26
GET /merge_requests?scope=assigned_to_me
27 28 29 30
```

Parameters:

31 32
| Attribute           | Type     | Required | Description                                                                                                            |
| ------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
33
| `state`             | string   | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                       |
34 35 36 37 38
| `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                                                        |
39 40 41 42
| `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                                                              |
43 44
| `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`              |
45
| `assignee_id`       | integer  | no       | Returns merge requests assigned to the given user `id`                                                                 |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
46
| `my_reaction_emoji` | string   | no       | Return merge requests reacted by the authenticated user by the given `emoji` _([Introduced][ce-14016] in GitLab 10.0)_ |
47 48
| `source_branch`     | string   | no       | Return merge requests with the given source branch                                                                     |
| `target_branch`     | string   | no       | Return merge requests with the given target branch                                                                     |
49
| `search`            | string   | no       | Search merge requests against their `title` and `description`                                                          |
50 51 52 53 54 55 56 57 58 59 60

```json
[
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
61 62
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
63 64 65 66 67 68 69
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "username": "admin",
      "name": "Administrator",
      "state": "active",
70 71
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
72 73 74 75 76 77
    },
    "assignee": {
      "id": 1,
      "username": "admin",
      "name": "Administrator",
      "state": "active",
78 79
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
    },
    "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,
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
104
    "squash": false,
105 106 107 108 109 110 111
    "web_url": "http://example.com/example/example/merge_requests/1",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
112 113 114 115 116 117
  }
]
```

## List project merge requests

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

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

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

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

141

Valeriy Sizov's avatar
Valeriy Sizov committed
142 143
Parameters:

Hiroyuki Sato's avatar
Hiroyuki Sato committed
144 145 146 147
| Attribute           | Type           | Required | Description                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `id`                | integer        | yes      | The ID of a project                                                                                                            |
| `iids[]`            | Array[integer] | no       | Return the request having the given `iid`                                                                                      |
148
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                               |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
149 150 151 152 153
| `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                                                                |
154 155 156 157
| `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                                                                      |
158
| `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
159 160 161
| `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)_         |
162 163
| `source_branch`     | string   | no       | Return merge requests with the given source branch                                                                     |
| `target_branch`     | string   | no       | Return merge requests with the given target branch                                                                     |
164
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |
Valeriy Sizov's avatar
Valeriy Sizov committed
165 166 167

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

232 233 234
## List group merge requests

Get all merge requests for this group and its subgroups.
235
The `state` parameter can be used to get only merge requests with a given state (`opened`, `closed`, `locked`, or `merged`) or all of them (`all`).
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
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                                                                                                           |
254
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                               |
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
| `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",
      "name": "Administrator",
      "state": "active",
291 292
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
293 294 295 296 297 298
    },
    "assignee": {
      "id": 1,
      "username": "admin",
      "name": "Administrator",
      "state": "active",
299 300
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
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
    },
    "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,
    "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
    }
  }
]
```

337 338
## Get single MR

339
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
340

341 342 343 344 345
**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
346
```
347
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
348 349 350 351
```

Parameters:

352
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
353
- `merge_request_iid` (required) - The internal ID of the merge request
Phil Hughes's avatar
Phil Hughes committed
354
- `render_html` (optional) - If `true` response includes rendered HTML for title and description
Valeriy Sizov's avatar
Valeriy Sizov committed
355 356 357

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

442 443 444 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
## 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"
  },
]
```

477 478
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
479
Get a list of merge request commits.
480 481

```
482
GET /projects/:id/merge_requests/:merge_request_iid/commits
483 484 485 486
```

Parameters:

487
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
488
- `merge_request_iid` (required) - The internal ID of the merge request
489 490 491 492 493 494 495 496 497 498 499


```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
500
    "message": "Replace sanitize with escape once"
501 502 503 504 505 506 507 508
  },
  {
    "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
509
    "message": "Sanitize for network graph"
510 511 512 513
  }
]
```

514 515
## Get single MR changes

516
Shows information about the merge request including its files and changes.
517 518

```
519
GET /projects/:id/merge_requests/:merge_request_iid/changes
520 521 522 523
```

Parameters:

524
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
525
- `merge_request_iid` (required) - The internal ID of the merge request
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

```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",
545 546
    "avatar_url": "http://www.gravatar.com/avatar/b95567800f828948baf5f4160ebb2473?s=40&d=identicon",
    "web_url" : "https://gitlab.example.com/jarrett"
547 548 549 550 551 552
  },
  "assignee": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
553 554
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon",
    "web_url" : "https://gitlab.example.com/root"
555 556 557 558
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
559 560
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
561 562 563 564 565 566 567 568 569 570 571
  "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
  },
572
  "merge_when_pipeline_succeeds": true,
573
  "merge_status": "can_be_merged",
574
  "subscribed" : true,
575 576
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
577
  "user_notes_count": 1,
578
  "changes_count": "1",
579 580
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
581
  "squash": false,
582
  "web_url": "http://example.com/example/example/merge_requests/1",
583
  "discussion_locked": false,
584 585 586 587 588 589
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
590
  "changes": [
591 592 593 594 595 596 597 598 599 600 601 602 603 604
    {
    "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
    }
  ]
}
```

605 606
## List MR pipelines

607 608
> [Introduced][ce-15454] in GitLab 10.5.0.

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

633
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
634
```
635
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
636 637
```

638 639 640 641 642 643 644 645 646 647
| 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                                         |
648
| `milestone_id`             | integer | no       | The global ID of a milestone                                                           |
649
| `remove_source_branch`     | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
650 651
| `allow_collaboration`      | boolean | no       | Allow commits from members who can merge to the target branch                   |
| `allow_maintainer_to_push` | boolean | no       | Deprecated, see allow_collaboration                                             |
652
| `squash`                   | boolean | no       | Squash commits into a single commit when merging                                |
Valeriy Sizov's avatar
Valeriy Sizov committed
653 654 655

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

## Update MR

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

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

728 729 730 731 732 733 734
| 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.  |
735
| `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.|
736 737 738 739
| `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 |
740
| `squash`                   | boolean | no       | Squash commits into a single commit when merging |
741
| `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. |
742 743
| `allow_collaboration`      | boolean | no       | Allow commits from members who can merge to the target branch                   |
| `allow_maintainer_to_push` | boolean | no       | Deprecated, see allow_collaboration                                             |
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 760 761
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
    "name": "Administrator",
    "state": "active",
762 763
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
764 765 766 767 768 769
  },
  "assignee": {
    "id": 1,
    "username": "admin",
    "name": "Administrator",
    "state": "active",
770 771
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
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_collaboration": false,
802
  "allow_maintainer_to_push": false,
803 804 805 806 807 808
  "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
809 810
}
```
811

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

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

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

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

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

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


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

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

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

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

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

Parameters:

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

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

919
## Cancel Merge When Pipeline Succeeds
920

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

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

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

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

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

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

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

## List issues that will close on merge

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

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

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

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

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

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

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

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

1077 1078
## Subscribe to a merge request

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

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

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

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

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

1150 1151
## Unsubscribe from a merge request

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

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

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

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

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

## Create a todo

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

```
1231
POST /projects/:id/merge_requests/:merge_request_iid/todo
1232 1233
```

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

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

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",
1261
    "web_url": "https://gitlab.example.com/root"
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273