Skip to content

Commit

Permalink
docs/api/migrations: refer to objects with defined schemas via $ref
Browse files Browse the repository at this point in the history
Swagger needs "$ref", while seastar only allows "type" (at least until
scylladb/seastar#2452 is merged), so let's use both
for now
  • Loading branch information
bashtanov committed Sep 24, 2024
1 parent dcf5c63 commit 22edfe6
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions src/v/redpanda/admin/api-doc/migration.def.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
}
},
"copy_to": {
"type": "bucket_configuration"
"type": "bucket_configuration",
"$ref": "bucket_configuration"
},
"auto_advance": {
"type": "boolean",
Expand All @@ -61,7 +62,7 @@
"topics": {
"type": "array",
"items": {
"type": "inbound_topic"
"$ref": "inbound_topic"
}
},
"consumer_groups": {
Expand All @@ -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"
}
}
},
Expand Down Expand Up @@ -136,7 +139,8 @@
"type": "string"
},
"migration": {
"type": "outbound_migration"
"type": "outbound_migration",
"$ref": "outbound_migration"
}
}
},
Expand All @@ -152,7 +156,8 @@
"description": "Current migration state"
},
"migration": {
"type": "inbound_migration"
"type": "inbound_migration",
"$ref": "inbound_migration"
}
}
},
Expand All @@ -165,7 +170,7 @@
"topics": {
"type": "array",
"items": {
"type": "inbound_topic"
"$ref": "inbound_topic"
},
"description": "List of topics to mount"
}
Expand Down

0 comments on commit 22edfe6

Please sign in to comment.