Update video openapi Spec (#583)

Co-authored-by: GH Action CI Stream <[email protected]>
GetStream · May 20, 2024 · 011b48e · 011b48e
1 parent 0cd1033
commit 011b48e
Show file tree

Hide file tree

Showing 14 changed files with 275 additions and 15 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
@@ -8647,7 +8647,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v113.1.0
+  version: v114.1.1
 openapi: 3.0.3
 paths:
   /app:

diff --git a/openapi/chat-openapi.json b/openapi/chat-openapi.json
diff --git a/openapi/chat-openapi.yaml b/openapi/chat-openapi.yaml
@@ -5270,6 +5270,40 @@ components:
       - created_at
       - updated_at
       type: object
+    MessageHistoryEntry:
+      nullable: true
+      properties:
+        Custom:
+          additionalProperties: {}
+          type: object
+          writeOnly: true
+          x-stream-index: "008"
+        attachments:
+          items:
+            $ref: '#/components/schemas/Attachment'
+          type: array
+          x-stream-index: "007"
+        message_id:
+          type: string
+          x-stream-index: "003"
+        message_updated_at:
+          format: date-time
+          type: string
+          x-stream-index: "005"
+        message_updated_by_id:
+          type: string
+          x-stream-index: "004"
+        text:
+          type: string
+          x-stream-index: "006"
+      required:
+      - message_id
+      - message_updated_by_id
+      - message_updated_at
+      - text
+      - attachments
+      - Custom
+      type: object
     MessageModerationResult:
       properties:
         action:
@@ -7188,6 +7222,59 @@ components:
       - flags
       - duration
       type: object
+    QueryMessageHistoryRequest:
+      nullable: true
+      properties:
+        filter:
+          additionalProperties: {}
+          maximum: 3
+          minimum: 1
+          type: object
+          x-stream-index: "001"
+        limit:
+          format: int32
+          maximum: 25
+          minimum: 0
+          type: integer
+          x-stream-index: "004.001"
+        next:
+          type: string
+          x-stream-index: "004.002"
+        prev:
+          type: string
+          x-stream-index: "004.003"
+        sort:
+          items:
+            $ref: '#/components/schemas/SortParam'
+          maximum: 5
+          type: array
+          x-stream-index: "002"
+      required:
+      - filter
+      type: object
+    QueryMessageHistoryResponse:
+      nullable: true
+      properties:
+        duration:
+          description: Duration of the request in human-readable format
+          title: Duration
+          type: string
+          x-stream-index: "003.001"
+        message_history:
+          items:
+            $ref: '#/components/schemas/MessageHistoryEntry'
+          type: array
+          x-stream-index: "001"
+        next:
+          type: string
+          x-stream-index: "002.001"
+        prev:
+          type: string
+          x-stream-index: "002.002"
+      required:
+      - message_history
+      - duration
+      type: object
     QueryPollVotesRequest:
       nullable: true
       properties:
@@ -10592,7 +10679,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v113.1.0
+  version: v114.1.1
 openapi: 3.0.3
 paths:
   /app:
@@ -13855,6 +13942,39 @@ paths:
       summary: Get replies
       tags:
       - product:chat
+  /messages/history:
+    post:
+      description: |
+        Queries history for one message
+      operationId: QueryMessageHistory
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/QueryMessageHistoryRequest'
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QueryMessageHistoryResponse'
+          description: Successful response
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIError'
+          description: Bad request
+        "429":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIError'
+          description: Too many requests
+      summary: Query message history
+      tags:
+      - product:chat
   /moderation/ban:
     delete:
       description: |

diff --git a/openapi/clientside-api.json b/openapi/clientside-api.json
diff --git a/openapi/clientside-api.yaml b/openapi/clientside-api.yaml
@@ -5955,7 +5955,7 @@ components:
           type: array
           x-stream-index: "001.002"
         type:
-          default: notification.thread_message_new
+          default: message.new
           type: string
           x-stream-index: "004.001"
         user:
@@ -12076,6 +12076,10 @@ components:
         info:
           $ref: '#/components/schemas/UserInfoResponse'
           x-stream-index: "001"
+        min_event_ts:
+          format: int32
+          type: integer
+          x-stream-index: "004"
         rating:
           format: int32
           type: integer
@@ -12088,6 +12092,7 @@ components:
       required:
       - info
       - session_stats
+      - min_event_ts
       type: object
     UserUnbannedEvent:
       properties:
@@ -12607,7 +12612,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v113.1.0
+  version: v114.1.1
 openapi: 3.0.3
 paths:
   /api/v2/app:

diff --git a/openapi/serverside-api.json b/openapi/serverside-api.json
diff --git a/openapi/serverside-api.yaml b/openapi/serverside-api.yaml
@@ -6569,6 +6569,40 @@ components:
       - created_at
       - updated_at
       type: object
+    MessageHistoryEntry:
+      nullable: true
+      properties:
+        Custom:
+          additionalProperties: {}
+          type: object
+          writeOnly: true
+          x-stream-index: "008"
+        attachments:
+          items:
+            $ref: '#/components/schemas/Attachment'
+          type: array
+          x-stream-index: "007"
+        message_id:
+          type: string
+          x-stream-index: "003"
+        message_updated_at:
+          format: date-time
+          type: number
+          x-stream-index: "005"
+        message_updated_by_id:
+          type: string
+          x-stream-index: "004"
+        text:
+          type: string
+          x-stream-index: "006"
+      required:
+      - message_id
+      - message_updated_by_id
+      - message_updated_at
+      - text
+      - attachments
+      - Custom
+      type: object
     MessageModerationResult:
       properties:
         action:
@@ -8757,6 +8791,59 @@ components:
       - flags
       - duration
       type: object
+    QueryMessageHistoryRequest:
+      nullable: true
+      properties:
+        filter:
+          additionalProperties: {}
+          maximum: 3
+          minimum: 1
+          type: object
+          x-stream-index: "001"
+        limit:
+          format: int32
+          maximum: 25
+          minimum: 0
+          type: integer
+          x-stream-index: "004.001"
+        next:
+          type: string
+          x-stream-index: "004.002"
+        prev:
+          type: string
+          x-stream-index: "004.003"
+        sort:
+          items:
+            $ref: '#/components/schemas/SortParam'
+          maximum: 5
+          type: array
+          x-stream-index: "002"
+      required:
+      - filter
+      type: object
+    QueryMessageHistoryResponse:
+      nullable: true
+      properties:
+        duration:
+          description: Duration of the request in human-readable format
+          title: Duration
+          type: string
+          x-stream-index: "003.001"
+        message_history:
+          items:
+            $ref: '#/components/schemas/MessageHistoryEntry'
+          type: array
+          x-stream-index: "001"
+        next:
+          type: string
+          x-stream-index: "002.001"
+        prev:
+          type: string
+          x-stream-index: "002.002"
+      required:
+      - message_history
+      - duration
+      type: object
     QueryPollVotesRequest:
       nullable: true
       properties:
@@ -12736,6 +12823,10 @@ components:
         info:
           $ref: '#/components/schemas/UserInfoResponse'
           x-stream-index: "001"
+        min_event_ts:
+          format: int32
+          type: integer
+          x-stream-index: "004"
         rating:
           format: int32
           type: integer
@@ -12748,6 +12839,7 @@ components:
       required:
       - info
       - session_stats
+      - min_event_ts
       type: object
     VideoQuality:
       properties:
@@ -13058,7 +13150,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v113.1.0
+  version: v114.1.1
 openapi: 3.0.3
 paths:
   /api/v2/app:
@@ -15620,6 +15712,39 @@ paths:
       summary: Get replies
       tags:
       - product:chat
+  /api/v2/chat/messages/history:
+    post:
+      description: |
+        Queries history for one message
+      operationId: QueryMessageHistory
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/QueryMessageHistoryRequest'
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QueryMessageHistoryResponse'
+          description: Successful response
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIError'
+          description: Bad request
+        "429":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIError'
+          description: Too many requests
+      summary: Query message history
+      tags:
+      - product:chat
   /api/v2/chat/moderation/flags/message:
     get:
       description: |

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
@@ -5308,6 +5308,10 @@ components:
         info:
           $ref: '#/components/schemas/UserInfoResponse'
           x-stream-index: "001"
+        min_event_ts:
+          format: int32
+          type: integer
+          x-stream-index: "004"
         rating:
           format: int32
           type: integer
@@ -5320,6 +5324,7 @@ components:
       required:
       - info
       - session_stats
+      - min_event_ts
       type: object
     UserUnbannedEvent:
       properties:
@@ -5616,7 +5621,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v113.1.0
+  version: v114.1.1
 openapi: 3.0.3
 paths:
   /video/call/{type}/{id}:

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