make hls/webtorrent fields closely documented in the openapi spec

pull/4042/head
Rigel Kent 2021-05-04 09:13:21 +02:00
parent f676e0e321
commit c540d8654f
No known key found for this signature in database
GPG Key ID: 5E53E96A494E452F
1 changed files with 20 additions and 6 deletions

View File

@ -4224,7 +4224,10 @@ components:
format: url format: url
files: files:
type: array type: array
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)' 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.)
items: items:
$ref: '#/components/schemas/VideoFile' $ref: '#/components/schemas/VideoFile'
redundancies: redundancies:
@ -4346,6 +4349,8 @@ components:
type: string type: string
description: A text tell the audience how to support the video creator description: A text tell the audience how to support the video creator
example: Please support my work on <insert crowdfunding plateform>! <3 example: Please support my work on <insert crowdfunding plateform>! <3
minLength: 3
maxLength: 1000
channel: channel:
$ref: '#/components/schemas/VideoChannel' $ref: '#/components/schemas/VideoChannel'
account: account:
@ -4359,11 +4364,6 @@ components:
type: string type: string
minLength: 2 minLength: 2
maxLength: 30 maxLength: 30
files:
type: array
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'
items:
$ref: '#/components/schemas/VideoFile'
commentsEnabled: commentsEnabled:
type: boolean type: boolean
downloadEnabled: downloadEnabled:
@ -4373,10 +4373,24 @@ components:
items: items:
type: string type: string
format: url format: url
files:
type: array
items:
$ref: '#/components/schemas/VideoFile'
description: |
WebTorrent/raw video files. If WebTorrent is disabled on the server:
- field will be empty
- video files will be found in `streamingPlaylists[].files` field
streamingPlaylists: streamingPlaylists:
type: array type: array
items: items:
$ref: '#/components/schemas/VideoStreamingPlaylists' $ref: '#/components/schemas/VideoStreamingPlaylists'
description: |
HLS playlists/manifest files. If HLS is disabled on the server:
- field will be empty
- video files will be found in `files` field
FileRedundancyInformation: FileRedundancyInformation:
properties: properties:
id: id: