Update video openapi Spec (#452)

Co-authored-by: GH Action CI Stream <[email protected]>
GetStream · Feb 26, 2024 · c2c3e28 · c2c3e28
1 parent c8f14ba
commit c2c3e28
Show file tree

Hide file tree

Showing 12 changed files with 105 additions and 19 deletions.
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
@@ -4073,7 +4073,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:
@@ -8435,7 +8435,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v99.1.1
+  version: v99.2.0
 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
@@ -2396,16 +2396,17 @@ components:
           description: Block list type.
           enum:
           - regex
-          - regular
-          - domains
-          - emails
+          - domain
+          - email
+          - word
           title: Type
           type: string
           x-stream-index: "003"
         words:
           description: List of words to block
           items:
             type: string
+          minimum: 1
           title: Words
           type: array
           x-stream-index: "002"
@@ -8516,11 +8517,16 @@ components:
           writeOnly: true
           x-stream-index: "001"
         words:
+          description: List of words to block
           items:
             type: string
+          minimum: 1
+          title: Words
           type: array
           x-stream-index: "002"
+      title: Update block list
       type: object
+      x-stream-docs-page-id: update_block_list
     UpdateChannelPartialRequest:
       nullable: true
       properties:
@@ -9785,7 +9791,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v99.1.1
+  version: v99.2.0
 openapi: 3.0.3
 paths:
   /app:
@@ -9993,6 +9999,8 @@ paths:
         name: name
         required: true
         schema:
+          description: Block list name
+          title: Name
           type: string
           writeOnly: true
           x-stream-index: "001"
@@ -10001,6 +10009,7 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/UpdateBlockListRequest'
+        description: Update block list
         required: true
       responses:
         "201":
@@ -10025,6 +10034,40 @@ paths:
       tags:
       - Settings
       - Moderation
+  /blocklists/{type}/validate:
+    post:
+      description: |
+        Runs specific blocklist validation, returns an appropriate error if the blocklist is invalid
+      operationId: ValidateBlockList
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateBlockListRequest'
+        description: Block list
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Response'
+          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: Validate Blocklist
+      tags:
+      - Moderation
   /calls:
     post:
       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
@@ -11276,7 +11276,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v99.1.1
+  version: v99.2.0
 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
@@ -2893,16 +2893,17 @@ components:
           description: Block list type.
           enum:
           - regex
-          - regular
-          - domains
-          - emails
+          - domain
+          - email
+          - word
           title: Type
           type: string
           x-stream-index: "003"
         words:
           description: List of words to block
           items:
             type: string
+          minimum: 1
           title: Words
           type: array
           x-stream-index: "002"
@@ -10088,11 +10089,16 @@ components:
           writeOnly: true
           x-stream-index: "001"
         words:
+          description: List of words to block
           items:
             type: string
+          minimum: 1
+          title: Words
           type: array
           x-stream-index: "002"
+      title: Update block list
       type: object
+      x-stream-docs-page-id: update_block_list
     UpdateCallMembersRequest:
       nullable: true
       properties:
@@ -11590,7 +11596,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v99.1.1
+  version: v99.2.0
 openapi: 3.0.3
 paths:
   /api/v2/app:
@@ -11798,6 +11804,8 @@ paths:
         name: name
         required: true
         schema:
+          description: Block list name
+          title: Name
           type: string
           writeOnly: true
           x-stream-index: "001"
@@ -11806,6 +11814,7 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/UpdateBlockListRequest'
+        description: Update block list
         required: true
       responses:
         "201":
@@ -11830,6 +11839,40 @@ paths:
       tags:
       - Settings
       - Moderation
+  /api/v2/chat/blocklists/{type}/validate:
+    post:
+      description: |
+        Runs specific blocklist validation, returns an appropriate error if the blocklist is invalid
+      operationId: ValidateBlockList
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateBlockListRequest'
+        description: Block list
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Response'
+          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: Validate Blocklist
+      tags:
+      - Moderation
   /api/v2/chat/channels:
     post:
       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
@@ -3494,7 +3494,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v99.1.1
+  version: v99.2.0
 openapi: 3.0.3
 paths:
   /video/call/{type}/{id}:

diff --git a/openapi/video-openapi.json b/openapi/video-openapi.json
diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml
@@ -2518,7 +2518,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v99.1.1
+  version: v99.2.0
 openapi: 3.0.3
 paths:
   /video/call/{type}/{id}: