gitlabhq/doc/api/merge_requests.md

204 lines
4.1 KiB
Markdown
Raw Normal View History

2012-10-22 21:53:06 +02:00
## List merge requests
Get all MR for this project.
```
2012-10-25 12:13:01 +02:00
GET /projects/:id/merge_requests
2012-10-22 21:53:06 +02:00
```
Parameters:
+ `id` (required) - The ID or code name of a project
```json
[
{
"id":1,
"target_branch":"master",
"source_branch":"test1",
"project_id":3,
"title":"test1",
"closed":true,
"merged":false,
"author":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
},
"assignee":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
}
}
]
```
## Show MR
Show information about MR.
```
2012-10-25 12:13:01 +02:00
GET /projects/:id/merge_request/:merge_request_id
2012-10-22 21:53:06 +02:00
```
Parameters:
+ `id` (required) - The ID or code name of a project
+ `merge_request_id` (required) - The ID of MR
```json
{
"id":1,
"target_branch":"master",
"source_branch":"test1",
"project_id":3,
"title":"test1",
"closed":true,
"merged":false,
"author":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
},
"assignee":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
}
}
```
## Create MR
Create MR.
```
2012-10-25 12:13:01 +02:00
POST /projects/:id/merge_requests
2012-10-22 21:53:06 +02:00
```
Parameters:
+ `id` (required) - The ID or code name of a project
+ `source_branch` (required) - The source branch
+ `target_branch` (required) - The target branch
+ `assignee_id` - Assignee user ID
+ `title` (required) - Title of MR
```json
{
"id":1,
"target_branch":"master",
"source_branch":"test1",
"project_id":3,
"title":"test1",
"closed":true,
"merged":false,
"author":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
},
"assignee":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
}
}
```
## Update MR
Update MR. You can change branches, title, or even close the MR.
```
2012-10-25 12:13:01 +02:00
PUT /projects/:id/merge_request/:merge_request_id
2012-10-22 21:53:06 +02:00
```
Parameters:
+ `id` (required) - The ID or code name 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
+ `closed` - Status of MR. true - closed
```json
{
"id":1,
"target_branch":"master",
"source_branch":"test1",
"project_id":3,
"title":"test1",
"closed":true,
"merged":false,
"author":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
},
"assignee":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
}
}
```
## Post comment to MR
Post comment to MR
```
2012-10-25 12:13:01 +02:00
POST /projects/:id/merge_request/:merge_request_id/comments
2012-10-22 21:53:06 +02:00
```
Parameters:
+ `id` (required) - The ID or code name of a project
+ `merge_request_id` (required) - ID of MR
+ `note` (required) - Text of comment
Will return created note with status `201 Created` on success, or `404 Not found` on fail.
```json
{
"author":{
"id":1,
"username": "admin",
2012-10-22 21:53:06 +02:00
"email":"admin@local.host",
"name":"Administrator",
"blocked":false,
"created_at":"2012-04-29T08:46:00Z"
},
"note":"text1"
}
```