Update video openapi Spec (#672)

Co-authored-by: GH Action CI Stream <[email protected]>
GetStream · Jul 15, 2024 · db8f3b6 · db8f3b6
1 parent 18d3823
commit db8f3b6
Show file tree

Hide file tree

Showing 14 changed files with 4,128 additions and 853 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
diff --git a/openapi/video-openapi.json b/openapi/video-openapi.json
diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml
@@ -196,7 +196,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -346,6 +346,9 @@ components:
         team:
           type: string
           x-stream-index: "001"
+        video:
+          type: boolean
+          x-stream-index: "008"
       type: object
     CallResponse:
       description: Represents a call
@@ -738,7 +741,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -788,7 +791,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -977,7 +980,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -1002,6 +1005,8 @@ components:
           type: string
           x-stream-index: "002"
         duration:
+          description: Duration of the request in milliseconds
+          title: Duration
           type: string
           x-stream-index: "003.001"
         user:
@@ -1030,7 +1035,7 @@ components:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001"
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "003.001"
@@ -1045,7 +1050,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -1357,7 +1362,7 @@ components:
           $ref: '#/components/schemas/CallTimeline'
           x-stream-index: "014"
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -1460,7 +1465,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "002.001"
@@ -1484,7 +1489,7 @@ components:
           format: int32
           maximum: 100
           type: integer
-          x-stream-index: "006"
+          x-stream-index: "007"
         notify:
           description: if provided it sends a notification event to the members for
             this call
@@ -1496,6 +1501,9 @@ components:
           title: Ring
           type: boolean
           x-stream-index: "004"
+        video:
+          type: boolean
+          x-stream-index: "006"
       type: object
     GetOrCreateCallResponse:
       nullable: true
@@ -1553,7 +1561,7 @@ components:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001"
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "002.001"
@@ -1715,7 +1723,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -1922,7 +1930,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2020,9 +2028,13 @@ components:
       nullable: true
       properties:
         session_id:
+          description: the session ID of the user who pinned the message
+          title: SessionID
           type: string
           x-stream-index: "003"
         user_id:
+          description: the user ID of the user who pinned the message
+          title: UserID
           type: string
           x-stream-index: "002"
       required:
@@ -2033,7 +2045,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2133,7 +2145,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "003.001"
@@ -2182,7 +2194,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "002.001"
@@ -2323,7 +2335,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001"
@@ -2480,7 +2492,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2530,7 +2542,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2547,7 +2559,7 @@ components:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001"
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "002.001"
@@ -2562,7 +2574,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2576,7 +2588,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2738,7 +2750,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2749,9 +2761,13 @@ components:
       nullable: true
       properties:
         session_id:
+          description: the session ID of the user who pinned the message
+          title: SessionID
           type: string
           x-stream-index: "003"
         user_id:
+          description: the user ID of the user who pinned the message
+          title: UserID
           type: string
           x-stream-index: "002"
       required:
@@ -2762,7 +2778,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2793,7 +2809,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -2953,7 +2969,7 @@ components:
           type: string
           x-stream-index: "001.003"
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "002.001"
@@ -3000,7 +3016,7 @@ components:
       nullable: true
       properties:
         duration:
-          description: Duration of the request in human-readable format
+          description: Duration of the request in milliseconds
           title: Duration
           type: string
           x-stream-index: "001.001"
@@ -3078,6 +3094,10 @@ components:
       type: object
     UserResponse:
       properties:
+        ban_expires:
+          format: date-time
+          type: string
+          x-stream-index: "003"
         banned:
           type: boolean
           x-stream-index: "001.011"
@@ -3110,7 +3130,7 @@ components:
           items:
             $ref: '#/components/schemas/Device'
           type: array
-          x-stream-index: "004"
+          x-stream-index: "005"
         id:
           type: string
           x-stream-index: "001.001"
@@ -3119,7 +3139,7 @@ components:
           x-stream-index: "001.003"
         invisible:
           type: boolean
-          x-stream-index: "005"
+          x-stream-index: "006"
         language:
           type: string
           x-stream-index: "001.005"
@@ -3135,7 +3155,7 @@ components:
           x-stream-index: "001.012"
         push_notifications:
           $ref: '#/components/schemas/PushNotificationSettings'
-          x-stream-index: "003"
+          x-stream-index: "004"
         revoke_tokens_issued_before:
           format: date-time
           type: string
@@ -3501,7 +3521,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v122.3.0
+  version: v125.7.0
 openapi: 3.0.3
 paths:
   /video/call/{type}/{id}:
@@ -3554,6 +3574,12 @@ paths:
           type: boolean
           writeOnly: true
           x-stream-index: "006"
+      - in: query
+        name: video
+        schema:
+          type: boolean
+          writeOnly: true
+          x-stream-index: "007"
       responses:
         "200":
           content: