-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.yml
509 lines (501 loc) · 15.7 KB
/
openapi.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
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
openapi: 3.0.3
info:
title: pomu.app API
version: 0.0.1
description: Public API for pomu.app
contact:
name: General inqueries regarding API
email: [email protected]
url: https://pomu.app
license:
name: BSD 3-Clause
url: https://github.com/mellowagain/pomu/blob/main/LICENSE.txt
servers:
- url: https://pomu.app/api
description: Production
- url: https://dev.pomu.app/api
description: Development instance
components:
schemas:
video:
type: object
required:
- id
- submitters
- scheduledStart
- finished
- title
- channelName
- channelId
- thumbnail
properties:
id:
type: string
description: Video ID
submitters:
type: array
description: "List of user IDs which have submitted this video to the queue (Format: Provider/UserID)"
items:
type: string
scheduledStart:
type: string
format: date-time
description: Scheduled start of livestream
finished:
type: boolean
description: Whenever the livestream has finished already
title:
type: string
description: Livestream title
channelName:
type: string
description: Name of channel which is streaming this livestream
channelId:
type: string
description: Channel ID of channel which is streaming this livestream
thumbnail:
type: string
description: URL to maximum quality thumbnail available for livestream
downloadUrl:
type: string
description: URL where archive is available for download
fileSizeBytes:
type: integer
format: int64
description: Archive file size in bytes
length:
type: integer
format: int32
description: Length of livestream in seconds
user:
type: object
required:
- id
- name
- avatar
- provider
properties:
id:
type: string
description: OAuth provider User ID
name:
type: string
description: Username (or First Name)
avatar:
type: string
format: url
description: URL to avatar
provider:
type: string
enum:
- google
- discord
parameters:
videoId:
name: videoId
in: path
required: true
schema:
type: string
description: Video ID of the video which you want to download `type` from
paths:
/:
get:
operationId: apiOverview
description: Returns general API information
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
required:
- app
- documentation
- repository
- commit
properties:
app:
type: string
description: Service which is running
documentation:
type: string
description: URL to API documentation
repository:
type: string
description: URL to code repository
commit:
type: string
description: Git SHA-1 of commit which is deployed
/validate:
get:
operationId: ValidateLivestream
description: Validates if the livestream is allowed to be submitted
parameters:
- name: url
in: query
description: YouTube url of livestream which should be validated against submission guidelines
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
required:
- valid
- channelId
properties:
valid:
type: boolean
description: Whenever this stream follows configured submission guidelines and can be submitted
channelId:
type: string
description: Channel ID of the submitted video
/qualities:
get:
operationId: PeekForQualities
description: Get list of available qualities for stream
parameters:
- name: url
in: query
description: YouTube url of livestream for which qualities should be peeked
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
required:
- code
- resolution
- best
properties:
code:
type: integer
format: int32
description: Numeric ID of the quality
resolution:
type: string
description: Human-readable resolution of the quality
best:
type: boolean
description: Whenever this is the best available quality (both audio and video)
/submit:
post:
operationId: SubmitVideo
description: Submits a livestream to the archiving queue
requestBody:
required: true
description: Livestream submission payload
content:
application/json:
schema:
type: object
required:
- videoUrl
- quality
properties:
videoUrl:
type: string
description: YouTube url of live stream which should be added to queue
quality:
type: integer
format: int32
description: Numeric ID of the quality in which the live stream should be archived
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/video"
"401":
description: Not logged in
/queue:
get:
operationId: GetQueue
description: Gets list of currently queued livestreams (live or upcoming)
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/video"
/history:
get:
operationId: GetHistory
description: Gets list of archived livestreams
parameters:
- name: page
in: query
description: Page to display
schema:
type: integer
format: int32
additionalProperties:
minimum: 0
default: 0
- name: limit
in: query
description: Amount of livestreams to display per page
schema:
type: integer
format: int32
additionalProperties:
maximum: 100
default: 25
- name: sort
in: query
description: Sort direction of results
schema:
type: string
enum:
- asc
- desc
- name: unfinished
in: query
description: Whenever unfinished livestreams (live or upcoming) should be displayed
schema:
type: boolean
additionalProperties:
default: false
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/video"
headers:
X-Pomu-Pagination-Total:
description: Total amounts of rows that match the filter
required: true
schema:
type: integer
X-Pomu-Pagination-Has-More:
description: Whenever there are more pages available
required: true
schema:
type: boolean
/search:
get:
operationId: SearchMetadata
description: |
Get Meilisearch metadata to search for videos.
If search is enabled, the returned metadata can be used to search for archived streams in the index `pomu`.
The returned `apiKey`, if provided, is guaranteed to be view and search only and can not modify the index.
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
required:
- enabled
properties:
enabled:
type: boolean
description: Whenever search is enabled on this instance
url:
type: string
description: Meilisearch API base url, if search is enabled
apiKey:
type: string
description: Meilisearch API key, if search is enabled
/user:
get:
operationId: identitySelf
description: Get full identity for the currently logged in user
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/user"
"401":
description: Not logged in
/user/{provider}/{id}:
parameters:
- name: provider
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
get:
operationId: identity
description: Get identity of a specific user
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/user"
/video/{videoId}/downloads:
parameters:
- $ref: "#/components/parameters/videoId"
get:
operationId: DownloadCount
description: Get the amount of downloads for the requested video
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
required:
- downloads
properties:
downloads:
type: integer
description: The total amount of times this video has been downloaded
/download/{videoId}/{type}:
parameters:
- $ref: "#/components/parameters/videoId"
- name: type
in: path
required: true
schema:
type: string
description: What you want to download
enum:
- video
- ffmpeg
- thumbnail
- name: User-Agent
in: header
required: true
schema:
type: string
description: |
A identify-able user agent string is **required** to use the pomu download endpoint.
Including a identify-able user agent allows us to contact you in case of abuse
or usage outside of our fair-use policy.
Failing to include such a user agent **will** result in request blocking (401 Bad Request)
and may also lead to an automated IP(-range) ban, if the request block is being circumvented.
example: "pomu (https://github.com/mellowagain/pomu)"
allowReserved: true
get:
operationId: Download
description: Downloads the request `type` of video `videoId`
responses:
"307":
description: |
OK - Follow redirect (response header `Location`) to download the requested file.
> warn
> The returned `Content-Type` and `Content-Disposition` may differ depending on
> what type you requested and when the stream was archived:
- **Type `video`** archived before 2023-01-26:
- `Content-Type: binary/octet-stream`
- No `Content-Disposition` header
- **Type `video`** archived between 2023-01-27 and 2023-02-04:
- `Content-Type: video/mp4`
- `Content-Disposition: inline`
- **Type `video`** archived after 2023-02-05:
- `Content-Type: video/mp4`
- `Content-Disposition: attachment`
- **Type `thumbnail`** archived before 2023-01-26:
- `Content-Type: binary/octet-stream`
- No `Content-Disposition` header
- **Type `thumbnail`** archived after 2023-01-27:
- `Content-Type: image/jpeg`
- `Content-Disposition: inline`
- **Type `ffmpeg`** archived before 2023-01-26:
- `Content-Type: binary/octet-stream`
- No `Content-Disposition` header
- **Type `ffmpeg`** archived after 2023-01-27:
- `Content-Type: text/plain`
- `Content-Disposition: inline`
content:
application/octet-stream:
schema:
type: string
format: binary
"401":
description: |
# Bad Request
One of these two things occurred:
- Video or ffmpeg log download has been requested but the video has not yet finished archiving.
- A bad user agent has been sent with the request. Please see the `User-Agent` header definition in this file.
"404":
description: Not Found
/logz:
get:
operationId: Log
description: Get ffmpeg log for a livestream which is currently being archived
parameters:
- name: url
in: query
description: YouTube url of livestream for which ffmpeg logs should be returned
schema:
type: string
- name: id
in: query
description: Video ID of livestream for which ffmpeg logs should be returned
schema:
type: string
responses:
"200":
description: OK
content:
text/plain:
schema:
type: string
/stats:
get:
operationId: GetStats
description: Get general stats for this pomu.app instance
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
required:
- videoAmount
- totalFileSize
- totalLength
- uniqueChannels
- s3BillPerMonth
properties:
videoAmount:
type: integer
description: Amount of videos which are archived or queued to be archived
totalFileSize:
type: integer
description: Total file size of all archives in bytes
totalLength:
type: integer
description: Total amount of seconds of all archives
s3BillPerMonth:
type: number
format: double
description: S3 bill per month in USD
usdPerGbPerMonth:
type: number
format: double
description: Cost of a single gigabyte of data per month for S3