api: add endpoints for recording management (#2901) (#2988)

bluenviron · Feb 4, 2024 · 0332ba5 · 0332ba5
1 parent 5e27304
commit 0332ba5
Show file tree

Hide file tree

Showing 13 changed files with 1,098 additions and 344 deletions.
diff --git a/apidocs/openapi.yaml b/apidocs/openapi.yaml
@@ -489,6 +489,32 @@ components:
           items:
             $ref: '#/components/schemas/HLSMuxer'
 
+    RecordingSegment:
+      type: object
+      properties:
+        start:
+          type: string
+
+    Recording:
+      type: object
+      properties:
+        name:
+          type: string
+        segments:
+          type: array
+          items:
+            $ref: '#/components/schemas/RecordingSegment'
+
+    RecordingList:
+      type: object
+      properties:
+        pageCount:
+          type: integer
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/Recording'
+
     RTMPConn:
       type: object
       properties:
@@ -1984,3 +2010,122 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+
+  /v3/recordings/list:
+    get:
+      operationId: recordingsList
+      tags: [Recordings]
+      summary: returns all recordings.
+      description: ''
+      parameters:
+      - name: page
+        in: query
+        description: page number.
+        schema:
+          type: integer
+          default: 0
+      - name: itemsPerPage
+        in: query
+        description: items per page.
+        schema:
+          type: integer
+          default: 100
+      responses:
+        '200':
+          description: the request was successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RecordingList'
+        '400':
+          description: invalid request.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: server error.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+
+  /v3/recordings/get/{name}:
+    get:
+      operationId: recordingsGet
+      tags: [Recordings]
+      summary: returns recordings for a path.
+      description: ''
+      parameters:
+      - name: name
+        in: path
+        required: true
+        description: name of the path.
+        schema:
+          type: string
+      responses:
+        '200':
+          description: the request was successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Recording'
+        '400':
+          description: invalid request.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '404':
+          description: path not found.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: server error.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+
+  /v3/recordings/deletesegment:
+    delete:
+      operationId: recordingsDeleteSegment
+      tags: [Recordings]
+      summary: deletes a recording segment.
+      description: ''
+      parameters:
+      - name: path
+        in: query
+        required: true
+        description: path.
+        schema:
+          type: string
+      - name: start
+        in: query
+        required: true
+        description: starting date of the segment.
+        schema:
+          type: string
+      responses:
+        '200':
+          description: the request was successful.
+        '400':
+          description: invalid request.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '404':
+          description: connection not found.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: server error.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'