From 61b66b361f3e5f6d507188517461c2791d0600e5 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Fri, 6 Apr 2018 10:17:06 +0200 Subject: Upgrade api doc --- support/doc/api/html/index.html | 1300 ++++++++++++++++++++++++++++++--------- 1 file changed, 1013 insertions(+), 287 deletions(-) (limited to 'support/doc/api/html') 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,213 +2986,606 @@
in
path
- - -
- -
-
-
-
200 OK
-
- - Video - -
- +
thumbnailfile
-

successful operation

+

Video thumbnail file

-
-
-
-
Response Content-Types: - application/json -
-
-
Response Example - (200 OK) -
- 
{
-  "id": "number",
-  "uuid": "string",
-  "createdAt": "string",
-  "updatedAt": "string",
-  "category": {
-    "id": "number",
-    "label": "string"
-  },
-  "licence": {
-    "id": "number",
-    "label": "string"
-  },
-  "language": {
-    "id": "number",
-    "label": "string"
-  },
-  "description": "string",
-  "duration": "number",
-  "isLocal": "boolean",
-  "name": "string",
-  "thumbnailPath": "string",
-  "previewPath": "string",
-  "embedPath": "string",
-  "views": "number",
-  "likes": "number",
-  "dislikes": "number",
-  "nsfw": "boolean"
-}
-
- -
-
-
- -
- - -
- Video - -
- - -

- - GET - /videos/{id} - -

-
-
-
+
+
type
+
+ file + +
+
+
+
in
+
formData
+
-
id
- +
previewfile
-

The video id

+

Video preview file

type
- string + file
in
-
path
+
formData
-
-
-
-
-
-
-
-
200 OK
-
- - Video - -
- +
category
-

successful operation

+

Video category

-
-
-
-
Response Content-Types: - application/json -
-
-
Response Example - (200 OK) -
- 
{
-  "id": "number",
-  "uuid": "string",
-  "createdAt": "string",
-  "updatedAt": "string",
-  "category": {
-    "id": "number",
-    "label": "string"
-  },
-  "licence": {
-    "id": "number",
-    "label": "string"
-  },
-  "language": {
-    "id": "number",
-    "label": "string"
-  },
-  "description": "string",
-  "duration": "number",
-  "isLocal": "boolean",
-  "name": "string",
-  "thumbnailPath": "string",
-  "previewPath": "string",
-  "embedPath": "string",
-  "views": "number",
-  "likes": "number",
-  "dislikes": "number",
-  "nsfw": "boolean"
-}
-
- -
-
-
-
-
- - -
- Video - -
- - -

- - DELETE - /videos/{id} - -

-
-
-
+
+
type
+
+ number + +
+
+
+
in
+
formData
+
-
id
- +
licence
-

The video id

+

Video licence

type
- string + number
in
-
path
+
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
+
+
+
+
+
+
+
+
+
+
+
200 OK
+
+ + Video + +
+ +
+
+

successful operation

+
+
+
+
+
+
Response Content-Types: + application/json +
+
+
Response Example + (200 OK) +
+ 
{
+  "id": "number",
+  "uuid": "string",
+  "createdAt": "string",
+  "publishedAt": "string",
+  "updatedAt": "string",
+  "category": {
+    "id": "number",
+    "label": "string"
+  },
+  "licence": {
+    "id": "number",
+    "label": "string"
+  },
+  "language": {
+    "id": "number",
+    "label": "string"
+  },
+  "privacy": "string",
+  "description": "string",
+  "duration": "number",
+  "isLocal": "boolean",
+  "name": "string",
+  "thumbnailPath": "string",
+  "previewPath": "string",
+  "embedPath": "string",
+  "views": "number",
+  "likes": "number",
+  "dislikes": "number",
+  "nsfw": "boolean",
+  "account": {
+    "name": "string",
+    "displayName": "string",
+    "url": "string",
+    "host": "string",
+    "avatar": {
+      "path": "string",
+      "createdAt": "string",
+      "updatedAt": "string"
+    }
+  }
+}
+
+ +
+
+
+
+
+ + +
+ Video + +
+ + +

+ + GET + /videos/{id} + +

