Skip to content

Commit

Permalink
Update video openapi Spec (#950)
Browse files Browse the repository at this point in the history
  • Loading branch information
tbarbugli authored Feb 5, 2025
2 parents 24639e5 + 79fdbbf commit c8266a8
Show file tree
Hide file tree
Showing 14 changed files with 1,321 additions and 52 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.

2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10026,7 +10026,7 @@ components:
type: apiKey
info:
title: Stream API
version: v151.0.1
version: v153.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.

41 changes: 33 additions & 8 deletions openapi/chat-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -849,31 +849,34 @@ components:
x-stream-index: "002"
broadcasting:
$ref: '#/components/schemas/BroadcastSettings'
x-stream-index: "007"
frame_recording:
$ref: '#/components/schemas/FrameRecordSettings'
x-stream-index: "006"
geofencing:
$ref: '#/components/schemas/GeofenceSettings'
x-stream-index: "007"
x-stream-index: "008"
limits:
$ref: '#/components/schemas/LimitsSettings'
x-stream-index: "011"
x-stream-index: "012"
recording:
$ref: '#/components/schemas/RecordSettings'
x-stream-index: "005"
ring:
$ref: '#/components/schemas/RingSettings'
x-stream-index: "009"
x-stream-index: "010"
screensharing:
$ref: '#/components/schemas/ScreensharingSettings'
x-stream-index: "004"
session:
$ref: '#/components/schemas/SessionSettings'
x-stream-index: "012"
x-stream-index: "013"
thumbnails:
$ref: '#/components/schemas/ThumbnailsSettings'
x-stream-index: "010"
x-stream-index: "011"
transcription:
$ref: '#/components/schemas/TranscriptionSettings'
x-stream-index: "008"
x-stream-index: "009"
video:
$ref: '#/components/schemas/VideoSettings'
x-stream-index: "003"
Expand Down Expand Up @@ -4647,6 +4650,28 @@ components:
x-stream-event-doc-group: other
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
FrameRecordSettings:
properties:
capture_interval_in_seconds:
format: int32
maximum: 60
minimum: 2
type: integer
x-stream-index: "003"
mode:
enum:
- available
- disabled
- auto-on
type: string
x-stream-index: "001"
quality:
type: string
x-stream-index: "002"
required:
- mode
- capture_interval_in_seconds
type: object
FullUserResponse:
properties:
banned:
Expand Down Expand Up @@ -6749,7 +6774,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 @@ -14122,7 +14147,7 @@ components:
type: apiKey
info:
title: Stream API
version: v151.0.1
version: v153.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.

208 changes: 201 additions & 7 deletions openapi/clientside-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4654,7 +4654,6 @@ components:
type: string
x-stream-index: "004"
required:
- user_session_id
- sdk
- sdk_version
- rating
Expand Down Expand Up @@ -9991,10 +9990,12 @@ components:
- send-video
- start-broadcast-call
- start-closed-captions-call
- start-frame-record-call
- start-record-call
- start-transcription-call
- stop-broadcast-call
- stop-closed-captions-call
- stop-frame-record-call
- stop-record-call
- stop-transcription-call
- update-call
Expand Down Expand Up @@ -12587,10 +12588,6 @@ components:
lower_bound:
$ref: '#/components/schemas/Bound'
x-stream-index: "002"
mean:
format: float
type: number
x-stream-index: "006"
sum:
format: float
type: number
Expand All @@ -12602,7 +12599,6 @@ components:
- category
- sum
- count
- mean
type: object
RequestPermissionRequest:
nullable: true
Expand Down Expand Up @@ -12850,6 +12846,11 @@ components:
status:
type: string
x-stream-index: "007"
teams:
items:
type: string
type: array
x-stream-index: "024"
updated_at:
format: date-time
type: number
Expand Down Expand Up @@ -13492,6 +13493,28 @@ components:
required:
- duration
type: object
StartFrameRecordingRequest:
nullable: true
properties:
recording_external_storage:
type: string
x-stream-index: "002"
title: StartFrameRecordingRequest
type: object
StartFrameRecordingResponse:
description: StartFrameRecordingResponse is the response payload for the start
frame recording endpoint.
nullable: true
properties:
duration:
description: Duration of the request in milliseconds
title: Duration
type: string
x-stream-index: "001.001"
required:
- duration
title: StartFrameRecordingResponse
type: object
StartHLSBroadcastingRequest:
description: StartHLSBroadcastingRequest is the payload for starting an HLS
broadcasting.
Expand Down Expand Up @@ -13646,6 +13669,22 @@ components:
- duration
title: Response
type: object
StopFrameRecordingRequest:
nullable: true
type: object
StopFrameRecordingResponse:
description: Basic response information
nullable: true
properties:
duration:
description: Duration of the request in milliseconds
title: Duration
type: string
x-stream-index: "001.001"
required:
- duration
title: Response
type: object
StopHLSBroadcastingRequest:
nullable: true
type: object
Expand Down Expand Up @@ -17202,7 +17241,7 @@ components:
type: apiKey
info:
title: Stream API
version: v151.0.1
version: v153.0.0
openapi: 3.0.3
paths:
/api/v2/app:
Expand Down Expand Up @@ -21493,6 +21532,56 @@ paths:
summary: Send custom event
tags:
- product:video
/api/v2/video/call/{type}/{id}/feedback:
post:
description: |2+

operationId: CollectUserFeedback
parameters:
- in: path
name: type
required: true
schema:
maxLength: 64
type: string
writeOnly: true
x-stream-index: "001.001"
- in: path
name: id
required: true
schema:
maxLength: 64
type: string
writeOnly: true
x-stream-index: "001.002"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CollectUserFeedbackRequest'
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/CollectUserFeedbackResponse'
description: 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: Collect user feedback
tags:
- product:video
/api/v2/video/call/{type}/{id}/feedback/{session}:
post:
description: |2+
Expand Down Expand Up @@ -22368,6 +22457,64 @@ paths:
summary: Start closed captions
tags:
- product:video
/api/v2/video/call/{type}/{id}/start_frame_recording:
post:
description: |
Starts frame by frame recording

Sends events:
- call.frame_recording_started
operationId: StartFrameRecording
parameters:
- in: path
name: type
required: true
schema:
description: The type of call
maxLength: 64
title: Type
type: string
writeOnly: true
x-stream-index: "001.001"
- in: path
name: id
required: true
schema:
description: Call ID
maxLength: 64
title: ID
type: string
writeOnly: true
x-stream-index: "001.002"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartFrameRecordingRequest'
description: StartFrameRecordingRequest
required: true
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/StartFrameRecordingResponse'
description: StartFrameRecordingResponse
"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: Start frame recording
tags:
- product:video
/api/v2/video/call/{type}/{id}/start_recording:
post:
description: |
Expand Down Expand Up @@ -22629,6 +22776,53 @@ paths:
summary: Stop closed captions
tags:
- product:video
/api/v2/video/call/{type}/{id}/stop_frame_recording:
post:
description: |
Stops frame recording

Sends events:
- call.frame_recording_stopped
operationId: StopFrameRecording
parameters:
- in: path
name: type
required: true
schema:
maxLength: 64
type: string
writeOnly: true
x-stream-index: "001.001"
- in: path
name: id
required: true
schema:
maxLength: 64
type: string
writeOnly: true
x-stream-index: "001.002"
responses:
"201":
content:
application/json:
schema:
$ref: '#/components/schemas/StopFrameRecordingResponse'
description: 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: Stop frame recording
tags:
- product:video
/api/v2/video/call/{type}/{id}/stop_live:
post:
description: |2
Expand Down
2 changes: 1 addition & 1 deletion openapi/serverside-api.json

Large diffs are not rendered by default.

Loading

0 comments on commit c8266a8

Please sign in to comment.