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.

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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 openapi/chat-openapi-clientside.json

Large diffs are not rendered by default.

9,157 changes: 5,403 additions & 3,754 deletions openapi/chat-openapi-clientside.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/chat-openapi.json

Large diffs are not rendered by default.

5,072 changes: 3,311 additions & 1,761 deletions openapi/chat-openapi.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/clientside-api.json

Large diffs are not rendered by default.

10,101 changes: 5,961 additions & 4,140 deletions openapi/clientside-api.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/serverside-api.json

Large diffs are not rendered by default.

4,688 changes: 3,205 additions & 1,483 deletions openapi/serverside-api.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/video-openapi-clientside.json

Large diffs are not rendered by default.

239 changes: 213 additions & 26 deletions openapi/video-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ components:
mic_default_on:
type: boolean
x-stream-index: "004"
noise_cancellation:
$ref: '#/components/schemas/NoiseCancellationSettings'
x-stream-index: "007"
opus_dtx_enabled:
type: boolean
x-stream-index: "002"
Expand Down Expand Up @@ -109,6 +112,9 @@ components:
mic_default_on:
type: boolean
x-stream-index: "004"
noise_cancellation:
$ref: '#/components/schemas/NoiseCancellationSettingsRequest'
x-stream-index: "007"
opus_dtx_enabled:
type: boolean
x-stream-index: "002"
Expand Down Expand Up @@ -394,20 +400,25 @@ components:
properties:
description:
type: string
x-stream-index: "003"
x-stream-index: "004"
end_timestamp:
format: int64
type: integer
x-stream-index: "002"
severity:
format: int32
type: integer
x-stream-index: "002"
x-stream-index: "003"
timestamp:
format: int32
type: integer
x-stream-index: "001"
type:
type: string
x-stream-index: "004"
x-stream-index: "005"
required:
- timestamp
- end_timestamp
- severity
- description
- type
Expand Down Expand Up @@ -2105,6 +2116,38 @@ components:
type: array
x-stream-index: "001"
type: object
GeolocationResult:
properties:
AccuracyRadius:
format: int32
type: integer
writeOnly: true
x-stream-index: "003"
continent_code:
type: string
x-stream-index: "002.003"
country_iso_code:
type: string
x-stream-index: "002.002"
latitude:
format: float
type: number
x-stream-index: "001.001"
longitude:
format: float
type: number
x-stream-index: "001.002"
subdivision_iso_code:
type: string
x-stream-index: "002.001"
required:
- latitude
- longitude
- subdivision_iso_code
- country_iso_code
- continent_code
- AccuracyRadius
type: object
GetCallResponse:
nullable: true
properties:
Expand Down Expand Up @@ -2145,57 +2188,67 @@ components:
type: number
x-stream-index: "004"
call_duration_seconds:
format: int64
format: int32
type: integer
x-stream-index: "002"
call_timeline:
$ref: '#/components/schemas/CallTimeline'
x-stream-index: "012"
x-stream-index: "014"
duration:
description: Duration of the request in human-readable format
title: Duration
type: string
x-stream-index: "001.001"
max_jitter:
format: float
type: number
x-stream-index: "007"
max_latency:
format: float
type: number
x-stream-index: "006"
max_participants:
format: int32
type: integer
x-stream-index: "006"
x-stream-index: "008"
participant_report:
additionalProperties:
$ref: '#/components/schemas/UserStats'
type: object
x-stream-index: "013"
x-stream-index: "015"
publishing_participants:
format: int32
type: integer
x-stream-index: "007"
x-stream-index: "009"
quality_score:
format: int32
type: integer
x-stream-index: "003"
sfu_count:
format: int32
type: integer
x-stream-index: "008"
x-stream-index: "010"
sfus:
items:
$ref: '#/components/schemas/SFULocationResponse'
type: array
x-stream-index: "011"
x-stream-index: "013"
total_freezes_duration:
format: float
type: number
x-stream-index: "010"
x-stream-index: "012"
total_quality_limitation_duration:
format: float
type: number
x-stream-index: "009"
x-stream-index: "011"
required:
- duration
- call_duration_seconds
- quality_score
- average_latency
- average_jitter
- max_latency
- max_jitter
- max_participants
- publishing_participants
- sfu_count
Expand Down Expand Up @@ -2609,12 +2662,35 @@ components:
required:
- duration
type: object
NoiseCancellationSettings:
properties:
mode:
enum:
- available
- disabled
- auto-on
type: string
x-stream-index: "001"
required:
- mode
type: object
NoiseCancellationSettingsRequest:
properties:
mode:
enum:
- available
- disabled
- auto-on
type: string
x-stream-index: "001"
type: object
OwnCapability:
description: All possibility of string to use
enum:
- block-users
- create-call
- create-reaction
- enable-noise-cancellation
- end-call
- join-backstage
- join-call
Expand Down Expand Up @@ -3308,6 +3384,24 @@ components:
required:
- duration
type: object
Subsession:
properties:
sfu_id:
type: string
x-stream-index: "003"
ts_ended_at:
format: int64
type: integer
x-stream-index: "002"
ts_joined_at:
format: int64
type: integer
x-stream-index: "001"
required:
- ts_joined_at
- ts_ended_at
- sfu_id
type: object
TargetResolution:
properties:
bitrate:
Expand Down Expand Up @@ -3740,47 +3834,118 @@ components:
type: object
UserSessionStats:
properties:
browser:
type: string
x-stream-index: "009"
browser_version:
type: string
x-stream-index: "010"
current_ip:
type: string
x-stream-index: "028"
current_sfu:
type: string
x-stream-index: "029"
device_model:
type: string
x-stream-index: "007"
device_version:
type: string
x-stream-index: "008"
freeze_duration_seconds:
format: float
type: number
x-stream-index: "009"
x-stream-index: "023"
geolocation:
$ref: '#/components/schemas/GeolocationResult'
x-stream-index: "030"
jitter:
$ref: '#/components/schemas/Stats'
x-stream-index: "006"
x-stream-index: "011"
latency:
$ref: '#/components/schemas/Stats'
x-stream-index: "007"
x-stream-index: "012"
max_fir_per_minute:
format: float
type: number
x-stream-index: "019"
max_freezes_per_minute:
format: float
type: number
x-stream-index: "020"
max_nack_per_minute:
format: float
type: number
x-stream-index: "018"
max_pli_per_minute:
format: float
type: number
x-stream-index: "017"
max_publishing_video_quality:
$ref: '#/components/schemas/VideoQuality'
x-stream-index: "016"
max_receiving_video_quality:
$ref: '#/components/schemas/VideoQuality'
x-stream-index: "025"
os:
type: string
x-stream-index: "002"
os_version:
type: string
x-stream-index: "003"
packet_loss_fraction:
format: float
type: number
x-stream-index: "010"
x-stream-index: "021"
publishing_audio_codec:
type: string
x-stream-index: "015"
publishing_duration_seconds:
format: int32
type: integer
x-stream-index: "014"
quality_score:
format: float
type: number
x-stream-index: "008"
x-stream-index: "013"
receiving_audio_codec:
type: string
x-stream-index: "024"
receiving_duration_seconds:
format: int32
type: integer
x-stream-index: "022"
sdk:
type: string
x-stream-index: "004"
x-stream-index: "005"
sdk_version:
type: string
x-stream-index: "005"
x-stream-index: "006"
subsessions:
items:
$ref: '#/components/schemas/Subsession'
type: array
x-stream-index: "031"
timeline:
$ref: '#/components/schemas/CallTimeline'
x-stream-index: "001"
total_pixels_in:
type: integer
x-stream-index: "026"
total_pixels_out:
type: integer
x-stream-index: "027"
webrtc_version:
type: string
x-stream-index: "003"
x-stream-index: "004"
required:
- os
- webrtc_version
- sdk
- sdk_version
- quality_score
- freeze_duration_seconds
- publishing_duration_seconds
- packet_loss_fraction
- receiving_duration_seconds
- freeze_duration_seconds
- total_pixels_in
- total_pixels_out
type: object
UserStats:
properties:
Expand All @@ -3796,6 +3961,28 @@ components:
- info
- session_stats
type: object
VideoQuality:
properties:
resolution:
$ref: '#/components/schemas/VideoResolution'
x-stream-index: "001"
required:
- resolution
type: object
VideoResolution:
properties:
height:
format: int32
type: integer
x-stream-index: "002"
width:
format: int32
type: integer
x-stream-index: "001"
required:
- width
- height
type: object
VideoSettings:
properties:
access_request_enabled:
Expand Down Expand Up @@ -3982,7 +4169,7 @@ components:
type: apiKey
info:
title: Stream API
version: v104.0.1
version: v105.1.0
openapi: 3.0.3
paths:
/video/call/{type}/{id}:
Expand Down
2 changes: 1 addition & 1 deletion openapi/video-openapi.json

Large diffs are not rendered by default.

Loading
Loading