aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api/openapi.yaml
diff options
context:
space:
mode:
authorThomas <tomspycell@gmail.com>2021-04-13 20:45:54 +0000
committerRigel Kent <par@rigelk.eu>2021-04-13 23:31:51 +0200
commite81af3000f1881ec5041678ae54b402b0314bd42 (patch)
tree1317b4653679c053d334000fb5c1c2c415f183ff /support/doc/api/openapi.yaml
parent1748e92aaa57623b24d71c47e18e7b7224821cd4 (diff)
downloadPeerTube-e81af3000f1881ec5041678ae54b402b0314bd42.tar.gz
PeerTube-e81af3000f1881ec5041678ae54b402b0314bd42.tar.zst
PeerTube-e81af3000f1881ec5041678ae54b402b0314bd42.zip
Update VideoFile structure in the API doc
Explain the difference between the 4 URL fields in the VideoFile structure.
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r--support/doc/api/openapi.yaml4
1 files changed, 4 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 373b17ddf..a63ee7983 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -4151,15 +4151,19 @@ components:
4151 description: 'Video file size in bytes' 4151 description: 'Video file size in bytes'
4152 torrentUrl: 4152 torrentUrl:
4153 type: string 4153 type: string
4154 description: Direct URL of the torrent file
4154 format: url 4155 format: url
4155 torrentDownloadUrl: 4156 torrentDownloadUrl:
4156 type: string 4157 type: string
4158 description: URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)
4157 format: url 4159 format: url
4158 fileUrl: 4160 fileUrl:
4159 type: string 4161 type: string
4162 description: Direct URL of the video
4160 format: url 4163 format: url
4161 fileDownloadUrl: 4164 fileDownloadUrl:
4162 type: string 4165 type: string
4166 description: URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)
4163 format: url 4167 format: url
4164 fps: 4168 fps:
4165 type: number 4169 type: number