From b71d092061fd51a22197e4265e9e1f89bd46bad4 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Thu, 9 Oct 2025 09:20:40 -0700 Subject: [PATCH 1/5] Add servers and tags objects with overlays --- .../update-tags.yaml | 0 admin/v2-overlays/add-servers-object.yaml | 12 ++++ admin/v2-overlays/create-and-update-tags.yaml | 61 +++++++++++++++++++ 3 files changed, 73 insertions(+) rename admin/{overlays => v1-overlays}/update-tags.yaml (100%) create mode 100644 admin/v2-overlays/add-servers-object.yaml create mode 100644 admin/v2-overlays/create-and-update-tags.yaml diff --git a/admin/overlays/update-tags.yaml b/admin/v1-overlays/update-tags.yaml similarity index 100% rename from admin/overlays/update-tags.yaml rename to admin/v1-overlays/update-tags.yaml diff --git a/admin/v2-overlays/add-servers-object.yaml b/admin/v2-overlays/add-servers-object.yaml new file mode 100644 index 0000000..ced4802 --- /dev/null +++ b/admin/v2-overlays/add-servers-object.yaml @@ -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: v1 + +actions: + - target: "$" + update: + servers: + - url: http://localhost:9644 \ No newline at end of file diff --git a/admin/v2-overlays/create-and-update-tags.yaml b/admin/v2-overlays/create-and-update-tags.yaml new file mode 100644 index 0000000..26cb93e --- /dev/null +++ b/admin/v2-overlays/create-and-update-tags.yaml @@ -0,0 +1,61 @@ +# 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 + - 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. + + # Rename BrokerService endpoint tags + - target: "$.paths.*.*.tags[?(@ == 'BrokerService')]" + update: "Brokers" + + # Rename ShadowLinkService endpoint tags + - target: "$.paths.*.*.tags[?(@ == 'ShadowLinkService')]" + update: "Shadow Links" + + + # # Rename BrokerService endpoint tags + # - target: "$.paths['/redpanda.core.admin.v2.BrokerService/GetBroker'].post.tags" + # update: + # - "Brokers" + + # - target: "$.paths['/redpanda.core.admin.v2.BrokerService/ListBrokers'].post.tags" + # update: + # - "Brokers" + + # - target: "$.paths['/redpanda.core.admin.v2.BrokerService/ListKafkaConnections'].post.tags" + # update: + # - "Brokers" + + # # Rename ShadowLinkService endpoint tags + # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink'].post.tags" + # update: + # - "Shadow Links" + + # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink'].post.tags" + # update: + # - "Shadow Links" + + # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink'].post.tags" + # update: + # - "Shadow Links" + + # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks'].post.tags" + # update: + # - "Shadow Links" + + # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/GetShadowLink'].post.tags" + # update: + # - "Shadow Links" + + From 5b351b039ef1c5378e94295841311fdf50d52099 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Thu, 9 Oct 2025 09:24:37 -0700 Subject: [PATCH 2/5] Remove commented out lines --- admin/v2-overlays/create-and-update-tags.yaml | 35 ------------------- 1 file changed, 35 deletions(-) diff --git a/admin/v2-overlays/create-and-update-tags.yaml b/admin/v2-overlays/create-and-update-tags.yaml index 26cb93e..36987a8 100644 --- a/admin/v2-overlays/create-and-update-tags.yaml +++ b/admin/v2-overlays/create-and-update-tags.yaml @@ -24,38 +24,3 @@ actions: update: "Shadow Links" - # # Rename BrokerService endpoint tags - # - target: "$.paths['/redpanda.core.admin.v2.BrokerService/GetBroker'].post.tags" - # update: - # - "Brokers" - - # - target: "$.paths['/redpanda.core.admin.v2.BrokerService/ListBrokers'].post.tags" - # update: - # - "Brokers" - - # - target: "$.paths['/redpanda.core.admin.v2.BrokerService/ListKafkaConnections'].post.tags" - # update: - # - "Brokers" - - # # Rename ShadowLinkService endpoint tags - # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink'].post.tags" - # update: - # - "Shadow Links" - - # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink'].post.tags" - # update: - # - "Shadow Links" - - # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink'].post.tags" - # update: - # - "Shadow Links" - - # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks'].post.tags" - # update: - # - "Shadow Links" - - # - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/GetShadowLink'].post.tags" - # update: - # - "Shadow Links" - - From 143430559d9123e6b9a4547a0f8472cdae6ae894 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Thu, 9 Oct 2025 09:31:26 -0700 Subject: [PATCH 3/5] Remove extra lines per automated review --- admin/v2-overlays/create-and-update-tags.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/admin/v2-overlays/create-and-update-tags.yaml b/admin/v2-overlays/create-and-update-tags.yaml index 36987a8..49c1c6f 100644 --- a/admin/v2-overlays/create-and-update-tags.yaml +++ b/admin/v2-overlays/create-and-update-tags.yaml @@ -22,5 +22,3 @@ actions: # Rename ShadowLinkService endpoint tags - target: "$.paths.*.*.tags[?(@ == 'ShadowLinkService')]" update: "Shadow Links" - - From 7d120e54e2bcbae04fb2310c65c436d0dfbe058c Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Thu, 9 Oct 2025 15:45:15 -0700 Subject: [PATCH 4/5] Change info.version to semver We can keep minor, non-breaking changes to overlay functionality without making it seem like a major version change --- admin/v1-overlays/update-tags.yaml | 2 +- admin/v2-overlays/add-servers-object.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/admin/v1-overlays/update-tags.yaml b/admin/v1-overlays/update-tags.yaml index 5602b7c..5e7bebb 100644 --- a/admin/v1-overlays/update-tags.yaml +++ b/admin/v1-overlays/update-tags.yaml @@ -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")] diff --git a/admin/v2-overlays/add-servers-object.yaml b/admin/v2-overlays/add-servers-object.yaml index ced4802..7f6629a 100644 --- a/admin/v2-overlays/add-servers-object.yaml +++ b/admin/v2-overlays/add-servers-object.yaml @@ -3,7 +3,7 @@ overlay: 1.0.0 info: title: Admin API v2 Servers - version: v1 + version: 1.0.0 actions: - target: "$" From a7b38fa9e41add7f3d81ea463556c5498d780f81 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Tue, 14 Oct 2025 09:26:37 -0700 Subject: [PATCH 5/5] Apply suggestion from review --- admin/v2-overlays/create-and-update-tags.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin/v2-overlays/create-and-update-tags.yaml b/admin/v2-overlays/create-and-update-tags.yaml index 49c1c6f..6aec5e9 100644 --- a/admin/v2-overlays/create-and-update-tags.yaml +++ b/admin/v2-overlays/create-and-update-tags.yaml @@ -13,7 +13,7 @@ actions: - 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. + description: Manage shadow links for disaster recovery and migration. # Rename BrokerService endpoint tags - target: "$.paths.*.*.tags[?(@ == 'BrokerService')]"