merge_requests.md 53 KB
Newer Older
Marcia Ramos's avatar
Marcia Ramos committed
1
# Merge requests API
Marin Jankovski's avatar
Marin Jankovski committed
2

3 4
Every API call to merge requests must be authenticated.

Valeriy Sizov's avatar
Valeriy Sizov committed
5 6
## List merge requests

7 8 9 10 11 12
> [Introduced][ce-13060] in GitLab 9.5.

Get all merge requests the authenticated user has access to. By
default it returns only merge requests created by the current user. To
get all merge requests, use parameter `scope=all`.

13 14 15 16 17
The `state` parameter can be used to get only merge requests with a
given state (`opened`, `closed`, or `merged`) or all of them (`all`).
The pagination parameters `page` and `per_page` can be used to
restrict the list of merge requests.

18 19 20 21 22
**Note**: the `changes_count` value in the response is a string, not an
integer. This is because when an MR has too many changes to display and store,
it will be capped at 1,000. In that case, the API will return the string
`"1000+"` for the changes count.

23 24 25 26 27 28 29
```
GET /merge_requests
GET /merge_requests?state=opened
GET /merge_requests?state=all
GET /merge_requests?milestone=release
GET /merge_requests?labels=bug,reproduced
GET /merge_requests?author_id=5
30
GET /merge_requests?my_reaction_emoji=star
31 32 33 34 35
GET /merge_requests?scope=assigned-to-me
```

Parameters:

36 37 38 39 40 41 42 43 44 45 46 47 48
| Attribute           | Type     | Required | Description                                                                                                            |
| ------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `state`             | string   | no       | Return all merge requests or just those that are `opened`, `closed`, or `merged`                                       |
| `order_by`          | string   | no       | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                |
| `sort`              | string   | no       | Return requests sorted in `asc` or `desc` order. Default is `desc`                                                     |
| `milestone`         | string   | no       | Return merge requests for a specific milestone                                                                         |
| `view`              | string   | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                              |
| `labels`            | string   | no       | Return merge requests matching a comma separated list of labels                                                        |
| `created_after`     | datetime | no       | Return merge requests created after the given time (inclusive)                                                         |
| `created_before`    | datetime | no       | Return merge requests created before the given time (inclusive)                                                        |
| `scope`             | string   | no       | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all`. Defaults to `created-by-me`     |
| `author_id`         | integer  | no       | Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned-to-me`              |
| `assignee_id`       | integer  | no       | Returns merge requests assigned to the given user `id`                                                                 |
Hiroyuki Sato's avatar
Hiroyuki Sato committed
49
| `my_reaction_emoji` | string   | no       | Return merge requests reacted by the authenticated user by the given `emoji` _([Introduced][ce-14016] in GitLab 10.0)_ |
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

```json
[
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "username": "admin",
      "email": "admin@example.com",
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
      "email": "admin@example.com",
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "source_project_id": 2,
    "target_project_id": 3,
    "labels": [ ],
    "description": "fixed login page css paddings",
    "work_in_progress": false,
    "milestone": {
      "id": 5,
      "iid": 1,
      "project_id": 3,
      "title": "v2.0",
      "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
      "state": "closed",
      "created_at": "2015-02-02T19:49:26.013Z",
      "updated_at": "2015-02-02T19:49:26.013Z",
      "due_date": null
    },
    "merge_when_pipeline_succeeds": true,
    "merge_status": "can_be_merged",
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
    "user_notes_count": 1,
100
    "changes_count": "1",
101 102
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
103 104 105 106 107 108 109
    "web_url": "http://example.com/example/example/merge_requests/1",
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
110 111 112 113 114 115
  }
]
```

## List project merge requests

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

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

130 131 132 133 134 135 136 137 138
`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.

139 140 141 142 143
**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
144 145
Parameters:

Hiroyuki Sato's avatar
Hiroyuki Sato committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
| Attribute           | Type           | Required | Description                                                                                                                    |
| ------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `id`                | integer        | yes      | The ID of a project                                                                                                            |
| `iids[]`            | Array[integer] | no       | Return the request having the given `iid`                                                                                      |
| `state`             | string         | no       | Return all merge requests or just those that are `opened`, `closed`, or `merged`                                               |
| `order_by`          | string         | no       | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`                                        |
| `sort`              | string         | no       | Return requests sorted in `asc` or `desc` order. Default is `desc`                                                             |
| `milestone`         | string         | no       | Return merge requests for a specific milestone                                                                                 |
| `view`              | string         | no       | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request                                      |
| `labels`            | string         | no       | Return merge requests matching a comma separated list of labels                                                                |
| `created_after`     | datetime       | no       | Return merge requests created after the given time (inclusive)                                                                 |
| `created_before`    | datetime       | no       | Return merge requests created before the given time (inclusive)                                                                |
| `scope`             | string         | no       | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all` _([Introduced][ce-13060] in GitLab 9.5)_ |
| `author_id`         | integer        | no       | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_                                 |
| `assignee_id`       | integer        | no       | Returns merge requests assigned to the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_                                |
| `my_reaction_emoji` | string         | no       | Return merge requests reacted by the authenticated user by the given `emoji` _([Introduced][ce-14016] in GitLab 10.0)_         |
Valeriy Sizov's avatar
Valeriy Sizov committed
162 163 164

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
165 166 167 168 169 170 171 172 173 174 175 176 177
  {
    "id": 1,
    "iid": 1,
    "target_branch": "master",
    "source_branch": "test1",
    "project_id": 3,
    "title": "test1",
    "state": "opened",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "id": 1,
      "username": "admin",
178
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
179 180 181 182 183 184 185
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
186
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
187 188 189
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
190
    },
Ben Boeckel's avatar
Ben Boeckel committed
191 192
    "source_project_id": 2,
    "target_project_id": 3,
193
    "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
194
    "description": "fixed login page css paddings",
195 196 197 198 199 200 201 202 203 204 205 206
    "work_in_progress": false,
    "milestone": {
      "id": 5,
      "iid": 1,
      "project_id": 3,
      "title": "v2.0",
      "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
      "state": "closed",
      "created_at": "2015-02-02T19:49:26.013Z",
      "updated_at": "2015-02-02T19:49:26.013Z",
      "due_date": null
    },
207
    "merge_when_pipeline_succeeds": true,
208
    "merge_status": "can_be_merged",
209 210
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
211
    "user_notes_count": 1,
212
    "changes_count": "1",
213
    "should_remove_source_branch": true,
214
    "force_remove_source_branch": false,
Sean McGivern's avatar
Sean McGivern committed
215
    "squash": false,
216
    "web_url": "http://example.com/example/example/merge_requests/1",
217
    "discussion_locked": false,
218 219 220 221 222
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
223 224
    },
    "approvals_before_merge": null
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
225
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
226 227 228
]
```

229 230
## Get single MR

231
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
232 233

```
234
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
235 236 237 238
```

Parameters:

239
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
240
- `merge_request_iid` (required) - The internal ID of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
241 242 243

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
244 245 246 247 248 249 250 251 252 253 254 255
  "id": 1,
  "iid": 1,
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
256
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
257 258 259 260 261 262 263
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
264
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
265 266 267
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
268
  },
Ben Boeckel's avatar
Ben Boeckel committed
269 270
  "source_project_id": 2,
  "target_project_id": 3,
271
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
272
  "description": "fixed login page css paddings",
273 274 275 276 277 278 279 280 281 282 283 284
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 3,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
285
  "merge_when_pipeline_succeeds": true,
286
  "merge_status": "can_be_merged",
287
  "subscribed" : true,
288 289
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
290
  "user_notes_count": 1,
291
  "changes_count": "1",
292
  "should_remove_source_branch": true,
293
  "force_remove_source_branch": false,
Sean McGivern's avatar
Sean McGivern committed
294
  "squash": false,
295
  "web_url": "http://example.com/example/example/merge_requests/1",
296
  "discussion_locked": false,
297 298 299 300 301
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
302 303
  },
  "approvals_before_merge": null
Valeriy Sizov's avatar
Valeriy Sizov committed
304 305 306
}
```

307 308
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
309
Get a list of merge request commits.
310 311

```
312
GET /projects/:id/merge_requests/:merge_request_iid/commits
313 314 315 316
```

Parameters:

317
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
318
- `merge_request_iid` (required) - The internal ID of the merge request
319 320 321 322 323 324 325 326 327 328 329


```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
330
    "message": "Replace sanitize with escape once"
331 332 333 334 335 336 337 338
  },
  {
    "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
339
    "message": "Sanitize for network graph"
340 341 342 343
  }
]
```

344 345
## Get single MR changes

346
Shows information about the merge request including its files and changes.
347 348

```
349
GET /projects/:id/merge_requests/:merge_request_iid/changes
350 351 352 353
```

Parameters:

354
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
355
- `merge_request_iid` (required) - The internal ID of the merge request
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386

```json
{
  "id": 21,
  "iid": 1,
  "project_id": 4,
  "title": "Blanditiis beatae suscipit hic assumenda et molestias nisi asperiores repellat et.",
  "state": "reopened",
  "created_at": "2015-02-02T19:49:39.159Z",
  "updated_at": "2015-02-02T20:08:49.959Z",
  "target_branch": "secret_token",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Chad Hamill",
    "username": "jarrett",
    "id": 5,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/b95567800f828948baf5f4160ebb2473?s=40&d=identicon"
  },
  "assignee": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40&d=identicon"
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
387 388
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
389 390 391 392 393 394 395 396 397 398 399
  "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
  },
400
  "merge_when_pipeline_succeeds": true,
401
  "merge_status": "can_be_merged",
402
  "subscribed" : true,
403 404
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
405
  "user_notes_count": 1,
406
  "changes_count": "1",
407 408
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
Sean McGivern's avatar
Sean McGivern committed
409
  "squash": false,
410
  "web_url": "http://example.com/example/example/merge_requests/1",
411
  "discussion_locked": false,
412 413 414 415 416 417
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
418
  "changes": [
419 420 421 422 423 424 425 426 427 428
    {
    "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
    }
429 430
  ],
  "approvals_before_merge": null
431 432 433
}
```

Valeriy Sizov's avatar
Valeriy Sizov committed
434 435
## Create MR

436
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
437
```
438
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
439 440
```

441 442
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
443
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
444 445 446 447 448 449 450 451 452
| `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                                         |
| `milestone_id`         | integer | no       | The ID of a milestone                                                           |
| `remove_source_branch` | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
Nick Thomas's avatar
Nick Thomas committed
453 454 455 456 457 458 459 460 461 462 463
| `approvals_before_merge` | integer| no | Number of approvals required before this can be merged (see below) |
| `squash` | boolean| no | Squash commits into a single commit when merging |

If `approvals_before_merge` is not provided, it inherits the value from the
target project. If it is provided, then the following conditions must hold in
order for it to take effect:

1. The target project's `approvals_before_merge` must be greater than zero. (A
   value of zero disables approvals for that project.)
2. The provided value of `approvals_before_merge` must be greater than the
   target project's `approvals_before_merge`.
Valeriy Sizov's avatar
Valeriy Sizov committed
464 465 466

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
467
  "id": 1,
468
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
469 470 471 472 473 474 475 476 477 478
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
479
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
480 481 482 483 484 485 486
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
487
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
488 489 490
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
491
  },
492 493 494
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
495
  "description": "fixed login page css paddings",
496 497 498 499 500 501 502 503 504 505 506 507
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
508
  "merge_when_pipeline_succeeds": true,
509
  "merge_status": "can_be_merged",
510
  "subscribed" : true,
511 512
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
513
  "user_notes_count": 0,
514
  "changes_count": "1",
515
  "should_remove_source_branch": true,
516
  "force_remove_source_branch": false,
Sean McGivern's avatar
Sean McGivern committed
517
  "squash": false,
518
  "web_url": "http://example.com/example/example/merge_requests/1",
519
  "discussion_locked": false,
520 521 522 523 524
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
525 526
  },
  "approvals_before_merge": null
Valeriy Sizov's avatar
Valeriy Sizov committed
527 528 529 530 531
}
```

## Update MR

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

```
535
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
536 537
```

538 539
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
540
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
541 542 543 544 545 546 547 548 549
| `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       | Assignee user ID                                                                |
| `description`          | string  | no       | Description of MR                                                               |
| `state_event`          | string  | no       | New state (close/reopen)                                                        |
| `labels`               | string  | no       | Labels for MR as a comma-separated list                                         |
| `milestone_id`         | integer | no       | The ID of a milestone                                                           |
| `remove_source_branch` | boolean | no       | Flag indicating if a merge request should remove the source branch when merging |
Nick Thomas's avatar
Nick Thomas committed
550
| `squash` | boolean| no | Squash commits into a single commit when merging |
551
| `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. |
552

553 554
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
555 556
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
557
  "id": 1,
558
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
559 560 561 562 563 564 565 566 567
  "target_branch": "master",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
568
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
569 570 571 572 573 574 575
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
576
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
577 578 579
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
  "description": "description1",
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
597
  "merge_when_pipeline_succeeds": true,
598
  "merge_status": "can_be_merged",
599
  "subscribed" : true,
600 601
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
602
  "user_notes_count": 1,
603
  "changes_count": "1",
604
  "should_remove_source_branch": true,
605
  "force_remove_source_branch": false,
Sean McGivern's avatar
Sean McGivern committed
606
  "squash": false,
607
  "web_url": "http://example.com/example/example/merge_requests/1",
608
  "discussion_locked": false,
609 610 611 612 613
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
614 615
  },
  "approvals_before_merge": null
Valeriy Sizov's avatar
Valeriy Sizov committed
616 617
}
```
618

619 620 621
## Delete a merge request

Only for admins and project owners. Soft deletes the merge request in question.
622 623

```
624
DELETE /projects/:id/merge_requests/:merge_request_iid
625 626
```

627 628 629
| 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 |
630
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
631

632
```bash
633
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/4/merge_requests/85
634 635
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
636 637
## Accept MR

638
Merge changes submitted with MR using this API.
639 640


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

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

645
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'
646

647
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
648 649

```
650
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
651 652 653 654
```

Parameters:

655
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
656
- `merge_request_iid` (required)            - Internal ID of MR
657 658
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
659
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
660
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
661 662 663 664

```json
{
  "id": 1,
665
  "iid": 1,
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "merged",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
    "email": "admin@example.com",
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
    "email": "admin@example.com",
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
688 689 690 691
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
692
  "description": "fixed login page css paddings",
693 694 695 696 697 698 699 700 701 702 703 704
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
705
  "merge_when_pipeline_succeeds": true,
706
  "merge_status": "can_be_merged",
707
  "subscribed" : true,
708 709
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
710
  "user_notes_count": 1,
711
  "changes_count": "1",
712
  "should_remove_source_branch": true,
713
  "force_remove_source_branch": false,
Sean McGivern's avatar
Sean McGivern committed
714
  "squash": false,
715
  "web_url": "http://example.com/example/example/merge_requests/1",
716
  "discussion_locked": false,
717 718 719 720 721
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
722 723
  },
  "approvals_before_merge": null
