merge_requests.md 47.7 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 14 15 16 17 18 19 20 21 22 23 24
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.

```
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 27 28 29 30
GET /merge_requests?scope=assigned-to-me
```

Parameters:

31 32 33 34 35 36 37 38 39 40 41 42 43
| 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
44
| `my_reaction_emoji` | string   | no       | Return merge requests reacted by the authenticated user by the given `emoji` _([Introduced][ce-14016] in GitLab 10.0)_ |
45 46 47 48 49 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

```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,
    "should_remove_source_branch": true,
    "force_remove_source_branch": false,
97 98 99 100 101 102 103
    "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
    }
104 105 106 107 108 109
  }
]
```

## List project merge requests

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

```
115
GET /projects/:id/merge_requests
116 117
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
118
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
119
GET /projects/:id/merge_requests?milestone=release
120
GET /projects/:id/merge_requests?labels=bug,reproduced
121
GET /projects/:id/merge_requests?my_reaction_emoji=star
Valeriy Sizov's avatar
Valeriy Sizov committed
122 123
```

124 125 126 127 128 129 130 131 132
`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.

Valeriy Sizov's avatar
Valeriy Sizov committed
133 134
Parameters:

Hiroyuki Sato's avatar
Hiroyuki Sato committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
| 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
151 152 153

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
154 155 156 157 158 159 160 161 162 163 164 165 166
  {
    "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",
167
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
168 169 170 171 172 173 174
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
175
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
176 177 178
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
179
    },
Ben Boeckel's avatar
Ben Boeckel committed
180 181
    "source_project_id": 2,
    "target_project_id": 3,
182
    "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
183
    "description": "fixed login page css paddings",
184 185 186 187 188 189 190 191 192 193 194 195
    "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
    },
196
    "merge_when_pipeline_succeeds": true,
197
    "merge_status": "can_be_merged",
198 199
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
200 201
    "user_notes_count": 1,
    "should_remove_source_branch": true,
202
    "force_remove_source_branch": false,
203
    "web_url": "http://example.com/example/example/merge_requests/1",
204
    "discussion_locked": false,
205 206 207 208 209 210
    "time_stats": {
      "time_estimate": 0,
      "total_time_spent": 0,
      "human_time_estimate": null,
      "human_total_time_spent": null
    }
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
211
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
212 213 214
]
```

215 216
## Get single MR

217
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
218 219

```
220
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
221 222 223 224
```

Parameters:

225
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
226
- `merge_request_iid` (required) - The internal ID of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
227 228 229

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
230 231 232 233 234 235 236 237 238 239 240 241
  "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",
242
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
243 244 245 246 247 248 249
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
250
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
251 252 253
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
254
  },
Ben Boeckel's avatar
Ben Boeckel committed
255 256
  "source_project_id": 2,
  "target_project_id": 3,
257
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
258
  "description": "fixed login page css paddings",
259 260 261 262 263 264 265 266 267 268 269 270
  "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
  },
271
  "merge_when_pipeline_succeeds": true,
272
  "merge_status": "can_be_merged",
273
  "subscribed" : true,
274 275
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
276 277
  "user_notes_count": 1,
  "should_remove_source_branch": true,
278
  "force_remove_source_branch": false,
279
  "web_url": "http://example.com/example/example/merge_requests/1",
280
  "discussion_locked": false,
281 282 283 284 285 286
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
287 288 289
}
```

290 291
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
292
Get a list of merge request commits.
293 294

```
295
GET /projects/:id/merge_requests/:merge_request_iid/commits
296 297 298 299
```

Parameters:

300
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
301
- `merge_request_iid` (required) - The internal ID of the merge request
302 303 304 305 306 307 308 309 310 311 312


```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
313
    "message": "Replace sanitize with escape once"
314 315 316 317 318 319 320 321
  },
  {
    "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
322
    "message": "Sanitize for network graph"
323 324 325 326
  }
]
```

327 328
## Get single MR changes

329
Shows information about the merge request including its files and changes.
330 331

```
332
GET /projects/:id/merge_requests/:merge_request_iid/changes
333 334 335 336
```

Parameters:

337
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
338
- `merge_request_iid` (required) - The internal ID of the merge request
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369

```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": [ ],
370 371
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
372 373 374 375 376 377 378 379 380 381 382
  "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
  },
383
  "merge_when_pipeline_succeeds": true,
384
  "merge_status": "can_be_merged",
385
  "subscribed" : true,
386 387
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
388
  "user_notes_count": 1,
389 390
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
391
  "web_url": "http://example.com/example/example/merge_requests/1",
392
  "discussion_locked": false,
393 394 395 396 397 398
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
399
  "changes": [
400 401 402 403 404 405 406 407 408 409 410 411 412 413
    {
    "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
    }
  ]
}
```

Valeriy Sizov's avatar
Valeriy Sizov committed
414 415
## Create MR

416
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
417
```
418
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
419 420
```

421 422
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
423
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
424 425 426 427 428 429 430 431 432
| `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 |
Valeriy Sizov's avatar
Valeriy Sizov committed
433 434 435

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
436
  "id": 1,
437
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
438 439 440 441 442 443 444 445 446 447
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
448
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
449 450 451 452 453 454 455
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
456
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
457 458 459
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
460
  },
461 462 463
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
464
  "description": "fixed login page css paddings",
465 466 467 468 469 470 471 472 473 474 475 476
  "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
  },
477
  "merge_when_pipeline_succeeds": true,
478
  "merge_status": "can_be_merged",
479
  "subscribed" : true,
480 481
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
482 483
  "user_notes_count": 0,
  "should_remove_source_branch": true,
484
  "force_remove_source_branch": false,
485
  "web_url": "http://example.com/example/example/merge_requests/1",
486
  "discussion_locked": false,
487 488 489 490 491 492
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
493 494 495 496 497
}
```

## Update MR

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

```
501
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
502 503
```

504 505
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
506
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
507 508 509 510 511 512 513 514 515
| `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 |
516
| `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. |
Valeriy Sizov's avatar
Valeriy Sizov committed
517

518 519
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
520 521
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
522
  "id": 1,
523
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
524 525 526 527 528 529 530 531 532
  "target_branch": "master",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
533
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
534 535 536 537 538 539 540
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
541
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
542 543 544
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
  },
  "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
  },
562
  "merge_when_pipeline_succeeds": true,
563
  "merge_status": "can_be_merged",
564
  "subscribed" : true,
565 566
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
567 568
  "user_notes_count": 1,
  "should_remove_source_branch": true,
569
  "force_remove_source_branch": false,
570
  "web_url": "http://example.com/example/example/merge_requests/1",
571
  "discussion_locked": false,
572 573 574 575 576 577
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
578 579
}
```
580

581 582 583
## 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
584 585

```
586
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
587 588
```

589 590 591
| 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 |
592
| `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
593

594
```bash
595
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/4/merge_requests/85
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
596 597
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
598 599
## Accept MR

600
Merge changes submitted with MR using this API.
601 602


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

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

607
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'
608

609
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
610 611

```
612
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
613 614 615 616
```

Parameters:

617
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
618
- `merge_request_iid` (required)            - Internal ID of MR
619 620
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
621
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
622
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
623 624 625 626

```json
{
  "id": 1,
627
  "iid": 1,
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
  "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"
650 651 652 653
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
654
  "description": "fixed login page css paddings",
655 656 657 658 659 660 661 662 663 664 665 666
  "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
  },
667
  "merge_when_pipeline_succeeds": true,
668
  "merge_status": "can_be_merged",
669
  "subscribed" : true,
670 671
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
672 673
  "user_notes_count": 1,
  "should_remove_source_branch": true,
674
  "force_remove_source_branch": false,
675
  "web_url": "http://example.com/example/example/merge_requests/1",
676
  "discussion_locked": false,
677 678 679 680 681 682
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
683 684 685
}
```

686
## Cancel Merge When Pipeline Succeeds
687

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

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

692
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
693
```
694
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
695 696 697
```
Parameters:

698
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
699
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
700 701 702 703

```json
{
  "id": 1,
704
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
705 706 707 708
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
709
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
710 711 712 713 714
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
715
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
716 717 718 719 720 721 722
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
723
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
724 725 726
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
727 728 729 730
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
731
  "description": "fixed login page css paddings",
732 733 734 735 736 737 738 739 740 741 742 743
  "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
  },
744
  "merge_when_pipeline_succeeds": true,
745
  "merge_status": "can_be_merged",
746
  "subscribed" : true,
747 748
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
749 750
  "user_notes_count": 1,
  "should_remove_source_branch": true,
751
  "force_remove_source_branch": false,
752
  "web_url": "http://example.com/example/example/merge_requests/1",
753
  "discussion_locked": false,
754 755 756 757 758 759
  "time_stats": {
    "time_estimate": 0,
    "total_time_spent": 0,
    "human_time_estimate": null,
    "human_total_time_spent": null
  }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
760 761 762
}
```

bb-froggy's avatar
typo  
bb-froggy committed
763
## Comments on merge requests
764

765
Comments are done via the [notes](notes.md) resource.
766 767 768 769 770 771

## List issues that will close on merge

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

```
772
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
773 774
```

775 776
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
777
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
778
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
779 780

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

784
Example response when the GitLab issue tracker is used:
785 786 787 788 789 790 791 792 793

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
794
         "web_url" : "https://gitlab.example.com/eileen.lowe",
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
         "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",
