GitLab steht Mittwoch, den 23. September, zwischen 10:00 und 12:00 Uhr aufgrund von Wartungsarbeiten nicht zur Verfügung.

merge_requests.md 72.8 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                                                                                                            |
| ------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
33
| `state`             | string   | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                             |
34 35
| `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`                                                     |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
36
| `milestone`         | string   | no       | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. |
37
| `view`              | string   | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                              |
38
| `labels`            | string   | no       | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. |
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. |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
46
| `my_reaction_emoji` | string   | no       | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([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`                                                          |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
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 61 62 63 64 65 66 67 68 69 70 71
    "state": "merged",
    "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,
72 73
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
74 75
    "target_branch": "master",
    "source_branch": "test1",
76 77 78 79 80
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
81
      "username": "admin",
82
      "state": "active",
83 84
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
85 86 87 88
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
89
      "username": "admin",
90
      "state": "active",
91 92
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
93 94 95
    },
    "source_project_id": 2,
    "target_project_id": 3,
96 97 98 99
    "labels": [
      "Community contribution",
      "Manage"
    ],
100 101 102 103 104 105 106 107 108 109
    "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",
110 111 112
      "due_date": "2018-09-22",
      "start_date": "2018-08-08",
      "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
113 114 115 116 117 118
    },
    "merge_when_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
119
    "discussion_locked": null,
120 121
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
122 123 124
    "allow_collaboration": false,
    "allow_maintainer_to_push": false,
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
125 126 127 128 129
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
130 131
    },
    "squash": false
132 133 134 135 136 137
  }
]
```

## List project merge requests

138
Get all merge requests for this project.
139
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`).
140
The pagination parameters `page` and `per_page` can be used to restrict the list of merge requests.
Valeriy Sizov's avatar
Valeriy Sizov committed
141 142

```
143
GET /projects/:id/merge_requests
144 145
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
146
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
147
GET /projects/:id/merge_requests?milestone=release
148
GET /projects/:id/merge_requests?labels=bug,reproduced
149
GET /projects/:id/merge_requests?my_reaction_emoji=star
Valeriy Sizov's avatar
Valeriy Sizov committed
150 151
```

152 153 154 155 156 157 158 159 160
`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.

161

Valeriy Sizov's avatar
Valeriy Sizov committed
162 163
Parameters:

Hiroyuki Sato's avatar
Hiroyuki Sato committed
164 165 166 167
| Attribute           | Type           | Required | Description                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `id`                | integer        | yes      | The ID of a project                                                                                                            |
| `iids[]`            | Array[integer] | no       | Return the request having the given `iid`                                                                                      |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
168
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                     |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
169 170
| `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`                                                             |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
171
| `milestone`         | string         | no       | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
172
| `view`              | string         | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                                      |
173
| `labels`            | string         | no       | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. |
174 175 176 177
| `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                                                                      |
178
| `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
179
| `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
180
| `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)_ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
181
| `my_reaction_emoji` | string         | no       | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
182 183
| `source_branch`     | string         | no       | Return merge requests with the given source branch                                                                             |
| `target_branch`     | string         | no       | Return merge requests with the given target branch                                                                             |
184
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |
Valeriy Sizov's avatar
Valeriy Sizov committed
185 186 187

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
188 189 190 191 192
  {
    "id": 1,
    "iid": 1,
    "project_id": 3,
    "title": "test1",
193
    "description": "fixed login page css paddings",
194 195 196 197 198 199 200 201 202 203 204 205
    "state": "merged",
    "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,
206 207
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
208 209
    "target_branch": "master",
    "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
210 211 212 213 214
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
215
      "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
216
      "state": "active",
217 218
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
219 220 221 222
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
223
      "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
224
      "state": "active",
225 226
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
227
    },
Ben Boeckel's avatar
Ben Boeckel committed
228 229
    "source_project_id": 2,
    "target_project_id": 3,
230 231 232 233
    "labels": [
      "Community contribution",
      "Manage"
    ],
234 235 236 237 238 239 240 241 242 243
    "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",
244 245 246
      "due_date": "2018-09-22",
      "start_date": "2018-08-08",
      "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
247
    },
248
    "merge_when_pipeline_succeeds": true,
249
    "merge_status": "can_be_merged",
250 251
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
252
    "user_notes_count": 1,
253
    "discussion_locked": null,
254
    "should_remove_source_branch": true,
255
    "force_remove_source_branch": false,
