gsadmin/garage
1
0
Fork 0
mirror of https://github.com/deuxfleurs-org/garage.git synced 2026-08-13 07:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

admin api: clearer syntax for AddBucketAlias and RemoveBucketAlias

Browse Source
This commit is contained in:
Alex Auvolat
2025-01-29 11:06:45 +01:00
parent 12ea4cda5f
commit 420bbc162d
7 changed files with 79 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/garage-admin-v2.yml
+13 -10
View File
@@ -950,7 +950,7 @@ paths:
post:
tags:
- Bucket aliases
operationId: "AddlBucketAlias"
operationId: "AddBucketAlias"
summary: "Add an alias to a bucket"
description: |
Add an alias for the target bucket.
@@ -962,17 +962,19 @@ paths:
application/json:
schema:
type: object
required: [bucketId, alias]
required: [bucketId]
properties:
bucketId:
type: string
example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
globalAlias:
type: string
localAlias:
type: string
example: my_documents
accessKeyId:
type: string
example: GK31c2f218a2e44f485b94239e
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."
@@ -1003,17 +1005,18 @@ paths:
application/json:
schema:
type: object
required: [bucketId, alias]
required: [bucketId]
properties:
bucketId:
type: string
example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
globalAlias:
type: string
example: the_bucket
localAlias:
type: string
accessKeyId:
type: string
example: GK31c2f218a2e44f485b94239e
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."
doc/drafts/admin-api.md
+15 -15
View File
@@ -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",
"globalAlias": "my-bucket"
}
```
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.
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:
```json
{
"bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b",
"accessKeyId": "GK31c2f218a2e44f485b94239e",
"alias": "my-bucket"
}
```
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.