815
         "web_url" : "https://gitlab.example.com/root",
816 817 818 819 820 821 822 823
         "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,
824 825
      "labels" : [],
      "user_notes_count": 1
826 827 828
   },
]
```
829

830 831 832 833 834 835 836 837 838 839 840
Example response when an external issue tracker (e.g. JIRA) is used:

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

841 842
## Subscribe to a merge request

843 844
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.
845 846

```
847
POST /projects/:id/merge_requests/:merge_request_iid/subscribe
848 849
```

850 851
| Attribute           | Type    | Required | Description                 |
| ---------           | ----    | -------- | -----------                 |
852
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user         |
853
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
854 855

```bash
856
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
```

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",
881
    "web_url": "https://gitlab.example.com/leila"
882 883 884 885 886 887 888
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
889
    "web_url": "https://gitlab.example.com/carli"
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
  },
  "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
  },
906
  "merge_when_pipeline_succeeds": false,
907
  "merge_status": "cannot_be_merged",
908 909 910
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
911 912
}
```
913

914 915
## Unsubscribe from a merge request

916
Unsubscribes the authenticated user from a merge request to not receive
917 918
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
919 920

```
921
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
922 923
```

924 925
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
926
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
927
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
928 929

```bash
930
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
```

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",
955
    "web_url": "https://gitlab.example.com/leila"
956 957 958 959 960 961 962
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
963
    "web_url": "https://gitlab.example.com/carli"
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
  },
  "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
  },
980
  "merge_when_pipeline_succeeds": false,
981
  "merge_status": "cannot_be_merged",
982 983 984
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
985 986
}
```
987 988 989

## Create a todo

990
Manually creates a todo for the current user on a merge request.
991
If there already exists a todo for the user on that merge request,
992 993 994
status code `304` is returned.

```
995
POST /projects/:id/merge_requests/:merge_request_iid/todo
996 997
```

998 999
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1000
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1001
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1002 1003

```bash
1004
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
```

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",
1025
    "web_url": "https://gitlab.example.com/root"
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
  },
  "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",
1048 1049
      "web_url": "https://gitlab.example.com/francisca",
      "discussion_locked": false
1050 1051 1052 1053 1054 1055 1056
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
1057
      "web_url": "https://gitlab.example.com/barrett.krajcik"
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
    },
    "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
    },
1074
    "merge_when_pipeline_succeeds": false,
1075 1076
    "merge_status": "unchecked",
    "subscribed": true,
1077 1078
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
1079 1080
    "user_notes_count": 7,
    "should_remove_source_branch": true,
1081 1082
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
1083 1084 1085 1086 1087 1088 1089
  },
  "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"
}
```
1090 1091 1092 1093 1094 1095

## Get MR diff versions

Get a list of merge request diff versions.

```
1096
GET /projects/:id/merge_requests/:merge_request_iid/versions
1097 1098
```

1099 1100 1101 1102
| Attribute           | Type    | Required | Description                 |
| ---------           | ------- | -------- | ---------------------       |
| `id`                | String  | yes      | The ID of the project       |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1103

1104
```bash
1105
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions
1106
```
1107

1108
Example response:
1109 1110 1111

```json
[{
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
  "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.

```
1137
GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id
1138 1139
```

1140 1141 1142 1143 1144
| 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 |
1145 1146

```bash
1147
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1
1148 1149 1150 1151 1152 1153
```

Example response:

```json
{
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
  "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
  }]
1197
}
1198
```
1199 1200 1201 1202 1203
## Set a time estimate for a merge request

Sets an estimated time of work for this merge request.

```
1204
POST /projects/:id/merge_requests/:merge_request_iid/time_estimate
1205 1206
```

1207 1208
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
1209
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                      |
1210 1211
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1212 1213

```bash
1214
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_estimate?duration=3h30m
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
```

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.

```
1233
POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate
1234 1235
```

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

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

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

```
1261
POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time
1262 1263
```

1264 1265
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
1266
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                      |
1267 1268
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1269 1270

```bash
1271
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/add_spent_time?duration=1h
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
```

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.

```
1290
POST /projects/:id/merge_requests/:merge_request_iid/reset_spent_time
1291 1292
```

1293 1294
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
1295
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                          |
1296
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1297 1298

```bash
1299
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_spent_time
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
```

Example response:

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

## Get time tracking stats

```
1316
GET /projects/:id/merge_requests/:merge_request_iid/time_stats
1317 1318
```

1319 1320
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1321
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1322
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1323 1324

```bash
1325
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
```

Example response:

```json
{
  "human_time_estimate": "2h",
  "human_total_time_spent": "1h",
  "time_estimate": 7200,
  "total_time_spent": 3600
}
```
Toon Claes's avatar