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

Valeriy Sizov's avatar
Valeriy Sizov committed
3 4
## List merge requests

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

```
10
GET /projects/:id/merge_requests
11 12
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
13
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
14
GET /projects/:id/merge_requests?milestone=release
15
GET /projects/:id/merge_requests?labels=bug,reproduced
Valeriy Sizov's avatar
Valeriy Sizov committed
16 17 18 19
```

Parameters:

20 21 22 23 24 25 26 27
| 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 |
28
| `view` | string | no | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request |
29
| `labels`  | string  | no | Return merge requests matching a comma separated list of labels |
30 31
| `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) |
Valeriy Sizov's avatar
Valeriy Sizov committed
32 33 34

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
35 36 37 38 39 40 41 42 43 44 45 46 47
  {
    "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",
48
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
49 50 51 52 53 54 55
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
56
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
57 58 59
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
60
    },
Ben Boeckel's avatar
Ben Boeckel committed
61 62
    "source_project_id": 2,
    "target_project_id": 3,
63
    "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
64
    "description": "fixed login page css paddings",
65 66 67 68 69 70 71 72 73 74 75 76
    "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
    },
77
    "merge_when_pipeline_succeeds": true,
78
    "merge_status": "can_be_merged",
79 80
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
81 82
    "user_notes_count": 1,
    "should_remove_source_branch": true,
83 84
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
85
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
86 87 88
]
```

89 90
## Get single MR

91
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
92 93

```
94
GET /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
95 96 97 98
```

Parameters:

99
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
100
- `merge_request_iid` (required) - The internal ID of the merge request
Valeriy Sizov's avatar
Valeriy Sizov committed
101 102 103

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
104 105 106 107 108 109 110 111 112 113 114 115
  "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",
116
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
117 118 119 120 121 122 123
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
124
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
125 126 127
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
128
  },
Ben Boeckel's avatar
Ben Boeckel committed
129 130
  "source_project_id": 2,
  "target_project_id": 3,
131
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
132
  "description": "fixed login page css paddings",
133 134 135 136 137 138 139 140 141 142 143 144
  "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
  },
145
  "merge_when_pipeline_succeeds": true,
146
  "merge_status": "can_be_merged",
147
  "subscribed" : true,
148 149
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
150 151
  "user_notes_count": 1,
  "should_remove_source_branch": true,
152 153
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
154 155 156
}
```

157 158
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
159
Get a list of merge request commits.
160 161

```
162
GET /projects/:id/merge_requests/:merge_request_iid/commits
163 164 165 166
```

Parameters:

167
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
168
- `merge_request_iid` (required) - The internal ID of the merge request
169 170 171 172 173 174 175 176 177 178 179


```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
180
    "message": "Replace sanitize with escape once"
181 182 183 184 185 186 187 188
  },
  {
    "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
189
    "message": "Sanitize for network graph"
190 191 192 193
  }
]
```

194 195
## Get single MR changes

196
Shows information about the merge request including its files and changes.
197 198

```
199
GET /projects/:id/merge_requests/:merge_request_iid/changes
200 201 202 203
```

Parameters:

204
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
205
- `merge_request_iid` (required) - The internal ID of the merge request
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236

```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": [ ],
237 238
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
239 240 241 242 243 244 245 246 247 248 249
  "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
  },
250
  "merge_when_pipeline_succeeds": true,
251
  "merge_status": "can_be_merged",
252
  "subscribed" : true,
253 254
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
255
  "user_notes_count": 1,
256 257
  "should_remove_source_branch": true,
  "force_remove_source_branch": false,
258
  "web_url": "http://example.com/example/example/merge_requests/1",
259
  "changes": [
260 261 262 263 264 265 266 267 268 269 270 271 272 273
    {
    "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
274 275
## Create MR

276
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
277
```
278
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
279 280
```

281 282
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
283
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
284 285 286 287 288 289 290 291 292
| `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
293 294 295

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
296
  "id": 1,
297
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
298 299 300 301 302 303 304 305 306 307
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
308
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
309 310 311 312 313 314 315
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
316
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
317 318 319
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
320
  },
321 322 323
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
324
  "description": "fixed login page css paddings",
325 326 327 328 329 330 331 332 333 334 335 336
  "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
  },
337
  "merge_when_pipeline_succeeds": true,
338
  "merge_status": "can_be_merged",
339
  "subscribed" : true,
340 341
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
342 343
  "user_notes_count": 0,
  "should_remove_source_branch": true,
344 345
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
346 347 348 349 350
}
```

## Update MR

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

```
354
PUT /projects/:id/merge_requests/:merge_request_iid
Valeriy Sizov's avatar
Valeriy Sizov committed
355 356
```

357 358
| Attribute              | Type    | Required | Description                                                                     |
| ---------              | ----    | -------- | -----------                                                                     |
359
| `id`                   | integer/string  | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
360 361 362 363 364 365 366 367 368
| `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 |
Valeriy Sizov's avatar
Valeriy Sizov committed
369

370 371
Must include at least one non-required attribute from above.

Valeriy Sizov's avatar
Valeriy Sizov committed
372 373
```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
374
  "id": 1,
375
  "iid": 1,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
376 377 378 379 380 381 382 383 384
  "target_branch": "master",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
385
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
386 387 388 389 390 391 392
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
393
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
394 395 396
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
  },
  "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
  },
414
  "merge_when_pipeline_succeeds": true,
415
  "merge_status": "can_be_merged",
416
  "subscribed" : true,
417 418
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
419 420
  "user_notes_count": 1,
  "should_remove_source_branch": true,
421 422
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Valeriy Sizov's avatar
Valeriy Sizov committed
423 424
}
```
425

426 427 428
## 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
429 430

```
431
DELETE /projects/:id/merge_requests/:merge_request_iid
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
432 433
```

434 435 436
| 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 |
437
| `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
438

439
```bash
440
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
441 442
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
443 444
## Accept MR

445
Merge changes submitted with MR using this API.
446 447


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

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

452
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'
453

454
If you don't have permissions to accept this merge request - you'll get a `401`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
455 456

```
457
PUT /projects/:id/merge_requests/:merge_request_iid/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
458 459 460 461
```

Parameters:

462
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
463
- `merge_request_iid` (required)            - Internal ID of MR
464 465
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
466
- `merge_when_pipeline_succeeds` (optional)    - if `true` the MR is merged when the pipeline succeeds
467
- `sha` (optional)                          - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
468 469 470 471

```json
{
  "id": 1,
472
  "iid": 1,
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
  "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"
495 496 497 498
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
499
  "description": "fixed login page css paddings",
500 501 502 503 504 505 506 507 508 509 510 511
  "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
  },
512
  "merge_when_pipeline_succeeds": true,
513
  "merge_status": "can_be_merged",
514
  "subscribed" : true,
515 516
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": "9999999999999999999999999999999999999999",
517 518
  "user_notes_count": 1,
  "should_remove_source_branch": true,
519 520
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
521 522 523
}
```

524
## Cancel Merge When Pipeline Succeeds
525

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

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

530
In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
531
```
532
PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds
533 534 535
```
Parameters:

536
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
537
- `merge_request_iid` (required)            - Internal ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
538 539 540 541

```json
{
  "id": 1,
542
  "iid": 1,
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
543 544 545 546
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
547
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
548 549 550 551 552
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
553
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
554 555 556 557 558 559 560
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
561
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
562 563 564
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
565 566 567 568
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
Ben Boeckel's avatar
Ben Boeckel committed
569
  "description": "fixed login page css paddings",
570 571 572 573 574 575 576 577 578 579 580 581
  "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
  },
582
  "merge_when_pipeline_succeeds": true,
583
  "merge_status": "can_be_merged",
584
  "subscribed" : true,
585 586
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null,
587 588
  "user_notes_count": 1,
  "should_remove_source_branch": true,
589 590
  "force_remove_source_branch": false,
  "web_url": "http://example.com/example/example/merge_requests/1"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
591 592 593
}
```

bb-froggy's avatar
typo  
bb-froggy committed
594
## Comments on merge requests
595

596
Comments are done via the [notes](notes.md) resource.
597 598 599 600 601 602

## List issues that will close on merge

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

```
603
GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
604 605
```

606 607
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
608
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
609
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
610 611

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

615
Example response when the GitLab issue tracker is used:
616 617 618 619 620 621 622 623 624

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
625
         "web_url" : "https://gitlab.example.com/eileen.lowe",
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
         "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",
646
         "web_url" : "https://gitlab.example.com/root",
647 648 649 650 651 652 653 654
         "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,
655 656
      "labels" : [],
      "user_notes_count": 1
657 658 659
   },
]
```
660

661 662 663 664 665 666 667 668 669 670 671
Example response when an external issue tracker (e.g. JIRA) is used:

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

672 673
## Subscribe to a merge request

674 675
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.
676 677

```
678
POST /projects/:id/merge_requests/:merge_request_iid/subscribe
679 680
```

681 682
| Attribute           | Type    | Required | Description                 |
| ---------           | ----    | -------- | -----------                 |
683
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user         |
684
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
685 686

```bash
687
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
```

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",
712
    "web_url": "https://gitlab.example.com/leila"
713 714 715 716 717 718 719
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
720
    "web_url": "https://gitlab.example.com/carli"
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
  },
  "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
  },
737
  "merge_when_pipeline_succeeds": false,
