aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2022-08-01 15:48:14 +0200
committerChocobozzz <me@florianbigard.com>2022-08-01 15:50:15 +0200
commitf9079a78bd84e3745b20a6a36c5d2a8c693427b0 (patch)
tree1c9fd81ab17c282ee78bf3bea8dbc6eeb5fdbdc5
parent15eb9e5b8fe9a29201567ab41f730fd39c1a14b8 (diff)
downloadPeerTube-f9079a78bd84e3745b20a6a36c5d2a8c693427b0.tar.gz
PeerTube-f9079a78bd84e3745b20a6a36c5d2a8c693427b0.tar.zst
PeerTube-f9079a78bd84e3745b20a6a36c5d2a8c693427b0.zip
Add studio API documentation
-rw-r--r--support/doc/api/openapi.yaml87
1 files changed, 87 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 3092a9960..74963df14 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1671,6 +1671,31 @@ paths:
1671 '404': 1671 '404':
1672 description: video not found 1672 description: video not found
1673 1673
1674 /videos/{id}/studio/edit:
1675 post:
1676 summary: Create a studio task
1677 tags:
1678 - Video Transcoding
1679 - Video
1680 description: Create a task to edit a video (cut, add intro/outro etc)
1681 security:
1682 - OAuth2: []
1683 parameters:
1684 - $ref: '#/components/parameters/idOrUUID'
1685 requestBody:
1686 required: true
1687 content:
1688 application/x-www-form-urlencoded:
1689 schema:
1690 $ref: '#/components/schemas/VideoStudioCreateTask'
1691 responses:
1692 '204':
1693 description: successful operation
1694 '400':
1695 description: incorrect parameters
1696 '404':
1697 description: video not found
1698
1674 /videos: 1699 /videos:
1675 get: 1700 get:
1676 summary: List videos 1701 summary: List videos
@@ -7913,6 +7938,68 @@ components:
7913 description: User can select live latency mode if enabled by the instance 7938 description: User can select live latency mode if enabled by the instance
7914 $ref: '#/components/schemas/LiveVideoLatencyMode' 7939 $ref: '#/components/schemas/LiveVideoLatencyMode'
7915 7940
7941 VideoStudioCreateTask:
7942 type: array
7943 items:
7944 anyOf:
7945 -
7946 title: cut
7947 type: object
7948 properties:
7949 name:
7950 type: string
7951 enum:
7952 - 'cut'
7953 options:
7954 type: object
7955 properties:
7956 start:
7957 type: integer
7958 end:
7959 type: integer
7960 -
7961 title: add-intro
7962 type: object
7963 properties:
7964 name:
7965 type: string
7966 enum:
7967 - 'add-intro'
7968 options:
7969 type: object
7970 properties:
7971 file:
7972 type: string
7973 format: binary
7974 -
7975 title: add-outro
7976 type: object
7977 properties:
7978 name:
7979 type: string
7980 enum:
7981 - 'add-outro'
7982 options:
7983 type: object
7984 properties:
7985 file:
7986 type: string
7987 format: binary
7988 -
7989 title: add-watermark
7990 type: object
7991 properties:
7992 name:
7993 type: string
7994 enum:
7995 - 'add-watermark'
7996 options:
7997 type: object
7998 properties:
7999 file:
8000 type: string
8001 format: binary
8002
7916 LiveVideoSessionResponse: 8003 LiveVideoSessionResponse:
7917 properties: 8004 properties:
7918 id: 8005 id: