From 7c049504824d735e7ed7982848e19fddf3de8138 Mon Sep 17 00:00:00 2001 From: Stream CI Bot Date: Thu, 21 Sep 2023 16:06:33 +0200 Subject: [PATCH] Update video openapi Spec (#244) Co-authored-by: GH Action CI Stream --- openapi/video-openapi-clientside.yaml | 67 ++++++++++++++++++++++++++- openapi/video-openapi.yaml | 67 ++++++++++++++++++++++++++- 2 files changed, 132 insertions(+), 2 deletions(-) diff --git a/openapi/video-openapi-clientside.yaml b/openapi/video-openapi-clientside.yaml index 18592293..1cf42cea 100644 --- a/openapi/video-openapi-clientside.yaml +++ b/openapi/video-openapi-clientside.yaml @@ -709,19 +709,24 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent CallRecording: + description: CallRecording represents a recording of a call. properties: end_time: format: date-time + title: The end time of the recording. type: string x-stream-index: "004" filename: + title: The filename of the recording. type: string x-stream-index: "001" start_time: format: date-time + title: The start time of the recording. type: string x-stream-index: "003" url: + title: The URL of the recording. type: string x-stream-index: "002" required: @@ -730,6 +735,62 @@ components: - start_time - end_time type: object + CallRecordingFailedEvent: + description: This event is sent when call recording has failed + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: string + x-stream-index: "001.002" + type: + default: call.recording_failed + description: 'The type of event: "call.recording_failed" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + title: CallRecordingFailedEvent + type: object + x-stream-event-call-type: true + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallRecordingReadyEvent: + description: This event is sent when call recording is ready + properties: + call_cid: + type: string + x-stream-index: "002.001" + call_recording: + $ref: '#/components/schemas/CallRecording' + description: The call recording object + title: CallRecording + x-stream-index: "003" + created_at: + format: date-time + type: string + x-stream-index: "001.002" + type: + default: call.recording_ready + description: 'The type of event: "call.recording_ready" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call_recording + title: CallRecordingReadyEvent + type: object + x-stream-event-call-type: true + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent CallRecordingStartedEvent: description: This event is sent when call recording has started nullable: true @@ -3155,6 +3216,8 @@ components: call.permission_request: '#/components/schemas/PermissionRequestEvent' call.permissions_updated: '#/components/schemas/UpdatedCallPermissionsEvent' call.reaction_new: '#/components/schemas/CallReactionEvent' + call.recording_failed: '#/components/schemas/CallRecordingFailedEvent' + call.recording_ready: '#/components/schemas/CallRecordingReadyEvent' call.recording_started: '#/components/schemas/CallRecordingStartedEvent' call.recording_stopped: '#/components/schemas/CallRecordingStoppedEvent' call.rejected: '#/components/schemas/CallRejectedEvent' @@ -3185,6 +3248,8 @@ components: - $ref: '#/components/schemas/CallMemberUpdatedPermissionEvent' - $ref: '#/components/schemas/CallNotificationEvent' - $ref: '#/components/schemas/CallReactionEvent' + - $ref: '#/components/schemas/CallRecordingFailedEvent' + - $ref: '#/components/schemas/CallRecordingReadyEvent' - $ref: '#/components/schemas/CallRecordingStartedEvent' - $ref: '#/components/schemas/CallRecordingStoppedEvent' - $ref: '#/components/schemas/CallRejectedEvent' @@ -3324,7 +3389,7 @@ externalDocs: url: https://getstream.io/video/docs/ info: title: Stream Video API - version: v88.11.0 + version: v88.13.0 openapi: 3.0.3 paths: /call/{type}/{id}: diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml index 6662a624..ca9455b7 100644 --- a/openapi/video-openapi.yaml +++ b/openapi/video-openapi.yaml @@ -730,19 +730,24 @@ components: x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent CallRecording: + description: CallRecording represents a recording of a call. properties: end_time: format: date-time + title: The end time of the recording. type: string x-stream-index: "004" filename: + title: The filename of the recording. type: string x-stream-index: "001" start_time: format: date-time + title: The start time of the recording. type: string x-stream-index: "003" url: + title: The URL of the recording. type: string x-stream-index: "002" required: @@ -751,6 +756,62 @@ components: - start_time - end_time type: object + CallRecordingFailedEvent: + description: This event is sent when call recording has failed + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: string + x-stream-index: "001.002" + type: + default: call.recording_failed + description: 'The type of event: "call.recording_failed" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + title: CallRecordingFailedEvent + type: object + x-stream-event-call-type: true + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallRecordingReadyEvent: + description: This event is sent when call recording is ready + properties: + call_cid: + type: string + x-stream-index: "002.001" + call_recording: + $ref: '#/components/schemas/CallRecording' + description: The call recording object + title: CallRecording + x-stream-index: "003" + created_at: + format: date-time + type: string + x-stream-index: "001.002" + type: + default: call.recording_ready + description: 'The type of event: "call.recording_ready" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call_recording + title: CallRecordingReadyEvent + type: object + x-stream-event-call-type: true + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent CallRecordingStartedEvent: description: This event is sent when call recording has started nullable: true @@ -3468,6 +3529,8 @@ components: call.permission_request: '#/components/schemas/PermissionRequestEvent' call.permissions_updated: '#/components/schemas/UpdatedCallPermissionsEvent' call.reaction_new: '#/components/schemas/CallReactionEvent' + call.recording_failed: '#/components/schemas/CallRecordingFailedEvent' + call.recording_ready: '#/components/schemas/CallRecordingReadyEvent' call.recording_started: '#/components/schemas/CallRecordingStartedEvent' call.recording_stopped: '#/components/schemas/CallRecordingStoppedEvent' call.rejected: '#/components/schemas/CallRejectedEvent' @@ -3498,6 +3561,8 @@ components: - $ref: '#/components/schemas/CallMemberUpdatedPermissionEvent' - $ref: '#/components/schemas/CallNotificationEvent' - $ref: '#/components/schemas/CallReactionEvent' + - $ref: '#/components/schemas/CallRecordingFailedEvent' + - $ref: '#/components/schemas/CallRecordingReadyEvent' - $ref: '#/components/schemas/CallRecordingStartedEvent' - $ref: '#/components/schemas/CallRecordingStoppedEvent' - $ref: '#/components/schemas/CallRejectedEvent' @@ -3637,7 +3702,7 @@ externalDocs: url: https://getstream.io/video/docs/ info: title: Stream Video API - version: v88.11.0 + version: v88.13.0 openapi: 3.0.3 paths: /call/{type}/{id}: