diff --git a/support/doc/api/accounts.yaml b/support/doc/api/accounts.yaml new file mode 100644 index 000000000..c5b20040d --- /dev/null +++ b/support/doc/api/accounts.yaml @@ -0,0 +1,7 @@ +parameters: + name: + name: name + in: path + required: true + type: string + description: 'The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)' \ No newline at end of file diff --git a/support/doc/api/commons.yaml b/support/doc/api/commons.yaml new file mode 100644 index 000000000..c8bab3c80 --- /dev/null +++ b/support/doc/api/commons.yaml @@ -0,0 +1,23 @@ +parameters: + start: + name: start + in: query + required: false + type: number + description: 'Offset' + count: + name: count + in: query + required: false + type: number + description: 'Number of items' + sort: + name: sort + in: query + required: false + type: string + description: 'Sort column (-createdAt for example)' + +responses: + emptySuccess: + description: 'Successful operation' \ No newline at end of file diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html index 24017e674..bf9b6a17b 100644 --- a/support/doc/api/html/index.html +++ b/support/doc/api/html/index.html @@ -173,10 +173,10 @@ VideoBlacklist
The name of the account (chocobozzz or @@ -369,41 +369,44 @@
starting page
+Offset
stopping page
+Number of items
sorting
+Sort column (-createdAt for example)
The name of the account (chocobozzz or
@@ -755,19 +759,20 @@
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 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 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 starting page Offset stopping page Number of items sorting Sort column (-createdAt for example) successful operation Successful operation The file to upload. starting page category id of the video stopping page Offset sorting Number of items 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 Video preview file Video category Video licence Video language Video description Whether or not we wait transcoding before publish the video Text describing how to support the video uploader Whether or not this video contains sensitive content Video name Video tags Enable or disable comments for this video Video privacy (no description) 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 Video thumbnail file Video preview file Video category Whether or not we wait transcoding before publish the video Video licence Video language Video description Text describing how to support the video uploader Channel id that will contain this video Video thumbnail file Video preview file Video category Video licence Video language Video description Whether or not we wait transcoding before publish the video Text describing how to support the video uploader Whether or not this video contains sensitive content Video name Video tags Enable or disable comments for this video Video privacy (no description) 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 channel id The video channel id or uuid The video channel id The video channel id or uuid successful operation Successful operation The video channel id The video channel id or uuid successful operation Successful operation The video channel id The video channel id or uuid The name of the account (chocobozzz or
@@ -5472,7 +5572,7 @@
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 When to update the videoVideoBlacklist
-
POST
- /videos/{videoId}/blacklist
+ /videos/{id}/blacklist
DELETE
- /videos/{videoId}/blacklist
+ /videos/{id}/blacklist
VideoComment
-
GET
- /videos/{videoId}/comment-threads
+ /videos/{id}/comment-threads
POST
- /videos/{videoId}/comment-threads
+ /videos/{id}/comment-threads
GET
- /videos/{videoId}/comment-threads/{threadId}
+ /videos/{id}/comment-threads/{threadId}
POST
- /videos/{videoId}/comments/{commentId}
+ /videos/{id}/comments/{commentId}
DELETE
- /videos/{videoId}/comments/{commentId}
+ /videos/{id}/comments/{commentId}
- ScheduleVideoUpdate:
-
-
-
-
- Example
- {
- "updateAt": "dateTime",
- "privacy": "string"
-}