256 257 258
    "allow_collaboration": false,
    "allow_maintainer_to_push": false,
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
259 260 261 262 263
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
264 265
    },
    "squash": false
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
266
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
267 268 269
]
```

270 271 272
## List group merge requests

Get all merge requests for this group and its subgroups.
273
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`).
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
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                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
291 292 293 294 295
| `id`                | integer        | yes      | The ID of a group                                                                                                              |
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, `locked`, or `merged`                                     |
| `order_by`          | string         | no       | Return merge requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                  |
| `sort`              | string         | no       | Return merge requests sorted in `asc` or `desc` order. Default is `desc`                                                       |
| `milestone`         | string         | no       | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. |
296
| `view`              | string         | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                                      |
297
| `labels`            | string         | no       | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. |
298 299 300 301 302 303
| `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
304
| `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)_ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
305
| `my_reaction_emoji` | string         | no       | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
306 307
| `source_branch`     | string         | no       | Return merge requests with the given source branch                                                                             |
| `target_branch`     | string         | no       | Return merge requests with the given target branch                                                                             |
308 309 310 311 312 313 314 315 316
| `search`            | string         | no       | Search merge requests against their `title` and `description`                                                                  |

```json
[
  {
    "id": 1,
    "iid": 1,
    "project_id": 3,
    "title": "test1",
317
    "description": "fixed login page css paddings",
318 319 320 321 322 323 324 325 326 327 328 329
    "state": "merged",
    "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,
330 331
    "created_at": "2017-04-29T08:46:00Z",
    "updated_at": "2017-04-29T08:46:00Z",
332 333
    "target_branch": "master",
    "source_branch": "test1",
334 335 336 337 338
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "name": "Administrator",
339
      "username": "admin",
340
      "state": "active",
341 342
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
343 344 345 346
    },
    "assignee": {
      "id": 1,
      "name": "Administrator",
347
      "username": "admin",
348
      "state": "active",
349 350
      "avatar_url": null,
      "web_url" : "https://gitlab.example.com/admin"
351 352 353
    },
    "source_project_id": 2,
    "target_project_id": 3,
354 355 356 357
    "labels": [
      "Community contribution",
      "Manage"
    ],
358 359 360 361 362 363 364 365 366 367
    "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",
368 369 370
      "due_date": "2018-10-22",
      "start_date": "2018-09-08",
      "web_url": "gitlab.example.com/my-group/my-project/milestones/1"
371 372 373 374 375 376
    },
    "merge_when_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
377
    "discussion_locked": null,
378 379
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
380
    "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
381 382 383 384 385
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
386 387
    },
    "squash": false
388 389 390 391
  }
]
```

392 393
## Get single MR

394
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
395

396 397 398 399 400
**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
401
```
402
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
403 404 405 406
```

Parameters:

407
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
408
- `merge_request_iid` (required) - The internal ID of the merge request
Phil Hughes's avatar
Phil Hughes committed
409
- `render_html` (optional) - If `true` response includes rendered HTML for title and description
410
- `include_diverged_commits_count` (optional) - If `true` response includes the commits behind the target branch
411
- `include_rebase_in_progress` (optional) - If `true` response includes whether a rebase operation is in progress
Valeriy Sizov's avatar
Valeriy Sizov committed
412 413 414

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
415 416 417 418
  "id": 1,
  "iid": 1,
  "project_id": 3,
  "title": "test1",
419
  "description": "fixed login page css paddings",
420
  "state": "merged",
421 422
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
423 424
  "target_branch": "master",
  "source_branch": "test1",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
425 426 427
  "upvotes": 0,
  "downvotes": 0,
  "author": {
428 429 430 431 432 433
    "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
434 435
  },
  "assignee": {
436 437 438 439 440 441
    "id": 1,
    "name": "Administrator",
    "username": "admin",
    "state": "active",
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
442
  },
Ben Boeckel's avatar
Ben Boeckel committed
443 444
  "source_project_id": 2,
  "target_project_id": 3,
445 446 447 448
  "labels": [
    "Community contribution",
    "Manage"
  ],
449 450 451 452 453 454 455 456 457 458
  "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",
459 460 461
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
462
  },
463
  "merge_when_pipeline_succeeds": true,
464
  "merge_status": "can_be_merged",
465
  "merge_error": null,
466
  "sha": "8888888888888888888888888888888888888888",
467
  "merge_commit_sha": null,
468
  "user_notes_count": 1,
469
  "discussion_locked": null,
470
  "should_remove_source_branch": true,
471
  "force_remove_source_branch": false,
472 473 474
  "allow_collaboration": false,
  "allow_maintainer_to_push": false,
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
475 476 477 478 479
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
haseeb's avatar
haseeb committed
480
  },
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
  "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
497 498
  "first_deployed_to_production_at": null,
  "pipeline": {
499 500 501 502 503
    "id": 29626725,
    "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "ref": "patch-28",
    "status": "success",
    "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
504
  },
505
  "diff_refs": {
506 507 508
    "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
    "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
    "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
509
  },
510 511
  "diverged_commits_count": 2,
  "rebase_in_progress": false
Valeriy Sizov's avatar
Valeriy Sizov committed
512 513 514
}
```

515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
## 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"
  },
]
```

550 551
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
552
Get a list of merge request commits.
553 554

```
555
GET /projects/:id/merge_requests/:merge_request_iid/commits
556 557 558 559
```

Parameters:

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


```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
573
    "message": "Replace sanitize with escape once"
574 575 576 577 578 579 580 581
  },
  {
    "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
582
    "message": "Sanitize for network graph"
583 584 585 586
  }
]
```

587 588
## Get single MR changes

589
Shows information about the merge request including its files and changes.
590 591

```
592
GET /projects/:id/merge_requests/:merge_request_iid/changes
593 594 595 596
```

Parameters:

597
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
598
- `merge_request_iid` (required) - The internal ID of the merge request
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617

```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",
618 619
    "avatar_url": "http://www.gravatar.com/avatar/b95567800f828948baf5f4160ebb2473?s=40&d=identicon",
    "web_url" : "https://gitlab.example.com/jarrett"
620 621 622 623 624 625
  },
  "assignee": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
626 627
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon",
    "web_url" : "https://gitlab.example.com/root"
628 629 630 631
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
632 633
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
634 635 636 637 638 639 640 641 642 643 644
  "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
  },
645
  "merge_when_pipeline_succeeds": true,
646
  "merge_status": "can_be_merged",
647
  "subscribed" : true,
648 649
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
650
  "user_notes_count": 1,
651
  "changes_count": "1",
652 653
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
654
  "squash": false,
655
  "web_url": "http://example.com/example/example/merge_requests/1",
656
  "discussion_locked": false,
657 658 659 660 661 662
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
663
  "changes": [
664 665 666 667 668 669 670 671 672 673 674 675 676 677
    {
    "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
    }
  ]
}
```

678 679
## List MR pipelines

680 681
> [Introduced][ce-15454] in GitLab 10.5.0.

682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
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
704 705
## Create MR

706
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
707
```
708
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
709 710
```

711 712 713 714 715 716 717 718 719 720
| 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                                         |
721
| `milestone_id`             | integer | no       | The global ID of a milestone                                                           |
722
| `remove_source_branch`     | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
723 724
| `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                                             |
725
| `squash`                   | boolean | no       | Squash commits into a single commit when merging                                |
Valeriy Sizov's avatar
Valeriy Sizov committed
726 727 728

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
729
  "id": 1,
730
  "iid": 1,
731
  "project_id": 3,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
732
  "title": "test1",
733
  "description": "fixed login page css paddings",
734
  "state": "merged",
735 736 737 738
  "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
739 740 741 742 743
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
744
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
745
    "state": "active",
746 747
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
748 749 750 751
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
752
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
753
    "state": "active",
754 755
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
756
  },
757 758 759 760 761 762
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
763 764 765 766
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
767
    "project_id": 3,
768 769 770 771 772
    "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",
773 774 775
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
776
  },
777
  "merge_when_pipeline_succeeds": true,
778
  "merge_status": "can_be_merged",
779
  "merge_error": null,
780 781
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
782 783
  "user_notes_count": 1,
  "discussion_locked": null,
784
  "should_remove_source_branch": true,
785
  "force_remove_source_branch": false,
786
  "allow_collaboration": false,
787
  "allow_maintainer_to_push": false,
788
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
789 790 791 792 793
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
  },
  "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
825 826 827 828 829
}
```

## Update MR

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

```
833
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
834 835
```

836 837 838 839 840 841 842
| 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.  |
843
| `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.|
844 845 846 847
| `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 |
848
| `squash`                   | boolean | no       | Squash commits into a single commit when merging |
849
| `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. |
850 851
| `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
852

853 854
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
855 856
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
857
  "id": 1,
858
  "iid": 1,
859
  "project_id": 3,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
860
  "title": "test1",
861
  "description": "fixed login page css paddings",
862
  "state": "merged",
863 864 865 866
  "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
867 868 869 870 871
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
872
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
873
    "state": "active",
874 875
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
876 877 878 879
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
880
    "username": "admin",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
881
    "state": "active",
882 883
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
884
  },
885 886 887 888 889 890
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
891 892 893 894
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
895
    "project_id": 3,
896 897 898 899 900
    "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",
901 902 903
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
904
  },
905
  "merge_when_pipeline_succeeds": true,
906
  "merge_status": "can_be_merged",
907
  "merge_error": null,
908 909
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
910
  "user_notes_count": 1,
911
  "discussion_locked": null,
912
  "should_remove_source_branch": true,
913
  "force_remove_source_branch": false,
914
  "allow_collaboration": false,
915
  "allow_maintainer_to_push": false,
916
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
917 918 919 920 921
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
  },
  "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
953 954
}
```
955

956 957 958
## 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
959 960

```
961
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
962 963
```

964 965 966
| 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 |
967
| `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
968

969
```bash
970
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/merge_requests/85
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
971 972
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
973 974
## Accept MR

975
Merge changes submitted with MR using this API.
976

977
If merge request is unable to be accepted (ie: Work in Progress, Closed, Pipeline Pending Completion, or Failed while requiring Success) - you'll get a `405` and the error message 'Method Not Allowed'
978

979
If it has some conflicts and can not be merged - you'll get a `406` and the error message 'Branch cannot be merged'
980

981
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'
982

983
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
984 985

```
986
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
987 988 989 990
```

Parameters:

991
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
992
- `merge_request_iid` (required)            - Internal ID of MR
993 994
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
995
- `merge_when_pipeline_succeeds` (optional) - if `true` the MR is merged when the pipeline succeeds
996
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
997 998 999 1000

```json
{
  "id": 1,
1001
  "iid": 1,
1002 1003
  "project_id": 3,
  "title": "test1",
1004
  "description": "fixed login page css paddings",
1005
  "state": "merged",
1006 1007 1008 1009
  "created_at": "2017-04-29T08:46:00Z",
  "updated_at": "2017-04-29T08:46:00Z",
  "target_branch": "master",
  "source_branch": "test1",
1010 1011 1012 1013 1014
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
1015
    "username": "admin",
1016
    "state": "active",
1017 1018
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
1019 1020 1021 1022
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
1023
    "username": "admin",
1024
    "state": "active",
1025 1026
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
1027
  },
1028 1029 1030 1031 1032 1033
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
1034 1035 1036 1037
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
1038
    "project_id": 3,
1039 1040 1041 1042 1043
    "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",
1044 1045 1046
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
1047
  },
1048
  "merge_when_pipeline_succeeds": true,
1049
  "merge_status": "can_be_merged",
1050
  "merge_error": null,
1051
  "sha": "8888888888888888888888888888888888888888",
1052
  "merge_commit_sha": null,
1053
  "user_notes_count": 1,
1054
  "discussion_locked": null,
1055
  "should_remove_source_branch": true,
1056
  "force_remove_source_branch": false,
1057 1058 1059
  "allow_collaboration": false,
  "allow_maintainer_to_push": false,
  "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
1060 1061 1062 1063 1064
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
  },
  "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
1096 1097 1098
}
```

1099
## Cancel Merge When Pipeline Succeeds
1100

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

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

1105
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
1106
```
1107
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
1108 1109 1110
```
Parameters:

1111
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
1112
- `merge_request_iid` (required) - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1113 1114 1115 1116

```json
{
  "id": 1,
1117
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1118 1119
  "project_id": 3,
  "title": "test1",
1120
  "description": "fixed login page css paddings",
1121
  "state": "merged",
1122 1123 1124 1125
  "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
1126 1127 1128 1129 1130
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "name": "Administrator",
1131
    "username": "admin",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1132
    "state": "active",
1133 1134
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1135 1136 1137 1138
  },
  "assignee": {
    "id": 1,
    "name": "Administrator",
1139
    "username": "admin",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1140
    "state": "active",
1141 1142
    "avatar_url": null,
    "web_url" : "https://gitlab.example.com/admin"
1143
  },
1144 1145 1146 1147 1148 1149
  "source_project_id": 2,
  "target_project_id": 3,
  "labels": [
    "Community contribution",
    "Manage"
  ],
1150 1151 1152 1153
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
1154
    "project_id": 3,
1155 1156 1157 1158 1159
    "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",
1160 1161 1162
    "due_date": "2018-09-22",
    "start_date": "2018-08-08",
    "web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
1163
  },
1164
  "merge_when_pipeline_succeeds": false,
1165
  "merge_status": "can_be_merged",
1166
  "merge_error": null,