Update video openapi Spec

GetStream · Sep 15, 2023 · f460a7b · f460a7b
1 parent 727cdbb
commit f460a7b
Show file tree

Hide file tree

Showing 2 changed files with 86 additions and 72 deletions.
diff --git a/openapi/video-openapi-clientside.yaml b/openapi/video-openapi-clientside.yaml
@@ -1271,11 +1271,6 @@ components:
       type: object
     CallStateResponseFields:
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001"
@@ -1295,11 +1290,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "005"
+          x-stream-index: "004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       type: object
     CallUpdatedEvent:
@@ -1346,6 +1340,41 @@ components:
       x-stream-event-call-type: true
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
+    CallUserMuted:
+      description: This event is sent when a call member is muted
+      properties:
+        call_cid:
+          type: string
+          x-stream-index: "002.001"
+        created_at:
+          format: date-time
+          type: string
+          x-stream-index: "001.002"
+        from_user_id:
+          type: string
+          x-stream-index: "003"
+        muted_user_ids:
+          items:
+            type: string
+          type: array
+          x-stream-index: "004"
+        type:
+          default: call.user_muted
+          description: 'The type of event: "call.user_muted" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      - from_user_id
+      - muted_user_ids
+      title: CallUserMuted
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
     ConnectUserDetailsRequest:
       properties:
         custom:
@@ -1705,11 +1734,6 @@ components:
     GetCallResponse:
       nullable: true
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "001.004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001.001"
@@ -1728,11 +1752,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "001.005"
+          x-stream-index: "001.004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       - duration
       type: object
@@ -1780,11 +1803,6 @@ components:
     GetOrCreateCallResponse:
       nullable: true
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "001.004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001.001"
@@ -1806,11 +1824,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "001.005"
+          x-stream-index: "001.004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       - created
       - duration
@@ -1962,11 +1979,6 @@ components:
     JoinCallResponse:
       nullable: true
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "001.004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001.001"
@@ -1993,11 +2005,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "001.005"
+          x-stream-index: "001.004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       - created
       - credentials
@@ -2954,11 +2965,6 @@ components:
       description: Represents a call
       nullable: true
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "001.004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001.001"
@@ -2977,11 +2983,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "001.005"
+          x-stream-index: "001.004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       - duration
       title: Call
@@ -3160,6 +3165,7 @@ components:
           call.session_started: '#/components/schemas/CallSessionStartedEvent'
           call.unblocked_user: '#/components/schemas/UnblockedUserEvent'
           call.updated: '#/components/schemas/CallUpdatedEvent'
+          call.user_muted: '#/components/schemas/CallUserMuted'
           connection.error: '#/components/schemas/ConnectionErrorEvent'
           connection.ok: '#/components/schemas/ConnectedEvent'
           custom: '#/components/schemas/CustomVideoEvent'
@@ -3188,6 +3194,7 @@ components:
       - $ref: '#/components/schemas/CallSessionParticipantLeftEvent'
       - $ref: '#/components/schemas/CallSessionStartedEvent'
       - $ref: '#/components/schemas/CallUpdatedEvent'
+      - $ref: '#/components/schemas/CallUserMuted'
       - $ref: '#/components/schemas/ConnectedEvent'
       - $ref: '#/components/schemas/ConnectionErrorEvent'
       - $ref: '#/components/schemas/CustomVideoEvent'
@@ -3317,7 +3324,7 @@ externalDocs:
   url: https://getstream.io/video/docs/
 info:
   title: Stream Video API
-  version: v88.10.0
+  version: v88.11.0
 openapi: 3.0.3
 paths:
   /call/{type}/{id}:

diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml
@@ -1302,11 +1302,6 @@ components:
       type: object
     CallStateResponseFields:
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001"
@@ -1326,11 +1321,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "005"
+          x-stream-index: "004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       type: object
     CallTypeResponse:
@@ -1411,6 +1405,41 @@ components:
       x-stream-event-call-type: true
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
+    CallUserMuted:
+      description: This event is sent when a call member is muted
+      properties:
+        call_cid:
+          type: string
+          x-stream-index: "002.001"
+        created_at:
+          format: date-time
+          type: string
+          x-stream-index: "001.002"
+        from_user_id:
+          type: string
+          x-stream-index: "003"
+        muted_user_ids:
+          items:
+            type: string
+          type: array
+          x-stream-index: "004"
+        type:
+          default: call.user_muted
+          description: 'The type of event: "call.user_muted" in this case'
+          title: Event Type
+          type: string
+          x-stream-index: "001.001"
+      required:
+      - type
+      - created_at
+      - call_cid
+      - from_user_id
+      - muted_user_ids
+      title: CallUserMuted
+      type: object
+      x-stream-event-call-type: true
+      x-stream-is-event: true
+      x-stream-ws-base-event-name: VideoEvent
     ConnectUserDetailsRequest:
       properties:
         custom:
@@ -1852,11 +1881,6 @@ components:
     GetCallResponse:
       nullable: true
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "001.004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001.001"
@@ -1875,11 +1899,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "001.005"
+          x-stream-index: "001.004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       - duration
       type: object
@@ -1966,11 +1989,6 @@ components:
     GetOrCreateCallResponse:
       nullable: true
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "001.004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001.001"
@@ -1992,11 +2010,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "001.005"
+          x-stream-index: "001.004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       - created
       - duration
@@ -2148,11 +2165,6 @@ components:
     JoinCallResponse:
       nullable: true
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "001.004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001.001"
@@ -2179,11 +2191,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "001.005"
+          x-stream-index: "001.004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       - created
       - credentials
@@ -3199,11 +3210,6 @@ components:
       description: Represents a call
       nullable: true
       properties:
-        blocked_users:
-          items:
-            $ref: '#/components/schemas/UserResponse'
-          type: array
-          x-stream-index: "001.004"
         call:
           $ref: '#/components/schemas/CallResponse'
           x-stream-index: "001.001"
@@ -3222,11 +3228,10 @@ components:
           items:
             $ref: '#/components/schemas/OwnCapability'
           type: array
-          x-stream-index: "001.005"
+          x-stream-index: "001.004"
       required:
       - call
       - members
-      - blocked_users
       - own_capabilities
       - duration
       title: Call
@@ -3473,6 +3478,7 @@ components:
           call.session_started: '#/components/schemas/CallSessionStartedEvent'
           call.unblocked_user: '#/components/schemas/UnblockedUserEvent'
           call.updated: '#/components/schemas/CallUpdatedEvent'
+          call.user_muted: '#/components/schemas/CallUserMuted'
           connection.error: '#/components/schemas/ConnectionErrorEvent'
           connection.ok: '#/components/schemas/ConnectedEvent'
           custom: '#/components/schemas/CustomVideoEvent'
@@ -3501,6 +3507,7 @@ components:
       - $ref: '#/components/schemas/CallSessionParticipantLeftEvent'
       - $ref: '#/components/schemas/CallSessionStartedEvent'
       - $ref: '#/components/schemas/CallUpdatedEvent'
+      - $ref: '#/components/schemas/CallUserMuted'
       - $ref: '#/components/schemas/ConnectedEvent'
       - $ref: '#/components/schemas/ConnectionErrorEvent'
       - $ref: '#/components/schemas/CustomVideoEvent'
@@ -3630,7 +3637,7 @@ externalDocs:
   url: https://getstream.io/video/docs/
 info:
   title: Stream Video API
-  version: v88.10.0
+  version: v88.11.0
 openapi: 3.0.3
 paths:
   /call/{type}/{id}: