diff options
| author | Nick Thomas <nick@gitlab.com> | 2019-06-21 17:56:47 +0100 |
|---|---|---|
| committer | Nick Thomas <nick@gitlab.com> | 2019-07-04 08:50:55 +0100 |
| commit | 381468d0cc6e5b528a4b2207c0a534569035a73f (patch) | |
| tree | 2ffc9e9062fef50a7cca8dfd8d0b5733e8cf4c9d /doc/api | |
| parent | 9ef0c8559de925d0a72a3fe421d95209c2b81d8f (diff) | |
| download | gitlab-ce-381468d0cc6e5b528a4b2207c0a534569035a73f.tar.gz | |
Allow asynchronous rebase operations to be monitored
This MR introduces tracking of the `rebase_jid` for merge requests. As
with `merge_ongoing?`, `rebase_in_progress?` will now return true if a
rebase is proceeding in sidekiq.
After one release, we should remove the Gitaly-based lookup of rebases.
It is much better to track this kind of thing via the database.
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/merge_requests.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 69db9f97a35..5a20db4b647 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -1485,8 +1485,14 @@ PUT /projects/:id/merge_requests/:merge_request_iid/rebase curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/76/merge_requests/1/rebase ``` -This is an asynchronous request. The API will return an empty `202 Accepted` -response if the request is enqueued successfully. +This is an asynchronous request. The API will return a `202 Accepted` response +if the request is enqueued successfully, with a response containing: + +```json +{ + "rebase_in_progress": true +} +``` You can poll the [Get single MR](#get-single-mr) endpoint with the `include_rebase_in_progress` parameter to check the status of the |