aboutsummaryrefslogtreecommitdiff
path: root/doc
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
parent5fefbd94e9f8cded0d911f7cdae3d0382762607c (diff)
downloadgarage-12ea4cda5fe033fc2b9f1fec51ddc3d8b860a85f.tar.gz
garage-12ea4cda5fe033fc2b9f1fec51ddc3d8b860a85f.zip
admin api: merge calls to manage global/local aliases
Diffstat (limited to 'doc')
-rw-r--r--doc/api/garage-admin-v2.yml94
-rw-r--r--doc/drafts/admin-api.md38
2 files changed, 21 insertions, 111 deletions
diff --git a/doc/api/garage-admin-v2.yml b/doc/api/garage-admin-v2.yml
index 9ee1cf63..5cca7dd1 100644
--- a/doc/api/garage-admin-v2.yml
+++ b/doc/api/garage-admin-v2.yml
@@ -946,14 +946,16 @@ paths:
schema:
$ref: '#/components/schemas/BucketInfo'
- /AddGlobalBucketAlias:
+ /AddBucketAlias:
post:
tags:
- Bucket aliases
- operationId: "AddGlobalBucketAlias"
- summary: "Add a global alias"
+ operationId: "AddlBucketAlias"
+ summary: "Add an alias to a bucket"
description: |
- Add a global alias to the target bucket
+ Add an alias for the target bucket.
+ This can be a local alias if `accessKeyId` is specified,
+ or a global alias otherwise.
requestBody:
required: true
content:
@@ -965,78 +967,6 @@ paths:
bucketId:
type: string
example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
- alias:
- type: string
- example: my_documents
- responses:
- '500':
- description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
- '400':
- description: "Bad request, check your request body"
- '404':
- description: "Bucket not found"
- '200':
- description: Returns exhaustive information about the bucket
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BucketInfo'
-
- /RemoveGlobalBucketAlias:
- post:
- tags:
- - Bucket aliases
- operationId: "RemoveGlobalBucketAlias"
- summary: "Delete a global alias"
- description: |
- Delete a global alias from the target bucket
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- required: [bucketId, alias]
- properties:
- bucketId:
- type: string
- example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
- alias:
- type: string
- example: my_documents
- responses:
- '500':
- description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
- '400':
- description: "Bad request, check your request body"
- '404':
- description: "Bucket not found"
- '200':
- description: Returns exhaustive information about the bucket
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BucketInfo'
-
- /AddLocalBucketAlias:
- post:
- tags:
- - Bucket aliases
- operationId: "AddLocalBucketAlias"
- summary: "Add a local alias"
- description: |
- Add a local alias, bound to specified account, to the target bucket
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- required: [bucketId, accessKeyId, alias]
- properties:
- bucketId:
- type: string
- example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
accessKeyId:
type: string
example: GK31c2f218a2e44f485b94239e
@@ -1057,21 +987,23 @@ paths:
schema:
$ref: '#/components/schemas/BucketInfo'
- /RemoveGlobalBucketAlias:
+ /RemoveBucketAlias:
post:
tags:
- Bucket aliases
- operationId: "RemoveGlobalBucketAlias"
- summary: "Delete a local alias"
+ operationId: "RemoveBucketAlias"
+ summary: "Remove an alias from a bucket"
description: |
- Delete a local alias, bound to specified account, from the target bucket
+ Remove an alias for the target bucket.
+ This can be a local alias if `accessKeyId` is specified,
+ or a global alias otherwise.
requestBody:
required: true
content:
application/json:
schema:
type: object
- required: [bucketId, accessKeyId, alias]
+ required: [bucketId, alias]
properties:
bucketId:
type: string
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: