X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fapi%2Fhtml%2Findex.html;h=bf9b6a17bc5cf59db95c37c537c937f9eab73158;hb=330eaf12969ed0f15f93d5dd50599885f62ffbed;hp=bf9430e799bf49792c56a9ee21a1ccc4ea316bf8;hpb=94ff4c2335ace54b36b2bca96f63226ee8f575b1;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html index bf9430e79..bf9b6a17b 100644 --- a/support/doc/api/html/index.html +++ b/support/doc/api/html/index.html @@ -25,7 +25,10 @@ Accounts +
+ Feeds + +
Job
@@ -199,19 +213,19 @@ VideoComment @@ -224,7 +238,8 @@
Schema Definitions
- VideoConstant + VideoConstantNumber + VideoConstantString VideoPrivacy Video VideoAbuse @@ -318,7 +333,7 @@

Accounts

-
+
@@ -330,7 +345,7 @@

GET - /accounts/{id} + /accounts/{name}

@@ -338,55 +353,60 @@
-
id
+
name: + + string + + +
in path
-
- string - -
-

The id of the account

+

The name of the account (chocobozzz or + chocobozzz@peertube.cpy.re for example)

-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -437,6 +457,119 @@ "updatedAt": "string" } } + + + +
+
+
+
+ + +
+ Accounts + +
+ + +

+ + GET + /accounts/{name}/videos + +

+
+
+
+
+
+
name: + + string + + +
+ +
in path
+
+
+

The name of the account (chocobozzz or + chocobozzz@peertube.cpy.re for example)

+
+
+
+
+
+
+
+
+
+
+
+
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": "string",
+    "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"
+    }
+  }
+}
@@ -605,6 +738,98 @@
+

Feeds

+
+ + +
+ Feeds + +
+ + +

+ + GET + /feeds/videos.{format} + +

+
+
+
+
+
+
format: + + string + + xml, + atom, + json + + + xml + +
+ +
in path
+
+
+

The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0

+
+
+
+
+
accountId: + + number + + +
+
in query
+
+
+

The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds

+
+
+
+
+
accountName: + + string + + +
+
in query
+
+
+

The name of the local account to filter to

+
+
+
+
+
+
+
+
+
+
+
+
200 OK
+
+
+

successful operation

+
+
+
+
+
+
Response Content-Types: + application/atom+xml, application/rss+xml, application/json +
+
+
+

Job

@@ -626,55 +851,59 @@
-
state
+
state: + + string + + +
in path
-
- string - -
-

The id of the account

+

The state of the job

-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
count
-
in query
-
- number - +
count: + + number + +
+
in query
-

(no description)

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -779,13 +1008,14 @@
-
host
+
host: + + string + + +
in path
-
- string - -

The host to unfollow

@@ -857,41 +1087,44 @@
-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -1003,41 +1236,44 @@
-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -1221,7 +1457,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -1387,41 +1623,44 @@
-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -1498,54 +1737,10 @@ "displayName": "string", "description": "string", "isLocal": "boolean", - "owner": { - "name": "string", + "ownerAccount": { + "id": "number", "uuid": "string" - }, - "videos": [ - { - "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" - } - } - } - ] + } } ] } @@ -1598,16 +1793,17 @@
-
id
+
id: + + number + + +
in path
-
- string - -
-

The user id

+

The user id

@@ -1622,7 +1818,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -1676,16 +1872,17 @@
-
id
+
id: + + number + + +
in path
-
- string - -
-

The user id

+

The user id

@@ -1750,54 +1947,10 @@ "displayName": "string", "description": "string", "isLocal": "boolean", - "owner": { - "name": "string", + "ownerAccount": { + "id": "number", "uuid": "string" - }, - "videos": [ - { - "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" - } - } - } - ] + } } ] } @@ -1865,16 +2018,17 @@
-
id
+
id: + + number + + +
in path
-
- string - -
-

The user id

+

The user id

