Update video openapi Spec

GetStream · Oct 10, 2023 · 17ce253 · 17ce253
1 parent 471d3c5
commit 17ce253
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 6 deletions.
diff --git a/openapi/video-openapi-clientside.yaml b/openapi/video-openapi-clientside.yaml
@@ -335,6 +335,32 @@ components:
       x-stream-event-call-type: true
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
+    CallHLSBroadcastingFailedEvent:
+      description: This event is sent when HLS broadcasting has failed
+      properties:
+        call_cid:
+          type: string
+          x-stream-index: "002.001"
+        created_at:
+          format: date-time
+          type: string
+          x-stream-index: "001.002"
+        type:
+          default: call.hls_broadcasting_failed
+          description: 'The type of event: "call.hls_broadcasting_failed" in this
+            case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      title: CallHLSBroadcastingFailedEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
     CallHLSBroadcastingStartedEvent:
       description: This event is sent when HLS broadcasting has started
       properties:
@@ -2198,6 +2224,10 @@ components:
           title: Screenshare
           type: boolean
           x-stream-index: "007"
+        screenshare_audio:
+          title: ScreenshareAudio
+          type: boolean
+          x-stream-index: "008"
         user_ids:
           items:
             type: string
@@ -3231,6 +3261,7 @@ components:
           call.blocked_user: '#/components/schemas/BlockedUserEvent'
           call.created: '#/components/schemas/CallCreatedEvent'
           call.ended: '#/components/schemas/CallEndedEvent'
+          call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent'
           call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent'
           call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent'
           call.live_started: '#/components/schemas/CallLiveStartedEvent'
@@ -3265,6 +3296,7 @@ components:
       - $ref: '#/components/schemas/CallAcceptedEvent'
       - $ref: '#/components/schemas/CallCreatedEvent'
       - $ref: '#/components/schemas/CallEndedEvent'
+      - $ref: '#/components/schemas/CallHLSBroadcastingFailedEvent'
       - $ref: '#/components/schemas/CallHLSBroadcastingStartedEvent'
       - $ref: '#/components/schemas/CallHLSBroadcastingStoppedEvent'
       - $ref: '#/components/schemas/CallLiveStartedEvent'
@@ -3415,7 +3447,7 @@ externalDocs:
   url: https://getstream.io/video/docs/
 info:
   title: Stream Video API
-  version: v89.2.0
+  version: v89.3.0
 openapi: 3.0.3
 paths:
   /call/{type}/{id}:
@@ -3696,7 +3728,7 @@ paths:
 
         Required permissions:
         - ListRecordings
-      operationId: ListRecordings_type_id_session_1
+      operationId: ListRecordings_type_id_session
       parameters:
       - in: path
         name: type
@@ -4538,7 +4570,7 @@ paths:
 
         Required permissions:
         - ListRecordings
-      operationId: ListRecordings_type_id_0
+      operationId: ListRecordings_type_id
       parameters:
       - in: path
         name: type

diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml
@@ -356,6 +356,32 @@ components:
       x-stream-event-call-type: true
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
+    CallHLSBroadcastingFailedEvent:
+      description: This event is sent when HLS broadcasting has failed
+      properties:
+        call_cid:
+          type: string
+          x-stream-index: "002.001"
+        created_at:
+          format: date-time
+          type: string
+          x-stream-index: "001.002"
+        type:
+          default: call.hls_broadcasting_failed
+          description: 'The type of event: "call.hls_broadcasting_failed" in this
+            case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      title: CallHLSBroadcastingFailedEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
     CallHLSBroadcastingStartedEvent:
       description: This event is sent when HLS broadcasting has started
       properties:
@@ -2460,6 +2486,10 @@ components:
           title: Screenshare
           type: boolean
           x-stream-index: "007"
+        screenshare_audio:
+          title: ScreenshareAudio
+          type: boolean
+          x-stream-index: "008"
         user_ids:
           items:
             type: string
@@ -3616,6 +3646,7 @@ components:
           call.blocked_user: '#/components/schemas/BlockedUserEvent'
           call.created: '#/components/schemas/CallCreatedEvent'
           call.ended: '#/components/schemas/CallEndedEvent'
+          call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent'
           call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent'
           call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent'
           call.live_started: '#/components/schemas/CallLiveStartedEvent'
@@ -3650,6 +3681,7 @@ components:
       - $ref: '#/components/schemas/CallAcceptedEvent'
       - $ref: '#/components/schemas/CallCreatedEvent'
       - $ref: '#/components/schemas/CallEndedEvent'
+      - $ref: '#/components/schemas/CallHLSBroadcastingFailedEvent'
       - $ref: '#/components/schemas/CallHLSBroadcastingStartedEvent'
       - $ref: '#/components/schemas/CallHLSBroadcastingStoppedEvent'
       - $ref: '#/components/schemas/CallLiveStartedEvent'
@@ -3800,7 +3832,7 @@ externalDocs:
   url: https://getstream.io/video/docs/
 info:
   title: Stream Video API
-  version: v89.2.0
+  version: v89.3.0
 openapi: 3.0.3
 paths:
   /call/{type}/{id}:
@@ -4081,7 +4113,7 @@ paths:
 
         Required permissions:
         - ListRecordings
-      operationId: ListRecordings_type_id_session_1
+      operationId: ListRecordings_type_id_session
       parameters:
       - in: path
         name: type
@@ -4923,7 +4955,7 @@ paths:
 
         Required permissions:
         - ListRecordings
-      operationId: ListRecordings_type_id_0
+      operationId: ListRecordings_type_id
       parameters:
       - in: path
         name: type