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.

138 changes: 137 additions & 1 deletion openapi/chat-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11227,6 +11227,45 @@ components:
- duration
title: Response
type: object
Role:
properties:
created_at:
description: Date/time of creation
format: date-time
title: Created at
type: string
x-stream-index: "004"
custom:
description: Whether this is a custom role or built-in
title: Custom
type: boolean
x-stream-index: "002"
name:
description: Unique role name
title: Name
type: string
x-stream-index: "001"
scopes:
description: List of scopes where this role is currently present. `.app`
means that role is present in app-level grants
items:
type: string
title: Scopes
type: array
x-stream-index: "003"
updated_at:
description: Date/time of the last update
format: date-time
title: Updated at
type: string
x-stream-index: "005"
required:
- name
- custom
- scopes
- created_at
- updated_at
type: object
SearchPayload:
properties:
filter_conditions:
Expand Down Expand Up @@ -11907,6 +11946,23 @@ components:
- pinned
- restricted_visibility
type: object
SearchRolesResponse:
nullable: true
properties:
duration:
type: string
x-stream-index: "001.001"
roles:
description: Matching roles, sorted ascending by name
items:
$ref: '#/components/schemas/Role'
title: Roles
type: array
x-stream-index: "002"
required:
- duration
- roles
type: object
SearchUserGroupsResponse:
description: Response for searching user groups
nullable: true
Expand Down Expand Up @@ -15714,7 +15770,7 @@ components:
type: apiKey
info:
title: Stream API
version: v228.12.0
version: v228.13.0
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -19285,6 +19341,86 @@ paths:
summary: Query reminders
tags:
- product:chat
/roles/search:
get:
description: |
Searches mentionable roles (user-assignable + channel-assignable, built-in and custom) by name prefix for autocomplete
operationId: SearchRoles
parameters:
- in: query
name: query
required: true
schema:
description: Case-insensitive name prefix to match against role names
maxLength: 255
minLength: 1
title: Query
type: string
writeOnly: true
x-stream-index: "001"
- in: query
name: limit
schema:
description: Maximum number of roles to return (1-25, default 10)
format: int32
maximum: 25
minimum: 1
title: Limit
type: integer
writeOnly: true
x-stream-index: "002"
- in: query
name: name_gt
schema:
description: Return roles with names strictly greater than this cursor (for
pagination)
title: Name cursor
type: string
writeOnly: true
x-stream-index: "003"
- in: query
name: role_type
schema:
description: 'Optional filter: ''user'' for user-assignable roles, ''channel''
for channel-assignable roles. Omit to return both.'
enum:
- user
- channel
title: Role type
type: string
writeOnly: true
x-stream-index: "004"
- in: query
name: include_global_roles
schema:
description: When true, include cross-team operator roles whose name starts
with 'global_'. Defaults to false.
title: Include global roles
type: boolean
writeOnly: true
x-stream-index: "005"
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SearchRolesResponse'
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: Search roles
tags:
- product:chat
/search:
get:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json

Large diffs are not rendered by default.

101 changes: 99 additions & 2 deletions openapi/chat-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ components:
type: string
x-stream-index: "002.001"
type:
default: export.moderation_logs.error
default: export.users.error
type: string
x-stream-index: "003.002"
required:
Expand Down Expand Up @@ -16053,6 +16053,23 @@ components:
- pinned
- restricted_visibility
type: object
SearchRolesResponse:
nullable: true
properties:
duration:
type: string
x-stream-index: "001.001"
roles:
description: Matching roles, sorted ascending by name
items:
$ref: '#/components/schemas/Role'
title: Roles
type: array
x-stream-index: "002"
required:
- duration
- roles
type: object
SearchUserGroupsResponse:
description: Response for searching user groups
nullable: true
Expand Down Expand Up @@ -21180,7 +21197,7 @@ components:
type: apiKey
info:
title: Stream API
version: v228.12.0
version: v228.13.0
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -26799,6 +26816,86 @@ paths:
summary: Delete role
tags:
- product:chat
/roles/search:
get:
description: |
Searches mentionable roles (user-assignable + channel-assignable, built-in and custom) by name prefix for autocomplete
operationId: SearchRoles
parameters:
- in: query
name: query
required: true
schema:
description: Case-insensitive name prefix to match against role names
maxLength: 255
minLength: 1
title: Query
type: string
writeOnly: true
x-stream-index: "001"
- in: query
name: limit
schema:
description: Maximum number of roles to return (1-25, default 10)
format: int32
maximum: 25
minimum: 1
title: Limit
type: integer
writeOnly: true
x-stream-index: "002"
- in: query
name: name_gt
schema:
description: Return roles with names strictly greater than this cursor (for
pagination)
title: Name cursor
type: string
writeOnly: true
x-stream-index: "003"
- in: query
name: role_type
schema:
description: 'Optional filter: ''user'' for user-assignable roles, ''channel''
for channel-assignable roles. Omit to return both.'
enum:
- user
- channel
title: Role type
type: string
writeOnly: true
x-stream-index: "004"
- in: query
name: include_global_roles
schema:
description: When true, include cross-team operator roles whose name starts
with 'global_'. Defaults to false.
title: Include global roles
type: boolean
writeOnly: true
x-stream-index: "005"
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SearchRolesResponse'
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: Search roles
tags:
- product:chat
/search:
get:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/clientside-api.json

Large diffs are not rendered by default.

Loading
Loading