X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;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
The id of the account
+The name of the account (chocobozzz or + chocobozzz@peertube.cpy.re for example)
starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
The name of the account (chocobozzz or + chocobozzz@peertube.cpy.re for example)
+successful operation
+{
+ "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"
+ }
+ }
+}
The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0
+The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds
+The name of the local account to filter to
+successful operation
+The id of the account
+The state of the job
starting page
+Offset
(no description)
+Number of items
sorting
+Sort column (-createdAt for example)
The host to unfollow
@@ -857,41 +1087,44 @@starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
successful operation
+Successful operation
starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
The user id
+The user id
successful operation
+Successful operation
The user id
+The user id
The user id
+The user id
successful operation
+Successful operation
successful operation
+Successful operation
The video id
@@ -2393,41 +2504,44 @@starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
successful operation
+Successful operation
The file to upload.
@@ -2730,41 +2845,58 @@starting page
+category id of the video
stopping page
+Offset
Number of items
+sorting
+Sort column (-createdAt for example)
starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
The video id
+The video id or uuid
Video thumbnail file
@@ -3287,12 +3424,13 @@Video preview file
@@ -3300,12 +3438,13 @@Video category
@@ -3313,12 +3452,13 @@Video licence
@@ -3326,12 +3466,13 @@Video language
@@ -3339,12 +3480,13 @@Video description
@@ -3352,12 +3494,27 @@Whether or not we wait transcoding before publish the video
+Text describing how to support the video uploader
@@ -3365,12 +3522,13 @@Whether or not this video contains sensitive content
@@ -3378,12 +3536,13 @@Video name
@@ -3391,12 +3550,13 @@Video tags
@@ -3404,12 +3564,13 @@Enable or disable comments for this video
@@ -3417,21 +3578,36 @@Video privacy
Schedule an update at a specific datetime
+The video id
+The video id or uuid
The video id
+The video id or uuid
successful operation
+Successful operation
The video id
+The video id or uuid
The video id
+The video id or uuid
successful operation
+Successful operation
Video file
@@ -3885,13 +4066,28 @@Channel id that will contain this video
+Video thumbnail file
@@ -3899,13 +4095,13 @@Video preview file
@@ -3913,12 +4109,13 @@Video category
@@ -3926,12 +4123,13 @@Video licence
@@ -3939,12 +4137,13 @@Video language
@@ -3952,12 +4151,13 @@Video description
@@ -3965,40 +4165,41 @@Text describing how to support the video uploader
+Whether or not we wait transcoding before publish the video
Channel id that will contain this video
+Text describing how to support the video uploader
Whether or not this video contains sensitive content
@@ -4006,13 +4207,13 @@Video name
@@ -4020,12 +4221,13 @@Video tags
@@ -4033,12 +4235,13 @@Enable or disable comments for this video
@@ -4046,23 +4249,36 @@Video privacy
Schedule an update at a specific datetime
+starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
The video id
+The video id or uuid
successful operation
+Successful operation
The video id
+The video id or uuid
successful operation
+Successful operation
The video id
+The video id or uuid
successful operation
+Successful operation
starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
successful operation
+Successful operation
The video id
+The video channel id or uuid
The video id
+The video channel id or uuid
successful operation
+Successful operation
The video id
+The video channel id or uuid
successful operation
+Successful operation
The video channel id or uuid
+successful operation
+{
+ "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"
+ }
+ }
+}
+
+
+ The account id
+The name of the account (chocobozzz or + chocobozzz@peertube.cpy.re for example)
The video id
+The video id or uuid
starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
The video id
+The video id or uuid
The video id
+The video id or uuid
The thread id
+The thread id (root comment id)
The video id
+The video id or uuid
The comment id
+The comment id
The video id
+The video id or uuid
The comment id
+The comment id
successful operation
+Successful operation
The video id
+The video id or uuid
successful operation
+Successful operation