Skip to content

Commit d833155

Browse files
committed
Update video openapi Spec
1 parent 86a754b commit d833155

36 files changed

+1354
-62
lines changed

openapi/chat-openapi-clientside.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/chat-openapi-clientside.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8899,8 +8899,6 @@ components:
88998899
type: boolean
89008900
x-stream-index: "010"
89018901
force_sql_v2_backend:
8902-
description: Force usage of SQL v2 search backend
8903-
title: Force SQL v2 Backend
89048902
type: boolean
89058903
x-stream-index: "011"
89068904
limit:
@@ -12142,7 +12140,7 @@ components:
1214212140
type: apiKey
1214312141
info:
1214412142
title: Stream API
12145-
version: v214.2.0
12143+
version: v214.3.0
1214612144
openapi: 3.0.3
1214712145
paths:
1214812146
/app:

openapi/chat-openapi.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/chat-openapi.yaml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ components:
606606
type: string
607607
x-stream-index: "002.001"
608608
type:
609-
default: export.bulk_image_moderation.error
609+
default: export.moderation_logs.error
610610
type: string
611611
x-stream-index: "003.002"
612612
required:
@@ -8318,7 +8318,7 @@ components:
83188318
type: array
83198319
x-stream-index: "001.002"
83208320
type:
8321-
default: message.new
8321+
default: notification.thread_message_new
83228322
type: string
83238323
x-stream-index: "004.001"
83248324
user:
@@ -12841,8 +12841,6 @@ components:
1284112841
type: boolean
1284212842
x-stream-index: "010"
1284312843
force_sql_v2_backend:
12844-
description: Force usage of SQL v2 search backend
12845-
title: Force SQL v2 Backend
1284612844
type: boolean
1284712845
x-stream-index: "011"
1284812846
limit:
@@ -17260,7 +17258,7 @@ components:
1726017258
type: apiKey
1726117259
info:
1726217260
title: Stream API
17263-
version: v214.2.0
17261+
version: v214.3.0
1726417262
openapi: 3.0.3
1726517263
paths:
1726617264
/app:

openapi/clientside-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/clientside-api.yaml

