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

vbotbuildovich · 2025-12-20T17:39:09Z

This PR adds the latest OpenAPI spec for version v25.3.5 of the Redpanda Admin API:

npx doc-tools generate bundle-openapi --tag v25.3.5 --use-admin-major-version --surface admin --out-admin admin/admin-v2.yaml

coderabbitai · 2025-12-20T17:39:17Z

📝 Walkthrough

Walkthrough

The pull request updates the OpenAPI specification file admin/admin-v2.yaml with metadata and documentation improvements. The changes include bumping the x-redpanda-core-version from v25.3.2 to v25.3.3, updating the x-generated-at timestamp, and revising path operation descriptions and summaries across several endpoints (GetBroker, ListBrokers, ListKafkaConnections, ShadowLink operations). No changes are made to request/response schemas, endpoints, or the API surface.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Single file with metadata and documentation-only updates
No functional, structural, or schema changes to verify
Descriptions are straightforward and can be quickly scanned for accuracy and clarity

Possibly related PRs

redpanda-data/api-docs#29: Introduces the initial full v2 OpenAPI spec file, which this PR now updates with refined metadata and operation descriptions.

Suggested reviewers

kbatuigas
paulohtb6

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title mentions v25.3.5 but the actual changes update the spec from v25.3.2 to v25.3.3, creating a discrepancy with the actual changeset.	Update the PR title to reflect the actual version being updated: 'auto-docs: Update Admin API docs for v25.3.3' to match the changes in the changeset.
Description check	⚠️ Warning	The description claims the PR adds OpenAPI spec for v25.3.5, but the summary and objectives indicate the actual update is to v25.3.3, creating inconsistency with the actual changes.	Correct the version number in the description from v25.3.5 to v25.3.3 to accurately reflect the changes being made in this pull request.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2025-12-20T17:39:39Z

ℹ️ Redpanda/admin (branch: v2) API content change detected

Preview documentation

No structural change, nothing to display.

Powered by Bump.sh

Feediver1 · 2026-01-13T22:09:43Z

admin/admin-v2.yaml

                $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.


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.

Feediver1 · 2026-01-13T22:10:00Z

admin/admin-v2.yaml

  /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


Suggested change

description: Fails over a shadow link or a single shadow topic

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

Feediver1 · 2026-01-13T22:12:28Z

admin/admin-v2.yaml

-        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.


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

Feediver1 · 2026-01-13T22:12:48Z

admin/admin-v2.yaml

                $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.


Same comment re capitalization

Feediver1 · 2026-01-13T22:13:06Z

admin/admin-v2.yaml

      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


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

Feediver1 · 2026-01-13T22:13:26Z

admin/admin-v2.yaml

                $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


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

kbatuigas · 2026-01-14T05:06:45Z

Using a specific tagged release (--tag v25.3.4) with the generate command results in the generated spec not including the changes introduced in redpanda-data/redpanda#29040.

vbotbuildovich requested a review from a team as a code owner December 20, 2025 17:39

vbotbuildovich added the auto-docs label Dec 20, 2025

vbotbuildovich force-pushed the auto-docs/admin-api branch from 284375a to 63bb5b1 Compare December 26, 2025 05:33

vbotbuildovich changed the title ~~auto-docs: Update Admin API docs for v25.3.3~~ auto-docs: Update Admin API docs for v25.3.4 Dec 26, 2025

Feediver1 reviewed Jan 13, 2026

View reviewed changes

docs: Update Admin API docs for v25.3.5

0c4c1fb

vbotbuildovich changed the title ~~auto-docs: Update Admin API docs for v25.3.4~~ auto-docs: Update Admin API docs for v25.3.5 Jan 16, 2026

vbotbuildovich force-pushed the auto-docs/admin-api branch from 63bb5b1 to 0c4c1fb Compare January 16, 2026 14:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

vbotbuildovich commented Dec 20, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 20, 2025 •

edited

Loading

Walkthrough

Estimated code review effort

Possibly related PRs

Suggested reviewers

Uh oh!

github-actions bot commented Dec 20, 2025 •

edited

Loading

Uh oh!

Feediver1 Jan 13, 2026

Uh oh!

Feediver1 Jan 13, 2026

Uh oh!

Feediver1 Jan 13, 2026

Uh oh!

Feediver1 Jan 13, 2026

Uh oh!

Feediver1 Jan 13, 2026

Uh oh!

Feediver1 Jan 13, 2026

Uh oh!

kbatuigas commented Jan 14, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	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.

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

	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

	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

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

Are you sure you want to change the base?

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

Conversation

vbotbuildovich commented Dec 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Dec 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

Possibly related PRs

Suggested reviewers

Uh oh!

github-actions bot commented Dec 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ℹ️ Redpanda/admin (branch: v2) API content change detected

Powered by Bump.sh

Uh oh!

Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Feediver1 Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

kbatuigas commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vbotbuildovich commented Dec 20, 2025 •

edited

Loading

coderabbitai bot commented Dec 20, 2025 •

edited

Loading

github-actions bot commented Dec 20, 2025 •

edited

Loading

kbatuigas commented Jan 14, 2026 •

edited

Loading