Update video openapi Spec

GetStream · Sep 10, 2024 · b56a56f · b56a56f
1 parent 655e315
commit b56a56f
Show file tree

Hide file tree

Showing 14 changed files with 294 additions and 314 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
@@ -5021,7 +5021,7 @@ components:
       x-stream-event-client-type: true
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
-    ModerationMarkSafeEvent:
+    ModerationMarkReviewedEvent:
       properties:
         created_at:
           format: date-time
@@ -5034,7 +5034,7 @@ components:
           $ref: '#/components/schemas/Message'
           x-stream-index: "002"
         type:
-          default: moderation.mark_safe
+          default: moderation.mark_reviewed
           type: string
           x-stream-index: "004.001"
         user:
@@ -5043,7 +5043,7 @@ components:
       required:
       - type
       - created_at
-      title: ModerationMarkSafeEvent
+      title: ModerationMarkReviewedEvent
       type: object
       x-stream-event-client-type: true
       x-stream-is-event: true
@@ -6539,7 +6539,7 @@ components:
           type: string
           x-stream-index: "002"
       type: object
-    QueryBannedUsersRequest:
+    QueryBannedUsersPayload:
       properties:
         exclude_expired_bans:
           description: Whether to exclude expired bans or not
@@ -6673,61 +6673,47 @@ components:
       - duration
       title: Channels list
       type: object
-    QueryMembersRequest:
+    QueryMembersPayload:
       properties:
         filter_conditions:
           additionalProperties: {}
-          description: Filter to apply to members
-          title: Filter conditions
           type: object
           x-stream-index: "004"
         id:
-          description: Channel ID to interact with
-          title: Channel ID
           type: string
           x-stream-index: "002"
         limit:
-          description: Number of records to return
           format: int32
           maximum: 300
           minimum: 0
-          title: Limit
           type: integer
           x-stream-index: "006.003"
         members:
-          description: List of members to search in distinct channels
           items:
             $ref: '#/components/schemas/ChannelMember'
           maximum: 100
-          title: Members
           type: array
           x-stream-index: "003"
         offset:
-          description: Number of records to offset
           format: int32
           maximum: 10000
-          title: Offset
           type: integer
           x-stream-index: "006.004"
         sort:
-          description: Array of sort parameters
           items:
             $ref: '#/components/schemas/SortParamRequest'
           maximum: 1
-          title: Sort
           type: array
           x-stream-index: "005"
         type:
-          description: Channel type to interact with
           maxLength: 64
-          title: Channel type
           type: string
           x-stream-index: "001"
       required:
       - type
       - filter_conditions
       type: object
-    QueryMessageFlagsRequest:
+    QueryMessageFlagsPayload:
       properties:
         filter_conditions:
           additionalProperties: {}
@@ -7526,7 +7512,7 @@ components:
       - actions
       - content_changed
       type: object
-    SearchRequest:
+    SearchPayload:
       properties:
         filter_conditions:
           additionalProperties: {}
@@ -10144,7 +10130,7 @@ components:
           message.updated: '#/components/schemas/MessageUpdatedEvent'
           moderation.custom_action: '#/components/schemas/ModerationCustomActionEvent'
           moderation.flagged: '#/components/schemas/ModerationFlaggedEvent'
-          moderation.mark_safe: '#/components/schemas/ModerationMarkSafeEvent'
+          moderation.mark_reviewed: '#/components/schemas/ModerationMarkReviewedEvent'
           notification.added_to_channel: '#/components/schemas/NotificationAddedToChannelEvent'
           notification.channel_deleted: '#/components/schemas/NotificationChannelDeletedEvent'
           notification.channel_mutes_updated: '#/components/schemas/NotificationChannelMutesUpdatedEvent'
@@ -10197,7 +10183,7 @@ components:
       - $ref: '#/components/schemas/MessageUpdatedEvent'
       - $ref: '#/components/schemas/ModerationCustomActionEvent'
       - $ref: '#/components/schemas/ModerationFlaggedEvent'
-      - $ref: '#/components/schemas/ModerationMarkSafeEvent'
+      - $ref: '#/components/schemas/ModerationMarkReviewedEvent'
       - $ref: '#/components/schemas/NotificationAddedToChannelEvent'
       - $ref: '#/components/schemas/NotificationChannelDeletedEvent'
       - $ref: '#/components/schemas/NotificationChannelMutesUpdatedEvent'
@@ -10256,7 +10242,7 @@ components:
           message.updated: '#/components/schemas/MessageUpdatedEvent'
           moderation.custom_action: '#/components/schemas/ModerationCustomActionEvent'
           moderation.flagged: '#/components/schemas/ModerationFlaggedEvent'
-          moderation.mark_safe: '#/components/schemas/ModerationMarkSafeEvent'
+          moderation.mark_reviewed: '#/components/schemas/ModerationMarkReviewedEvent'
           notification.thread_message_new: '#/components/schemas/MessageNewEvent'
           reaction.deleted: '#/components/schemas/ReactionDeletedEvent'
           reaction.new: '#/components/schemas/ReactionNewEvent'
@@ -10301,7 +10287,7 @@ components:
       - $ref: '#/components/schemas/MessageUpdatedEvent'
       - $ref: '#/components/schemas/ModerationCustomActionEvent'
       - $ref: '#/components/schemas/ModerationFlaggedEvent'
-      - $ref: '#/components/schemas/ModerationMarkSafeEvent'
+      - $ref: '#/components/schemas/ModerationMarkReviewedEvent'
       - $ref: '#/components/schemas/ReactionDeletedEvent'
       - $ref: '#/components/schemas/ReactionNewEvent'
       - $ref: '#/components/schemas/ReactionUpdatedEvent'
@@ -10399,7 +10385,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v130.6.4
+  version: v130.9.1
 openapi: 3.0.3
 paths:
   /app:
@@ -11888,7 +11874,7 @@ paths:
       - content:
           application/json:
             schema:
-              $ref: '#/components/schemas/QueryMembersRequest'
+              $ref: '#/components/schemas/QueryMembersPayload'
               x-stream-index: "001"
         in: query
         name: payload
@@ -12801,7 +12787,9 @@ paths:
       - content:
           application/json:
             schema:
-              $ref: '#/components/schemas/QueryMessageFlagsRequest'
+              $ref: '#/components/schemas/QueryMessageFlagsPayload'
+              description: JSON object with query message flags payload
+              title: Payload
               x-stream-index: "001"
         in: query
         name: payload
@@ -13543,7 +13531,9 @@ paths:
       - content:
           application/json:
             schema:
-              $ref: '#/components/schemas/QueryBannedUsersRequest'
+              $ref: '#/components/schemas/QueryBannedUsersPayload'
+              description: JSON object with query user bans payload
+              title: Payload
               x-stream-index: "001"
         in: query
         name: payload
@@ -13581,7 +13571,7 @@ paths:
       - content:
           application/json:
             schema:
-              $ref: '#/components/schemas/SearchRequest'
+              $ref: '#/components/schemas/SearchPayload'
               description: JSON object with search payload
               title: Payload
               x-stream-index: "001"

diff --git a/openapi/chat-openapi.json b/openapi/chat-openapi.json
diff --git a/openapi/chat-openapi.yaml b/openapi/chat-openapi.yaml
@@ -7537,7 +7537,7 @@ components:
       - created_at
       - updated_at
       type: object
-    QueryBannedUsersRequest:
+    QueryBannedUsersPayload:
       properties:
         exclude_expired_bans:
           description: Whether to exclude expired bans or not
@@ -7674,54 +7674,40 @@ components:
       - duration
       title: Channels list
       type: object
-    QueryMembersRequest:
+    QueryMembersPayload:
       properties:
         filter_conditions:
           additionalProperties: {}
-          description: Filter to apply to members
-          title: Filter conditions
           type: object
           x-stream-index: "004"
         id:
-          description: Channel ID to interact with
-          title: Channel ID
           type: string
           x-stream-index: "002"
         limit:
-          description: Number of records to return
           format: int32
           maximum: 300
           minimum: 0
-          title: Limit
           type: integer
           x-stream-index: "006.003"
         members:
-          description: List of members to search in distinct channels
           items:
             $ref: '#/components/schemas/ChannelMember'
           maximum: 100
-          title: Members
           type: array
           x-stream-index: "003"
         offset:
-          description: Number of records to offset
           format: int32
           maximum: 10000
-          title: Offset
           type: integer
           x-stream-index: "006.004"
         sort:
-          description: Array of sort parameters
           items:
             $ref: '#/components/schemas/SortParamRequest'
           maximum: 1
-          title: Sort
           type: array
           x-stream-index: "005"
         type:
-          description: Channel type to interact with
           maxLength: 64
-          title: Channel type
           type: string
           x-stream-index: "001"
         user:
@@ -7734,7 +7720,7 @@ components:
       - type
       - filter_conditions
       type: object
-    QueryMessageFlagsRequest:
+    QueryMessageFlagsPayload:
       properties:
         filter_conditions:
           additionalProperties: {}
@@ -8596,7 +8582,7 @@ components:
       - enabled
       - access_request_enabled
       type: object
-    SearchRequest:
+    SearchPayload:
       properties:
         filter_conditions:
           additionalProperties: {}
@@ -11543,7 +11529,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v130.6.4
+  version: v130.9.1
 openapi: 3.0.3
 paths:
   /app:
@@ -13977,7 +13963,7 @@ paths:
       - content:
           application/json:
             schema:
-              $ref: '#/components/schemas/QueryMembersRequest'
+              $ref: '#/components/schemas/QueryMembersPayload'
               x-stream-index: "001"
         in: query
         name: payload
@@ -15016,7 +15002,9 @@ paths:
       - content:
           application/json:
             schema:
-              $ref: '#/components/schemas/QueryMessageFlagsRequest'
+              $ref: '#/components/schemas/QueryMessageFlagsPayload'
+              description: JSON object with query message flags payload
+              title: Payload
               x-stream-index: "001"
         in: query
         name: payload
@@ -15930,7 +15918,9 @@ paths:
       - content:
           application/json:
             schema:
-              $ref: '#/components/schemas/QueryBannedUsersRequest'
+              $ref: '#/components/schemas/QueryBannedUsersPayload'
+              description: JSON object with query user bans payload
+              title: Payload
               x-stream-index: "001"
         in: query
         name: payload
@@ -16133,7 +16123,7 @@ paths:
       - content:
           application/json:
             schema:
-              $ref: '#/components/schemas/SearchRequest'
+              $ref: '#/components/schemas/SearchPayload'
               description: JSON object with search payload
               title: Payload
               x-stream-index: "001"

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