deploy: b92c8c2613

2 years ago · f793e1b1b9
2 changed files with 240 additions and 25 deletions
--- a/index.html
+++ b/index.html
--- a/openapi.yaml
+++ b/openapi.yaml
@ -298,6 +298,12 @@ components:
				@@ -298,6 +298,12 @@ components:
          type: string
        rpiCameraAWB:
          type: string
+        rpiCameraAWBGains:
+          type: array
+          minItems: 2
+          maxItems: 2
+          items:
+            type: number
        rpiCameraDenoise:
          type: string
        rpiCameraShutter:
@ -483,6 +489,32 @@ components:
				@@ -483,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:
@ -654,6 +686,7 @@ paths:
				@@ -654,6 +686,7 @@ paths:
  /v3/config/global/get:
    get:
      operationId: configGlobalGet
+      tags: [Configuration]
      summary: returns the global configuration.
      description: ''
      responses:
@ -679,6 +712,7 @@ paths:
				@@ -679,6 +712,7 @@ paths:
  /v3/config/global/patch:
    patch:
      operationId: configGlobalSet
+      tags: [Configuration]
      summary: patches the global configuration.
      description: all fields are optional.
      requestBody:
@ -706,6 +740,7 @@ paths:
				@@ -706,6 +740,7 @@ paths:
  /v3/config/pathdefaults/get:
    get:
      operationId: configPathDefaultsGet
+      tags: [Configuration]
      summary: returns the default path configuration.
      description: ''
      responses:
@ -731,6 +766,7 @@ paths:
				@@ -731,6 +766,7 @@ paths:
  /v3/config/pathdefaults/patch:
    patch:
      operationId: configPathDefaultsPatch
+      tags: [Configuration]
      summary: patches the default path configuration.
      description: all fields are optional.
      requestBody:
@ -758,6 +794,7 @@ paths:
				@@ -758,6 +794,7 @@ paths:
  /v3/config/paths/list:
    get:
      operationId: configPathsList
+      tags: [Configuration]
      summary: returns all path configurations.
      description: ''
      parameters:
@ -796,6 +833,7 @@ paths:
				@@ -796,6 +833,7 @@ paths:
  /v3/config/paths/get/{name}:
    get:
      operationId: configPathsGet
+      tags: [Configuration]
      summary: returns a path configuration.
      description: ''
      parameters:
@ -834,6 +872,7 @@ paths:
				@@ -834,6 +872,7 @@ paths:
  /v3/config/paths/add/{name}:
    post:
      operationId: configPathsAdd
+      tags: [Configuration]
      summary: adds a path configuration.
      description: all fields are optional.
      parameters:
@ -868,6 +907,7 @@ paths:
				@@ -868,6 +907,7 @@ paths:
  /v3/config/paths/patch/{name}:
    patch:
      operationId: configPathsPatch
+      tags: [Configuration]
      summary: patches a path configuration.
      description: all fields are optional.
      parameters:
@ -908,6 +948,7 @@ paths:
				@@ -908,6 +948,7 @@ paths:
  /v3/config/paths/replace/{name}:
    post:
      operationId: configPathsReplace
+      tags: [Configuration]
      summary: replaces all values of a path configuration.
      description: all fields are optional.
      parameters:
@ -948,6 +989,7 @@ paths:
				@@ -948,6 +989,7 @@ paths:
  /v3/config/paths/delete/{name}:
    delete:
      operationId: configPathsDelete
+      tags: [Configuration]
      summary: removes a path configuration.
      description: ''
      parameters:
@ -982,6 +1024,7 @@ paths:
				@@ -982,6 +1024,7 @@ paths:
  /v3/hlsmuxers/list:
    get:
      operationId: hlsMuxersList
+      tags: [HLS]
      summary: returns all HLS muxers.
      description: ''
      parameters:
@ -1020,6 +1063,7 @@ paths:
				@@ -1020,6 +1063,7 @@ paths:
  /v3/hlsmuxers/get/{name}:
    get:
      operationId: hlsMuxersGet
+      tags: [HLS]
      summary: returns a HLS muxer.
      description: ''
      parameters:
@ -1058,6 +1102,7 @@ paths:
				@@ -1058,6 +1102,7 @@ paths:
  /v3/paths/list:
    get:
      operationId: pathsList
+      tags: [Paths]
      summary: returns all paths.
      description: ''
      parameters:
@ -1096,6 +1141,7 @@ paths:
				@@ -1096,6 +1141,7 @@ paths:
  /v3/paths/get/{name}:
    get:
      operationId: pathsGet
+      tags: [Paths]
      summary: returns a path.
      description: ''
      parameters:
@ -1134,6 +1180,7 @@ paths:
				@@ -1134,6 +1180,7 @@ paths:
  /v3/rtspconns/list:
    get:
      operationId: rtspConnsList
+      tags: [RTSP]
      summary: returns all RTSP connections.
      description: ''
      parameters:
@ -1172,6 +1219,7 @@ paths:
				@@ -1172,6 +1219,7 @@ paths:
  /v3/rtspconns/get/{id}:
    get:
      operationId: rtspConnsGet
+      tags: [RTSP]
      summary: returns a RTSP connection.
      description: ''
      parameters:
@ -1210,6 +1258,7 @@ paths:
				@@ -1210,6 +1258,7 @@ paths:
  /v3/rtspsessions/list:
    get:
      operationId: rtspSessionsList
+      tags: [RTSP]
      summary: returns all RTSP sessions.
      description: ''
      parameters:
@ -1248,6 +1297,7 @@ paths:
				@@ -1248,6 +1297,7 @@ paths:
  /v3/rtspsessions/get/{id}:
    get:
      operationId: rtspSessionsGet
+      tags: [RTSP]
      summary: returns a RTSP session.
      description: ''
      parameters:
@ -1286,6 +1336,7 @@ paths:
				@@ -1286,6 +1336,7 @@ paths:
  /v3/rtspsessions/kick/{id}:
    post:
      operationId: rtspSessionsKick
+      tags: [RTSP]
      summary: kicks out a RTSP session from the server.
      description: ''
      parameters:
@ -1320,6 +1371,7 @@ paths:
				@@ -1320,6 +1371,7 @@ paths:
  /v3/rtspsconns/list:
    get:
      operationId: rtspsConnsList
+      tags: [RTSP]
      summary: returns all RTSPS connections.
      description: ''
      parameters:
@ -1358,6 +1410,7 @@ paths:
				@@ -1358,6 +1410,7 @@ paths:
  /v3/rtspsconns/get/{id}:
    get:
      operationId: rtspsConnsGet
+      tags: [RTSP]
      summary: returns a RTSPS connection.
      description: ''
      parameters:
@ -1396,6 +1449,7 @@ paths:
				@@ -1396,6 +1449,7 @@ paths:
  /v3/rtspssessions/list:
    get:
      operationId: rtspsSessionsList
+      tags: [RTSP]
      summary: returns all RTSPS sessions.
      description: ''
      parameters:
@ -1434,6 +1488,7 @@ paths:
				@@ -1434,6 +1488,7 @@ paths:
  /v3/rtspssessions/get/{id}:
    get:
      operationId: rtspsSessionsGet
+      tags: [RTSP]
      summary: returns a RTSPS session.
      description: ''
      parameters:
@ -1472,6 +1527,7 @@ paths:
				@@ -1472,6 +1527,7 @@ paths:
  /v3/rtspssessions/kick/{id}:
    post:
      operationId: rtspsSessionsKick
+      tags: [RTSP]
      summary: kicks out a RTSPS session from the server.
      description: ''
      parameters:
@ -1506,6 +1562,7 @@ paths:
				@@ -1506,6 +1562,7 @@ paths:
  /v3/rtmpconns/list:
    get:
      operationId: rtmpConnsList
+      tags: [RTMP]
      summary: returns all RTMP connections.
      description: ''
      parameters:
@ -1544,6 +1601,7 @@ paths:
				@@ -1544,6 +1601,7 @@ paths:
  /v3/rtmpconns/get/{id}:
    get:
      operationId: rtmpConnectionsGet
+      tags: [RTMP]
      summary: returns a RTMP connection.
      description: ''
      parameters:
@ -1582,6 +1640,7 @@ paths:
				@@ -1582,6 +1640,7 @@ paths:
  /v3/rtmpconns/kick/{id}:
    post:
      operationId: rtmpConnsKick
+      tags: [RTMP]
      summary: kicks out a RTMP connection from the server.
      description: ''
      parameters:
@ -1616,6 +1675,7 @@ paths:
				@@ -1616,6 +1675,7 @@ paths:
  /v3/rtmpsconns/list:
    get:
      operationId: rtmpsConnsList
+      tags: [RTMP]
      summary: returns all RTMPS connections.
      description: ''
      parameters:
@ -1654,6 +1714,7 @@ paths:
				@@ -1654,6 +1714,7 @@ paths:
  /v3/rtmpsconns/get/{id}:
    get:
      operationId: rtmpsConnectionsGet
+      tags: [RTMP]
      summary: returns a RTMPS connection.
      description: ''
      parameters:
@ -1692,6 +1753,7 @@ paths:
				@@ -1692,6 +1753,7 @@ paths:
  /v3/rtmpsconns/kick/{id}:
    post:
      operationId: rtmpsConnsKick
+      tags: [RTMP]
      summary: kicks out a RTMPS connection from the server.
      description: ''
      parameters:
@ -1726,6 +1788,7 @@ paths:
				@@ -1726,6 +1788,7 @@ paths:
  /v3/srtconns/list:
    get:
      operationId: srtConnsList
+      tags: [SRT]
      summary: returns all SRT connections.
      description: ''
      parameters:
@ -1764,6 +1827,7 @@ paths:
				@@ -1764,6 +1827,7 @@ paths:
  /v3/srtconns/get/{id}:
    get:
      operationId: srtConnsGet
+      tags: [SRT]
      summary: returns a SRT connection.
      description: ''
      parameters:
@ -1802,6 +1866,7 @@ paths:
				@@ -1802,6 +1866,7 @@ paths:
  /v3/srtconns/kick/{id}:
    post:
      operationId: srtConnsKick
+      tags: [SRT]
      summary: kicks out a SRT connection from the server.
      description: ''
      parameters:
@ -1836,6 +1901,7 @@ paths:
				@@ -1836,6 +1901,7 @@ paths:
  /v3/webrtcsessions/list:
    get:
      operationId: webrtcSessionsList
+      tags: [WebRTC]
      summary: returns all WebRTC sessions.
      description: ''
      parameters:
@ -1874,6 +1940,7 @@ paths:
				@@ -1874,6 +1940,7 @@ paths:
  /v3/webrtcsessions/get/{id}:
    get:
      operationId: webrtcSessionsGet
+      tags: [WebRTC]
      summary: returns a WebRTC session.
      description: ''
      parameters:
@ -1912,6 +1979,7 @@ paths:
				@@ -1912,6 +1979,7 @@ paths:
  /v3/webrtcsessions/kick/{id}:
    post:
      operationId: webrtcSessionsKick
+      tags: [WebRTC]
      summary: kicks out a WebRTC session from the server.
      description: ''
      parameters:
@ -1942,3 +2010,122 @@ paths:
				@@ -1942,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'