Skip to content

Commit 3faff10

Browse files
blockscout-botblockscout-bot
committed
[BOT] [CREATE-SWAGGER] [SKIP-GH-PAGES] create swagger for "metadata" of version 2.6.16
1 parent ba261bb commit 3faff10

File tree

1 file changed

+349
-0
lines changed

1 file changed

+349
-0
lines changed

‎services/metadata/2.6.16/swagger.yaml‎

Lines changed: 349 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,349 @@
1+
swagger: "2.0"
2+
info:
3+
title: v1/metadata.proto
4+
version: version not set
5+
tags:
6+
- name: Metadata
7+
- name: Health
8+
consumes:
9+
- application/json
10+
produces:
11+
- application/json
12+
paths:
13+
/api/v1/addresses:
14+
get:
15+
operationId: Metadata_GetPublicTagAddresses
16+
responses:
17+
"200":
18+
description: A successful response.
19+
schema:
20+
$ref: '#/definitions/v1GetPublicTagAddressesResponse'
21+
default:
22+
description: An unexpected error response.
23+
schema:
24+
$ref: '#/definitions/rpcStatus'
25+
parameters:
26+
- name: slug
27+
in: query
28+
required: false
29+
type: string
30+
- name: tagType
31+
in: query
32+
required: false
33+
type: string
34+
- name: chainId
35+
description: If not provided, only multichain tags will be returned
36+
in: query
37+
required: false
38+
type: string
39+
format: int64
40+
- name: pageSize
41+
in: query
42+
required: false
43+
type: integer
44+
format: int64
45+
- name: pageToken
46+
in: query
47+
required: false
48+
type: string
49+
tags:
50+
- Metadata
51+
/api/v1/addresses:submit:
52+
post:
53+
operationId: Metadata_SubmitAddressesToExtractors
54+
responses:
55+
"200":
56+
description: A successful response.
57+
schema:
58+
$ref: '#/definitions/v1SubmitAddressesToExtractorsResponse'
59+
default:
60+
description: An unexpected error response.
61+
schema:
62+
$ref: '#/definitions/rpcStatus'
63+
parameters:
64+
- name: body
65+
in: body
66+
required: true
67+
schema:
68+
$ref: '#/definitions/v1SubmitAddressesToExtractorsRequest'
69+
tags:
70+
- Metadata
71+
/api/v1/metadata:
72+
get:
73+
operationId: Metadata_BatchGetMetadata
74+
responses:
75+
"200":
76+
description: A successful response.
77+
schema:
78+
$ref: '#/definitions/v1BatchGetMetadataResponse'
79+
default:
80+
description: An unexpected error response.
81+
schema:
82+
$ref: '#/definitions/rpcStatus'
83+
parameters:
84+
- name: addresses
85+
description: Comma separated list of addresses
86+
in: query
87+
required: false
88+
type: string
89+
- name: chainId
90+
description: If not provided, only multichain tags will be returned
91+
in: query
92+
required: false
93+
type: string
94+
format: int64
95+
- name: tagsLimit
96+
description: If provided, the first `tags_limit` tags will be returned for each address
97+
in: query
98+
required: false
99+
type: integer
100+
format: int64
101+
- name: tagTypes
102+
description: Comma separated list of tag types
103+
in: query
104+
required: false
105+
type: string
106+
tags:
107+
- Metadata
108+
/api/v1/public-tag-types:
109+
get:
110+
operationId: Metadata_GetPublicTagTypes
111+
responses:
112+
"200":
113+
description: A successful response.
114+
schema:
115+
$ref: '#/definitions/v1GetPublicTagTypesResponse'
116+
default:
117+
description: An unexpected error response.
118+
schema:
119+
$ref: '#/definitions/rpcStatus'
120+
tags:
121+
- Metadata
122+
/api/v1/reputation:
123+
get:
124+
operationId: Metadata_BatchGetReputation
125+
responses:
126+
"200":
127+
description: A successful response.
128+
schema:
129+
$ref: '#/definitions/v1BatchGetReputationResponse'
130+
default:
131+
description: An unexpected error response.
132+
schema:
133+
$ref: '#/definitions/rpcStatus'
134+
parameters:
135+
- name: addresses
136+
description: Comma separated list of addresses
137+
in: query
138+
required: false
139+
type: string
140+
tags:
141+
- Metadata
142+
/api/v1/tags:search:
143+
get:
144+
operationId: Metadata_SearchPublicTags
145+
responses:
146+
"200":
147+
description: A successful response.
148+
schema:
149+
$ref: '#/definitions/v1SearchPublicTagsResponse'
150+
default:
151+
description: An unexpected error response.
152+
schema:
153+
$ref: '#/definitions/rpcStatus'
154+
parameters:
155+
- name: chainId
156+
in: query
157+
required: false
158+
type: string
159+
format: int64
160+
- name: tagTypes
161+
description: Comma separated list of tag types
162+
in: query
163+
required: false
164+
type: string
165+
- name: name
166+
in: query
167+
required: false
168+
type: string
169+
- name: pageSize
170+
in: query
171+
required: false
172+
type: integer
173+
format: int64
174+
- name: pageToken
175+
in: query
176+
required: false
177+
type: string
178+
- name: addressLimit
179+
in: query
180+
required: false
181+
type: integer
182+
format: int64
183+
tags:
184+
- Metadata
185+
/health:
186+
get:
187+
summary: |-
188+
If the requested service is unknown, the call will fail with status
189+
NOT_FOUND.
190+
operationId: Health_Check
191+
responses:
192+
"200":
193+
description: A successful response.
194+
schema:
195+
$ref: '#/definitions/v1HealthCheckResponse'
196+
default:
197+
description: An unexpected error response.
198+
schema:
199+
$ref: '#/definitions/rpcStatus'
200+
parameters:
201+
- name: service
202+
in: query
203+
required: false
204+
type: string
205+
tags:
206+
- Health
207+
definitions:
208+
HealthCheckResponseServingStatus:
209+
type: string
210+
enum:
211+
- UNKNOWN
212+
- SERVING
213+
- NOT_SERVING
214+
- SERVICE_UNKNOWN
215+
default: UNKNOWN
216+
description: ' - SERVICE_UNKNOWN: Used only by the Watch method.'
217+
protobufAny:
218+
type: object
219+
properties:
220+
'@type':
221+
type: string
222+
additionalProperties: {}
223+
rpcStatus:
224+
type: object
225+
properties:
226+
code:
227+
type: integer
228+
format: int32
229+
message:
230+
type: string
231+
details:
232+
type: array
233+
items:
234+
type: object
235+
$ref: '#/definitions/protobufAny'
236+
v1AddressMetadataResponse:
237+
type: object
238+
properties:
239+
tags:
240+
type: array
241+
items:
242+
type: object
243+
$ref: '#/definitions/v1Tag'
244+
v1BatchGetMetadataResponse:
245+
type: object
246+
properties:
247+
addresses:
248+
type: object
249+
additionalProperties:
250+
$ref: '#/definitions/v1AddressMetadataResponse'
251+
v1BatchGetReputationResponse:
252+
type: object
253+
properties:
254+
addresses:
255+
type: object
256+
additionalProperties:
257+
$ref: '#/definitions/v1Reputation'
258+
v1GetPublicTagAddressesResponse:
259+
type: object
260+
properties:
261+
addresses:
262+
type: array
263+
items:
264+
type: string
265+
title: 'TODO: remove this field'
266+
items:
267+
type: array
268+
items:
269+
type: string
270+
nextPageParams:
271+
$ref: '#/definitions/v1Pagination'
272+
v1GetPublicTagTypesResponse:
273+
type: object
274+
properties:
275+
tagTypes:
276+
type: array
277+
items:
278+
type: object
279+
$ref: '#/definitions/v1PublicTagType'
280+
v1HealthCheckResponse:
281+
type: object
282+
properties:
283+
status:
284+
$ref: '#/definitions/HealthCheckResponseServingStatus'
285+
v1Pagination:
286+
type: object
287+
properties:
288+
pageToken:
289+
type: string
290+
pageSize:
291+
type: integer
292+
format: int64
293+
v1PublicTagType:
294+
type: object
295+
properties:
296+
id:
297+
type: string
298+
type:
299+
type: string
300+
description:
301+
type: string
302+
v1Reputation:
303+
type: object
304+
properties:
305+
score:
306+
type: integer
307+
format: int32
308+
v1SearchPublicTagsResponse:
309+
type: object
310+
properties:
311+
items:
312+
type: array
313+
items:
314+
type: object
315+
$ref: '#/definitions/v1TagAddresses'
316+
nextPageParams:
317+
$ref: '#/definitions/v1Pagination'
318+
v1SubmitAddressesToExtractorsRequest:
319+
type: object
320+
properties:
321+
addresses:
322+
type: array
323+
items:
324+
type: string
325+
v1SubmitAddressesToExtractorsResponse:
326+
type: object
327+
v1Tag:
328+
type: object
329+
properties:
330+
slug:
331+
type: string
332+
name:
333+
type: string
334+
tagType:
335+
type: string
336+
ordinal:
337+
type: integer
338+
format: int32
339+
meta:
340+
type: string
341+
v1TagAddresses:
342+
type: object
343+
properties:
344+
tag:
345+
$ref: '#/definitions/v1Tag'
346+
addresses:
347+
type: array
348+
items:
349+
type: string

0 commit comments

Comments
 (0)