Update video openapi Spec

GetStream · Jun 9, 2024 · 9b3eb15 · 9b3eb15
1 parent 8277f0e
commit 9b3eb15
Show file tree

Hide file tree

Showing 14 changed files with 192 additions and 159 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
@@ -367,7 +367,7 @@ components:
     BlockUsersResponse:
       nullable: true
       properties:
-        blocked_users:
+        blocks:
           items:
             $ref: '#/components/schemas/UserBlock'
           type: array
@@ -379,7 +379,7 @@ components:
           x-stream-index: "001.001"
       required:
       - duration
-      - blocked_users
+      - blocks
       type: object
     BlockedUserResponse:
       nullable: true
@@ -2296,6 +2296,11 @@ components:
         banned:
           type: boolean
           x-stream-index: "001.011"
+        blocked_user_ids:
+          items:
+            type: string
+          type: array
+          x-stream-index: "013"
         channel_mutes:
           items:
             $ref: '#/components/schemas/ChannelMute'
@@ -2409,6 +2414,7 @@ components:
       - unread_channels
       - unread_threads
       - shadow_banned
+      - blocked_user_ids
       type: object
     GetApplicationResponse:
       nullable: true
@@ -3591,7 +3597,7 @@ components:
           type: array
           x-stream-index: "001.002"
         type:
-          default: message.new
+          default: notification.thread_message_new
           type: string
           x-stream-index: "004.001"
         user:
@@ -8022,35 +8028,20 @@ components:
     UserBlock:
       nullable: true
       properties:
-        AppPK:
-          format: int32
-          type: integer
-          writeOnly: true
-          x-stream-index: "003"
-        BlockedByUser:
-          $ref: '#/components/schemas/UserObject'
-          x-stream-index: "004"
-        BlockedByUserID:
+        blocked_by_user_id:
           type: string
-          writeOnly: true
           x-stream-index: "005"
-        BlockedUser:
-          $ref: '#/components/schemas/UserObject'
-          x-stream-index: "006"
-        BlockedUserID:
+        blocked_user_id:
           type: string
-          writeOnly: true
           x-stream-index: "007"
-        CreatedAt:
+        created_at:
           format: date-time
           type: string
-          writeOnly: true
           x-stream-index: "008"
       required:
-      - AppPK
-      - BlockedByUserID
-      - BlockedUserID
-      - CreatedAt
+      - blocked_by_user_id
+      - blocked_user_id
+      - created_at
       type: object
     UserDeactivatedEvent:
       properties:
@@ -8361,6 +8352,11 @@ components:
         banned:
           type: boolean
           x-stream-index: "001.011"
+        blocked_user_ids:
+          items:
+            type: string
+          type: array
+          x-stream-index: "001.016"
         created_at:
           description: Date/time of creation
           format: date-time
@@ -8428,6 +8424,7 @@ components:
       - updated_at
       - banned
       - online
+      - blocked_user_ids
       - shadow_banned
       - devices
       - invisible
@@ -8785,7 +8782,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v116.0.2
+  version: v117.0.0
 openapi: 3.0.3
 paths:
   /app:
@@ -10106,14 +10103,6 @@ paths:
           type: string
           writeOnly: true
           x-stream-index: "001"
-      - in: query
-        name: user_id
-        schema:
-          description: '**Server-side only**. User ID which server acts upon'
-          title: User ID
-          type: string
-          writeOnly: true
-          x-stream-index: "002.001"
       responses:
         "200":
           content:
@@ -10140,15 +10129,6 @@ paths:
       description: |
         Returns all available devices
       operationId: ListDevices
-      parameters:
-      - in: query
-        name: user_id
-        schema:
-          description: '**Server-side only**. User ID which server acts upon'
-          title: User ID
-          type: string
-          writeOnly: true
-          x-stream-index: "001.001"
       responses:
         "200":
           content:

diff --git a/openapi/chat-openapi.json b/openapi/chat-openapi.json
diff --git a/openapi/chat-openapi.yaml b/openapi/chat-openapi.yaml
@@ -705,7 +705,7 @@ components:
     BlockUsersResponse:
       nullable: true
       properties:
-        blocked_users:
+        blocks:
           items:
             $ref: '#/components/schemas/UserBlock'
           type: array
@@ -717,7 +717,7 @@ components:
           x-stream-index: "001.001"
       required:
       - duration
-      - blocked_users
+      - blocks
       type: object
     BlockedUserResponse:
       nullable: true
@@ -1926,8 +1926,12 @@ components:
           title: Duration
           type: string
           x-stream-index: "001.001"
+        file_url:
+          type: string
+          x-stream-index: "002"
       required:
       - duration
+      - file_url
       type: object
     CheckPushRequest:
       nullable: true
@@ -2676,6 +2680,10 @@ components:
           type: string
           x-stream-index: "003.003"
         storage_type:
+          enum:
+          - s3
+          - gcs
+          - abs
           type: string
           x-stream-index: "003.001"
       required:
@@ -3432,6 +3440,10 @@ components:
           type: string
           x-stream-index: "004"
         type:
+          enum:
+          - s3
+          - gcs
+          - abs
           type: string
           x-stream-index: "002"
       required:
@@ -3753,6 +3765,11 @@ components:
         banned:
           type: boolean
           x-stream-index: "001.011"
+        blocked_user_ids:
+          items:
+            type: string
+          type: array
+          x-stream-index: "013"
         channel_mutes:
           items:
             $ref: '#/components/schemas/ChannelMute'
@@ -3866,6 +3883,7 @@ components:
       - unread_channels
       - unread_threads
       - shadow_banned
+      - blocked_user_ids
       type: object
     GeofenceResponse:
       nullable: true
@@ -9945,6 +9963,10 @@ components:
           type: string
           x-stream-index: "003.003"
         storage_type:
+          enum:
+          - s3
+          - gcs
+          - abs
           type: string
           x-stream-index: "003.001"
       required:
@@ -9969,6 +9991,10 @@ components:
           type: string
           x-stream-index: "001.004"
         type:
+          enum:
+          - s3
+          - gcs
+          - abs
           type: string
           x-stream-index: "001.002"
       required:
@@ -10296,35 +10322,20 @@ components:
     UserBlock:
       nullable: true
       properties:
-        AppPK:
-          format: int32
-          type: integer
-          writeOnly: true
-          x-stream-index: "003"
-        BlockedByUser:
-          $ref: '#/components/schemas/UserObject'
-          x-stream-index: "004"
-        BlockedByUserID:
+        blocked_by_user_id:
           type: string
-          writeOnly: true
           x-stream-index: "005"
-        BlockedUser:
-          $ref: '#/components/schemas/UserObject'
-          x-stream-index: "006"
-        BlockedUserID:
+        blocked_user_id:
           type: string
-          writeOnly: true
           x-stream-index: "007"
-        CreatedAt:
+        created_at:
           format: date-time
           type: string
-          writeOnly: true
           x-stream-index: "008"
       required:
-      - AppPK
-      - BlockedByUserID
-      - BlockedUserID
-      - CreatedAt
+      - blocked_by_user_id
+      - blocked_user_id
+      - created_at
       type: object
     UserCustomEventRequest:
       properties:
@@ -10528,6 +10539,11 @@ components:
         banned:
           type: boolean
           x-stream-index: "001.011"
+        blocked_user_ids:
+          items:
+            type: string
+          type: array
+          x-stream-index: "001.016"
         created_at:
           description: Date/time of creation
           format: date-time
@@ -10609,6 +10625,7 @@ components:
       - updated_at
       - banned
       - online
+      - blocked_user_ids
       - shadow_banned
       - devices
       - invisible
@@ -10849,7 +10866,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v116.0.2
+  version: v117.0.0
 openapi: 3.0.3
 paths:
   /app:
@@ -15968,6 +15985,13 @@ paths:
       description: |
         Get list of blocked Users
       operationId: GetBlockedUsers
+      parameters:
+      - in: query
+        name: user_id
+        schema:
+          type: string
+          writeOnly: true
+          x-stream-index: "002.001"
       responses:
         "200":
           content:

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