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

Merged
merged 1 commit into from
Sep 15, 2023
Merged

Update video openapi Spec #240

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
79 changes: 43 additions & 36 deletions openapi/video-openapi-clientside.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1271,11 +1271,6 @@ components:
type: object
CallStateResponseFields:
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001"
Expand All @@ -1295,11 +1290,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "005"
x-stream-index: "004"
required:
- call
- members
- blocked_users
- own_capabilities
type: object
CallUpdatedEvent:
Expand Down Expand Up @@ -1346,6 +1340,41 @@ components:
x-stream-event-call-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallUserMuted:
description: This event is sent when a call member is muted
properties:
call_cid:
type: string
x-stream-index: "002.001"
created_at:
format: date-time
type: string
x-stream-index: "001.002"
from_user_id:
type: string
x-stream-index: "003"
muted_user_ids:
items:
type: string
type: array
x-stream-index: "004"
type:
default: call.user_muted
description: 'The type of event: "call.user_muted" in this case'
title: Event Type
type: string
x-stream-index: "001.001"
required:
- type
- created_at
- call_cid
- from_user_id
- muted_user_ids
title: CallUserMuted
type: object
x-stream-event-call-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
ConnectUserDetailsRequest:
properties:
custom:
Expand Down Expand Up @@ -1705,11 +1734,6 @@ components:
GetCallResponse:
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "001.004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001.001"
Expand All @@ -1728,11 +1752,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "001.005"
x-stream-index: "001.004"
required:
- call
- members
- blocked_users
- own_capabilities
- duration
type: object
Expand Down Expand Up @@ -1780,11 +1803,6 @@ components:
GetOrCreateCallResponse:
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "001.004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001.001"
Expand All @@ -1806,11 +1824,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "001.005"
x-stream-index: "001.004"
required:
- call
- members
- blocked_users
- own_capabilities
- created
- duration
Expand Down Expand Up @@ -1962,11 +1979,6 @@ components:
JoinCallResponse:
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "001.004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001.001"
Expand All @@ -1993,11 +2005,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "001.005"
x-stream-index: "001.004"
required:
- call
- members
- blocked_users
- own_capabilities
- created
- credentials
Expand Down Expand Up @@ -2954,11 +2965,6 @@ components:
description: Represents a call
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "001.004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001.001"
Expand All @@ -2977,11 +2983,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "001.005"
x-stream-index: "001.004"
required:
- call
- members
- blocked_users
- own_capabilities
- duration
title: Call
Expand Down Expand Up @@ -3160,6 +3165,7 @@ components:
call.session_started: '#/components/schemas/CallSessionStartedEvent'
call.unblocked_user: '#/components/schemas/UnblockedUserEvent'
call.updated: '#/components/schemas/CallUpdatedEvent'
call.user_muted: '#/components/schemas/CallUserMuted'
connection.error: '#/components/schemas/ConnectionErrorEvent'
connection.ok: '#/components/schemas/ConnectedEvent'
custom: '#/components/schemas/CustomVideoEvent'
Expand Down Expand Up @@ -3188,6 +3194,7 @@ components:
- $ref: '#/components/schemas/CallSessionParticipantLeftEvent'
- $ref: '#/components/schemas/CallSessionStartedEvent'
- $ref: '#/components/schemas/CallUpdatedEvent'
- $ref: '#/components/schemas/CallUserMuted'
- $ref: '#/components/schemas/ConnectedEvent'
- $ref: '#/components/schemas/ConnectionErrorEvent'
- $ref: '#/components/schemas/CustomVideoEvent'
Expand Down Expand Up @@ -3317,7 +3324,7 @@ externalDocs:
url: https://getstream.io/video/docs/
info:
title: Stream Video API
version: v88.10.0
version: v88.11.0
openapi: 3.0.3
paths:
/call/{type}/{id}:
Expand Down
79 changes: 43 additions & 36 deletions openapi/video-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1302,11 +1302,6 @@ components:
type: object
CallStateResponseFields:
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001"
Expand All @@ -1326,11 +1321,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "005"
x-stream-index: "004"
required:
- call
- members
- blocked_users
- own_capabilities
type: object
CallTypeResponse:
Expand Down Expand Up @@ -1411,6 +1405,41 @@ components:
x-stream-event-call-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
CallUserMuted:
description: This event is sent when a call member is muted
properties:
call_cid:
type: string
x-stream-index: "002.001"
created_at:
format: date-time
type: string
x-stream-index: "001.002"
from_user_id:
type: string
x-stream-index: "003"
muted_user_ids:
items:
type: string
type: array
x-stream-index: "004"
type:
default: call.user_muted
description: 'The type of event: "call.user_muted" in this case'
title: Event Type
type: string
x-stream-index: "001.001"
required:
- type
- created_at
- call_cid
- from_user_id
- muted_user_ids
title: CallUserMuted
type: object
x-stream-event-call-type: true
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
ConnectUserDetailsRequest:
properties:
custom:
Expand Down Expand Up @@ -1852,11 +1881,6 @@ components:
GetCallResponse:
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "001.004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001.001"
Expand All @@ -1875,11 +1899,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "001.005"
x-stream-index: "001.004"
required:
- call
- members
- blocked_users
- own_capabilities
- duration
type: object
Expand Down Expand Up @@ -1966,11 +1989,6 @@ components:
GetOrCreateCallResponse:
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "001.004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001.001"
Expand All @@ -1992,11 +2010,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "001.005"
x-stream-index: "001.004"
required:
- call
- members
- blocked_users
- own_capabilities
- created
- duration
Expand Down Expand Up @@ -2148,11 +2165,6 @@ components:
JoinCallResponse:
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "001.004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001.001"
Expand All @@ -2179,11 +2191,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "001.005"
x-stream-index: "001.004"
required:
- call
- members
- blocked_users
- own_capabilities
- created
- credentials
Expand Down Expand Up @@ -3199,11 +3210,6 @@ components:
description: Represents a call
nullable: true
properties:
blocked_users:
items:
$ref: '#/components/schemas/UserResponse'
type: array
x-stream-index: "001.004"
call:
$ref: '#/components/schemas/CallResponse'
x-stream-index: "001.001"
Expand All @@ -3222,11 +3228,10 @@ components:
items:
$ref: '#/components/schemas/OwnCapability'
type: array
x-stream-index: "001.005"
x-stream-index: "001.004"
required:
- call
- members
- blocked_users
- own_capabilities
- duration
title: Call
Expand Down Expand Up @@ -3473,6 +3478,7 @@ components:
call.session_started: '#/components/schemas/CallSessionStartedEvent'
call.unblocked_user: '#/components/schemas/UnblockedUserEvent'
call.updated: '#/components/schemas/CallUpdatedEvent'
call.user_muted: '#/components/schemas/CallUserMuted'
connection.error: '#/components/schemas/ConnectionErrorEvent'
connection.ok: '#/components/schemas/ConnectedEvent'
custom: '#/components/schemas/CustomVideoEvent'
Expand Down Expand Up @@ -3501,6 +3507,7 @@ components:
- $ref: '#/components/schemas/CallSessionParticipantLeftEvent'
- $ref: '#/components/schemas/CallSessionStartedEvent'
- $ref: '#/components/schemas/CallUpdatedEvent'
- $ref: '#/components/schemas/CallUserMuted'
- $ref: '#/components/schemas/ConnectedEvent'
- $ref: '#/components/schemas/ConnectionErrorEvent'
- $ref: '#/components/schemas/CustomVideoEvent'
Expand Down Expand Up @@ -3630,7 +3637,7 @@ externalDocs:
url: https://getstream.io/video/docs/
info:
title: Stream Video API
version: v88.10.0
version: v88.11.0
openapi: 3.0.3
paths:
/call/{type}/{id}:
Expand Down