summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZeger-Jan van de Weg <mail@zjvandeweg.nl>2015-11-23 09:42:20 +0100
committerZeger-Jan van de Weg <mail@zjvandeweg.nl>2015-11-23 10:11:54 +0100
commit8608c6325e19f529f7b43ff881c562d3a0114e1c (patch)
treeacbc21c6603848b4157a2ec5cac11b279f11a5c6 /doc
parent53b285c9a8b7eec9ee10906ef519da376347b69e (diff)
downloadgitlab-ce-8608c6325e19f529f7b43ff881c562d3a0114e1c.tar.gz
Refactor MergeWhenBuildSucceedsService and incorporate feedback
Diffstat (limited to 'doc')
-rw-r--r--doc/api/merge_requests.md8
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index 1b2ad1caf49..19e6fbb7887 100644
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@@ -296,7 +296,7 @@ Parameters:
- `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
-- `merge_when_build_succeeds` (optional) - if `true` the MR is merge when the build succeeds
+- `merged_when_build_succeeds` (optional) - if `true` the MR is merge when the build succeeds
```json
{
@@ -329,15 +329,13 @@ Parameters:
## Cancel Merge When Build Succeeds
-Cancels the merge when build succeeds and reset the merge parameters
-
-If successfull you'll get `200 OK`.
+If successful you'll get `200 OK`.
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'
-In case the merge request is not set to be merged when the build succeeds, you'll also get a 405 with the error message 'Method Not Allowed'
+In case the merge request is not set to be merged when the build succeeds, you'll also get a 406 error.
```
PUT /projects/:id/merge_request/:merge_request_id/cancel_merge_when_build_succeeds
```