Skip to content

Commit 83d187d

Browse files
committed
Update video openapi Spec
1 parent 86a754b commit 83d187d

36 files changed

+3188
-417
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: 143 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,12 @@ components:
502502
BanRequest:
503503
nullable: true
504504
properties:
505+
ban_from_future_channels:
506+
description: Whether to also ban the user from all future channels created
507+
by the banner
508+
title: Ban from future channels
509+
type: boolean
510+
x-stream-index: "012"
505511
banned_by:
506512
$ref: '#/components/schemas/UserRequest'
507513
description: User who issued a ban
@@ -1297,6 +1303,7 @@ components:
12971303
filter_tags:
12981304
items:
12991305
type: string
1306+
maximum: 10
13001307
type: array
13011308
x-stream-index: "026"
13021309
frozen:
@@ -2294,7 +2301,6 @@ components:
22942301
description: List of words to block
22952302
items:
22962303
type: string
2297-
minimum: 1
22982304
title: Words
22992305
type: array
23002306
x-stream-index: "004"
@@ -3433,6 +3439,32 @@ components:
34333439
- shadow_banned
34343440
- blocked_user_ids
34353441
type: object
3442+
FutureChannelBanResponse:
3443+
nullable: true
3444+
properties:
3445+
banned_by:
3446+
$ref: '#/components/schemas/UserResponse'
3447+
x-stream-index: "002"
3448+
created_at:
3449+
format: date-time
3450+
type: string
3451+
x-stream-index: "006"
3452+
expires:
3453+
format: date-time
3454+
type: string
3455+
x-stream-index: "003"
3456+
reason:
3457+
type: string
3458+
x-stream-index: "004"
3459+
shadow:
3460+
type: boolean
3461+
x-stream-index: "005"
3462+
user:
3463+
$ref: '#/components/schemas/UserResponse'
3464+
x-stream-index: "001"
3465+
required:
3466+
- created_at
3467+
type: object
34363468
GetApplicationResponse:
34373469
description: Basic response information
34383470
nullable: true
@@ -4711,7 +4743,7 @@ components:
47114743
type: array
47124744
x-stream-index: "001.002"
47134745
type:
4714-
default: message.new
4746+
default: notification.thread_message_new
47154747
type: string
47164748
x-stream-index: "004.001"
47174749
user:
@@ -7681,6 +7713,12 @@ components:
76817713
additionalProperties: {}
76827714
type: object
76837715
x-stream-index: "001"
7716+
filter_values:
7717+
additionalProperties: {}
7718+
description: Values to interpolate into the predefined filter template
7719+
title: Filter Values
7720+
type: object
7721+
x-stream-index: "011"
76847722
limit:
76857723
description: Number of channels to limit
76867724
format: int32
@@ -7708,6 +7746,12 @@ components:
77087746
title: Offset
77097747
type: integer
77107748
x-stream-index: "009"
7749+
predefined_filter:
7750+
description: ID of a predefined filter to use instead of filter_conditions
7751+
maxLength: 255
7752+
title: Predefined Filter
7753+
type: string
7754+
x-stream-index: "010"
77117755
presence:
77127756
title: Presence
77137757
type: boolean
@@ -7720,6 +7764,10 @@ components:
77207764
title: Sort
77217765
type: array
77227766
x-stream-index: "002"
7767+
sort_values:
7768+
additionalProperties: {}
7769+
type: object
7770+
x-stream-index: "012"
77237771
state:
77247772
description: Whether to update channel state or not
77257773
title: State
@@ -7809,6 +7857,53 @@ components:
78097857
- drafts
78107858
- duration
78117859
type: object
7860+
QueryFutureChannelBansPayload:
7861+
properties:
7862+
exclude_expired_bans:
7863+
description: Whether to exclude expired bans or not
7864+
title: Exclude expired bans
7865+
type: boolean
7866+
x-stream-index: "002"
7867+
limit:
7868+
description: Number of records to return
7869+
format: int32
7870+
maximum: 300
7871+
minimum: 0
7872+
title: Limit
7873+
type: integer
7874+
x-stream-index: "001.003"
7875+
offset:
7876+
description: Number of records to offset
7877+
format: int32
7878+
maximum: 10000
7879+
title: Offset
7880+
type: integer
7881+
x-stream-index: "001.004"
7882+
target_user_id:
7883+
description: Filter by the target user ID. For server-side requests only.
7884+
title: Target user ID
7885+
type: string
7886+
x-stream-index: "003"
7887+
type: object
7888+
QueryFutureChannelBansResponse:
7889+
nullable: true
7890+
properties:
7891+
bans:
7892+
description: List of found future channel bans
7893+
items:
7894+
$ref: '#/components/schemas/FutureChannelBanResponse'
7895+
title: FutureChannelBanResponse
7896+
type: array
7897+
x-stream-index: "001"
7898+
duration:
7899+
description: Duration of the request in milliseconds
7900+
title: Duration
7901+
type: string
7902+
x-stream-index: "002.001"
7903+
required:
7904+
- bans
7905+
- duration
7906+
type: object
78127907
QueryMembersPayload:
78137908
description: Client request
78147909
properties:
@@ -7828,7 +7923,6 @@ components:
78287923
members:
78297924
items:
78307925
$ref: '#/components/schemas/ChannelMemberRequest'
7831-
maximum: 100
78327926
type: array
78337927
x-stream-index: "003"
78347928
offset:
@@ -8899,8 +8993,6 @@ components:
88998993
type: boolean
89008994
x-stream-index: "010"
89018995
force_sql_v2_backend:
8902-
description: Force usage of SQL v2 search backend
8903-
title: Force SQL v2 Backend
89048996
type: boolean
89058997
x-stream-index: "011"
89068998
limit:
@@ -10266,7 +10358,6 @@ components:
1026610358
description: List of words to block
1026710359
items:
1026810360
type: string
10269-
minimum: 1
1027010361
title: Words
1027110362
type: array
1027210363
x-stream-index: "003"
@@ -10339,6 +10430,7 @@ components:
1033910430
description: List of filter tags to add to the channel
1034010431
items:
1034110432
type: string
10433+
maximum: 10
1034210434
title: Add filter tags
1034310435
type: array
1034410436
x-stream-index: "014"
@@ -10824,7 +10916,6 @@ components:
1082410916
users:
1082510917
items:
1082610918
$ref: '#/components/schemas/UpdateUserPartialRequest'
10827-
maximum: 100
1082810919
type: array
1082910920
x-stream-index: "001"
1083010921
required:
@@ -12142,7 +12233,7 @@ components:
1214212233
type: apiKey
1214312234
info:
1214412235
title: Stream API
12145-
version: v214.2.0
12236+
version: v215.1.0
1214612237
openapi: 3.0.3
1214712238
paths:
1214812239
/app:
@@ -12335,7 +12426,7 @@ paths:
1233512426
Body or URL parameter
1233612427
title: Connection ID
1233712428
type: string
12338-
x-stream-index: "011.003"
12429+
x-stream-index: "014.003"
1233912430
requestBody:
1234012431
content:
1234112432
application/json:
@@ -14732,6 +14823,12 @@ paths:
1473214823
type: string
1473314824
writeOnly: true
1473414825
x-stream-index: "005"
14826+
- in: query
14827+
name: remove_future_channels_ban
14828+
schema:
14829+
type: boolean
14830+
writeOnly: true
14831+
x-stream-index: "006"
1473514832
responses:
1473614833
"200":
1473714834
content:
@@ -15620,6 +15717,43 @@ paths:
1562015717
summary: Query Banned Users
1562115718
tags:
1562215719
- product:chat
15720+
/query_future_channel_bans:
15721+
get:
15722+
description: |
15723+
Find and filter future channel bans created by the authenticated user
15724+
operationId: QueryFutureChannelBans
15725+
parameters:
15726+
- content:
15727+
application/json:
15728+
schema:
15729+
$ref: '#/components/schemas/QueryFutureChannelBansPayload'
15730+
description: JSON object with query future channel bans payload
15731+
title: Payload
15732+
x-stream-index: "001"
15733+
in: query
15734+
name: payload
15735+
responses:
15736+
"200":
15737+
content:
15738+
application/json:
15739+
schema:
15740+
$ref: '#/components/schemas/QueryFutureChannelBansResponse'
15741+
description: Successful response
15742+
"400":
15743+
content:
15744+
application/json:
15745+
schema:
15746+
$ref: '#/components/schemas/APIError'
15747+
description: Bad request
15748+
"429":
15749+
content:
15750+
application/json:
15751+
schema:
15752+
$ref: '#/components/schemas/APIError'
15753+
description: Too many requests
15754+
summary: Query Future Channel Bans
15755+
tags:
15756+
- product:chat
1562315757
/reminders/query:
1562415758
post:
1562515759
description: |

openapi/chat-openapi.json

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

0 commit comments

Comments
 (0)