From ab0ee6a14f7edd4cd353636f3648772564146965 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 7 Mar 2018 08:11:38 +0100 Subject: [PATCH] Upgrade api doc html file --- support/doc/api/html/index.html | 1233 ++++++++++++++++++++++++++++--- 1 file changed, 1112 insertions(+), 121 deletions(-) diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html index 9baa091d1..00cecb07a 100644 --- a/support/doc/api/html/index.html +++ b/support/doc/api/html/index.html @@ -109,40 +109,40 @@ Video @@ -150,10 +150,10 @@ VideoAbuse @@ -161,13 +161,13 @@ VideoBlacklist @@ -175,22 +175,22 @@ VideoChannel @@ -198,19 +198,19 @@ VideoComment @@ -218,7 +218,7 @@ VideoRate @@ -238,6 +238,8 @@ Job AddUserResponse VideoUploadResponse + CommentThreadResponse + CommentThreadPostResponse AddUser UpdateUser UpdateMe @@ -308,6 +310,63 @@
in
path
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
@@ -530,7 +589,87 @@
-
+
+
+
+
+
state
+ +
+
+

The id of the account

+
+
+
+
type
+
+ string + +
+
+
+
in
+
path
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
count
+
+
+

(no description)

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -656,7 +795,67 @@
-
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -749,7 +948,67 @@
-
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -1034,7 +1293,67 @@
-
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -1764,7 +2083,67 @@
-
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -1973,26 +2352,86 @@
-
-
-

Video

-
- - -
- Video - -
- - -

- - GET - /video - -

-
-
+
+
+

Video

+
+ + +
+ Video + +
+ + +

+ + GET + /videos + +

+
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -2055,7 +2494,7 @@
-
+
@@ -2067,7 +2506,7 @@

GET - /video/categories + /videos/categories

@@ -2106,7 +2545,7 @@
-
+
@@ -2118,7 +2557,7 @@

GET - /video/licences + /videos/licences

@@ -2157,7 +2596,7 @@
-
+
@@ -2169,7 +2608,7 @@

GET - /video/languages + /videos/languages

@@ -2208,7 +2647,7 @@
-
+
@@ -2220,7 +2659,7 @@

GET - /video/privacies + /videos/privacies

@@ -2259,7 +2698,7 @@
-
+
@@ -2271,11 +2710,71 @@

GET - /video/search + /videos/search

-
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -2338,7 +2837,7 @@
-
+
@@ -2350,7 +2849,7 @@

PUT - /video/{id} + /videos/{id}

@@ -2438,7 +2937,7 @@
-
+
@@ -2450,7 +2949,7 @@

GET - /video/{id} + /videos/{id}

@@ -2538,7 +3037,7 @@
-
+
@@ -2550,7 +3049,7 @@

DELETE - /video/{id} + /videos/{id}

@@ -2600,7 +3099,7 @@
-
+
@@ -2612,7 +3111,7 @@

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

@@ -2672,7 +3171,7 @@
-
+
@@ -2684,7 +3183,7 @@

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

@@ -2734,7 +3233,7 @@
-
+
@@ -2746,7 +3245,7 @@

POST - /video/upload + /videos/upload

@@ -2813,7 +3312,7 @@

VideoAbuse

-
+
@@ -2825,11 +3324,71 @@

GET - /video/abuse + /videos/abuse

-
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -2877,7 +3436,7 @@
-
+
@@ -2889,7 +3448,7 @@

POST - /video/{id}/abuse + /videos/{id}/abuse

@@ -2940,7 +3499,7 @@

VideoBlacklist

-
+
@@ -2952,7 +3511,7 @@

POST - /video/{videoId}/blacklist + /videos/{videoId}/blacklist

@@ -3002,7 +3561,7 @@
-
+
@@ -3014,7 +3573,7 @@

DELETE - /video/{videoId}/blacklist + /videos/{videoId}/blacklist

@@ -3064,7 +3623,7 @@
-
+
@@ -3076,11 +3635,71 @@

GET - /video/blacklist + /videos/blacklist

-
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -3133,7 +3752,7 @@

VideoChannel

-
+
@@ -3145,11 +3764,71 @@

GET - /video/channels + /videos/channels

-
+
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
+
+
+

stoping page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
@@ -3223,7 +3902,7 @@
-
+
@@ -3235,7 +3914,7 @@

POST - /video/channels + /videos/channels

@@ -3291,7 +3970,7 @@
-
+
@@ -3303,7 +3982,7 @@

GET - /video/channels/{id} + /videos/channels/{id}

@@ -3402,7 +4081,7 @@
-
+
@@ -3414,7 +4093,7 @@

PUT - /video/channels/{id} + /videos/channels/{id}

@@ -3492,7 +4171,7 @@
-
+
@@ -3504,7 +4183,7 @@

DELETE - /video/channels/{id} + /videos/channels/{id}

@@ -3554,7 +4233,7 @@
-
+
@@ -3566,7 +4245,7 @@

GET - /video/accounts/{accountId}/channels + /videos/accounts/{accountId}/channels

@@ -3668,7 +4347,7 @@

VideoComment

-
+
@@ -3680,7 +4359,7 @@

GET - /video/{videoId}/comment-threads + /videos/{videoId}/comment-threads

@@ -3688,23 +4367,80 @@
-
videoId
- +
videoId
+ +
+
+

The video id

+
+
+
+
type
+
+ string + +
+
+
+
in
+
path
+
+
+
+
start
+
+
+

starting page

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
+
+
+
+
stop
-

The video id

+

stoping page

type
- string + number
in
-
path
+
query
+
+
+
+
sort
+
+
+

sorting

+
+
+
+
type
+
+ number + +
+
+
+
in
+
query
@@ -3718,7 +4454,7 @@
200 OK
- VideoComment + CommentThreadResponse
@@ -3737,13 +4473,46 @@
Response Example (200 OK)
- + 
{
+  "total": "number",
+  "data": [
+    {
+      "id": "number",
+      "url": "string",
+      "text": "string",
+      "threadId": "number",
+      "inReplyToCommentId": "number",
+      "videoId": "number",
+      "createdAt": "string",
+      "updatedAt": "string",
+      "totalReplies": "number",
+      "account": {
+        "displayName": "string",
+        "id": "number",
+        "uuid": "string",
+        "url": "string",
+        "name": "string",
+        "host": "string",
+        "followingCount": "number",
+        "followersCount": "number",
+        "createdAt": "string",
+        "updatedAt": "string",
+        "avatar": {
+          "path": "string",
+          "createdAt": "string",
+          "updatedAt": "string"
+        }
+      }
+    }
+  ]
+}
+
-
+
@@ -3755,7 +4524,7 @@

POST - /video/{videoId}/comment-threads + /videos/{videoId}/comment-threads

@@ -3791,6 +4560,12 @@
200 OK
+
+ + CommentThreadPostResponse + +
+

successful operation

@@ -3802,10 +4577,47 @@
Response Content-Types: application/json
+
+
Response Example + (200 OK) +
+ 
{
+  "comment": {
+    "id": "number",
+    "url": "string",
+    "text": "string",
+    "threadId": "number",
+    "inReplyToCommentId": "number",
+    "videoId": "number",
+    "createdAt": "string",
+    "updatedAt": "string",
+    "totalReplies": "number",
+    "account": {
+      "displayName": "string",
+      "id": "number",
+      "uuid": "string",
+      "url": "string",
+      "name": "string",
+      "host": "string",
+      "followingCount": "number",
+      "followersCount": "number",
+      "createdAt": "string",
+      "updatedAt": "string",
+      "avatar": {
+        "path": "string",
+        "createdAt": "string",
+        "updatedAt": "string"
+      }
+    }
+  }
+}
+
+ +
-
+
@@ -3817,7 +4629,7 @@

GET - /video/{videoId}/comment-threads/{threadId} + /videos/{videoId}/comment-threads/{threadId}

@@ -3993,7 +4805,7 @@
-
+
@@ -4005,7 +4817,7 @@

POST - /video/{videoId}/comments/{commentId} + /videos/{videoId}/comments/{commentId}

@@ -4061,6 +4873,12 @@
200 OK
+
+ + CommentThreadPostResponse + +
+

successful operation

@@ -4072,10 +4890,47 @@
Response Content-Types: application/json
+
+
Response Example + (200 OK) +
+ 
{
+  "comment": {
+    "id": "number",
+    "url": "string",
+    "text": "string",
+    "threadId": "number",
+    "inReplyToCommentId": "number",
+    "videoId": "number",
+    "createdAt": "string",
+    "updatedAt": "string",
+    "totalReplies": "number",
+    "account": {
+      "displayName": "string",
+      "id": "number",
+      "uuid": "string",
+      "url": "string",
+      "name": "string",
+      "host": "string",
+      "followingCount": "number",
+      "followersCount": "number",
+      "createdAt": "string",
+      "updatedAt": "string",
+      "avatar": {
+        "path": "string",
+        "createdAt": "string",
+        "updatedAt": "string"
+      }
+    }
+  }
+}
+
+ +
-
+
@@ -4087,7 +4942,7 @@

DELETE - /video/{videoId}/comments/{commentId} + /videos/{videoId}/comments/{commentId}

@@ -4158,7 +5013,7 @@

VideoRate

-
+
@@ -4170,7 +5025,7 @@

PUT - /video/{id}/rate + /videos/{id}/rate

@@ -5579,6 +6434,142 @@ "id": "number", "uuid": "string" } + + + +
+
+
+
+

+ CommentThreadResponse: + +

+
+
+
+
+
+ total: + number + +
+
+ data: + + + VideoComment + + + +
+
+
+
+
+
+
Example
+ 
{
+  "total": "number",
+  "data": [
+    {
+      "id": "number",
+      "url": "string",
+      "text": "string",
+      "threadId": "number",
+      "inReplyToCommentId": "number",
+      "videoId": "number",
+      "createdAt": "string",
+      "updatedAt": "string",
+      "totalReplies": "number",
+      "account": {
+        "displayName": "string",
+        "id": "number",
+        "uuid": "string",
+        "url": "string",
+        "name": "string",
+        "host": "string",
+        "followingCount": "number",
+        "followersCount": "number",
+        "createdAt": "string",
+        "updatedAt": "string",
+        "avatar": {
+          "path": "string",
+          "createdAt": "string",
+          "updatedAt": "string"
+        }
+      }
+    }
+  ]
+}
+
+ +
+
+
+
+
+

+ CommentThreadPostResponse: + +

+
+
+
+
+
+ comment: + + + VideoComment + + + +
+
+
+
+
+
+
Example
+ 
{
+  "comment": {
+    "id": "number",
+    "url": "string",
+    "text": "string",
+    "threadId": "number",
+    "inReplyToCommentId": "number",
+    "videoId": "number",
+    "createdAt": "string",
+    "updatedAt": "string",
+    "totalReplies": "number",
+    "account": {
+      "displayName": "string",
+      "id": "number",
+      "uuid": "string",
+      "url": "string",
+      "name": "string",
+      "host": "string",
+      "followingCount": "number",
+      "followersCount": "number",
+      "createdAt": "string",
+      "updatedAt": "string",
+      "avatar": {
+        "path": "string",
+        "createdAt": "string",
+        "updatedAt": "string"
+      }
+    }
+  }
+}
-- 2.25.1