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