Update video openapi Spec (#471)

Co-authored-by: GH Action CI Stream <[email protected]>
GetStream · Mar 7, 2024 · 987d88a · 987d88a
1 parent e30f5c9
commit 987d88a
Show file tree

Hide file tree

Showing 12 changed files with 257 additions and 17 deletions.
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
@@ -8435,7 +8435,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v100.4.2
+  version: v100.4.3
 openapi: 3.0.3
 paths:
   /app:

diff --git a/openapi/chat-openapi.json b/openapi/chat-openapi.json
diff --git a/openapi/chat-openapi.yaml b/openapi/chat-openapi.yaml
@@ -9791,7 +9791,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v100.4.2
+  version: v100.4.3
 openapi: 3.0.3
 paths:
   /app:

diff --git a/openapi/clientside-api.json b/openapi/clientside-api.json
diff --git a/openapi/clientside-api.yaml b/openapi/clientside-api.yaml
@@ -2086,6 +2086,112 @@ components:
       - start_time
       - end_time
       type: object
+    CallTranscriptionFailedEvent:
+      description: This event is sent when call transcription 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.transcription_failed
+          description: 'The type of event: "call.transcription_failed" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      title: CallTranscriptionFailedEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
+    CallTranscriptionReadyEvent:
+      description: This event is sent when call transcription is ready
+      properties:
+        call_cid:
+          type: string
+          x-stream-index: "002.001"
+        call_transcription:
+          $ref: '#/components/schemas/CallTranscription'
+          description: The call transcription object
+          title: CallTranscription
+          x-stream-index: "003"
+        created_at:
+          format: date-time
+          type: string
+          x-stream-index: "001.002"
+        type:
+          default: call.transcription_ready
+          description: 'The type of event: "call.transcription_ready" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      - call_transcription
+      title: CallTranscriptionReadyEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
+    CallTranscriptionStartedEvent:
+      description: This event is sent when call transcription has started
+      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.transcription_started
+          description: 'The type of event: "call.transcription_started" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      title: CallTranscriptionStartedEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
+    CallTranscriptionStoppedEvent:
+      description: This event is sent when call transcription has stopped
+      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.transcription_stopped
+          description: 'The type of event: "call.transcription_stopped" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      title: CallTranscriptionStoppedEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
     CallType:
       nullable: true
       properties:
@@ -5992,7 +6098,7 @@ components:
           type: array
           x-stream-index: "001.002"
         type:
-          default: notification.thread_message_new
+          default: message.new
           type: string
           x-stream-index: "004.001"
         user:
@@ -11058,6 +11164,10 @@ components:
           call.session_participant_joined: '#/components/schemas/CallSessionParticipantJoinedEvent'
           call.session_participant_left: '#/components/schemas/CallSessionParticipantLeftEvent'
           call.session_started: '#/components/schemas/CallSessionStartedEvent'
+          call.transcription_failed: '#/components/schemas/CallTranscriptionFailedEvent'
+          call.transcription_ready: '#/components/schemas/CallTranscriptionReadyEvent'
+          call.transcription_started: '#/components/schemas/CallTranscriptionStartedEvent'
+          call.transcription_stopped: '#/components/schemas/CallTranscriptionStoppedEvent'
           call.unblocked_user: '#/components/schemas/UnblockedUserEvent'
           call.updated: '#/components/schemas/CallUpdatedEvent'
           call.user_muted: '#/components/schemas/CallUserMuted'
@@ -11138,6 +11248,10 @@ components:
       - $ref: '#/components/schemas/CallSessionParticipantJoinedEvent'
       - $ref: '#/components/schemas/CallSessionParticipantLeftEvent'
       - $ref: '#/components/schemas/CallSessionStartedEvent'
+      - $ref: '#/components/schemas/CallTranscriptionFailedEvent'
+      - $ref: '#/components/schemas/CallTranscriptionReadyEvent'
+      - $ref: '#/components/schemas/CallTranscriptionStartedEvent'
+      - $ref: '#/components/schemas/CallTranscriptionStoppedEvent'
       - $ref: '#/components/schemas/CallUpdatedEvent'
       - $ref: '#/components/schemas/CallUserMuted'
       - $ref: '#/components/schemas/ChannelCreatedEvent'
@@ -11289,7 +11403,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v100.4.2
+  version: v100.4.3
 openapi: 3.0.3
 paths:
   /api/v2/app:
@@ -15056,7 +15170,7 @@ paths:
         - call.recording_started
 
         Required permissions:
-        - StopRecording
+        - StartRecording
       operationId: StartRecording
       parameters:
       - in: path
@@ -15310,6 +15424,9 @@ paths:
       description: |
         Stops transcription
 
+        Sends events:
+        - call.transcription_stopped
+
         Required permissions:
         - StopTranscription
       operationId: StopTranscription

diff --git a/openapi/serverside-api.json b/openapi/serverside-api.json
diff --git a/openapi/serverside-api.yaml b/openapi/serverside-api.yaml
@@ -11596,7 +11596,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v100.4.2
+  version: v100.4.3
 openapi: 3.0.3
 paths:
   /api/v2/app:
@@ -16636,7 +16636,7 @@ paths:
         - call.recording_started
 
         Required permissions:
-        - StopRecording
+        - StartRecording
       operationId: StartRecording
       parameters:
       - in: path
@@ -16890,6 +16890,9 @@ paths:
       description: |
         Stops transcription
 
+        Sends events:
+        - call.transcription_stopped
+
         Required permissions:
         - StopTranscription
       operationId: StopTranscription

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
@@ -1464,6 +1464,112 @@ components:
       - start_time
       - end_time
       type: object
+    CallTranscriptionFailedEvent:
+      description: This event is sent when call transcription 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.transcription_failed
+          description: 'The type of event: "call.transcription_failed" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      title: CallTranscriptionFailedEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
+    CallTranscriptionReadyEvent:
+      description: This event is sent when call transcription is ready
+      properties:
+        call_cid:
+          type: string
+          x-stream-index: "002.001"
+        call_transcription:
+          $ref: '#/components/schemas/CallTranscription'
+          description: The call transcription object
+          title: CallTranscription
+          x-stream-index: "003"
+        created_at:
+          format: date-time
+          type: string
+          x-stream-index: "001.002"
+        type:
+          default: call.transcription_ready
+          description: 'The type of event: "call.transcription_ready" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      - call_transcription
+      title: CallTranscriptionReadyEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
+    CallTranscriptionStartedEvent:
+      description: This event is sent when call transcription has started
+      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.transcription_started
+          description: 'The type of event: "call.transcription_started" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      title: CallTranscriptionStartedEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
+    CallTranscriptionStoppedEvent:
+      description: This event is sent when call transcription has stopped
+      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.transcription_stopped
+          description: 'The type of event: "call.transcription_stopped" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      title: CallTranscriptionStoppedEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
     CallUpdatedEvent:
       description: "This event is sent when a call is updated, clients should use
         this update the local state of the call. \nThis event also contains the capabilities
@@ -3426,6 +3532,10 @@ components:
           call.session_participant_joined: '#/components/schemas/CallSessionParticipantJoinedEvent'
           call.session_participant_left: '#/components/schemas/CallSessionParticipantLeftEvent'
           call.session_started: '#/components/schemas/CallSessionStartedEvent'
+          call.transcription_failed: '#/components/schemas/CallTranscriptionFailedEvent'
+          call.transcription_ready: '#/components/schemas/CallTranscriptionReadyEvent'
+          call.transcription_started: '#/components/schemas/CallTranscriptionStartedEvent'
+          call.transcription_stopped: '#/components/schemas/CallTranscriptionStoppedEvent'
           call.unblocked_user: '#/components/schemas/UnblockedUserEvent'
           call.updated: '#/components/schemas/CallUpdatedEvent'
           call.user_muted: '#/components/schemas/CallUserMuted'
@@ -3458,6 +3568,10 @@ components:
       - $ref: '#/components/schemas/CallSessionParticipantJoinedEvent'
       - $ref: '#/components/schemas/CallSessionParticipantLeftEvent'
       - $ref: '#/components/schemas/CallSessionStartedEvent'
+      - $ref: '#/components/schemas/CallTranscriptionFailedEvent'
+      - $ref: '#/components/schemas/CallTranscriptionReadyEvent'
+      - $ref: '#/components/schemas/CallTranscriptionStartedEvent'
+      - $ref: '#/components/schemas/CallTranscriptionStoppedEvent'
       - $ref: '#/components/schemas/CallUpdatedEvent'
       - $ref: '#/components/schemas/CallUserMuted'
       - $ref: '#/components/schemas/ClosedCaptionEvent'
@@ -3507,7 +3621,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v100.4.2
+  version: v100.4.3
 openapi: 3.0.3
 paths:
   /video/call/{type}/{id}:
@@ -4481,7 +4595,7 @@ paths:
         - call.recording_started
 
         Required permissions:
-        - StopRecording
+        - StartRecording
       operationId: StartRecording
       parameters:
       - in: path
@@ -4735,6 +4849,9 @@ paths:
       description: |
         Stops transcription
 
+        Sends events:
+        - call.transcription_stopped
+
         Required permissions:
         - StopTranscription
       operationId: StopTranscription

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