Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update video openapi Spec #495

Merged
merged 1 commit into from
Apr 3, 2024
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.

10 changes: 7 additions & 3 deletions openapi/chat-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4086,7 +4086,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 @@ -7625,7 +7625,10 @@ components:
properties:
duration:
type: string
x-stream-index: "002.001"
x-stream-index: "003.001"
membership_deletion_task_id:
type: string
x-stream-index: "002"
users:
additionalProperties:
$ref: '#/components/schemas/UserObject'
Expand All @@ -7637,6 +7640,7 @@ components:
key: user_id
required:
- users
- membership_deletion_task_id
- duration
type: object
UserBannedEvent:
Expand Down Expand Up @@ -8502,7 +8506,7 @@ components:
type: apiKey
info:
title: Stream API
version: v101.3.2
version: v102.0.0
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions openapi/chat-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9195,7 +9195,10 @@ components:
properties:
duration:
type: string
x-stream-index: "002.001"
x-stream-index: "003.001"
membership_deletion_task_id:
type: string
x-stream-index: "002"
users:
additionalProperties:
$ref: '#/components/schemas/UserObject'
Expand All @@ -9207,6 +9210,7 @@ components:
key: user_id
required:
- users
- membership_deletion_task_id
- duration
type: object
UpsertPushProviderRequest:
Expand Down Expand Up @@ -9828,7 +9832,7 @@ components:
type: apiKey
info:
title: Stream API
version: v101.3.2
version: v102.0.0
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/clientside-api.json

Large diffs are not rendered by default.

111 changes: 109 additions & 2 deletions openapi/clientside-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2083,6 +2083,27 @@ components:
- members
- own_capabilities
type: object
CallStatsReportSummaryResponse:
properties:
call_cid:
type: string
x-stream-index: "001"
call_session_id:
type: string
x-stream-index: "002"
call_status:
type: string
x-stream-index: "004"
first_stats_time:
format: date-time
type: string
x-stream-index: "003"
required:
- call_cid
- call_session_id
- first_stats_time
- call_status
type: object
CallTimeline:
properties:
events:
Expand Down Expand Up @@ -7790,6 +7811,54 @@ components:
- bans
- duration
type: object
QueryCallStatsRequest:
nullable: true
properties:
filter_conditions:
type: object
x-stream-index: "001"
limit:
format: int32
maximum: 25
minimum: 0
type: integer
x-stream-index: "004.001"
next:
type: string
x-stream-index: "004.002"
prev:
type: string
x-stream-index: "004.003"
sort:
items:
$ref: '#/components/schemas/SortParamRequest'
maximum: 2
type: array
x-stream-index: "002"
type: object
QueryCallStatsResponse:
nullable: true
properties:
duration:
description: Duration of the request in human-readable format
title: Duration
type: string
x-stream-index: "002.001"
next:
type: string
x-stream-index: "003.001"
prev:
type: string
x-stream-index: "003.002"
reports:
items:
$ref: '#/components/schemas/CallStatsReportSummaryResponse'
type: array
x-stream-index: "001"
required:
- reports
- duration
type: object
QueryCallsRequest:
nullable: true
properties:
Expand Down Expand Up @@ -10645,7 +10714,10 @@ components:
properties:
duration:
type: string
x-stream-index: "002.001"
x-stream-index: "003.001"
membership_deletion_task_id:
type: string
x-stream-index: "002"
users:
additionalProperties:
$ref: '#/components/schemas/UserObject'
Expand All @@ -10657,6 +10729,7 @@ components:
key: user_id
required:
- users
- membership_deletion_task_id
- duration
type: object
UpdatedCallPermissionsEvent:
Expand Down Expand Up @@ -11718,7 +11791,7 @@ components:
type: apiKey
info:
title: Stream API
version: v101.3.2
version: v102.0.0
openapi: 3.0.3
paths:
/api/v2/app:
Expand Down Expand Up @@ -16081,6 +16154,40 @@ paths:
$ref: '#/components/schemas/APIError'
description: Too many requests
summary: Query call members
/api/v2/video/call/stats:
post:
description: |2


Required permissions:
- ReadCallStats
operationId: QueryCallStats
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryCallStatsRequest'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/QueryCallStatsResponse'
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 Call Stats
/api/v2/video/calls:
post:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/serverside-api.json

Large diffs are not rendered by default.

111 changes: 109 additions & 2 deletions openapi/serverside-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1290,6 +1290,27 @@ components:
- members
- own_capabilities
type: object
CallStatsReportSummaryResponse:
properties:
call_cid:
type: string
x-stream-index: "001"
call_session_id:
type: string
x-stream-index: "002"
call_status:
type: string
x-stream-index: "004"
first_stats_time:
format: date-time
type: string
x-stream-index: "003"
required:
- call_cid
- call_session_id
- first_stats_time
- call_status
type: object
CallTimeline:
properties:
events:
Expand Down Expand Up @@ -7821,6 +7842,54 @@ components:
- bans
- duration
type: object
QueryCallStatsRequest:
nullable: true
properties:
filter_conditions:
type: object
x-stream-index: "001"
limit:
format: int32
maximum: 25
minimum: 0
type: integer
x-stream-index: "004.001"
next:
type: string
x-stream-index: "004.002"
prev:
type: string
x-stream-index: "004.003"
sort:
items:
$ref: '#/components/schemas/SortParamRequest'
maximum: 2
type: array
x-stream-index: "002"
type: object
QueryCallStatsResponse:
nullable: true
properties:
duration:
description: Duration of the request in human-readable format
title: Duration
type: string
x-stream-index: "002.001"
next:
type: string
x-stream-index: "003.001"
prev:
type: string
x-stream-index: "003.002"
reports:
items:
$ref: '#/components/schemas/CallStatsReportSummaryResponse'
type: array
x-stream-index: "001"
required:
- reports
- duration
type: object
QueryCallsRequest:
nullable: true
properties:
Expand Down Expand Up @@ -11166,7 +11235,10 @@ components:
properties:
duration:
type: string
x-stream-index: "002.001"
x-stream-index: "003.001"
membership_deletion_task_id:
type: string
x-stream-index: "002"
users:
additionalProperties:
$ref: '#/components/schemas/UserObject'
Expand All @@ -11178,6 +11250,7 @@ components:
key: user_id
required:
- users
- membership_deletion_task_id
- duration
type: object
UpsertPushProviderRequest:
Expand Down Expand Up @@ -11881,7 +11954,7 @@ components:
type: apiKey
info:
title: Stream API
version: v101.3.2
version: v102.0.0
openapi: 3.0.3
paths:
/api/v2/app:
Expand Down Expand Up @@ -17561,6 +17634,40 @@ paths:
$ref: '#/components/schemas/APIError'
description: Too many requests
summary: Query call members
/api/v2/video/call/stats:
post:
description: |2


Required permissions:
- ReadCallStats
operationId: QueryCallStats
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryCallStatsRequest'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/QueryCallStatsResponse'
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 Call Stats
/api/v2/video/calls:
post:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/video-openapi-clientside.json

Large diffs are not rendered by default.

Loading
Loading