diff options
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 21818ae81..787859c3b 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -99,6 +99,7 @@ x-tagGroups: | |||
99 | - name: Videos | 99 | - name: Videos |
100 | tags: | 100 | tags: |
101 | - Video | 101 | - Video |
102 | - Video Caption | ||
102 | - Video Channel | 103 | - Video Channel |
103 | - Video Comment | 104 | - Video Comment |
104 | - Video Following | 105 | - Video Following |
@@ -1247,6 +1248,58 @@ paths: | |||
1247 | type: array | 1248 | type: array |
1248 | items: | 1249 | items: |
1249 | $ref: '#/components/schemas/VideoBlacklist' | 1250 | $ref: '#/components/schemas/VideoBlacklist' |
1251 | /videos/{id}/captions: | ||
1252 | get: | ||
1253 | summary: Get list of video's captions | ||
1254 | tags: | ||
1255 | - Video Caption | ||
1256 | parameters: | ||
1257 | - $ref: '#/components/parameters/id2' | ||
1258 | responses: | ||
1259 | '200': | ||
1260 | description: successful operation | ||
1261 | content: | ||
1262 | application/json: | ||
1263 | schema: | ||
1264 | type: object | ||
1265 | properties: | ||
1266 | total: | ||
1267 | type: integer | ||
1268 | data: | ||
1269 | type: array | ||
1270 | items: | ||
1271 | $ref: '#/components/schemas/VideoCaption' | ||
1272 | /videos/{id}/captions/{captionLanguage}: | ||
1273 | put: | ||
1274 | summary: Add or replace a video caption | ||
1275 | tags: | ||
1276 | - Video Caption | ||
1277 | parameters: | ||
1278 | - $ref: '#/components/parameters/id2' | ||
1279 | - $ref: '#/components/parameters/captionLanguage' | ||
1280 | requestBody: | ||
1281 | content: | ||
1282 | multipart/form-data: | ||
1283 | schema: | ||
1284 | type: object | ||
1285 | properties: | ||
1286 | captionfile: | ||
1287 | description: The file to upload. | ||
1288 | type: string | ||
1289 | format: binary | ||
1290 | responses: | ||
1291 | '204': | ||
1292 | $ref: '#/paths/~1users~1me/put/responses/204' | ||
1293 | delete: | ||
1294 | summary: Delete a video caption | ||
1295 | tags: | ||
1296 | - Video Caption | ||
1297 | parameters: | ||
1298 | - $ref: '#/components/parameters/id2' | ||
1299 | - $ref: '#/components/parameters/captionLanguage' | ||
1300 | responses: | ||
1301 | '204': | ||
1302 | $ref: '#/paths/~1users~1me/put/responses/204' | ||
1250 | /video-channels: | 1303 | /video-channels: |
1251 | get: | 1304 | get: |
1252 | summary: Get list of video channels | 1305 | summary: Get list of video channels |
@@ -1611,6 +1664,13 @@ components: | |||
1611 | description: The video id or uuid | 1664 | description: The video id or uuid |
1612 | schema: | 1665 | schema: |
1613 | type: string | 1666 | type: string |
1667 | captionLanguage: | ||
1668 | name: captionLanguage | ||
1669 | in: path | ||
1670 | required: true | ||
1671 | description: The caption language | ||
1672 | schema: | ||
1673 | type: string | ||
1614 | channelHandle: | 1674 | channelHandle: |
1615 | name: channelHandle | 1675 | name: channelHandle |
1616 | in: path | 1676 | in: path |
@@ -1917,6 +1977,12 @@ components: | |||
1917 | type: array | 1977 | type: array |
1918 | items: | 1978 | items: |
1919 | $ref: '#/components/schemas/VideoCommentThreadTree' | 1979 | $ref: '#/components/schemas/VideoCommentThreadTree' |
1980 | VideoCaption: | ||
1981 | properties: | ||
1982 | language: | ||
1983 | $ref: '#/components/schemas/VideoConstantString' | ||
1984 | captionPath: | ||
1985 | type: string | ||
1920 | Avatar: | 1986 | Avatar: |
1921 | properties: | 1987 | properties: |
1922 | path: | 1988 | path: |