Update video openapi Spec

GetStream · Dec 11, 2024 · b5bad5c · b5bad5c
1 parent 7cef784
commit b5bad5c
Show file tree

Hide file tree

Showing 14 changed files with 1,868 additions and 238 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
@@ -8081,28 +8081,32 @@ components:
           items:
             $ref: '#/components/schemas/ActionLog'
           type: array
-          x-stream-index: "028"
+          x-stream-index: "029"
         assigned_to:
           $ref: '#/components/schemas/User'
-          x-stream-index: "025"
+          x-stream-index: "026"
         bans:
           items:
             $ref: '#/components/schemas/Ban'
           type: array
-          x-stream-index: "026"
+          x-stream-index: "027"
+        bounce_count:
+          format: int32
+          type: integer
+          x-stream-index: "023"
         completed_at:
           $ref: '#/components/schemas/NullTime'
           x-stream-index: "017"
         content_changed:
           type: boolean
-          x-stream-index: "029"
+          x-stream-index: "030"
         created_at:
           format: date-time
           type: string
           x-stream-index: "004"
         entity_creator:
           $ref: '#/components/schemas/EntityCreator'
-          x-stream-index: "024"
+          x-stream-index: "025"
         entity_id:
           type: string
           x-stream-index: "007"
@@ -8111,15 +8115,15 @@ components:
           x-stream-index: "006"
         feeds_v2_activity:
           $ref: '#/components/schemas/EnrichedActivity'
-          x-stream-index: "030"
+          x-stream-index: "031"
         feeds_v2_reaction:
           $ref: '#/components/schemas/Reaction'
-          x-stream-index: "031"
+          x-stream-index: "032"
         flags:
           items:
             $ref: '#/components/schemas/Flag2'
           type: array
-          x-stream-index: "027"
+          x-stream-index: "028"
         has_image:
           type: boolean
           x-stream-index: "011"
@@ -8139,7 +8143,7 @@ components:
           x-stream-index: "018"
         message:
           $ref: '#/components/schemas/Message'
-          x-stream-index: "023"
+          x-stream-index: "024"
         moderation_payload:
           $ref: '#/components/schemas/ModerationPayload'
           x-stream-index: "009"
@@ -8189,6 +8193,7 @@ components:
       - severity
       - reviewed_at
       - reviewed_by
+      - bounce_count
       - bans
       - flags
       - actions
@@ -11003,7 +11008,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v138.15.0
+  version: v139.2.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
@@ -544,24 +544,34 @@ components:
           x-stream-index: "003"
       type: object
     AzureRequest:
+      description: Config for creating Azure Blob Storage storage
       properties:
         abs_account_name:
+          description: The account name
+          title: AccountName
           type: string
           x-stream-index: "001"
         abs_client_id:
+          description: The client id
+          title: ClientID
           type: string
           x-stream-index: "003"
         abs_client_secret:
+          description: The client secret
+          title: ClientSecret
           type: string
           x-stream-index: "004"
         abs_tenant_id:
+          description: The tenant id
+          title: TenantID
           type: string
           x-stream-index: "002"
       required:
       - abs_account_name
       - abs_tenant_id
       - abs_client_id
       - abs_client_secret
+      title: AzureRequest
       type: object
     BackstageSettings:
       properties:
@@ -2981,37 +2991,51 @@ components:
       title: CreateDeviceRequest
       type: object
     CreateExternalStorageRequest:
+      description: Create external storage
       nullable: true
       properties:
         aws_s3:
           $ref: '#/components/schemas/S3Request'
+          description: Only required if you want to create an Amazon S3 storage
+          title: AwsS3
           x-stream-index: "003.004"
         azure_blob:
           $ref: '#/components/schemas/AzureRequest'
+          description: Only required if you want to create an Azure Blob Storage
+          title: AzureBlob
           x-stream-index: "003.006"
         bucket:
+          description: The name of the bucket on the service provider
+          title: Bucket
           type: string
           x-stream-index: "003.002"
         gcs_credentials:
           type: string
           x-stream-index: "003.005"
         name:
+          description: The name of the provider, this must be unique
+          title: Name
           type: string
           x-stream-index: "001"
         path:
+          description: The path prefix to use for storing files
+          title: Path
           type: string
           x-stream-index: "003.003"
         storage_type:
+          description: The type of storage to use
           enum:
           - s3
           - gcs
           - abs
+          title: StorageType
           type: string
           x-stream-index: "003.001"
       required:
       - name
       - storage_type
       - bucket
+      title: CreateExternalStorageRequest
       type: object
     CreateExternalStorageResponse:
       description: Basic response information
@@ -9335,18 +9359,30 @@ components:
       - updated_at
       type: object
     S3Request:
+      description: Config for creating Amazon S3 storage.
       properties:
         s3_api_key:
+          description: 'The AWS API key. To use Amazon S3 as your storage provider,
+            you have two authentication options: IAM role or API key. If you do not
+            specify the `s3_api_key` parameter, Stream will use IAM role authentication.
+            In that case make sure to have the correct IAM role configured for your
+            application.'
+          title: S3ApiKey
           type: string
           x-stream-index: "002"
         s3_region:
+          description: The AWS region where the bucket is hosted
+          title: S3Region
           type: string
           x-stream-index: "001"
         s3_secret:
+          description: The AWS API Secret
+          title: S3Secret
           type: string
           x-stream-index: "003"
       required:
       - s3_region
+      title: S3Request
       type: object
     ScreensharingSettings:
       properties:
@@ -11366,33 +11402,45 @@ components:
       title: UpdateCommandResponse
       type: object
     UpdateExternalStorageRequest:
+      description: External storage
       nullable: true
       properties:
         aws_s3:
           $ref: '#/components/schemas/S3Request'
+          description: Only required if you want to create an Amazon S3 storage
+          title: AwsS3
           x-stream-index: "003.004"
         azure_blob:
           $ref: '#/components/schemas/AzureRequest'
+          description: Only required if you want to create an Azure Blob Storage
+          title: AzureBlob
           x-stream-index: "003.006"
         bucket:
+          description: The name of the bucket on the service provider
+          title: Bucket
           type: string
           x-stream-index: "003.002"
         gcs_credentials:
           type: string
           x-stream-index: "003.005"
         path:
+          description: The path prefix to use for storing files
+          title: Path
           type: string
           x-stream-index: "003.003"
         storage_type:
+          description: The type of storage to use
           enum:
           - s3
           - gcs
           - abs
+          title: StorageType
           type: string
           x-stream-index: "003.001"
       required:
       - storage_type
       - bucket
+      title: ExternalStorageRequest
       type: object
     UpdateExternalStorageResponse:
       description: Basic response information
@@ -12401,7 +12449,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v138.15.0
+  version: v139.2.2
 openapi: 3.0.3
 paths:
   /app:
@@ -14742,6 +14790,7 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/CreateExternalStorageRequest'
+        description: CreateExternalStorageRequest
         required: true
       responses:
         "201":
@@ -14817,6 +14866,7 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/UpdateExternalStorageRequest'
+        description: ExternalStorageRequest
         required: true
       responses:
         "201":

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