Update video openapi Spec

GetStream · Aug 6, 2024 · 8527768 · 8527768
1 parent 7cf5b5d
commit 8527768
Show file tree

Hide file tree

Showing 14 changed files with 583 additions and 73 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
@@ -93,9 +93,15 @@ components:
         reason:
           type: string
           x-stream-index: "008"
+        review_queue_item:
+          $ref: '#/components/schemas/ReviewQueueItem'
+          x-stream-index: "013"
         review_queue_item_id:
           type: string
           x-stream-index: "011"
+        target_user:
+          $ref: '#/components/schemas/UserObject'
+          x-stream-index: "012"
         target_user_id:
           type: string
           x-stream-index: "010"
@@ -2428,8 +2434,6 @@ components:
           type: string
           x-stream-index: "002.004"
         id:
-          description: Device ID
-          title: ID
           type: string
           x-stream-index: 002.001.004
         push_provider:
@@ -2438,12 +2442,9 @@ components:
           - apn
           - huawei
           - xiaomi
-          title: Push provider
           type: string
           x-stream-index: 002.001.001
         push_provider_name:
-          description: Name of the push provider configuration
-          title: Push provider name
           type: string
           x-stream-index: 002.001.003
         user_id:
@@ -2461,8 +2462,6 @@ components:
     DeviceFields:
       properties:
         id:
-          description: Device ID
-          title: ID
           type: string
           x-stream-index: "004"
         push_provider:
@@ -2471,12 +2470,9 @@ components:
           - apn
           - huawei
           - xiaomi
-          title: Push provider
           type: string
           x-stream-index: "001"
         push_provider_name:
-          description: Name of the push provider configuration
-          title: Push provider name
           type: string
           x-stream-index: "003"
         voip:
@@ -4322,7 +4318,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:
@@ -5971,7 +5967,7 @@ components:
           type: string
           x-stream-index: 002.003.003
         poll:
-          $ref: '#/components/schemas/PollResponseData'
+          $ref: '#/components/schemas/PollPayloadData'
           x-stream-index: "001"
         received_at:
           format: date-time
@@ -5998,7 +5994,7 @@ components:
           type: string
           x-stream-index: 002.003.003
         poll:
-          $ref: '#/components/schemas/PollResponseData'
+          $ref: '#/components/schemas/PollPayloadData'
           x-stream-index: "001"
         received_at:
           format: date-time
@@ -6096,6 +6092,99 @@ components:
       - text
       - custom
       type: object
+    PollPayloadData:
+      properties:
+        Custom:
+          additionalProperties: {}
+          type: object
+          writeOnly: true
+          x-stream-index: "019"
+        allow_answers:
+          type: boolean
+          x-stream-index: "008"
+        allow_user_suggested_options:
+          type: boolean
+          x-stream-index: "007"
+        answers_count:
+          format: int32
+          type: integer
+          x-stream-index: "012"
+        created_at:
+          format: date-time
+          type: string
+          x-stream-index: "017"
+        created_by:
+          $ref: '#/components/schemas/UserObject'
+          x-stream-index: "016"
+        created_by_id:
+          type: string
+          x-stream-index: "015"
+        description:
+          type: string
+          x-stream-index: "003"
+        enforce_unique_vote:
+          type: boolean
+          x-stream-index: "005"
+        id:
+          type: string
+          x-stream-index: "001"
+        is_closed:
+          type: boolean
+          x-stream-index: "009"
+        latest_votes_by_option:
+          additionalProperties:
+            items:
+              $ref: '#/components/schemas/PollVoteResponseData'
+            type: array
+          type: object
+          x-stream-index: "014"
+        max_votes_allowed:
+          format: int32
+          type: integer
+          x-stream-index: "006"
+        name:
+          type: string
+          x-stream-index: "002"
+        options:
+          items:
+            $ref: '#/components/schemas/PollOptionResponseData'
+          type: array
+          x-stream-index: "011"
+        updated_at:
+          format: date-time
+          type: string
+          x-stream-index: "018"
+        vote_count:
+          format: int32
+          type: integer
+          x-stream-index: "010"
+        vote_counts_by_option:
+          additionalProperties:
+            format: int32
+            type: integer
+          type: object
+          x-stream-index: "013"
+        voting_visibility:
+          type: string
+          x-stream-index: "004"
+      required:
+      - id
+      - name
+      - description
+      - voting_visibility
+      - enforce_unique_vote
+      - allow_user_suggested_options
+      - allow_answers
+      - vote_count
+      - options
+      - answers_count
+      - vote_counts_by_option
+      - latest_votes_by_option
+      - created_by_id
+      - created_at
+      - updated_at
+      - Custom
+      type: object
     PollResponse:
       nullable: true
       properties:
@@ -6223,7 +6312,7 @@ components:
           type: string
           x-stream-index: 002.003.003
         poll:
-          $ref: '#/components/schemas/PollResponseData'
+          $ref: '#/components/schemas/PollPayloadData'
           x-stream-index: "001"
         received_at:
           format: date-time
@@ -6289,7 +6378,7 @@ components:
           type: string
           x-stream-index: 003.003.003
         poll:
-          $ref: '#/components/schemas/PollResponseData'
+          $ref: '#/components/schemas/PollPayloadData'
           x-stream-index: "001"
         poll_vote:
           $ref: '#/components/schemas/PollVoteResponseData'
@@ -6320,7 +6409,7 @@ components:
           type: string
           x-stream-index: 003.003.003
         poll:
-          $ref: '#/components/schemas/PollResponseData'
+          $ref: '#/components/schemas/PollPayloadData'
           x-stream-index: "001"
         poll_vote:
           $ref: '#/components/schemas/PollVoteResponseData'
@@ -6351,7 +6440,7 @@ components:
           type: string
           x-stream-index: 003.003.003
         poll:
-          $ref: '#/components/schemas/PollResponseData'
+          $ref: '#/components/schemas/PollPayloadData'
           x-stream-index: "001"
         poll_vote:
           $ref: '#/components/schemas/PollVoteResponseData'
@@ -10419,7 +10508,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v126.7.0
+  version: v127.4.2
 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
@@ -786,9 +786,11 @@ components:
         hls:
           $ref: '#/components/schemas/HLSSettings'
           x-stream-index: "002"
+        rtmp:
+          $ref: '#/components/schemas/RTMPSettings'
+          x-stream-index: "003"
       required:
       - enabled
-      - hls
       type: object
     Call:
       properties:
@@ -3326,45 +3328,52 @@ components:
       nullable: true
       properties:
         created_at:
+          description: Date/time of creation
           format: date-time
+          title: Created at
           type: string
-          x-stream-index: "002.002"
+          x-stream-index: "004"
         disabled:
+          description: Whether device is disabled or not
+          title: Disabled
           type: boolean
-          x-stream-index: "002.003"
+          x-stream-index: "005"
         disabled_reason:
+          description: Reason explaining why device had been disabled
+          title: Reason
           type: string
-          x-stream-index: "002.004"
+          x-stream-index: "006"
         id:
           description: Device ID
           title: ID
           type: string
-          x-stream-index: 002.001.004
+          x-stream-index: "003"
         push_provider:
-          enum:
-          - firebase
-          - apn
-          - huawei
-          - xiaomi
-          title: Push provider
+          description: Push provider
+          title: PushProvider
           type: string
-          x-stream-index: 002.001.001
+          x-stream-index: "001"
         push_provider_name:
-          description: Name of the push provider configuration
-          title: Push provider name
+          description: Push provider name
+          title: PushProviderName
           type: string
-          x-stream-index: 002.001.003
+          x-stream-index: "002"
         user_id:
+          description: User ID
+          title: UserID
           type: string
-          x-stream-index: "004"
+          x-stream-index: "008"
         voip:
+          description: When true the token is for Apple VoIP push notifications
+          title: Voip
           type: boolean
-          x-stream-index: 002.001.005
+          x-stream-index: "007"
       required:
       - push_provider
       - id
       - created_at
       - user_id
+      title: Device
       type: object
     DeviceErrorInfo:
       properties:
@@ -8039,6 +8048,25 @@ components:
       - users
       - duration
       type: object
+    RTMPSettings:
+      properties:
+        enabled:
+          type: boolean
+          x-stream-index: "001"
+        layout:
+          $ref: '#/components/schemas/LayoutSettings'
+          x-stream-index: "003"
+        max_duration_minutes:
+          format: int32
+          type: integer
+          x-stream-index: "004"
+        quality:
+          type: string
+          x-stream-index: "002"
+      required:
+      - enabled
+      - quality
+      type: object
     Reaction:
       description: Represents user reaction to a message
       nullable: true
@@ -11461,7 +11489,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v126.7.0
+  version: v127.4.2
 openapi: 3.0.3
 paths:
   /app:

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