Skip to content
Merged
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.

182 changes: 177 additions & 5 deletions openapi/chat-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4152,6 +4152,72 @@ components:
- duration
title: GetUserGroupResponse
type: object
GroupedChannelsBucket:
properties:
channels:
description: Channels returned for this bucket
items:
$ref: '#/components/schemas/ChannelStateResponseFields'
title: Channels
type: array
x-stream-index: "001"
unread_channels:
description: Unread channels currently classified into this bucket
format: int32
title: Unread Channels
type: integer
x-stream-index: "002"
required:
- channels
title: Grouped Channels Bucket
type: object
GroupedQueryChannelsRequest:
nullable: true
properties:
limit:
description: Max channels per bucket (default 10)
format: int32
maximum: 10
title: Limit
type: integer
x-stream-index: "001"
presence:
description: Whether to subscribe to presence events for channel members
title: Presence
type: boolean
x-stream-index: "003"
watch:
description: Whether to start watching found channels or not
title: Watch
type: boolean
x-stream-index: "002"
title: Grouped Query Channels Request
type: object
x-stream-docs-page-id: grouped_query_channels
GroupedQueryChannelsResponse:
nullable: true
properties:
duration:
description: Duration of the request in milliseconds
title: Duration
type: string
x-stream-index: "002.001"
groups:
additionalProperties:
$ref: '#/components/schemas/GroupedChannelsBucket'
description: Predefined channel groups keyed by group name
title: Groups
type: object
x-stream-index: "001"
x-stream-map:
description: Channels and unread counts for one group
key: group_name
title: Grouped Channels Bucket
required:
- groups
- duration
title: Grouped Query Channels Response
type: object
HealthCheckEvent:
nullable: true
properties:
Expand Down Expand Up @@ -5304,6 +5370,12 @@ components:
additionalProperties: {}
type: object
x-stream-index: 001.001.001.001.001.007
grouped_unread_channels:
additionalProperties:
format: int32
type: integer
type: object
x-stream-index: "010"
message:
$ref: '#/components/schemas/MessageResponse'
description: The new message
Expand Down Expand Up @@ -6793,6 +6865,12 @@ components:
additionalProperties: {}
type: object
x-stream-index: 001.001.001.001.001.007
grouped_unread_channels:
additionalProperties:
format: int32
type: integer
type: object
x-stream-index: "005"
received_at:
format: date-time
type: string
Expand Down Expand Up @@ -6930,6 +7008,12 @@ components:
additionalProperties: {}
type: object
x-stream-index: 001.001.001.001.001.007
grouped_unread_channels:
additionalProperties:
format: int32
type: integer
type: object
x-stream-index: "006"
message:
$ref: '#/components/schemas/MessageResponse'
description: The message regarding the update
Expand Down Expand Up @@ -7300,6 +7384,12 @@ components:
additionalProperties: {}
type: object
x-stream-index: 001.001.001.001.007
grouped_unread_channels:
additionalProperties:
format: int32
type: integer
type: object
x-stream-index: "010"
last_read_message_id:
description: The ID of the last read message
title: Last Read Message ID
Expand Down Expand Up @@ -7353,13 +7443,13 @@ components:
format: int32
title: Unread Thread Messages
type: integer
x-stream-index: "011"
x-stream-index: "012"
unread_threads:
description: The number of unread threads
format: int32
title: Unread Threads
type: integer
x-stream-index: "010"
x-stream-index: "011"
user:
$ref: '#/components/schemas/UserResponseCommonFields'
description: The user who marked the channel as read
Expand Down Expand Up @@ -7432,6 +7522,12 @@ components:
title: First Unread Message ID
type: string
x-stream-index: "005"
grouped_unread_channels:
additionalProperties:
format: int32
type: integer
type: object
x-stream-index: "012"
last_read_at:
description: The time when the channel/thread was marked as unread
format: date-time
Expand Down Expand Up @@ -7492,13 +7588,13 @@ components:
format: int32
title: Unread Thread Messages
type: integer
x-stream-index: "013"
x-stream-index: "014"
unread_threads:
description: The number of unread threads
format: int32
title: Unread Threads
type: integer
x-stream-index: "012"
x-stream-index: "013"
user:
$ref: '#/components/schemas/UserResponseCommonFields'
description: The user who marked the channel as unread
Expand Down Expand Up @@ -7602,6 +7698,12 @@ components:
additionalProperties: {}
type: object
x-stream-index: 001.001.001.001.001.007
grouped_unread_channels:
additionalProperties:
format: int32
type: integer
type: object
x-stream-index: "010"
message:
$ref: '#/components/schemas/MessageResponse'
description: The new message
Expand Down Expand Up @@ -9136,6 +9238,18 @@ components:
- $in
- $nin
type: string
message_count:
operators:
- $eq
- $exists
- $gt
- $gte
- $in
- $lt
- $lte
- $ne
- $nin
type: number
muted:
operators:
- $eq
Expand Down Expand Up @@ -11262,6 +11376,18 @@ components:
- $in
- $nin
type: string
message_count:
operators:
- $eq
- $exists
- $gt
- $gte
- $in
- $lt
- $lte
- $ne
- $nin
type: number
muted:
operators:
- $eq
Expand Down Expand Up @@ -15572,7 +15698,7 @@ components:
type: apiKey
info:
title: Stream API
version: v226.17.1
version: v226.18.0
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -17036,6 +17162,46 @@ paths:
summary: Mark channel message delivery status
tags:
- product:chat
/channels/grouped:
post:
description: |
Query channels grouped into predefined buckets. Only available for enterprise apps.
operationId: GroupedQueryChannels
parameters:
- in: query
name: connection_id
schema:
type: string
x-stream-index: "007.003"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupedQueryChannelsRequest'
description: Grouped Query Channels Request
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/GroupedQueryChannelsResponse'
description: Grouped Query Channels 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: Grouped query channels
tags:
- product:chat
/channels/read:
post:
description: |
Expand Down Expand Up @@ -18145,6 +18311,12 @@ paths:
type: boolean
writeOnly: true
x-stream-index: "006"
- in: query
name: reason
schema:
type: string
writeOnly: true
x-stream-index: "007"
responses:
"200":
content:
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json

Large diffs are not rendered by default.

Loading
Loading