Add studio API documentation

[github/Chocobozzz/PeerTube.git] / support / doc / api / openapi.yaml

diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 61fd6c95ab56c497df5838dcb118b7958bfc4d27..74963df140cf27a97e25198e56ecde369c47606f 100644 (file)
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: PeerTube
 openapi: 3.0.0
 info:
   title: PeerTube

-  version: 3.2.0-rc.1
+  version: 4.0.0

   contact:
     name: PeerTube Community
     url: https://joinpeertube.org
   contact:
     name: PeerTube Community
     url: https://joinpeertube.org


@@ -22,7 +22,7 @@ info:
     - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
 
     See the [REST API quick start](https://docs.joinpeertube.org/api-rest-getting-started) for a few
     - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
 
     See the [REST API quick start](https://docs.joinpeertube.org/api-rest-getting-started) for a few

-    examples of using with the PeerTube API.
+    examples of using the PeerTube API.

 
     # Authentication
 
 
     # Authentication
 


@@ -38,48 +38,79 @@ info:
     # Errors
 
     The API uses standard HTTP status codes to indicate the success or failure
     # Errors
 
     The API uses standard HTTP status codes to indicate the success or failure

-    of the API call.
+    of the API call, completed by a [RFC7807-compliant](https://tools.ietf.org/html/rfc7807) response body.

 
     ```
     HTTP 1.1 404 Not Found
 
     ```
     HTTP 1.1 404 Not Found

-    Content-Type: application/json
+    Content-Type: application/problem+json; charset=utf-8

 
     {
 
     {

-      "errorCode": 1
-      "error": "Account not found"
+      "detail": "Video not found",
+      "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
+      "status": 404,
+      "title": "Not Found",
+      "type": "about:blank"

     }
     ```
 
     }
     ```
 

-    We provide error codes for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/server/server-error-code.enum.ts),
-    but it is still optional.
+    We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/server/server-error-code.enum.ts),
+    but it is still optional. Types are used to disambiguate errors that bear the same status code
+    and are non-obvious:
+
+    ```
+    HTTP 1.1 403 Forbidden
+    Content-Type: application/problem+json; charset=utf-8
+
+    {
+      "detail": "Cannot get this video regarding follow constraints",
+      "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
+      "status": 403,
+      "title": "Forbidden",
+      "type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints"
+    }
+    ```
+
+    Here a 403 error could otherwise mean that the video is private or blocklisted.

 
     ### Validation errors
 
     Each parameter is evaluated on its own against a set of rules before the route validator
 
     ### Validation errors
 
     Each parameter is evaluated on its own against a set of rules before the route validator

-    proceeds with potential testing involving parameter combinations. Errors coming from Validation
-    errors appear earlier and benefit from a more detailed error type:
+    proceeds with potential testing involving parameter combinations. Errors coming from validation
+    errors appear earlier and benefit from a more detailed error description:

 
     ```
     HTTP 1.1 400 Bad Request
 
     ```
     HTTP 1.1 400 Bad Request

-    Content-Type: application/json
+    Content-Type: application/problem+json; charset=utf-8

 
     {
 
     {

-      "errors": {
+      "detail": "Incorrect request parameters: id",
+      "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
+      "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180",
+      "invalid-params": {

         "id": {
         "id": {

-          "value": "a117eb-c6a9-4756-bb09-2a956239f",
-          "msg": "Should have a valid id",
+          "location": "params",
+          "msg": "Invalid value",

           "param": "id",
           "param": "id",

-          "location": "params"
+          "value": "9c9de5e8-0a1e-484a-b099-e80766180"

         }
         }

-      }
+      },
+      "status": 400,
+      "title": "Bad Request",
+      "type": "about:blank"

     }
     ```
 
     Where `id` is the name of the field concerned by the error, within the route definition.
     }
     ```
 
     Where `id` is the name of the field concerned by the error, within the route definition.

-    `errors.<field>.location` can be either 'params', 'body', 'header', 'query' or 'cookies', and
-    `errors.<field>.value` reports the value that didn't pass validation whose `errors.<field>.msg`
+    `invalid-params.<field>.location` can be either 'params', 'body', 'header', 'query' or 'cookies', and
+    `invalid-params.<field>.value` reports the value that didn't pass validation whose `invalid-params.<field>.msg`

     is about.
 
     is about.
 

+    ### Deprecated error fields
+
+    Some fields could be included with previous versions. They are still included but their use is deprecated:
+    - `error`: superseded by `detail`
+    - `code`: superseded by `type` (which is now an URI)
+

     # Rate limits
 
     We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
     # Rate limits
 
     We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:


@@ -108,7 +139,7 @@ info:
 
     This API features [Cross-Origin Resource Sharing (CORS)](https://fetch.spec.whatwg.org/),
     allowing cross-domain communication from the browser for some routes:
 
     This API features [Cross-Origin Resource Sharing (CORS)](https://fetch.spec.whatwg.org/),
     allowing cross-domain communication from the browser for some routes:

-    
+

     | Endpoint                    |
     |------------------------- ---|
     | `/api/*`                    |
     | Endpoint                    |
     |------------------------- ---|
     | `/api/*`                    |


@@ -124,8 +155,8 @@ tags:
   - name: Register
     description: |
       As a visitor, you can use this API to open an account (if registrations are open on
   - name: Register
     description: |
       As a visitor, you can use this API to open an account (if registrations are open on

-      that PeerTube instance). As an admin, you should use the dedicated [User creation 
-      API](#operation/createUser) instead.
+      that PeerTube instance). As an admin, you should use the dedicated [User creation
+      API](#operation/addUser) instead.

   - name: Session
     x-displayName: Login/Logout
     description: |
   - name: Session
     x-displayName: Login/Logout
     description: |


@@ -216,11 +247,13 @@ tags:
       ### Import
 
       - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)
       ### Import
 
       - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)

-      - _magnet_-based: where the URI resolves to a BitTorrent ressource containing a single supported video file
-      - _torrent_-based: where the metainfo file resolves to a BitTorrent ressource containing a single supported video file
+      - _magnet_-based: where the URI resolves to a BitTorrent resource containing a single supported video file
+      - _torrent_-based: where the metainfo file resolves to a BitTorrent resource containing a single supported video file

 
       The import function is practical when the desired video/audio is available online. It makes PeerTube
       download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.
 
       The import function is practical when the desired video/audio is available online. It makes PeerTube
       download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.

+  - name: Video Imports
+    description: Operations dealing with listing, adding and removing video imports.

   - name: Video Captions
     description: Operations dealing with listing, adding and removing closed captions of a video.
   - name: Video Channels
   - name: Video Captions
     description: Operations dealing with listing, adding and removing closed captions of a video.
   - name: Video Channels


@@ -236,6 +269,12 @@ tags:
     description: Like/dislike a video.
   - name: Video Playlists
     description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels.
     description: Like/dislike a video.
   - name: Video Playlists
     description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels.

+  - name: Video Files
+    description: Operations on video files
+  - name: Video Transcoding
+    description: Video transcoding related operations
+  - name: Video stats
+    description: Video statistics

   - name: Feeds
     description: Server syndication feeds
   - name: Search
   - name: Feeds
     description: Server syndication feeds
   - name: Search


@@ -247,11 +286,17 @@ tags:
 
       Administrators can also enable the use of a remote search system, indexing
       videos and channels not could be not federated by the instance.
 
       Administrators can also enable the use of a remote search system, indexing
       videos and channels not could be not federated by the instance.

+  - name: Homepage
+    description: Get and update the custom homepage

   - name: Video Mirroring
     description: |
       PeerTube instances can mirror videos from one another, and help distribute some videos.
 
       For importing videos as your own, refer to [video imports](#operation/importVideo).
   - name: Video Mirroring
     description: |
       PeerTube instances can mirror videos from one another, and help distribute some videos.
 
       For importing videos as your own, refer to [video imports](#operation/importVideo).

+  - name: Stats
+    description: |
+      Statistics
+

 x-tagGroups:
   - name: Auth
     tags:
 x-tagGroups:
   - name: Auth
     tags:


@@ -269,13 +314,17 @@ x-tagGroups:
     tags:
       - Video
       - Video Upload
     tags:
       - Video
       - Video Upload

+      - Video Imports

       - Video Captions
       - Video Channels
       - Video Comments
       - Video Rates
       - Video Playlists
       - Video Captions
       - Video Channels
       - Video Comments
       - Video Rates
       - Video Playlists

+      - Video Stats

       - Video Ownership Change
       - Video Mirroring
       - Video Ownership Change
       - Video Mirroring

+      - Video Files
+      - Video Transcoding

       - Live Videos
       - Feeds
   - name: Search
       - Live Videos
       - Feeds
   - name: Search


@@ -287,14 +336,15 @@ x-tagGroups:
       - Video Blocks
       - Account Blocks
       - Server Blocks
       - Video Blocks
       - Account Blocks
       - Server Blocks

-  - name: Instance Configuration
+  - name: Instance

     tags:
       - Config
     tags:
       - Config

+      - Homepage

       - Instance Follows
       - Instance Redundancy
       - Plugins
       - Instance Follows
       - Instance Redundancy
       - Plugins

-  - name: Jobs
-    tags:
+      - Stats
+      - Logs

       - Job
 paths:
   '/accounts/{name}':
       - Job
 paths:
   '/accounts/{name}':


@@ -331,7 +381,11 @@ paths:
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'

-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/isLocal'
+        - $ref: '#/components/parameters/include'
+        - $ref: '#/components/parameters/privacyOneOf'
+        - $ref: '#/components/parameters/hasHLSFiles'
+        - $ref: '#/components/parameters/hasWebtorrentFiles'

         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'
         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'


@@ -378,6 +432,36 @@ paths:
 
             print(json)
 
 
             print(json)
 

+  '/accounts/{name}/followers':
+    get:
+      tags:
+        - Accounts
+      summary: 'List followers of an account'
+      security:
+        - OAuth2: []
+      operationId: getAccountFollowers
+      parameters:
+        - $ref: '#/components/parameters/name'
+        - $ref: '#/components/parameters/start'
+        - $ref: '#/components/parameters/count'
+        - $ref: '#/components/parameters/followersSort'
+        - $ref: '#/components/parameters/search'
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  total:
+                    type: integer
+                    example: 1
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Follow'
+

   /accounts:
     get:
       tags:
   /accounts:
     get:
       tags:


@@ -477,6 +561,64 @@ paths:
         '200':
           description: successful operation
 
         '200':
           description: successful operation
 

+  /custom-pages/homepage/instance:
+    get:
+      summary: Get instance custom homepage
+      tags:
+        - Homepage
+      responses:
+        '404':
+          description: No homepage set
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CustomHomepage'
+    put:
+      summary: Set instance custom homepage
+      tags:
+        - Homepage
+      security:
+        - OAuth2:
+          - admin
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                content:
+                  type: string
+                  description: content of the homepage, that will be injected in the client
+      responses:
+        '204':
+          description: successful operation
+
+  /jobs/pause:
+    post:
+      summary: Pause job queue
+      security:
+        - OAuth2:
+          - admin
+      tags:
+        - Job
+      responses:
+        '204':
+          description: successful operation
+
+  /jobs/resume:
+    post:
+      summary: Resume job queue
+      security:
+        - OAuth2:
+          - admin
+      tags:
+        - Job
+      responses:
+        '204':
+          description: successful operation
+

   /jobs/{state}:
     get:
       summary: List instance jobs
   /jobs/{state}:
     get:
       summary: List instance jobs


@@ -646,7 +788,7 @@ paths:
           - admin
       tags:
         - Instance Follows
           - admin
       tags:
         - Instance Follows

-      summary: Follow a list of servers
+      summary: Follow a list of actors (PeerTube instance, channel or account)

       responses:
         '204':
           description: successful operation
       responses:
         '204':
           description: successful operation


@@ -664,33 +806,37 @@ paths:
                     type: string
                     format: hostname
                   uniqueItems: true
                     type: string
                     format: hostname
                   uniqueItems: true

+                handles:
+                  type: array
+                  items:
+                    type: string
+                  uniqueItems: true

 
 

-  '/server/following/{host}':
+  '/server/following/{hostOrHandle}':

     delete:
     delete:

-      summary: Unfollow a server
+      summary: Unfollow an actor (PeerTube instance, channel or account)

       security:
         - OAuth2:
           - admin
       tags:
         - Instance Follows
       parameters:
       security:
         - OAuth2:
           - admin
       tags:
         - Instance Follows
       parameters:

-        - name: host
+        - name: hostOrHandle

           in: path
           required: true
           in: path
           required: true

-          description: The host to unfollow
+          description: The hostOrHandle to unfollow

           schema:
             type: string
           schema:
             type: string

-            format: hostname

       responses:
         '204':
           description: successful operation
         '404':
       responses:
         '204':
           description: successful operation
         '404':

-          description: host not found
+          description: host or handle not found

 
   /users:
     post:
       summary: Create a user
 
   /users:
     post:
       summary: Create a user

-      operationId: createUser
+      operationId: addUser

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -705,18 +851,18 @@ paths:
                 $ref: '#/components/schemas/AddUserResponse'
           links:
             # GET /users/{id}
                 $ref: '#/components/schemas/AddUserResponse'
           links:
             # GET /users/{id}

-            GetUserId:
-              operationId: getUserId
+            GetUser:
+              operationId: getUser

               parameters:
                 id: '$response.body#/user/id'
             # PUT /users/{id}
               parameters:
                 id: '$response.body#/user/id'
             # PUT /users/{id}

-            PutUserId:
-              operationId: putUserId
+            PutUser:
+              operationId: putUser

               parameters:
                 id: '$response.body#/user/id'
             # DELETE /users/{id}
               parameters:
                 id: '$response.body#/user/id'
             # DELETE /users/{id}

-            DelUserId:
-              operationId: delUserId
+            DelUser:
+              operationId: delUser

               parameters:
                 id: '$response.body#/user/id'
         '403':
               parameters:
                 id: '$response.body#/user/id'
         '403':


@@ -764,7 +910,7 @@ paths:
           - admin
       tags:
         - Users
           - admin
       tags:
         - Users

-      operationId: delUserId
+      operationId: delUser

       responses:
         '204':
           description: successful operation
       responses:
         '204':
           description: successful operation


@@ -774,7 +920,7 @@ paths:
         - OAuth2: []
       tags:
         - Users
         - OAuth2: []
       tags:
         - Users

-      operationId: getUserId
+      operationId: getUser

       parameters:
         - name: withStats
           in: query
       parameters:
         - name: withStats
           in: query


@@ -799,7 +945,7 @@ paths:
         - OAuth2: []
       tags:
         - Users
         - OAuth2: []
       tags:
         - Users

-      operationId: putUserId
+      operationId: putUser

       responses:
         '204':
           description: successful operation
       responses:
         '204':
           description: successful operation


@@ -884,6 +1030,18 @@ paths:
                     type: integer
                     minimum: 0
                     example: 1209600
                     type: integer
                     minimum: 0
                     example: 1209600

+        '400':
+          x-summary: client or credentials are invalid
+          description: |
+            Disambiguate via `type`:
+            - `invalid_client` for an unmatched `client_id`
+            - `invalid_grant` for unmatched credentials
+        '401':
+          x-summary: token expired
+          description: |
+            Disambiguate via `type`:
+            - default value for a regular authentication failure
+            - `invalid_token` for an expired token

       x-codeSamples:
         - lang: Shell
           source: |
       x-codeSamples:
         - lang: Shell
           source: |


@@ -939,7 +1097,7 @@ paths:
       operationId: verifyUser
       description: |
         Following a user registration, the new user will receive an email asking to click a link
       operationId: verifyUser
       description: |
         Following a user registration, the new user will receive an email asking to click a link

-        containing a secret. 
+        containing a secret.

       tags:
         - Users
         - Register
       tags:
         - Users
         - Register


@@ -1184,7 +1342,11 @@ paths:
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'

-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/isLocal'
+        - $ref: '#/components/parameters/include'
+        - $ref: '#/components/parameters/privacyOneOf'
+        - $ref: '#/components/parameters/hasHLSFiles'
+        - $ref: '#/components/parameters/hasWebtorrentFiles'

         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'
         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'


@@ -1346,6 +1508,23 @@ paths:
               schema:
                 $ref: '#/components/schemas/VideoListResponse'
 
               schema:
                 $ref: '#/components/schemas/VideoListResponse'
 

+  /users/me/history/videos/{videoId}:
+    delete:
+      summary: Delete history element
+      security:
+        - OAuth2: []
+      tags:
+        - My History
+      parameters:
+        - name: videoId
+          in: path
+          required: true
+          schema:
+            $ref: '#/components/schemas/Video/properties/id'
+      responses:
+        '204':
+          description: successful operation
+

   /users/me/history/videos/remove:
     post:
       summary: Clear video history
   /users/me/history/videos/remove:
     post:
       summary: Clear video history


@@ -1382,8 +1561,10 @@ paths:
               schema:
                 type: object
                 properties:
               schema:
                 type: object
                 properties:

-                  avatar:
-                    $ref: '#/components/schemas/ActorImage'
+                  avatars:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/ActorImage'

         '413':
           description: image file too large
           headers:
         '413':
           description: image file too large
           headers:


@@ -1443,7 +1624,7 @@ paths:
         '403':
           description: cannot terminate an ownership change of another user
         '404':
         '403':
           description: cannot terminate an ownership change of another user
         '404':

-          description: video owneship change not found
+          description: video ownership change not found

 
   '/videos/ownership/{id}/refuse':
     post:
 
   '/videos/ownership/{id}/refuse':
     post:


@@ -1460,7 +1641,7 @@ paths:
         '403':
           description: cannot terminate an ownership change of another user
         '404':
         '403':
           description: cannot terminate an ownership change of another user
         '404':

-          description: video owneship change not found
+          description: video ownership change not found

 
   '/videos/{id}/give-ownership':
     post:
 
   '/videos/{id}/give-ownership':
     post:


@@ -1490,9 +1671,35 @@ paths:
         '404':
           description: video not found
 
         '404':
           description: video not found
 

+  /videos/{id}/studio/edit:
+    post:
+      summary: Create a studio task
+      tags:
+        - Video Transcoding
+        - Video
+      description: Create a task to edit a video  (cut, add intro/outro etc)
+      security:
+        - OAuth2: []
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      requestBody:
+        required: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/VideoStudioCreateTask'
+      responses:
+        '204':
+          description: successful operation
+        '400':
+          description: incorrect parameters
+        '404':
+          description: video not found
+

   /videos:
     get:
       summary: List videos
   /videos:
     get:
       summary: List videos

+      operationId: getVideos

       tags:
         - Video
       parameters:
       tags:
         - Video
       parameters:


@@ -1503,7 +1710,11 @@ paths:
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'

-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/isLocal'
+        - $ref: '#/components/parameters/include'
+        - $ref: '#/components/parameters/privacyOneOf'
+        - $ref: '#/components/parameters/hasHLSFiles'
+        - $ref: '#/components/parameters/hasWebtorrentFiles'

         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'
         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'


@@ -1657,6 +1868,9 @@ paths:
                 commentsEnabled:
                   description: Enable or disable comments for this video
                   type: boolean
                 commentsEnabled:
                   description: Enable or disable comments for this video
                   type: boolean

+                downloadEnabled:
+                  description: Enable or disable downloading for this video
+                  type: boolean

                 originallyPublishedAt:
                   description: Date when the content was originally published
                   type: string
                 originallyPublishedAt:
                   description: Date when the content was originally published
                   type: string


@@ -1716,13 +1930,37 @@ paths:
                 example: |
                   **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**
 
                 example: |
                   **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**
 

+  '/videos/{id}/source':
+    post:
+      summary: Get video source file metadata
+      operationId: getVideoSource
+      tags:
+        - Video
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VideoSource'
+

   '/videos/{id}/views':
     post:
   '/videos/{id}/views':
     post:

-      summary: Add a view to a video
+      summary: Notify user is watching a video
+      description: Call this endpoint regularly (every 5-10 seconds for example) to notify the server the user is watching the video. After a while, PeerTube will increase video's viewers counter. If the user is authenticated, PeerTube will also store the current player time.
+      operationId: addView

       tags:
         - Video
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
       tags:
         - Video
       parameters:
         - $ref: '#/components/parameters/idOrUUID'

+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserViewingVideo'
+        required: true

       responses:
         '204':
           description: successful operation
       responses:
         '204':
           description: successful operation


@@ -1730,6 +1968,8 @@ paths:
   '/videos/{id}/watching':
     put:
       summary: Set watching progress of a video
   '/videos/{id}/watching':
     put:
       summary: Set watching progress of a video

+      deprecated: true
+      description: This endpoint has been deprecated. Use `/videos/{id}/views` instead

       tags:
         - Video
       security:
       tags:
         - Video
       security:


@@ -1740,12 +1980,97 @@ paths:
         content:
           application/json:
             schema:
         content:
           application/json:
             schema:

-              $ref: '#/components/schemas/UserWatchingVideo'
+              $ref: '#/components/schemas/UserViewingVideo'

         required: true
       responses:
         '204':
           description: successful operation
 
         required: true
       responses:
         '204':
           description: successful operation
 

+  '/videos/{id}/stats/overall':
+    get:
+      summary: Get overall stats of a video
+      tags:
+        - Video Stats
+      security:
+        - OAuth2: []
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+        - name: startDate
+          in: query
+          description: Filter stats by start date
+          schema:
+            type: string
+            format: date-time
+        - name: endDate
+          in: query
+          description: Filter stats by end date
+          schema:
+            type: string
+            format: date-time
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VideoStatsOverall'
+
+  '/videos/{id}/stats/retention':
+    get:
+      summary: Get retention stats of a video
+      tags:
+        - Video Stats
+      security:
+        - OAuth2: []
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VideoStatsRetention'
+
+  '/videos/{id}/stats/timeseries/{metric}':
+    get:
+      summary: Get timeserie stats of a video
+      tags:
+        - Video Stats
+      security:
+        - OAuth2: []
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+        -
+          name: metric
+          in: path
+          required: true
+          description: The metric to get
+          schema:
+            type: string
+            enum:
+              - 'viewers'
+              - 'aggregateWatchTime'
+        - name: startDate
+          in: query
+          description: Filter stats by start date
+          schema:
+            type: string
+            format: date-time
+        - name: endDate
+          in: query
+          description: Filter stats by end date
+          schema:
+            type: string
+            format: date-time
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VideoStatsTimeserie'
+

   /videos/upload:
     post:
       summary: Upload a video
   /videos/upload:
     post:
       summary: Upload a video


@@ -1763,14 +2088,15 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/VideoUploadResponse'
             application/json:
               schema:
                 $ref: '#/components/schemas/VideoUploadResponse'

-        '400':
-          description: invalid file field, schedule date or parameter

         '403':
           description: video didn't pass upload filter
         '408':
           description: upload has timed out
         '413':
         '403':
           description: video didn't pass upload filter
         '408':
           description: upload has timed out
         '413':

-          description: video file too large, due to quota or max body size limit set by the reverse-proxy
+          x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy
+          description: |
+            If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`:
+            - `quota_reached` for quota limits whether daily or global

           headers:
             X-File-Maximum-Size:
               schema:
           headers:
             X-File-Maximum-Size:
               schema:


@@ -1869,10 +2195,12 @@ paths:
               schema:
                 type: number
                 example: 0
               schema:
                 type: number
                 example: 0

-        '400':
-          description: invalid file field, schedule date or parameter

         '413':
         '413':

-          description: video file too large, due to quota, absolute max file size or concurrent partial upload limit
+          x-summary: video file too large, due to quota, absolute max file size or concurrent partial upload limit
+          description: |
+            Disambiguate via `type`:
+            - `max_file_size_reached` for the absolute file size limit
+            - `quota_reached` for quota limits whether daily or global

         '415':
           description: video type unsupported
     put:
         '415':
           description: video type unsupported
     put:


@@ -1886,10 +2214,10 @@ paths:
         - Video Upload
       parameters:
         - name: upload_id
         - Video Upload
       parameters:
         - name: upload_id

-          in: path
+          in: query

           required: true
           description: |
           required: true
           description: |

-            Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is
+            Created session id to proceed with. If you didn't send chunks in the last hour, it is

             not valid anymore and you need to initialize a new upload.
           schema:
             type: string
             not valid anymore and you need to initialize a new upload.
           schema:
             type: string


@@ -1913,9 +2241,6 @@ paths:
           description: |
             Size of the chunk that the request is sending.
 
           description: |
             Size of the chunk that the request is sending.
 

-            The chunk size __must be a multiple of 256 KB__, and unlike [Google Resumable](https://developers.google.com/youtube/v3/guides/using_resumable_upload_protocol)
-            doesn't mandate for chunks to have the same size throughout the upload sequence.
-

             Remember that larger chunks are more efficient. PeerTube's web client uses chunks varying from
             1048576 bytes (~1MB) and increases or reduces size depending on connection health.
       requestBody:
             Remember that larger chunks are more efficient. PeerTube's web client uses chunks varying from
             1048576 bytes (~1MB) and increases or reduces size depending on connection health.
       requestBody:


@@ -1948,10 +2273,21 @@ paths:
                 example: 0
         '403':
           description: video didn't pass upload filter
                 example: 0
         '403':
           description: video didn't pass upload filter

-        '413':
-          description: video file too large, due to quota or max body size limit set by the reverse-proxy
+        '404':
+          description: upload not found
+        '409':
+          description: chunk doesn't match range

         '422':
           description: video unreadable
         '422':
           description: video unreadable

+        '429':
+          description: too many concurrent requests
+        '503':
+          description: upload is already being processed
+          headers:
+            'Retry-After':
+              schema:
+                type: number
+                example: 300

     delete:
       summary: Cancel the resumable upload of a video, deleting any data uploaded so far
       description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video
     delete:
       summary: Cancel the resumable upload of a video, deleting any data uploaded so far
       description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video


@@ -1963,7 +2299,7 @@ paths:
         - Video Upload
       parameters:
         - name: upload_id
         - Video Upload
       parameters:
         - name: upload_id

-          in: path
+          in: query

           required: true
           description: |
             Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is
           required: true
           description: |
             Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is


@@ -1984,6 +2320,8 @@ paths:
               schema:
                 type: number
                 example: 0
               schema:
                 type: number
                 example: 0

+        '404':
+          description: upload not found

 
   /videos/imports:
     post:
 
   /videos/imports:
     post:


@@ -1993,7 +2331,7 @@ paths:
       security:
         - OAuth2: []
       tags:
       security:
         - OAuth2: []
       tags:

-        - Video
+        - Video Imports

         - Video Upload
       requestBody:
         content:
         - Video Upload
       requestBody:
         content:


@@ -2021,10 +2359,38 @@ paths:
         '409':
           description: HTTP or Torrent/magnetURI import not enabled
 
         '409':
           description: HTTP or Torrent/magnetURI import not enabled
 

+  /videos/imports/{id}/cancel:
+    post:
+      summary: Cancel video import
+      description: Cancel a pending video import
+      security:
+        - OAuth2: []
+      tags:
+        - Video Imports
+      parameters:
+        - $ref: '#/components/parameters/id'
+      responses:
+        '204':
+          description: successful operation
+
+  /videos/imports/{id}:
+    delete:
+      summary: Delete video import
+      description: Delete ended video import
+      security:
+        - OAuth2: []
+      tags:
+        - Video Imports
+      parameters:
+        - $ref: '#/components/parameters/id'
+      responses:
+        '204':
+          description: successful operation
+

   /videos/live:
     post:
       summary: Create a live
   /videos/live:
     post:
       summary: Create a live

-      operationId: createLive
+      operationId: addLive

       security:
         - OAuth2: []
       tags:
       security:
         - OAuth2: []
       tags:


@@ -2037,8 +2403,20 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/VideoUploadResponse'
             application/json:
               schema:
                 $ref: '#/components/schemas/VideoUploadResponse'

+        '400':
+          x-summary: validation error, or conflicting `saveReplay` and `permanentLive` parameter set
+          description: |
+            Disambiguate via `type`:
+            - default type for a validation error
+            - `live_conflicting_permanent_and_save_replay` for conflicting parameters set

         '403':
         '403':

-          description: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
+          x-summary: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
+          description: |
+            Disambiguate via `type`:
+            - `live_not_enabled` for a disabled live feature
+            - `live_not_allowing_replay` for a disabled replay feature
+            - `max_instance_lives_limit_reached` for the absolute concurrent live limit
+            - `max_user_lives_limit_reached` for the user concurrent live limit

       requestBody:
         content:
           multipart/form-data:
       requestBody:
         content:
           multipart/form-data:


@@ -2053,6 +2431,9 @@ paths:
                 permanentLive:
                   description: User can stream multiple times in a permanent live
                   type: boolean
                 permanentLive:
                   description: User can stream multiple times in a permanent live
                   type: boolean

+                latencyMode:
+                  description: User can select live latency mode if enabled by the instance
+                  $ref: '#/components/schemas/LiveVideoLatencyMode'

                 thumbnailfile:
                   description: Live video/replay thumbnail file
                   type: string
                 thumbnailfile:
                   description: Live video/replay thumbnail file
                   type: string


@@ -2097,7 +2478,7 @@ paths:
                   description: Enable or disable comments for this live video/replay
                   type: boolean
                 downloadEnabled:
                   description: Enable or disable comments for this live video/replay
                   type: boolean
                 downloadEnabled:

-                  description: Enable or disable downloading for the replay of this live
+                  description: Enable or disable downloading for the replay of this live video

                   type: boolean
               required:
                 - channelId
                   type: boolean
               required:
                 - channelId


@@ -2148,6 +2529,48 @@ paths:
           description: bad parameters or trying to update a live that has already started
         '403':
           description: trying to save replay of the live but saving replay is not enabled on the instance
           description: bad parameters or trying to update a live that has already started
         '403':
           description: trying to save replay of the live but saving replay is not enabled on the instance

+  /videos/live/{id}/sessions:
+    get:
+      summary: List live sessions
+      description: List all sessions created in a particular live
+      security:
+        - OAuth2: []
+      tags:
+        - Live Videos
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  total:
+                    type: integer
+                    example: 1
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/LiveVideoSessionResponse'
+  /videos/{id}/live-session:
+    get:
+      summary: Get live session of a replay
+      description: If the video is a replay of a live, you can find the associated live session using this endpoint
+      security:
+        - OAuth2: []
+      tags:
+        - Live Videos
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LiveVideoSessionResponse'

 
   /users/me/abuses:
     get:
 
   /users/me/abuses:
     get:


@@ -2239,7 +2662,7 @@ paths:
             type: string
         - name: videoIs
           in: query
             type: string
         - name: videoIs
           in: query

-          description: only list blacklisted or deleted videos
+          description: only list deleted or blocklisted videos

           schema:
             type: string
             enum:
           schema:
             type: string
             enum:


@@ -2638,7 +3061,7 @@ paths:
                     type: object
                     properties:
                       id:
                     type: object
                     properties:
                       id:

-                        $ref: '#/components/schemas/VideoChannel/properties/id'
+                        $ref: '#/components/schemas/id'

       requestBody:
         content:
           application/json:
       requestBody:
         content:
           application/json:


@@ -2706,7 +3129,11 @@ paths:
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'

-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/isLocal'
+        - $ref: '#/components/parameters/include'
+        - $ref: '#/components/parameters/privacyOneOf'
+        - $ref: '#/components/parameters/hasHLSFiles'
+        - $ref: '#/components/parameters/hasWebtorrentFiles'

         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'
         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'


@@ -2719,6 +3146,36 @@ paths:
               schema:
                 $ref: '#/components/schemas/VideoListResponse'
 
               schema:
                 $ref: '#/components/schemas/VideoListResponse'
 

+  '/video-channels/{channelHandle}/followers':
+    get:
+      tags:
+        - Video Channels
+      summary: 'List followers of a video channel'
+      security:
+        - OAuth2: []
+      operationId: getVideoChannelFollowers
+      parameters:
+        - $ref: '#/components/parameters/channelHandle'
+        - $ref: '#/components/parameters/start'
+        - $ref: '#/components/parameters/count'
+        - $ref: '#/components/parameters/followersSort'
+        - $ref: '#/components/parameters/search'
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  total:
+                    type: integer
+                    example: 1
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Follow'
+

   '/video-channels/{channelHandle}/avatar/pick':
     post:
       summary: Update channel avatar
   '/video-channels/{channelHandle}/avatar/pick':
     post:
       summary: Update channel avatar


@@ -2736,8 +3193,10 @@ paths:
               schema:
                 type: object
                 properties:
               schema:
                 type: object
                 properties:

-                  avatar:
-                    $ref: '#/components/schemas/ActorImage'
+                  avatars:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/ActorImage'

         '413':
           description: image file too large
           headers:
         '413':
           description: image file too large
           headers:


@@ -2790,8 +3249,10 @@ paths:
               schema:
                 type: object
                 properties:
               schema:
                 type: object
                 properties:

-                  banner:
-                    $ref: '#/components/schemas/ActorImage'
+                  banners:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/ActorImage'

         '413':
           description: image file too large
           headers:
         '413':
           description: image file too large
           headers:


@@ -2874,7 +3335,7 @@ paths:
     post:
       summary: Create a video playlist
       description: If the video playlist is set as public, `videoChannelId` is mandatory.
     post:
       summary: Create a video playlist
       description: If the video playlist is set as public, `videoChannelId` is mandatory.

-      operationId: createPlaylist
+      operationId: addPlaylist

       security:
         - OAuth2: []
       tags:
       security:
         - OAuth2: []
       tags:


@@ -2894,6 +3355,8 @@ paths:
                         $ref: '#/components/schemas/VideoPlaylist/properties/id'
                       uuid:
                         $ref: '#/components/schemas/VideoPlaylist/properties/uuid'
                         $ref: '#/components/schemas/VideoPlaylist/properties/id'
                       uuid:
                         $ref: '#/components/schemas/VideoPlaylist/properties/uuid'

+                      shortUUID:
+                        $ref: '#/components/schemas/VideoPlaylist/properties/shortUUID'

       requestBody:
         content:
           multipart/form-data:
       requestBody:
         content:
           multipart/form-data:


@@ -2994,11 +3457,14 @@ paths:
   /video-playlists/{playlistId}/videos:
     get:
       summary: 'List videos of a playlist'
   /video-playlists/{playlistId}/videos:
     get:
       summary: 'List videos of a playlist'

+      operationId: getVideoPlaylistVideos

       tags:
         - Videos
         - Video Playlists
       parameters:
         - $ref: '#/components/parameters/playlistId'
       tags:
         - Videos
         - Video Playlists
       parameters:
         - $ref: '#/components/parameters/playlistId'

+        - $ref: '#/components/parameters/start'
+        - $ref: '#/components/parameters/count'

       responses:
         '200':
           description: successful operation
       responses:
         '200':
           description: successful operation


@@ -3008,6 +3474,7 @@ paths:
                 $ref: '#/components/schemas/VideoListResponse'
     post:
       summary: Add a video in a playlist
                 $ref: '#/components/schemas/VideoListResponse'
     post:
       summary: Add a video in a playlist

+      operationId: addVideoPlaylistVideo

       security:
         - OAuth2: []
       tags:
       security:
         - OAuth2: []
       tags:


@@ -3054,6 +3521,7 @@ paths:
   /video-playlists/{playlistId}/videos/reorder:
     post:
       summary: 'Reorder a playlist'
   /video-playlists/{playlistId}/videos/reorder:
     post:
       summary: 'Reorder a playlist'

+      operationId: reorderVideoPlaylist

       security:
         - OAuth2: []
       tags:
       security:
         - OAuth2: []
       tags:


@@ -3088,6 +3556,7 @@ paths:
   /video-playlists/{playlistId}/videos/{playlistElementId}:
     put:
       summary: Update a playlist element
   /video-playlists/{playlistId}/videos/{playlistElementId}:
     put:
       summary: Update a playlist element

+      operationId: putVideoPlaylistVideo

       security:
         - OAuth2: []
       tags:
       security:
         - OAuth2: []
       tags:


@@ -3114,6 +3583,7 @@ paths:
                   description: Stop the video at this specific timestamp
     delete:
       summary: Delete an element from a playlist
                   description: Stop the video at this specific timestamp
     delete:
       summary: Delete an element from a playlist

+      operationId: delVideoPlaylistVideo

       security:
         - OAuth2: []
       tags:
       security:
         - OAuth2: []
       tags:


@@ -3175,7 +3645,7 @@ paths:
         - $ref: '#/components/parameters/name'
         - name: withStats
           in: query
         - $ref: '#/components/parameters/name'
         - name: withStats
           in: query

-          description: include view statistics for the last 30 days (only if authentified as the account user)
+          description: include daily view statistics for the last 30 days and total views (only if authentified as the account user)

           schema:
             type: boolean
         - $ref: '#/components/parameters/start'
           schema:
             type: boolean
         - $ref: '#/components/parameters/start'


@@ -3363,11 +3833,75 @@ paths:
         '404':
           description: video does not exist
 
         '404':
           description: video does not exist
 

+  '/videos/{id}/hls':
+    delete:
+      summary: Delete video HLS files
+      security:
+        - OAuth2:
+          - admin
+      tags:
+        - Video Files
+      operationId: delVideoHLS
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      responses:
+        '204':
+          description: successful operation
+        '404':
+          description: video does not exist
+  '/videos/{id}/webtorrent':
+    delete:
+      summary: Delete video WebTorrent files
+      security:
+        - OAuth2:
+          - admin
+      tags:
+        - Video Files
+      operationId: delVideoWebTorrent
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      responses:
+        '204':
+          description: successful operation
+        '404':
+          description: video does not exist
+
+  '/videos/{id}/transcoding':
+    post:
+      summary: Create a transcoding job
+      security:
+        - OAuth2:
+          - admin
+      tags:
+        - Video Transcoding
+      operationId: createVideoTranscoding
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      requestBody:
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  transcodingType:
+                    type: string
+                    enum:
+                      - hls
+                      - webtorrent
+                required:
+                  - transcodingType
+      responses:
+        '204':
+          description: successful operation
+        '404':
+          description: video does not exist
+

   /search/videos:
     get:
       tags:
         - Search
       summary: Search videos
   /search/videos:
     get:
       tags:
         - Search
       summary: Search videos

+      operationId: searchVideos

       parameters:
         - name: search
           in: query
       parameters:
         - name: search
           in: query


@@ -3386,7 +3920,11 @@ paths:
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'
         - $ref: '#/components/parameters/licenceOneOf'
         - $ref: '#/components/parameters/languageOneOf'
         - $ref: '#/components/parameters/nsfw'

-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/isLocal'
+        - $ref: '#/components/parameters/include'
+        - $ref: '#/components/parameters/privacyOneOf'
+        - $ref: '#/components/parameters/hasHLSFiles'
+        - $ref: '#/components/parameters/hasWebtorrentFiles'

         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'
         - $ref: '#/components/parameters/skipCount'
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'


@@ -3444,6 +3982,7 @@ paths:
       tags:
         - Search
       summary: Search channels
       tags:
         - Search
       summary: Search channels

+      operationId: searchChannels

       parameters:
         - name: search
           in: query
       parameters:
         - name: search
           in: query


@@ -3471,6 +4010,80 @@ paths:
         '500':
           description: search index unavailable
 
         '500':
           description: search index unavailable
 

+  /search/video-playlists:
+    get:
+      tags:
+        - Search
+      summary: Search playlists
+      operationId: searchPlaylists
+      parameters:
+        - name: search
+          in: query
+          required: true
+          description: >
+            String to search. If the user can make a remote URI search, and the string is an URI then the
+            PeerTube instance will fetch the remote object and add it to its database. Then,
+            you can use the REST API to fetch the complete playlist information and interact with it.
+          schema:
+            type: string
+        - $ref: '#/components/parameters/start'
+        - $ref: '#/components/parameters/count'
+        - $ref: '#/components/parameters/searchTarget'
+        - $ref: '#/components/parameters/sort'
+      callbacks:
+        'searchTarget === search-index':
+          $ref: '#/components/callbacks/searchIndex'
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  total:
+                    type: integer
+                    example: 1
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/VideoPlaylist'
+        '500':
+          description: search index unavailable
+
+  /blocklist/status:
+    get:
+      tags:
+        - Account Blocks
+        - Server Blocks
+      summary: Get block status of accounts/hosts
+      parameters:
+        -
+          name: 'accounts'
+          in: query
+          description: 'Check if these accounts are blocked'
+          example: [ 'goofy@example.com', 'donald@example.com' ]
+          schema:
+            type: array
+            items:
+              type: string
+        -
+          name: 'hosts'
+          in: query
+          description: 'Check if these hosts are blocked'
+          example: [ 'example.com' ]
+          schema:
+            type: array
+            items:
+              type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            'application/json':
+              schema:
+                $ref: '#/components/schemas/BlockStatus'
+

   /server/blocklist/accounts:
     get:
       tags:
   /server/blocklist/accounts:
     get:
       tags:


@@ -3632,6 +4245,7 @@ paths:
       tags:
         - Video Mirroring
       summary: List videos being mirrored
       tags:
         - Video Mirroring
       summary: List videos being mirrored

+      operationId: getMirroredVideos

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -3661,6 +4275,7 @@ paths:
       tags:
         - Video Mirroring
       summary: Mirror a video
       tags:
         - Video Mirroring
       summary: Mirror a video

+      operationId: putMirroredVideo

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -3689,6 +4304,7 @@ paths:
       tags:
         - Video Mirroring
       summary: Delete a mirror done on a video
       tags:
         - Video Mirroring
       summary: Delete a mirror done on a video

+      operationId: delMirroredVideo

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -3705,11 +4321,80 @@ paths:
         '404':
           description: video redundancy not found
 
         '404':
           description: video redundancy not found
 

+  /server/stats:
+    get:
+      tags:
+        - Stats
+      summary: Get instance stats
+      description: Get instance public statistics. This endpoint is cached.
+      operationId: getInstanceStats
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ServerStats'
+
+  /server/logs/client:
+    post:
+      tags:
+        - Logs
+      summary: Send client log
+      operationId: sendClientLog
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SendClientLog'
+      responses:
+        '204':
+          description: successful operation
+
+  /server/logs:
+    get:
+      tags:
+        - Logs
+      summary: Get instance logs
+      operationId: getInstanceLogs
+      security:
+        - OAuth2:
+          - admin
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+
+  /server/audit-logs:
+    get:
+      tags:
+        - Logs
+      summary: Get instance audit logs
+      operationId: getInstanceAuditLogs
+      security:
+        - OAuth2:
+          - admin
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+

   '/feeds/video-comments.{format}':
     get:
       tags:
         - Feeds
       summary: List comments on videos
   '/feeds/video-comments.{format}':
     get:
       tags:
         - Feeds
       summary: List comments on videos

+      operationId: getSyndicatedComments

       parameters:
         - name: format
           in: path
       parameters:
         - name: format
           in: path


@@ -3804,6 +4489,7 @@ paths:
       tags:
         - Feeds
       summary: List videos
       tags:
         - Feeds
       summary: List videos

+      operationId: getSyndicatedVideos

       parameters:
         - name: format
           in: path
       parameters:
         - name: format
           in: path


@@ -3841,7 +4527,11 @@ paths:
             type: string
         - $ref: '#/components/parameters/sort'
         - $ref: '#/components/parameters/nsfw'
             type: string
         - $ref: '#/components/parameters/sort'
         - $ref: '#/components/parameters/nsfw'

-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/isLocal'
+        - $ref: '#/components/parameters/include'
+        - $ref: '#/components/parameters/privacyOneOf'
+        - $ref: '#/components/parameters/hasHLSFiles'
+        - $ref: '#/components/parameters/hasWebtorrentFiles'

       responses:
         '204':
           description: successful operation
       responses:
         '204':
           description: successful operation


@@ -3892,6 +4582,7 @@ paths:
         - Feeds
         - Account
       summary: List videos of subscriptions tied to a token
         - Feeds
         - Account
       summary: List videos of subscriptions tied to a token

+      operationId: getSyndicatedSubscriptionVideos

       parameters:
         - name: format
           in: path
       parameters:
         - name: format
           in: path


@@ -3921,7 +4612,11 @@ paths:
           required: true
         - $ref: '#/components/parameters/sort'
         - $ref: '#/components/parameters/nsfw'
           required: true
         - $ref: '#/components/parameters/sort'
         - $ref: '#/components/parameters/nsfw'

-        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/isLocal'
+        - $ref: '#/components/parameters/include'
+        - $ref: '#/components/parameters/privacyOneOf'
+        - $ref: '#/components/parameters/hasHLSFiles'
+        - $ref: '#/components/parameters/hasWebtorrentFiles'

       responses:
         '204':
           description: successful operation
       responses:
         '204':
           description: successful operation


@@ -3954,6 +4649,7 @@ paths:
       tags:
         - Plugins
       summary: List plugins
       tags:
         - Plugins
       summary: List plugins

+      operationId: getPlugins

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -3982,6 +4678,7 @@ paths:
       tags:
         - Plugins
       summary: List available plugins
       tags:
         - Plugins
       summary: List available plugins

+      operationId: getAvailablePlugins

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -4016,6 +4713,7 @@ paths:
       tags:
         - Plugins
       summary: Install a plugin
       tags:
         - Plugins
       summary: Install a plugin

+      operationId: addPlugin

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -4050,6 +4748,7 @@ paths:
       tags:
         - Plugins
       summary: Update a plugin
       tags:
         - Plugins
       summary: Update a plugin

+      operationId: updatePlugin

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -4086,6 +4785,7 @@ paths:
       tags:
         - Plugins
       summary: Uninstall a plugin
       tags:
         - Plugins
       summary: Uninstall a plugin

+      operationId: uninstallPlugin

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -4112,6 +4812,7 @@ paths:
       tags:
         - Plugins
       summary: Get a plugin
       tags:
         - Plugins
       summary: Get a plugin

+      operationId: getPlugin

       security:
         - OAuth2:
           - admin
       security:
         - OAuth2:
           - admin


@@ -4257,23 +4958,31 @@ components:
       name: sort
       in: query
       required: false
       name: sort
       in: query
       required: false

-      description: Sort videos by criteria

       schema:
         type: string
         enum:
       schema:
         type: string
         enum:

-        - name
-        - -duration
-        - -createdAt
-        - -publishedAt
-        - -views
-        - -likes
-        - -trending
-        - -hot
+          - name
+          - -duration
+          - -createdAt
+          - -publishedAt
+          - -views
+          - -likes
+          - -trending
+          - -hot
+          - -best
+        description: >
+          Sort videos by criteria (prefixing with `-` means `DESC` order):
+            * `hot` - Adaptation of Reddit "hot" algorithm taking into account video views, likes, dislikes and comments and publication date
+            * `best` - Same than `hot`, but also takes into account user video history
+            * `trending` - Sort videos by recent views ("recent" is defined by the admin)
+            * `views` - Sort videos using their `views` counter
+            * `publishedAt` - Sort by video publication date (when it became publicly available)

     videosSearchSort:
       name: sort
       in: query
       required: false
     videosSearchSort:
       name: sort
       in: query
       required: false

-      description: Sort videos by criteria
+      description: >
+        Sort videos by criteria (prefixing with `-` means `DESC` order):

       schema:
         type: string
         enum:
       schema:
         type: string
         enum:


@@ -4298,7 +5007,7 @@ components:
       name: sort
       in: query
       required: false
       name: sort
       in: query
       required: false

-      description: Sort blacklists by criteria
+      description: Sort blocklists by criteria

       schema:
         type: string
         enum:
       schema:
         type: string
         enum:


@@ -4355,6 +5064,15 @@ components:
         type: string
         enum:
         - name
         type: string
         enum:
         - name

+    followersSort:
+      name: sort
+      in: query
+      required: false
+      description: Sort followers by criteria
+      schema:
+        type: string
+        enum:
+        - createdAt

     name:
       name: name
       in: path
     name:
       name: name
       in: path


@@ -4367,18 +5085,19 @@ components:
       name: id
       in: path
       required: true
       name: id
       in: path
       required: true

-      description: The user id
+      description: Entity id

       schema:
         $ref: '#/components/schemas/id'
     idOrUUID:
       name: id
       in: path
       required: true
       schema:
         $ref: '#/components/schemas/id'
     idOrUUID:
       name: id
       in: path
       required: true

-      description: The object id or uuid
+      description: The object id, uuid or short uuid

       schema:
         oneOf:
           - $ref: '#/components/schemas/id'
           - $ref: '#/components/schemas/UUIDv4'
       schema:
         oneOf:
           - $ref: '#/components/schemas/id'
           - $ref: '#/components/schemas/UUIDv4'

+          - $ref: '#/components/schemas/shortUUID'

     playlistId:
       name: playlistId
       in: path
     playlistId:
       name: playlistId
       in: path


@@ -4436,7 +5155,7 @@ components:
       required: true
       description: The thread id (root comment id)
       schema:
       required: true
       description: The thread id (root comment id)
       schema:

-        $ref: '#/components/schemas/VideoCommentThreadTree/properties/comment/properties/id'
+        type: integer

     commentId:
       name: commentId
       in: path
     commentId:
       name: commentId
       in: path


@@ -4538,20 +5257,58 @@ components:
         enum:
         - 'true'
         - 'false'
         enum:
         - 'true'
         - 'false'

-    filter:
-      name: filter
+    isLocal:
+      name: isLocal
+      in: query
+      required: false
+      schema:
+        type: boolean
+      description: '**PeerTube >= 4.0** Display only local or remote videos'
+    hasHLSFiles:
+      name: hasHLSFiles
+      in: query
+      required: false
+      schema:
+        type: boolean
+      description: '**PeerTube >= 4.0** Display only videos that have HLS files'
+    hasWebtorrentFiles:
+      name: hasWebtorrentFiles
+      in: query
+      required: false
+      schema:
+        type: boolean
+      description: '**PeerTube >= 4.0** Display only videos that have WebTorrent files'
+    privacyOneOf:
+      name: privacyOneOf
+      in: query
+      required: false
+      schema:
+        $ref: '#/components/schemas/VideoPrivacySet'
+      description: '**PeerTube >= 4.0** Display only videos in this specific privacy/privacies'
+    include:
+      name: include

       in: query
       required: false
       in: query
       required: false

-      description: >
-        Special filters which might require special rights:
-         * `local` - only videos local to the instance
-         * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
-         * `all` - all videos, showing private and unlisted videos (requires Admin privileges)

       schema:
       schema:

-        type: string
+        type: integer

         enum:
         enum:

-        - local
-        - all-local
+        - 0
+        - 1
+        - 2
+        - 4
+        - 8
+      description: >
+        **PeerTube >= 4.0** Include additional videos in results (can be combined using bitwise or operator)
+
+        - `0` NONE
+
+        - `1` NOT_PUBLISHED_STATE
+
+        - `2` BLACKLISTED
+
+        - `4` BLOCKED_OWNER
+
+        - `8` FILES

     subscriptionsUris:
       name: uris
       in: query
     subscriptionsUris:
       name: uris
       in: query


@@ -4586,7 +5343,7 @@ components:
           - video-transcoding
           - video-file-import
           - video-import
           - video-transcoding
           - video-file-import
           - video-import

-          - videos-views
+          - videos-views-stats

           - activitypub-refresher
           - video-redundancy
           - video-live-ending
           - activitypub-refresher
           - video-redundancy
           - video-live-ending


@@ -4631,7 +5388,7 @@ components:
             moderator: Moderator scope
             user: User scope
   schemas:
             moderator: Moderator scope
             user: User scope
   schemas:

-    # Resuable core properties
+    # Reusable core properties

     id:
       type: integer
       minimum: 1
     id:
       type: integer
       minimum: 1


@@ -4643,6 +5400,10 @@ components:
       pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
       minLength: 36
       maxLength: 36
       pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
       minLength: 36
       maxLength: 36

+    shortUUID:
+      type: string
+      description: translation of a uuid v4 with a bigger alphabet to have a shorter uuid
+      example: 2y84q2MQUMWPbiEcxNXMgC

     username:
       type: string
       description: immutable name of the user, used to find or mention its actor
     username:
       type: string
       description: immutable name of the user, used to find or mention its actor


@@ -4741,6 +5502,29 @@ components:
         label:
           type: string
 
         label:
           type: string
 

+    BlockStatus:
+      properties:
+        accounts:
+          type: object
+          additionalProperties:
+            x-additionalPropertiesName: account
+            type: object
+            properties:
+              blockedByServer:
+                type: boolean
+              blockedByUser:
+                type: boolean
+        hosts:
+          type: object
+          additionalProperties:
+            x-additionalPropertiesName: host
+            type: object
+            properties:
+              blockedByServer:
+                type: boolean
+              blockedByUser:
+                type: boolean
+

     NSFWPolicy:
       type: string
       enum:
     NSFWPolicy:
       type: string
       enum:


@@ -4761,9 +5545,17 @@ components:
       enum:
         - 0
         - 1
       enum:
         - 0
         - 1

-      description: 'Admin flags for the user (None = `0`, Bypass video blacklist = `1`)'
+      description: 'Admin flags for the user (None = `0`, Bypass video blocklist = `1`)'

       example: 1
 
       example: 1
 

+    LiveVideoLatencyMode:
+      type: integer
+      enum:
+        - 1
+        - 2
+        - 3
+      description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)'
+

     VideoStateConstant:
       properties:
         id:
     VideoStateConstant:
       properties:
         id:


@@ -4772,7 +5564,23 @@ components:
             - 1
             - 2
             - 3
             - 1
             - 2
             - 3

-          description: 'The video state (Published = `1`, to transcode = `2`, to import = `3`)'
+            - 4
+            - 5
+            - 6
+            - 7
+            - 8
+            - 9
+          description: |
+            The video state:
+            - `1`: Published
+            - `2`: To transcode
+            - `3`: To import
+            - `4`: Waiting for live stream
+            - `5`: Live ended
+            - `6`: To move to an external storage (object storage...)
+            - `7`: Transcoding failed
+            - `8`: Moving to an external storage failed
+            - `9`: To edit using studio edition feature

         label:
           type: string
 
         label:
           type: string
 


@@ -4843,10 +5651,10 @@ components:
         host:
           type: string
           format: hostname
         host:
           type: string
           format: hostname

-        avatar:
-          nullable: true
-          allOf:
-            - $ref: '#/components/schemas/ActorImage'
+        avatars:
+          type: array
+          items:
+            $ref: '#/components/schemas/ActorImage'

     VideoChannelSummary:
       properties:
         id:
     VideoChannelSummary:
       properties:
         id:


@@ -4861,10 +5669,10 @@ components:
         host:
           type: string
           format: hostname
         host:
           type: string
           format: hostname

-        avatar:
-          nullable: true
-          allOf:
-            - $ref: '#/components/schemas/ActorImage'
+        avatars:
+          type: array
+          items:
+            $ref: '#/components/schemas/ActorImage'

     PlaylistElement:
       properties:
         position:
     PlaylistElement:
       properties:
         position:


@@ -4882,11 +5690,12 @@ components:
     VideoFile:
       readOnly: true
       properties:
     VideoFile:
       readOnly: true
       properties:

+        id:
+          $ref: '#/components/schemas/id'

         magnetUri:
           type: string
           format: uri
           description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file
         magnetUri:
           type: string
           format: uri
           description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file

-          example: magnet:?xs=https%3A%2F%2Fframatube.org%2Fstatic%2Ftorrents%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.torrent&xt=urn:btih:38b4747ff788b30bf61f59d1965cd38f9e48e01f&dn=What+is+PeerTube%3F&tr=wss%3A%2F%2Fframatube.org%2Ftracker%2Fsocket&tr=https%3A%2F%2Fframatube.org%2Ftracker%2Fannounce&ws=https%3A%2F%2Fframatube.org%2Fstatic%2Fwebseed%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.mp4

           pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
         resolution:
           $ref: '#/components/schemas/VideoResolutionConstant'
           pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
         resolution:
           $ref: '#/components/schemas/VideoResolutionConstant'


@@ -4972,6 +5781,9 @@ components:
           description: universal identifier for the video, that can be used across instances
           allOf:
             - $ref: '#/components/schemas/UUIDv4'
           description: universal identifier for the video, that can be used across instances
           allOf:
             - $ref: '#/components/schemas/UUIDv4'

+        shortUUID:
+          allOf:
+            - $ref: '#/components/schemas/shortUUID'

         isLive:
           type: boolean
         createdAt:
         isLive:
           type: boolean
         createdAt:


@@ -5085,6 +5897,9 @@ components:
         - $ref: '#/components/schemas/Video'
         - type: object
           properties:
         - $ref: '#/components/schemas/Video'
         - type: object
           properties:

+            viewers:
+              type: integer
+              description: If the video is a live, you have the amount of current viewers

             descriptionPath:
               type: string
               example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description
             descriptionPath:
               type: string
               example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description


@@ -5233,7 +6048,6 @@ components:
           type: string
           format: uri
           description: magnet URI allowing to resolve the import's source video
           type: string
           format: uri
           description: magnet URI allowing to resolve the import's source video

-          example: magnet:?xs=https%3A%2F%2Fframatube.org%2Fstatic%2Ftorrents%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.torrent&xt=urn:btih:38b4747ff788b30bf61f59d1965cd38f9e48e01f&dn=What+is+PeerTube%3F&tr=wss%3A%2F%2Fframatube.org%2Ftracker%2Fsocket&tr=https%3A%2F%2Fframatube.org%2Ftracker%2Fannounce&ws=https%3A%2F%2Fframatube.org%2Fstatic%2Fwebseed%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.mp4

           pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
         torrentfile:
           writeOnly: true
           pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
         torrentfile:
           writeOnly: true


@@ -5351,6 +6165,9 @@ components:
           $ref: '#/components/schemas/id'
         uuid:
           $ref: '#/components/schemas/UUIDv4'
           $ref: '#/components/schemas/id'
         uuid:
           $ref: '#/components/schemas/UUIDv4'

+        shortUUID:
+          allOf:
+            - $ref: '#/components/schemas/shortUUID'

         createdAt:
           type: string
           format: date-time
         createdAt:
           type: string
           format: date-time


@@ -5437,10 +6254,16 @@ components:
           $ref: '#/components/schemas/VideoConstantString-Language'
         captionPath:
           type: string
           $ref: '#/components/schemas/VideoConstantString-Language'
         captionPath:
           type: string

+    VideoSource:
+      properties:
+        filename:
+          type: string

     ActorImage:
       properties:
         path:
           type: string
     ActorImage:
       properties:
         path:
           type: string

+        width:
+          type: integer

         createdAt:
           type: string
           format: date-time
         createdAt:
           type: string
           format: date-time


@@ -5458,12 +6281,10 @@ components:
         host:
           type: string
           format: hostname
         host:
           type: string
           format: hostname

-        avatar:
-          nullable: true
-          type: object
-          properties:
-            path:
-              type: string
+        avatars:
+          type: array
+          items:
+            $ref: '#/components/schemas/ActorImage'

     Actor:
       properties:
         id:
     Actor:
       properties:
         id:


@@ -5496,8 +6317,6 @@ components:
         updatedAt:
           type: string
           format: date-time
         updatedAt:
           type: string
           format: date-time

-        avatar:
-          $ref: '#/components/schemas/ActorImage'

     Account:
       allOf:
         - $ref: '#/components/schemas/Actor'
     Account:
       allOf:
         - $ref: '#/components/schemas/Actor'


@@ -5514,13 +6333,68 @@ components:
             description:
               type: string
               description: text or bio displayed on the account's profile
             description:
               type: string
               description: text or bio displayed on the account's profile

-    UserWatchingVideo:
+    UserViewingVideo:
+      required:
+        - currentTime

       properties:
         currentTime:
           type: integer
           format: seconds
           description: timestamp within the video, in seconds
           example: 5
       properties:
         currentTime:
           type: integer
           format: seconds
           description: timestamp within the video, in seconds
           example: 5

+        viewEvent:
+          type: string
+          enum:
+            - seek
+          description: >
+            Event since last viewing call:
+             * `seek` - If the user seeked the video
+
+    VideoStatsOverall:
+      properties:
+        averageWatchTime:
+          type: number
+        totalWatchTime:
+          type: number
+        viewersPeak:
+          type: number
+        viewersPeakDate:
+          type: string
+          format: date-time
+        countries:
+          type: array
+          items:
+            type: object
+            properties:
+              isoCode:
+                type: string
+              viewers:
+                type: number
+
+    VideoStatsRetention:
+      properties:
+        data:
+          type: array
+          items:
+            type: object
+            properties:
+              second:
+                type: number
+              retentionPercent:
+                type: number
+
+    VideoStatsTimeserie:
+      properties:
+        data:
+          type: array
+          items:
+            type: object
+            properties:
+              date:
+                type: string
+              value:
+                type: number
+

     ServerConfig:
       properties:
         instance:
     ServerConfig:
       properties:
         instance:


@@ -5720,6 +6594,102 @@ components:
                     indexUrl:
                       type: string
                       format: url
                     indexUrl:
                       type: string
                       format: url

+        homepage:
+          type: object
+          properties:
+            enabled:
+              type: boolean
+
+    SendClientLog:
+      properties:
+        message:
+          type: string
+        url:
+          type: string
+          description: URL of the current user page
+        level:
+          enum:
+            - error
+            - warn
+        stackTrace:
+          type: string
+          description: Stack trace of the error if there is one
+        userAgent:
+          type: string
+          description: User agent of the web browser that sends the message
+        meta:
+          type: string
+          description: Additional information regarding this log
+      required:
+        - message
+        - url
+        - level
+
+    ServerStats:
+      properties:
+        totalUsers:
+          type: number
+        totalDailyActiveUsers:
+          type: number
+        totalWeeklyActiveUsers:
+          type: number
+        totalMonthlyActiveUsers:
+          type: number
+        totalLocalVideos:
+          type: number
+        totalLocalVideoViews:
+          type: number
+          description: Total video views made on the instance
+        totalLocalVideoComments:
+          type: number
+          description: Total comments made by local users
+        totalLocalVideoFilesSize:
+          type: number
+        totalVideos:
+          type: number
+        totalVideoComments:
+          type: number
+        totalLocalVideoChannels:
+          type: number
+        totalLocalDailyActiveVideoChannels:
+          type: number
+        totalLocalWeeklyActiveVideoChannels:
+          type: number
+        totalLocalMonthlyActiveVideoChannels:
+          type: number
+        totalLocalPlaylists:
+          type: number
+        totalInstanceFollowers:
+          type: number
+        totalInstanceFollowing:
+          type: number
+        videosRedundancy:
+          type: array
+          items:
+            type: object
+            properties:
+                strategy:
+                  type: string
+                totalSize:
+                  type: number
+                totalUsed:
+                  type: number
+                totalVideoFiles:
+                  type: number
+                totalVideos:
+                  type: number
+        totalActivityPubMessagesProcessed:
+          type: number
+        totalActivityPubMessagesSuccesses:
+          type: number
+        totalActivityPubMessagesErrors:
+          type: number
+
+        activityPubMessagesProcessedPerSecond:
+          type: number
+        totalActivityPubMessagesWaiting:
+          type: number
+

     ServerConfigAbout:
       properties:
         instance:
     ServerConfigAbout:
       properties:
         instance:


@@ -5847,6 +6817,8 @@ components:
               properties:
                 0p:
                   type: boolean
               properties:
                 0p:
                   type: boolean

+                144p:
+                  type: boolean

                 240p:
                   type: boolean
                 360p:
                 240p:
                   type: boolean
                 360p:


@@ -5910,6 +6882,12 @@ components:
                   type: boolean
                 manualApproval:
                   type: boolean
                   type: boolean
                 manualApproval:
                   type: boolean

+
+    CustomHomepage:
+      properties:
+        content:
+          type: string
+

     Follow:
       properties:
         id:
     Follow:
       properties:
         id:


@@ -5972,7 +6950,7 @@ components:
             - video-transcoding
             - email
             - video-import
             - video-transcoding
             - email
             - video-import

-            - videos-views
+            - videos-views-stats

             - activitypub-refresher
             - video-redundancy
         data:
             - activitypub-refresher
             - video-redundancy
         data:


@@ -6114,6 +7092,8 @@ components:
               $ref: '#/components/schemas/Video/properties/id'
             uuid:
               $ref: '#/components/schemas/Video/properties/uuid'
               $ref: '#/components/schemas/Video/properties/id'
             uuid:
               $ref: '#/components/schemas/Video/properties/uuid'

+            shortUUID:
+              $ref: '#/components/schemas/Video/properties/shortUUID'

     CommentThreadResponse:
       properties:
         total:
     CommentThreadResponse:
       properties:
         total:


@@ -6176,6 +7156,8 @@ components:
           format: date-time
         noInstanceConfigWarningModal:
           type: boolean
           format: date-time
         noInstanceConfigWarningModal:
           type: boolean

+        noAccountSetupWarningModal:
+          type: boolean

         noWelcomeModal:
           type: boolean
         nsfwPolicy:
         noWelcomeModal:
           type: boolean
         nsfwPolicy:


@@ -6205,7 +7187,7 @@ components:
           type: integer
           description: The user daily video quota in bytes
           example: -1
           type: integer
           description: The user daily video quota in bytes
           example: -1

-        webtorrentEnabled:
+        p2pEnabled:

           type: boolean
           description: Enable P2P in the player
     UserWithStats:
           type: boolean
           description: Enable P2P in the player
     UserWithStats:


@@ -6215,7 +7197,7 @@ components:
             # optionally present fields: they require WITH_STATS scope
             videosCount:
               type: integer
             # optionally present fields: they require WITH_STATS scope
             videosCount:
               type: integer

-              description: Count of videos published 
+              description: Count of videos published

             abusesCount:
               type: integer
               description: Count of reports/abuses of which the user is a target
             abusesCount:
               type: integer
               description: Count of reports/abuses of which the user is a target


@@ -6283,6 +7265,8 @@ components:
           $ref: '#/components/schemas/UserRole'
         adminFlags:
           $ref: '#/components/schemas/UserAdminFlags'
           $ref: '#/components/schemas/UserRole'
         adminFlags:
           $ref: '#/components/schemas/UserAdminFlags'

+        password:
+          $ref: '#/components/schemas/password'

     UpdateMe:
       # see shared/models/users/user-update-me.model.ts:
       properties:
     UpdateMe:
       # see shared/models/users/user-update-me.model.ts:
       properties:


@@ -6306,7 +7290,7 @@ components:
             - 'true'
             - 'false'
             - both
             - 'true'
             - 'false'
             - both

-        webTorrentEnabled:
+        p2pEnabled:

           type: boolean
           description: whether to enable P2P in the player or not
         autoPlayVideo:
           type: boolean
           description: whether to enable P2P in the player or not
         autoPlayVideo:


@@ -6330,6 +7314,8 @@ components:
           type: string
         noInstanceConfigWarningModal:
           type: boolean
           type: string
         noInstanceConfigWarningModal:
           type: boolean

+        noAccountSetupWarningModal:
+          type: boolean

         noWelcomeModal:
           type: boolean
     GetMeVideoRating:
         noWelcomeModal:
           type: boolean
     GetMeVideoRating:


@@ -6384,7 +7370,7 @@ components:
             name:
               $ref: '#/components/schemas/usernameChannel'
             displayName:
             name:
               $ref: '#/components/schemas/usernameChannel'
             displayName:

-              $ref: '#/components/schemas/VideoChannel/properties/displayName'
+              type: string

       required:
         - username
         - password
       required:
         - username
         - password


@@ -6446,46 +7432,47 @@ components:
         - refresh_token
 
     VideoChannel:
         - refresh_token
 
     VideoChannel:

-      properties:
-        # GET/POST/PUT properties
-        displayName:
-          type: string
-          description: editable name of the channel, displayed in its representations
-          example: Videos of Framasoft
-          minLength: 1
-          maxLength: 120
-        description:
-          type: string
-          example: Videos made with <3 by Framasoft
-          minLength: 3
-          maxLength: 1000
-        support:
-          type: string
-          description: text shown by default on all videos of this channel, to tell the audience how to support it
-          example: Please support our work on https://soutenir.framasoft.org/en/ <3
-          minLength: 3
-          maxLength: 1000
-        # GET-only properties
-        id:
-          readOnly: true
-          allOf:
-            - $ref: '#/components/schemas/id'
-        isLocal:
-          readOnly: true
-          type: boolean
-        updatedAt:
-          readOnly: true
-          type: string
-          format: date-time
-        ownerAccount:
-          readOnly: true
-          nullable: true
-          type: object
+      allOf:
+        - $ref: '#/components/schemas/Actor'
+        - type: object

           properties:
           properties:

-            id:
-              type: integer
-            uuid:
-              $ref: '#/components/schemas/UUIDv4'
+            displayName:
+              type: string
+              description: editable name of the channel, displayed in its representations
+              example: Videos of Framasoft
+              minLength: 1
+              maxLength: 120
+            description:
+              type: string
+              example: Videos made with <3 by Framasoft
+              minLength: 3
+              maxLength: 1000
+            support:
+              type: string
+              description: text shown by default on all videos of this channel, to tell the audience how to support it
+              example: Please support our work on https://soutenir.framasoft.org/en/ <3
+              minLength: 3
+              maxLength: 1000
+            isLocal:
+              readOnly: true
+              type: boolean
+            updatedAt:
+              readOnly: true
+              type: string
+              format: date-time
+            banners:
+              type: array
+              items:
+                $ref: '#/components/schemas/ActorImage'
+            ownerAccount:
+              readOnly: true
+              nullable: true
+              type: object
+              properties:
+                id:
+                  type: integer
+                uuid:
+                  $ref: '#/components/schemas/UUIDv4'

     VideoChannelCreate:
       allOf:
         - $ref: '#/components/schemas/VideoChannel'
     VideoChannelCreate:
       allOf:
         - $ref: '#/components/schemas/VideoChannel'


@@ -6715,7 +7702,7 @@ components:
       enum:
         - 0
         - 1
       enum:
         - 0
         - 1

-        - 3
+        - 2

     Notification:
       properties:
         id:
     Notification:
       properties:
         id:


@@ -6752,6 +7739,14 @@ components:
             - `13` NEW_INSTANCE_FOLLOWER
 
             - `14` AUTO_INSTANCE_FOLLOWING
             - `13` NEW_INSTANCE_FOLLOWER
 
             - `14` AUTO_INSTANCE_FOLLOWING

+
+            - `15` ABUSE_STATE_CHANGE
+
+            - `16` ABUSE_NEW_MESSAGE
+
+            - `17` NEW_PLUGIN_VERSION
+
+            - `18` NEW_PEERTUBE_VERSION

         read:
           type: boolean
         video:
         read:
           type: boolean
         video:


@@ -6919,21 +7914,131 @@ components:
         permanentLive:
           description: User can stream multiple times in a permanent live
           type: boolean
         permanentLive:
           description: User can stream multiple times in a permanent live
           type: boolean

+        latencyMode:
+          description: User can select live latency mode if enabled by the instance
+          $ref: '#/components/schemas/LiveVideoLatencyMode'

 
     LiveVideoResponse:
       properties:
         rtmpUrl:
           type: string
 
     LiveVideoResponse:
       properties:
         rtmpUrl:
           type: string

+          description: Included in the response if an appropriate token is provided
+        rtmpsUrl:
+          type: string
+          description: Included in the response if an appropriate token is provided

         streamKey:
           type: string
         streamKey:
           type: string

-          description: RTMP stream key to use to stream into this live video
+          description: RTMP stream key to use to stream into this live video. Included in the response if an appropriate token is provided

         saveReplay:
           type: boolean
         permanentLive:
           description: User can stream multiple times in a permanent live
           type: boolean
         saveReplay:
           type: boolean
         permanentLive:
           description: User can stream multiple times in a permanent live
           type: boolean

+        latencyMode:
+          description: User can select live latency mode if enabled by the instance
+          $ref: '#/components/schemas/LiveVideoLatencyMode'

 
 

+    VideoStudioCreateTask:
+      type: array
+      items:
+        anyOf:
+          -
+            title: cut
+            type: object
+            properties:
+              name:
+                type: string
+                enum:
+                  - 'cut'
+              options:
+                type: object
+                properties:
+                  start:
+                    type: integer
+                  end:
+                    type: integer
+          -
+            title: add-intro
+            type: object
+            properties:
+              name:
+                type: string
+                enum:
+                  - 'add-intro'
+              options:
+                type: object
+                properties:
+                  file:
+                    type: string
+                    format: binary
+          -
+            title: add-outro
+            type: object
+            properties:
+              name:
+                type: string
+                enum:
+                  - 'add-outro'
+              options:
+                type: object
+                properties:
+                  file:
+                    type: string
+                    format: binary
+          -
+            title: add-watermark
+            type: object
+            properties:
+              name:
+                type: string
+                enum:
+                  - 'add-watermark'
+              options:
+                type: object
+                properties:
+                  file:
+                    type: string
+                    format: binary

 
 

+    LiveVideoSessionResponse:
+        properties:
+          id:
+            type: integer
+          startDate:
+            type: string
+            format: date-time
+            description: Start date of the live session
+          endDate:
+            type: string
+            format: date-time
+            nullable: true
+            description: End date of the live session
+          error:
+            type: integer
+            enum:
+              - 1
+              - 2
+              - 3
+              - 4
+              - 5
+            nullable: true
+            description: >
+              Error type if an error occurred during the live session:
+                - `1`: Bad socket health (transcoding is too slow)
+                - `2`: Max duration exceeded
+                - `3`: Quota exceeded
+                - `4`: Quota FFmpeg error
+                - `5`: Video has been blacklisted during the live
+          replayVideo:
+            type: object
+            description: Video replay information
+            properties:
+              id:
+                type: number
+              uuid:
+                $ref: '#/components/schemas/UUIDv4'
+              shortUUID:
+                $ref: '#/components/schemas/shortUUID'

 
   callbacks:
     searchIndex:
 
   callbacks:
     searchIndex: