Skip to content

Commit 7309c88

Browse files
kbatuigasKat Batuigas
andauthored
Add servers and tags objects with overlays (#26)
* Add servers and tags objects with overlays * Remove commented out lines * Remove extra lines per automated review * Change info.version to semver We can keep minor, non-breaking changes to overlay functionality without making it seem like a major version change * Apply suggestion from review --------- Co-authored-by: Kat Batuigas <[email protected]>
1 parent 735df6b commit 7309c88

File tree

3 files changed

+37
-1
lines changed

3 files changed

+37
-1
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
overlay: 1.0.0
33
info:
44
title: Redpanda Admin API Tags
5-
version: v1
5+
version: 1.0.0
66

77
actions:
88
- target: $.tags[?(@.name=="Mount and unmount topics")]
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# This overlay adds the servers object to the Redpanda Admin API v2 specification.
2+
3+
overlay: 1.0.0
4+
info:
5+
title: Admin API v2 Servers
6+
version: 1.0.0
7+
8+
actions:
9+
- target: "$"
10+
update:
11+
servers:
12+
- url: http://localhost:9644
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# This overlay extends the Redpanda Admin API specification by creating an
2+
# end-user facing list of tags and applying them to the relevant endpoints.
3+
overlay: 1.0.0
4+
info:
5+
title: Redpanda Admin API v2 Tags
6+
version: 1.0.0
7+
8+
actions:
9+
# Add tags object to the root level
10+
- target: "$"
11+
update:
12+
tags:
13+
- name: Brokers
14+
description: See details about brokers in a Redpanda cluster, including client connections.
15+
- name: Shadow Links
16+
description: Manage shadow links for disaster recovery and migration.
17+
18+
# Rename BrokerService endpoint tags
19+
- target: "$.paths.*.*.tags[?(@ == 'BrokerService')]"
20+
update: "Brokers"
21+
22+
# Rename ShadowLinkService endpoint tags
23+
- target: "$.paths.*.*.tags[?(@ == 'ShadowLinkService')]"
24+
update: "Shadow Links"

0 commit comments

Comments
 (0)