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.

Sign up for GitHub

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 #960

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update video openapi Spec #960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 docusaurus/video/docusaurus/docs/api/video-client-openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docusaurus/video/docusaurus/docs/api/video-openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10069,7 +10069,7 @@ components:
type: apiKey
info:
title: Stream API
version: v154.1.0
version: v155.2.0
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions openapi/chat-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6785,7 +6785,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 @@ -14193,7 +14193,7 @@ components:
type: apiKey
info:
title: Stream API
version: v154.1.0
version: v155.2.0
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/clientside-api.json
View file
Open in desktop

Large diffs are not rendered by default.

196 changes: 194 additions & 2 deletions openapi/clientside-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1562,6 +1562,173 @@ components:
- internal
- kind
type: object
CallFrameRecordingFailedEvent:
description: This event is sent when frame recording has failed
properties:
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "003"
call_cid:
type: string
x-stream-index: "002.001"
created_at:
format: date-time
type: number
x-stream-index: "001.002"
egress_id:
type: string
x-stream-index: "004"
type:
default: call.frame_recording_failed
description: 'The type of event: "call.frame_recording_failed" in this case'
title: Event Type
type: string
x-stream-index: "001.001"
required:
- type
- created_at
- call_cid
- call
- egress_id
title: CallFrameRecordingFailedEvent
type: object
x-stream-event-call-type: true
x-stream-event-doc-group: recording
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallFrameRecordingFrameReadyEvent:
description: This event is sent when a frame is captured from a call
properties:
call_cid:
type: string
x-stream-index: "002.001"
captured_at:
description: The time the frame was captured
format: date-time
title: CapturedAt
type: number
x-stream-index: "006"
created_at:
format: date-time
type: number
x-stream-index: "001.002"
egress_id:
type: string
x-stream-index: "008"
session_id:
description: Call session ID
title: Session ID
type: string
x-stream-index: "003.001"
track_type:
description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)
title: TrackType
type: string
x-stream-index: "004"
type:
default: call.frame_recording_ready
description: 'The type of event: "call.frame_recording_ready" in this case'
title: Event Type
type: string
x-stream-index: "001.001"
url:
description: The URL of the frame
title: URL
type: string
x-stream-index: "005"
users:
additionalProperties:
$ref: '#/components/schemas/UserResponse'
description: The users in the frame
title: Users
type: object
x-stream-index: "007"
required:
- type
- created_at
- call_cid
- session_id
- track_type
- url
- captured_at
- users
- egress_id
title: CallFrameRecordingFrameReadyEvent
type: object
x-stream-event-call-type: true
x-stream-event-doc-group: call
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallFrameRecordingStartedEvent:
description: This event is sent when frame recording has started
properties:
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "003"
call_cid:
type: string
x-stream-index: "002.001"
created_at:
format: date-time
type: number
x-stream-index: "001.002"
egress_id:
type: string
x-stream-index: "004"
type:
default: call.frame_recording_started
description: 'The type of event: "call.frame_recording_started" in this
case'
title: Event Type
type: string
x-stream-index: "001.001"
required:
- type
- created_at
- call_cid
- call
- egress_id
title: CallFrameRecordingStartedEvent
type: object
x-stream-event-call-type: true
x-stream-event-doc-group: recording
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallFrameRecordingStoppedEvent:
description: This event is sent when frame recording has stopped
properties:
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "003"
call_cid:
type: string
x-stream-index: "002.001"
created_at:
format: date-time
type: number
x-stream-index: "001.002"
egress_id:
type: string
x-stream-index: "004"
type:
default: call.frame_recording_stopped
description: 'The type of event: "call.frame_recording_stopped" in this
case'
title: Event Type
type: string
x-stream-index: "001.001"
required:
- type
- created_at
- call_cid
- call
- egress_id
title: CallFrameRecordingStoppedEvent
type: object
x-stream-event-call-type: true
x-stream-event-doc-group: recording
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallHLSBroadcastingFailedEvent:
description: This event is sent when HLS broadcasting has failed
properties:
Expand Down Expand Up @@ -5689,6 +5856,9 @@ components:
broadcasting:
type: boolean
x-stream-index: "001"
frame_recording:
$ref: '#/components/schemas/FrameRecordingResponse'
x-stream-index: "004"
hls:
$ref: '#/components/schemas/EgressHLSResponse'
x-stream-index: "002"
Expand Down Expand Up @@ -6374,6 +6544,14 @@ components:
- duration
title: Response
type: object
FrameRecordingResponse:
properties:
status:
type: string
x-stream-index: "001"
required:
- status
type: object
FrameRecordingSettingsRequest:
properties:
capture_interval_in_seconds:
Expand All @@ -6390,6 +6568,12 @@ components:
type: string
x-stream-index: "001"
quality:
enum:
- 360p
- 480p
- 720p
- 1080p
- 1440p
type: string
x-stream-index: "002"
required:
Expand Down Expand Up @@ -8354,7 +8538,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 @@ -17052,6 +17236,10 @@ components:
call.created: '#/components/schemas/CallCreatedEvent'
call.deleted: '#/components/schemas/CallDeletedEvent'
call.ended: '#/components/schemas/CallEndedEvent'
call.frame_recording_failed: '#/components/schemas/CallFrameRecordingFailedEvent'
call.frame_recording_ready: '#/components/schemas/CallFrameRecordingFrameReadyEvent'
call.frame_recording_started: '#/components/schemas/CallFrameRecordingStartedEvent'
call.frame_recording_stopped: '#/components/schemas/CallFrameRecordingStoppedEvent'
call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent'
call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent'
call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent'
Expand Down Expand Up @@ -17159,6 +17347,10 @@ components:
- $ref: '#/components/schemas/CallCreatedEvent'
- $ref: '#/components/schemas/CallDeletedEvent'
- $ref: '#/components/schemas/CallEndedEvent'
- $ref: '#/components/schemas/CallFrameRecordingFailedEvent'
- $ref: '#/components/schemas/CallFrameRecordingFrameReadyEvent'
- $ref: '#/components/schemas/CallFrameRecordingStartedEvent'
- $ref: '#/components/schemas/CallFrameRecordingStoppedEvent'
- $ref: '#/components/schemas/CallHLSBroadcastingFailedEvent'
- $ref: '#/components/schemas/CallHLSBroadcastingStartedEvent'
- $ref: '#/components/schemas/CallHLSBroadcastingStoppedEvent'
Expand Down Expand Up @@ -17335,7 +17527,7 @@ components:
type: apiKey
info:
title: Stream API
version: v154.1.0
version: v155.2.0
openapi: 3.0.3
paths:
/api/v2/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/serverside-api.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading