Deuxfleurs/garage
41
56
Fork 73
Code Issues 98 Pull requests 14 Releases 30 Wiki Activity

OpenAPI specification of admin APIv1 #672

Merged
lx merged 15 commits from api-v1 into main 2023-11-29 15:42:47 +00:00
Conversation 10 Commits 15 Files changed 7 +5 -5
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 814b3e11d4 - Show all commits

8
doc/api/garage-admin-v1.yml
View file

@ -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
quentin marked this conversation as resolved Outdated
unrob commented 2023-11-23 01:51:15 +00:00
Outdated
Review
Copy link

Thanks for the super fast response on #671! Updated my fork of the terraform provider but can't delete a key (with the golang sdk).

It issues a request to DELETE /v1/key without an id query string parameter (which i think the endpoint consumes), and here it says it needs to go on the path, but there's no {access_key} in there. Should this be name: id, in: query?

Thanks for the super fast response on #671! Updated [my fork](https://git.rob.mx/nidito/terraform-provider-garage/pulls/1) of the terraform provider but can't delete a key (with the golang sdk). It issues a request to `DELETE /v1/key` without an `id` query string parameter (which i think the [endpoint](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/src/api/admin/router_v1.rs#L114) consumes), and here it says it needs to go on the path, but there's no `{access_key}` in there. Should this be `name: id, in: query`?
👍 1
quentin commented 2023-11-23 07:57:50 +00:00
Outdated
Review
Copy link

Indeed you're right.

Should be fixed now.

Indeed you're right. Should be fixed now.
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"