Upgrade api doc
This commit is contained in:
Chocobozzz
parent
f37bad639b
commit
61b66b361f
File diff suppressed because it is too large
Load Diff
|
|
@ -31,7 +31,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -141,7 +141,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -172,7 +172,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -212,6 +212,7 @@ paths:
|
|||
- in: body
|
||||
name: body
|
||||
required: true
|
||||
description: 'User to create'
|
||||
schema:
|
||||
$ref: '#/definitions/AddUser'
|
||||
responses:
|
||||
|
|
@ -236,7 +237,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -387,7 +388,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -453,7 +454,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -544,7 +545,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -562,7 +563,7 @@ paths:
|
|||
tags:
|
||||
- Video
|
||||
consumes:
|
||||
- application/json
|
||||
- multipart/form-data
|
||||
produces:
|
||||
- application/json
|
||||
parameters:
|
||||
|
|
@ -570,7 +571,56 @@ paths:
|
|||
in: path
|
||||
required: true
|
||||
type: string
|
||||
description: 'The video id '
|
||||
description: 'The video id'
|
||||
- name: thumbnailfile
|
||||
in: formData
|
||||
type: file
|
||||
description: 'Video thumbnail file'
|
||||
- name: previewfile
|
||||
in: formData
|
||||
type: file
|
||||
description: 'Video preview file'
|
||||
- name: category
|
||||
in: formData
|
||||
type: number
|
||||
description: 'Video category'
|
||||
- name: licence
|
||||
in: formData
|
||||
type: number
|
||||
description: 'Video licence'
|
||||
- name: language
|
||||
in: formData
|
||||
type: number
|
||||
description: 'Video language'
|
||||
- name: description
|
||||
in: formData
|
||||
type: string
|
||||
description: 'Video description'
|
||||
- name: support
|
||||
in: formData
|
||||
type: string
|
||||
description: 'Text describing how to support the video uploader'
|
||||
- name: nsfw
|
||||
in: formData
|
||||
type: boolean
|
||||
description: 'Whether or not this video contains sensitive content'
|
||||
- name: name
|
||||
in: formData
|
||||
type: string
|
||||
description: 'Video name'
|
||||
- name: tags
|
||||
in: formData
|
||||
type: string[]
|
||||
description: 'Video tags'
|
||||
- name: commentsEnabled
|
||||
in: formData
|
||||
type: boolean
|
||||
description: 'Enable or disable comments for this video'
|
||||
- name: privacy
|
||||
in: formData
|
||||
type: string
|
||||
enum: [Public, Unlisted, Private]
|
||||
description: 'Video privacy'
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
|
|
@ -655,10 +705,70 @@ paths:
|
|||
produces:
|
||||
- application/json
|
||||
parameters:
|
||||
- in: formData
|
||||
name: videofile
|
||||
- name: videofile
|
||||
in: formData
|
||||
type: file
|
||||
description: The file to upload.
|
||||
required: true
|
||||
description: 'Video file'
|
||||
- name: thumbnailfile
|
||||
in: formData
|
||||
type: file
|
||||
required: true
|
||||
description: 'Video thumbnail file'
|
||||
- name: previewfile
|
||||
in: formData
|
||||
type: file
|
||||
required: true
|
||||
description: 'Video preview file'
|
||||
- name: category
|
||||
in: formData
|
||||
type: number
|
||||
description: 'Video category'
|
||||
- name: licence
|
||||
in: formData
|
||||
type: number
|
||||
description: 'Video licence'
|
||||
- name: language
|
||||
in: formData
|
||||
type: number
|
||||
description: 'Video language'
|
||||
- name: description
|
||||
in: formData
|
||||
type: string
|
||||
description: 'Video description'
|
||||
- name: support
|
||||
in: formData
|
||||
type: string
|
||||
description: 'Text describing how to support the video uploader'
|
||||
- name: channelId
|
||||
in: formData
|
||||
required: true
|
||||
type: number
|
||||
description: 'Channel id that will contain this video'
|
||||
- name: nsfw
|
||||
in: formData
|
||||
required: true
|
||||
type: boolean
|
||||
description: 'Whether or not this video contains sensitive content'
|
||||
- name: name
|
||||
in: formData
|
||||
required: true
|
||||
type: string
|
||||
description: 'Video name'
|
||||
- name: tags
|
||||
in: formData
|
||||
type: string[]
|
||||
description: 'Video tags'
|
||||
- name: commentsEnabled
|
||||
in: formData
|
||||
type: boolean
|
||||
description: 'Enable or disable comments for this video'
|
||||
- name: privacy
|
||||
in: formData
|
||||
required: true
|
||||
type: string
|
||||
enum: [Public, Unlisted, Private]
|
||||
description: 'Video privacy'
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
|
|
@ -682,7 +792,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -763,7 +873,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -794,7 +904,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -921,7 +1031,7 @@ paths:
|
|||
in: query
|
||||
required: false
|
||||
type: number
|
||||
description: 'stoping page'
|
||||
description: 'stopping page'
|
||||
- name: sort
|
||||
in: query
|
||||
required: false
|
||||
|
|
@ -1043,6 +1153,9 @@ definitions:
|
|||
type: number
|
||||
label:
|
||||
type: string
|
||||
VideoPrivacy:
|
||||
type: string
|
||||
enum: [Public, Unlisted, Private]
|
||||
Video:
|
||||
properties:
|
||||
id:
|
||||
|
|
@ -1051,6 +1164,8 @@ definitions:
|
|||
type: string
|
||||
createdAt:
|
||||
type: string
|
||||
publishedAt:
|
||||
type: string
|
||||
updatedAt:
|
||||
type: string
|
||||
category:
|
||||
|
|
@ -1059,6 +1174,8 @@ definitions:
|
|||
$ref: "#/definitions/VideoConstant"
|
||||
language:
|
||||
$ref: "#/definitions/VideoConstant"
|
||||
privacy:
|
||||
$ref: "#/definitions/VideoPrivacy"
|
||||
description:
|
||||
type: string
|
||||
duration:
|
||||
|
|
@ -1082,12 +1199,18 @@ definitions:
|
|||
nsfw:
|
||||
type: boolean
|
||||
account:
|
||||
name: string
|
||||
displayName: string
|
||||
url: string
|
||||
host: string
|
||||
avatar:
|
||||
$ref: "#/definitions/Avatar"
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
displayName:
|
||||
type: string
|
||||
url:
|
||||
type: string
|
||||
host:
|
||||
type: string
|
||||
avatar:
|
||||
$ref: "#/definitions/Avatar"
|
||||
VideoAbuse:
|
||||
properties:
|
||||
id:
|
||||
|
|
@ -1097,10 +1220,16 @@ definitions:
|
|||
reporterAccount:
|
||||
$ref: "#/definitions/Account"
|
||||
video:
|
||||
id: number
|
||||
name: string
|
||||
uuid: string
|
||||
url: string
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
name:
|
||||
type: string
|
||||
uuid:
|
||||
type: string
|
||||
url:
|
||||
type: string
|
||||
createdAt:
|
||||
type: string
|
||||
VideoBlacklist:
|
||||
|
|
@ -1314,7 +1443,7 @@ definitions:
|
|||
updatedAt:
|
||||
type: string
|
||||
|
||||
#Api responses
|
||||
# Api responses
|
||||
AddUserResponse:
|
||||
properties:
|
||||
id:
|
||||
|
|
@ -1323,10 +1452,13 @@ definitions:
|
|||
type: string
|
||||
VideoUploadResponse:
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
uuid:
|
||||
type: string
|
||||
video:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
uuid:
|
||||
type: string
|
||||
CommentThreadResponse:
|
||||
properties:
|
||||
total:
|
||||
|
|
@ -1340,7 +1472,7 @@ definitions:
|
|||
comment:
|
||||
$ref: "#/definitions/VideoComment"
|
||||
|
||||
#request bodies
|
||||
# Request bodies
|
||||
AddUser:
|
||||
properties:
|
||||
username:
|
||||
|
|
|
|||
Loading…
Reference in New Issue