Lines changed: 172 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13680,6 +13680,57 @@ components:
1368013680
- enable_dtx
1368113681
- bitrate
1368213682
type: object
13683+
IngressErrorEvent:
13684+
description: This event is sent when a critical error occurs that breaks the
13685+
streaming pipeline
13686+
nullable: true
13687+
properties:
13688+
call_cid:
13689+
type: string
13690+
x-stream-index: "002.001"
13691+
code:
13692+
description: Error code
13693+
title: string
13694+
type: string
13695+
x-stream-index: "006"
13696+
created_at:
13697+
format: date-time
13698+
type: number
13699+
x-stream-index: "001.002"
13700+
error:
13701+
description: Human-readable error message
13702+
title: string
13703+
type: string
13704+
x-stream-index: "005"
13705+
ingress_stream_id:
13706+
description: Unique identifier for the stream
13707+
title: string
13708+
type: string
13709+
x-stream-index: "003"
13710+
type:
13711+
default: ingress.error
13712+
description: 'The type of event: "ingress.error" in this case'
13713+
title: Event Type
13714+
type: string
13715+
x-stream-index: "001.001"
13716+
user_id:
13717+
description: User who was streaming
13718+
title: string
13719+
type: string
13720+
x-stream-index: "004"
13721+
required:
13722+
- type
13723+
- created_at
13724+
- call_cid
13725+
- ingress_stream_id
13726+
- user_id
13727+
- error
13728+
title: IngressErrorEvent
13729+
type: object
13730+
x-stream-event-call-type: true
13731+
x-stream-event-doc-group: call
13732+
x-stream-is-event: true
13733+
x-stream-ws-base-event-name: VideoEvent
1368313734
IngressSettingsRequest:
1368413735
properties:
1368513736
audio_encoding_options:
@@ -13747,6 +13798,106 @@ components:
1374713798
- height
1374813799
- fps
1374913800
type: object
13801+
IngressStartedEvent:
13802+
description: This event is sent when a user begins streaming into a call
13803+
nullable: true
13804+
properties:
13805+
call_cid:
13806+
type: string
13807+
x-stream-index: "002.001"
13808+
client_ip:
13809+
description: Client IP address
13810+
title: string
13811+
type: string
13812+
x-stream-index: "008"
13813+
client_name:
13814+
description: Streaming client software name (e.g., 'OBS Studio')
13815+
title: string
13816+
type: string
13817+
x-stream-index: "006"
13818+
created_at:
13819+
format: date-time
13820+
type: number
13821+
x-stream-index: "001.002"
13822+
ingress_stream_id:
13823+
description: Unique identifier for this stream
13824+
title: string
13825+
type: string
13826+
x-stream-index: "003"
13827+
publisher_type:
13828+
description: Streaming protocol (e.g., 'rtmps', 'srt', 'rtmp', 'rtsp')
13829+
title: string
13830+
type: string
13831+
x-stream-index: "005"
13832+
type:
13833+
default: ingress.started
13834+
description: 'The type of event: "ingress.started" in this case'
13835+
title: Event Type
13836+
type: string
13837+
x-stream-index: "001.001"
13838+
user_id:
13839+
description: User who started the stream
13840+
title: string
13841+
type: string
13842+
x-stream-index: "004"
13843+
version:
13844+
description: Client software version
13845+
title: string
13846+
type: string
13847+
x-stream-index: "007"
13848+
required:
13849+
- type
13850+
- created_at
13851+
- call_cid
13852+
- ingress_stream_id
13853+
- user_id
13854+
- publisher_type
13855+
title: IngressStartedEvent
13856+
type: object
13857+
x-stream-event-call-type: true
13858+
x-stream-event-doc-group: call
13859+
x-stream-is-event: true
13860+
x-stream-ws-base-event-name: VideoEvent
13861+
IngressStoppedEvent:
13862+
description: This event is sent when streaming stops due to user action or call
13863+
ended
13864+
nullable: true
13865+
properties:
13866+
call_cid:
13867+
type: string
13868+
x-stream-index: "002.001"
13869+
created_at:
13870+
format: date-time
13871+
type: number
13872+
x-stream-index: "001.002"
13873+
ingress_stream_id:
13874+
description: Unique identifier for the stream
13875+
title: string
13876+
type: string
13877+
x-stream-index: "003"
13878+
type:
13879+
default: ingress.stopped
13880+
description: 'The type of event: "ingress.stopped" in this case'
13881+
title: Event Type
13882+
type: string
13883+
x-stream-index: "001.001"
13884+
user_id:
13885+
description: User who was streaming
13886+
title: string
13887+
type: string
13888+
x-stream-index: "004"
13889+
required:
13890+
- type
13891+
- created_at
13892+
- call_cid
13893+
- ingress_stream_id
13894+
- user_id
13895+
title: IngressStoppedEvent
13896+
type: object
13897+
x-stream-event-call-type: true
13898+
x-stream-event-doc-group: call
13899+
x-stream-is-event: true
13900+
x-stream-ws-base-event-name: VideoEvent
1375013901
IngressVideoEncodingOptionsRequest:
1375113902
properties:
1375213903
layers:
@@ -15176,7 +15327,7 @@ components:
1517615327
type: array
1517715328
x-stream-index: "001.002"
1517815329
type:
15179-
default: message.new
15330+
default: notification.thread_message_new
1518015331
type: string
1518115332
x-stream-index: "004.001"
1518215333
user:
@@ -23312,8 +23463,6 @@ components:
2331223463
type: boolean
2331323464
x-stream-index: "010"
2331423465
force_sql_v2_backend:
23315-
description: Force usage of SQL v2 search backend
23316-
title: Force SQL v2 Backend
2331723466
type: boolean
2331823467
x-stream-index: "011"
2331923468
limit:
@@ -28768,6 +28917,19 @@ components:
2876828917
- token
2876928918
title: WSAuthMessage
2877028919
type: object
28920+
WSCallEvent:
28921+
description: The discriminator object for all websocket call events, it maps
28922+
events' payload to the final type
28923+
discriminator:
28924+
mapping:
28925+
ingress.error: '#/components/schemas/IngressErrorEvent'
28926+
ingress.started: '#/components/schemas/IngressStartedEvent'
28927+
ingress.stopped: '#/components/schemas/IngressStoppedEvent'
28928+
propertyName: type
28929+
oneOf:
28930+
- $ref: '#/components/schemas/IngressErrorEvent'
28931+
- $ref: '#/components/schemas/IngressStartedEvent'
28932+
- $ref: '#/components/schemas/IngressStoppedEvent'
2877128933
WSClientEvent:
2877228934
description: The discriminator object for all websocket client events, it maps
2877328935
events' payload to the final type
@@ -29016,6 +29178,9 @@ components:
2901629178
feeds.poll.vote_removed: '#/components/schemas/PollVoteRemovedFeedEvent'
2901729179
feeds.stories_feed.updated: '#/components/schemas/StoriesFeedUpdatedEvent'
2901829180
health.check: '#/components/schemas/HealthCheckEvent'
29181+
ingress.error: '#/components/schemas/IngressErrorEvent'
29182+
ingress.started: '#/components/schemas/IngressStartedEvent'
29183+
ingress.stopped: '#/components/schemas/IngressStoppedEvent'
2901929184
member.added: '#/components/schemas/MemberAddedEvent'
2902029185
member.removed: '#/components/schemas/MemberRemovedEvent'
2902129186
member.updated: '#/components/schemas/MemberUpdatedEvent'
@@ -29173,6 +29338,9 @@ components:
2917329338
- $ref: '#/components/schemas/FollowDeletedEvent'
2917429339
- $ref: '#/components/schemas/FollowUpdatedEvent'
2917529340
- $ref: '#/components/schemas/HealthCheckEvent'
29341+
- $ref: '#/components/schemas/IngressErrorEvent'
29342+
- $ref: '#/components/schemas/IngressStartedEvent'
29343+
- $ref: '#/components/schemas/IngressStoppedEvent'
2917629344
- $ref: '#/components/schemas/KickedUserEvent'
2917729345
- $ref: '#/components/schemas/MemberAddedEvent'
2917829346
- $ref: '#/components/schemas/MemberRemovedEvent'
@@ -29326,7 +29494,7 @@ components:
2932629494
type: apiKey
2932729495
info:
2932829496
title: Stream API
29329-
version: v214.2.0
29497+
version: v214.3.0
2933029498
openapi: 3.0.3
2933129499
paths:
2933229500
/api/v2/app:

openapi/moderation-clientside-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/moderation-clientside-api.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7766,7 +7766,7 @@ components:
77667766
type: apiKey
77677767
info:
77687768
title: Stream API
7769-
version: v214.2.0
7769+
version: v214.3.0
77707770
openapi: 3.0.3
77717771
paths:
77727772
/api/v2/moderation/appeal:

openapi/moderation-serverside-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/moderation-serverside-api.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9144,7 +9144,7 @@ components:
91449144
type: apiKey
91459145
info:
91469146
title: Stream API
9147-
version: v214.2.0
9147+
version: v214.3.0
91489148
openapi: 3.0.3
91499149
paths:
91509150
/api/v2/moderation/appeal:

0 commit comments

Comments
 (0)