Skip to content

Commit ee42cc4

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

36 files changed

+1523
-99
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: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4711,7 +4711,7 @@ components:
47114711
type: array
47124712
x-stream-index: "001.002"
47134713
type:
4714-
default: message.new
4714+
default: notification.thread_message_new
47154715
type: string
47164716
x-stream-index: "004.001"
47174717
user:
@@ -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.6.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: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -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.6.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: 199 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1192,7 +1192,8 @@ components:
11921192
type: string
11931193
x-stream-index: "011"
11941194
feeds:
1195-
description: List of feed IDs to add the activity to
1195+
description: List of feeds to add the activity to with a default max limit
1196+
of 25 feeds
11961197
items:
11971198
type: string
11981199
maximum: 255
@@ -1743,7 +1744,8 @@ components:
17431744
type: string
17441745
x-stream-index: "001.011"
17451746
feeds:
1746-
description: List of feed IDs to add the activity to
1747+
description: List of feeds to add the activity to with a default max limit
1748+
of 25 feeds
17471749
items:
17481750
type: string
17491751
maximum: 255
@@ -1948,7 +1950,12 @@ components:
19481950
description: Duration of the request
19491951
title: string
19501952
type: string
1951-
x-stream-index: "003.001"
1953+
x-stream-index: "004.001"
1954+
notification_created:
1955+
description: Whether a notification activity was successfully created
1956+
title: boolean
1957+
type: boolean
1958+
x-stream-index: "003"
19521959
reaction:
19531960
$ref: '#/components/schemas/FeedsReactionResponse'
19541961
description: The created or updated reaction
@@ -2036,7 +2043,12 @@ components:
20362043
x-stream-index: "001"
20372044
duration:
20382045
type: string
2039-
x-stream-index: "002.001"
2046+
x-stream-index: "003.001"
2047+
notification_created:
2048+
description: Whether a notification activity was successfully created
2049+
title: Notification Created
2050+
type: boolean
2051+
x-stream-index: "002"
20402052
required:
20412053
- comment
20422054
- duration
@@ -2133,7 +2145,12 @@ components:
21332145
x-stream-index: "001"
21342146
duration:
21352147
type: string
2136-
x-stream-index: "003.001"
2148+
x-stream-index: "004.001"
2149+
notification_created:
2150+
description: Whether a notification activity was successfully created
2151+
title: Notification Created
2152+
type: boolean
2153+
x-stream-index: "003"
21372154
reaction:
21382155
$ref: '#/components/schemas/FeedsReactionResponse'
21392156
description: The created reaction
@@ -13680,6 +13697,57 @@ components:
1368013697
- enable_dtx
1368113698
- bitrate
1368213699
type: object
13700+
IngressErrorEvent:
13701+
description: This event is sent when a critical error occurs that breaks the
13702+
streaming pipeline
13703+
nullable: true
13704+
properties:
13705+
call_cid:
13706+
type: string
13707+
x-stream-index: "002.001"
13708+
code:
13709+
description: Error code
13710+
title: string
13711+
type: string
13712+
x-stream-index: "006"
13713+
created_at:
13714+
format: date-time
13715+
type: number
13716+
x-stream-index: "001.002"
13717+
error:
13718+
description: Human-readable error message
13719+
title: string
13720+
type: string
13721+
x-stream-index: "005"
13722+
ingress_stream_id:
13723+
description: Unique identifier for the stream
13724+
title: string
13725+
type: string
13726+
x-stream-index: "003"
13727+
type:
13728+
default: ingress.error
13729+
description: 'The type of event: "ingress.error" in this case'
13730+
title: Event Type
13731+
type: string
13732+
x-stream-index: "001.001"
13733+
user_id:
13734+
description: User who was streaming
13735+
title: string
13736+
type: string
13737+
x-stream-index: "004"
13738+
required:
13739+
- type
13740+
- created_at
13741+
- call_cid
13742+
- ingress_stream_id
13743+
- user_id
13744+
- error
13745+
title: IngressErrorEvent
13746+
type: object
13747+
x-stream-event-call-type: true
13748+
x-stream-event-doc-group: call
13749+
x-stream-is-event: true
13750+
x-stream-ws-base-event-name: VideoEvent
1368313751
IngressSettingsRequest:
1368413752
properties:
1368513753
audio_encoding_options:
@@ -13747,6 +13815,106 @@ components:
1374713815
- height
1374813816
- fps
1374913817
type: object
13818+
IngressStartedEvent:
13819+
description: This event is sent when a user begins streaming into a call
13820+
nullable: true
13821+
properties:
13822+
call_cid:
13823+
type: string
13824+
x-stream-index: "002.001"
13825+
client_ip:
13826+
description: Client IP address
13827+
title: string
13828+
type: string
13829+
x-stream-index: "008"
13830+
client_name:
13831+
description: Streaming client software name (e.g., 'OBS Studio')
13832+
title: string
13833+
type: string
13834+
x-stream-index: "006"
13835+
created_at:
13836+
format: date-time
13837+
type: number
13838+
x-stream-index: "001.002"
13839+
ingress_stream_id:
13840+
description: Unique identifier for this stream
13841+
title: string
13842+
type: string
13843+
x-stream-index: "003"
13844+
publisher_type:
13845+
description: Streaming protocol (e.g., 'rtmps', 'srt', 'rtmp', 'rtsp')
13846+
title: string
13847+
type: string
13848+
x-stream-index: "005"
13849+
type:
13850+
default: ingress.started
13851+
description: 'The type of event: "ingress.started" in this case'
13852+
title: Event Type
13853+
type: string
13854+
x-stream-index: "001.001"
13855+
user_id:
13856+
description: User who started the stream
13857+
title: string
13858+
type: string
13859+
x-stream-index: "004"
13860+
version:
13861+
description: Client software version
13862+
title: string
13863+
type: string
13864+
x-stream-index: "007"
13865+
required:
13866+
- type
13867+
- created_at
13868+
- call_cid
13869+
- ingress_stream_id
13870+
- user_id
13871+
- publisher_type
13872+
title: IngressStartedEvent
13873+
type: object
13874+
x-stream-event-call-type: true
13875+
x-stream-event-doc-group: call
13876+
x-stream-is-event: true
13877+
x-stream-ws-base-event-name: VideoEvent
13878+
IngressStoppedEvent:
13879+
description: This event is sent when streaming stops due to user action or call
13880+
ended
13881+
nullable: true
13882+
properties:
13883+
call_cid:
13884+
type: string
13885+
x-stream-index: "002.001"
13886+
created_at:
13887+
format: date-time
13888+
type: number
13889+
x-stream-index: "001.002"
13890+
ingress_stream_id:
13891+
description: Unique identifier for the stream
13892+
title: string
13893+
type: string
13894+
x-stream-index: "003"
13895+
type:
13896+
default: ingress.stopped
13897+
description: 'The type of event: "ingress.stopped" in this case'
13898+
title: Event Type
13899+
type: string
13900+
x-stream-index: "001.001"
13901+
user_id:
13902+
description: User who was streaming
13903+
title: string
13904+
type: string
13905+
x-stream-index: "004"
13906+
required:
13907+
- type
13908+
- created_at
13909+
- call_cid
13910+
- ingress_stream_id
13911+
- user_id
13912+
title: IngressStoppedEvent
13913+
type: object
13914+
x-stream-event-call-type: true
13915+
x-stream-event-doc-group: call
13916+
x-stream-is-event: true
13917+
x-stream-ws-base-event-name: VideoEvent
1375013918
IngressVideoEncodingOptionsRequest:
1375113919
properties:
1375213920
layers:
@@ -23312,8 +23480,6 @@ components:
2331223480
type: boolean
2331323481
x-stream-index: "010"
2331423482
force_sql_v2_backend:
23315-
description: Force usage of SQL v2 search backend
23316-
title: Force SQL v2 Backend
2331723483
type: boolean
2331823484
x-stream-index: "011"
2331923485
limit:
@@ -23954,12 +24120,17 @@ components:
2395424120
properties:
2395524121
duration:
2395624122
type: string
23957-
x-stream-index: "002.001"
24123+
x-stream-index: "003.001"
2395824124
follow:
2395924125
$ref: '#/components/schemas/FollowResponse'
2396024126
description: The created follow relationship
2396124127
title: Follow
2396224128
x-stream-index: "001"
24129+
notification_created:
24130+
description: Whether a notification activity was successfully created
24131+
title: Notification Created
24132+
type: boolean
24133+
x-stream-index: "002"
2396324134
required:
2396424135
- follow
2396524136
- duration
@@ -28768,6 +28939,19 @@ components:
2876828939
- token
2876928940
title: WSAuthMessage
2877028941
type: object
28942+
WSCallEvent:
28943+
description: The discriminator object for all websocket call events, it maps
28944+
events' payload to the final type
28945+
discriminator:
28946+
mapping:
28947+
ingress.error: '#/components/schemas/IngressErrorEvent'
28948+
ingress.started: '#/components/schemas/IngressStartedEvent'
28949+
ingress.stopped: '#/components/schemas/IngressStoppedEvent'
28950+
propertyName: type
28951+
oneOf:
28952+
- $ref: '#/components/schemas/IngressErrorEvent'
28953+
- $ref: '#/components/schemas/IngressStartedEvent'
28954+
- $ref: '#/components/schemas/IngressStoppedEvent'
2877128955
WSClientEvent:
2877228956
description: The discriminator object for all websocket client events, it maps
2877328957
events' payload to the final type
@@ -29016,6 +29200,9 @@ components:
2901629200
feeds.poll.vote_removed: '#/components/schemas/PollVoteRemovedFeedEvent'
2901729201
feeds.stories_feed.updated: '#/components/schemas/StoriesFeedUpdatedEvent'
2901829202
health.check: '#/components/schemas/HealthCheckEvent'
29203+
ingress.error: '#/components/schemas/IngressErrorEvent'
29204+
ingress.started: '#/components/schemas/IngressStartedEvent'
29205+
ingress.stopped: '#/components/schemas/IngressStoppedEvent'
2901929206
member.added: '#/components/schemas/MemberAddedEvent'
2902029207
member.removed: '#/components/schemas/MemberRemovedEvent'
2902129208
member.updated: '#/components/schemas/MemberUpdatedEvent'
@@ -29173,6 +29360,9 @@ components:
2917329360
- $ref: '#/components/schemas/FollowDeletedEvent'
2917429361
- $ref: '#/components/schemas/FollowUpdatedEvent'
2917529362
- $ref: '#/components/schemas/HealthCheckEvent'
29363+
- $ref: '#/components/schemas/IngressErrorEvent'
29364+
- $ref: '#/components/schemas/IngressStartedEvent'
29365+
- $ref: '#/components/schemas/IngressStoppedEvent'
2917629366
- $ref: '#/components/schemas/KickedUserEvent'
2917729367
- $ref: '#/components/schemas/MemberAddedEvent'
2917829368
- $ref: '#/components/schemas/MemberRemovedEvent'
@@ -29326,7 +29516,7 @@ components:
2932629516
type: apiKey
2932729517
info:
2932829518
title: Stream API
29329-
version: v214.2.0
29519+
version: v214.6.0
2933029520
openapi: 3.0.3
2933129521
paths:
2933229522
/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.6.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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -863,7 +863,7 @@ components:
863863
type: string
864864
x-stream-index: "002.001"
865865
type:
866-
default: export.bulk_image_moderation.error
866+
default: export.moderation_logs.error
867867
type: string
868868
x-stream-index: "003.002"
869869
required:
@@ -9144,7 +9144,7 @@ components:
91449144
type: apiKey
91459145
info:
91469146
title: Stream API
9147-
version: v214.2.0
9147+
version: v214.6.0
91489148
openapi: 3.0.3
91499149
paths:
91509150
/api/v2/moderation/appeal:

0 commit comments

Comments
 (0)