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/api | |
| parent | 12ea4cda5fe033fc2b9f1fec51ddc3d8b860a85f (diff) | |
| download | garage-420bbc162dffd1246544168cf2e935efc60c5c98.tar.gz garage-420bbc162dffd1246544168cf2e935efc60c5c98.zip | |
admin api: clearer syntax for AddBucketAlias and RemoveBucketAlias
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/garage-admin-v2.yml | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/doc/api/garage-admin-v2.yml b/doc/api/garage-admin-v2.yml index 5cca7dd1..0b948135 100644 --- a/doc/api/garage-admin-v2.yml +++ b/doc/api/garage-admin-v2.yml @@ -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 - accessKeyId: + globalAlias: type: string - example: GK31c2f218a2e44f485b94239e - alias: + localAlias: type: string example: my_documents + accessKeyId: + type: string + example: GK31c2f218a2e44f485b94239e 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 - accessKeyId: + globalAlias: type: string - example: GK31c2f218a2e44f485b94239e - alias: + example: the_bucket + localAlias: + type: string + accessKeyId: type: string - example: my_documents responses: '500': description: "The server can not handle your request. Check your connectivity with the rest of the cluster." |