724 725 726
}
```

Patricio Cano's avatar
Patricio Cano committed
727 728 729 730 731 732 733 734
## Merge Request Approvals

>**Note:** This API endpoint is only available on 8.9 EE and above.

You can request information about a merge request's approval status using the
following endpoint:

```
735
GET /projects/:id/merge_requests/:merge_request_iid/approvals
Patricio Cano's avatar
Patricio Cano committed
736 737 738 739
```

**Parameters:**

740 741 742 743
| Attribute           | Type    | Required | Description         |
|---------------------|---------|----------|---------------------|
| `id`                | integer | yes      | The ID of a project |
| `merge_request_iid` | integer | yes      | The IID of MR       |
Patricio Cano's avatar
Patricio Cano committed
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776

```json
{
  "id": 5,
  "iid": 5,
  "project_id": 1,
  "title": "Approvals API",
  "description": "Test",
  "state": "opened",
  "created_at": "2016-06-08T00:19:52.638Z",
  "updated_at": "2016-06-08T21:20:42.470Z",
  "merge_status": "can_be_merged",
  "approvals_required": 2,
  "approvals_missing": 1,
  "approved_by": [
    {
      "user": {
        "name": "Administrator",
        "username": "root",
        "id": 1,
        "state": "active",
        "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon",
        "web_url": "http://localhost:3000/u/root"
      }
    }
  ]
}
```

## Approve Merge Request

>**Note:** This API endpoint is only available on 8.9 EE and above.

777
If you are allowed to, you can approve a merge request using the following
Patricio Cano's avatar
Patricio Cano committed
778 779 780
endpoint:

```
781
POST /projects/:id/merge_requests/:merge_request_iid/approve
Patricio Cano's avatar
Patricio Cano committed
782 783 784 785
```

**Parameters:**

786 787 788 789
| Attribute           | Type    | Required | Description         |
|---------------------|---------|----------|---------------------|
| `id`                | integer | yes      | The ID of a project |
| `merge_request_iid` | integer | yes      | The IID of MR       |
790 791 792 793 794 795
| `sha`               | string  | no       | The HEAD of the MR  |

The `sha` parameter works in the same way as
when [accepting a merge request](#accept-mr): if it is passed, then it must
match the current HEAD of the merge request for the approval to be added. If it
does not match, the response code will be `409`.
Patricio Cano's avatar
Patricio Cano committed
796 797 798 799 800 801 802 803 804 805 806 807 808

```json
{
  "id": 5,
  "iid": 5,
  "project_id": 1,
  "title": "Approvals API",
  "description": "Test",
  "state": "opened",
  "created_at": "2016-06-08T00:19:52.638Z",
  "updated_at": "2016-06-09T21:32:14.105Z",
  "merge_status": "can_be_merged",
  "approvals_required": 2,
809
  "approvals_left": 0,
Patricio Cano's avatar
Patricio Cano committed
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
  "approved_by": [
    {
      "user": {
        "name": "Administrator",
        "username": "root",
        "id": 1,
        "state": "active",
        "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon",
        "web_url": "http://localhost:3000/u/root"
      }
    },
    {
      "user": {
        "name": "Nico Cartwright",
        "username": "ryley",
        "id": 2,
        "state": "active",
        "avatar_url": "http://www.gravatar.com/avatar/cf7ad14b34162a76d593e3affca2adca?s=80\u0026d=identicon",
        "web_url": "http://localhost:3000/u/ryley"
      }
    }
  ]
}
```

835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
## Unapprove Merge Request

>**Note:** This API endpoint is only available on 9.0 EE and above.

If you did approve a merge request, you can unapprove it using the following
endpoint:

```
POST /projects/:id/merge_requests/:merge_request_iid/unapprove
```

**Parameters:**

| Attribute           | Type    | Required | Description         |
|---------------------|---------|----------|---------------------|
| `id`                | integer | yes      | The ID of a project |
| `merge_request_iid` | integer | yes      | The IID of MR       |

853
## Cancel Merge When Pipeline Succeeds
854

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

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

859
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
860
```
861
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
862 863 864
```
Parameters:

865
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
866
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
867 868 869 870

```json
{
  "id": 1,
871
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
872 873 874 875
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
876
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
877 878 879 880 881
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
882
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
883 884 885 886 887 888 889
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
890
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
891 892 893
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
894 895 896 897
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
898
  "description": "fixed login page css paddings",
899 900 901 902 903 904 905 906 907 908 909 910
  "work_in_progress": false,
  "milestone": {
    "id": 5,
    "iid": 1,
    "project_id": 4,
    "title": "v2.0",
    "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
    "state": "closed",
    "created_at": "2015-02-02T19:49:26.013Z",
    "updated_at": "2015-02-02T19:49:26.013Z",
    "due_date": null
  },
911
  "merge_when_pipeline_succeeds": true,
912
  "merge_status": "can_be_merged",
913
  "subscribed" : true,
914 915
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
916
  "user_notes_count": 1,
917
  "changes_count": "1",
918
  "should_remove_source_branch": true,
919
  "force_remove_source_branch": false,
Sean McGivern's avatar
Sean McGivern committed
920
  "squash": false,
921
  "web_url": "http://example.com/example/example/merge_requests/1",
922
  "discussion_locked": false,
923 924 925 926 927
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
928 929
  },
  "approvals_before_merge": null
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
930 931 932
}
```

bb-froggy's avatar
typo  
bb-froggy committed
933
## Comments on merge requests
934

935
Comments are done via the [notes](notes.md) resource.
936 937 938 939 940 941

## List issues that will close on merge

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

```
942
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
943 944
```

945 946
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
947
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
948
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
949 950

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

954
Example response when the GitLab issue tracker is used:
955 956 957 958 959 960 961 962 963

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
964
         "web_url" : "https://gitlab.example.com/eileen.lowe",
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
         "name" : "Alexandra Bashirian",
         "avatar_url" : null,
         "username" : "eileen.lowe"
      },
      "milestone" : {
         "project_id" : 1,
         "description" : "Ducimus nam enim ex consequatur cumque ratione.",
         "state" : "closed",
         "due_date" : null,
         "iid" : 2,
         "created_at" : "2016-01-04T15:31:39.996Z",
         "title" : "v4.0",
         "id" : 17,
         "updated_at" : "2016-01-04T15:31:39.996Z"
      },
      "project_id" : 1,
      "assignee" : {
         "state" : "active",
         "id" : 1,
         "name" : "Administrator",
985
         "web_url" : "https://gitlab.example.com/root",
986 987 988 989 990 991 992 993
         "avatar_url" : null,
         "username" : "root"
      },
      "updated_at" : "2016-01-04T15:31:51.081Z",
      "id" : 76,
      "title" : "Consequatur vero maxime deserunt laboriosam est voluptas dolorem.",
      "created_at" : "2016-01-04T15:31:51.081Z",
      "iid" : 6,
994
      "labels" : [],
995
      "user_notes_count": 1,
996
      "changes_count": "1",
997
      "approvals_before_merge": null
998
   }
999 1000
]
```
1001

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
Example response when an external issue tracker (e.g. JIRA) is used:

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

1013 1014
## Subscribe to a merge request

1015 1016
Subscribes the authenticated user to a merge request to receive notification. If the user is already subscribed to the merge request, the
status code `304` is returned.
1017 1018

```
1019
POST /projects/:id/merge_requests/:merge_request_iid/subscribe
1020 1021
```

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

```bash
1028
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
```

Example response:

```json
{
  "id": 17,
  "iid": 1,
  "project_id": 5,
  "title": "Et et sequi est impedit nulla ut rem et voluptatem.",
  "description": "Consequatur velit eos rerum optio autem. Quia id officia quaerat dolorum optio. Illo laudantium aut ipsum dolorem.",
  "state": "opened",
  "created_at": "2016-04-05T21:42:23.233Z",
  "updated_at": "2016-04-05T22:11:52.900Z",
  "target_branch": "ui-dev-kit",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Eileen Skiles",
    "username": "leila",
    "id": 19,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/39ce4a2822cc896933ffbd68c1470e55?s=80&d=identicon",
1053
    "web_url": "https://gitlab.example.com/leila"
1054 1055 1056 1057 1058 1059 1060
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
1061
    "web_url": "https://gitlab.example.com/carli"
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
  },
  "source_project_id": 5,
  "target_project_id": 5,
  "labels": [],
  "work_in_progress": false,
  "milestone": {
    "id": 7,
    "iid": 1,
    "project_id": 5,
    "title": "v2.0",
    "description": "Corrupti eveniet et velit occaecati dolorem est rerum aut.",
    "state": "closed",
    "created_at": "2016-04-05T21:41:40.905Z",
    "updated_at": "2016-04-05T21:41:40.905Z",
    "due_date": null
  },
1078
  "merge_when_pipeline_succeeds": false,
1079
  "merge_status": "cannot_be_merged",
1080 1081 1082
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
1083 1084
}
```
1085

1086 1087
## Unsubscribe from a merge request

1088
Unsubscribes the authenticated user from a merge request to not receive
1089 1090
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
1091 1092

```
1093
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
1094 1095
```

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

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

Example response:

```json
{
  "id": 17,
  "iid": 1,
  "project_id": 5,
  "title": "Et et sequi est impedit nulla ut rem et voluptatem.",
  "description": "Consequatur velit eos rerum optio autem. Quia id officia quaerat dolorum optio. Illo laudantium aut ipsum dolorem.",
  "state": "opened",
  "created_at": "2016-04-05T21:42:23.233Z",
  "updated_at": "2016-04-05T22:11:52.900Z",
  "target_branch": "ui-dev-kit",
  "source_branch": "version-1-9",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "name": "Eileen Skiles",
    "username": "leila",
    "id": 19,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/39ce4a2822cc896933ffbd68c1470e55?s=80&d=identicon",
1127
    "web_url": "https://gitlab.example.com/leila"
1128 1129 1130 1131 1132 1133 1134
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
1135
    "web_url": "https://gitlab.example.com/carli"
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
  },
  "source_project_id": 5,
  "target_project_id": 5,
  "labels": [],
  "work_in_progress": false,
  "milestone": {
    "id": 7,
    "iid": 1,
    "project_id": 5,
    "title": "v2.0",
    "description": "Corrupti eveniet et velit occaecati dolorem est rerum aut.",
    "state": "closed",
    "created_at": "2016-04-05T21:41:40.905Z",
    "updated_at": "2016-04-05T21:41:40.905Z",
    "due_date": null
  },
1152
  "merge_when_pipeline_succeeds": false,
1153
  "merge_status": "cannot_be_merged",
1154 1155 1156
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
1157 1158
}
```
1159 1160 1161

