Update video openapi Spec

GetStream · Feb 16, 2024 · 8565eef · 8565eef
1 parent 0e58036
commit 8565eef
Show file tree

Hide file tree

Showing 12 changed files with 412 additions and 12 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
@@ -8565,7 +8565,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v98.2.0
+  version: v98.2.0-fix-transcriptions.14
 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
@@ -9691,7 +9691,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v98.2.0
+  version: v98.2.0-fix-transcriptions.14
 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
@@ -2032,6 +2032,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
     CallType:
       nullable: true
       properties:
@@ -4588,6 +4615,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:
@@ -5160,6 +5190,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
     MarkChannelsReadRequest:
       nullable: true
       properties:
@@ -8804,6 +8849,10 @@ components:
       type: object
     StartTranscriptionRequest:
       nullable: true
+      properties:
+        transcription_external_storage:
+          type: string
+          x-stream-index: "002"
       type: object
     StartTranscriptionResponse:
       nullable: true
@@ -11275,7 +11324,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v98.2.0
+  version: v98.2.0-fix-transcriptions.14
 openapi: 3.0.3
 paths:
   /api/v2/app:
@@ -15116,6 +15165,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:
@@ -15326,6 +15381,51 @@ paths:
                 $ref: '#/components/schemas/APIError'
           description: Too many requests
       summary: Stop transcription
+  /api/v2/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
   /api/v2/video/call/{type}/{id}/unblock:
     post:
       description: |

diff --git a/openapi/serverside-api.json b/openapi/serverside-api.json
diff --git a/openapi/serverside-api.yaml b/openapi/serverside-api.yaml
@@ -1265,6 +1265,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
     CallType:
       nullable: true
       properties:
@@ -5014,6 +5041,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:
@@ -5769,6 +5799,21 @@ components:
       - roles
       - duration
       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
     MarkChannelsReadRequest:
       nullable: true
       properties:
@@ -8940,6 +8985,10 @@ components:
       type: object
     StartTranscriptionRequest:
       nullable: true
+      properties:
+        transcription_external_storage:
+          type: string
+          x-stream-index: "002"
       type: object
     StartTranscriptionResponse:
       nullable: true
@@ -11439,7 +11488,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v98.2.0
+  version: v98.2.0-fix-transcriptions.14
 openapi: 3.0.3
 paths:
   /api/v2/app:
@@ -16483,6 +16532,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:
@@ -16693,6 +16748,51 @@ paths:
                 $ref: '#/components/schemas/APIError'
           description: Too many requests
       summary: Stop transcription
+  /api/v2/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
   /api/v2/video/call/{type}/{id}/unblock:
     post:
       description: |

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