merge_requests.md 60.4 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
| `wip`            | string   | no       | Filter merge requests against their `wip` status. `yes` to return *only* WIP merge requests, `no` to return *non* WIP merge requests                                                        |
51 52 53 54 55 56 57 58 59 60 61

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

## List project merge requests

119
Get all merge requests for this project.
120
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`).
121
The pagination parameters `page` and `per_page` can be used to restrict the list of merge requests.
Valeriy Sizov's avatar
Valeriy Sizov committed
122 123

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

133 134 135 136 137 138 139 140 141
`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.

142

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

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

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

233 234 235
## List group merge requests

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

338 339
## Get single MR

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

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

Parameters:

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

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

485 486
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
487
Get a list of merge request commits.
488 489

```
490
GET /projects/:id/merge_requests/:merge_request_iid/commits
491 492 493 494
```

Parameters:

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


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

522 523
## Get single MR changes

524
Shows information about the merge request including its files and changes.
525 526

```
527
GET /projects/:id/merge_requests/:merge_request_iid/changes
528 529 530 531
```

Parameters:

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

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

613 614
## List MR pipelines

615 616
> [Introduced][ce-15454] in GitLab 10.5.0.

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
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
639 640
## Create MR

641
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
642
```
643
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
644 645
```

646 647 648 649 650 651 652 653 654 655
| 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                                         |
656
| `milestone_id`             | integer | no       | The global ID of a milestone                                                           |
657
| `remove_source_branch`     | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
658 659
| `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                                             |
660
| `squash`                   | boolean | no       | Squash commits into a single commit when merging                                |
Valeriy Sizov's avatar
Valeriy Sizov committed
661 662 663

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

## Update MR

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

```
733
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
734 735
```

736 737 738 739 740 741 742
| 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.  |
743
| `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.|
744 745 746 747
| `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 |
748
| `squash`                   | boolean | no       | Squash commits into a single commit when merging |
749
| `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. |
750 751
| `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
752

753 754
Must include at least one non-required attribute from above.

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

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

```
825
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
826 827
```

828 829 830
| 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 |
831
| `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
832

833
```bash
834
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
835 836
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
837 838
## Accept MR

839
Merge changes submitted with MR using this API.
840 841


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

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

846
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'
847

848
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
849 850

```
851
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
852 853 854 855
```

Parameters:

856
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
857
- `merge_request_iid` (required)            - Internal ID of MR
858 859
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
860
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
861
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
862 863 864 865

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

927
## Cancel Merge When Pipeline Succeeds
928

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

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

933
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
934
```
935
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
936 937 938
```
Parameters:

939
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
940
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
941 942 943 944

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

bb-froggy's avatar
typo  
bb-froggy committed
1006
## Comments on merge requests
1007

1008
Comments are done via the [notes](notes.md) resource.
1009 1010 1011 1012 1013 1014

## List issues that will close on merge

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

```
1015
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
1016 1017
```

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

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

1027
Example response when the GitLab issue tracker is used:
1028 1029 1030 1031 1032 1033 1034 1035 1036

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

1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
Example response when an external issue tracker (e.g. JIRA) is used:

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

1085 1086
## Subscribe to a merge request

1087 1088
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.
1089 1090

```
1091
POST /projects/:id/merge_requests/:merge_request_iid/subscribe
1092 1093
```

1094 1095
| Attribute           | Type    | Required | Description                 |
| ---------           | ----    | -------- | -----------                 |
1096
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user         |
1097
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1098 1099

```bash
1100
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
```

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

1158 1159
## Unsubscribe from a merge request

1160
Unsubscribes the authenticated user from a merge request to not receive
1161 1162
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
1163 1164

```
1165
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
1166 1167
```

1168 1169
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1170
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1171
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1172 1173

```bash
1174
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
```

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

## Create a todo

1234
Manually creates a todo for the current user on a merge request.
1235
If there already exists a todo for the user on that merge request,
1236 1237 1238
status code `304` is returned.

```
1239
POST /projects/:id/merge_requests/:merge_request_iid/todo
1240 1241
```

1242 1243
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1244
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1245
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1246 1247

```bash
1248
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263