aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2021-11-18 14:35:08 +0100
committerChocobozzz <me@florianbigard.com>2021-11-18 15:20:57 +0100
commitad5db1044c8599eaaaa2a578b350777ae996b068 (patch)
tree3e003cccf021152405d49b21c6c91b703c8ae96c /support/doc/api
parentb46cf4b920984492df598c1b61179acfc7f6f22e (diff)
downloadPeerTube-ad5db1044c8599eaaaa2a578b350777ae996b068.tar.gz
PeerTube-ad5db1044c8599eaaaa2a578b350777ae996b068.tar.zst
PeerTube-ad5db1044c8599eaaaa2a578b350777ae996b068.zip
Add ability to run transcoding jobs
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml69
1 files changed, 69 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 88a089fc7..cfba7b361 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -267,6 +267,10 @@ tags:
267 description: Like/dislike a video. 267 description: Like/dislike a video.
268 - name: Video Playlists 268 - name: Video Playlists
269 description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels. 269 description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels.
270 - name: Video Files
271 description: Operations on video files
272 - name: Video Transcoding
273 description: Video transcoding related operations
270 - name: Feeds 274 - name: Feeds
271 description: Server syndication feeds 275 description: Server syndication feeds
272 - name: Search 276 - name: Search
@@ -309,6 +313,8 @@ x-tagGroups:
309 - Video Playlists 313 - Video Playlists
310 - Video Ownership Change 314 - Video Ownership Change
311 - Video Mirroring 315 - Video Mirroring
316 - Video Files
317 - Video Transcoding
312 - Live Videos 318 - Live Videos
313 - Feeds 319 - Feeds
314 - name: Search 320 - name: Search
@@ -3568,6 +3574,69 @@ paths:
3568 '404': 3574 '404':
3569 description: video does not exist 3575 description: video does not exist
3570 3576
3577 '/videos/{id}/hls':
3578 delete:
3579 summary: Delete video HLS files
3580 security:
3581 - OAuth2:
3582 - admin
3583 tags:
3584 - Video Files
3585 operationId: delVideoHLS
3586 parameters:
3587 - $ref: '#/components/parameters/idOrUUID'
3588 responses:
3589 '204':
3590 description: successful operation
3591 '404':
3592 description: video does not exist
3593 '/videos/{id}/webtorrent':
3594 delete:
3595 summary: Delete video WebTorrent files
3596 security:
3597 - OAuth2:
3598 - admin
3599 tags:
3600 - Video Files
3601 operationId: delVideoWebTorrent
3602 parameters:
3603 - $ref: '#/components/parameters/idOrUUID'
3604 responses:
3605 '204':
3606 description: successful operation
3607 '404':
3608 description: video does not exist
3609
3610 '/videos/{id}/transcoding':
3611 post:
3612 summary: Create a transcoding job
3613 security:
3614 - OAuth2:
3615 - admin
3616 tags:
3617 - Video Transcoding
3618 operationId: createVideoTranscoding
3619 parameters:
3620 - $ref: '#/components/parameters/idOrUUID'
3621 requestBody:
3622 content:
3623 application/json:
3624 schema:
3625 type: object
3626 properties:
3627 transcodingType:
3628 type: string
3629 enum:
3630 - hls
3631 - webtorrent
3632 required:
3633 - transcodingType
3634 responses:
3635 '204':
3636 description: successful operation
3637 '404':
3638 description: video does not exist
3639
3571 /search/videos: 3640 /search/videos:
3572 get: 3641 get:
3573 tags: 3642 tags: