This repository was archived by the owner on Oct 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
525 lines (515 loc) · 12.8 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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
openapi: 3.0.3
info:
title: Netflux ESIR
description: Netflux ESIR
version: 1.0.0
servers:
- url: 'https'
paths:
/api/v1/presignedurl/{key}:
get:
security:
- bearerAuth: [ ]
tags:
- presignedurl
summary: Get a presigned url
operationId: getPresignedUrl
parameters:
- name: key
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
required:
- url
properties:
url:
type: string
description: The presigned url
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Not Found
'500':
description: Internal Server Error
/api/v1/users/register:
post:
security:
- bearerAuth: [ ]
tags:
- users
summary: Register a user, only for admin
operationId: registerUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
required:
- token
properties:
token:
type: string
description: The token of the user
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'409':
description: Conflict
'500':
description: Internal Server Error
/api/v1/users/login:
post:
tags:
- users
summary: Login a user
operationId: loginUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
required:
- token
properties:
token:
type: string
description: The token of the user
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal Server Error
/api/v1/videos:
get:
security:
- bearerAuth: [ ]
tags:
- videos
summary: Get all videos
operationId: getVideos
parameters:
- name: limit
description: The number of items to return
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 10
- name: offset
in: query
description: The number of items to skip before starting to collect the result set
required: false
schema:
type: integer
minimum: 0
default: 0
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Video'
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal Server Error
post:
security:
- bearerAuth: [ ]
tags:
- videos
summary: Create a video
operationId: createVideo
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Not Found
'409':
description: Conflict
'500':
description: Internal Server Error
/api/v1/videos/{videoId}:
get:
security:
- bearerAuth: [ ]
tags:
- videos
summary: Get a video
operationId: getVideo
parameters:
- name: videoId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Not Found
put:
security:
- bearerAuth: [ ]
tags:
- videos
summary: Update a video
operationId: updateVideo
parameters:
- name: videoId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Not Found
'500':
description: Internal Server Error
delete:
security:
- bearerAuth: [ ]
tags:
- videos
summary: Delete a video
operationId: deleteVideo
parameters:
- name: videoId
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Not Found
'500':
description: Internal Server Error
/api/v1/processing/{videoId}:
get:
security:
- bearerAuth: [ ]
tags:
- processing
summary: Get a processing
operationId: getProcessing
parameters:
- name: videoId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Processing'
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Not Found
'500':
description: Internal Server Error
/api/v1/processing/{videoId}/status:
post:
security:
- bearerAuth: [ ]
tags:
- processing
summary: Update the status of a processing
operationId: updateProcessingStatus
parameters:
- name: videoId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: The status of the processing
enum:
- PENDING
- STARTED
- ERROR
- FINISHED
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Not Found
'500':
description: Internal Server Error
/api/v1/processing/{videoId}/steps:
post:
security:
- bearerAuth: [ ]
tags:
- processing
summary: Update the step of a processing
operationId: updateProcessingStep
parameters:
- name: videoId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
type: object
required:
- step
properties:
step:
type: string
description: The step of the processing
enum:
- NONE
- DOWNSCALE
- LANG_DETECTION
- TRANSCRIPTION
- ANIMAL_DETECTION
status:
type: string
description: The status of the step
enum:
- STARTED
- ERROR
- FINISHED
log:
type: string
description: The logs of the step
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Not Found
'500':
description: Internal Server Error
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
responses:
Unauthorized:
description: Access token is missing or invalid
schemas:
Account:
type: object
required:
- email
- password
properties:
email:
type: string
format: email
description: The email of the user
password:
type: string
description: The password of the user
role:
type: string
description: The role of the user
enum:
- ADMIN
- USER
- ROBOT
Video:
type: object
required:
- title
- description
properties:
id:
type: string
format: uuid
description: The unique identifier of the video
title:
type: string
description: The title of the video
description:
type: string
description: The description of the video
videoUrl:
type: string
description: The url of the video
captionUrl:
type: string
description: The url of the caption
processingId:
type: string
format: uuid
description: The unique identifier of the processing
labels:
type: object
additionalProperties:
type: string
description: The labels of the video
language:
type: string
description: The language of the video
metadata:
type: object
description: The metadata of the video
additionalProperties:
type: string
Processing:
type: object
properties:
id:
type: string
format: uuid
description: The unique identifier of the processing
status:
type: string
description: The status of the processing
enum:
- PENDING
- STARTED
- ERROR
- FINISHED
videoId:
type: string
format: uuid
description: The unique identifier of the video
currentStep:
type: string
description: The step of the processing
enum:
- NONE
- DOWNSCALE
- LANG_DETECTION
- TRANSCRIPTION
- ANIMAL_DETECTION
- FINISHED
steps:
type: array
items:
$ref: '#/components/schemas/ProcessingStep'
ProcessingStep:
type: object
properties:
step:
type: string
description: The step of the processing
enum:
- NONE
- DOWNSCALE
- LANG_DETECTION
- TRANSCRIPTION
- ANIMAL_DETECTION
- FINISHED
status:
type: string
description: The status of the processing
enum:
- STARTED
- FINISHED
- ERROR
log:
type: string
description: The message of the processing
security:
- bearerAuth: []