diff options
| author | Douwe Maan <douwe@gitlab.com> | 2019-06-03 16:29:41 +0000 |
|---|---|---|
| committer | Douwe Maan <douwe@gitlab.com> | 2019-06-03 16:29:41 +0000 |
| commit | 96ff9c6bd82a6eb60b9f2d1c20fca0105ed4160d (patch) | |
| tree | 7e6025b6d502befb5bc973a42ae02519f5c523aa /doc/api | |
| parent | a9589cdf28bc789e0b4902e3d45acfc9a6b69217 (diff) | |
| parent | 4246a62118d919e62b94d75eba641ed374c3f241 (diff) | |
| download | gitlab-ce-96ff9c6bd82a6eb60b9f2d1c20fca0105ed4160d.tar.gz | |
Merge branch 'osw-sync-merge-ref-upon-mergeability-check' into 'master'
Automatically update MR merge-ref along merge status
Closes #58495
See merge request gitlab-org/gitlab-ce!28513
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/merge_requests.md | 20 |
1 files changed, 8 insertions, 12 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 7992af15448..9529a9ec1f5 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -1159,33 +1159,29 @@ Parameters: } ``` -## Merge to default merge ref path +## Returns the up to date merge-ref HEAD commit 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 +ref, of the target project repository, if possible. 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 is not a regular merge action given it doesn't change the merge request target branch 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. +This ref (`refs/merge-requests/:iid/merge`) isn't necessarily overwritten when submitting +requests to this API, though it'll make sure the ref has the latest possible state. -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`. +If the merge request has conflicts, is empty or already merged, you'll get a `400` and a descriptive error message. -It returns the HEAD commit of `refs/merge-requests/:iid/merge` in the response body in -case of `200`. +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 +GET /projects/:id/merge_requests/:merge_request_iid/merge_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 { |