summaryrefslogtreecommitdiff
path: root/doc/api/group_repository_storage_moves.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/group_repository_storage_moves.md')
-rw-r--r--doc/api/group_repository_storage_moves.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/api/group_repository_storage_moves.md b/doc/api/group_repository_storage_moves.md
index 2373fa25e15..53afe8d5ef3 100644
--- a/doc/api/group_repository_storage_moves.md
+++ b/doc/api/group_repository_storage_moves.md
@@ -16,19 +16,19 @@ example, or to migrate a Group Wiki.
As group repository storage moves are processed, they transition through different states. Values
of `state` are:
-- `initial`
-- `scheduled`
-- `started`
-- `finished`
-- `failed`
-- `replicated`
-- `cleanup failed`
+- `initial`: The record has been created but the background job has not yet been scheduled.
+- `scheduled`: The background job has been scheduled.
+- `started`: The group repositories are being copied to the destination storage.
+- `replicated`: The group has been moved.
+- `failed`: The group repositories failed to copy or the checksums did not match.
+- `finished`: The group has been moved and the repositories on the source storage have been deleted.
+- `cleanup failed`: The group has been moved but the repositories on the source storage could not be deleted.
To ensure data integrity, groups are put in a temporary read-only state for the
duration of the move. During this time, users receive a `The repository is temporarily
read-only. Please try again later.` message if they try to push new commits.
-This API requires you to [authenticate yourself](README.md#authentication) as an administrator.
+This API requires you to [authenticate yourself](index.md#authentication) as an administrator.
For other type of repositories you can read:
@@ -42,7 +42,7 @@ GET /group_repository_storage_moves
```
By default, `GET` requests return 20 results at a time because the API results
-are [paginated](README.md#pagination).
+are [paginated](index.md#pagination).
Example request:
@@ -78,7 +78,7 @@ GET /groups/:group_id/repository_storage_moves
```
By default, `GET` requests return 20 results at a time because the API results
-are [paginated](README.md#pagination).
+are [paginated](index.md#pagination).
Supported attributes: