gitlab-org--gitlab-foss/doc/api/merge_requests.md

319 lines
7.1 KiB
Markdown
Raw Normal View History

2014-05-27 08:12:15 -04:00
# Merge requests
2012-10-22 15:53:06 -04:00
## List merge requests
2014-04-24 18:48:22 -04:00
Get all merge requests for this project. 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.
2012-10-22 15:53:06 -04:00
```
2012-10-25 06:13:01 -04:00
GET /projects/:id/merge_requests
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
2012-10-22 15:53:06 -04:00
```
Parameters:
2014-04-24 18:48:22 -04:00
- `id` (required) - The ID of a project
- `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed`
2014-09-09 11:39:53 -04:00
- `order_by` (optional) - Return requests ordered by `created_at` or `updated_at` fields
- `sort` (optional) - Return requests sorted in `asc` or `desc` order
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",
"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",
"email": "admin@example.com",
2014-04-05 02:36:47 -04:00
"name": "Administrator",
"state": "active",
"created_at": "2012-04-29T08:46:00Z"
},
"description":"fixed login page css paddings"
2014-04-05 02:36:47 -04:00
}
2012-10-22 15:53:06 -04:00
]
```
## Get single MR
Shows information about a single merge request.
2012-10-22 15:53:06 -04:00
```
2012-10-25 06:13:01 -04:00
GET /projects/:id/merge_request/: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",
"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",
"email": "admin@example.com",
2014-04-05 02:36:47 -04:00
"name": "Administrator",
"state": "active",
"created_at": "2012-04-29T08:46:00Z"
},
"description":"fixed login page css paddings"
2012-10-22 15:53:06 -04:00
}
```
## Create MR
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
- `target_project_id` (optional) - The target project (numeric 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",
"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",
"email": "admin@example.com",
2014-04-05 02:36:47 -04:00
"name": "Administrator",
"state": "active",
"created_at": "2012-04-29T08:46:00Z"
},
"description":"fixed login page css paddings"
2012-10-22 15:53:06 -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
Updates an existing merge request. You can change branches, title, or even close the MR.
2012-10-22 15:53:06 -04:00
```
2012-10-25 06:13:01 -04:00
PUT /projects/:id/merge_request/: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
- `source_branch` - The source branch
- `target_branch` - The target branch
- `assignee_id` - Assignee user ID
- `title` - Title of MR
- `state_event` - New state (close|reopen|merge)
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",
"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",
"email": "admin@example.com",
2014-04-05 02:36:47 -04:00
"name": "Administrator",
"state": "active",
"created_at": "2012-04-29T08:46:00Z"
}
2012-10-22 15:53:06 -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.
## Accept MR
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
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
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
```
PUT /projects/:id/merge_request/:merge_request_id/merge
```
Parameters:
2014-04-24 18:48:22 -04:00
- `id` (required) - The ID of a project
- `merge_request_id` (required) - ID of MR
- `merge_commit_message` (optional) - Custom merge commit message
```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"
}
}
```
2012-10-22 15:53:06 -04:00
## Post comment to MR
Adds a comment to a merge request.
2012-10-22 15:53:06 -04:00
```
2012-10-25 06:13:01 -04:00
POST /projects/:id/merge_request/:merge_request_id/comments
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 merge request
- `note` (required) - Text of comment
2012-10-22 15:53:06 -04:00
```json
{
2014-04-05 02:36:47 -04:00
"author": {
"id": 1,
"username": "admin",
"email": "admin@example.com",
2014-04-05 02:36:47 -04:00
"name": "Administrator",
"blocked": false,
"created_at": "2012-04-29T08:46:00Z"
},
"note": "text1"
2012-10-22 15:53:06 -04:00
}
```
## Get the comments on a MR
Gets all the comments associated with a merge request.
```
GET /projects/:id/merge_request/:merge_request_id/comments
```
Parameters:
2014-04-24 18:48:22 -04:00
- `id` (required) - The ID of a project
- `merge_request_id` (required) - ID of merge request
```json
[
2014-04-05 02:36:47 -04:00
{
"note": "this is the 1st comment on the 2merge merge request",
"author": {
"id": 11,
"username": "admin",
"email": "admin@example.com",
2014-04-05 02:36:47 -04:00
"name": "Administrator",
"state": "active",
"created_at": "2014-03-06T08:17:35.000Z"
}
},
{
"note": "_Status changed to closed_",
"author": {
"id": 11,
"username": "admin",
"email": "admin@example.com",
2014-04-05 02:36:47 -04:00
"name": "Administrator",
"state": "active",
"created_at": "2014-03-06T08:17:35.000Z"
}
2014-04-05 02:36:47 -04:00
}
]
```
## Comments on issues
Comments are done via the notes resource.