Skip to content

Commit 00bf490

Browse files
author
Kat Batuigas
committed
Add servers and tags objects with overlays
1 parent 58634be commit 00bf490

File tree

3 files changed

+73
-0
lines changed

3 files changed

+73
-0
lines changed
File renamed without changes.
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: v1
7+
8+
actions:
9+
- target: "$"
10+
update:
11+
servers:
12+
- url: http://localhost:9644
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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 migration and disaster recovery.
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"
25+
26+
27+
# # Rename BrokerService endpoint tags
28+
# - target: "$.paths['/redpanda.core.admin.v2.BrokerService/GetBroker'].post.tags"
29+
# update:
30+
# - "Brokers"
31+
32+
# - target: "$.paths['/redpanda.core.admin.v2.BrokerService/ListBrokers'].post.tags"
33+
# update:
34+
# - "Brokers"
35+
36+
# - target: "$.paths['/redpanda.core.admin.v2.BrokerService/ListKafkaConnections'].post.tags"
37+
# update:
38+
# - "Brokers"
39+
40+
# # Rename ShadowLinkService endpoint tags
41+
# - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink'].post.tags"
42+
# update:
43+
# - "Shadow Links"
44+
45+
# - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink'].post.tags"
46+
# update:
47+
# - "Shadow Links"
48+
49+
# - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink'].post.tags"
50+
# update:
51+
# - "Shadow Links"
52+
53+
# - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks'].post.tags"
54+
# update:
55+
# - "Shadow Links"
56+
57+
# - target: "$.paths['/redpanda.core.admin.v2.ShadowLinkService/GetShadowLink'].post.tags"
58+
# update:
59+
# - "Shadow Links"
60+
61+

0 commit comments

Comments
 (0)