Skip to content

auto-docs: Update Admin API docs for v25.3.4 #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vbotbuildovich wants to merge 1 commit into
base: main
Choose a base branch
from
Open

auto-docs: Update Admin API docs for v25.3.4 #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 19 additions & 22 deletions admin/admin-v2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1996,14 +1996,14 @@ info:
title: Redpanda Admin API
version: v2.0.0
x-admin-api-major: v2.0.0
x-generated-at: 2025-12-12T04:54:23.532Z
x-generated-at: 2025-12-26T05:33:49.898Z
x-generator: redpanda-docs-openapi-bundler
x-redpanda-core-version: v25.3.2
x-redpanda-core-version: v25.3.4
openapi: 3.1.0
paths:
/redpanda.core.admin.v2.BrokerService/GetBroker:
post:
description: Returns information about a single broker in the cluster.
description: GetBroker returns information about a single broker in the cluster.
operationId: redpanda.core.admin.v2.BrokerService.GetBroker
parameters:
- in: header
Expand Down Expand Up @@ -2034,12 +2034,12 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: GetBroker
summary: GetBroker returns information about a single broker in the cluster.
tags:
- BrokerService
/redpanda.core.admin.v2.BrokerService/ListBrokers:
post:
description: Returns information about all brokers in the cluster.
description: ListBrokers returns information about all brokers in the cluster.
operationId: redpanda.core.admin.v2.BrokerService.ListBrokers
parameters:
- in: header
Expand Down Expand Up @@ -2070,12 +2070,14 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: ListBrokers
summary: ListBrokers returns information about all brokers in the cluster.
tags:
- BrokerService
/redpanda.core.admin.v2.ClusterService/ListKafkaConnections:
post:
description: Returns information about the cluster's Kafka connections, collected and ordered across all brokers.
description: |-
ListKafkaConnections returns information about the cluster's Kafka
connections, collected and ordered across all brokers.
operationId: redpanda.core.admin.v2.ClusterService.ListKafkaConnections
parameters:
- in: header
Expand Down Expand Up @@ -2106,12 +2108,11 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: ListKafkaConnections
summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers.
Copy link
Contributor

@Feediver1 Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers.
summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers.

tags:
- ClusterService
/redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink:
post:
description: Creates a new shadow link between clusters.
operationId: redpanda.core.admin.v2.ShadowLinkService.CreateShadowLink
parameters:
- in: header
Expand Down Expand Up @@ -2147,7 +2148,6 @@ paths:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink:
post:
description: Deletes an existing shadow link.
operationId: redpanda.core.admin.v2.ShadowLinkService.DeleteShadowLink
parameters:
- in: header
Expand Down Expand Up @@ -2183,7 +2183,7 @@ paths:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/FailOver:
post:
description: Fails over a shadow link or a single shadow topic for disaster recovery.
description: Fails over a shadow link or a single shadow topic
Copy link
Contributor

@Feediver1 Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Fails over a shadow link or a single shadow topic
description: Fails over a shadow link or a single shadow topic.

operationId: redpanda.core.admin.v2.ShadowLinkService.FailOver
parameters:
- in: header
Expand Down Expand Up @@ -2214,12 +2214,11 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: FailOver
summary: Fails over a shadow link or a single shadow topic
tags:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/GetShadowLink:
post:
description: Gets information about a specific shadow link.
operationId: redpanda.core.admin.v2.ShadowLinkService.GetShadowLink
parameters:
- in: header
Expand Down Expand Up @@ -2256,9 +2255,9 @@ paths:
/redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic:
post:
description: |-
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
This operation returns information about a Shadow Topic on a Shadow Link.
Copy link
Contributor

@Feediver1 Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our DR docs do not use this capitalization style. The enterprise feature is Shadowing. Docs use shadow linking, and shadow topics.

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.
operationId: redpanda.core.admin.v2.ShadowLinkService.GetShadowTopic
parameters:
Expand Down Expand Up @@ -2290,12 +2289,11 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: GetShadowTopic
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.
Copy link
Contributor

@Feediver1 Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment re capitalization

tags:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks:
post:
description: Lists all shadow links in the cluster.
operationId: redpanda.core.admin.v2.ShadowLinkService.ListShadowLinks
parameters:
- in: header
Expand Down Expand Up @@ -2332,8 +2330,8 @@ paths:
/redpanda.core.admin.v2.ShadowLinkService/ListShadowTopics:
post:
description: |-
Returns a list of all shadow topics on a shadow link and
their status.
This operation returns a list of all Shadow Topics on a Shadow Link and
Copy link
Contributor

@Feediver1 Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This operation returns a list of all Shadow Topics on a Shadow Link and
This operation returns a list of all shadow topics on a shadow link and

their status
operationId: redpanda.core.admin.v2.ShadowLinkService.ListShadowTopics
parameters:
- in: header
Expand Down Expand Up @@ -2364,12 +2362,11 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: ListShadowTopics
summary: This operation returns a list of all Shadow Topics on a Shadow Link and their status
Copy link
Contributor

@Feediver1 Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
summary: This operation returns a list of all Shadow Topics on a Shadow Link and their status
summary: This operation returns a list of all shadow topics on a shadow link and their status

tags:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink:
post:
description: Updates an existing shadow link configuration.
operationId: redpanda.core.admin.v2.ShadowLinkService.UpdateShadowLink
parameters:
- in: header
Expand Down