]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/commitdiff
Update openapi documentation
authorChocobozzz <me@florianbigard.com>
Wed, 26 Aug 2020 12:45:39 +0000 (14:45 +0200)
committerChocobozzz <me@florianbigard.com>
Wed, 26 Aug 2020 12:45:39 +0000 (14:45 +0200)
Regarding "files" property of the video object

support/doc/api/openapi.yaml

index 9922a321605d4d3b576e1c50255eb22aefd8b33f..756c610c142814f32733c72d7ed765b82cab0f2a 100644 (file)
@@ -3822,6 +3822,7 @@ components:
           format: url
         files:
           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)'
           items:
             $ref: '#/components/schemas/VideoFile'
         redundancies:
@@ -3948,6 +3949,7 @@ components:
               example: [flowers, gardening]
             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: