-
Notifications
You must be signed in to change notification settings - Fork 105
/
openapi.yaml
618 lines (616 loc) · 21.2 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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
openapi: '3.0.2'
info:
title: Torrents Stream Server
version: '1.0'
paths:
/api/auth:
post:
operationId: auth
tags:
- auth
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessModel'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
/api/usage:
get:
operationId: getUsage
tags:
- dashboard
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UsageModel'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
/api/torrents:
get:
operationId: getTorrents
tags:
- torrents
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TorrentModel'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
post:
operationId: createTorrent
tags:
- torrents
parameters:
- in: query
name: torrent
description: magnet or torrent link
required: true
allowReserved: true
schema:
type: string
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TorrentModel'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
/api/torrents/{infoHash}:
get:
operationId: getTorrent
tags:
- torrents
parameters:
- in: path
name: infoHash
description: torrent info hash
required: true
schema:
type: string
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TorrentModel'
404:
$ref: '#/components/responses/404'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
/stream/{torrent}:
get:
operationId: getStream
description: 'Create a file stream from torrents by `torrent` parameter. By default the biggest file will be returned, but it is possible to select file manually using `file`, `fileType`, `fileIndex` parameters. Endpoint can be protected by passing signed payload with JWT token (`token` parameter).'
tags:
- stream
parameters:
- $ref: '#/components/parameters/torrentParam'
- $ref: '#/components/parameters/file'
- $ref: '#/components/parameters/fileType'
- $ref: '#/components/parameters/fileIndex'
- $ref: '#/components/parameters/output'
responses:
200:
description: OK
content:
application/octet-stream:
schema:
type: string
format: binary
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
/stream:
get:
operationId: getStream2
description: 'Create a file stream from torrents by `torrent` parameter. By default the biggest file will be returned, but it is possible to select file manually using `file`, `fileType`, `fileIndex` parameters. Endpoint can be protected by passing signed payload with JWT token (`token` parameter).'
tags:
- stream
parameters:
- $ref: '#/components/parameters/torrent'
- $ref: '#/components/parameters/file'
- $ref: '#/components/parameters/fileType'
- $ref: '#/components/parameters/fileIndex'
- $ref: '#/components/parameters/output'
responses:
200:
description: OK
content:
application/octet-stream:
schema:
type: string
format: binary
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
/playlist/{torrent}:
get:
operationId: getPlaylist
description: 'Returns [m3u multimedia playlist](https://en.wikipedia.org/wiki/M3U) of the torrent. Supports same parameters as stream endpoint.'
tags:
- stream
parameters:
- $ref: '#/components/parameters/torrentParam'
- $ref: '#/components/parameters/file'
- $ref: '#/components/parameters/fileType'
- $ref: '#/components/parameters/fileIndex'
responses:
200:
description: OK
content:
application/octet-stream:
schema:
type: string
format: binary
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
/playlist:
get:
operationId: getPlaylist2
description: 'Returns [m3u multimedia playlist](https://en.wikipedia.org/wiki/M3U) of the torrent. Supports same parameters as stream endpoint.'
tags:
- stream
parameters:
- $ref: '#/components/parameters/torrent'
- $ref: '#/components/parameters/file'
- $ref: '#/components/parameters/fileType'
- $ref: '#/components/parameters/fileIndex'
responses:
200:
description: OK
content:
application/octet-stream:
schema:
type: string
format: binary
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
/api/browse/providers:
get:
operationId: getProviders
tags:
- browse
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ProviderModel'
errors:
type: array
items:
$ref: '#/components/schemas/ProviderErrorModel'
required: ['items', 'errors']
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
/api/browse/providers/{provider}/magnet/{torrentId}:
get:
operationId: getMagnet
tags:
- browse
parameters:
- in: path
name: provider
description: provider name
required: true
schema:
type: string
- in: path
name: torrentId
description: torrent id
required: true
schema:
type: string
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MagnetModel'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
/api/browse/search:
get:
operationId: searchTorrents
tags:
- browse
parameters:
- in: query
name: query
description: search query
required: true
allowReserved: true
schema:
type: string
- in: query
name: providers
description: provider name
allowReserved: true
schema:
type: array
items:
type: string
- in: query
name: category
description: provider category
allowReserved: true
schema:
type: string
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SearchResultsModel'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
/api/logs:
get:
operationId: getLogs
summary: "Retrieve latest server logs"
tags:
- dashboard
security:
- apiKey: []
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Log'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
components:
parameters:
torrentParam:
in: path
name: torrent
required: true
description: Can be torrent infoHash, magnet or link to torrent file. If security is enabled, it should be JWT encoded whole payload (including all `query` parameters) with extra `torrent` parameter.
schema:
type: string
torrent:
in: query
name: torrent
required: true
allowReserved: true
description: Can be torrent infoHash, magnet or link to torrent file. If security is enabled, it should be JWT encoded whole payload (including all `query` parameters) with extra `torrent` parameter.
schema:
type: string
file:
in: query
name: file
description: Case insensitive file name or path
allowReserved: true
schema:
type: string
fileType:
in: query
name: fileType
description: Case insensitive file mime type (e.g. `video`, `video/mp4`, `mp4`) or file extension (e.g. `.mp4`, `mp4`)
allowReserved: true
schema:
type: string
fileIndex:
in: query
name: fileIndex
description: File index (starting from `1`)
allowReserved: true
schema:
type: number
output:
in: query
name: output
description: Set output type
allowReserved: true
schema:
type: string
enum: ['zip']
schemas:
UsageModel:
type: object
properties:
totalDiskSpace:
type: number
freeDiskSpace:
type: number
usedTorrentSpace:
type: number
required: ['totalDiskSpace', 'freeDiskSpace', 'usedTorrentSpace']
TorrentModel:
type: object
properties:
link:
type: string
infoHash:
type: string
name:
type: string
started:
type: number
updated:
type: number
files:
type: array
items:
$ref: '#/components/schemas/TorrentFileModel'
downloaded:
type: number
downloadSpeed:
type: number
playlist:
type: string
streamZip:
type: string
required: ['link', 'infoHash', 'name', 'started', 'updated', 'files', 'downloaded', 'downloadSpeed', 'playlist', 'streamZip']
TorrentFileModel:
type: object
properties:
name:
type: string
path:
type: string
type:
type: string
length:
type: number
stream:
type: string
streamZip:
type: string
required: ['name', 'path', 'length', 'type', 'stream', 'streamZip']
ProviderModel:
type: object
properties:
provider:
type: string
categories:
type: array
items:
$ref: '#/components/schemas/ProviderCategoryModel'
required: ['provider', 'categories']
ProviderCategoryModel:
type: object
properties:
name:
type: string
id:
type: string
subcategories:
type: array
items:
type: object
properties:
name:
type: string
id:
type: string
required: ['name', 'id']
required: ['name', 'id', 'subcategories']
ProviderTorrentModel:
type: object
properties:
id:
type: string
name:
type: string
magnet:
type: string
seeds:
type: number
downloads:
type: number
peers:
type: number
comments:
type: number
size:
type: string
time:
type: number
link:
type: string
isVip:
type: boolean
imdb:
type: string
numFiles:
type: number
provider:
type: string
category:
type: object
properties:
name:
type: string
id:
type: string
required: ['name', 'id']
required: ['name', 'id', 'seeds', 'peers', 'size', 'provider']
SearchResultsModel:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ProviderTorrentModel'
errors:
type: array
items:
$ref: '#/components/schemas/ProviderErrorModel'
required: ['items', 'errors']
ProviderErrorModel:
type: object
properties:
error:
type: string
provider:
type: string
required: ['error', 'provider']
MagnetModel:
type: object
properties:
magnet:
type: string
required: ['magnet']
ApiErrorModel:
type: object
properties:
error:
type: string
required: ['error']
SuccessModel:
type: object
properties:
success:
type: boolean
required: ['success']
Log:
type: object
description: Server log entry
properties:
message:
description: Log message
type: string
time:
description: Log timestamp in seconds
type: number
level:
type: string
enum: ['debug', 'info', 'warn', 'error']
required: ['message', 'time', 'level']
responses:
204:
description: Successful operation
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorModel'
401:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorModel'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorModel'
404:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorModel'
409:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorModel'
503:
description: Server is busy
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorModel'
securitySchemes:
apiKey:
type: http
scheme: bearer
servers:
- url: http://127.0.0.1:3000/
description: Dev server