Skip to content

Commit 3273596

Browse files
committed
Update video openapi Spec
1 parent 63e2a2f commit 3273596

32 files changed

+1235
-141
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: 92 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4514,7 +4514,7 @@ components:
45144514
type: array
45154515
x-stream-index: "001.002"
45164516
type:
4517-
default: notification.thread_message_new
4517+
default: message.new
45184518
type: string
45194519
x-stream-index: "004.001"
45204520
user:
@@ -10732,6 +10732,91 @@ components:
1073210732
x-stream-event-doc-group: other
1073310733
x-stream-is-event: true
1073410734
x-stream-ws-base-event-name: VideoEvent
10735+
UserMessagesDeletedEvent:
10736+
description: This event is sent when a user's message get deleted. The event
10737+
contains information about the user whose messages got deleted.
10738+
nullable: true
10739+
properties:
10740+
channel_custom:
10741+
additionalProperties: {}
10742+
type: object
10743+
x-stream-index: 001.001.005
10744+
channel_id:
10745+
description: The ID of the channel where the target user's messages were
10746+
deleted
10747+
title: Channel ID
10748+
type: string
10749+
x-stream-index: 001.002.002
10750+
channel_member_count:
10751+
format: int32
10752+
type: integer
10753+
x-stream-index: 001.001.004
10754+
channel_type:
10755+
description: The type of the channel where the target user's messages were
10756+
deleted
10757+
title: Channel Type
10758+
type: string
10759+
x-stream-index: 001.002.001
10760+
cid:
10761+
description: The CID of the channel where the target user's messages were
10762+
deleted
10763+
title: Channel CID
10764+
type: string
10765+
x-stream-index: 001.001.001.002
10766+
created_at:
10767+
description: Date/time of creation
10768+
format: date-time
10769+
title: Created at
10770+
type: string
10771+
x-stream-index: 001.001.001.001.003
10772+
custom:
10773+
additionalProperties: {}
10774+
type: object
10775+
x-stream-index: 001.001.001.001.007
10776+
hard_delete:
10777+
description: Whether Messages were hard deleted
10778+
title: Hard Delete
10779+
type: boolean
10780+
x-stream-index: "004"
10781+
received_at:
10782+
format: date-time
10783+
type: string
10784+
x-stream-index: 001.001.001.001.004
10785+
soft_delete:
10786+
description: Whether Messages were soft deleted
10787+
title: Soft Delete
10788+
type: boolean
10789+
x-stream-index: "003"
10790+
team:
10791+
description: The team of the channel where the target user's messages were
10792+
deleted
10793+
title: Team
10794+
type: string
10795+
x-stream-index: 001.001.003
10796+
type:
10797+
default: user.messages.deleted
10798+
description: 'The type of event: "user.messages.deleted" in this case'
10799+
title: Event Type
10800+
type: string
10801+
x-stream-index: 001.001.001.001.002
10802+
user:
10803+
$ref: '#/components/schemas/UserResponseCommonFields'
10804+
description: The target user whose messages got deleted
10805+
title: User
10806+
x-stream-index: "002.001"
10807+
required:
10808+
- type
10809+
- created_at
10810+
- custom
10811+
- user
10812+
- soft_delete
10813+
- hard_delete
10814+
title: UserMessagesDeletedEvent
10815+
type: object
10816+
x-stream-event-client-type: true
10817+
x-stream-event-doc-group: other
10818+
x-stream-is-event: true
10819+
x-stream-ws-base-event-name: VideoEvent
1073510820
UserMute:
1073610821
nullable: true
1073710822
properties:
@@ -11381,6 +11466,7 @@ components:
1138111466
reminder.created: '#/components/schemas/ReminderCreatedEvent'
1138211467
reminder.deleted: '#/components/schemas/ReminderDeletedEvent'
1138311468
reminder.updated: '#/components/schemas/ReminderUpdatedEvent'
11469+
user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent'
1138411470
user.updated: '#/components/schemas/UserUpdatedEvent'
1138511471
propertyName: type
1138611472
oneOf:
@@ -11399,6 +11485,7 @@ components:
1139911485
- $ref: '#/components/schemas/ReminderDeletedEvent'
1140011486
- $ref: '#/components/schemas/ReminderNotificationEvent'
1140111487
- $ref: '#/components/schemas/ReminderUpdatedEvent'
11488+
- $ref: '#/components/schemas/UserMessagesDeletedEvent'
1140211489
- $ref: '#/components/schemas/UserUpdatedEvent'
1140311490
WSEvent:
1140411491
description: The discriminator object for all websocket events, it maps events'
@@ -11464,6 +11551,7 @@ components:
1146411551
user.banned: '#/components/schemas/UserBannedEvent'
1146511552
user.deactivated: '#/components/schemas/UserDeactivatedEvent'
1146611553
user.deleted: '#/components/schemas/UserDeletedEvent'
11554+
user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent'
1146711555
user.muted: '#/components/schemas/UserMutedEvent'
1146811556
user.presence.changed: '#/components/schemas/UserPresenceChangedEvent'
1146911557
user.reactivated: '#/components/schemas/UserReactivatedEvent'
@@ -11532,6 +11620,7 @@ components:
1153211620
- $ref: '#/components/schemas/UserBannedEvent'
1153311621
- $ref: '#/components/schemas/UserDeactivatedEvent'
1153411622
- $ref: '#/components/schemas/UserDeletedEvent'
11623+
- $ref: '#/components/schemas/UserMessagesDeletedEvent'
1153511624
- $ref: '#/components/schemas/UserMutedEvent'
1153611625
- $ref: '#/components/schemas/UserPresenceChangedEvent'
1153711626
- $ref: '#/components/schemas/UserReactivatedEvent'
@@ -11630,7 +11719,7 @@ components:
1163011719
type: apiKey
1163111720
info:
1163211721
title: Stream API
11633-
version: v187.13.0
11722+
version: v188.1.3
1163411723
openapi: 3.0.3
1163511724
paths:
1163611725
/app:
@@ -14272,6 +14361,7 @@ paths:
1427214361
1427314362
Sends events:
1427414363
- user.banned
14364+
- user.messages.deleted
1427514365
- user.banned
1427614366
operationId: Ban
1427714367
requestBody:

openapi/chat-openapi.json

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

openapi/chat-openapi.yaml

Lines changed: 91 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ components:
584584
type: string
585585
x-stream-index: "002.001"
586586
type:
587-
default: export.channels.error
587+
default: export.moderation_logs.error
588588
type: string
589589
x-stream-index: "003.002"
590590
required:
@@ -7672,7 +7672,7 @@ components:
76727672
type: array
76737673
x-stream-index: "001.002"
76747674
type:
7675-
default: notification.thread_message_new
7675+
default: message.new
76767676
type: string
76777677
x-stream-index: "004.001"
76787678
user:
@@ -15212,6 +15212,91 @@ components:
1521215212
x-stream-event-doc-group: other
1521315213
x-stream-is-event: true
1521415214
x-stream-ws-base-event-name: VideoEvent
15215+
UserMessagesDeletedEvent:
15216+
description: This event is sent when a user's message get deleted. The event
15217+
contains information about the user whose messages got deleted.
15218+
nullable: true
15219+
properties:
15220+
channel_custom:
15221+
additionalProperties: {}
15222+
type: object
15223+
x-stream-index: 001.001.005
15224+
channel_id:
15225+
description: The ID of the channel where the target user's messages were
15226+
deleted
15227+
title: Channel ID
15228+
type: string
15229+
x-stream-index: 001.002.002
15230+
channel_member_count:
15231+
format: int32
15232+
type: integer
15233+
x-stream-index: 001.001.004
15234+
channel_type:
15235+
description: The type of the channel where the target user's messages were
15236+
deleted
15237+
title: Channel Type
15238+
type: string
15239+
x-stream-index: 001.002.001
15240+
cid:
15241+
description: The CID of the channel where the target user's messages were
15242+
deleted
15243+
title: Channel CID
15244+
type: string
15245+
x-stream-index: 001.001.001.002
15246+
created_at:
15247+
description: Date/time of creation
15248+
format: date-time
15249+
title: Created at
15250+
type: string
15251+
x-stream-index: 001.001.001.001.003
15252+
custom:
15253+
additionalProperties: {}
15254+
type: object
15255+
x-stream-index: 001.001.001.001.007
15256+
hard_delete:
15257+
description: Whether Messages were hard deleted
15258+
title: Hard Delete
15259+
type: boolean
15260+
x-stream-index: "004"
15261+
received_at:
15262+
format: date-time
15263+
type: string
15264+
x-stream-index: 001.001.001.001.004
15265+
soft_delete:
15266+
description: Whether Messages were soft deleted
15267+
title: Soft Delete
15268+
type: boolean
15269+
x-stream-index: "003"
15270+
team:
15271+
description: The team of the channel where the target user's messages were
15272+
deleted
15273+
title: Team
15274+
type: string
15275+
x-stream-index: 001.001.003
15276+
type:
15277+
default: user.messages.deleted
15278+
description: 'The type of event: "user.messages.deleted" in this case'
15279+
title: Event Type
15280+
type: string
15281+
x-stream-index: 001.001.001.001.002
15282+
user:
15283+
$ref: '#/components/schemas/UserResponseCommonFields'
15284+
description: The target user whose messages got deleted
15285+
title: User
15286+
x-stream-index: "002.001"
15287+
required:
15288+
- type
15289+
- created_at
15290+
- custom
15291+
- user
15292+
- soft_delete
15293+
- hard_delete
15294+
title: UserMessagesDeletedEvent
15295+
type: object
15296+
x-stream-event-client-type: true
15297+
x-stream-event-doc-group: other
15298+
x-stream-is-event: true
15299+
x-stream-ws-base-event-name: VideoEvent
1521515300
UserMute:
1521615301
nullable: true
1521715302
properties:
@@ -16022,6 +16107,7 @@ components:
1602216107
user.deactivated: '#/components/schemas/UserDeactivatedEvent'
1602316108
user.deleted: '#/components/schemas/UserDeletedEvent'
1602416109
user.flagged: '#/components/schemas/UserFlaggedEvent'
16110+
user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent'
1602516111
user.muted: '#/components/schemas/UserMutedEvent'
1602616112
user.reactivated: '#/components/schemas/UserReactivatedEvent'
1602716113
user.unbanned: '#/components/schemas/UserUnbannedEvent'
@@ -16078,6 +16164,7 @@ components:
1607816164
- $ref: '#/components/schemas/UserDeactivatedEvent'
1607916165
- $ref: '#/components/schemas/UserDeletedEvent'
1608016166
- $ref: '#/components/schemas/UserFlaggedEvent'
16167+
- $ref: '#/components/schemas/UserMessagesDeletedEvent'
1608116168
- $ref: '#/components/schemas/UserMutedEvent'
1608216169
- $ref: '#/components/schemas/UserReactivatedEvent'
1608316170
- $ref: '#/components/schemas/UserUnbannedEvent'
@@ -16199,7 +16286,7 @@ components:
1619916286
type: apiKey
1620016287
info:
1620116288
title: Stream API
16202-
version: v187.13.0
16289+
version: v188.1.3
1620316290
openapi: 3.0.3
1620416291
paths:
1620516292
/app:
@@ -19898,6 +19985,7 @@ paths:
1989819985

1989919986
Sends events:
1990019987
- user.banned
19988+
- user.messages.deleted
1990119989
- user.banned
1990219990
operationId: Ban
1990319991
requestBody:

openapi/clientside-api.json

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

0 commit comments

Comments
 (0)