diff options
author | Alex Auvolat <lx@deuxfleurs.fr> | 2025-01-29 11:06:45 +0100 |
---|---|---|
committer | Alex Auvolat <lx@deuxfleurs.fr> | 2025-01-29 19:26:16 +0100 |
commit | 420bbc162dffd1246544168cf2e935efc60c5c98 (patch) | |
tree | 2bb6a733de3e0c1856879631f4397dad0a518cb0 /doc/drafts/admin-api.md | |
parent | 12ea4cda5fe033fc2b9f1fec51ddc3d8b860a85f (diff) | |
download | garage-420bbc162dffd1246544168cf2e935efc60c5c98.tar.gz garage-420bbc162dffd1246544168cf2e935efc60c5c98.zip |
admin api: clearer syntax for AddBucketAlias and RemoveBucketAlias
Diffstat (limited to 'doc/drafts/admin-api.md')
-rw-r--r-- | doc/drafts/admin-api.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md index 6d24a1b6..ca60ead1 100644 --- a/doc/drafts/admin-api.md +++ b/doc/drafts/admin-api.md @@ -753,32 +753,32 @@ Other flags will remain unchanged. #### AddBucketAlias `POST /v2/AddBucketAlias` 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. +To create a global alias, specify the `globalAlias` field. +To create a local alias, specify the `localAlias` and `accessKeyId` fields. Request body format: ```json { "bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b", - "accessKeyId": "GK31c2f218a2e44f485b94239e", - "alias": "my-bucket" + "globalAlias": "my-bucket" } ``` -#### RemoveBucketAlias `POST /v2/RemoveBucketAlias` - -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: +or: ```json { "bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b", "accessKeyId": "GK31c2f218a2e44f485b94239e", - "alias": "my-bucket" + "localAlias": "my-bucket" } ``` +#### RemoveBucketAlias `POST /v2/RemoveBucketAlias` + +Removes an alias for a bucket in the namespace of a specific access key. +To remove a global alias, specify the `globalAlias` field. +To remove a local alias, specify the `localAlias` and `accessKeyId` fields. + +Request body format: same as AddBucketAlias. |