Update video openapi Spec (#958)

GetStream · Feb 10, 2025 · dba2378 · dba2378
2 parents c8266a8 + 47089ad
commit dba2378
Show file tree

Hide file tree

Showing 14 changed files with 755 additions and 461 deletions.
diff --git a/docusaurus/video/docusaurus/docs/api/video-client-openapi.json b/docusaurus/video/docusaurus/docs/api/video-client-openapi.json
diff --git a/docusaurus/video/docusaurus/docs/api/video-openapi.json b/docusaurus/video/docusaurus/docs/api/video-openapi.json
diff --git a/openapi/chat-openapi-clientside.json b/openapi/chat-openapi-clientside.json
diff --git a/openapi/chat-openapi-clientside.yaml b/openapi/chat-openapi-clientside.yaml
diff --git a/openapi/chat-openapi.json b/openapi/chat-openapi.json
diff --git a/openapi/chat-openapi.yaml b/openapi/chat-openapi.yaml
diff --git a/openapi/clientside-api.json b/openapi/clientside-api.json
diff --git a/openapi/clientside-api.yaml b/openapi/clientside-api.yaml
diff --git a/openapi/serverside-api.json b/openapi/serverside-api.json
diff --git a/openapi/serverside-api.yaml b/openapi/serverside-api.yaml
diff --git a/openapi/video-openapi-clientside.json b/openapi/video-openapi-clientside.json
diff --git a/openapi/video-openapi-clientside.yaml b/openapi/video-openapi-clientside.yaml
@@ -1884,31 +1884,34 @@ components:
           x-stream-index: "002"
         broadcasting:
           $ref: '#/components/schemas/BroadcastSettingsRequest'
-          x-stream-index: "009"
+          x-stream-index: "010"
+        frame_recording:
+          $ref: '#/components/schemas/FrameRecordingSettingsRequest'
+          x-stream-index: "006"
         geofencing:
           $ref: '#/components/schemas/GeofenceSettingsRequest'
           x-stream-index: "003"
         limits:
           $ref: '#/components/schemas/LimitsSettingsRequest'
-          x-stream-index: "011"
+          x-stream-index: "012"
         recording:
           $ref: '#/components/schemas/RecordSettingsRequest'
           x-stream-index: "005"
         ring:
           $ref: '#/components/schemas/RingSettingsRequest'
-          x-stream-index: "006"
+          x-stream-index: "007"
         screensharing:
           $ref: '#/components/schemas/ScreensharingSettingsRequest'
-          x-stream-index: "007"
+          x-stream-index: "008"
         session:
           $ref: '#/components/schemas/SessionSettingsRequest'
-          x-stream-index: "012"
+          x-stream-index: "013"
         thumbnails:
           $ref: '#/components/schemas/ThumbnailsSettingsRequest'
-          x-stream-index: "010"
+          x-stream-index: "011"
         transcription:
           $ref: '#/components/schemas/TranscriptionSettingsRequest'
-          x-stream-index: "008"
+          x-stream-index: "009"
         video:
           $ref: '#/components/schemas/VideoSettingsRequest'
           x-stream-index: "004"
@@ -1924,39 +1927,43 @@ components:
         broadcasting:
           $ref: '#/components/schemas/BroadcastSettingsResponse'
           x-stream-index: "003"
+        frame_recording:
+          $ref: '#/components/schemas/FrameRecordingSettingsResponse'
+          x-stream-index: "006"
         geofencing:
           $ref: '#/components/schemas/GeofenceSettingsResponse'
           x-stream-index: "004"
         limits:
           $ref: '#/components/schemas/LimitsSettingsResponse'
-          x-stream-index: "011"
+          x-stream-index: "012"
         recording:
           $ref: '#/components/schemas/RecordSettingsResponse'
           x-stream-index: "005"
         ring:
           $ref: '#/components/schemas/RingSettingsResponse'
-          x-stream-index: "006"
+          x-stream-index: "007"
         screensharing:
           $ref: '#/components/schemas/ScreensharingSettingsResponse'
-          x-stream-index: "007"
+          x-stream-index: "008"
         session:
           $ref: '#/components/schemas/SessionSettingsResponse'
-          x-stream-index: "012"
+          x-stream-index: "013"
         thumbnails:
           $ref: '#/components/schemas/ThumbnailsSettingsResponse'
-          x-stream-index: "010"
+          x-stream-index: "011"
         transcription:
           $ref: '#/components/schemas/TranscriptionSettingsResponse'
-          x-stream-index: "008"
+          x-stream-index: "009"
         video:
           $ref: '#/components/schemas/VideoSettingsResponse'
-          x-stream-index: "009"
+          x-stream-index: "010"
       required:
       - audio
       - backstage
       - broadcasting
       - geofencing
       - recording
+      - frame_recording
       - ring
       - screensharing
       - transcription
@@ -2919,6 +2926,50 @@ components:
       - duration
       title: EndCallResponse
       type: object
+    FrameRecordingSettingsRequest:
+      properties:
+        capture_interval_in_seconds:
+          format: int32
+          maximum: 60
+          minimum: 2
+          type: integer
+          x-stream-index: "003"
+        mode:
+          enum:
+          - available
+          - disabled
+          - auto-on
+          type: string
+          x-stream-index: "001"
+        quality:
+          type: string
+          x-stream-index: "002"
+      required:
+      - mode
+      - capture_interval_in_seconds
+      type: object
+    FrameRecordingSettingsResponse:
+      properties:
+        capture_interval_in_seconds:
+          format: int32
+          maximum: 60
+          minimum: 2
+          type: integer
+          x-stream-index: "003"
+        mode:
+          enum:
+          - available
+          - disabled
+          - auto-on
+          type: string
+          x-stream-index: "001"
+        quality:
+          type: string
+          x-stream-index: "002"
+      required:
+      - mode
+      - capture_interval_in_seconds
+      type: object
     GeofenceSettingsRequest:
       properties:
         names:
@@ -6199,7 +6250,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v153.0.0
+  version: v154.1.0
 openapi: 3.0.3
 paths:
   /video/call/{type}/{id}:
@@ -6806,64 +6857,6 @@ paths:
       summary: Collect user feedback
       tags:
       - product:video
-  /video/call/{type}/{id}/feedback/{session}:
-    post:
-      description: |2+
-
-      operationId: CollectUserFeedback
-      parameters:
-      - in: path
-        name: type
-        required: true
-        schema:
-          maxLength: 64
-          type: string
-          writeOnly: true
-          x-stream-index: "001.001"
-      - in: path
-        name: id
-        required: true
-        schema:
-          maxLength: 64
-          type: string
-          writeOnly: true
-          x-stream-index: "001.002"
-      - in: path
-        name: session
-        required: true
-        schema:
-          maxLength: 64
-          type: string
-          writeOnly: true
-          x-stream-index: "003"
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/CollectUserFeedbackRequest'
-        required: true
-      responses:
-        "201":
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/CollectUserFeedbackResponse'
-          description: Response
-        "400":
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/APIError'
-          description: Bad request
-        "429":
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/APIError'
-          description: Too many requests
-      summary: Collect user feedback
-      tags:
-      - product:video
   /video/call/{type}/{id}/go_live:
     post:
       description: |2

diff --git a/openapi/video-openapi.json b/openapi/video-openapi.json