X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fapi%2Fhtml%2Findex.html;h=24017e674ad059eaf0b482b1995bf3997be69fe2;hb=aa1c3d929f524f57930f8bb0ae8b07e8b51f9952;hp=00cecb07a5e42d52c1b8ca7d5b1abf1e8f40d79e;hpb=ab0ee6a14f7edd4cd353636f3648772564146965;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html
index 00cecb07a..24017e674 100644
--- a/support/doc/api/html/index.html
+++ b/support/doc/api/html/index.html
@@ -17,14 +17,18 @@
Ã
@@ -254,25 +273,68 @@
+ PeerTube
+ API Reference
+
-
PeerTube
- API Reference
-
Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
+ API Endpoint
+ https://peertube.example.com/api/v1
+
+ Schemes:
+ https
+
Version:
- 0.0.15-alpha
+ 1.0.0-beta
Authentication
+
+
+
+
+ OAuth2
+
+
+
+ In the header:
+ Authorization: Bearer mytoken
+
+
+
+
+
+
+
+
https://peertube.example.com/api/v1/users/token
+
+
+
+
Accounts
-
+
+
+
+
+
+
+
+
+ GET
+ /accounts/{name}/videos
+
+
+
+
+
+
+
+
name
+
+
in path
+
+ string
+
+
+
+
+
+
+
+
+
+
+
+
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"
+ }
+ }
+}
@@ -457,6 +608,17 @@
successful operation
+
@@ -572,12 +734,12 @@
Job
-
+
Feeds
+
-
ServerFollowing
-
+
Job
+
- DELETE
- /server/following/{host}
+ GET
+ /jobs
@@ -737,23 +844,170 @@
-
host
+
state
+
in path
+
+ string
+
+
-
The host to unfollow
+
The id of the account
+
+
+
+
+
start
+
in query
+
+ number
+
+
+
+
+
+
+
count
+
in query
+
+ number
+
+
+
+
+
+
+
sort
+
in query
+
+ number
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
Response Content-Types:
+ application/json
+
+
+ Response Example
+ (200 OK)
+
+ [
+ {
+ "id": "number",
+ "state": "string",
+ "category": "string",
+ "handlerName": "string",
+ "handlerInputData": "string",
+ "createdAt": "string",
+ "updatedAt": "string"
+ }
+]
+
+
+
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
+
ServerFollowing
+
+
+
+
+
+
+
+
+ DELETE
+ /server/following/{host}
+
+
+
+
+
+
+
+
host
+
+
in path
+
+ string
+
+
+
+
@@ -778,6 +1032,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -800,60 +1076,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -875,6 +1133,17 @@
successful operation
@@ -953,60 +1222,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -1112,7 +1374,8 @@
- undefined
+
+
undefined
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
User
@@ -1216,7 +1501,8 @@
- undefined
+
+
User to create
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1298,60 +1606,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -1415,37 +1716,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
}
@@ -1455,7 +1729,29 @@
-
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1478,22 +1774,16 @@
id
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1540,22 +1852,16 @@
id
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1685,7 +1986,8 @@
- undefined
+
+
undefined
id
+
in path
+
+ string
+
+
-
-
@@ -1749,6 +2045,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1786,6 +2104,17 @@
successful operation
@@ -1828,37 +2157,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
}
@@ -1868,6 +2170,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1896,7 +2220,8 @@
- undefined
+
+
undefined
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1971,6 +2318,13 @@
successful operation
@@ -1987,6 +2341,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2010,22 +2386,16 @@
videoId
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2088,60 +2480,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -2177,27 +2562,44 @@
{
"id": "number",
"uuid": "string",
- "accountName": "string",
"createdAt": "string",
+ "publishedAt": "string",
"updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
+ "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",
- "serverHost": "string",
"thumbnailPath": "string",
"previewPath": "string",
"embedPath": "string",
"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"
+ }
+ }
}
]
@@ -2205,6 +2607,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2233,7 +2657,8 @@
- undefined
+
+
undefined
avatarfile
+
in formData
+
+ file
+
+
-
-
@@ -2353,6 +2772,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
Video
@@ -2376,60 +2817,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -2465,27 +2899,44 @@
{
"id":
"number",
"uuid":
"string",
-
"accountName":
"string",
"createdAt":
"string",
+
"publishedAt":
"string",
"updatedAt":
"string",
-
"categoryLabel":
"string",
-
"category":
"number",
-
"licenceLabel":
"string",
-
"licence":
"number",
-
"languageLabel":
"string",
-
"language":
"number",
+
"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",
-
"serverHost":
"string",
"thumbnailPath":
"string",
"previewPath":
"string",
"embedPath":
"string",
"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"
+ }
+ }
}
]
@@ -2526,6 +2977,13 @@
successful operation
+
type
+
+ string[]
+
+
+
@@ -2577,6 +3035,13 @@
successful operation
+
type
+
+ string[]
+
+
+
@@ -2628,6 +3093,13 @@
successful operation
+
type
+
+ string[]
+
+
+
@@ -2679,9 +3151,16 @@
successful operation
+
+
type
+
+ string[]
+
+
+
+
+
Response Content-Types:
application/json
@@ -2719,60 +3198,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -2794,6 +3255,17 @@
successful operation
+
@@ -2808,27 +3280,44 @@
{
"id":
"number",
"uuid":
"string",
-
"accountName":
"string",
"createdAt":
"string",
+
"publishedAt":
"string",
"updatedAt":
"string",
-
"categoryLabel":
"string",
-
"category":
"number",
-
"licenceLabel":
"string",
-
"licence":
"number",
-
"languageLabel":
"string",
-
"language":
"number",
+
"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",
-
"serverHost":
"string",
"thumbnailPath":
"string",
"previewPath":
"string",
"embedPath":
"string",
"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"
+ }
+ }
}
]
@@ -2859,21 +3348,201 @@
id
+
in path
+
+ string
+
+
-
The video id
+
The video id
-
type
+
+
+
thumbnailfile
+
in formData
+
+ file
+
+
+
-
string
-
+
Video thumbnail file
-
-
in
-
path
+
+
+
previewfile
+
in formData
+
+ file
+
+
+
+
+
+
+
+
category
+
in formData
+
+ number
+
+
+
+
+
+
+
+
licence
+
in formData
+
+ number
+
+
+
+
+
+
+
+
language
+
in formData
+
+ string
+
+
+
+
+
+
+
+
description
+
in formData
+
+ string
+
+
+
+
+
+
+
+
waitTranscoding
+
in formData
+
+ boolean
+
+
+
+
+
Whether or not we wait transcoding before publish the video
+
+
+
+
+
support
+
in formData
+
+ string
+
+
+
+
+
Text describing how to support the video uploader
+
+
+
+
+
nsfw
+
in formData
+
+ boolean
+
+
+
+
+
Whether or not this video contains sensitive content
+
+
+
+
+
name
+
in formData
+
+ string
+
+
+
+
+
+
+
+
tags
+
in formData
+
+ string[]
+
+
+
+
+
+
+
+
commentsEnabled
+
in formData
+
+ boolean
+
+
+
+
+
Enable or disable comments for this video
+
+
+
+
+
privacy
+
in formData
+
+ string
+
+ Public,
+ Unlisted
+
+
+
+
+
+
+
+
+
scheduleUpdate
+
in formData
+
+ [object Object]
+
+
+
+
@@ -2909,33 +3578,72 @@
{
"id": "number",
"uuid": "string",
- "accountName": "string",
"createdAt": "string",
+ "publishedAt": "string",
"updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
+ "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",
- "serverHost": "string",
"thumbnailPath": "string",
"previewPath": "string",
"embedPath": "string",
"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"
+ }
+ }
}
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2959,22 +3667,16 @@
id
+
in path
+
+ string
+
+
{
"id": "number",
"uuid": "string",
- "accountName": "string",
"createdAt": "string",
+ "publishedAt": "string",
"updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
+ "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",
- "serverHost": "string",
"thumbnailPath": "string",
"previewPath": "string",
"embedPath": "string",
"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"
+ }
+ }
}
@@ -3059,22 +3778,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -3098,6 +3811,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3121,22 +3856,16 @@
id
+
in path
+
+ string
+
+
successful operation
+
@@ -3193,22 +3929,16 @@
id
+
in path
+
+ string
+
+
videofile
+
+
in formData
+
+ file
+
+
-
The file to upload.
+
Video file
-
-
type
+
+
+
thumbnailfile
+
+
in formData
+
+ file
+
+
+
-
file
-
+
Video thumbnail file
-
-
in
-
formData
+
+
+
previewfile
+
+
in formData
+
+ file
+
+
+
+
+
+
+
+
category
+
in formData
+
+ number
+
+
+
+
+
+
+
+
waitTranscoding
+
in formData
+
+ boolean
+
+
+
+
+
Whether or not we wait transcoding before publish the video
+
+
+
+
+
licence
+
in formData
+
+ number
+
+
+
+
+
+
+
+
language
+
in formData
+
+ string
+
+
+
+
+
+
+
+
description
+
in formData
+
+ string
+
+
+
+
+
+
+
+
support
+
in formData
+
+ string
+
+
+
+
+
Text describing how to support the video uploader
+
+
+
+
+
channelId
+
+
in formData
+
+ number
+
+
+
+
+
Channel id that will contain this video
+
+
+
+
+
nsfw
+
+
in formData
+
+ boolean
+
+
+
+
+
Whether or not this video contains sensitive content
+
+
+
+
+
name
+
+
in formData
+
+ string
+
+
+
+
+
+
+
+
tags
+
in formData
+
+ string[]
+
+
+
+
+
+
+
+
commentsEnabled
+
in formData
+
+ boolean
+
+
+
+
+
Enable or disable comments for this video
+
+
+
+
+
privacy
+
+
in formData
+
+ [object Object]
+
+
+
+
+
+
+
+
scheduleUpdate
+
in formData
+
+ [object Object]
+
+
+
+
@@ -3302,14 +4228,38 @@
(200 OK)
{
- "id": "number",
- "uuid": "string"
+ "video": {
+ "id": "number",
+ "uuid": "string"
+ }
}
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoAbuse
@@ -3333,60 +4283,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -3422,11 +4365,29 @@
{
"id": "number",
"reason": "string",
- "reporterUsername": "string",
- "reporterServerHost": "string",
- "videoId": "number",
- "videoUUID": "string",
- "videoName": "string",
+ "reporterAccount": {
+ "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"
+ }
+ },
+ "video": {
+ "id": "number",
+ "name": "string",
+ "uuid": "string",
+ "url": "string"
+ },
"createdAt": "string"
}
]
@@ -3435,6 +4396,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3458,22 +4441,16 @@
id
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoBlacklist
@@ -3521,22 +4520,16 @@
videoId
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3583,22 +4598,16 @@
videoId
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3644,60 +4675,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -3750,9 +4774,31 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoChannel
-
@@ -3863,37 +4902,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
@@ -3902,7 +4914,7 @@
-
+
- undefined
+
+
undefined
@@ -3969,8 +4982,30 @@
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
@@ -4043,37 +5072,10 @@
"displayName":
"string",
"description":
"string",
"isLocal":
"boolean",
-
"owner": {
-
"name":
"string",
+
"ownerAccount": {
+
"id":
"number",
"uuid":
"string"
- },
-
"videos": [
- {
-
"id":
"number",
-
"uuid":
"string",
-
"accountName":
"string",
-
"createdAt":
"string",
-
"updatedAt":
"string",
-
"categoryLabel":
"string",
-
"category":
"number",
-
"licenceLabel":
"string",
-
"licence":
"number",
-
"languageLabel":
"string",
-
"language":
"number",
-
"description":
"string",
-
"duration":
"number",
-
"isLocal":
"boolean",
-
"name":
"string",
-
"serverHost":
"string",
-
"thumbnailPath":
"string",
-
"previewPath":
"string",
-
"embedPath":
"string",
-
"views":
"number",
-
"likes":
"number",
-
"dislikes":
"number",
-
"nsfw":
"boolean"
- }
- ]
+ }
}
@@ -4081,7 +5083,7 @@
+
- undefined
+
+
undefined
@@ -4118,22 +5121,16 @@
id
+
in path
+
+ string
+
+
-
-
type
-
-
string
-
+
The video channel id
@@ -4170,8 +5167,30 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
+
+
+
+
+
-
string
-
+
successful operation
+
Response Content-Types:
+ application/json
+
+
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GET
+ /video-channels/{id}/videos
+
+
+
+
+
+
+
+
id
+
+
in path
+
+ string
+
+
+
+
@@ -4218,7 +5309,13 @@
-
204 No Content
+
200 OK
+
+
successful operation
@@ -4226,14 +5323,63 @@
-
-
Response Content-Types:
- application/json
-
-
+
+
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"
+ }
+ }
+}
+
+
+
+
-
@@ -4307,37 +5459,10 @@
"displayName":
"string",
"description":
"string",
"isLocal":
"boolean",
-
"owner": {
-
"name":
"string",
+
"ownerAccount": {
+
"id":
"number",
"uuid":
"string"
- },
-
"videos": [
- {
-
"id":
"number",
-
"uuid":
"string",
-
"accountName":
"string",
-
"createdAt":
"string",
-
"updatedAt":
"string",
-
"categoryLabel":
"string",
-
"category":
"number",
-
"licenceLabel":
"string",
-
"licence":
"number",
-
"languageLabel":
"string",
-
"language":
"number",
-
"description":
"string",
-
"duration":
"number",
-
"isLocal":
"boolean",
-
"name":
"string",
-
"serverHost":
"string",
-
"thumbnailPath":
"string",
-
"previewPath":
"string",
-
"embedPath":
"string",
-
"views":
"number",
-
"likes":
"number",
-
"dislikes":
"number",
-
"nsfw":
"boolean"
- }
- ]
+ }
}
]
@@ -4369,79 +5494,55 @@
videoId
+
in path
+
+ string
+
+
-
-
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -4534,22 +5635,16 @@
videoId
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
threadId
+
in path
+
+ string
+
+
-
-
@@ -4827,42 +5932,30 @@
videoId
+
in path
+
+ string
+
+
-
-
commentId
+
in path
+
+ string
+
+
-
-
@@ -4929,6 +6022,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
commentId
+
in path
+
+ string
+
+
-
-
@@ -5011,6 +6114,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoRate
@@ -5030,52 +6155,171 @@
-
-
-
-
type
-
+
+
+
+
id
+
+
in path
+
+ string
+
+
+
+
+
+
+
+
+
+
+
Response Content-Types:
+ application/json
+
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
Schema Definitions
+
+
+ VideoConstantNumber:
+
+
+
+
+
+
+ -
+ id:
+ number
+
+
+ -
+ label:
+ string
+
+
+
+
+
+
+
+ Example
+ {
+ "id": "number",
+ "label": "string"
+}
+
+
+
+
+
+
+
+
+ VideoConstantString:
+
+
+
-
+
+
+ label:
+ string
+
+
+
+
+
+
+
+ Example
+ {
+ "id": "string",
+ "label": "string"
+}
+
+
-
+
+
+ VideoPrivacy: string
+
+
-
-
Response Content-Types:
- application/json
-
+ string
+
+ Public,
+ Unlisted,
+ Private
+
+
Schema Definitions
Video:
@@ -5099,49 +6343,55 @@
string
-
- accountName:
- string
-
-
createdAt:
string
-
- updatedAt:
+
+ publishedAt:
string
-
- categoryLabel:
+
+ updatedAt:
string
category:
- number
-
-
-
- licenceLabel:
- string
+
+
+ VideoConstantNumber
+
+
licence:
- number
-
-
-
- languageLabel:
- string
+
+
+ VideoConstantNumber
+
+
language:
- number
+
+
+ VideoConstantString
+
+
+
+
+
+ privacy:
+
+
+ VideoPrivacy
+
+
@@ -5164,11 +6414,6 @@
string
-
- serverHost:
- string
-
-
thumbnailPath:
string
@@ -5204,6 +6449,46 @@
boolean
+
+ account:
+ object
+
+
+
+
+
+ -
+ name:
+ string
+
+
+ -
+ displayName:
+ string
+
+
+ -
+ url:
+ string
+
+
+ -
+ host:
+ string
+
+
+ -
+ avatar:
+
+
+ Avatar
+
+
+
+
+
+
+
@@ -5213,27 +6498,44 @@
{
"id": "number",
"uuid": "string",
- "accountName": "string",
"createdAt": "string",
+ "publishedAt": "string",
"updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
+ "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",
- "serverHost": "string",
"thumbnailPath": "string",
"previewPath": "string",
"embedPath": "string",
"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"
+ }
+ }
}
@@ -5264,30 +6566,45 @@
string
-
- reporterUsername:
- string
-
-
-
- reporterServerHost:
- string
-
-
-
- videoId:
- number
+
+ reporterAccount:
+
+
+ Account
+
+
-
- videoUUID:
- string
+
+ video:
+ object
-
- videoName:
- string
-
+
+
+
+ -
+ id:
+ number
+
+
+ -
+ name:
+ string
+
+
+ -
+ uuid:
+ string
+
+
+ -
+ url:
+ string
+
+
+
+
createdAt:
@@ -5303,11 +6620,29 @@
{
"id": "number",
"reason": "string",
- "reporterUsername": "string",
- "reporterServerHost": "string",
- "videoId": "number",
- "videoUUID": "string",
- "videoName": "string",
+ "reporterAccount": {
+ "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"
+ }
+ },
+ "video": {
+ "id": "number",
+ "name": "string",
+ "uuid": "string",
+ "url": "string"
+ },
"createdAt": "string"
}
@@ -5443,19 +6778,26 @@
boolean
-
- owner:
+
+ ownerAccount:
object
-
- videos:
-
-
- Video
-
-
-
+
+
+
+ -
+ id:
+ number
+
+
+ -
+ uuid:
+ string
+
+
+
+
@@ -5467,37 +6809,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
@@ -5643,6 +6958,17 @@
+
+
+
@@ -6023,6 +7349,17 @@
+
+
+
@@ -6060,37 +7397,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
}
@@ -6118,21 +7428,124 @@
object
+
+
+
+ -
+ allowed:
+ boolean
+
+
+
+
+
transcoding:
object
+
+
+
+ -
+ enabledResolutions:
+ number[]
+
+
+ -
+
+
+
+
+
avatar:
object
+
+
+
+ -
+ file:
+ object
+
+
+ -
+
+
+ -
+ size:
+ object
+
+
+ -
+
+
+ -
+ max:
+ number
+
+
+
+
+
+
+
+
+ -
+ extensions:
+ string[]
+
+
+ -
+
+
+
+
+
video:
object
+
+
+
+ -
+ file:
+ object
+
+
+ -
+
+
+ -
+ extensions:
+ string[]
+
+
+ -
+
+
+
+
+
+
+
+
@@ -6414,15 +7827,26 @@
- -
- id:
- number
+
-
+ video:
+ object
- -
- uuid:
- string
-
+
-
+
+
+ -
+ id:
+ number
+
+
+ -
+ uuid:
+ string
+
+
+
+
@@ -6431,8 +7855,10 @@
Example
{
- "id": "number",
- "uuid": "string"
+ "video": {
+ "id": "number",
+ "uuid": "string"
+ }
}
@@ -6467,6 +7893,17 @@
+
+
+
@@ -6924,6 +8361,52 @@
"name": "string",
"description": "string"
}
+
+
+
+
+
+
+
+
+ ScheduleVideoUpdate:
+
+
+
+
+
+
+ -
+ updateAt:
+ dateTime
+
+
+ -
+
When to update the video
+
+ -
+ privacy:
+
+
+ VideoPrivacy
+
+
+
+
+
+
+
+
+
+ Example
+ {
+ "updateAt": "dateTime",
+ "privacy": "string"
+}