@@ -1904,7 +2058,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -2027,54 +2181,10 @@ "displayName": "string", "description": "string", "isLocal": "boolean", - "owner": { - "name": "string", + "ownerAccount": { + "id": "number", "uuid": "string" - }, - "videos": [ - { - "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" - } - } - } - ] + } } ] } @@ -2166,7 +2276,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -2225,7 +2335,7 @@
200 OK
-
+
@@ -2298,13 +2408,14 @@
-
videoId
+
videoId: + + string + + +
in path
-
- string - -

The video id

@@ -2393,41 +2504,44 @@
-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -2488,7 +2602,7 @@ "label": "string" }, "language": { - "id": "number", + "id": "string", "label": "string" }, "privacy": "string", @@ -2602,7 +2716,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -2634,12 +2748,13 @@
-
avatarfile
-
in formData
-
- file - +
avatarfile: + + file + +
+
in formData

The file to upload.

@@ -2730,41 +2845,58 @@
-
start
-
in query
-
- number - +
category: + + number + +
+
in query
-

starting page

+

category id of the video

-
stop
-
in query
-
- number - +
start: + + number + +
+
in query
-

stopping page

+

Offset

-
sort
+
count: + + number + + +
in query
-
- number - +
+
+

Number of items

+
+
+
+
+
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -2825,7 +2957,7 @@ "label": "string" }, "language": { - "id": "number", + "id": "string", "label": "string" }, "privacy": "string", @@ -2884,7 +3016,7 @@
200 OK
-
+
@@ -2942,7 +3074,7 @@
200 OK
-
+
@@ -3000,7 +3132,7 @@
200 OK
-
+
@@ -3058,7 +3190,7 @@
200 OK
-
+
@@ -3111,41 +3243,44 @@
-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -3206,7 +3341,7 @@ "label": "string" }, "language": { - "id": "number", + "id": "string", "label": "string" }, "privacy": "string", @@ -3260,26 +3395,28 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

-
thumbnailfile
-
in formData
-
- file - +
thumbnailfile: + + file + +
+
in formData

Video thumbnail file

@@ -3287,12 +3424,13 @@
-
previewfile
-
in formData
-
- file - +
previewfile: + + file + +
+
in formData

Video preview file

@@ -3300,12 +3438,13 @@
-
category
-
in formData
-
- number - +
category: + + number + +
+
in formData

Video category

@@ -3313,12 +3452,13 @@
-
licence
-
in formData
-
- number - +
licence: + + number + +
+
in formData

Video licence

@@ -3326,12 +3466,13 @@
-
language
-
in formData
-
- number - +
language: + + string + +
+
in formData

Video language

@@ -3339,12 +3480,13 @@
-
description
-
in formData
-
- string - +
description: + + string + +
+
in formData

Video description

@@ -3352,12 +3494,27 @@
-
support
+
waitTranscoding: + + boolean + + +
in formData
-
- string - +
+
+

Whether or not we wait transcoding before publish the video

+
+
+
+
+
support: + + string + +
+
in formData

Text describing how to support the video uploader

@@ -3365,12 +3522,13 @@
-
nsfw
-
in formData
-
- boolean - +
nsfw: + + boolean + +
+
in formData

Whether or not this video contains sensitive content

@@ -3378,12 +3536,13 @@
-
name
-
in formData
-
- string - +
name: + + string + +
+
in formData

Video name

@@ -3391,12 +3550,13 @@
-
tags
-
in formData
-
- string[] - +
tags: + + string[] + +
+
in formData

Video tags

@@ -3404,12 +3564,13 @@
-
commentsEnabled
-
in formData
-
- boolean - +
commentsEnabled: + + boolean + +
+
in formData

Enable or disable comments for this video

@@ -3417,21 +3578,36 @@
-
privacy
-
in formData
-
- string - - Public, - Unlisted +
privacy: + + string + + Public, + Unlisted + + -
+
in formData

Video privacy

+
+
+
scheduleUpdate: + + object + + +
+
in formData
+
+
+

Schedule an update at a specific datetime

