-
Notifications
You must be signed in to change notification settings - Fork 115
/
openapi.yaml
341 lines (341 loc) · 8.23 KB
/
openapi.yaml
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
openapi: 3.0.3
info:
title: Storage node API
description: Storage node API
contact:
email: info@joystream.org
license:
name: GPL-3.0-only
url: 'https://opensource.org/licenses/GPL-3.0'
version: 0.1.0
externalDocs:
description: Storage node API
url: 'https://github.com/Joystream/joystream/issues/2224'
servers:
- url: 'http://localhost:3333/api/v1/'
tags:
- name: files
description: Storage node Files API
- name: state
description: Storage node State API
paths:
'/files/{id}':
get:
operationId: filesApi.getFile
description: Returns a media file.
tags:
- files
parameters:
- name: id
required: true
in: path
description: Data object ID
schema:
type: string
pattern: ^\d+$ #integer
responses:
'200':
description: Ok
content:
video/*:
schema:
type: string
format: binary
audio/*:
schema:
type: string
format: binary
image/*:
schema:
type: string
format: binary
application/octet-stream:
schema:
type: string
format: binary
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: File not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Unknown server error
head:
operationId: filesApi.getFileHeaders
description: Returns a media file headers.
tags:
- files
parameters:
- name: id
required: true
in: path
description: Data object ID
schema:
type: string
pattern: ^\d+$ #integer
responses:
'200':
description: Ok
'400':
description: Bad request
'404':
description: File not found
'500':
description: Unknown server error
/files:
post:
description: Upload data
operationId: filesApi.uploadFile
tags:
- files
parameters:
- name: dataObjectId
required: true
in: query
description: Data object runtime ID
schema:
type: string
pattern: ^\d+$ #integer
- name: storageBucketId
required: true
in: query
description: Storage bucket ID
schema:
type: string
pattern: ^\d+$ #integer
- name: bagId
required: true
in: query
description: Bag ID
schema:
type: string
allowReserved: true
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
description: Data file
type: string
format: binary
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
id:
type: string
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/state/data-objects:
get:
operationId: stateApi.getAllLocalDataObjects
description: Returns all local data objects.
tags:
- state
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DataObjectResponse'
'/state/bags/{bagId}/data-objects':
get:
operationId: stateApi.getLocalDataObjectsByBagId
description: Returns local data objects for the bag.
tags:
- state
parameters:
- name: bagId
required: true
in: path
description: Bag ID
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DataObjectResponse'
/version:
get:
operationId: stateApi.getVersion
description: Returns server version.
tags:
- state
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/VersionResponse'
/state/data:
get:
operationId: stateApi.getLocalDataStats
description: Returns local uploading directory stats.
tags:
- state
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DataStatsResponse'
/status:
get:
operationId: stateApi.getStatus
description: Returns json object describing current node status.
tags:
- state
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StatusResponse'
500:
description: Unexpected server error
components:
schemas:
ErrorResponse:
type: object
required:
- message
properties:
type:
type: string
message:
type: string
DataStatsResponse:
type: object
required:
- totalSize
- objectNumber
properties:
totalSize:
type: integer
format: int64
objectNumber:
type: integer
format: int64
tempDirSize:
type: integer
format: int64
tempDownloads:
type: integer
format: int64
pendingDirSize:
type: integer
format: int64
pendingObjects:
type: integer
format: int64
VersionResponse:
type: object
required:
- version
properties:
version:
type: string
userAgent:
type: string
StatusResponse:
type: object
required:
- version
- uptime
- queryNodeStatus
- uploadBuckets
- downloadBuckets
- sync
- cleanup
properties:
version:
type: string
uptime:
type: number
nodeEnv:
type: string
queryNodeStatus:
type: object
required:
- 'url'
- 'chainHead'
- 'blocksProcessed'
- 'packageVersion'
properties:
url:
type: string
chainHead:
type: integer
minimum: 0
blocksProcessed:
type: integer
minimum: 0
packageVersion:
type: string
uploadBuckets:
type: array
items:
type: string
downloadBuckets:
type: array
items:
type: string
sync:
type: object
required:
- 'enabled'
- 'interval'
properties:
enabled:
type: boolean
interval:
type: integer
cleanup:
type: object
required:
- 'enabled'
- 'interval'
properties:
enabled:
type: boolean
interval:
type: integer
maxQnLaggingThresholdInBlocks:
type: integer
minReplicationThresholdForPruning:
type: integer
DataObjectResponse:
type: array
items:
type: string