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 Feb 13, 2025
1 parent 8a0981c commit 95d352c
Show file tree
Hide file tree
Showing 14 changed files with 1,012 additions and 32 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 @@ -10069,7 +10069,7 @@ components:
type: apiKey
info:
title: Stream API
version: v154.1.0
version: v156.2.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.

4 changes: 2 additions & 2 deletions openapi/chat-openapi.yaml
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: v156.2.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.

212 changes: 207 additions & 5 deletions openapi/clientside-api.yaml
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 @@ -2062,6 +2229,10 @@ components:
title: The filename of the recording.
type: string
x-stream-index: "001"
session_id:
title: The session ID of the recording.
type: string
x-stream-index: "005"
start_time:
format: date-time
title: The start time of the recording.
Expand All @@ -2076,6 +2247,7 @@ components:
- url
- start_time
- end_time
- session_id
title: CallRecording
type: object
CallRecordingFailedEvent:
Expand Down Expand Up @@ -5689,6 +5861,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 @@ -5966,6 +6141,10 @@ components:
format: int32
type: integer
x-stream-index: "003"
flagged_count:
format: int32
type: integer
x-stream-index: "004"
id:
description: Unique user identifier
title: ID
Expand Down Expand Up @@ -6035,6 +6214,7 @@ components:
- invisible
- ban_count
- deleted_content_count
- flagged_count
title: UserResponse
type: object
EventRequest:
Expand Down Expand Up @@ -6374,6 +6554,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 +6578,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 @@ -7074,9 +7268,6 @@ components:
start_recording:
type: boolean
x-stream-index: "004"
start_rtmp_broadcasts:
type: boolean
x-stream-index: "009"
start_transcription:
type: boolean
x-stream-index: "007"
Expand Down Expand Up @@ -8354,7 +8545,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 @@ -13525,6 +13716,8 @@ components:
required:
- inactivity_timeout_seconds
type: object
ShadowBlockActionRequest:
type: object
ShowChannelRequest:
nullable: true
type: object
Expand Down Expand Up @@ -13900,6 +14093,7 @@ components:
- restore
- delete_user
- unblock
- shadow_block
type: string
x-stream-index: "002"
ban:
Expand Down Expand Up @@ -17052,6 +17246,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 +17357,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 +17537,7 @@ components:
type: apiKey
info:
title: Stream API
version: v154.1.0
version: v156.2.0
openapi: 3.0.3
paths:
/api/v2/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/serverside-api.json

Large diffs are not rendered by default.

Loading

0 comments on commit 95d352c

Please sign in to comment.