Skip to content

Commit 22edfe6

Browse files
committed
docs/api/migrations: refer to objects with defined schemas via $ref
Swagger needs "$ref", while seastar only allows "type" (at least until scylladb/seastar#2452 is merged), so let's use both for now
1 parent dcf5c63 commit 22edfe6

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

Diff for: src/v/redpanda/admin/api-doc/migration.def.json

+12-7
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@
4141
}
4242
},
4343
"copy_to": {
44-
"type": "bucket_configuration"
44+
"type": "bucket_configuration",
45+
"$ref": "bucket_configuration"
4546
},
4647
"auto_advance": {
4748
"type": "boolean",
@@ -61,7 +62,7 @@
6162
"topics": {
6263
"type": "array",
6364
"items": {
64-
"type": "inbound_topic"
65+
"$ref": "inbound_topic"
6566
}
6667
},
6768
"consumer_groups": {
@@ -85,11 +86,13 @@
8586
"properties": {
8687
"source_topic": {
8788
"description": "Name of the topic in the source cluster",
88-
"type": "namespaced_topic"
89+
"type": "namespaced_topic",
90+
"$ref": "namespaced_topic"
8991
},
9092
"alias": {
9193
"description": "Name of the topic in the destination cluster",
92-
"type": "namespaced_topic"
94+
"type": "namespaced_topic",
95+
"$ref": "namespaced_topic"
9396
}
9497
}
9598
},
@@ -136,7 +139,8 @@
136139
"type": "string"
137140
},
138141
"migration": {
139-
"type": "outbound_migration"
142+
"type": "outbound_migration",
143+
"$ref": "outbound_migration"
140144
}
141145
}
142146
},
@@ -152,7 +156,8 @@
152156
"description": "Current migration state"
153157
},
154158
"migration": {
155-
"type": "inbound_migration"
159+
"type": "inbound_migration",
160+
"$ref": "inbound_migration"
156161
}
157162
}
158163
},
@@ -165,7 +170,7 @@
165170
"topics": {
166171
"type": "array",
167172
"items": {
168-
"type": "inbound_topic"
173+
"$ref": "inbound_topic"
169174
},
170175
"description": "List of topics to mount"
171176
}

0 commit comments

Comments
 (0)