+
+
@@ -3478,7 +3654,7 @@ "label": "string" }, "language": { - "id": "number", + "id": "string", "label": "string" }, "privacy": "string", @@ -3553,16 +3729,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -3611,7 +3788,7 @@ "label": "string" }, "language": { - "id": "number", + "id": "string", "label": "string" }, "privacy": "string", @@ -3664,16 +3841,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -3688,7 +3866,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -3742,16 +3920,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -3764,7 +3943,7 @@
200 OK
-
+
@@ -3815,16 +3994,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -3839,7 +4019,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -3871,13 +4051,14 @@
-
videofile
+
videofile: + + file + + +
in formData
-
- file - -

Video file

@@ -3885,13 +4066,28 @@
-
thumbnailfile
+
channelId: + + number + + +
in formData
-
- file - +
+
+

Channel id that will contain this video

+
+
+
+
+
thumbnailfile: + + file + +
+
in formData

Video thumbnail file

@@ -3899,13 +4095,13 @@
-
previewfile
- -
in formData
-
- file - +
previewfile: + + file + +
+
in formData

Video preview file

@@ -3913,12 +4109,13 @@
-
category
-
in formData
-
- number - +
category: + + number + +
+
in formData

Video category

@@ -3926,12 +4123,13 @@
-
licence
-
in formData
-
- number - +
licence: + + number + +
+
in formData

Video licence

@@ -3939,12 +4137,13 @@
-
language
-
in formData
-
- number - +
language: + + string + +
+
in formData

Video language

@@ -3952,12 +4151,13 @@
-
description
-
in formData
-
- string - +
description: + + string + +
+
in formData

Video description

@@ -3965,40 +4165,41 @@
-
support
-
in formData
-
- string - +
waitTranscoding: + + boolean + +
+
in formData
-

Text describing how to support the video uploader

+

Whether or not we wait transcoding before publish the video

-
channelId
- -
in formData
-
- number - +
support: + + string + +
+
in formData
-

Channel id that will contain this video

+

Text describing how to support the video uploader

-
nsfw
- -
in formData
-
- boolean - +
nsfw: + + boolean + +
+
in formData

Whether or not this video contains sensitive content

@@ -4006,13 +4207,13 @@
-
name
- -
in formData
-
- string - +
name: + + string + +
+
in formData

Video name

@@ -4020,12 +4221,13 @@
-
tags
-
in formData
-
- string[] - +
tags: + + string[] + +
+
in formData

Video tags

@@ -4033,12 +4235,13 @@
-
commentsEnabled
-
in formData
-
- boolean - +
commentsEnabled: + + boolean + +
+
in formData

Enable or disable comments for this video

@@ -4046,23 +4249,36 @@
-
privacy
- -
in formData
-
- string - - Public, - Unlisted, - Private +
privacy: + + string + + Public, + Unlisted + + -
+
in formData

Video privacy

+
+
+
scheduleUpdate: + + object + + +
+
in formData
+
+
+

Schedule an update at a specific datetime

+
+
@@ -4149,41 +4365,44 @@
-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -4306,16 +4525,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -4330,7 +4550,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -4365,7 +4585,7 @@

VideoBlacklist

-
+
@@ -4377,7 +4597,7 @@

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

@@ -4385,16 +4605,17 @@
-
videoId
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -4409,7 +4630,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -4443,7 +4664,7 @@
-
+
@@ -4455,7 +4676,7 @@

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

@@ -4463,16 +4684,17 @@
-
videoId
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -4487,7 +4709,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -4541,41 +4763,44 @@
-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -4665,7 +4890,7 @@

VideoChannel

-
+
@@ -4677,7 +4902,7 @@

GET - /videos/channels + /video-channels

@@ -4685,41 +4910,44 @@
-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -4769,54 +4997,10 @@ "displayName": "string", "description": "string", "isLocal": "boolean", - "owner": { - "name": "string", + "ownerAccount": { + "id": "number", "uuid": "string" - }, - "videos": [ - { - "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" - } - } - } - ] + } } ] @@ -4825,7 +5009,7 @@
-
+
@@ -4837,7 +5021,7 @@

POST - /videos/channels + /video-channels

@@ -4882,7 +5066,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -4916,7 +5100,7 @@
-
+
@@ -4928,7 +5112,7 @@

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

@@ -4936,16 +5120,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video channel id or uuid

@@ -4983,54 +5168,10 @@ "displayName": "string", "description": "string", "isLocal": "boolean", - "owner": { - "name": "string", + "ownerAccount": { + "id": "number", "uuid": "string" - }, - "videos": [ - { - "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" - } - } - } - ] + } } @@ -5038,7 +5179,7 @@
-
+
@@ -5050,7 +5191,7 @@

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

@@ -5074,16 +5215,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video channel id or uuid

@@ -5111,7 +5253,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -5145,7 +5287,7 @@
-
+
@@ -5157,7 +5299,7 @@

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

@@ -5165,16 +5307,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video channel id or uuid

@@ -5189,7 +5332,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -5223,7 +5366,119 @@
-
+
+ + +
+ VideoChannel + +
+ + +

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

+
+
+
+
+
+
id: + + string + + +
+ +
in path
+
+
+

The video channel id or uuid

+
+
+
+
+
+
+
+
+
+
+
+
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": "string",
+    "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"
+    }
+  }
+}
+
+ +
+
+
+
+
@@ -5235,7 +5490,7 @@

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

@@ -5243,16 +5498,18 @@
-
accountId
+
name: + + string + + +
in path
-
- string - -
-

The account id

+

The name of the account (chocobozzz or + chocobozzz@peertube.cpy.re for example)

@@ -5302,54 +5559,10 @@ "displayName": "string", "description": "string", "isLocal": "boolean", - "owner": { - "name": "string", + "ownerAccount": { + "id": "number", "uuid": "string" - }, - "videos": [ - { - "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" - } - } - } - ] + } } ] @@ -5359,7 +5572,7 @@

VideoComment

-
+
@@ -5371,7 +5584,7 @@

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

@@ -5379,55 +5592,59 @@
-
videoId
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

-
start
-
in query
-
- number - +
start: + + number + +
+
in query
-

starting page

+

Offset

-
stop
-
in query
-
- number - +
count: + + number + +
+
in query
-

stopping page

+

Number of items

-
sort
-
in query
-
- number - +
sort: + + string + +
+
in query
-

sorting

+

Sort column (-createdAt for example)

@@ -5500,7 +5717,7 @@
-
+
@@ -5512,7 +5729,7 @@

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

@@ -5520,16 +5737,17 @@
-
videoId
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -5621,7 +5839,7 @@
-
+
@@ -5633,7 +5851,7 @@

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

@@ -5641,30 +5859,32 @@
-
videoId
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

-
threadId
+
threadId: + + number + + +
in path
-
- string - -
-

The thread id

+

The thread id (root comment id)

@@ -5797,7 +6017,7 @@
-
+
@@ -5809,7 +6029,7 @@

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

@@ -5817,30 +6037,32 @@
-
videoId
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

-
commentId
+
threadId: + + number + + +
in path
-
- string - -
-

The comment id

+

The comment id

@@ -5932,7 +6154,7 @@
-
+
@@ -5944,7 +6166,7 @@

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

@@ -5952,30 +6174,32 @@
-
videoId
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

-
commentId
+
threadId: + + number + + +
in path
-
- string - -
-

The comment id

+

The comment id

@@ -5990,7 +6214,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -6045,16 +6269,17 @@
-
id
+
id: + + string + + +
in path
-
- string - -
-

The video id

+

The video id or uuid

@@ -6069,7 +6294,7 @@
204 No Content
-

successful operation

+

Successful operation

@@ -6104,10 +6329,11 @@

Schema Definitions

-
+

- VideoConstant: - + +

+
+
+
+

+ VideoConstantString: + +

+
+
+
+
+
+ id: + string + +
+
+ label: + string + +
+
+
+
+
+
+
Example
+ 
{
+  "id": "string",
+  "label": "string"
+}
@@ -6146,7 +6412,8 @@

VideoPrivacy: string - @@ -6647,7 +6942,8 @@

VideoComment: -