merge_requests.md 69 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`              |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
45
| `assignee_id`       | integer  | no       | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. |
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

```json
[
  {
    "id": 1,
    "iid": 1,
    "project_id": 3,
    "title": "test1",
59
    "description": "fixed login page css paddings",
60
    "state": "opened",
61 62
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
63 64
    "target_branch": "master",
    "source_branch": "test1",
65 66 67 68 69
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
70
      "username": "admin",
71
      "state": "active",
72 73
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
74 75 76 77
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
78
      "username": "admin",
79
      "state": "active",
80 81
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
82 83 84
    },
    "source_project_id": 2,
    "target_project_id": 3,
85 86 87 88
    "labels": [
      "Community contribution",
      "Manage"
    ],
89 90 91 92 93 94 95 96 97 98
    "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",
99 100 101
      "due_date": "2018-09-22",
      "start_date": "2018-08-08",
      "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
102 103 104 105 106 107
    },
    "merge_when_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
108
    "discussion_locked": null,
109 110
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
111 112 113
    "allow_collaboration": false,
    "allow_maintainer_to_push": false,
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
114 115 116 117 118
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
119 120
    },
    "squash": false
121 122 123 124 125 126
  }
]
```

## List project merge requests

127
Get all merge requests for this project.
128
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`).
129
The pagination parameters `page` and `per_page` can be used to restrict the list of merge requests.
Valeriy Sizov's avatar
Valeriy Sizov committed
130 131

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

141 142 143 144 145 146 147 148 149
`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.

150

Valeriy Sizov's avatar
Valeriy Sizov committed
151 152
Parameters:

Hiroyuki Sato's avatar
Hiroyuki Sato committed
153 154 155 156
| Attribute           | Type           | Required | Description                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `id`                | integer        | yes      | The ID of a project                                                                                                            |
| `iids[]`            | Array[integer] | no       | Return the request having the given `iid`                                                                                      |
157
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                               |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
158 159 160 161 162
| `order_by`          | string         | no       | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                        |
| `sort`              | string         | no       | Return requests sorted in `asc` or `desc` order. Default is `desc`                                                             |
| `milestone`         | string         | no       | Return merge requests for a specific milestone                                                                                 |
| `view`              | string         | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                                      |
| `labels`            | string         | no       | Return merge requests matching a comma separated list of labels                                                                |
163 164 165 166
| `created_after`     | datetime       | no       | Return merge requests created on or after the given time                                                                       |
| `created_before`    | datetime       | no       | Return merge requests created on or before the given time                                                                      |
| `updated_after`     | datetime       | no       | Return merge requests updated on or after the given time                                                                       |
| `updated_before`    | datetime       | no       | Return merge requests updated on or before the given time                                                                      |
167
| `scope`             | string         | no       | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13060] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
168
| `author_id`         | integer        | no       | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_                                 |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
169
| `assignee_id`       | integer        | no       | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced][ce-13060] in GitLab 9.5)_ |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
170
| `my_reaction_emoji` | string         | no       | Return merge requests reacted by the authenticated user by the given `emoji` _([Introduced][ce-14016] in GitLab 10.0)_         |
171 172
| `source_branch`     | string   | no       | Return merge requests with the given source branch                                                                     |
| `target_branch`     | string   | no       | Return merge requests with the given target branch                                                                     |
173
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |
Valeriy Sizov's avatar
Valeriy Sizov committed
174 175 176

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
177 178 179 180 181
  {
    "id": 1,
    "iid": 1,
    "project_id": 3,
    "title": "test1",
182
    "description": "fixed login page css paddings",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
183
    "state": "opened",
184 185
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
186 187
    "target_branch": "master",
    "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
188 189 190 191 192
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
193
      "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
194
      "state": "active",
195 196
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
197 198 199 200
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
201
      "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
202
      "state": "active",
203 204
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
205
    },
Ben Boeckel's avatar
Ben Boeckel committed
206 207
    "source_project_id": 2,
    "target_project_id": 3,
208 209 210 211
    "labels": [
      "Community contribution",
      "Manage"
    ],
212 213 214 215 216 217 218 219 220 221
    "work_in_progress": false,
    "milestone": {
      "id": 5,
      "iid": 1,
      "project_id": 3,
      "title": "v2.0",
      "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
      "state": "closed",
      "created_at": "2015-02-02T19:49:26.013Z",
      "updated_at": "2015-02-02T19:49:26.013Z",
222 223 224
      "due_date": "2018-09-22",
      "start_date": "2018-08-08",
      "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
225
    },
226
    "merge_when_pipeline_succeeds": true,
227
    "merge_status": "can_be_merged",
228 229
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
230
    "user_notes_count": 1,
231
    "discussion_locked": null,
232
    "should_remove_source_branch": true,
233
    "force_remove_source_branch": false,
234 235 236
    "allow_collaboration": false,
    "allow_maintainer_to_push": false,
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
237 238 239 240 241
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
242 243
    },
    "squash": false
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
244
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
245 246 247
]
```

248 249 250
## List group merge requests

Get all merge requests for this group and its subgroups.
251
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`).
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
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                                                                                                           |
270
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                               |
271 272 273 274 275 276 277 278 279 280 281
| `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)_                                 |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
282
| `assignee_id`       | integer        | no       | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced][ce-13060] in GitLab 9.5)_ |
283 284 285 286 287 288 289 290 291 292 293 294
| `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,
    "project_id": 3,
    "title": "test1",
295
    "description": "fixed login page css paddings",
296 297 298
    "state": "opened",
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
299 300
    "target_branch": "master",
    "source_branch": "test1",
301 302 303 304 305
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
306
      "username": "admin",
307
      "state": "active",
308 309
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
310 311 312 313
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
314
      "username": "admin",
315
      "state": "active",
316 317
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
318 319 320
    },
    "source_project_id": 2,
    "target_project_id": 3,
321 322 323 324
    "labels": [
      "Community contribution",
      "Manage"
    ],
325 326 327 328 329 330 331 332 333 334
    "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",
335 336 337
      "due_date": "2018-10-22",
      "start_date": "2018-09-08",
      "web_url": "gitlab.example.com/my-group/my-project/milestones/1"
338 339 340 341 342 343
    },
    "merge_when_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
344
    "discussion_locked": null,
345 346
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
347
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
348 349 350 351 352
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
353 354
    },
    "squash": false
355 356 357 358
  }
]
```

359 360
## Get single MR

361
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
362

363 364 365 366 367
**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
368
```
369
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
370 371 372 373
```

Parameters:

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

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
381 382 383 384
  "id": 1,
  "iid": 1,
  "project_id": 3,
  "title": "test1",
385 386
  "description": "fixed login page css paddings",
  "state": "opened",
387 388
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
389 390
  "target_branch": "master",
  "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
391 392 393
  "upvotes": 0,
  "downvotes": 0,
  "author": {
394 395 396 397 398 399
    "id": 1,
    "name": "Administrator",
    "username": "admin",
    "state": "active",
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
400 401
  },
  "assignee": {
402 403 404 405 406 407
    "id": 1,
    "name": "Administrator",
    "username": "admin",
    "state": "active",
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
408
  },
Ben Boeckel's avatar
Ben Boeckel committed
409 410
  "source_project_id": 2,
  "target_project_id": 3,
411 412 413 414
  "labels": [
    "Community contribution",
    "Manage"
  ],
415 416 417 418 419 420 421 422 423 424
  "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",
425 426 427
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
428
  },
429
  "merge_when_pipeline_succeeds": true,
430
  "merge_status": "can_be_merged",
431
  "sha": "8888888888888888888888888888888888888888",
432
  "merge_commit_sha": null,
433
  "user_notes_count": 1,
434
  "discussion_locked": null,
435
  "should_remove_source_branch": true,
436
  "force_remove_source_branch": false,
437 438 439
  "allow_collaboration": false,
  "allow_maintainer_to_push": false,
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
440 441 442 443 444
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
haseeb's avatar
haseeb committed
445
  },
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
haseeb's avatar
haseeb committed
462 463
  "first_deployed_to_production_at": null,
  "pipeline": {
464 465 466 467 468
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
469
  },
470
  "diff_refs": {
471 472 473
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
474
  },
475
  "diverged_commits_count": 2
Valeriy Sizov's avatar
Valeriy Sizov committed
476 477 478
}
```

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
## 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"
  },
]
```

514 515
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
516
Get a list of merge request commits.
517 518

```
519
GET /projects/:id/merge_requests/:merge_request_iid/commits
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


```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
537
    "message": "Replace sanitize with escape once"
538 539 540 541 542 543 544 545
  },
  {
    "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
546
    "message": "Sanitize for network graph"
547 548 549 550
  }
]
```

551 552
## Get single MR changes

553
Shows information about the merge request including its files and changes.
554 555

```
556
GET /projects/:id/merge_requests/:merge_request_iid/changes
557 558 559 560
```

Parameters:

561
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
562
- `merge_request_iid` (required) - The internal ID of the merge request
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581

```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",
582 583
    "avatar_url": "http://www.gravatar.com/avatar/b95567800f828948baf5f4160ebb2473?s=40&d=identicon",
    "web_url" : "https://gitlab.example.com/jarrett"
584 585 586 587 588 589
  },
  "assignee": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
590 591
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon",
    "web_url" : "https://gitlab.example.com/root"
592 593 594 595
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
596 597
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
598 599 600 601 602 603 604 605 606 607 608
  "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
  },
609
  "merge_when_pipeline_succeeds": true,
610
  "merge_status": "can_be_merged",
611
  "subscribed" : true,
612 613
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
614
  "user_notes_count": 1,
615
  "changes_count": "1",
616 617
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
618
  "squash": false,
619
  "web_url": "http://example.com/example/example/merge_requests/1",
620
  "discussion_locked": false,
621 622 623 624 625 626
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
627
  "changes": [
628 629 630 631 632 633 634 635 636 637 638 639 640 641
    {
    "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
    }
  ]
}
```

642 643
## List MR pipelines

644 645
> [Introduced][ce-15454] in GitLab 10.5.0.

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
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
668 669
## Create MR

670
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
671
```
672
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
673 674
```

675 676 677 678 679 680 681 682 683 684
| 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                                         |
685
| `milestone_id`             | integer | no       | The global ID of a milestone                                                           |
686
| `remove_source_branch`     | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
687 688
| `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                                             |
689
| `squash`                   | boolean | no       | Squash commits into a single commit when merging                                |
Valeriy Sizov's avatar
Valeriy Sizov committed
690 691 692

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
693
  "id": 1,
694
  "iid": 1,
695
  "project_id": 3,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
696
  "title": "test1",
697
  "description": "fixed login page css paddings",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
698
  "state": "opened",
699 700 701 702
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
703 704 705 706 707
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
708
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
709
    "state": "active",
710 711
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
712 713 714 715
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
716
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
717
    "state": "active",
718 719
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
720
  },
721 722 723 724 725 726
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
727 728 729 730
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
731
    "project_id": 3,
732 733 734 735 736
    "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",
737 738 739
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
740
  },
741
  "merge_when_pipeline_succeeds": true,
742
  "merge_status": "can_be_merged",
743 744
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
745 746
  "user_notes_count": 1,
  "discussion_locked": null,
747
  "should_remove_source_branch": true,
748
  "force_remove_source_branch": false,
749
  "allow_collaboration": false,
750
  "allow_maintainer_to_push": false,
751
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
752 753 754 755 756
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
  },
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
  "first_deployed_to_production_at": null,
  "pipeline": {
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
  },
  "diff_refs": {
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
  },
  "diverged_commits_count": 2
Valeriy Sizov's avatar
Valeriy Sizov committed
788 789 790 791 792
}
```

## Update MR

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

```
796
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
797 798
```

799 800 801 802 803 804 805
| 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.  |
806
| `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.|
807 808 809 810
| `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 |
811
| `squash`                   | boolean | no       | Squash commits into a single commit when merging |
812
| `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. |
813 814
| `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
815

816 817
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
818 819
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
820
  "id": 1,
821
  "iid": 1,
822
  "project_id": 3,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
823
  "title": "test1",
824
  "description": "fixed login page css paddings",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
825
  "state": "opened",
826 827 828 829
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
830 831 832 833 834
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
835
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
836
    "state": "active",
837 838
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
839 840 841 842
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
843
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
844
    "state": "active",
845 846
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
847
  },
848 849 850 851 852 853
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
854 855 856 857
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
858
    "project_id": 3,
859 860 861 862 863
    "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",
864 865 866
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
867
  },
868
  "merge_when_pipeline_succeeds": true,
869
  "merge_status": "can_be_merged",
870 871
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
872
  "user_notes_count": 1,
873
  "discussion_locked": null,
874
  "should_remove_source_branch": true,
875
  "force_remove_source_branch": false,
876
  "allow_collaboration": false,
877
  "allow_maintainer_to_push": false,
878
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
879 880 881 882 883
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
  },
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
  "first_deployed_to_production_at": null,
  "pipeline": {
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
  },
  "diff_refs": {
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
  },
  "diverged_commits_count": 2
Valeriy Sizov's avatar
Valeriy Sizov committed
915 916
}
```
917

918 919 920
## 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
921 922

```
923
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
924 925
```

926 927 928
| 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 |
929
| `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
930

931
```bash
932
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
933 934
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
935 936
## Accept MR

937
Merge changes submitted with MR using this API.
938 939


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

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

944
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'
945

946
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
947 948

```
949
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
950 951 952 953
```

Parameters:

954
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
955
- `merge_request_iid` (required)            - Internal ID of MR
956 957
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
958
- `merge_when_pipeline_succeeds` (optional) - if `true` the MR is merged when the pipeline succeeds
959
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
960 961 962 963

```json
{
  "id": 1,
964
  "iid": 1,
965 966
  "project_id": 3,
  "title": "test1",
967 968 969 970 971 972
  "description": "fixed login page css paddings",
  "state": "opened",
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
973 974 975 976 977
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
978
    "username": "admin",
979
    "state": "active",
980 981
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
982 983 984 985
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
986
    "username": "admin",
987
    "state": "active",
988 989
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
990
  },
991 992 993 994 995 996
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
997 998 999 1000
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
1001
    "project_id": 3,
1002 1003 1004 1005 1006
    "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",
1007 1008 1009
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
1010
  },
1011
  "merge_when_pipeline_succeeds": true,
1012
  "merge_status": "can_be_merged",
1013
  "sha": "8888888888888888888888888888888888888888",
1014
  "merge_commit_sha": null,
1015
  "user_notes_count": 1,
1016
  "discussion_locked": null,
1017
  "should_remove_source_branch": true,
1018
  "force_remove_source_branch": false,
1019 1020 1021
  "allow_collaboration": false,
  "allow_maintainer_to_push": false,
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
1022 1023 1024 1025 1026
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
  },
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
  "first_deployed_to_production_at": null,
  "pipeline": {
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
  },
  "diff_refs": {
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
  },
  "diverged_commits_count": 2
1058 1059 1060
}
```

1061
## Cancel Merge When Pipeline Succeeds
1062

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

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

1067
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
1068
```
1069
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
1070 1071 1072
```
Parameters:

1073
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
1074
- `merge_request_iid` (required) - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1075 1076 1077 1078

```json
{
  "id": 1,
1079
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1080 1081
  "project_id": 3,
  "title": "test1",
1082
  "description": "fixed login page css paddings",
1083
  "state": "opened",
1084 1085 1086 1087
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1088 1089 1090 1091 1092
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
1093
    "username": "admin",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1094
    "state": "active",
1095 1096
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1097 1098 1099 1100
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
1101
    "username": "admin",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1102
    "state": "active",
1103 1104
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
1105
  },
1106 1107 1108 1109 1110 1111
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
1112 1113 1114 1115
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
1116
    "project_id": 3,
1117 1118 1119 1120 1121
    "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",
1122 1123 1124
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
1125
  },
1126
  "merge_when_pipeline_succeeds": false,
1127
  "merge_status": "can_be_merged",
1128 1129
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
1130
  "user_notes_count": 1,
1131
  "discussion_locked": null,
1132
  "should_remove_source_branch": true,
1133
  "force_remove_source_branch": false,
1134 1135 1136
  "allow_collaboration": false,
  "allow_maintainer_to_push": false,
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
1137 1138 1139 1140 1141
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
  },
  "squash": false,
  "subscribed": false,
  "changes_count": "1",
  "merged_by": {
    "id": 87854,
    "name": "Douwe Maan",
    "username": "DouweM",
    "state": "active",
    "avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
    "web_url": "https://gitlab.com/DouweM"
  },
  "merged_at": "2018-09-07T11:16:17.520Z",
  "closed_by": null,
  "closed_at": null,
  "latest_build_started_at": "2018-09-07T07:27:38.472Z",
  "latest_build_finished_at": "2018-09-07T08:07:06.012Z",
  "first_deployed_to_production_at": null,
  "pipeline": {
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
  },
  "diff_refs": {
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
  },
  "diverged_commits_count": 2
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1173 1174 1175
}
```

bb-froggy's avatar
typo  
bb-froggy committed
1176
## Comments on merge requests
1177

1178
Comments are done via the [notes](notes.md) resource.
1179 1180 1181 1182 1183 1184

## List issues that will close on merge

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

```
1185
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
1186 1187
```

1188 1189
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |