-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
365 lines (360 loc) · 10.8 KB
/
swagger.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
openapi: 3.0.3
info:
title: Oracle API
version: 1.0.0
servers:
- url: "http://localhost:8787"
description: "local development"
- url: "https://oracle.vechain.energy"
description: "public deployment"
paths:
/{feedId}:
get:
summary: get feed status and latest value. accessing with api key will provide details about the data sources.
parameters:
- in: path
name: feedId
schema:
type: string
example: "vet-usd"
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/FeedStatus'
- allOf:
- $ref: '#/components/schemas/FeedStatus'
- $ref: '#/components/schemas/FeedStatusAuthorized'
'404':
description: 'Not Found'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- authorization: []
post:
summary: add or update a feed configuration
parameters:
- in: path
name: feedId
schema:
type: string
example: "vet-usd"
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FeedConfiguration'
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
id:
type: string
example: "vet-usd"
'500':
description: 'Error'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- authorization: []
delete:
summary: delete a feed
parameters:
- in: path
name: feedId
schema:
type: string
example: "vet-usd"
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
security:
- authorization: []
/{feedId}/resolver?sender={sender}&data={data}:
get:
summary: get a signed response of the latest values (CCIP Resolver)
description: "the response is an encoded (uint128 value, uint128 updatedAt, bytes32 feedId) abi encoded within (bytes response, uint64 validUntil, bytes signature). data can be passed on its signature proofs that it was signed by the oracles reporter."
parameters:
- in: path
name: feedId
schema:
type: string
example: "vet-usd"
required: true
- in: query
name: sender
schema:
type: string
example: "0x301aee1259f182636fadae08871269abe55f482c"
required: true
- in: query
name: data
schema:
type: string
example: "0x7665742d757364"
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
data:
type: string
example: "0x0000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000006578bb6900000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000006de5b002a000000000000000000000000000000000000000000000000000000006578ad540000000000000000000000000000000000000000000000000000000000000041152cab1cf1f5ebfecf9ddf1bdb7940aa41b512ee366222179d730197716d7ec822cbd8b54f790af7eb301143391115b06f87687027c4e4c2acd72035a45b0db31c00000000000000000000000000000000000000000000000000000000000000"
'404':
description: 'Not Found'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
'500':
description: 'Internal Errors'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
/{feedId}/resolver:
post:
summary: get a signed response of the latest values
description: "the response is an encoded representation of latestValue(feedId) abi encoded with (bytes response, uint64 validUntil, bytes signature). data can be passed on its signature proofs that it was signed by the oracles reporter."
parameters:
- in: path
name: feedId
schema:
type: string
example: "vet-usd"
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestCCIP'
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
id:
type: string
example: "vet-usd"
'500':
description: 'Error'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseError'
components:
securitySchemes:
authorization:
description: Authorization Token
type: apiKey
name: x-api-key
in: header
schemas:
FeedConfiguration:
type: object
properties:
id:
type: string
example: "vet-usd"
sources:
type: array
items:
type: object
properties:
url:
type: string
example: "https://api.coinbase.com/v2/exchange-rates?currency=VET"
path:
type: string
example: ".data.rates.USD"
heartbeat:
type: integer
example: 3600
deviationPoints:
type: integer
example: 100
interval:
type: integer
example: 60
timeout:
type: integer
example: 60
optional: true
contracts:
type: array
items:
type: object
properties:
nodeUrl:
type: string
example: "https://node-testnet.vechain.energy"
address:
type: string
delegationUrl:
type: string
example: "https://sponsor-testnet.vechain.energy/by/90"
required:
- nodeUrl
- address
RequestCCIP:
type: object
properties:
sender:
type: string
example: "0xb7d72bd84bbf52aa1956c528d7dfbee318c826e8"
callData:
string: string
example: "0x7665742d757364"
urls:
type: array
items:
type: string
example: "http://localhost:8787/vet-usd"
callbackFunction:
type: string
example: "0xd0c12da6"
extraData:
type: string
example: "0x7665742d757364"
required:
- sender
- callData
FeedStatus:
type: object
properties:
id:
type: string
example: "vet-usd"
healthy:
type: boolean
example: true
unhealthyContracts:
type: array
items:
type: object
properties:
nodeUrl:
type: string
example: "https://node-testnet.vechain.energy"
address:
type: string
nextUpdate:
type: integer
example: 60
optional: true
config:
type: object
properties:
heartbeat:
type: integer
example: 3600
deviationPoints:
type: integer
example: 100
interval:
type: integer
example: 60
contracts:
type: array
items:
type: object
properties:
nodeUrl:
type: string
example: "https://node-testnet.vechain.energy"
address:
type: string
latestValue:
type: object
optional: true
properties:
id:
type: string
example: "vet-usd"
value:
type: string
description: uint128 value
example: "29175281535"
formattedValue:
type: string
description: parseUnits(value, 12)
example: "0.029175281535"
updatedAt:
type: string
description: uint128 value
FeedStatusAuthorized:
type: object
properties:
dataSource:
type: object
optional: true
properties:
value:
type: string
example: "29919579637"
errors:
type: number
example: 0
sources:
type: array
items:
type: object
properties:
url:
type: string
example: "https://api.coincap.io/v2/assets/vechain"
path:
type: string
example: ".data.priceUsd"
value:
type: number
example: 0.0299195796373831
available:
type: boolean
example: true
values:
type: array
items:
type: number
example: [0.029919579637]
ResponseError:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: "Error Message"