From 0d415f42ac9158ba30079f9ed315a1d1c6a8caf9 Mon Sep 17 00:00:00 2001
From: Quentin Dufour <quentin@deuxfleurs.fr>
Date: Wed, 22 Nov 2023 18:05:11 +0100
Subject: Port GetKeyInfo by adding showSecretKey query param

---
 doc/api/garage-admin-v1.yml | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/api/garage-admin-v1.yml b/doc/api/garage-admin-v1.yml
index 9fb57e11..b41fcc5a 100644
--- a/doc/api/garage-admin-v1.yml
+++ b/doc/api/garage-admin-v1.yml
@@ -361,6 +361,14 @@ paths:
           example: "GK31c2f218a2e44f485b94239e"
           schema:
             type: string
+        - name: showSecretKey
+          in: query
+          schema:
+            type: boolean
+            default: false
+          example: true
+          required: false
+          description: "Wether or not the secret key should be returned in the response"
       responses:
         '500':
           description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
@@ -464,6 +472,14 @@ paths:
           example: "test-k"
           schema:
             type: string
+        - name: showSecretKey
+          in: query
+          schema:
+            type: boolean
+            default: false
+          example: true
+          required: false
+          description: "Wether or not the secret key should be returned in the response"
       responses:
         '500':
           description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
@@ -1117,7 +1133,7 @@ components:
           type: string
           example: "6a8e08af2aab1083ebab9b22165ea8b5b9d333b60a39ecd504e85cc1f432c36f"
         remove:
-          type: bool
+          type: boolean
           example: true
     NodeRoleUpdate:
       type: object
@@ -1194,6 +1210,7 @@ components:
           example: "GK31c2f218a2e44f485b94239e"
         secretAccessKey:
           type: string
+          nullable: true
           example: "b892c0665f0ada8a4755dae98baa3b133590e11dae3bcc1f9d769d67f16c3835"
         permissions:
           type: object
-- 
cgit v1.2.3