Skip to content

Add servers and tags objects with overlays #26

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

Merged
kbatuigas merged 5 commits into from
Oct 14, 2025
Merged

Add servers and tags objects with overlays #26

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b71d092
Add servers and tags objects with overlays
Oct 9, 2025
5b351b0
Remove commented out lines
Oct 9, 2025
1434305
Remove extra lines per automated review
Oct 9, 2025
7d120e5
Change info.version to semver
Oct 9, 2025
a7b38fa
Apply suggestion from review
kbatuigas Oct 14, 2025
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
2 changes: 1 addition & 1 deletion admin/overlays/update-tags.yaml → admin/v1-overlays/update-tags.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
overlay: 1.0.0
info:
title: Redpanda Admin API Tags
version: v1
version: 1.0.0

actions:
- target: $.tags[?(@.name=="Mount and unmount topics")]
Expand Down
12 changes: 12 additions & 0 deletions admin/v2-overlays/add-servers-object.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# This overlay adds the servers object to the Redpanda Admin API v2 specification.

overlay: 1.0.0
info:
title: Admin API v2 Servers
version: 1.0.0

actions:
- target: "$"
update:
servers:
- url: http://localhost:9644
24 changes: 24 additions & 0 deletions admin/v2-overlays/create-and-update-tags.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# This overlay extends the Redpanda Admin API specification by creating an
# end-user facing list of tags and applying them to the relevant endpoints.
overlay: 1.0.0
info:
title: Redpanda Admin API v2 Tags
version: 1.0.0

actions:
# Add tags object to the root level
Copy link

@Feediver1 Feediver1 Oct 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
# Add tags object to the root level
# Add the tags object at the root level

- target: "$"
update:
tags:
- 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.
Copy link

@Feediver1 Feediver1 Oct 13, 2025

Choose a reason for hiding this comment

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

Suggested change
description: Manage shadow links for migration and disaster recovery.
description: Manage shadow links for disaster recovery and migration.

Copy link

@Feediver1 Feediver1 Oct 13, 2025

Choose a reason for hiding this comment

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

primary reason for the feature is disaster recovery, so thinking that should come first.


# Rename BrokerService endpoint tags
- target: "$.paths.*.*.tags[?(@ == 'BrokerService')]"
update: "Brokers"

# Rename ShadowLinkService endpoint tags
- target: "$.paths.*.*.tags[?(@ == 'ShadowLinkService')]"
update: "Shadow Links"