Skip to content

Commit e7bc3e3

Browse files
vbotbuildovichgithub-actions[bot]
authored andcommitted
docs: Update Admin API docs for v25.3.2
1 parent eecf277 commit e7bc3e3

File tree

1 file changed

+59
-24
lines changed

1 file changed

+59
-24
lines changed

admin/admin-v2.yaml

Lines changed: 59 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -506,9 +506,18 @@ components:
506506
redpanda.core.admin.v2.AuthenticationConfiguration:
507507
additionalProperties: false
508508
description: |-
509-
Authentication config. Currently only supporting SASL/SCRAM,
510-
however made as a oneof for expansion
509+
Authentication config. Supports:
510+
* SASL/SCRAM
511+
* SASL/PLAIN
511512
oneOf:
513+
- properties:
514+
plainConfiguration:
515+
$ref: "#/components/schemas/redpanda.core.admin.v2.PlainConfig"
516+
description: SASL/PLAIN configuration
517+
title: plain_configuration
518+
required:
519+
- plainConfiguration
520+
title: plain_configuration
512521
- properties:
513522
scramConfiguration:
514523
$ref: "#/components/schemas/redpanda.core.admin.v2.ScramConfig"
@@ -1146,8 +1155,36 @@ components:
11461155
- PATTERN_TYPE_UNSPECIFIED
11471156
- PATTERN_TYPE_LITERAL
11481157
- PATTERN_TYPE_PREFIX
1158+
- PATTERN_TYPE_PREFIXED
11491159
title: PatternType
11501160
type: string
1161+
redpanda.core.admin.v2.PlainConfig:
1162+
additionalProperties: false
1163+
description: PLAIN settings
1164+
properties:
1165+
password:
1166+
description: Password
1167+
title: password
1168+
type: string
1169+
writeOnly: true
1170+
passwordSet:
1171+
description: Indicates that the password has been set
1172+
readOnly: true
1173+
title: password_set
1174+
type: boolean
1175+
passwordSetAt:
1176+
$ref: "#/components/schemas/google.protobuf.Timestamp"
1177+
description: |-
1178+
Timestamp of when the password was last set - only valid if password_set
1179+
is true
1180+
readOnly: true
1181+
title: password_set_at
1182+
username:
1183+
description: PLAIN username
1184+
title: username
1185+
type: string
1186+
title: PlainConfig
1187+
type: object
11511188
redpanda.core.admin.v2.RPCRoute:
11521189
additionalProperties: false
11531190
description: A route in the Admin API RPC server.
@@ -1849,6 +1886,7 @@ components:
18491886
- ACL_PATTERN_ANY
18501887
- ACL_PATTERN_LITERAL
18511888
- ACL_PATTERN_PREFIXED
1889+
- ACL_PATTERN_PREFIX
18521890
- ACL_PATTERN_MATCH
18531891
title: ACLPattern
18541892
type: string
@@ -1958,14 +1996,14 @@ info:
19581996
title: Redpanda Admin API
19591997
version: v2.0.0
19601998
x-admin-api-major: v2.0.0
1961-
x-generated-at: 2025-11-13T21:09:09.434Z
1999+
x-generated-at: 2025-12-12T04:54:23.532Z
19622000
x-generator: redpanda-docs-openapi-bundler
1963-
x-redpanda-core-version: kb/proto/docs/openapi-summaries
2001+
x-redpanda-core-version: v25.3.2
19642002
openapi: 3.1.0
19652003
paths:
19662004
/redpanda.core.admin.v2.BrokerService/GetBroker:
19672005
post:
1968-
description: Returns information about a single broker in the cluster.
2006+
description: GetBroker returns information about a single broker in the cluster.
19692007
operationId: redpanda.core.admin.v2.BrokerService.GetBroker
19702008
parameters:
19712009
- in: header
@@ -1996,12 +2034,12 @@ paths:
19962034
schema:
19972035
$ref: "#/components/schemas/connect.error"
19982036
description: Error
1999-
summary: GetBroker
2037+
summary: GetBroker returns information about a single broker in the cluster.
20002038
tags:
20012039
- BrokerService
20022040
/redpanda.core.admin.v2.BrokerService/ListBrokers:
20032041
post:
2004-
description: Returns information about all brokers in the cluster.
2042+
description: ListBrokers returns information about all brokers in the cluster.
20052043
operationId: redpanda.core.admin.v2.BrokerService.ListBrokers
20062044
parameters:
20072045
- in: header
@@ -2032,12 +2070,14 @@ paths:
20322070
schema:
20332071
$ref: "#/components/schemas/connect.error"
20342072
description: Error
2035-
summary: ListBrokers
2073+
summary: ListBrokers returns information about all brokers in the cluster.
20362074
tags:
20372075
- BrokerService
20382076
/redpanda.core.admin.v2.ClusterService/ListKafkaConnections:
20392077
post:
2040-
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.
20412081
operationId: redpanda.core.admin.v2.ClusterService.ListKafkaConnections
20422082
parameters:
20432083
- in: header
@@ -2068,12 +2108,11 @@ paths:
20682108
schema:
20692109
$ref: "#/components/schemas/connect.error"
20702110
description: Error
2071-
summary: ListKafkaConnections
2111+
summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers.
20722112
tags:
20732113
- ClusterService
20742114
/redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink:
20752115
post:
2076-
description: Creates a new shadow link between clusters.
20772116
operationId: redpanda.core.admin.v2.ShadowLinkService.CreateShadowLink
20782117
parameters:
20792118
- in: header
@@ -2109,7 +2148,6 @@ paths:
21092148
- ShadowLinkService
21102149
/redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink:
21112150
post:
2112-
description: Deletes an existing shadow link.
21132151
operationId: redpanda.core.admin.v2.ShadowLinkService.DeleteShadowLink
21142152
parameters:
21152153
- in: header
@@ -2145,7 +2183,7 @@ paths:
21452183
- ShadowLinkService
21462184
/redpanda.core.admin.v2.ShadowLinkService/FailOver:
21472185
post:
2148-
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
21492187
operationId: redpanda.core.admin.v2.ShadowLinkService.FailOver
21502188
parameters:
21512189
- in: header
@@ -2176,12 +2214,11 @@ paths:
21762214
schema:
21772215
$ref: "#/components/schemas/connect.error"
21782216
description: Error
2179-
summary: FailOver
2217+
summary: Fails over a shadow link or a single shadow topic
21802218
tags:
21812219
- ShadowLinkService
21822220
/redpanda.core.admin.v2.ShadowLinkService/GetShadowLink:
21832221
post:
2184-
description: Gets information about a specific shadow link.
21852222
operationId: redpanda.core.admin.v2.ShadowLinkService.GetShadowLink
21862223
parameters:
21872224
- in: header
@@ -2218,9 +2255,9 @@ paths:
22182255
/redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic:
22192256
post:
22202257
description: |-
2221-
Returns information about a shadow topic on a shadow link.
2222-
A shadow topic is a resource created automatically by a shadow link. The
2223-
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
22242261
and properties of that topic.
22252262
operationId: redpanda.core.admin.v2.ShadowLinkService.GetShadowTopic
22262263
parameters:
@@ -2252,12 +2289,11 @@ paths:
22522289
schema:
22532290
$ref: "#/components/schemas/connect.error"
22542291
description: Error
2255-
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.
22562293
tags:
22572294
- ShadowLinkService
22582295
/redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks:
22592296
post:
2260-
description: Lists all shadow links in the cluster.
22612297
operationId: redpanda.core.admin.v2.ShadowLinkService.ListShadowLinks
22622298
parameters:
22632299
- in: header
@@ -2294,8 +2330,8 @@ paths:
22942330
/redpanda.core.admin.v2.ShadowLinkService/ListShadowTopics:
22952331
post:
22962332
description: |-
2297-
Returns a list of all shadow topics on a shadow link and
2298-
their status.
2333+
This operation returns a list of all Shadow Topics on a Shadow Link and
2334+
their status
22992335
operationId: redpanda.core.admin.v2.ShadowLinkService.ListShadowTopics
23002336
parameters:
23012337
- in: header
@@ -2326,12 +2362,11 @@ paths:
23262362
schema:
23272363
$ref: "#/components/schemas/connect.error"
23282364
description: Error
2329-
summary: ListShadowTopics
2365+
summary: This operation returns a list of all Shadow Topics on a Shadow Link and their status
23302366
tags:
23312367
- ShadowLinkService
23322368
/redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink:
23332369
post:
2334-
description: Updates an existing shadow link configuration.
23352370
operationId: redpanda.core.admin.v2.ShadowLinkService.UpdateShadowLink
23362371
parameters:
23372372
- in: header

0 commit comments

Comments
 (0)