Skip to content

Commit e9073e8

Browse files
stream-ci-zzstream-ci-zz
committed
Update video openapi Spec
1 parent 7bcd03f commit e9073e8

36 files changed

+2961
-878
lines changed

‎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: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1382,6 +1382,11 @@ components:
13821382
disabled:
13831383
type: boolean
13841384
x-stream-index: "014"
1385+
filter_tags:
1386+
items:
1387+
type: string
1388+
type: array
1389+
x-stream-index: "026"
13851390
frozen:
13861391
description: Freeze or unfreeze the channel
13871392
title: Frozen
@@ -2329,6 +2334,7 @@ components:
23292334
- domain
23302335
- domain_allowlist
23312336
- email
2337+
- email_allowlist
23322338
- word
23332339
title: Type
23342340
type: string
@@ -2667,6 +2673,15 @@ components:
26672673
- duration
26682674
title: Response
26692675
type: object
2676+
DeliveredMessagePayload:
2677+
properties:
2678+
cid:
2679+
type: string
2680+
x-stream-index: "001"
2681+
id:
2682+
type: string
2683+
x-stream-index: "002"
2684+
type: object
26702685
DeliveryReceipts:
26712686
properties:
26722687
enabled:
@@ -3667,7 +3682,7 @@ components:
36673682
reactions:
36683683
description: List of reactions
36693684
items:
3670-
$ref: '#/components/schemas/Reaction'
3685+
$ref: '#/components/schemas/ReactionResponse'
36713686
title: Reactions
36723687
type: array
36733688
x-stream-index: "001"
@@ -3992,6 +4007,28 @@ components:
39924007
type: object
39934008
x-stream-index: "001"
39944009
type: object
4010+
MarkDeliveredRequest:
4011+
nullable: true
4012+
properties:
4013+
latest_delivered_messages:
4014+
items:
4015+
$ref: '#/components/schemas/DeliveredMessagePayload'
4016+
type: array
4017+
x-stream-index: "001"
4018+
type: object
4019+
MarkDeliveredResponse:
4020+
description: Basic response information
4021+
nullable: true
4022+
properties:
4023+
duration:
4024+
description: Duration of the request in milliseconds
4025+
title: Duration
4026+
type: string
4027+
x-stream-index: "001.001"
4028+
required:
4029+
- duration
4030+
title: Response
4031+
type: object
39954032
MarkReadRequest:
39964033
nullable: true
39974034
properties:
@@ -4030,8 +4067,15 @@ components:
40304067
title: Message ID
40314068
type: string
40324069
x-stream-index: "001"
4070+
message_timestamp:
4071+
description: Timestamp of the message from where the channel is marked unread
4072+
format: date-time
4073+
title: Message Timestamp
4074+
type: string
4075+
x-stream-index: "004"
40334076
thread_id:
4034-
description: Mark a thread unread, specify both the thread and message id
4077+
description: Mark a thread unread, specify one of the thread, message timestamp,
4078+
or message id
40354079
title: Thread ID
40364080
type: string
40374081
x-stream-index: "003"
@@ -12167,7 +12211,7 @@ components:
1216712211
type: apiKey
1216812212
info:
1216912213
title: Stream API
12170-
version: v200.1.0
12214+
version: v202.2.0
1217112215
openapi: 3.0.3
1217212216
paths:
1217312217
/app:
@@ -13613,6 +13657,39 @@ paths:
1361313657
summary: Deletes channels asynchronously
1361413658
tags:
1361513659
- product:chat
13660+
/channels/delivered:
13661+
post:
13662+
description: |
13663+
Mark the status of a channel message delivered.
13664+
operationId: MarkDelivered
13665+
requestBody:
13666+
content:
13667+
application/json:
13668+
schema:
13669+
$ref: '#/components/schemas/MarkDeliveredRequest'
13670+
required: true
13671+
responses:
13672+
"201":
13673+
content:
13674+
application/json:
13675+
schema:
13676+
$ref: '#/components/schemas/MarkDeliveredResponse'
13677+
description: Response
13678+
"400":
13679+
content:
13680+
application/json:
13681+
schema:
13682+
$ref: '#/components/schemas/APIError'
13683+
description: Bad request
13684+
"429":
13685+
content:
13686+
application/json:
13687+
schema:
13688+
$ref: '#/components/schemas/APIError'
13689+
description: Too many requests
13690+
summary: Mark channel message delivery status
13691+
tags:
13692+
- product:chat
1361613693
/channels/read:
1361713694
post:
1361813695
description: |

‎openapi/chat-openapi.json‎

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

‎openapi/chat-openapi.yaml‎

Lines changed: 120 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1266,12 +1266,28 @@ components:
12661266
- updated_at
12671267
- recording_external_storage
12681268
type: object
1269+
CampaignChannelMember:
1270+
nullable: true
1271+
properties:
1272+
channel_role:
1273+
type: string
1274+
x-stream-index: "002"
1275+
custom:
1276+
additionalProperties: {}
1277+
type: object
1278+
x-stream-index: "003"
1279+
user_id:
1280+
type: string
1281+
x-stream-index: "001"
1282+
required:
1283+
- user_id
1284+
type: object
12691285
CampaignChannelTemplate:
12701286
properties:
12711287
custom:
12721288
additionalProperties: {}
12731289
type: object
1274-
x-stream-index: "005"
1290+
x-stream-index: "006"
12751291
id:
12761292
type: string
12771293
x-stream-index: "002"
@@ -1281,10 +1297,16 @@ components:
12811297
maximum: 1000
12821298
type: array
12831299
x-stream-index: "003"
1300+
members_template:
1301+
items:
1302+
$ref: '#/components/schemas/CampaignChannelMember'
1303+
maximum: 1000
1304+
type: array
1305+
x-stream-index: "004"
12841306
team:
12851307
maxLength: 1000
12861308
type: string
1287-
x-stream-index: "004"
1309+
x-stream-index: "005"
12881310
type:
12891311
maxLength: 64
12901312
type: string
@@ -2200,6 +2222,11 @@ components:
22002222
disabled:
22012223
type: boolean
22022224
x-stream-index: "014"
2225+
filter_tags:
2226+
items:
2227+
type: string
2228+
type: array
2229+
x-stream-index: "026"
22032230
frozen:
22042231
description: Freeze or unfreeze the channel
22052232
title: Frozen
@@ -3552,6 +3579,7 @@ components:
35523579
- domain
35533580
- domain_allowlist
35543581
- email
3582+
- email_allowlist
35553583
- word
35563584
title: Type
35573585
type: string
@@ -4692,6 +4720,15 @@ components:
46924720
- task_id
46934721
- duration
46944722
type: object
4723+
DeliveredMessagePayload:
4724+
properties:
4725+
cid:
4726+
type: string
4727+
x-stream-index: "001"
4728+
id:
4729+
type: string
4730+
x-stream-index: "002"
4731+
type: object
46954732
DeliveryReceipts:
46964733
properties:
46974734
enabled:
@@ -6346,7 +6383,7 @@ components:
63466383
reactions:
63476384
description: List of reactions
63486385
items:
6349-
$ref: '#/components/schemas/Reaction'
6386+
$ref: '#/components/schemas/ReactionResponse'
63506387
title: Reactions
63516388
type: array
63526389
x-stream-index: "001"
@@ -7127,6 +7164,28 @@ components:
71277164
type: string
71287165
x-stream-index: "002.001"
71297166
type: object
7167+
MarkDeliveredRequest:
7168+
nullable: true
7169+
properties:
7170+
latest_delivered_messages:
7171+
items:
7172+
$ref: '#/components/schemas/DeliveredMessagePayload'
7173+
type: array
7174+
x-stream-index: "001"
7175+
type: object
7176+
MarkDeliveredResponse:
7177+
description: Basic response information
7178+
nullable: true
7179+
properties:
7180+
duration:
7181+
description: Duration of the request in milliseconds
7182+
title: Duration
7183+
type: string
7184+
x-stream-index: "001.001"
7185+
required:
7186+
- duration
7187+
title: Response
7188+
type: object
71307189
MarkReadRequest:
71317190
nullable: true
71327191
properties:
@@ -7171,17 +7230,24 @@ components:
71717230
title: Message ID
71727231
type: string
71737232
x-stream-index: "001"
7233+
message_timestamp:
7234+
description: Timestamp of the message from where the channel is marked unread
7235+
format: date-time
7236+
title: Message Timestamp
7237+
type: string
7238+
x-stream-index: "004"
71747239
thread_id:
7175-
description: Mark a thread unread, specify both the thread and message id
7240+
description: Mark a thread unread, specify one of the thread, message timestamp,
7241+
or message id
71767242
title: Thread ID
71777243
type: string
71787244
x-stream-index: "003"
71797245
user:
71807246
$ref: '#/components/schemas/UserRequest'
7181-
x-stream-index: "004.002"
7247+
x-stream-index: "005.002"
71827248
user_id:
71837249
type: string
7184-
x-stream-index: "004.001"
7250+
x-stream-index: "005.001"
71857251
type: object
71867252
MemberAddedEvent:
71877253
properties:
@@ -16802,7 +16868,7 @@ components:
1680216868
type: apiKey
1680316869
info:
1680416870
title: Stream API
16805-
version: v200.1.0
16871+
version: v202.2.0
1680616872
openapi: 3.0.3
1680716873
paths:
1680816874
/app:
@@ -18381,6 +18447,46 @@ paths:
1838118447
summary: Deletes channels asynchronously
1838218448
tags:
1838318449
- product:chat
18450+
/channels/delivered:
18451+
post:
18452+
description: |
18453+
Mark the status of a channel message delivered.
18454+
operationId: MarkDelivered
18455+
parameters:
18456+
- in: query
18457+
name: user_id
18458+
schema:
18459+
type: string
18460+
writeOnly: true
18461+
x-stream-index: "002.001"
18462+
requestBody:
18463+
content:
18464+
application/json:
18465+
schema:
18466+
$ref: '#/components/schemas/MarkDeliveredRequest'
18467+
required: true
18468+
responses:
18469+
"201":
18470+
content:
18471+
application/json:
18472+
schema:
18473+
$ref: '#/components/schemas/MarkDeliveredResponse'
18474+
description: Response
18475+
"400":
18476+
content:
18477+
application/json:
18478+
schema:
18479+
$ref: '#/components/schemas/APIError'
18480+
description: Bad request
18481+
"429":
18482+
content:
18483+
application/json:
18484+
schema:
18485+
$ref: '#/components/schemas/APIError'
18486+
description: Too many requests
18487+
summary: Mark channel message delivery status
18488+
tags:
18489+
- product:chat
1838418490
/channels/read:
1838518491
post:
1838618492
description: |
@@ -22255,6 +22361,13 @@ paths:
2225522361
description: |
2225622362
Fetch unread counts for a single user
2225722363
operationId: UnreadCounts
22364+
parameters:
22365+
- in: query
22366+
name: user_id
22367+
schema:
22368+
type: string
22369+
writeOnly: true
22370+
x-stream-index: "001.001"
2225822371
responses:
2225922372
"200":
2226022373
content:

‎openapi/clientside-api.json‎

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

0 commit comments

Comments
 (0)