738
  "merge_status": "cannot_be_merged",
739 740 741
  "subscribed": true,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
742 743
}
```
744

745 746
## Unsubscribe from a merge request

747
Unsubscribes the authenticated user from a merge request to not receive
748 749
notifications from that merge request. If the user is
not subscribed to the merge request, the status code `304` is returned.
750 751

```
752
POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
753 754
```

755 756
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
757
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
758
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
759 760

```bash
761
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
```

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",
786
    "web_url": "https://gitlab.example.com/leila"
787 788 789 790 791 792 793
  },
  "assignee": {
    "name": "Celine Wehner",
    "username": "carli",
    "id": 16,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon",
794
    "web_url": "https://gitlab.example.com/carli"
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
  },
  "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
  },
811
  "merge_when_pipeline_succeeds": false,
812
  "merge_status": "cannot_be_merged",
813 814 815
  "subscribed": false,
  "sha": "8888888888888888888888888888888888888888",
  "merge_commit_sha": null
816 817
}
```
818 819 820

## Create a todo

821
Manually creates a todo for the current user on a merge request.
822
If there already exists a todo for the user on that merge request,
823 824 825
status code `304` is returned.

```
826
POST /projects/:id/merge_requests/:merge_request_iid/todo
827 828
```

829 830
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
831
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
832
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
833 834

```bash
835
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
```

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",
856
    "web_url": "https://gitlab.example.com/root"
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
  },
  "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",
879
      "web_url": "https://gitlab.example.com/francisca"
880 881 882 883 884 885 886
    },
    "assignee": {
      "name": "Dr. Gabrielle Strosin",
      "username": "barrett.krajcik",
      "id": 4,
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/733005fcd7e6df12d2d8580171ccb966?s=80&d=identicon",
887
      "web_url": "https://gitlab.example.com/barrett.krajcik"
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
    },
    "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
    },
904
    "merge_when_pipeline_succeeds": false,
905 906
    "merge_status": "unchecked",
    "subscribed": true,
907 908
    "sha": "8888888888888888888888888888888888888888",
    "merge_commit_sha": null,
909 910
    "user_notes_count": 7,
    "should_remove_source_branch": true,
911 912
    "force_remove_source_branch": false,
    "web_url": "http://example.com/example/example/merge_requests/1"
913 914 915 916 917 918 919
  },
  "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"
}
```
920 921 922 923 924 925

## Get MR diff versions

Get a list of merge request diff versions.

```
926
GET /projects/:id/merge_requests/:merge_request_iid/versions
927 928
```

929 930 931 932
| Attribute           | Type    | Required | Description                 |
| ---------           | ------- | -------- | ---------------------       |
| `id`                | String  | yes      | The ID of the project       |
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
933

934
```bash
935
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions
936
```
937

938
Example response:
939 940 941

```json
[{
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
  "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.

```
967
GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id
968 969
```

970 971 972 973 974
| 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 |
975 976

```bash
977
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1
978 979 980 981 982 983
```

Example response:

```json
{
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
  "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
  }]
1027
}
1028
```
1029 1030 1031 1032 1033
## Set a time estimate for a merge request

Sets an estimated time of work for this merge request.

```
1034
POST /projects/:id/merge_requests/:merge_request_iid/time_estimate
1035 1036
```

1037 1038
| Attribute           | Type    | Required | Description                              |
| ---------           | ----    | -------- | -----------                              |
1039
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                      |
1040 1041
| `merge_request_iid` | integer | yes      | The internal ID of the merge request     |
| `duration`          | string  | yes      | The duration in human format. e.g: 3h30m |
1042 1043

```bash
1044
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_estimate?duration=3h30m
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
```

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.

```
1063
POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate
1064 1065
```

1066 1067
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
1068
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                          |
1069
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1070 1071

```bash
1072
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_time_estimate
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
```

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

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

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

```bash
1101
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/add_spent_time?duration=1h
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
```

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.

```
1120
POST /projects/:id/merge_requests/:merge_request_iid/reset_spent_time
1121 1122
```

1123 1124
| Attribute           | Type    | Required | Description                                  |
| ---------           | ----    | -------- | -----------                                  |
1125
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                          |
1126
| `merge_request_iid` | integer | yes      | The internal ID of a project's merge_request |
1127 1128

```bash
1129
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_spent_time
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
```

Example response:

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

## Get time tracking stats

```
1146
GET /projects/:id/merge_requests/:merge_request_iid/time_stats
1147 1148
```

1149 1150
| Attribute           | Type    | Required | Description                          |
| ---------           | ----    | -------- | -----------                          |
1151
| `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user                  |
1152
| `merge_request_iid` | integer | yes      | The internal ID of the merge request |
1153 1154

```bash
1155
curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
```

Example response:

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