Skip to content

Commit 3171ce2

Browse files
lhotarilhotari
committed
update rest-apidoc for 4.1.3
1 parent c71cf2f commit 3171ce2

15 files changed

+87827
-0
lines changed

‎static/swagger/4.1.3/swagger.json‎

Lines changed: 36421 additions & 0 deletions
Large diffs are not rendered by default.

‎static/swagger/4.1.3/swaggerfunctions.json‎

Lines changed: 2094 additions & 0 deletions
Large diffs are not rendered by default.

‎static/swagger/4.1.3/swaggerlookup.json‎

Lines changed: 319 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,319 @@
1+
{
2+
"basePath": "/lookup",
3+
"definitions": {
4+
"AuthenticationDataSource": {
5+
"properties": {
6+
"commandData": {
7+
"type": "string"
8+
},
9+
"httpAuthType": {
10+
"type": "string"
11+
},
12+
"peerAddress": {
13+
"$ref": "#/definitions/SocketAddress"
14+
},
15+
"subscription": {
16+
"type": "string"
17+
},
18+
"tlsCertificates": {
19+
"items": {
20+
"$ref": "#/definitions/Certificate"
21+
},
22+
"type": "array"
23+
}
24+
},
25+
"type": "object"
26+
},
27+
"AuthenticationParameters": {
28+
"properties": {
29+
"clientAuthenticationDataSource": {
30+
"$ref": "#/definitions/AuthenticationDataSource"
31+
},
32+
"clientRole": {
33+
"type": "string"
34+
},
35+
"originalPrincipal": {
36+
"type": "string"
37+
}
38+
},
39+
"type": "object"
40+
},
41+
"Certificate": {
42+
"properties": {
43+
"encoded": {
44+
"items": {
45+
"format": "byte",
46+
"type": "string"
47+
},
48+
"type": "array"
49+
},
50+
"publicKey": {
51+
"$ref": "#/definitions/PublicKey"
52+
},
53+
"type": {
54+
"type": "string"
55+
}
56+
},
57+
"type": "object"
58+
},
59+
"CompletableFuture": {
60+
"properties": {
61+
"cancelled": {
62+
"type": "boolean"
63+
},
64+
"completedExceptionally": {
65+
"type": "boolean"
66+
},
67+
"done": {
68+
"type": "boolean"
69+
},
70+
"numberOfDependents": {
71+
"format": "int32",
72+
"type": "integer"
73+
}
74+
},
75+
"type": "object"
76+
},
77+
"CompletableFutureByteBuf": {
78+
"properties": {
79+
"cancelled": {
80+
"type": "boolean"
81+
},
82+
"completedExceptionally": {
83+
"type": "boolean"
84+
},
85+
"done": {
86+
"type": "boolean"
87+
},
88+
"numberOfDependents": {
89+
"format": "int32",
90+
"type": "integer"
91+
}
92+
},
93+
"type": "object"
94+
},
95+
"CompletableFutureClusterData": {
96+
"properties": {
97+
"cancelled": {
98+
"type": "boolean"
99+
},
100+
"completedExceptionally": {
101+
"type": "boolean"
102+
},
103+
"done": {
104+
"type": "boolean"
105+
},
106+
"numberOfDependents": {
107+
"format": "int32",
108+
"type": "integer"
109+
}
110+
},
111+
"type": "object"
112+
},
113+
"CompletableFutureVoid": {
114+
"properties": {
115+
"cancelled": {
116+
"type": "boolean"
117+
},
118+
"completedExceptionally": {
119+
"type": "boolean"
120+
},
121+
"done": {
122+
"type": "boolean"
123+
},
124+
"numberOfDependents": {
125+
"format": "int32",
126+
"type": "integer"
127+
}
128+
},
129+
"type": "object"
130+
},
131+
"LookupData": {
132+
"properties": {
133+
"brokerUrl": {
134+
"type": "string"
135+
},
136+
"brokerUrlSsl": {
137+
"type": "string"
138+
},
139+
"brokerUrlTls": {
140+
"type": "string"
141+
},
142+
"httpUrl": {
143+
"type": "string"
144+
},
145+
"httpUrlTls": {
146+
"type": "string"
147+
},
148+
"nativeUrl": {
149+
"type": "string"
150+
}
151+
},
152+
"type": "object"
153+
},
154+
"PublicKey": {
155+
"properties": {
156+
"algorithm": {
157+
"type": "string"
158+
},
159+
"encoded": {
160+
"items": {
161+
"format": "byte",
162+
"type": "string"
163+
},
164+
"type": "array"
165+
},
166+
"format": {
167+
"type": "string"
168+
}
169+
},
170+
"type": "object"
171+
},
172+
"SocketAddress": {
173+
"type": "object"
174+
}
175+
},
176+
"info": {
177+
"description": "This provides the REST API for lookup operations",
178+
"license": {
179+
"name": "Apache 2.0",
180+
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
181+
},
182+
"title": "Pulsar Lookup REST API",
183+
"version": "v2"
184+
},
185+
"paths": {
186+
"/v2/topic/{topic-domain}/{tenant}/{namespace}/{topic}": {
187+
"get": {
188+
"description": "",
189+
"operationId": "TopicLookup_lookupTopicAsync",
190+
"parameters": [
191+
{
192+
"in": "path",
193+
"name": "topic-domain",
194+
"required": true,
195+
"type": "string"
196+
},
197+
{
198+
"in": "path",
199+
"name": "tenant",
200+
"required": true,
201+
"type": "string"
202+
},
203+
{
204+
"in": "path",
205+
"name": "namespace",
206+
"required": true,
207+
"type": "string"
208+
},
209+
{
210+
"in": "path",
211+
"name": "topic",
212+
"required": true,
213+
"type": "string"
214+
},
215+
{
216+
"default": false,
217+
"in": "query",
218+
"name": "authoritative",
219+
"required": false,
220+
"type": "boolean"
221+
},
222+
{
223+
"in": "query",
224+
"name": "listenerName",
225+
"required": false,
226+
"type": "string"
227+
},
228+
{
229+
"in": "header",
230+
"name": "X-Pulsar-ListenerName",
231+
"required": false,
232+
"type": "string"
233+
}
234+
],
235+
"produces": [
236+
"application/json"
237+
],
238+
"responses": {
239+
"200": {
240+
"description": "successful operation",
241+
"schema": {
242+
"$ref": "#/definitions/LookupData"
243+
}
244+
},
245+
"307": {
246+
"description": "Current broker doesn't serve the namespace of this topic"
247+
}
248+
},
249+
"summary": "Get the owner broker of the given topic.",
250+
"tags": [
251+
"lookup"
252+
]
253+
}
254+
},
255+
"/v2/topic/{topic-domain}/{tenant}/{namespace}/{topic}/bundle": {
256+
"get": {
257+
"description": "",
258+
"operationId": "TopicLookup_getNamespaceBundle",
259+
"parameters": [
260+
{
261+
"in": "path",
262+
"name": "topic-domain",
263+
"required": true,
264+
"type": "string"
265+
},
266+
{
267+
"in": "path",
268+
"name": "tenant",
269+
"required": true,
270+
"type": "string"
271+
},
272+
{
273+
"in": "path",
274+
"name": "namespace",
275+
"required": true,
276+
"type": "string"
277+
},
278+
{
279+
"in": "path",
280+
"name": "topic",
281+
"required": true,
282+
"type": "string"
283+
}
284+
],
285+
"produces": [
286+
"application/json"
287+
],
288+
"responses": {
289+
"200": {
290+
"description": "successful operation",
291+
"schema": {
292+
"type": "string"
293+
}
294+
},
295+
"403": {
296+
"description": "Don't have admin permission"
297+
},
298+
"405": {
299+
"description": "Invalid topic domain type"
300+
}
301+
},
302+
"summary": "Get the namespace bundle which the given topic belongs to.",
303+
"tags": [
304+
"lookup"
305+
]
306+
}
307+
}
308+
},
309+
"schemes": [
310+
"http",
311+
"https"
312+
],
313+
"swagger": "2.0",
314+
"tags": [
315+
{
316+
"name": "lookup"
317+
}
318+
]
319+
}

0 commit comments

Comments
 (0)