Add servers and tags objects with overlays #26
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughIntroduces two Admin API v2 overlay YAML files. One overlay (add-servers-object.yaml) adds a servers array at the spec root with a single http://localhost:9644 server. The other overlay (create-and-update-tags.yaml) adds a root-level tags list defining “Brokers” and “Shadow Links,” and updates existing endpoint tag references from “BrokerService” to “Brokers” and from “ShadowLinkService” to “Shadow Links.” No exported/public code entities are modified. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
admin/v2-overlays/create-and-update-tags.yaml (1)
25-26: Trim trailing blank lines for YAMLlint.YAMLlint flags the extra blank lines at the end of the file. Please remove them to satisfy the linter.
- -
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
admin/v2-overlays/add-servers-object.yaml(1 hunks)admin/v2-overlays/create-and-update-tags.yaml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
admin/v2-overlays/create-and-update-tags.yaml
[warning] 26-26: too many blank lines (2 > 0)
(empty-lines)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
admin/v2-overlays/add-servers-object.yaml (1)
4-6: Normalize overlay version formatting
info.versionis set tov1, while the accompanying overlays use semantic versions (for example,1.0.0). Consider adopting the same semver style here to keep the overlay metadata consistent across the admin docs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
admin/v2-overlays/add-servers-object.yaml(1 hunks)admin/v2-overlays/create-and-update-tags.yaml(1 hunks)
We can keep minor, non-breaking changes to overlay functionality without making it seem like a major version change
kbatuigas
force-pushed
the
DOC-1746-admin-tags-and-test-doc-tools
branch
from
ac54bef to
7d120e5
Compare
| version: 1.0.0 | ||
|
|
||
| actions: | ||
| # Add tags object to the root level |
There was a problem hiding this comment.
| # Add tags object to the root level | |
| # Add the tags object at the root level |
| - name: Brokers | ||
| description: See details about brokers in a Redpanda cluster, including client connections. | ||
| - name: Shadow Links | ||
| description: Manage shadow links for migration and disaster recovery. |
There was a problem hiding this comment.
| description: Manage shadow links for migration and disaster recovery. | |
| description: Manage shadow links for disaster recovery and migration. |
There was a problem hiding this comment.
primary reason for the feature is disaster recovery, so thinking that should come first.
The generated Admin v2 spec does not include a servers object. The protoc plugin also uses the short service names (e.g. "BrokerService") for tags, and we need to keep it end-user-friendly and consistent with our other API docs.
This PR adds two new overlays
The PR also reorganizes the overlays for Admin API in versioned directories for v1 and v2, so we can easily reference the matching overlays in our GH automation.
DEPLOY PREVIEW