2014-05-27 08:12:15 -04:00
|
|
|
# Merge requests
|
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
## List merge requests
|
|
|
|
|
2016-02-08 11:18:44 -05:00
|
|
|
Get all merge requests for this project.
|
2015-11-18 05:17:41 -05:00
|
|
|
The `state` parameter can be used to get only merge requests with a given state (`opened`, `closed`, or `merged`) or all of them (`all`).
|
2015-12-25 11:13:55 -05:00
|
|
|
The pagination parameters `page` and `per_page` can be used to restrict the list of merge requests.
|
2012-10-22 15:53:06 -04:00
|
|
|
|
|
|
|
```
|
2012-10-25 06:13:01 -04:00
|
|
|
GET /projects/:id/merge_requests
|
2014-04-04 12:32:53 -04:00
|
|
|
GET /projects/:id/merge_requests?state=opened
|
|
|
|
GET /projects/:id/merge_requests?state=all
|
2015-01-17 17:45:39 -05:00
|
|
|
GET /projects/:id/merge_requests?iid=42
|
2012-10-22 15:53:06 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2014-04-24 18:48:22 -04:00
|
|
|
- `id` (required) - The ID of a project
|
2015-01-17 17:45:39 -05:00
|
|
|
- `iid` (optional) - Return the request having the given `iid`
|
2014-04-24 18:48:22 -04:00
|
|
|
- `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed`
|
2015-02-06 01:00:54 -05:00
|
|
|
- `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`
|
2012-10-22 15:53:06 -04:00
|
|
|
|
|
|
|
```json
|
|
|
|
[
|
2014-04-05 02:36:47 -04:00
|
|
|
{
|
|
|
|
"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",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-04-05 02:36:47 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
|
|
|
},
|
|
|
|
"assignee": {
|
|
|
|
"id": 1,
|
|
|
|
"username": "admin",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-04-05 02:36:47 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
2014-04-15 22:14:05 -04:00
|
|
|
},
|
2016-02-08 11:18:44 -05:00
|
|
|
"source_project_id": "2",
|
|
|
|
"target_project_id": "3",
|
|
|
|
"labels": [ ],
|
2015-07-09 13:21:37 -04:00
|
|
|
"description":"fixed login page css paddings",
|
2016-02-08 11:18:44 -05:00
|
|
|
"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"
|
2014-04-05 02:36:47 -04:00
|
|
|
}
|
2012-10-22 15:53:06 -04:00
|
|
|
]
|
|
|
|
```
|
|
|
|
|
2013-02-27 09:07:42 -05:00
|
|
|
## Get single MR
|
|
|
|
|
2015-12-25 11:13:55 -05:00
|
|
|
Shows information about a single merge request.
|
2012-10-22 15:53:06 -04:00
|
|
|
|
|
|
|
```
|
2016-01-28 08:26:02 -05:00
|
|
|
GET /projects/:id/merge_requests/:merge_request_id
|
2012-10-22 15:53:06 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2014-04-24 18:48:22 -04:00
|
|
|
- `id` (required) - The ID of a project
|
|
|
|
- `merge_request_id` (required) - The ID of MR
|
2012-10-22 15:53:06 -04:00
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
2014-04-05 02:36:47 -04:00
|
|
|
"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",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-04-05 02:36:47 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
|
|
|
},
|
|
|
|
"assignee": {
|
|
|
|
"id": 1,
|
|
|
|
"username": "admin",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-04-05 02:36:47 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
2014-04-15 22:14:05 -04:00
|
|
|
},
|
2016-02-08 11:18:44 -05:00
|
|
|
"source_project_id": "2",
|
|
|
|
"target_project_id": "3",
|
|
|
|
"labels": [ ],
|
2015-07-09 13:21:37 -04:00
|
|
|
"description":"fixed login page css paddings",
|
2016-02-08 11:18:44 -05:00
|
|
|
"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"
|
2012-10-22 15:53:06 -04:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2015-12-04 05:08:10 -05:00
|
|
|
## Get single MR commits
|
|
|
|
|
2015-12-04 05:26:35 -05:00
|
|
|
Get a list of merge request commits.
|
2015-12-04 05:08:10 -05:00
|
|
|
|
|
|
|
```
|
2016-01-28 08:26:02 -05:00
|
|
|
GET /projects/:id/merge_requests/:merge_request_id/commits
|
2015-12-04 05:08:10 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
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",
|
2015-12-04 05:26:35 -05:00
|
|
|
"message": "Replace sanitize with escape once"
|
2015-12-04 05:08:10 -05:00
|
|
|
},
|
|
|
|
{
|
|
|
|
"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",
|
2015-12-04 05:26:35 -05:00
|
|
|
"message": "Sanitize for network graph"
|
2015-12-04 05:08:10 -05:00
|
|
|
}
|
|
|
|
]
|
|
|
|
```
|
|
|
|
|
2015-02-02 16:08:10 -05:00
|
|
|
## Get single MR changes
|
|
|
|
|
2015-11-21 15:36:31 -05:00
|
|
|
Shows information about the merge request including its files and changes.
|
2015-02-02 16:08:10 -05:00
|
|
|
|
|
|
|
```
|
2016-01-28 08:26:02 -05:00
|
|
|
GET /projects/:id/merge_requests/:merge_request_id/changes
|
2015-02-02 16:08:10 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
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": [ ],
|
2016-02-08 11:18:44 -05:00
|
|
|
"description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
|
|
|
|
"work_in_progress": false,
|
2015-02-02 16:08:10 -05:00
|
|
|
"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
|
|
|
|
},
|
2016-02-08 11:18:44 -05:00
|
|
|
"merge_when_build_succeeds": true,
|
|
|
|
"merge_status": "can_be_merged",
|
2015-12-04 04:55:36 -05:00
|
|
|
"changes": [
|
2015-02-02 16:08:10 -05:00
|
|
|
{
|
|
|
|
"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
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
## Create MR
|
|
|
|
|
2015-12-25 11:13:55 -05:00
|
|
|
Creates a new merge request.
|
2012-10-22 15:53:06 -04:00
|
|
|
```
|
2012-10-25 06:13:01 -04:00
|
|
|
POST /projects/:id/merge_requests
|
2012-10-22 15:53:06 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2014-04-24 18:48:22 -04:00
|
|
|
- `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
|
2015-01-18 07:42:20 -05:00
|
|
|
- `description` (optional) - Description of MR
|
2014-04-24 18:48:22 -04:00
|
|
|
- `target_project_id` (optional) - The target project (numeric id)
|
2015-10-13 11:40:37 -04:00
|
|
|
- `labels` (optional) - Labels for MR as a comma-separated list
|
2015-12-15 11:40:03 -05:00
|
|
|
- `milestone_id` (optional) - Milestone ID
|
2012-10-22 15:53:06 -04:00
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
2014-04-05 02:36:47 -04:00
|
|
|
"id": 1,
|
|
|
|
"target_branch": "master",
|
|
|
|
"source_branch": "test1",
|
|
|
|
"project_id": 3,
|
|
|
|
"title": "test1",
|
|
|
|
"state": "opened",
|
|
|
|
"upvotes": 0,
|
|
|
|
"downvotes": 0,
|
|
|
|
"author": {
|
|
|
|
"id": 1,
|
|
|
|
"username": "admin",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-04-05 02:36:47 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
|
|
|
},
|
|
|
|
"assignee": {
|
|
|
|
"id": 1,
|
|
|
|
"username": "admin",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-04-05 02:36:47 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
2014-04-15 22:14:05 -04:00
|
|
|
},
|
2016-02-08 11:18:44 -05:00
|
|
|
"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"
|
2012-10-22 15:53:06 -04:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2014-08-14 04:17:52 -04:00
|
|
|
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.
|
|
|
|
|
2012-10-22 15:53:06 -04:00
|
|
|
## Update MR
|
|
|
|
|
2015-12-25 11:13:55 -05:00
|
|
|
Updates an existing merge request. You can change the target branch, title, or even close the MR.
|
2012-10-22 15:53:06 -04:00
|
|
|
|
|
|
|
```
|
2016-01-28 08:26:02 -05:00
|
|
|
PUT /projects/:id/merge_requests/:merge_request_id
|
2012-10-22 15:53:06 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2014-04-24 18:48:22 -04:00
|
|
|
- `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
|
2015-01-18 07:42:20 -05:00
|
|
|
- `description` - Description of MR
|
2014-04-24 18:48:22 -04:00
|
|
|
- `state_event` - New state (close|reopen|merge)
|
2015-10-13 11:40:37 -04:00
|
|
|
- `labels` (optional) - Labels for MR as a comma-separated list
|
2015-12-15 11:40:03 -05:00
|
|
|
- `milestone_id` (optional) - Milestone ID
|
2012-10-22 15:53:06 -04:00
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
2014-04-05 02:36:47 -04:00
|
|
|
"id": 1,
|
|
|
|
"target_branch": "master",
|
|
|
|
"project_id": 3,
|
|
|
|
"title": "test1",
|
|
|
|
"state": "opened",
|
|
|
|
"upvotes": 0,
|
|
|
|
"downvotes": 0,
|
|
|
|
"author": {
|
|
|
|
"id": 1,
|
|
|
|
"username": "admin",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-04-05 02:36:47 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
|
|
|
},
|
|
|
|
"assignee": {
|
|
|
|
"id": 1,
|
|
|
|
"username": "admin",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-04-05 02:36:47 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
2016-02-08 11:18:44 -05:00
|
|
|
},
|
|
|
|
"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"
|
2012-10-22 15:53:06 -04:00
|
|
|
}
|
|
|
|
```
|
2013-02-27 09:07:42 -05:00
|
|
|
|
2014-08-14 04:17:52 -04:00
|
|
|
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.
|
|
|
|
|
2016-03-21 09:12:52 -04:00
|
|
|
## Delete a merge request
|
|
|
|
|
|
|
|
Only for admins and project owners. Soft deletes the merge request in question.
|
|
|
|
If the operation is successful, a status code of `200` is returned. Any the case you cannot
|
|
|
|
destroy this merge request, or it is not present, code `404` is given.
|
2016-02-26 03:55:43 -05:00
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
DELETE /projects/:id/merge_requests/:merge_request_id
|
|
|
|
```
|
|
|
|
|
|
|
|
| Attribute | Type | Required | Description |
|
|
|
|
| --------- | ---- | -------- | ----------- |
|
|
|
|
| `id` | integer | yes | The ID of a project |
|
|
|
|
| `merge_request_id` | integer | yes | The ID of a project's merge request |
|
|
|
|
|
2016-03-21 09:12:52 -04:00
|
|
|
```bash
|
|
|
|
curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/4/merge_request/85
|
2016-02-26 03:55:43 -05:00
|
|
|
```
|
|
|
|
|
2014-05-12 11:01:22 -04:00
|
|
|
## Accept MR
|
|
|
|
|
2015-12-25 11:13:55 -05:00
|
|
|
Merge changes submitted with MR using this API.
|
2014-04-24 18:48:22 -04:00
|
|
|
|
2014-08-15 10:03:01 -04:00
|
|
|
If merge success you get `200 OK`.
|
2014-04-24 18:48:22 -04:00
|
|
|
|
2014-05-12 11:01:22 -04:00
|
|
|
If it has some conflicts and can not be merged - you get 405 and error message 'Branch cannot be merged'
|
2014-04-24 18:48:22 -04:00
|
|
|
|
2014-08-14 04:17:52 -04:00
|
|
|
If merge request is already merged or closed - you get 405 and error message 'Method Not Allowed'
|
2014-04-24 18:48:22 -04:00
|
|
|
|
2014-08-15 10:03:01 -04:00
|
|
|
If you don't have permissions to accept this merge request - you'll get a 401
|
2014-05-12 11:01:22 -04:00
|
|
|
|
|
|
|
```
|
2016-01-28 08:26:02 -05:00
|
|
|
PUT /projects/:id/merge_requests/:merge_request_id/merge
|
2014-05-12 11:01:22 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2015-11-18 05:17:41 -05:00
|
|
|
- `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
|
2015-11-23 03:42:20 -05:00
|
|
|
- `merged_when_build_succeeds` (optional) - if `true` the MR is merge when the build succeeds
|
2015-11-18 05:17:41 -05:00
|
|
|
|
|
|
|
```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"
|
2016-02-08 11:18:44 -05:00
|
|
|
},
|
|
|
|
"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"
|
2015-11-18 05:17:41 -05:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Cancel Merge When Build Succeeds
|
|
|
|
|
2015-11-23 03:42:20 -05:00
|
|
|
If successful you'll get `200 OK`.
|
2015-11-18 05:17:41 -05:00
|
|
|
|
|
|
|
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'
|
|
|
|
|
2015-11-23 03:42:20 -05:00
|
|
|
In case the merge request is not set to be merged when the build succeeds, you'll also get a 406 error.
|
2015-11-18 05:17:41 -05:00
|
|
|
```
|
2016-01-28 08:26:02 -05:00
|
|
|
PUT /projects/:id/merge_requests/:merge_request_id/cancel_merge_when_build_succeeds
|
2015-11-18 05:17:41 -05:00
|
|
|
```
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
- `id` (required) - The ID of a project
|
|
|
|
- `merge_request_id` (required) - ID of MR
|
2014-05-12 11:01:22 -04:00
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"id": 1,
|
|
|
|
"target_branch": "master",
|
|
|
|
"source_branch": "test1",
|
|
|
|
"project_id": 3,
|
|
|
|
"title": "test1",
|
2016-02-08 11:18:44 -05:00
|
|
|
"state": "opened",
|
2014-05-12 11:01:22 -04:00
|
|
|
"upvotes": 0,
|
|
|
|
"downvotes": 0,
|
|
|
|
"author": {
|
|
|
|
"id": 1,
|
|
|
|
"username": "admin",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-05-12 11:01:22 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
|
|
|
},
|
|
|
|
"assignee": {
|
|
|
|
"id": 1,
|
|
|
|
"username": "admin",
|
2014-07-19 07:27:01 -04:00
|
|
|
"email": "admin@example.com",
|
2014-05-12 11:01:22 -04:00
|
|
|
"name": "Administrator",
|
|
|
|
"state": "active",
|
|
|
|
"created_at": "2012-04-29T08:46:00Z"
|
2016-02-08 11:18:44 -05:00
|
|
|
},
|
|
|
|
"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"
|
2014-05-12 11:01:22 -04:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2016-03-02 04:42:14 -05:00
|
|
|
## Comments on merge requests
|
2014-04-30 11:28:05 -04:00
|
|
|
|
2016-01-28 08:26:02 -05:00
|
|
|
Comments are done via the [notes](notes.md) resource.
|
2016-01-31 04:05:47 -05:00
|
|
|
|
|
|
|
## 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" : []
|
|
|
|
},
|
|
|
|
]
|
|
|
|
```
|