## Create a todo

1162
Manually creates a todo for the current user on a merge request.
1163
If there already exists a todo for the user on that merge request,
1164 1165 1166
status code `304` is returned.

```
1167
POST /projects/:id/merge_requests/:merge_request_iid/todo
1168 1169
```

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

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

Example response:

```json
{
  "id": 113,
  "project": {
    "id": 3,
    "name": "Gitlab Ci",
    "name_with_namespace": "Gitlab Org / Gitlab Ci",
    "path": "gitlab-ci",
    "path_with_namespace": "gitlab-org/gitlab-ci"
  },
  "author": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
1197
    "web_url": "https://gitlab.example.com/root"
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
  },
  "action_name": "marked",
  "target_type": "MergeRequest",
  "target": {
    "id": 27,
    "iid": 7,
    "project_id": 3,
    "title": "Et voluptas laudantium minus nihil recusandae ut accusamus earum aut non.",
    "description": "Veniam sunt nihil modi earum cumque illum delectus. Nihil ad quis distinctio quia. Autem eligendi at quibusdam repellendus.",
    "state": "opened",
    "created_at": "2016-06-17T07:48:04.330Z",
    "updated_at": "2016-07-01T11:14:15.537Z",
    "target_branch": "allow_regex_for_project_skip_ref",
    "source_branch": "backup",
    "upvotes": 0,
    "downvotes": 0,
    "author": {
      "name": "Jarret O'Keefe",
      "username": "francisca",
      "id": 14,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon",
1220 1221
      "web_url": "https://gitlab.example.com/francisca",
      "discussion_locked": false
1222 1223 1224 1225 1226 1227 1228
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
1229
      "web_url": "https://gitlab.example.com/barrett.krajcik"
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
    },
    "source_project_id": 3,
    "target_project_id": 3,
    "labels": [],
    "work_in_progress": false,
    "milestone": {
      "id": 27,
      "iid": 2,
      "project_id": 3,
      "title": "v1.0",
      "description": "Quis ea accusantium animi hic fuga assumenda.",
      "state": "active",
      "created_at": "2016-06-17T07:47:33.840Z",
      "updated_at": "2016-06-17T07:47:33.840Z",
      "due_date": null
    },
1246
    "merge_when_pipeline_succeeds": false,
1247 1248
    "merge_status": "unchecked",
    "subscribed": true,
1249 1250
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
1251
    "user_notes_count": 7,
1252
    "changes_count": "1",
1253
    "should_remove_source_branch": true,
1254
    "force_remove_source_branch": false,
Sean McGivern's avatar
Sean McGivern committed
1255
    "squash": true,
1256
    "web_url": "http://example.com/example/example/merge_requests/1"
1257 1258 1259 1260 1261 1262 1263
  },
  "target_url": "https://gitlab.example.com/gitlab-org/gitlab-ci/merge_requests/7",
  "body": "Et voluptas laudantium minus nihil recusandae ut accusamus earum aut non.",
  "state": "pending",
  "created_at": "2016-07-01T11:14:15.530Z"
}
```
1264 1265 1266 1267 1268 1269

## Get MR diff versions

Get a list of merge request diff versions.

```
1270
GET /projects/:id/merge_requests/:merge_request_iid/versions
1271 1272
```

1273 1274 1275 1276
| Attribute           | Type    | Required | Description                 |
| ---------           | ------- | -------- | ---------------------       |
| `id`                | String  | yes      | The ID of the project       |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1277

1278
```bash
1279
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions
1280
```
1281

1282
Example response:
1283 1284 1285

```json
[{
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
  "id": 110,
  "head_commit_sha": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-26T14:44:48.926Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1"
}, {
  "id": 108,
  "head_commit_sha": "3eed087b29835c48015768f839d76e5ea8f07a24",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-25T14:21:33.028Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1"
}]
```

## Get a single MR diff version

Get a single merge request diff version.

```
1311
GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id
1312 1313
```

1314 1315 1316 1317 1318
| Attribute           | Type    | Required | Description                              |
| ---------           | ------- | -------- | ---------------------                    |
| `id`                | String  | yes      | The ID of the project                    |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `version_id`        | integer | yes      | The ID of the merge request diff version |
1319 1320

