Add Admin v2 spec file

[kbatuigas]

• Add v2 spec (as of redpanda-data/redpanda@cf2b5d5)
• Adds an overlay to update info.description for Admin v2
• Edit overlay to use short service names for tags. Bump overlay version to 2.0.0.
• Adds link to Admin API guide in Admin v1 (will be live when Admin API guide docs#1390 is merged)

[coderabbitai]

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.

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

📝 Walkthrough

Walkthrough

This pull request introduces a new comprehensive OpenAPI v3.1 specification for the Redpanda Admin API v2.0.0, including definitions for three services (BrokerService, ShadowLinkService) and an extensive set of public schemas covering brokers, shadow links, shadow topics, TLS configuration, authentication, and supporting types. A documentation link is added to the existing admin.yaml file. A new overlay file is introduced to augment the Admin API v2 specification with descriptive text and external documentation references.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

The primary file (admin-v2.yaml) is substantial and contains many interconnected schema definitions for the new Admin API v2 service. While the changes follow repetitive OpenAPI specification patterns—making portions homogeneous—the breadth of schemas, endpoint definitions, and nested structures requires careful validation for correctness, consistency, and completeness. The secondary changes to admin.yaml and the new overlay file are straightforward. Reviewers should verify schema coherence, endpoint accuracy, type definitions, and alignment with the stated Shadow Link API objectives.

Suggested reviewers

• micheleRP

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Linked Issues Check	❓ Inconclusive	The linked issue DOC-1670 is referenced but does not provide specific coding requirements or acceptance criteria in the provided information. While the PR objectives mention creating reference information for the Shadow Link API and the changeset includes extensive ShadowLink-related schemas and endpoints within the Admin API v2 specification, without the actual requirements from the linked issue, it is not possible to definitively validate whether all coding-related objectives have been met or if the implementation aligns with the intended scope.	To complete this check, please provide the detailed requirements and acceptance criteria from issue DOC-1670 so that the implementation can be validated against the stated objectives. This will clarify whether the comprehensive Admin API v2 specification with BrokerService, ShadowLinkService, and related schemas fully addresses the issue requirements.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "Add Admin v2 spec file" directly and clearly summarizes the main change in the changeset. The primary alteration is the introduction of the Admin API v2 specification file (admin/admin-v2.yaml), which is the most significant change. The title is concise, specific, and a teammate scanning the history would immediately understand that this PR introduces the new v2 Admin API specification.
Out of Scope Changes Check	✅ Passed	All changes in the pull request appear to be aligned with the stated PR objectives. The three main components—adding the Admin v2 specification file (admin/admin-v2.yaml), adding an overlay file to update the info description (admin/v2-overlays/add-external-docs.yaml), and updating the Admin v1 spec with a documentation link (admin/admin.yaml)—are all explicitly mentioned in the PR description and directly support the stated goals. There are no apparent extraneous changes or unrelated modifications introduced in this changeset.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	The pull request description directly describes the changes in the changeset. It specifically mentions adding a v2 spec file (corresponding to admin/admin-v2.yaml), adding an overlay to update info.description for Admin v2 (corresponding to admin/v2-overlays/add-external-docs.yaml), and adding a link to the Admin API guide in Admin v1 (corresponding to changes in admin/admin.yaml). Each point in the description maps to an actual change in the pull request, and the description is sufficiently specific to convey meaningful information about what is being changed.

---

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

[github-actions]

ℹ️ API content change detected:

No structural change, nothing to display.

Preview documentation

Powered by Bump.sh