Browse Source

Update VideoFile structure in the API doc

Explain the difference between the 4 URL fields in the VideoFile structure.
Thomas 3 years ago
parent
commit
e81af3000f
1 changed files with 4 additions and 0 deletions
  1. 4 0
      support/doc/api/openapi.yaml

+ 4 - 0
support/doc/api/openapi.yaml

@@ -4151,15 +4151,19 @@ components:
           description: 'Video file size in bytes'
         torrentUrl:
           type: string
+          description: Direct URL of the torrent file
           format: url
         torrentDownloadUrl:
           type: string
+          description: URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)
           format: url
         fileUrl:
           type: string
+          description: Direct URL of the video
           format: url
         fileDownloadUrl:
           type: string
+          description: URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)
           format: url
         fps:
           type: number