Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.json

Large diffs are not rendered by default.

152 changes: 143 additions & 9 deletions openapi/chat-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,12 @@ components:
BanRequest:
nullable: true
properties:
ban_from_future_channels:
description: Whether to also ban the user from all future channels created
by the banner
title: Ban from future channels
type: boolean
x-stream-index: "012"
banned_by:
$ref: '#/components/schemas/UserRequest'
description: User who issued a ban
Expand Down Expand Up @@ -1297,6 +1303,7 @@ components:
filter_tags:
items:
type: string
maximum: 10
type: array
x-stream-index: "026"
frozen:
Expand Down Expand Up @@ -2294,7 +2301,6 @@ components:
description: List of words to block
items:
type: string
minimum: 1
title: Words
type: array
x-stream-index: "004"
Expand Down Expand Up @@ -3433,6 +3439,32 @@ components:
- shadow_banned
- blocked_user_ids
type: object
FutureChannelBanResponse:
nullable: true
properties:
banned_by:
$ref: '#/components/schemas/UserResponse'
x-stream-index: "002"
created_at:
format: date-time
type: string
x-stream-index: "006"
expires:
format: date-time
type: string
x-stream-index: "003"
reason:
type: string
x-stream-index: "004"
shadow:
type: boolean
x-stream-index: "005"
user:
$ref: '#/components/schemas/UserResponse'
x-stream-index: "001"
required:
- created_at
type: object
GetApplicationResponse:
description: Basic response information
nullable: true
Expand Down Expand Up @@ -4711,7 +4743,7 @@ components:
type: array
x-stream-index: "001.002"
type:
default: message.new
default: notification.thread_message_new
type: string
x-stream-index: "004.001"
user:
Expand Down Expand Up @@ -7681,6 +7713,12 @@ components:
additionalProperties: {}
type: object
x-stream-index: "001"
filter_values:
additionalProperties: {}
description: Values to interpolate into the predefined filter template
title: Filter Values
type: object
x-stream-index: "011"
limit:
description: Number of channels to limit
format: int32
Expand Down Expand Up @@ -7708,6 +7746,12 @@ components:
title: Offset
type: integer
x-stream-index: "009"
predefined_filter:
description: ID of a predefined filter to use instead of filter_conditions
maxLength: 255
title: Predefined Filter
type: string
x-stream-index: "010"
presence:
title: Presence
type: boolean
Expand All @@ -7720,6 +7764,10 @@ components:
title: Sort
type: array
x-stream-index: "002"
sort_values:
additionalProperties: {}
type: object
x-stream-index: "012"
state:
description: Whether to update channel state or not
title: State
Expand Down Expand Up @@ -7809,6 +7857,53 @@ components:
- drafts
- duration
type: object
QueryFutureChannelBansPayload:
properties:
exclude_expired_bans:
description: Whether to exclude expired bans or not
title: Exclude expired bans
type: boolean
x-stream-index: "002"
limit:
description: Number of records to return
format: int32
maximum: 300
minimum: 0
title: Limit
type: integer
x-stream-index: "001.003"
offset:
description: Number of records to offset
format: int32
maximum: 10000
title: Offset
type: integer
x-stream-index: "001.004"
target_user_id:
description: Filter by the target user ID. For server-side requests only.
title: Target user ID
type: string
x-stream-index: "003"
type: object
QueryFutureChannelBansResponse:
nullable: true
properties:
bans:
description: List of found future channel bans
items:
$ref: '#/components/schemas/FutureChannelBanResponse'
title: FutureChannelBanResponse
type: array
x-stream-index: "001"
duration:
description: Duration of the request in milliseconds
title: Duration
type: string
x-stream-index: "002.001"
required:
- bans
- duration
type: object
QueryMembersPayload:
description: Client request
properties:
Expand All @@ -7828,7 +7923,6 @@ components:
members:
items:
$ref: '#/components/schemas/ChannelMemberRequest'
maximum: 100
type: array
x-stream-index: "003"
offset:
Expand Down Expand Up @@ -8899,8 +8993,6 @@ components:
type: boolean
x-stream-index: "010"
force_sql_v2_backend:
description: Force usage of SQL v2 search backend
title: Force SQL v2 Backend
type: boolean
x-stream-index: "011"
limit:
Expand Down Expand Up @@ -10266,7 +10358,6 @@ components:
description: List of words to block
items:
type: string
minimum: 1
title: Words
type: array
x-stream-index: "003"
Expand Down Expand Up @@ -10339,6 +10430,7 @@ components:
description: List of filter tags to add to the channel
items:
type: string
maximum: 10
title: Add filter tags
type: array
x-stream-index: "014"
Expand Down Expand Up @@ -10824,7 +10916,6 @@ components:
users:
items:
$ref: '#/components/schemas/UpdateUserPartialRequest'
maximum: 100
type: array
x-stream-index: "001"
required:
Expand Down Expand Up @@ -12142,7 +12233,7 @@ components:
type: apiKey
info:
title: Stream API
version: v214.2.0
version: v214.12.0
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -12335,7 +12426,7 @@ paths:
Body or URL parameter
title: Connection ID
type: string
x-stream-index: "011.003"
x-stream-index: "014.003"
requestBody:
content:
application/json:
Expand Down Expand Up @@ -14732,6 +14823,12 @@ paths:
type: string
writeOnly: true
x-stream-index: "005"
- in: query
name: remove_future_channels_ban
schema:
type: boolean
writeOnly: true
x-stream-index: "006"
responses:
"200":
content:
Expand Down Expand Up @@ -15620,6 +15717,43 @@ paths:
summary: Query Banned Users
tags:
- product:chat
/query_future_channel_bans:
get:
description: |
Find and filter future channel bans created by the authenticated user
operationId: QueryFutureChannelBans
parameters:
- content:
application/json:
schema:
$ref: '#/components/schemas/QueryFutureChannelBansPayload'
description: JSON object with query future channel bans payload
title: Payload
x-stream-index: "001"
in: query
name: payload
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/QueryFutureChannelBansResponse'
description: Successful response
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: Bad request
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: Too many requests
summary: Query Future Channel Bans
tags:
- product:chat
/reminders/query:
post:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json

Large diffs are not rendered by default.

Loading