Skip to content

Commit a5bbd8b

Browse files
committed
Update video openapi Spec
1 parent 13c6344 commit a5bbd8b

36 files changed

+1080
-270
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: 128 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -286,16 +286,16 @@ components:
286286
properties:
287287
async_url_enrich_enabled:
288288
type: boolean
289-
x-stream-index: "019"
289+
x-stream-index: "020"
290290
auto_translation_enabled:
291291
type: boolean
292-
x-stream-index: "022"
292+
x-stream-index: "023"
293293
file_upload_config:
294294
$ref: '#/components/schemas/FileUploadConfig'
295-
x-stream-index: "032"
295+
x-stream-index: "033"
296296
image_upload_config:
297297
$ref: '#/components/schemas/FileUploadConfig'
298-
x-stream-index: "033"
298+
x-stream-index: "034"
299299
name:
300300
type: string
301301
x-stream-index: "001"
@@ -323,6 +323,7 @@ components:
323323
- permission_version
324324
- user_search_disallowed_roles
325325
- multi_tenant_enabled
326+
- allow_multi_user_devices
326327
- image_moderation_enabled
327328
- async_url_enrich_enabled
328329
- auto_translation_enabled
@@ -2623,6 +2624,22 @@ components:
26232624
- duration
26242625
title: Response
26252626
type: object
2627+
DeliveryReceipts:
2628+
properties:
2629+
enabled:
2630+
type: boolean
2631+
x-stream-index: "001"
2632+
required:
2633+
- enabled
2634+
type: object
2635+
DeliveryReceiptsResponse:
2636+
properties:
2637+
enabled:
2638+
type: boolean
2639+
x-stream-index: "001"
2640+
required:
2641+
- enabled
2642+
type: object
26262643
Device:
26272644
nullable: true
26282645
properties:
@@ -4371,6 +4388,94 @@ components:
43714388
x-stream-event-doc-group: other
43724389
x-stream-is-event: true
43734390
x-stream-ws-base-event-name: VideoEvent
4391+
MessageDeliveredEvent:
4392+
description: Emitted when a message is marked as delivered.
4393+
nullable: true
4394+
properties:
4395+
channel:
4396+
$ref: '#/components/schemas/ChannelResponse'
4397+
x-stream-index: "003.001"
4398+
channel_custom:
4399+
additionalProperties: {}
4400+
type: object
4401+
x-stream-index: 001.001.006
4402+
channel_id:
4403+
description: The ID of the channel where the message was read
4404+
title: Channel ID
4405+
type: string
4406+
x-stream-index: 001.002.002
4407+
channel_member_count:
4408+
description: The number of members in the channel
4409+
format: int32
4410+
title: Channel Member Count
4411+
type: integer
4412+
x-stream-index: 001.001.004
4413+
channel_message_count:
4414+
description: The number of messages in the channel
4415+
format: int64
4416+
title: Channel Message Count
4417+
type: integer
4418+
x-stream-index: 001.001.005
4419+
channel_type:
4420+
description: The type of the channel where the message was read
4421+
title: Channel Type
4422+
type: string
4423+
x-stream-index: 001.002.001
4424+
cid:
4425+
description: The CID of the channel where the message was read
4426+
title: Channel CID
4427+
type: string
4428+
x-stream-index: 001.001.001.002
4429+
created_at:
4430+
description: Date/time of creation
4431+
format: date-time
4432+
title: Created at
4433+
type: string
4434+
x-stream-index: 001.001.001.001.003
4435+
custom:
4436+
additionalProperties: {}
4437+
type: object
4438+
x-stream-index: 001.001.001.001.007
4439+
last_delivered_at:
4440+
description: The time when the message was delivered
4441+
title: Last Delivered At
4442+
type: string
4443+
x-stream-index: "005"
4444+
last_delivered_message_id:
4445+
description: The ID of the last delivered message
4446+
title: Last Delivered Message ID
4447+
type: string
4448+
x-stream-index: "004"
4449+
received_at:
4450+
format: date-time
4451+
type: string
4452+
x-stream-index: 001.001.001.001.004
4453+
team:
4454+
description: The team ID
4455+
title: Team
4456+
type: string
4457+
x-stream-index: 001.001.003
4458+
type:
4459+
default: message.delivered
4460+
description: 'The type of event: "message.delivered" in this case'
4461+
title: Event Type
4462+
type: string
4463+
x-stream-index: 001.001.001.001.002
4464+
user:
4465+
$ref: '#/components/schemas/UserResponseCommonFields'
4466+
description: The user that received the message
4467+
title: User
4468+
x-stream-index: "002.001"
4469+
required:
4470+
- type
4471+
- created_at
4472+
- custom
4473+
title: MessageDeliveredEvent
4474+
type: object
4475+
x-stream-event-client-type: true
4476+
x-stream-event-doc-group: other
4477+
x-stream-is-event: true
4478+
x-stream-ws-base-event-name: VideoEvent
43744479
MessageFlagResponse:
43754480
nullable: true
43764481
properties:
@@ -4524,7 +4629,7 @@ components:
45244629
type: array
45254630
x-stream-index: "001.002"
45264631
type:
4527-
default: notification.thread_message_new
4632+
default: message.new
45284633
type: string
45294634
x-stream-index: "004.001"
45304635
user:
@@ -7234,6 +7339,9 @@ components:
72347339
type: object
72357340
PrivacySettings:
72367341
properties:
7342+
delivery_receipts:
7343+
$ref: '#/components/schemas/DeliveryReceipts'
7344+
x-stream-index: "003"
72377345
read_receipts:
72387346
$ref: '#/components/schemas/ReadReceipts'
72397347
x-stream-index: "002"
@@ -7243,6 +7351,9 @@ components:
72437351
type: object
72447352
PrivacySettingsResponse:
72457353
properties:
7354+
delivery_receipts:
7355+
$ref: '#/components/schemas/DeliveryReceiptsResponse'
7356+
x-stream-index: "003"
72467357
read_receipts:
72477358
$ref: '#/components/schemas/ReadReceiptsResponse'
72487359
x-stream-index: "002"
@@ -8266,6 +8377,13 @@ components:
82668377
type: object
82678378
ReadStateResponse:
82688379
properties:
8380+
last_delivered_at:
8381+
format: date-time
8382+
type: string
8383+
x-stream-index: "005"
8384+
last_delivered_message_id:
8385+
type: string
8386+
x-stream-index: "006"
82698387
last_read:
82708388
format: date-time
82718389
type: string
@@ -11597,6 +11715,7 @@ components:
1159711715
draft.deleted: '#/components/schemas/DraftDeletedEvent'
1159811716
draft.updated: '#/components/schemas/DraftUpdatedEvent'
1159911717
health.check: '#/components/schemas/HealthCheckEvent'
11718+
message.delivered: '#/components/schemas/MessageDeliveredEvent'
1160011719
message.pending: '#/components/schemas/PendingMessageEvent'
1160111720
notification.reminder_due: '#/components/schemas/ReminderNotificationEvent'
1160211721
poll.closed: '#/components/schemas/PollClosedEvent'
@@ -11616,6 +11735,7 @@ components:
1161611735
- $ref: '#/components/schemas/DraftDeletedEvent'
1161711736
- $ref: '#/components/schemas/DraftUpdatedEvent'
1161811737
- $ref: '#/components/schemas/HealthCheckEvent'
11738+
- $ref: '#/components/schemas/MessageDeliveredEvent'
1161911739
- $ref: '#/components/schemas/PendingMessageEvent'
1162011740
- $ref: '#/components/schemas/PollClosedEvent'
1162111741
- $ref: '#/components/schemas/PollDeletedEvent'
@@ -11656,6 +11776,7 @@ components:
1165611776
member.removed: '#/components/schemas/MemberRemovedEvent'
1165711777
member.updated: '#/components/schemas/MemberUpdatedEvent'
1165811778
message.deleted: '#/components/schemas/MessageDeletedEvent'
11779+
message.delivered: '#/components/schemas/MessageDeliveredEvent'
1165911780
message.new: '#/components/schemas/MessageNewEvent'
1166011781
message.pending: '#/components/schemas/PendingMessageEvent'
1166111782
message.read: '#/components/schemas/MessageReadEvent'
@@ -11725,6 +11846,7 @@ components:
1172511846
- $ref: '#/components/schemas/MemberRemovedEvent'
1172611847
- $ref: '#/components/schemas/MemberUpdatedEvent'
1172711848
- $ref: '#/components/schemas/MessageDeletedEvent'
11849+
- $ref: '#/components/schemas/MessageDeliveredEvent'
1172811850
- $ref: '#/components/schemas/MessageNewEvent'
1172911851
- $ref: '#/components/schemas/MessageNewEvent'
1173011852
- $ref: '#/components/schemas/MessageReadEvent'
@@ -11861,7 +11983,7 @@ components:
1186111983
type: apiKey
1186211984
info:
1186311985
title: Stream API
11864-
version: v196.23.0
11986+
version: v198.1.0
1186511987
openapi: 3.0.3
1186611988
paths:
1186711989
/app:

openapi/chat-openapi.json

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

0 commit comments

Comments
 (0)