Skip to content

Commit

Permalink
Update video openapi Spec
Browse files Browse the repository at this point in the history
  • Loading branch information
stream-ci-zz committed Jun 4, 2024
1 parent 4554be8 commit 406979f
Show file tree
Hide file tree
Showing 14 changed files with 1,236 additions and 43 deletions.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docusaurus/video/docusaurus/docs/api/video-openapi.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.json

Large diffs are not rendered by default.

242 changes: 237 additions & 5 deletions openapi/chat-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,68 @@ components:
- blocklist
- behavior
type: object
BlockUsersRequest:
nullable: true
properties:
blocked_user_id:
description: User id to block
title: BlockedUserID
type: string
x-stream-index: "001"
required:
- blocked_user_id
type: object
BlockUsersResponse:
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserBlock'
type: array
x-stream-index: "002"
duration:
description: Duration of the request in human-readable format
title: Duration
type: string
x-stream-index: "001.001"
required:
- duration
- blocked_users
type: object
BlockedUserResponse:
nullable: true
properties:
blocked_user:
$ref: '#/components/schemas/UserResponse'
description: User who got blocked
title: User
x-stream-index: "003"
blocked_user_id:
description: ID of the user who got blocked
title: UserID
type: string
x-stream-index: "004"
created_at:
format: date-time
type: string
x-stream-index: "005"
user:
$ref: '#/components/schemas/UserResponse'
description: User who blocked another user
title: User
x-stream-index: "001"
user_id:
description: ID of the user who blocked another user
title: UserID
type: string
x-stream-index: "002"
required:
- user
- user_id
- blocked_user
- blocked_user_id
- created_at
type: object
Call:
properties:
agora:
Expand Down Expand Up @@ -1124,6 +1186,11 @@ components:
title: Auto translation language
type: string
x-stream-index: "022"
blocked:
description: Whether this channel is blocked by current user or not
title: Blocked
type: boolean
x-stream-index: "027"
cid:
description: Channel CID (<type>:<id>)
title: CID
Expand Down Expand Up @@ -1154,7 +1221,7 @@ components:
custom:
additionalProperties: {}
type: object
x-stream-index: "029"
x-stream-index: "030"
deleted_at:
description: Date/time of deletion
format: date-time
Expand Down Expand Up @@ -1232,10 +1299,10 @@ components:
format: date-time
title: Truncated At
type: string
x-stream-index: "027"
x-stream-index: "028"
truncated_by:
$ref: '#/components/schemas/UserObject'
x-stream-index: "028"
x-stream-index: "029"
type:
description: Type of the channel
title: Type
Expand Down Expand Up @@ -2358,6 +2425,23 @@ components:
- app
- duration
type: object
GetBlockedUsersResponse:
nullable: true
properties:
blocks:
description: Array of blocked user object
items:
$ref: '#/components/schemas/BlockedUserResponse'
title: Blocks
type: array
x-stream-index: "002"
duration:
type: string
x-stream-index: "001.001"
required:
- duration
- blocks
type: object
GetCallTokenRequest:
nullable: true
type: object
Expand Down Expand Up @@ -3507,7 +3591,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 @@ -4706,6 +4790,11 @@ components:
banned:
type: boolean
x-stream-index: "014"
blocked_user_ids:
items:
type: string
type: array
x-stream-index: "042"
channel_mutes:
items:
$ref: '#/components/schemas/ChannelMute'
Expand Down Expand Up @@ -7340,6 +7429,24 @@ components:
x-stream-event-client-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
UnblockUsersRequest:
nullable: true
properties:
blocked_user_id:
type: string
x-stream-index: "001"
required:
- blocked_user_id
type: object
UnblockUsersResponse:
nullable: true
properties:
duration:
type: string
x-stream-index: "001.001"
required:
- duration
type: object
UnmuteChannelRequest:
nullable: true
properties:
Expand Down Expand Up @@ -7912,6 +8019,39 @@ components:
x-stream-event-client-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
UserBlock:
nullable: true
properties:
AppPK:
format: int32
type: integer
writeOnly: true
x-stream-index: "003"
BlockedByUser:
$ref: '#/components/schemas/UserObject'
x-stream-index: "004"
BlockedByUserID:
type: string
writeOnly: true
x-stream-index: "005"
BlockedUser:
$ref: '#/components/schemas/UserObject'
x-stream-index: "006"
BlockedUserID:
type: string
writeOnly: true
x-stream-index: "007"
CreatedAt:
format: date-time
type: string
writeOnly: true
x-stream-index: "008"
required:
- AppPK
- BlockedByUserID
- BlockedUserID
- CreatedAt
type: object
UserDeactivatedEvent:
properties:
created_at:
Expand Down Expand Up @@ -8645,7 +8785,7 @@ components:
type: apiKey
info:
title: Stream API
version: v116.0.0
version: v116.0.3
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -12208,6 +12348,98 @@ paths:
summary: Upsert users
tags:
- product:chat
/users/block:
get:
description: |
Get list of blocked Users
operationId: GetBlockedUsers
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/GetBlockedUsersResponse'
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: Get list of blocked Users
tags:
- product:chat
post:
description: |
Block users
operationId: BlockUsers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BlockUsersRequest'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/BlockUsersResponse'
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: Block user
tags:
- product:chat
/users/unblock:
post:
description: |
Unblock users
operationId: UnblockUsers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnblockUsersRequest'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/UnblockUsersResponse'
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: Unblock user
tags:
- product:chat
security:
- JWT: []
api_key: []
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json

Large diffs are not rendered by default.

Loading

0 comments on commit 406979f

Please sign in to comment.