Add video caption upload documentation and improve error message

fixes #2038

diff --git a/server/middlewares/validators/videos/video-captions.ts b/server/middlewares/validators/videos/video-captions.ts
index 2fb1da5ce403581efa9f503f5a4871e8231b69ef..7b0cd6f66c8b7d0484af0609ad29e930862c1a9a 100644 (file)
--- a/server/middlewares/validators/videos/video-captions.ts
+++ b/server/middlewares/validators/videos/video-captions.ts
@@ -2,7 +2,7 @@ import * as express from 'express'
 import { areValidationErrors } from '../utils'
 import { isIdOrUUIDValid } from '../../../helpers/custom-validators/misc'
 import { body, param } from 'express-validator'
-import { CONSTRAINTS_FIELDS } from '../../../initializers/constants'
+import { CONSTRAINTS_FIELDS, MIMETYPES } from '../../../initializers/constants'
 import { UserRight } from '../../../../shared'
 import { logger } from '../../../helpers/logger'
 import { isVideoCaptionFile, isVideoCaptionLanguageValid } from '../../../helpers/custom-validators/video-captions'
@@ -13,9 +13,9 @@ const addVideoCaptionValidator = [
   param('videoId').custom(isIdOrUUIDValid).not().isEmpty().withMessage('Should have a valid video id'),
   param('captionLanguage').custom(isVideoCaptionLanguageValid).not().isEmpty().withMessage('Should have a valid caption language'),
   body('captionfile')
-    .custom((value, { req }) => isVideoCaptionFile(req.files, 'captionfile')).withMessage(
-    'This caption file is not supported or too large. Please, make sure it is of the following type : '
-    + CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME.join(', ')
+    .custom((_, { req }) => isVideoCaptionFile(req.files, 'captionfile')).withMessage(
+    `This caption file is not supported or too large. Please, make sure it is under ${CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE} and one of the following mimetypes: `
+    + Object.keys(MIMETYPES.VIDEO_CAPTIONS.MIMETYPE_EXT).map(key => `${key} (${MIMETYPES.VIDEO_CAPTIONS.MIMETYPE_EXT[key]})`).join(', ')
   ),
 
   async (req: express.Request, res: express.Response, next: express.NextFunction) => {

diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index a193bebab981ea5b66d2fa1ac660d16c764999f1..9c56bb27af46aa5b8de4ff0f6112dc566fa2962e 100644 (file)
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1292,7 +1292,7 @@ paths:
                   format: binary
             encoding:
               captionfile:
-                contentType: text/vtt, application/x-subrip
+                contentType: text/vtt, application/x-subrip, text/plain
       responses:
         '204':
           $ref: '#/paths/~1users~1me/put/responses/204'