From 22edfe6415153fe4f2a75cfa0471068f6cd70091 Mon Sep 17 00:00:00 2001
From: alexey bashtanov <alexey.bashtanov@redpanda.com>
Date: Fri, 20 Sep 2024 23:12:37 +0100
Subject: [PATCH] docs/api/migrations: refer to objects with defined schemas
 via $ref

Swagger needs "$ref", while seastar only allows "type" (at least until
https://github.com/scylladb/seastar/pull/2452 is merged), so let's use both
for now
---
 .../redpanda/admin/api-doc/migration.def.json | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/src/v/redpanda/admin/api-doc/migration.def.json b/src/v/redpanda/admin/api-doc/migration.def.json
index e29c433a22e33..0d4eea7f6165d 100644
--- a/src/v/redpanda/admin/api-doc/migration.def.json
+++ b/src/v/redpanda/admin/api-doc/migration.def.json
@@ -41,7 +41,8 @@
             }
         },
         "copy_to": {
-            "type": "bucket_configuration"
+            "type": "bucket_configuration",
+            "$ref": "bucket_configuration"
         },
         "auto_advance": {
             "type": "boolean",
@@ -61,7 +62,7 @@
         "topics": {
             "type": "array",
             "items": {
-                "type": "inbound_topic"
+                "$ref": "inbound_topic"
             }
         },
         "consumer_groups": {
@@ -85,11 +86,13 @@
     "properties": {
         "source_topic": {
             "description": "Name of the topic in the source cluster",
-            "type": "namespaced_topic"
+            "type": "namespaced_topic",
+            "$ref": "namespaced_topic"
         },
         "alias": {
             "description": "Name of the topic in the destination cluster",
-            "type": "namespaced_topic"
+            "type": "namespaced_topic",
+            "$ref": "namespaced_topic"
         }
     }
 },
@@ -136,7 +139,8 @@
             "type": "string"
         },
         "migration": {
-            "type": "outbound_migration"
+            "type": "outbound_migration",
+            "$ref": "outbound_migration"
         }
     }
 },
@@ -152,7 +156,8 @@
             "description": "Current migration state"
         },
         "migration": {
-            "type": "inbound_migration"
+            "type": "inbound_migration",
+            "$ref": "inbound_migration"
         }
     }
 },
@@ -165,7 +170,7 @@
         "topics": {
             "type": "array",
             "items": {
-                "type": "inbound_topic"
+                "$ref": "inbound_topic"
             },
             "description": "List of topics to mount"
         }