Skip to content

Commit 027e177

Browse files
committed
Update video openapi Spec
1 parent 7cef784 commit 027e177

14 files changed

+1833
-272
lines changed

docusaurus/video/docusaurus/docs/api/video-client-openapi.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docusaurus/video/docusaurus/docs/api/video-openapi.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/chat-openapi-clientside.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/chat-openapi-clientside.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4665,7 +4665,7 @@ components:
46654665
type: array
46664666
x-stream-index: "001.002"
46674667
type:
4668-
default: notification.thread_message_new
4668+
default: message.new
46694669
type: string
46704670
x-stream-index: "004.001"
46714671
user:
@@ -11003,7 +11003,7 @@ components:
1100311003
type: apiKey
1100411004
info:
1100511005
title: Stream API
11006-
version: v138.15.0
11006+
version: v139.0.0
1100711007
openapi: 3.0.3
1100811008
paths:
1100911009
/app:

openapi/chat-openapi.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/chat-openapi.yaml

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -544,24 +544,34 @@ components:
544544
x-stream-index: "003"
545545
type: object
546546
AzureRequest:
547+
description: Config for creating Azure Blob Storage storage
547548
properties:
548549
abs_account_name:
550+
description: The account name
551+
title: AccountName
549552
type: string
550553
x-stream-index: "001"
551554
abs_client_id:
555+
description: The client id
556+
title: ClientID
552557
type: string
553558
x-stream-index: "003"
554559
abs_client_secret:
560+
description: The client secret
561+
title: ClientSecret
555562
type: string
556563
x-stream-index: "004"
557564
abs_tenant_id:
565+
description: The tenant id
566+
title: TenantID
558567
type: string
559568
x-stream-index: "002"
560569
required:
561570
- abs_account_name
562571
- abs_tenant_id
563572
- abs_client_id
564573
- abs_client_secret
574+
title: AzureRequest
565575
type: object
566576
BackstageSettings:
567577
properties:
@@ -2981,37 +2991,51 @@ components:
29812991
title: CreateDeviceRequest
29822992
type: object
29832993
CreateExternalStorageRequest:
2994+
description: Create external storage
29842995
nullable: true
29852996
properties:
29862997
aws_s3:
29872998
$ref: '#/components/schemas/S3Request'
2999+
description: Only required if you want to create an Amazon S3 storage
3000+
title: AwsS3
29883001
x-stream-index: "003.004"
29893002
azure_blob:
29903003
$ref: '#/components/schemas/AzureRequest'
3004+
description: Only required if you want to create an Azure Blob Storage
3005+
title: AzureBlob
29913006
x-stream-index: "003.006"
29923007
bucket:
3008+
description: The name of the bucket on the service provider
3009+
title: Bucket
29933010
type: string
29943011
x-stream-index: "003.002"
29953012
gcs_credentials:
29963013
type: string
29973014
x-stream-index: "003.005"
29983015
name:
3016+
description: The name of the provider, this must be unique
3017+
title: Name
29993018
type: string
30003019
x-stream-index: "001"
30013020
path:
3021+
description: The path prefix to use for storing files
3022+
title: Path
30023023
type: string
30033024
x-stream-index: "003.003"
30043025
storage_type:
3026+
description: The type of storage to use
30053027
enum:
30063028
- s3
30073029
- gcs
30083030
- abs
3031+
title: StorageType
30093032
type: string
30103033
x-stream-index: "003.001"
30113034
required:
30123035
- name
30133036
- storage_type
30143037
- bucket
3038+
title: CreateExternalStorageRequest
30153039
type: object
30163040
CreateExternalStorageResponse:
30173041
description: Basic response information
@@ -9335,18 +9359,30 @@ components:
93359359
- updated_at
93369360
type: object
93379361
S3Request:
9362+
description: Config for creating Amazon S3 storage.
93389363
properties:
93399364
s3_api_key:
9365+
description: 'The AWS API key. To use Amazon S3 as your storage provider,
9366+
you have two authentication options: IAM role or API key. If you do not
9367+
specify the `s3_api_key` parameter, Stream will use IAM role authentication.
9368+
In that case make sure to have the correct IAM role configured for your
9369+
application.'
9370+
title: S3ApiKey
93409371
type: string
93419372
x-stream-index: "002"
93429373
s3_region:
9374+
description: The AWS region where the bucket is hosted
9375+
title: S3Region
93439376
type: string
93449377
x-stream-index: "001"
93459378
s3_secret:
9379+
description: The AWS API Secret
9380+
title: S3Secret
93469381
type: string
93479382
x-stream-index: "003"
93489383
required:
93499384
- s3_region
9385+
title: S3Request
93509386
type: object
93519387
ScreensharingSettings:
93529388
properties:
@@ -11366,33 +11402,45 @@ components:
1136611402
title: UpdateCommandResponse
1136711403
type: object
1136811404
UpdateExternalStorageRequest:
11405+
description: External storage
1136911406
nullable: true
1137011407
properties:
1137111408
aws_s3:
1137211409
$ref: '#/components/schemas/S3Request'
11410+
description: Only required if you want to create an Amazon S3 storage
11411+
title: AwsS3
1137311412
x-stream-index: "003.004"
1137411413
azure_blob:
1137511414
$ref: '#/components/schemas/AzureRequest'
11415+
description: Only required if you want to create an Azure Blob Storage
11416+
title: AzureBlob
1137611417
x-stream-index: "003.006"
1137711418
bucket:
11419+
description: The name of the bucket on the service provider
11420+
title: Bucket
1137811421
type: string
1137911422
x-stream-index: "003.002"
1138011423
gcs_credentials:
1138111424
type: string
1138211425
x-stream-index: "003.005"
1138311426
path:
11427+
description: The path prefix to use for storing files
11428+
title: Path
1138411429
type: string
1138511430
x-stream-index: "003.003"
1138611431
storage_type:
11432+
description: The type of storage to use
1138711433
enum:
1138811434
- s3
1138911435
- gcs
1139011436
- abs
11437+
title: StorageType
1139111438
type: string
1139211439
x-stream-index: "003.001"
1139311440
required:
1139411441
- storage_type
1139511442
- bucket
11443+
title: ExternalStorageRequest
1139611444
type: object
1139711445
UpdateExternalStorageResponse:
1139811446
description: Basic response information
@@ -12401,7 +12449,7 @@ components:
1240112449
type: apiKey
1240212450
info:
1240312451
title: Stream API
12404-
version: v138.15.0
12452+
version: v139.0.0
1240512453
openapi: 3.0.3
1240612454
paths:
1240712455
/app:
@@ -14742,6 +14790,7 @@ paths:
1474214790
application/json:
1474314791
schema:
1474414792
$ref: '#/components/schemas/CreateExternalStorageRequest'
14793+
description: CreateExternalStorageRequest
1474514794
required: true
1474614795
responses:
1474714796
"201":
@@ -14817,6 +14866,7 @@ paths:
1481714866
application/json:
1481814867
schema:
1481914868
$ref: '#/components/schemas/UpdateExternalStorageRequest'
14869+
description: ExternalStorageRequest
1482014870
required: true
1482114871
responses:
1482214872
"201":

openapi/clientside-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)