Merge pull request #29033 from nvartolomei/nv/api-doc-recovery

nvartolomei · web-flow · commit d63701cb248d · 2025-12-19T18:06:47.000Z
admin: update shadow indexing api doc
diff --git a/src/v/redpanda/admin/BUILD b/src/v/redpanda/admin/BUILD
@@ -68,6 +68,9 @@ seastar_cc_swagger_library(
 seastar_cc_swagger_library(
     name = "shadow_indexing",
     src = "api-doc/shadow_indexing.json",
+    definitions = [
+        "api-doc/shadow_indexing.def.json",
+    ],
 )
 
 seastar_cc_swagger_library(
diff --git a/src/v/redpanda/admin/api-doc/shadow_indexing.def.json b/src/v/redpanda/admin/api-doc/shadow_indexing.def.json
@@ -0,0 +1,12 @@
+"automated_recovery_request_body": {
+    "description": "Request body for initializing a cluster recovery",
+    "type": "object",
+    "properties": {
+        "cluster_uuid_override": {
+            "description": "Optional cluster uuid to recover. If not provided, will auto-discover the manifest with highest sequence number.",
+            "type": "string",
+            "format": "uuid"
+        }
+    },
+    "additionalProperties": false
+}
diff --git a/src/v/redpanda/admin/api-doc/shadow_indexing.json b/src/v/redpanda/admin/api-doc/shadow_indexing.json
@@ -48,9 +48,11 @@
           "nickname": "initialize_cluster_recovery",
           "parameters": [
             {
-              "name": "body",
-              "paramType": "body",
-              "required": false
+              "in": "body",
+              "required": false,
+              "schema": {
+                "$ref": "#/definitions/automated_recovery_request_body"
+              }
             }
           ],
           "responseMessages": [
@@ -644,4 +646,4 @@
       }
     }
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,9 @@ seastar_cc_swagger_library(`
`68`	`68`	`seastar_cc_swagger_library(`
`69`	`69`	`name = "shadow_indexing",`
`70`	`70`	`src = "api-doc/shadow_indexing.json",`
	`71`	`+ definitions = [`
	`72`	`+ "api-doc/shadow_indexing.def.json",`
	`73`	`+ ],`
`71`	`74`	`)`
`72`	`75`
`73`	`76`	`seastar_cc_swagger_library(`
Original file line number	Diff line number	Diff line change
`@@ -48,9 +48,11 @@`
`48`	`48`	`"nickname": "initialize_cluster_recovery",`
`49`	`49`	`"parameters": [`
`50`	`50`	`{`
`51`		`- "name": "body",`
`52`		`- "paramType": "body",`
`53`		`- "required": false`
	`51`	`+ "in": "body",`
	`52`	`+ "required": false,`
	`53`	`+ "schema": {`
	`54`	`+ "$ref": "#/definitions/automated_recovery_request_body"`
	`55`	`+ }`
`54`	`56`	`}`
`55`	`57`	`],`
`56`	`58`	`"responseMessages": [`
`@@ -644,4 +646,4 @@`
`644`	`646`	`}`
`645`	`647`	`}`
`646`	`648`	`}`
`647`		`-}`
	`649`	`+}`