```bash
1321
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1
1322 1323 1324 1325 1326 1327
```

Example response:

```json
{
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
  "id": 110,
  "head_commit_sha": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
  "base_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "start_commit_sha": "eeb57dffe83deb686a60a71c16c32f71046868fd",
  "created_at": "2016-07-26T14:44:48.926Z",
  "merge_request_id": 105,
  "state": "collected",
  "real_size": "1",
  "commits": [{
    "id": "33e2ee8579fda5bc36accc9c6fbd0b4fefda9e30",
    "short_id": "33e2ee85",
    "title": "Change year to 2018",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-26T17:44:29.000+03:00",
    "message": "Change year to 2018"
  }, {
    "id": "aa24655de48b36335556ac8a3cd8bb521f977cbd",
    "short_id": "aa24655d",
    "title": "Update LICENSE",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-25T17:21:53.000+03:00",
    "message": "Update LICENSE"
  }, {
    "id": "3eed087b29835c48015768f839d76e5ea8f07a24",
    "short_id": "3eed087b",
    "title": "Add license",
    "author_name": "Administrator",
    "author_email": "admin@example.com",
    "created_at": "2016-07-25T17:21:20.000+03:00",
    "message": "Add license"
  }],
  "diffs": [{
    "old_path": "LICENSE",
    "new_path": "LICENSE",
    "a_mode": "0",
    "b_mode": "100644",
    "diff": "--- /dev/null\n+++ b/LICENSE\n@@ -0,0 +1,21 @@\n+The MIT License (MIT)\n+\n+Copyright (c) 2018 Administrator\n+\n+Permission is hereby granted, free of charge, to any person obtaining a copy\n+of this software and associated documentation files (the \"Software\"), to deal\n+in the Software without restriction, including without limitation the rights\n+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n+copies of the Software, and to permit persons to whom the Software is\n+furnished to do so, subject to the following conditions:\n+\n+The above copyright notice and this permission notice shall be included in all\n+copies or substantial portions of the Software.\n+\n+THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n+SOFTWARE.\n",
    "new_file": true,
    "renamed_file": false,
    "deleted_file": false
  }]
1371
}
1372
```
1373 1374 1375 1376 1377
## Set a time estimate for a merge request

Sets an estimated time of work for this merge request.

```
1378
POST /projects/:id/merge_requests/:merge_request_iid/time_estimate
1379 1380
```

1381 1382
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
1383
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                      |
1384 1385
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1386 1387

```bash
1388
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_estimate?duration=3h30m
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406
```

Example response:

```json
{
  "human_time_estimate": "3h 30m",
  "human_total_time_spent": null,
  "time_estimate": 12600,
  "total_time_spent": 0
}
```

## Reset the time estimate for a merge request

Resets the estimated time for this merge request to 0 seconds.

```
1407
POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate
1408 1409
```

1410 1411
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
1412
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                          |
1413
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1414 1415

```bash
1416
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_time_estimate
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": null,
  "time_estimate": 0,
  "total_time_spent": 0
}
```

## Add spent time for a merge request

Adds spent time for this merge request

```
1435
POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time
1436 1437
```

1438 1439
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
1440
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                      |
1441 1442
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1443 1444

```bash
1445
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/add_spent_time?duration=1h
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": "1h",
  "time_estimate": 0,
  "total_time_spent": 3600
}
```

## Reset spent time for a merge request

Resets the total spent time for this merge request to 0 seconds.

```
1464
POST /projects/:id/merge_requests/:merge_request_iid/reset_spent_time
1465 1466
```

1467 1468
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
1469
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                          |
1470
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1471 1472

```bash
1473
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_spent_time
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
```

Example response:

```json
{
  "human_time_estimate": null,
  "human_total_time_spent": null,
  "time_estimate": 0,
  "total_time_spent": 0
}
```

## Get time tracking stats

```
1490
GET /projects/:id/merge_requests/:merge_request_iid/time_stats
1491 1492
```

1493 1494
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1495
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1496
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1497 1498

```bash
1499
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
```

Example response:

```json
{
  "human_time_estimate": "2h",
  "human_total_time_spent": "1h",
  "time_estimate": 7200,
  "total_time_spent": 3600
}
```
1512 1513

[ce-13060]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/13060
Hiroyuki Sato's avatar
Hiroyuki Sato committed
1514
[ce-14016]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14016