diff options
Diffstat (limited to 'doc/api/merge_requests.md')
| -rw-r--r-- | doc/api/merge_requests.md | 67 |
1 files changed, 30 insertions, 37 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 284c2befe6f..27c0d644e11 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -2,11 +2,7 @@ ## List merge requests -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. +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. ``` GET /projects/:id/merge_requests @@ -16,8 +12,8 @@ GET /projects/:id/merge_requests?state=all Parameters: -+ `id` (required) - The ID of a project -+ `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed` +- `id` (required) - The ID of a project +- `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed` ```json [ @@ -51,7 +47,6 @@ Parameters: ] ``` - ## Get single MR Shows information about a single merge request. @@ -62,8 +57,8 @@ GET /projects/:id/merge_request/:merge_request_id Parameters: -+ `id` (required) - The ID of a project -+ `merge_request_id` (required) - The ID of MR +- `id` (required) - The ID of a project +- `merge_request_id` (required) - The ID of MR ```json { @@ -95,7 +90,6 @@ Parameters: } ``` - ## Create MR Creates a new merge request. @@ -106,12 +100,12 @@ POST /projects/:id/merge_requests Parameters: -+ `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) +- `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) ```json { @@ -142,7 +136,6 @@ Parameters: } ``` - ## Update MR Updates an existing merge request. You can change branches, title, or even close the MR. @@ -153,13 +146,13 @@ PUT /projects/:id/merge_request/:merge_request_id Parameters: -+ `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) +- `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) ```json { @@ -190,13 +183,16 @@ Parameters: } ``` - ## Accept MR Merge changes submitted with MR usign this API. + If merge success you get 200 OK. + If it has some conflicts and can not be merged - you get 405 and error message 'Branch cannot be merged' + If merge request is already merged or closed - you get 405 and error message 'Method Not Allowed' + If you dont have permissions to accept this merge request - you get 401 ``` @@ -205,9 +201,9 @@ PUT /projects/:id/merge_request/:merge_request_id/merge Parameters: -+ `id` (required) - The ID of a project -+ `merge_request_id` (required) - ID of MR -+ `merge_commit_message` (optional) - Custom merge commit message +- `id` (required) - The ID of a project +- `merge_request_id` (required) - ID of MR +- `merge_commit_message` (optional) - Custom merge commit message ```json { @@ -238,7 +234,6 @@ Parameters: } ``` - ## Post comment to MR Adds a comment to a merge request. @@ -249,10 +244,9 @@ POST /projects/:id/merge_request/:merge_request_id/comments Parameters: -+ `id` (required) - The ID of a project -+ `merge_request_id` (required) - ID of merge request -+ `note` (required) - Text of comment - +- `id` (required) - The ID of a project +- `merge_request_id` (required) - ID of merge request +- `note` (required) - Text of comment ```json { @@ -268,7 +262,6 @@ Parameters: } ``` - ## Get the comments on a MR Gets all the comments associated with a merge request. @@ -279,8 +272,8 @@ GET /projects/:id/merge_request/:merge_request_id/comments Parameters: -+ `id` (required) - The ID of a project -+ `merge_request_id` (required) - ID of merge request +- `id` (required) - The ID of a project +- `merge_request_id` (required) - ID of merge request ```json [ |