aboutsummaryrefslogtreecommitdiff
path: root/doc/drafts/admin-api.md
diff options
context:
space:
mode:
authorAlex Auvolat <lx@deuxfleurs.fr>2025-01-28 19:03:39 +0100
committerAlex Auvolat <lx@deuxfleurs.fr>2025-01-29 19:26:16 +0100
commit12ea4cda5fe033fc2b9f1fec51ddc3d8b860a85f (patch)
treedaf39f76283143890210629d3b76fd6fa1cc6b3e /doc/drafts/admin-api.md
parent5fefbd94e9f8cded0d911f7cdae3d0382762607c (diff)
downloadgarage-12ea4cda5fe033fc2b9f1fec51ddc3d8b860a85f.tar.gz
garage-12ea4cda5fe033fc2b9f1fec51ddc3d8b860a85f.zip
admin api: merge calls to manage global/local aliases
Diffstat (limited to 'doc/drafts/admin-api.md')
-rw-r--r--doc/drafts/admin-api.md38
1 files changed, 8 insertions, 30 deletions
diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md
index 1fbe7c40..6d24a1b6 100644
--- a/doc/drafts/admin-api.md
+++ b/doc/drafts/admin-api.md
@@ -750,35 +750,11 @@ Other flags will remain unchanged.
### Operations on bucket aliases
-#### AddGlobalBucketAlias `POST /v2/AddGlobalBucketAlias`
+#### AddBucketAlias `POST /v2/AddBucketAlias`
-Creates a global alias for a bucket.
-
-Request body format:
-
-```json
-{
- "bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b",
- "alias": "the-bucket"
-}
-```
-
-#### RemoveGlobalBucketAlias `POST /v2/RemoveGlobalBucketAlias`
-
-Removes a global alias for a bucket.
-
-Request body format:
-
-```json
-{
- "bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b",
- "alias": "the-bucket"
-}
-```
-
-#### AddLocalBucketAlias `POST /v2/AddLocalBucketAlias`
-
-Creates a local alias for a bucket in the namespace of a specific access key.
+Creates an alias for a bucket in the namespace of a specific access key.
+If `accessKeyId` is specified, an alias is created in the local namespace
+of the key. Otherwise, a global alias is created.
Request body format:
@@ -790,9 +766,11 @@ Request body format:
}
```
-#### RemoveLocalBucketAlias `POST /v2/RemoveLocalBucketAlias`
+#### RemoveBucketAlias `POST /v2/RemoveBucketAlias`
-Removes a local alias for a bucket in the namespace of a specific access key.
+Removes an alias for a bucket in the namespace of a specific access key.
+If `accessKeyId` is specified, the alias is removed from the local namespace
+of the key. Otherwise, the alias is removed from the global namespace.
Request body format: