Skip to content

Commit

Permalink
Update video openapi Spec (#346)
Browse files Browse the repository at this point in the history
Co-authored-by: GH Action CI Stream <[email protected]>
  • Loading branch information
stream-ci-bot and stream-ci-zz authored Dec 21, 2023
1 parent 44fd795 commit c9aa8ed
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 8 deletions.
18 changes: 12 additions & 6 deletions openapi/chat-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ components:
type: string
x-stream-index: "001.002"
type:
default: any
default: custom
type: string
x-stream-index: "001.001"
required:
Expand Down Expand Up @@ -3322,9 +3322,6 @@ components:
title: Maximum message length
type: integer
x-stream-index: "015"
message_retention:
type: string
x-stream-index: "014"
mutes:
description: Enables mutes
title: Mutes
Expand Down Expand Up @@ -3885,6 +3882,12 @@ components:
DeleteUsersRequest:
nullable: true
properties:
calls:
enum:
- soft
- hard
type: string
x-stream-index: 001.002.004
conversations:
description: |
Conversation channels delete mode.
Expand Down Expand Up @@ -3914,9 +3917,12 @@ components:
title: Delete Messages
type: string
x-stream-index: 001.002.002
new_call_owner_id:
type: string
x-stream-index: 001.002.006
new_channel_owner_id:
type: string
x-stream-index: 001.002.004
x-stream-index: 001.002.005
user:
description: |
User delete mode.
Expand Down Expand Up @@ -11892,7 +11898,7 @@ externalDocs:
url: https://getstream.io/chat/docs/
info:
title: Stream Chat API
version: v94.0.1
version: v95.0.0
openapi: 3.0.3
paths:
/app:
Expand Down
36 changes: 35 additions & 1 deletion openapi/video-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,38 @@ components:
x-stream-event-call-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallDeletedEvent:
description: This event is sent when a call is deleted. Clients receiving this
event should leave the call screen
properties:
call:
$ref: '#/components/schemas/CallResponse'
description: Call object
title: Call
x-stream-index: "003"
call_cid:
type: string
x-stream-index: "002.001"
created_at:
format: date-time
type: string
x-stream-index: "001.002"
type:
default: call.deleted
description: 'The type of event: "call.deleted" in this case'
title: Event Type
type: string
x-stream-index: "001.001"
required:
- type
- created_at
- call_cid
- call
title: CallDeletedEvent
type: object
x-stream-event-call-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallEndedEvent:
description: This event is sent when a call is mark as ended for all its participants.
Clients receiving this event should leave the call screen
Expand Down Expand Up @@ -3260,6 +3292,7 @@ components:
call.accepted: '#/components/schemas/CallAcceptedEvent'
call.blocked_user: '#/components/schemas/BlockedUserEvent'
call.created: '#/components/schemas/CallCreatedEvent'
call.deleted: '#/components/schemas/CallDeletedEvent'
call.ended: '#/components/schemas/CallEndedEvent'
call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent'
call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent'
Expand Down Expand Up @@ -3295,6 +3328,7 @@ components:
- $ref: '#/components/schemas/BlockedUserEvent'
- $ref: '#/components/schemas/CallAcceptedEvent'
- $ref: '#/components/schemas/CallCreatedEvent'
- $ref: '#/components/schemas/CallDeletedEvent'
- $ref: '#/components/schemas/CallEndedEvent'
- $ref: '#/components/schemas/CallHLSBroadcastingFailedEvent'
- $ref: '#/components/schemas/CallHLSBroadcastingStartedEvent'
Expand Down Expand Up @@ -3447,7 +3481,7 @@ externalDocs:
url: https://getstream.io/video/docs/
info:
title: Stream Video API
version: v94.0.1
version: v95.0.0
openapi: 3.0.3
paths:
/call/{type}/{id}:
Expand Down
36 changes: 35 additions & 1 deletion openapi/video-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,38 @@ components:
x-stream-event-call-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallDeletedEvent:
description: This event is sent when a call is deleted. Clients receiving this
event should leave the call screen
properties:
call:
$ref: '#/components/schemas/CallResponse'
description: Call object
title: Call
x-stream-index: "003"
call_cid:
type: string
x-stream-index: "002.001"
created_at:
format: date-time
type: string
x-stream-index: "001.002"
type:
default: call.deleted
description: 'The type of event: "call.deleted" in this case'
title: Event Type
type: string
x-stream-index: "001.001"
required:
- type
- created_at
- call_cid
- call
title: CallDeletedEvent
type: object
x-stream-event-call-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallEndedEvent:
description: This event is sent when a call is mark as ended for all its participants.
Clients receiving this event should leave the call screen
Expand Down Expand Up @@ -3435,6 +3467,7 @@ components:
call.accepted: '#/components/schemas/CallAcceptedEvent'
call.blocked_user: '#/components/schemas/BlockedUserEvent'
call.created: '#/components/schemas/CallCreatedEvent'
call.deleted: '#/components/schemas/CallDeletedEvent'
call.ended: '#/components/schemas/CallEndedEvent'
call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent'
call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent'
Expand Down Expand Up @@ -3470,6 +3503,7 @@ components:
- $ref: '#/components/schemas/BlockedUserEvent'
- $ref: '#/components/schemas/CallAcceptedEvent'
- $ref: '#/components/schemas/CallCreatedEvent'
- $ref: '#/components/schemas/CallDeletedEvent'
- $ref: '#/components/schemas/CallEndedEvent'
- $ref: '#/components/schemas/CallHLSBroadcastingFailedEvent'
- $ref: '#/components/schemas/CallHLSBroadcastingStartedEvent'
Expand Down Expand Up @@ -3622,7 +3656,7 @@ externalDocs:
url: https://getstream.io/video/docs/
info:
title: Stream Video API
version: v94.0.1
version: v95.0.0
openapi: 3.0.3
paths:
/call/{type}/{id}:
Expand Down

0 comments on commit c9aa8ed

Please sign in to comment.