Skip to content

Commit 284375a

Browse files
vbotbuildovichgithub-actions[bot]
authored andcommitted
docs: Update Admin API docs for v25.3.3
1 parent b05c46b commit 284375a

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

admin/admin-v2.yaml

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1996,14 +1996,14 @@ info:
19961996
title: Redpanda Admin API
19971997
version: v2.0.0
19981998
x-admin-api-major: v2.0.0
1999-
x-generated-at: 2025-12-12T04:54:23.532Z
1999+
x-generated-at: 2025-12-20T17:39:07.209Z
20002000
x-generator: redpanda-docs-openapi-bundler
2001-
x-redpanda-core-version: v25.3.2
2001+
x-redpanda-core-version: v25.3.3
20022002
openapi: 3.1.0
20032003
paths:
20042004
/redpanda.core.admin.v2.BrokerService/GetBroker:
20052005
post:
2006-
description: Returns information about a single broker in the cluster.
2006+
description: GetBroker returns information about a single broker in the cluster.
20072007
operationId: redpanda.core.admin.v2.BrokerService.GetBroker
20082008
parameters:
20092009
- in: header
@@ -2034,12 +2034,12 @@ paths:
20342034
schema:
20352035
$ref: "#/components/schemas/connect.error"
20362036
description: Error
2037-
summary: GetBroker
2037+
summary: GetBroker returns information about a single broker in the cluster.
20382038
tags:
20392039
- BrokerService
20402040
/redpanda.core.admin.v2.BrokerService/ListBrokers:
20412041
post:
2042-
description: Returns information about all brokers in the cluster.
2042+
description: ListBrokers returns information about all brokers in the cluster.
20432043
operationId: redpanda.core.admin.v2.BrokerService.ListBrokers
20442044
parameters:
20452045
- in: header
@@ -2070,12 +2070,14 @@ paths:
20702070
schema:
20712071
$ref: "#/components/schemas/connect.error"
20722072
description: Error
2073-
summary: ListBrokers
2073+
summary: ListBrokers returns information about all brokers in the cluster.
20742074
tags:
20752075
- BrokerService
20762076
/redpanda.core.admin.v2.ClusterService/ListKafkaConnections:
20772077
post:
2078-
description: Returns information about the cluster's Kafka connections, collected and ordered across all brokers.
2078+
description: |-
2079+
ListKafkaConnections returns information about the cluster's Kafka
2080+
connections, collected and ordered across all brokers.
20792081
operationId: redpanda.core.admin.v2.ClusterService.ListKafkaConnections
20802082
parameters:
20812083
- in: header
@@ -2106,12 +2108,11 @@ paths:
21062108
schema:
21072109
$ref: "#/components/schemas/connect.error"
21082110
description: Error
2109-
summary: ListKafkaConnections
2111+
summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers.
21102112
tags:
21112113
- ClusterService
21122114
/redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink:
21132115
post:
2114-
description: Creates a new shadow link between clusters.
21152116
operationId: redpanda.core.admin.v2.ShadowLinkService.CreateShadowLink
21162117
parameters:
21172118
- in: header
@@ -2147,7 +2148,6 @@ paths:
21472148
- ShadowLinkService
21482149
/redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink:
21492150
post:
2150-
description: Deletes an existing shadow link.
21512151
operationId: redpanda.core.admin.v2.ShadowLinkService.DeleteShadowLink
21522152
parameters:
21532153
- in: header
@@ -2183,7 +2183,7 @@ paths:
21832183
- ShadowLinkService
21842184
/redpanda.core.admin.v2.ShadowLinkService/FailOver:
21852185
post:
2186-
description: Fails over a shadow link or a single shadow topic for disaster recovery.
2186+
description: Fails over a shadow link or a single shadow topic
21872187
operationId: redpanda.core.admin.v2.ShadowLinkService.FailOver
21882188
parameters:
21892189
- in: header
@@ -2214,12 +2214,11 @@ paths:
22142214
schema:
22152215
$ref: "#/components/schemas/connect.error"
22162216
description: Error
2217-
summary: FailOver
2217+
summary: Fails over a shadow link or a single shadow topic
22182218
tags:
22192219
- ShadowLinkService
22202220
/redpanda.core.admin.v2.ShadowLinkService/GetShadowLink:
22212221
post:
2222-
description: Gets information about a specific shadow link.
22232222
operationId: redpanda.core.admin.v2.ShadowLinkService.GetShadowLink
22242223
parameters:
22252224
- in: header
@@ -2256,9 +2255,9 @@ paths:
22562255
/redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic:
22572256
post:
22582257
description: |-
2259-
Returns information about a shadow topic on a shadow link.
2260-
A shadow topic is a resource created automatically by a shadow link. The
2261-
shadow topic 'shadows' a topic on a source cluster, mirroring the data
2258+
This operation returns information about a Shadow Topic on a Shadow Link.
2259+
A Shadow Topic is a resource created automatically by a Shadow Link. The
2260+
Shadow Topic 'shadows' a topic on a source cluster, mirroring the data
22622261
and properties of that topic.
22632262
operationId: redpanda.core.admin.v2.ShadowLinkService.GetShadowTopic
22642263
parameters:
@@ -2290,12 +2289,11 @@ paths:
22902289
schema:
22912290
$ref: "#/components/schemas/connect.error"
22922291
description: Error
2293-
summary: GetShadowTopic
2292+
summary: This operation returns information about a Shadow Topic on a Shadow Link. A Shadow Topic is a resource created automatically by a Shadow Link. The Shadow Topic 'shadows' a topic on a source cluster, mirroring the data and properties of that topic.
22942293
tags:
22952294
- ShadowLinkService
22962295
/redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks:
22972296
post:
2298-
description: Lists all shadow links in the cluster.
22992297
operationId: redpanda.core.admin.v2.ShadowLinkService.ListShadowLinks
23002298
parameters:
23012299
- in: header
@@ -2332,8 +2330,8 @@ paths:
23322330
/redpanda.core.admin.v2.ShadowLinkService/ListShadowTopics:
23332331
post:
23342332
description: |-
2335-
Returns a list of all shadow topics on a shadow link and
2336-
their status.
2333+
This operation returns a list of all Shadow Topics on a Shadow Link and
2334+
their status
23372335
operationId: redpanda.core.admin.v2.ShadowLinkService.ListShadowTopics
23382336
parameters:
23392337
- in: header
@@ -2364,12 +2362,11 @@ paths:
23642362
schema:
23652363
$ref: "#/components/schemas/connect.error"
23662364
description: Error
2367-
summary: ListShadowTopics
2365+
summary: This operation returns a list of all Shadow Topics on a Shadow Link and their status
23682366
tags:
23692367
- ShadowLinkService
23702368
/redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink:
23712369
post:
2372-
description: Updates an existing shadow link configuration.
23732370
operationId: redpanda.core.admin.v2.ShadowLinkService.UpdateShadowLink
23742371
parameters:
23752372
- in: header

0 commit comments

Comments
 (0)