diff options
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index da51732ad..4283e61d2 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -4224,7 +4224,10 @@ components: | |||
4224 | format: url | 4224 | format: url |
4225 | files: | 4225 | files: |
4226 | type: array | 4226 | type: array |
4227 | description: 'Video files associated to this playlist. The difference with the root "files" property is that these files are fragmented, so they can be used in this streaming playlist (HLS etc)' | 4227 | description: | |
4228 | Video files associated to this playlist. | ||
4229 | |||
4230 | The difference with the root `files` property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.) | ||
4228 | items: | 4231 | items: |
4229 | $ref: '#/components/schemas/VideoFile' | 4232 | $ref: '#/components/schemas/VideoFile' |
4230 | redundancies: | 4233 | redundancies: |
@@ -4346,6 +4349,8 @@ components: | |||
4346 | type: string | 4349 | type: string |
4347 | description: A text tell the audience how to support the video creator | 4350 | description: A text tell the audience how to support the video creator |
4348 | example: Please support my work on <insert crowdfunding plateform>! <3 | 4351 | example: Please support my work on <insert crowdfunding plateform>! <3 |
4352 | minLength: 3 | ||
4353 | maxLength: 1000 | ||
4349 | channel: | 4354 | channel: |
4350 | $ref: '#/components/schemas/VideoChannel' | 4355 | $ref: '#/components/schemas/VideoChannel' |
4351 | account: | 4356 | account: |
@@ -4359,11 +4364,6 @@ components: | |||
4359 | type: string | 4364 | type: string |
4360 | minLength: 2 | 4365 | minLength: 2 |
4361 | maxLength: 30 | 4366 | maxLength: 30 |
4362 | files: | ||
4363 | type: array | ||
4364 | description: 'WebTorrent/raw video files. Can be empty if WebTorrent is disabled on the server. In this case, video files will be in the "streamingPlaylists[].files" property' | ||
4365 | items: | ||
4366 | $ref: '#/components/schemas/VideoFile' | ||
4367 | commentsEnabled: | 4367 | commentsEnabled: |
4368 | type: boolean | 4368 | type: boolean |
4369 | downloadEnabled: | 4369 | downloadEnabled: |
@@ -4373,10 +4373,24 @@ components: | |||
4373 | items: | 4373 | items: |
4374 | type: string | 4374 | type: string |
4375 | format: url | 4375 | format: url |
4376 | files: | ||
4377 | type: array | ||
4378 | items: | ||
4379 | $ref: '#/components/schemas/VideoFile' | ||
4380 | description: | | ||
4381 | WebTorrent/raw video files. If WebTorrent is disabled on the server: | ||
4382 | |||
4383 | - field will be empty | ||
4384 | - video files will be found in `streamingPlaylists[].files` field | ||
4376 | streamingPlaylists: | 4385 | streamingPlaylists: |
4377 | type: array | 4386 | type: array |
4378 | items: | 4387 | items: |
4379 | $ref: '#/components/schemas/VideoStreamingPlaylists' | 4388 | $ref: '#/components/schemas/VideoStreamingPlaylists' |
4389 | description: | | ||
4390 | HLS playlists/manifest files. If HLS is disabled on the server: | ||
4391 | |||
4392 | - field will be empty | ||
4393 | - video files will be found in `files` field | ||
4380 | FileRedundancyInformation: | 4394 | FileRedundancyInformation: |
4381 | properties: | 4395 | properties: |
4382 | id: | 4396 | id: |