support/doc/api/videos.yaml

   1 parameters:
   2   id:
   3     name: id
   4     in: path
   5     required: true
   6     type: string
   7     description: 'The video id or uuid'
   8   thumbnailfile:
   9     name: thumbnailfile
  10     in: formData
  11     type: file
  12     description: 'Video thumbnail file'
  13   previewfile:
  14     name: previewfile
  15     in: formData
  16     type: file
  17     description: 'Video preview file'
  18   category:
  19     name: category
  20     in: formData
  21     type: number
  22     description: 'Video category'
  23   licence:
  24     name: licence
  25     in: formData
  26     type: number
  27     description: 'Video licence'
  28   language:
  29     name: language
  30     in: formData
  31     type: string
  32     description: 'Video language'
  33   description:
  34     name: description
  35     in: formData
  36     type: string
  37     description: 'Video description'
  38   waitTranscoding:
  39     name: waitTranscoding
  40     in: formData
  41     type: boolean
  42     description: 'Whether or not we wait transcoding before publish the video'
  43   support:
  44     name: support
  45     in: formData
  46     type: string
  47     description: 'Text describing how to support the video uploader'
  48   nsfw:
  49     name: nsfw
  50     in: formData
  51     type: boolean
  52     description: 'Whether or not this video contains sensitive content'
  53   name:
  54     name: name
  55     in: formData
  56     type: string
  57     description: 'Video name'
  58   tags:
  59     name: tags
  60     in: formData
  61     type: string[]
  62     description: 'Video tags'
  63   commentsEnabled:
  64     name: commentsEnabled
  65     in: formData
  66     type: boolean
  67     description: 'Enable or disable comments for this video'
  68   privacy:
  69     name: privacy
  70     in: formData
  71     type: string
  72     enum: [Public, Unlisted]
  73     description: 'Video privacy'
  74   scheduleUpdate:
  75     name: scheduleUpdate
  76     in: formData
  77     required: false
  78     description: 'Schedule an update at a specific datetime'
  79     properties:
  80       updateAt:
  81         type: dateTime
  82         description: 'When to update the video'
  83         required: true
  84       privacy:
  85         type: string
  86         enum: [Public, Unlisted]
  87         description: 'Video privacy target'