Skip to content

Commit c8266a8

Browse files
tbarbuglitbarbugli
authored
Update video openapi Spec (#950)
2 parents 24639e5 + 79fdbbf commit c8266a8

14 files changed

+1321
-52
lines changed

‎docusaurus/video/docusaurus/docs/api/video-client-openapi.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docusaurus/video/docusaurus/docs/api/video-openapi.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎openapi/chat-openapi-clientside.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎openapi/chat-openapi-clientside.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10026,7 +10026,7 @@ components:
1002610026
type: apiKey
1002710027
info:
1002810028
title: Stream API
10029-
version: v151.0.1
10029+
version: v153.0.0
1003010030
openapi: 3.0.3
1003110031
paths:
1003210032
/app:

‎openapi/chat-openapi.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎openapi/chat-openapi.yaml‎

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -849,31 +849,34 @@ components:
849849
x-stream-index: "002"
850850
broadcasting:
851851
$ref: '#/components/schemas/BroadcastSettings'
852+
x-stream-index: "007"
853+
frame_recording:
854+
$ref: '#/components/schemas/FrameRecordSettings'
852855
x-stream-index: "006"
853856
geofencing:
854857
$ref: '#/components/schemas/GeofenceSettings'
855-
x-stream-index: "007"
858+
x-stream-index: "008"
856859
limits:
857860
$ref: '#/components/schemas/LimitsSettings'
858-
x-stream-index: "011"
861+
x-stream-index: "012"
859862
recording:
860863
$ref: '#/components/schemas/RecordSettings'
861864
x-stream-index: "005"
862865
ring:
863866
$ref: '#/components/schemas/RingSettings'
864-
x-stream-index: "009"
867+
x-stream-index: "010"
865868
screensharing:
866869
$ref: '#/components/schemas/ScreensharingSettings'
867870
x-stream-index: "004"
868871
session:
869872
$ref: '#/components/schemas/SessionSettings'
870-
x-stream-index: "012"
873+
x-stream-index: "013"
871874
thumbnails:
872875
$ref: '#/components/schemas/ThumbnailsSettings'
873-
x-stream-index: "010"
876+
x-stream-index: "011"
874877
transcription:
875878
$ref: '#/components/schemas/TranscriptionSettings'
876-
x-stream-index: "008"
879+
x-stream-index: "009"
877880
video:
878881
$ref: '#/components/schemas/VideoSettings'
879882
x-stream-index: "003"
@@ -4647,6 +4650,28 @@ components:
46474650
x-stream-event-doc-group: other
46484651
x-stream-is-event: true
46494652
x-stream-ws-base-event-name: VideoEvent
4653+
FrameRecordSettings:
4654+
properties:
4655+
capture_interval_in_seconds:
4656+
format: int32
4657+
maximum: 60
4658+
minimum: 2
4659+
type: integer
4660+
x-stream-index: "003"
4661+
mode:
4662+
enum:
4663+
- available
4664+
- disabled
4665+
- auto-on
4666+
type: string
4667+
x-stream-index: "001"
4668+
quality:
4669+
type: string
4670+
x-stream-index: "002"
4671+
required:
4672+
- mode
4673+
- capture_interval_in_seconds
4674+
type: object
46504675
FullUserResponse:
46514676
properties:
46524677
banned:
@@ -6749,7 +6774,7 @@ components:
67496774
type: array
67506775
x-stream-index: "001.002"
67516776
type:
6752-
default: message.new
6777+
default: notification.thread_message_new
67536778
type: string
67546779
x-stream-index: "004.001"
67556780
user:
@@ -14122,7 +14147,7 @@ components:
1412214147
type: apiKey
1412314148
info:
1412414149
title: Stream API
14125-
version: v151.0.1
14150+
version: v153.0.0
1412614151
openapi: 3.0.3
1412714152
paths:
1412814153
/app:

‎openapi/clientside-api.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎openapi/clientside-api.yaml‎

Lines changed: 201 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4654,7 +4654,6 @@ components:
46544654
type: string
46554655
x-stream-index: "004"
46564656
required:
4657-
- user_session_id
46584657
- sdk
46594658
- sdk_version
46604659
- rating
@@ -9991,10 +9990,12 @@ components:
99919990
- send-video
99929991
- start-broadcast-call
99939992
- start-closed-captions-call
9993+
- start-frame-record-call
99949994
- start-record-call
99959995
- start-transcription-call
99969996
- stop-broadcast-call
99979997
- stop-closed-captions-call
9998+
- stop-frame-record-call
99989999
- stop-record-call
999910000
- stop-transcription-call
1000010001
- update-call
@@ -12587,10 +12588,6 @@ components:
1258712588
lower_bound:
1258812589
$ref: '#/components/schemas/Bound'
1258912590
x-stream-index: "002"
12590-
mean:
12591-
format: float
12592-
type: number
12593-
x-stream-index: "006"
1259412591
sum:
1259512592
format: float
1259612593
type: number
@@ -12602,7 +12599,6 @@ components:
1260212599
- category
1260312600
- sum
1260412601
- count
12605-
- mean
1260612602
type: object
1260712603
RequestPermissionRequest:
1260812604
nullable: true
@@ -12850,6 +12846,11 @@ components:
1285012846
status:
1285112847
type: string
1285212848
x-stream-index: "007"
12849+
teams:
12850+
items:
12851+
type: string
12852+
type: array
12853+
x-stream-index: "024"
1285312854
updated_at:
1285412855
format: date-time
1285512856
type: number
@@ -13492,6 +13493,28 @@ components:
1349213493
required:
1349313494
- duration
1349413495
type: object
13496+
StartFrameRecordingRequest:
13497+
nullable: true
13498+
properties:
13499+
recording_external_storage:
13500+
type: string
13501+
x-stream-index: "002"
13502+
title: StartFrameRecordingRequest
13503+
type: object
13504+
StartFrameRecordingResponse:
13505+
description: StartFrameRecordingResponse is the response payload for the start
13506+
frame recording endpoint.
13507+
nullable: true
13508+
properties:
13509+
duration:
13510+
description: Duration of the request in milliseconds
13511+
title: Duration
13512+
type: string
13513+
x-stream-index: "001.001"
13514+
required:
13515+
- duration
13516+
title: StartFrameRecordingResponse
13517+
type: object
1349513518
StartHLSBroadcastingRequest:
1349613519
description: StartHLSBroadcastingRequest is the payload for starting an HLS
1349713520
broadcasting.
@@ -13646,6 +13669,22 @@ components:
1364613669
- duration
1364713670
title: Response
1364813671
type: object
13672+
StopFrameRecordingRequest:
13673+
nullable: true
13674+
type: object
13675+
StopFrameRecordingResponse:
13676+
description: Basic response information
13677+
nullable: true
13678+
properties:
13679+
duration:
13680+
description: Duration of the request in milliseconds
13681+
title: Duration
13682+
type: string
13683+
x-stream-index: "001.001"
13684+
required:
13685+
- duration
13686+
title: Response
13687+
type: object
1364913688
StopHLSBroadcastingRequest:
1365013689
nullable: true
1365113690
type: object
@@ -17202,7 +17241,7 @@ components:
1720217241
type: apiKey
1720317242
info:
1720417243
title: Stream API
17205-
version: v151.0.1
17244+
version: v153.0.0
1720617245
openapi: 3.0.3
1720717246
paths:
1720817247
/api/v2/app:
@@ -21493,6 +21532,56 @@ paths:
2149321532
summary: Send custom event
2149421533
tags:
2149521534
- product:video
21535+
/api/v2/video/call/{type}/{id}/feedback:
21536+
post:
21537+
description: |2+
21538+
21539+
operationId: CollectUserFeedback
21540+
parameters:
21541+
- in: path
21542+
name: type
21543+
required: true
21544+
schema:
21545+
maxLength: 64
21546+
type: string
21547+
writeOnly: true
21548+
x-stream-index: "001.001"
21549+
- in: path
21550+
name: id
21551+
required: true
21552+
schema:
21553+
maxLength: 64
21554+
type: string
21555+
writeOnly: true
21556+
x-stream-index: "001.002"
21557+
requestBody:
21558+
content:
21559+
application/json:
21560+
schema:
21561+
$ref: '#/components/schemas/CollectUserFeedbackRequest'
21562+
required: true
21563+
responses:
21564+
"201":
21565+
content:
21566+
application/json:
21567+
schema:
21568+
$ref: '#/components/schemas/CollectUserFeedbackResponse'
21569+
description: Response
21570+
"400":
21571+
content:
21572+
application/json:
21573+
schema:
21574+
$ref: '#/components/schemas/APIError'
21575+
description: Bad request
21576+
"429":
21577+
content:
21578+
application/json:
21579+
schema:
21580+
$ref: '#/components/schemas/APIError'
21581+
description: Too many requests
21582+
summary: Collect user feedback
21583+
tags:
21584+
- product:video
2149621585
/api/v2/video/call/{type}/{id}/feedback/{session}:
2149721586
post:
2149821587
description: |2+
@@ -22368,6 +22457,64 @@ paths:
2236822457
summary: Start closed captions
2236922458
tags:
2237022459
- product:video
22460+
/api/v2/video/call/{type}/{id}/start_frame_recording:
22461+
post:
22462+
description: |
22463+
Starts frame by frame recording
22464+
22465+
Sends events:
22466+
- call.frame_recording_started
22467+
operationId: StartFrameRecording
22468+
parameters:
22469+
- in: path
22470+
name: type
22471+
required: true
22472+
schema:
22473+
description: The type of call
22474+
maxLength: 64
22475+
title: Type
22476+
type: string
22477+
writeOnly: true
22478+
x-stream-index: "001.001"
22479+
- in: path
22480+
name: id
22481+
required: true
22482+
schema:
22483+
description: Call ID
22484+
maxLength: 64
22485+
title: ID
22486+
type: string
22487+
writeOnly: true
22488+
x-stream-index: "001.002"
22489+
requestBody:
22490+
content:
22491+
application/json:
22492+
schema:
22493+
$ref: '#/components/schemas/StartFrameRecordingRequest'
22494+
description: StartFrameRecordingRequest
22495+
required: true
22496+
responses:
22497+
"201":
22498+
content:
22499+
application/json:
22500+
schema:
22501+
$ref: '#/components/schemas/StartFrameRecordingResponse'
22502+
description: StartFrameRecordingResponse
22503+
"400":
22504+
content:
22505+
application/json:
22506+
schema:
22507+
$ref: '#/components/schemas/APIError'
22508+
description: Bad request
22509+
"429":
22510+
content:
22511+
application/json:
22512+
schema:
22513+
$ref: '#/components/schemas/APIError'
22514+
description: Too many requests
22515+
summary: Start frame recording
22516+
tags:
22517+
- product:video
2237122518
/api/v2/video/call/{type}/{id}/start_recording:
2237222519
post:
2237322520
description: |
@@ -22629,6 +22776,53 @@ paths:
2262922776
summary: Stop closed captions
2263022777
tags:
2263122778
- product:video
22779+
/api/v2/video/call/{type}/{id}/stop_frame_recording:
22780+
post:
22781+
description: |
22782+
Stops frame recording
22783+
22784+
Sends events:
22785+
- call.frame_recording_stopped
22786+
operationId: StopFrameRecording
22787+
parameters:
22788+
- in: path
22789+
name: type
22790+
required: true
22791+
schema:
22792+
maxLength: 64
22793+
type: string
22794+
writeOnly: true
22795+
x-stream-index: "001.001"
22796+
- in: path
22797+
name: id
22798+
required: true
22799+
schema:
22800+
maxLength: 64
22801+
type: string
22802+
writeOnly: true
22803+
x-stream-index: "001.002"
22804+
responses:
22805+
"201":
22806+
content:
22807+
application/json:
22808+
schema:
22809+
$ref: '#/components/schemas/StopFrameRecordingResponse'
22810+
description: Response
22811+
"400":
22812+
content:
22813+
application/json:
22814+
schema:
22815+
$ref: '#/components/schemas/APIError'
22816+
description: Bad request
22817+
"429":
22818+
content:
22819+
application/json:
22820+
schema:
22821+
$ref: '#/components/schemas/APIError'
22822+
description: Too many requests
22823+
summary: Stop frame recording
22824+
tags:
22825+
- product:video
2263222826
/api/v2/video/call/{type}/{id}/stop_live:
2263322827
post:
2263422828
description: |2

‎openapi/serverside-api.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)