Improved description of all file uploads (#2053)

* Add format:binary for file uploads

* Fix wrongly named field for encoding

* Fix typo in field name

* Add contentType for torrentfile and captionfile

* Add contentType for videofile
This commit is contained in:
Frank Sträter 2019-08-21 08:32:15 +02:00 committed by Chocobozzz
parent ee7ea34e62
commit 0ad45af705
1 changed files with 30 additions and 3 deletions

View File

@ -726,8 +726,7 @@ paths:
type: string type: string
format: binary format: binary
encoding: encoding:
profileImage: avatarfile:
# only accept png/jpeg
contentType: image/png, image/jpeg contentType: image/png, image/jpeg
/videos: /videos:
get: get:
@ -829,9 +828,11 @@ paths:
thumbnailfile: thumbnailfile:
description: Video thumbnail file description: Video thumbnail file
type: string type: string
format: binary
previewfile: previewfile:
description: Video preview file description: Video preview file
type: string type: string
format: binary
category: category:
description: Video category description: Video category
type: string type: string
@ -874,6 +875,11 @@ paths:
format: date-time format: date-time
scheduleUpdate: scheduleUpdate:
$ref: '#/components/schemas/VideoScheduledUpdate' $ref: '#/components/schemas/VideoScheduledUpdate'
encoding:
thumbnailfile:
contentType: image/jpeg
previewfile:
contentType: image/jpeg
get: get:
summary: Get a video by its id summary: Get a video by its id
tags: tags:
@ -1029,9 +1035,11 @@ paths:
thumbnailfile: thumbnailfile:
description: Video thumbnail file description: Video thumbnail file
type: string type: string
format: binary
previewfile: previewfile:
description: Video preview file description: Video preview file
type: string type: string
format: binary
privacy: privacy:
$ref: '#/components/schemas/VideoPrivacySet' $ref: '#/components/schemas/VideoPrivacySet'
category: category:
@ -1080,6 +1088,13 @@ paths:
- videofile - videofile
- channelId - channelId
- name - name
encoding:
videofile:
contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
thumbnailfile:
contentType: image/jpeg
previewfile:
contentType: image/jpeg
x-code-samples: x-code-samples:
- lang: Shell - lang: Shell
source: | source: |
@ -1142,9 +1157,11 @@ paths:
thumbnailfile: thumbnailfile:
description: Video thumbnail file description: Video thumbnail file
type: string type: string
format: binary
previewfile: previewfile:
description: Video preview file description: Video preview file
type: string type: string
format: binary
privacy: privacy:
$ref: '#/components/schemas/VideoPrivacySet' $ref: '#/components/schemas/VideoPrivacySet'
category: category:
@ -1188,6 +1205,13 @@ paths:
required: required:
- channelId - channelId
- name - name
encoding:
torrentfile:
contentType: application/x-bittorrent
thumbnailfile:
contentType: image/jpeg
previewfile:
contentType: image/jpeg
/videos/abuse: /videos/abuse:
get: get:
summary: Get list of reported video abuses summary: Get list of reported video abuses
@ -1308,6 +1332,9 @@ paths:
description: The file to upload. description: The file to upload.
type: string type: string
format: binary format: binary
encoding:
captionfile:
contentType: text/vtt, application/x-subrip
responses: responses:
'204': '204':
$ref: '#/paths/~1users~1me/put/responses/204' $ref: '#/paths/~1users~1me/put/responses/204'
@ -1952,7 +1979,7 @@ components:
description: 'Video file size in bytes' description: 'Video file size in bytes'
torrentUrl: torrentUrl:
type: string type: string
torrentDownaloadUrl: torrentDownloadUrl:
type: string type: string
fileUrl: fileUrl:
type: string type: string