Update video openapi Spec (#450)

Co-authored-by: GH Action CI Stream <[email protected]>
GetStream · Feb 23, 2024 · 77454aa · 77454aa
1 parent 00c71a7
commit 77454aa
Show file tree

Hide file tree

Showing 12 changed files with 1,038 additions and 477 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
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
@@ -253,6 +253,33 @@ components:
       x-stream-event-call-type: true
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
+    CallClosedCaption:
+      description: CallClosedCaption represents a closed caption of a call.
+      properties:
+        end_time:
+          format: date-time
+          title: The end time of the closed caption.
+          type: string
+          x-stream-index: "003"
+        speaker_id:
+          title: The speaker ID of the closed caption.
+          type: string
+          x-stream-index: "004"
+        start_time:
+          format: date-time
+          title: The start time of the closed caption.
+          type: string
+          x-stream-index: "002"
+        text:
+          title: The text of the closed caption.
+          type: string
+          x-stream-index: "001"
+      required:
+      - text
+      - start_time
+      - end_time
+      - speaker_id
+      type: object
     CallCreatedEvent:
       description: "This event is sent when a call is created. Clients receiving this
         event should check if the ringing \nfield is set to true and if so, show the
@@ -1410,6 +1437,33 @@ components:
       - members
       - own_capabilities
       type: object
+    CallTranscription:
+      description: CallTranscription represents a transcription of a call.
+      properties:
+        end_time:
+          format: date-time
+          title: The end time of the transcription.
+          type: string
+          x-stream-index: "004"
+        filename:
+          title: The filename of the transcription.
+          type: string
+          x-stream-index: "001"
+        start_time:
+          format: date-time
+          title: The start time of the transcription.
+          type: string
+          x-stream-index: "003"
+        url:
+          title: The URL of the transcription.
+          type: string
+          x-stream-index: "002"
+      required:
+      - filename
+      - url
+      - start_time
+      - end_time
+      type: object
     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
@@ -1488,6 +1542,38 @@ components:
       x-stream-event-call-type: true
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
+    ClosedCaptionEvent:
+      description: This event is sent when closed captions are being sent in a call,
+        clients should use this to show the closed captions in the call screen
+      properties:
+        call_cid:
+          type: string
+          x-stream-index: "002.001"
+        closed_caption:
+          $ref: '#/components/schemas/CallClosedCaption'
+          description: The closed caption object
+          title: CallClosedCaption
+          x-stream-index: "003"
+        created_at:
+          format: date-time
+          type: string
+          x-stream-index: "001.002"
+        type:
+          default: call.closed_caption
+          description: 'The type of event: "call.closed_caption" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      - closed_caption
+      title: ClosedCaptionEvent
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
     ConnectUserDetailsRequest:
       properties:
         custom:
@@ -1916,6 +2002,9 @@ components:
           x-stream-index: "004"
         start_transcription:
           type: boolean
+          x-stream-index: "007"
+        transcription_storage_name:
+          type: string
           x-stream-index: "006"
       type: object
     GoLiveResponse:
@@ -2095,6 +2184,21 @@ components:
       - duration
       - recordings
       type: object
+    ListTranscriptionsResponse:
+      nullable: true
+      properties:
+        duration:
+          type: string
+          x-stream-index: "001.001"
+        transcriptions:
+          items:
+            $ref: '#/components/schemas/CallTranscription'
+          type: array
+          x-stream-index: "002"
+      required:
+      - duration
+      - transcriptions
+      type: object
     MemberRequest:
       properties:
         custom:
@@ -2730,6 +2834,10 @@ components:
       type: object
     StartTranscriptionRequest:
       nullable: true
+      properties:
+        transcription_external_storage:
+          type: string
+          x-stream-index: "002"
       type: object
     StartTranscriptionResponse:
       nullable: true
@@ -3279,6 +3387,7 @@ components:
         mapping:
           call.accepted: '#/components/schemas/CallAcceptedEvent'
           call.blocked_user: '#/components/schemas/BlockedUserEvent'
+          call.closed_caption: '#/components/schemas/ClosedCaptionEvent'
           call.created: '#/components/schemas/CallCreatedEvent'
           call.deleted: '#/components/schemas/CallDeletedEvent'
           call.ended: '#/components/schemas/CallEndedEvent'
@@ -3338,6 +3447,7 @@ components:
       - $ref: '#/components/schemas/CallSessionStartedEvent'
       - $ref: '#/components/schemas/CallUpdatedEvent'
       - $ref: '#/components/schemas/CallUserMuted'
+      - $ref: '#/components/schemas/ClosedCaptionEvent'
       - $ref: '#/components/schemas/ConnectedEvent'
       - $ref: '#/components/schemas/ConnectionErrorEvent'
       - $ref: '#/components/schemas/PermissionRequestEvent'
@@ -3384,7 +3494,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v98.2.0
+  version: v99.1.0
 openapi: 3.0.3
 paths:
   /video/call/{type}/{id}:
@@ -4436,6 +4546,12 @@ paths:
           type: string
           writeOnly: true
           x-stream-index: "001.002"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/StartTranscriptionRequest'
+        required: true
       responses:
         "201":
           content:
@@ -4646,6 +4762,51 @@ paths:
                 $ref: '#/components/schemas/APIError'
           description: Too many requests
       summary: Stop transcription
+  /video/call/{type}/{id}/transcriptions:
+    get:
+      description: |
+        Lists transcriptions
+
+        Required permissions:
+        - ListTranscriptions
+      operationId: ListTranscriptions
+      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"
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListTranscriptionsResponse'
+          description: Successful 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: List transcriptions
   /video/call/{type}/{id}/unblock:
     post:
       description: |

diff --git a/openapi/video-openapi.json b/openapi/video-openapi.json
diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml
@@ -555,6 +555,33 @@ components:
       - members
       - own_capabilities
       type: object
+    CallTranscription:
+      description: CallTranscription represents a transcription of a call.
+      properties:
+        end_time:
+          format: date-time
+          title: The end time of the transcription.
+          type: string
+          x-stream-index: "004"
+        filename:
+          title: The filename of the transcription.
+          type: string
+          x-stream-index: "001"
+        start_time:
+          format: date-time
+          title: The start time of the transcription.
+          type: string
+          x-stream-index: "003"
+        url:
+          title: The URL of the transcription.
+          type: string
+          x-stream-index: "002"
+      required:
+      - filename
+      - url
+      - start_time
+      - end_time
+      type: object
     CallTypeResponse:
       properties:
         created_at:
@@ -1155,6 +1182,9 @@ components:
           x-stream-index: "004"
         start_transcription:
           type: boolean
+          x-stream-index: "007"
+        transcription_storage_name:
+          type: string
           x-stream-index: "006"
       type: object
     GoLiveResponse:
@@ -1327,6 +1357,21 @@ components:
       - duration
       - recordings
       type: object
+    ListTranscriptionsResponse:
+      nullable: true
+      properties:
+        duration:
+          type: string
+          x-stream-index: "001.001"
+        transcriptions:
+          items:
+            $ref: '#/components/schemas/CallTranscription'
+          type: array
+          x-stream-index: "002"
+      required:
+      - duration
+      - transcriptions
+      type: object
     MemberRequest:
       properties:
         custom:
@@ -1834,6 +1879,10 @@ components:
       type: object
     StartTranscriptionRequest:
       nullable: true
+      properties:
+        transcription_external_storage:
+          type: string
+          x-stream-index: "002"
       type: object
     StartTranscriptionResponse:
       nullable: true
@@ -2469,7 +2518,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v98.2.0
+  version: v99.1.0
 openapi: 3.0.3
 paths:
   /video/call/{type}/{id}:
@@ -3245,6 +3294,12 @@ paths:
           type: string
           writeOnly: true
           x-stream-index: "001.002"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/StartTranscriptionRequest'
+        required: true
       responses:
         "201":
           content:
@@ -3455,6 +3510,51 @@ paths:
                 $ref: '#/components/schemas/APIError'
           description: Too many requests
       summary: Stop transcription
+  /video/call/{type}/{id}/transcriptions:
+    get:
+      description: |
+        Lists transcriptions
+
+        Required permissions:
+        - ListTranscriptions
+      operationId: ListTranscriptions
+      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"
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListTranscriptionsResponse'
+          description: Successful 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: List transcriptions
   /video/call/{type}/{id}/unblock:
     post:
       description: |