Update video openapi Spec

GetStream · Dec 9, 2024 · 6861558 · 6861558
1 parent 6d60ad9
commit 6861558
Show file tree

Hide file tree

Showing 14 changed files with 183 additions and 82 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
@@ -11003,7 +11003,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v138.15.0
+  version: v138.17.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
@@ -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: v138.17.0
 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
diff --git a/openapi/clientside-api.yaml b/openapi/clientside-api.yaml
@@ -16910,7 +16910,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v138.15.0
+  version: v138.17.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
@@ -875,24 +875,34 @@ components:
       - rules
       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:
@@ -4497,37 +4507,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
@@ -13426,18 +13450,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
     SFULocationResponse:
       properties:
@@ -16213,33 +16249,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
@@ -17808,7 +17856,7 @@ components:
       type: apiKey
 info:
   title: Stream API
-  version: v138.15.0
+  version: v138.17.0
 openapi: 3.0.3
 paths:
   /api/v2/app:
@@ -22129,6 +22177,7 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/CreateExternalStorageRequest'
+        description: CreateExternalStorageRequest
         required: true
       responses:
         "201":
@@ -22204,6 +22253,7 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/UpdateExternalStorageRequest'
+        description: ExternalStorageRequest
         required: true
       responses:
         "201":

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