+
+
+
+
+
+
id
+ +
+
+

The video id

+
+
+
+
type
+
+ string + +
+
+
+
in
+
path
+
+
+
+
+
+
+
+
+
+
+
200 OK
+
+ + Video + +
+ +
+
+

successful operation

+
+
+
+
+
+
Response Content-Types: + application/json +
+
+
Response Example + (200 OK) +
+ 
{
+  "id": "number",
+  "uuid": "string",
+  "createdAt": "string",
+  "publishedAt": "string",
+  "updatedAt": "string",
+  "category": {
+    "id": "number",
+    "label": "string"
+  },
+  "licence": {
+    "id": "number",
+    "label": "string"
+  },
+  "language": {
+    "id": "number",
+    "label": "string"
+  },
+  "privacy": "string",
+  "description": "string",
+  "duration": "number",
+  "isLocal": "boolean",
+  "name": "string",
+  "thumbnailPath": "string",
+  "previewPath": "string",
+  "embedPath": "string",
+  "views": "number",
+  "likes": "number",
+  "dislikes": "number",
+  "nsfw": "boolean",
+  "account": {
+    "name": "string",
+    "displayName": "string",
+    "url": "string",
+    "host": "string",
+    "avatar": {
+      "path": "string",
+      "createdAt": "string",
+      "updatedAt": "string"
+    }
+  }
+}
+
+ +
+
+
+
+
+ + +
+ Video + +
+ + +

+ + DELETE + /videos/{id} + +

+
+
+
+
+
+
id
+ +
+
+

The video id

+
+
+
+
type
+
+ string + +
+
+
+
in
+
path
+
+
+
+
+
+
+
+
+
+
+
204 No Content
+
+
+

successful operation

+
+
+
+
+
+
Response Content-Types: + application/json +
+
+
+
+
+ + +
+ Video + +
+ + +

+ + GET + /videos/{id}/description + +

+
+
+
+
+
+
id
+ +
+
+

The video id

+
+
+
+
type
+
+ string + +
+
+
+
in
+
path
+
+
+
+
+
+
+
+
+
+
+
200 OK
+
+ +
+
+

successful operation

+
+
+
+
+
+
Response Content-Types: + application/json +
+
+
Response Example + (200 OK) +
+ 
"string"
+
+ +
+
+
+
+
+ + +
+ Video + +
+ + +

+ + POST + /videos/{id}/views + +

+
+
+
+
+
+
id
+ +
+
+

The video id

+
+
+
+
type
+
+ string + +
+
+
+
in
+
path
@@ -3138,7 +3611,7 @@
-
+
@@ -3149,8 +3622,8 @@

- GET - /videos/{id}/description + POST + /videos/upload

@@ -3158,83 +3631,206 @@
-
id
+
videofile
+ +
+
+

Video file

+
+
+
+
type
+
+ file + +
+
+
+
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
-

The video id

+

Channel id that will contain this video

type
- string + number
in
-
path
+
formData
-
-
-
-
-
-
-
-
200 OK
-
- +
nsfw
+
-

successful operation

+

Whether or not this video contains sensitive content

-
-
-
-
Response Content-Types: - application/json -
-
-
Response Example - (200 OK) -
- 
"string"
-
- -
-
-
-
-
- - -
- Video - -
- - -

- - POST - /videos/{id}/views - -

-
-
-
+
+
type
+
+ boolean + +
+
+
+
in
+
formData
+
-
id
+
name
-

The video id

+

Video name

@@ -3246,62 +3842,64 @@
in
-
path
+
formData
-
-
-
-
-
-
-
-
204 No Content
+
tags
-

successful operation

+

Video tags

-
-
-
-
Response Content-Types: - application/json -
-
-
-
-
- - -
- Video - -
- - -

- - POST - /videos/upload - -

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

The file to upload.

+

Enable or disable comments for this video

type
- file + boolean + +
+
+
+
in
+
formData
+
+
+
+
privacy
+ +
+
+

Video privacy

+
+
+
+
type
+
+ string + + Public, + Unlisted, + Private +
@@ -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"
+  }
 }
-- cgit v1.2.3