Update video openapi Spec

GetStream · Sep 4, 2024 · cc74cd1 · cc74cd1
1 parent 2cc09df
commit cc74cd1
Show file tree

Hide file tree

Showing 14 changed files with 841 additions and 423 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
@@ -44,6 +44,13 @@ components:
           title: More info
           type: string
           x-stream-index: "006"
+        unrecoverable:
+          description: Flag that indicates if the error is unrecoverable, requests
+            that return unrecoverable errors should not be retried, this error only
+            applies to the request that caused it
+          title: Unrecoverable
+          type: boolean
+          x-stream-index: "008"
       required:
       - code
       - message
@@ -1303,53 +1310,53 @@ components:
           description: Enable or disable auto translation
           title: Auto translation
           type: boolean
-          x-stream-index: "007"
+          x-stream-index: "005"
         auto_translation_language:
           description: Switch auto translation language
           title: Auto translation language
           type: string
-          x-stream-index: "008"
+          x-stream-index: "006"
         config_overrides:
           $ref: '#/components/schemas/ChannelConfig'
-          x-stream-index: "026"
+          x-stream-index: "024"
         created_by:
-          $ref: '#/components/schemas/UserObject'
-          x-stream-index: "011"
+          $ref: '#/components/schemas/UserRequest'
+          x-stream-index: "009"
         created_by_id:
           type: string
-          x-stream-index: "010"
+          x-stream-index: "008"
         custom:
           additionalProperties: {}
           type: object
-          x-stream-index: "017"
+          x-stream-index: "015"
         disabled:
           type: boolean
-          x-stream-index: "016"
+          x-stream-index: "014"
         frozen:
           description: Freeze or unfreeze the channel
           title: Frozen
           type: boolean
-          x-stream-index: "015"
+          x-stream-index: "013"
         invites:
           items:
             $ref: '#/components/schemas/ChannelMember'
           maximum: 100
           type: array
-          x-stream-index: "018"
+          x-stream-index: "016"
         members:
           items:
             $ref: '#/components/schemas/ChannelMember'
           maximum: 100
           type: array
-          x-stream-index: "020"
+          x-stream-index: "018"
         team:
           description: Team the channel belongs to (if multi-tenant mode is enabled)
           title: Team
           type: string
-          x-stream-index: "006"
+          x-stream-index: "004"
         truncated_by_id:
           type: string
-          x-stream-index: "012"
+          x-stream-index: "010"
       type: object
     ChannelKickedEvent:
       properties:
@@ -3586,19 +3593,15 @@ components:
     LabelThresholds:
       properties:
         block:
-          description: Threshold for automatic message block
           format: float
           maximum: 1
           minimum: 0
-          title: Block
           type: number
           x-stream-index: "002"
         flag:
-          description: Threshold for automatic message flag
           format: float
           maximum: 1
           minimum: 0
-          title: Flag
           type: number
           x-stream-index: "001"
       type: object
@@ -4270,50 +4273,74 @@ components:
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
     MessageModerationResult:
+      description: Result of the message moderation
       properties:
         action:
+          description: Action taken by automod
+          title: Action
           type: string
-          x-stream-index: "004"
+          x-stream-index: "002"
         ai_moderation_response:
           $ref: '#/components/schemas/ModerationResponse'
-          x-stream-index: "009"
+          description: Response from AI moderation
+          title: AI moderation response
+          x-stream-index: "007"
         blocked_word:
+          description: Word that was blocked
+          title: Blocked word
           type: string
-          x-stream-index: "006"
+          x-stream-index: "004"
         blocklist_name:
+          description: Name of the blocklist
+          title: Blocklist name
           type: string
-          x-stream-index: "007"
+          x-stream-index: "005"
         created_at:
+          description: Date/time of creation
           format: date-time
+          title: Created at
           type: string
-          x-stream-index: "012"
+          x-stream-index: "010"
         message_id:
+          description: ID of the message
+          title: Message ID
           type: string
-          x-stream-index: "003"
+          x-stream-index: "001"
         moderated_by:
+          description: User who moderated the message
+          title: Moderated by
           type: string
-          x-stream-index: "005"
+          x-stream-index: "003"
         moderation_thresholds:
           $ref: '#/components/schemas/Thresholds'
-          x-stream-index: "008"
+          description: Thresholds for AI moderation
+          title: Moderation thresholds
+          x-stream-index: "006"
         updated_at:
+          description: Date/time of the last update
           format: date-time
+          title: Updated at
           type: string
-          x-stream-index: "013"
+          x-stream-index: "011"
         user_bad_karma:
+          description: Whether user has bad karma
+          title: User bad karma
           type: boolean
-          x-stream-index: "011"
+          x-stream-index: "009"
         user_karma:
+          description: Karma of the user
           format: float
+          title: User karma
           type: number
-          x-stream-index: "010"
+          x-stream-index: "008"
       required:
       - message_id
       - action
       - user_karma
       - user_bad_karma
       - created_at
       - updated_at
+      title: Message moderation result
       type: object
     MessageNewEvent:
       properties:
@@ -5023,10 +5050,6 @@ components:
       x-stream-ws-base-event-name: VideoEvent
     ModerationPayload:
       properties:
-        created_at:
-          format: date-time
-          type: string
-          x-stream-index: "005"
         custom:
           additionalProperties: {}
           type: object
@@ -5046,8 +5069,6 @@ components:
             type: string
           type: array
           x-stream-index: "003"
-      required:
-      - created_at
       type: object
     ModerationResponse:
       properties:
@@ -8455,24 +8476,16 @@ components:
       x-stream-is-event: true
       x-stream-ws-base-event-name: VideoEvent
     Thresholds:
-      description: Sets thresholds for AI moderation
       properties:
         explicit:
           $ref: '#/components/schemas/LabelThresholds'
-          description: Thresholds for explicit messages
-          title: Explicit
           x-stream-index: "001"
         spam:
           $ref: '#/components/schemas/LabelThresholds'
-          description: Thresholds for spam
-          title: Spam
           x-stream-index: "002"
         toxic:
           $ref: '#/components/schemas/LabelThresholds'
-          description: Thresholds for toxic messages
-          title: Toxic
           x-stream-index: "003"
-      title: Auto moderation thresholds
       type: object
     Time:
       type: object
@@ -10386,7 +10399,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v130.1.0
+  version: v130.6.4
 openapi: 3.0.3
 paths:
   /app:

diff --git a/openapi/chat-openapi.json b/openapi/chat-openapi.json