Skip to content

auto-docs: Update Admin API docs for v26.1.1#54

Open
vbotbuildovich wants to merge 1 commit intomainfrom
auto-docs/admin-api
Open

auto-docs: Update Admin API docs for v26.1.1#54
vbotbuildovich wants to merge 1 commit intomainfrom
auto-docs/admin-api

Conversation

@vbotbuildovich
Copy link
Copy Markdown
Contributor

@vbotbuildovich vbotbuildovich commented Jan 23, 2026

This PR adds the latest OpenAPI spec for version v26.1.1 of the Redpanda Admin API:

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

@vbotbuildovich vbotbuildovich requested a review from a team as a code owner January 23, 2026 19:28
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 23, 2026

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 903e0cf6-464f-469a-8688-6c1355b1543b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The admin/admin-v2.yaml OpenAPI specification file was updated with new metadata values. The x-generated-at timestamp was updated to reflect the generation time as of 2026-01-23T19:28:04.258Z, and the x-redpanda-core-version was incremented from v25.3.5 to v25.3.6. No changes were made to API paths or operation definitions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • api-docs#31: Updates metadata in admin/admin-v2.yaml including x-generated-at timestamp and version fields.
  • api-docs#50: Modifies admin/admin-v2.yaml and updates x-generated-at and x-redpanda-core-version metadata fields.
  • api-docs#29: Introduced the v2 OpenAPI spec and updates its metadata fields like x-generated-at and x-redpanda-core-version.

Suggested reviewers

  • kbatuigas
  • paulohtb6
🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title mentions updating Admin API docs for v26.1.1, but the PR objectives and raw summary indicate the actual changes are for v25.3.6 (bumped from v25.3.5 to v25.3.6). This is a version mismatch. Update the PR title to reflect the correct version: 'auto-docs: Update Admin API docs for v25.3.6' to match the actual changes made.
Description check ⚠️ Warning The description mentions generating OpenAPI spec for v26.1.1, but the PR objectives clearly state the spec is for v25.3.6. The description is misleading regarding the actual version being updated. Update the description to reference the correct version v25.3.6 instead of v26.1.1 to accurately reflect the changes in this PR.
✅ 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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch auto-docs/admin-api

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

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 23, 2026

🚨 Breaking Redpanda/admin (branch: v2) API change detected

Preview documentation

Structural change details

Modified (9)

  • POST /redpanda.core.admin.v2.SecurityService/CreateScramCredential
    • Content type modified: application/json
      • Property modified: scramCredential
        • Property added: passwordSetAt
  • POST /redpanda.core.admin.v2.SecurityService/UpdateScramCredential
    • Content type modified: application/json
      • Property modified: scramCredential
        • Property added: passwordSetAt
  • POST /redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink
    • Content type modified: application/json
      • Property modified: shadowLink
        • Property modified: configurations
          • Properties modified: clientOptions, consumerOffsetSyncOptions, securitySyncOptions, topicMetadataSyncOptions
          • [Breaking] Property modified: shadow_schema_registry_topic
            • Name is no longer schemaRegistrySyncOptions [Breaking]
        • Property added: status
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: shadowLink
          • Properties modified: configurations, status
  • POST /redpanda.core.admin.v2.ShadowLinkService/FailOver
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: shadowLink
          • Properties modified: configurations, status
  • POST /redpanda.core.admin.v2.ShadowLinkService/GetShadowLink
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: shadowLink
          • Properties modified: configurations, status
  • POST /redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: shadowTopic
          • Property modified: status
  • POST /redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: shadowLinks
          • Properties modified: configurations, status
  • POST /redpanda.core.admin.v2.ShadowLinkService/ListShadowTopics
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: shadowTopics
          • Property modified: status
  • POST /redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink
    • Content type modified: application/json
      • Property modified: shadowLink
        • Property modified: configurations
          • Properties modified: clientOptions, consumerOffsetSyncOptions, securitySyncOptions, topicMetadataSyncOptions
          • [Breaking] Property modified: shadow_schema_registry_topic
            • Name is no longer schemaRegistrySyncOptions [Breaking]
        • Property added: status
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: shadowLink
          • Properties modified: configurations, status
Powered by Bump.sh

@vbotbuildovich vbotbuildovich changed the title auto-docs: Update Admin API docs for v25.3.6 auto-docs: Update Admin API docs for v25.3.7 Feb 7, 2026
@vbotbuildovich vbotbuildovich changed the title auto-docs: Update Admin API docs for v25.3.7 auto-docs: Update Admin API docs for v25.3.8 Feb 25, 2026
@vbotbuildovich vbotbuildovich changed the title auto-docs: Update Admin API docs for v25.3.8 auto-docs: Update Admin API docs for v25.3.9 Feb 26, 2026
@vbotbuildovich vbotbuildovich changed the title auto-docs: Update Admin API docs for v25.3.9 auto-docs: Update Admin API docs for v25.3.10 Mar 5, 2026
@vbotbuildovich vbotbuildovich changed the title auto-docs: Update Admin API docs for v25.3.10 auto-docs: Update Admin API docs for v25.3.11 Mar 26, 2026
@vbotbuildovich vbotbuildovich changed the title auto-docs: Update Admin API docs for v25.3.11 auto-docs: Update Admin API docs for v26.1.1 Mar 31, 2026
@kbatuigas
Copy link
Copy Markdown
Contributor

Diffs are due to the implemented allOf workaround for this API. redpanda-data/docs-extensions-and-macros#179 adds a post processing step that will apply the workaround to incoming v2 specs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants