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

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?iid=42
Valeriy Sizov's avatar
Valeriy Sizov committed
14 15 16 17
```

Parameters:

18
- `id` (required) - The ID of a project
19
- `iid` (optional) - Return the request having the given `iid`
20
- `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed`
21 22
- `order_by` (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
Valeriy Sizov's avatar
Valeriy Sizov committed
23 24 25

```json
[
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
26 27 28 29 30 31 32 33 34 35 36 37 38
  {
    "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",
39
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
40 41 42 43 44 45 46
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
    },
    "assignee": {
      "id": 1,
      "username": "admin",
47
      "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
48 49 50
      "name": "Administrator",
      "state": "active",
      "created_at": "2012-04-29T08:46:00Z"
51
    },
52 53 54
    "source_project_id": "2",
    "target_project_id": "3",
    "labels": [ ],
55
    "description":"fixed login page css paddings",
56 57 58 59 60 61 62 63 64 65 66 67 68 69
    "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_build_succeeds": true,
    "merge_status": "can_be_merged"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
70
  }
Valeriy Sizov's avatar
Valeriy Sizov committed
71 72 73
]
```

74 75
## Get single MR

76
Shows information about a single merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
77 78

```
79
GET /projects/:id/merge_requests/:merge_request_id
Valeriy Sizov's avatar
Valeriy Sizov committed
80 81 82 83
```

Parameters:

84 85
- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of MR
Valeriy Sizov's avatar
Valeriy Sizov committed
86 87 88

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
89 90 91 92 93 94 95 96 97 98 99 100
  "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",
101
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
102 103 104 105 106 107 108
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
109
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
110 111 112
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
113
  },
114 115 116
  "source_project_id": "2",
  "target_project_id": "3",
  "labels": [ ],
117
  "description":"fixed login page css paddings",
118 119 120 121 122 123 124 125 126 127 128 129 130 131
  "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_build_succeeds": true,
  "merge_status": "can_be_merged"
Valeriy Sizov's avatar
Valeriy Sizov committed
132 133 134
}
```

135 136
## Get single MR commits

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
137
Get a list of merge request commits.
138 139

```
140
GET /projects/:id/merge_requests/:merge_request_id/commits
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
```

Parameters:

- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of MR


```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
158
    "message": "Replace sanitize with escape once"
159 160 161 162 163 164 165 166
  },
  {
    "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
167
    "message": "Sanitize for network graph"
168 169 170 171
  }
]
```

172 173
## Get single MR changes

174
Shows information about the merge request including its files and changes.
175 176

```
177
GET /projects/:id/merge_requests/:merge_request_id/changes
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
```

Parameters:

- `id` (required) - The ID of a project
- `merge_request_id` (required) - The ID of MR

```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": [ ],
215 216
  "description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
  "work_in_progress": false,
217 218 219 220 221 222 223 224 225 226 227
  "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
  },
228 229
  "merge_when_build_succeeds": true,
  "merge_status": "can_be_merged",
230
  "changes": [
231 232 233 234 235 236 237 238 239 240 241 242 243 244
    {
    "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
245 246
## Create MR

247
Creates a new merge request.
Valeriy Sizov's avatar
Valeriy Sizov committed
248
```
249
POST /projects/:id/merge_requests
Valeriy Sizov's avatar
Valeriy Sizov committed
250 251 252 253
```

Parameters:

254 255 256 257 258
- `id` (required)                - The ID of a project
- `source_branch` (required)     - The source branch
- `target_branch` (required)     - The target branch
- `assignee_id` (optional)       - Assignee user ID
- `title` (required)             - Title of MR
259
- `description` (optional)       - Description of MR
260
- `target_project_id` (optional) - The target project (numeric id)
261
- `labels` (optional)            - Labels for MR as a comma-separated list
262
- `milestone_id` (optional)      - Milestone ID
Valeriy Sizov's avatar
Valeriy Sizov committed
263 264 265

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
266 267 268 269 270 271 272 273 274 275 276
  "id": 1,
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
277
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
278 279 280 281 282 283 284
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
285
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
286 287 288
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
289
  },
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
  "description":"fixed login page css paddings",
  "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
  },
  "merge_when_build_succeeds": true,
  "merge_status": "can_be_merged"
Valeriy Sizov's avatar
Valeriy Sizov committed
308 309 310
}
```

311 312 313
If the operation is successful, 200 and the newly created merge request is returned.
If an error occurs, an error number and a message explaining the reason is returned.

Valeriy Sizov's avatar
Valeriy Sizov committed
314 315
## Update MR

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

```
319
PUT /projects/:id/merge_requests/:merge_request_id
Valeriy Sizov's avatar
Valeriy Sizov committed
320 321 322 323
```

Parameters:

324 325 326 327 328
- `id` (required)               - The ID of a project
- `merge_request_id` (required) - ID of MR
- `target_branch`               - The target branch
- `assignee_id`                 - Assignee user ID
- `title`                       - Title of MR
329
- `description`                 - Description of MR
330
- `state_event`                 - New state (close|reopen|merge)
331
- `labels` (optional)           - Labels for MR as a comma-separated list
332
- `milestone_id` (optional)     - Milestone ID
Valeriy Sizov's avatar
Valeriy Sizov committed
333 334 335

```json
{
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
336 337 338 339 340 341 342 343 344 345
  "id": 1,
  "target_branch": "master",
  "project_id": 3,
  "title": "test1",
  "state": "opened",
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
346
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
347 348 349 350 351 352 353
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
354
    "email": "admin@example.com",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
355 356 357
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
  },
  "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
  },
  "merge_when_build_succeeds": true,
  "merge_status": "can_be_merged"
Valeriy Sizov's avatar
Valeriy Sizov committed
377 378
}
```
379

380 381 382
If the operation is successful, 200 and the updated merge request is returned.
If an error occurs, an error number and a message explaining the reason is returned.

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
383 384
## Accept MR

385
Merge changes submitted with MR using this API.
386

387
If merge success you get `200 OK`.
388

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
389
If it has some conflicts and can not be merged - you get 405 and error message 'Branch cannot be merged'
390

391
If merge request is already merged or closed - you get 405 and error message 'Method Not Allowed'
392

393
If you don't have permissions to accept this merge request - you'll get a 401
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
394 395

```
396
PUT /projects/:id/merge_requests/:merge_request_id/merge
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
397 398 399 400
```

Parameters:

401 402 403 404
- `id` (required)                           - The ID of a project
- `merge_request_id` (required)             - ID of MR
- `merge_commit_message` (optional)         - Custom merge commit message
- `should_remove_source_branch` (optional)  - if `true` removes the source branch
405
- `merged_when_build_succeeds` (optional)    - if `true` the MR is merge when the build succeeds
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431

```json
{
  "id": 1,
  "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"
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
  "description":"fixed login page css paddings",
  "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
  },
  "merge_when_build_succeeds": true,
  "merge_status": "can_be_merged"
451 452 453 454 455
}
```

## Cancel Merge When Build Succeeds

456
If successful you'll get `200 OK`.
457 458 459 460 461

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

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

462
In case the merge request is not set to be merged when the build succeeds, you'll also get a 406 error.
463
```
464
PUT /projects/:id/merge_requests/:merge_request_id/cancel_merge_when_build_succeeds
465 466 467 468 469
```
Parameters:

- `id` (required)                           - The ID of a project
- `merge_request_id` (required)             - ID of MR
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
470 471 472 473 474 475 476 477

```json
{
  "id": 1,
  "target_branch": "master",
  "source_branch": "test1",
  "project_id": 3,
  "title": "test1",
478
  "state": "opened",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
479 480 481 482 483
  "upvotes": 0,
  "downvotes": 0,
  "author": {
    "id": 1,
    "username": "admin",
484
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
485 486 487 488 489 490 491
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
492
    "email": "admin@example.com",
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
493 494 495
    "name": "Administrator",
    "state": "active",
    "created_at": "2012-04-29T08:46:00Z"
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
  },
  "source_project_id": 4,
  "target_project_id": 4,
  "labels": [ ],
  "description":"fixed login page css paddings",
  "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
  },
  "merge_when_build_succeeds": true,
  "merge_status": "can_be_merged"
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
515 516 517
}
```

bb-froggy's avatar
typo  
bb-froggy committed
518
## Comments on merge requests
519

520
Comments are done via the [notes](notes.md) resource.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582

## List issues that will close on merge

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

```
GET /projects/:id/merge_requests/:merge_request_id/closes_issues
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes   | The ID of a project |
| `merge_request_id` | integer | yes   | The ID of the merge request |

```bash
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/76/merge_requests/1/closes_issues
```

Example response:

```json
[
   {
      "state" : "opened",
      "description" : "Ratione dolores corrupti mollitia soluta quia.",
      "author" : {
         "state" : "active",
         "id" : 18,
         "web_url" : "https://gitlab.example.com/u/eileen.lowe",
         "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",
         "web_url" : "https://gitlab.example.com/u/root",
         "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,
      "labels" : []
   },
]
```