diff options
author | Douwe Maan <douwe@gitlab.com> | 2019-02-27 13:59:06 +0300 |
---|---|---|
committer | Douwe Maan <douwe@gitlab.com> | 2019-02-27 13:59:06 +0300 |
commit | 7ebe264779b5ef6db61afca836774ecb5a3fcbfc (patch) | |
tree | cecf38c19aff561862667503206c52ca6c9946c8 /doc | |
parent | 8cfbe8ab71fcef351a5b40852d7dd66acdd66531 (diff) | |
parent | e8fbc070e01b0c527c66d803f9be813b4c2cdc0a (diff) |
Merge branch 'osw-merge-refs-refreshing-api' into 'master'
API support for MR merge to temporary merge ref path
Closes #57252
See merge request gitlab-org/gitlab-ce!24918
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/merge_requests.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index e176cdffc5f..ed4b6281acc 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -1101,6 +1101,40 @@ Parameters: } ``` +## Merge to default merge ref path + +Merge the changes between the merge request source and target branches into `refs/merge-requests/:iid/merge` +ref, of the target project repository. This ref will have the state the target branch would have if +a regular merge action was taken. + +This is not a regular merge action given it doesn't change the merge request state in any manner. + +This ref (`refs/merge-requests/:iid/merge`) is **always** overwritten when submitting +requests to this API, so none of its state is kept or used in the process. + +If the merge request has conflicts, is empty or already merged, +you'll get a `400` and a descriptive error message. If you don't have permissions to do so, +you'll get a `403`. + +It returns the HEAD commit of `refs/merge-requests/:iid/merge` in the response body in +case of `200`. + +``` +PUT /projects/:id/merge_requests/:merge_request_iid/merge_to_ref +``` + +Parameters: + +- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user +- `merge_request_iid` (required) - Internal ID of MR +- `merge_commit_message` (optional) - Custom merge commit message + +```json +{ + "commit_id": "854a3a7a17acbcc0bbbea170986df1eb60435f34" +} +``` + ## Cancel Merge When Pipeline Succeeds If you don't have permissions to accept this merge request - you'll get a `401` |