Skip to content

Commit

Permalink
Update video openapi Spec (#546)
Browse files Browse the repository at this point in the history
  • Loading branch information
@su225
su225 authored May 2, 2024
2 parents fbe437d + 202c4ea commit 4f8e26b
Show file tree
Hide file tree
Showing 12 changed files with 361 additions and 161 deletions.
2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.json
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions openapi/chat-openapi-clientside.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4005,7 +4005,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 @@ -9622,7 +9622,7 @@ components:
type: apiKey
info:
title: Stream API
version: v112.1.0
version: v112.2.0
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/chat-openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10504,7 +10504,7 @@ components:
type: apiKey
info:
title: Stream API
version: v112.1.0
version: v112.2.0
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/clientside-api.json
View file

Large diffs are not rendered by default.

126 changes: 88 additions & 38 deletions openapi/clientside-api.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5744,6 +5744,26 @@ components:
type: string
x-stream-index: "003"
type: object
MediaPubSubHint:
properties:
audio_published:
type: boolean
x-stream-index: "001"
audio_subscribed:
type: boolean
x-stream-index: "002"
video_published:
type: boolean
x-stream-index: "003"
video_subscribed:
type: boolean
x-stream-index: "004"
required:
- audio_published
- audio_subscribed
- video_published
- video_subscribed
type: object
MemberAddedEvent:
properties:
channel_id:
Expand Down Expand Up @@ -10694,6 +10714,7 @@ components:
- duration
type: object
Subsession:
nullable: true
properties:
ended_at:
format: int32
Expand All @@ -10703,6 +10724,9 @@ components:
format: int32
type: integer
x-stream-index: "001"
pub_sub_hint:
$ref: '#/components/schemas/MediaPubSubHint'
x-stream-index: "004"
sfu_id:
type: string
x-stream-index: "003"
Expand Down Expand Up @@ -12729,137 +12753,163 @@ components:
properties:
browser:
type: string
x-stream-index: "009"
x-stream-index: "012.008"
browser_version:
type: string
x-stream-index: "010"
x-stream-index: "012.009"
current_ip:
type: string
x-stream-index: "014"
x-stream-index: "005"
current_sfu:
type: string
x-stream-index: "015"
x-stream-index: "006"
device_model:
type: string
x-stream-index: "007"
x-stream-index: "012.006"
device_version:
type: string
x-stream-index: "008"
x-stream-index: "012.007"
distance_to_sfu_kilometers:
format: float
type: number
x-stream-index: "016"
x-stream-index: "007"
freeze_duration_seconds:
format: int32
type: integer
x-stream-index: "021.010"
x-stream-index: "014.012"
geolocation:
$ref: '#/components/schemas/GeolocationResult'
x-stream-index: "017"
x-stream-index: "008"
jitter:
$ref: '#/components/schemas/Stats'
x-stream-index: "011"
x-stream-index: "002"
latency:
$ref: '#/components/schemas/Stats'
x-stream-index: "012"
x-stream-index: "003"
max_fir_per_second:
format: float
type: number
x-stream-index: "021.003"
x-stream-index: "014.003"
max_freeze_fraction:
format: float
type: number
x-stream-index: "021.007"
x-stream-index: "014.006"
max_freezes_duration_seconds:
format: int32
type: integer
x-stream-index: "021.006"
x-stream-index: "014.005"
max_freezes_per_second:
format: float
type: number
x-stream-index: "021.004"
x-stream-index: "014.004"
max_nack_per_second:
format: float
type: number
x-stream-index: "021.002"
x-stream-index: "014.002"
max_pli_per_second:
format: float
type: number
x-stream-index: "021.001"
x-stream-index: "014.001"
max_publishing_video_quality:
$ref: '#/components/schemas/VideoQuality'
x-stream-index: "020.003"
x-stream-index: "013.003"
max_receiving_video_quality:
$ref: '#/components/schemas/VideoQuality'
x-stream-index: "021.012"
x-stream-index: "014.014"
os:
type: string
x-stream-index: "002"
x-stream-index: "012.001"
os_version:
type: string
x-stream-index: "003"
x-stream-index: "012.002"
packet_loss_fraction:
format: float
type: number
x-stream-index: "021.005"
x-stream-index: "014.008"
pub_sub_hints:
$ref: '#/components/schemas/MediaPubSubHint'
x-stream-index: "011"
publisher_audio_mos:
$ref: '#/components/schemas/MOSStats'
x-stream-index: "020.005"
x-stream-index: "013.005"
publisher_jitter:
$ref: '#/components/schemas/Stats'
x-stream-index: "013.008"
publisher_latency:
$ref: '#/components/schemas/Stats'
x-stream-index: "013.007"
publisher_packet_loss_fraction:
format: float
type: number
x-stream-index: "013.006"
publisher_video_quality_limitation_duration_seconds:
additionalProperties:
format: float
type: number
type: object
x-stream-index: "013.009"
publishing_audio_codec:
type: string
x-stream-index: "020.002"
x-stream-index: "013.002"
publishing_duration_seconds:
format: int32
type: integer
x-stream-index: "020.001"
x-stream-index: "013.001"
quality_score:
format: float
type: number
x-stream-index: "013"
x-stream-index: "004"
receiving_audio_codec:
type: string
x-stream-index: "021.011"
x-stream-index: "014.013"
receiving_duration_seconds:
format: int32
type: integer
x-stream-index: "021.009"
x-stream-index: "014.011"
sdk:
type: string
x-stream-index: "005"
x-stream-index: "012.004"
sdk_version:
type: string
x-stream-index: "006"
x-stream-index: "012.005"
session_id:
type: string
x-stream-index: "019"
x-stream-index: "010"
subscriber_audio_mos:
$ref: '#/components/schemas/MOSStats'
x-stream-index: "021.008"
x-stream-index: "014.007"
subscriber_jitter:
$ref: '#/components/schemas/Stats'
x-stream-index: "014.010"
subscriber_latency:
$ref: '#/components/schemas/Stats'
x-stream-index: "014.009"
subsessions:
items:
$ref: '#/components/schemas/Subsession'
type: array
x-stream-index: "018"
x-stream-index: "009"
timeline:
$ref: '#/components/schemas/CallTimeline'
x-stream-index: "001"
total_pixels_in:
type: integer
x-stream-index: "021.013"
x-stream-index: "014.015"
total_pixels_out:
type: integer
x-stream-index: "020.004"
x-stream-index: "013.004"
webrtc_version:
type: string
x-stream-index: "004"
x-stream-index: "012.003"
required:
- quality_score
- session_id
- publishing_duration_seconds
- total_pixels_out
- packet_loss_fraction
- publisher_packet_loss_fraction
- max_freezes_duration_seconds
- max_freeze_fraction
- packet_loss_fraction
- receiving_duration_seconds
- freeze_duration_seconds
- total_pixels_in
Expand Down Expand Up @@ -13439,7 +13489,7 @@ components:
type: apiKey
info:
title: Stream API
version: v112.1.0
version: v112.2.0
openapi: 3.0.3
paths:
/api/v2/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/serverside-api.json
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 4f8e26b

Please sign in to comment.