diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html index 700b2a423..59c982546 100644 --- a/support/doc/api/html/index.html +++ b/support/doc/api/html/index.html @@ -224,6 +224,7 @@
Schema Definitions
VideoConstant + VideoPrivacy Video VideoAbuse VideoBlacklist @@ -1223,7 +1224,8 @@
- undefined + +

User to create

@@ -1431,6 +1433,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -1444,6 +1447,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -1454,7 +1458,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] } @@ -1638,6 +1653,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -1651,6 +1667,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -1661,7 +1678,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] } @@ -1852,6 +1880,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -1865,6 +1894,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -1875,7 +1905,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] } @@ -2197,6 +2238,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -2210,6 +2252,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -2220,7 +2263,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] @@ -2489,6 +2543,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -2502,6 +2557,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -2512,7 +2568,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] @@ -2836,6 +2903,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -2849,6 +2917,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -2859,7 +2928,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] @@ -2892,7 +2972,7 @@
-

The video id

+

The video id

@@ -2906,6 +2986,239 @@
in
path
+
+
+
thumbnailfile
+
+
+

Video thumbnail file

+
+
+
+
type
+
+ file + +
+
+
+
in
+
formData
+
+
+
+
previewfile
+
+
+

Video preview file

+
+
+
+
type
+
+ file + +
+
+
+
in
+
formData
+
+
+
+
category
+
+
+

Video category

+
+
+
+
type
+
+ number + +
+
+
+
in
+
formData
+
+
+
+
licence
+
+
+

Video licence

+
+
+
+
type
+
+ number + +
+
+
+
in
+
formData
+
+
+
+
language
+
+
+

Video language

+
+
+
+
type
+
+ number + +
+
+
+
in
+
formData
+
+
+
+
description
+
+
+

Video description

+
+
+
+
type
+
+ string + +
+
+
+
in
+
formData
+
+
+
+
support
+
+
+

Text describing how to support the video uploader

+
+
+
+
type
+
+ string + +
+
+
+
in
+
formData
+
+
+
+
nsfw
+
+
+

Whether or not this video contains sensitive content

+
+
+
+
type
+
+ boolean + +
+
+
+
in
+
formData
+
+
+
+
name
+
+
+

Video name

+
+
+
+
type
+
+ string + +
+
+
+
in
+
formData
+
+
+
+
tags
+
+
+

Video tags

+
+
+
+
type
+
+ string[] + +
+
+
+
in
+
formData
+
+
+
+
commentsEnabled
+
+
+

Enable or disable comments for this video

+
+
+
+
type
+
+ boolean + +
+
+
+
in
+
formData
+
+
+
+
privacy
+
+
+

Video privacy

+
+
+
+
type
+
+ string + + Public, + Unlisted, + Private + + +
+
+
+
in
+
formData
+
@@ -2941,6 +3254,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -2954,6 +3268,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -2964,7 +3279,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } @@ -3045,6 +3371,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -3058,6 +3385,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -3068,7 +3396,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } @@ -3293,9 +3632,10 @@
videofile
+
-

The file to upload.

+

Video file

@@ -3309,6 +3649,264 @@
in
formData
+
+
+
thumbnailfile
+ +
+
+

Video thumbnail file

+
+
+
+
type
+
+ file + +
+
+
+
in
+
formData
+
+
+
+
previewfile
+ +
+
+

Video preview file

+
+
+
+
type
+
+ file + +
+
+
+
in
+
formData
+
+
+
+
category
+
+
+

Video category

+
+
+
+
type
+
+ number + +
+
+
+
in
+
formData
+
+
+
+
licence
+
+
+

Video licence

+
+
+
+
type
+
+ number + +
+
+
+
in
+
formData
+
+
+
+
language
+
+
+

Video language

+
+
+
+
type
+
+ number + +
+
+
+
in
+
formData
+
+
+
+
description
+
+
+

Video description

+
+
+
+
type
+
+ string + +
+
+
+
in
+
formData
+
+
+
+
support
+
+
+

Text describing how to support the video uploader

+
+
+
+
type
+
+ string + +
+
+
+
in
+
formData
+
+
+
+
channelId
+ +
+
+

Channel id that will contain this video

+
+
+
+
type
+
+ number + +
+
+
+
in
+
formData
+
+
+
+
nsfw
+ +
+
+

Whether or not this video contains sensitive content

+
+
+
+
type
+
+ boolean + +
+
+
+
in
+
formData
+
+
+
+
name
+ +
+
+

Video name

+
+
+
+
type
+
+ string + +
+
+
+
in
+
formData
+
+
+
+
tags
+
+
+

Video tags

+
+
+
+
type
+
+ string[] + +
+
+
+
in
+
formData
+
+
+
+
commentsEnabled
+
+
+

Enable or disable comments for this video

+
+
+
+
type
+
+ boolean + +
+
+
+
in
+
formData
+
+
+
+
privacy
+ +
+
+

Video privacy

+
+
+
+
type
+
+ string + + Public, + Unlisted, + Private + + +
+
+
+
in
+
formData
+
@@ -3341,8 +3939,10 @@ (200 OK) 
{
-  "id": "number",
-  "uuid": "string"
+  "video": {
+    "id": "number",
+    "uuid": "string"
+  }
 }
@@ -3478,6 +4078,12 @@ "updatedAt": "string" } }, + "video": { + "id": "number", + "name": "string", + "uuid": "string", + "url": "string" + }, "createdAt": "string" } ] @@ -3923,6 +4529,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -3936,6 +4543,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -3946,7 +4554,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] } @@ -4107,6 +4726,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -4120,6 +4740,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -4130,7 +4751,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] } @@ -4375,6 +5007,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -4388,6 +5021,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -4398,7 +5032,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] } @@ -5178,6 +5823,31 @@ +
+

+ VideoPrivacy: string + +

+
+
+ string + + Public, + Unlisted, + Private + + +
+
+

Video: @@ -5206,6 +5876,11 @@ string +
+ publishedAt: + string + +
updatedAt: string @@ -5238,6 +5913,15 @@
+
+ privacy: + + + VideoPrivacy + + + +
description: string @@ -5308,6 +5992,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -5321,6 +6006,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -5331,7 +6017,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } @@ -5407,6 +6104,12 @@ "updatedAt": "string" } }, + "video": { + "id": "number", + "name": "string", + "uuid": "string", + "url": "string" + }, "createdAt": "string" } @@ -5575,6 +6278,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -5588,6 +6292,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -5598,7 +6303,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] } @@ -6172,6 +6888,7 @@ "id": "number", "uuid": "string", "createdAt": "string", + "publishedAt": "string", "updatedAt": "string", "category": { "id": "number", @@ -6185,6 +6902,7 @@ "id": "number", "label": "string" }, + "privacy": "string", "description": "string", "duration": "number", "isLocal": "boolean", @@ -6195,7 +6913,18 @@ "views": "number", "likes": "number", "dislikes": "number", - "nsfw": "boolean" + "nsfw": "boolean", + "account": { + "name": "string", + "displayName": "string", + "url": "string", + "host": "string", + "avatar": { + "path": "string", + "createdAt": "string", + "updatedAt": "string" + } + } } ] } @@ -6521,14 +7250,9 @@
-
- id: - number - -
-
- uuid: - string +
+ video: + object
@@ -6538,8 +7262,10 @@
Example
{
-  "id": "number",
-  "uuid": "string"
+  "video": {
+    "id": "number",
+    "uuid": "string"
+  }
 }
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 44b437c40..86dfae69d 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml @@ -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: