OpenAPI specification of admin APIv1 #672

Merged
lx merged 15 commits from api-v1 into main 2023-11-29 15:42:47 +00:00
Showing only changes of commit 814b3e11d4 - Show all commits

View file

@ -348,7 +348,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/KeyInfo' $ref: '#/components/schemas/KeyInfo'
"/key": "/key":
get: get:
tags: tags:
@ -409,8 +409,8 @@ paths:
description: | description: |
Delete a key from the cluster. Its access will be removed from all the buckets. Buckets are not automatically deleted and can be dangling. You should manually delete them before. Delete a key from the cluster. Its access will be removed from all the buckets. Buckets are not automatically deleted and can be dangling. You should manually delete them before.
parameters: parameters:
- name: access_key - name: id
in: path in: query
required: true required: true
description: "The exact API access key generated by Garage" description: "The exact API access key generated by Garage"
example: "GK31c2f218a2e44f485b94239e" example: "GK31c2f218a2e44f485b94239e"
@ -433,8 +433,8 @@ paths:
*Note: the secret key is not returned in the response, `null` is sent instead.* *Note: the secret key is not returned in the response, `null` is sent instead.*
parameters: parameters:
- name: access_key - name: id
in: path in: query
required: true required: true
description: "The exact API access key generated by Garage" description: "The exact API access key generated by Garage"
example: "GK31c2f218a2e44f485b94239e" example: "GK31c2f218a2e44f485b94239e"