Skip to content

Commit bbd6d6f

Browse files
committed
Update video openapi Spec
1 parent 7bcd03f commit bbd6d6f

36 files changed

+688
-202
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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12167,7 +12167,7 @@ components:
1216712167
type: apiKey
1216812168
info:
1216912169
title: Stream API
12170-
version: v200.1.0
12170+
version: v201.0.0
1217112171
openapi: 3.0.3
1217212172
paths:
1217312173
/app:

openapi/chat-openapi.json

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

openapi/chat-openapi.yaml

Lines changed: 26 additions & 4 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.channels.error
609+
default: export.users.error
610610
type: string
611611
x-stream-index: "003.002"
612612
required:
@@ -1266,12 +1266,28 @@ components:
12661266
- updated_at
12671267
- recording_external_storage
12681268
type: object
1269+
CampaignChannelMember:
1270+
nullable: true
1271+
properties:
1272+
channel_role:
1273+
type: string
1274+
x-stream-index: "002"
1275+
custom:
1276+
additionalProperties: {}
1277+
type: object
1278+
x-stream-index: "003"
1279+
user_id:
1280+
type: string
1281+
x-stream-index: "001"
1282+
required:
1283+
- user_id
1284+
type: object
12691285
CampaignChannelTemplate:
12701286
properties:
12711287
custom:
12721288
additionalProperties: {}
12731289
type: object
1274-
x-stream-index: "005"
1290+
x-stream-index: "006"
12751291
id:
12761292
type: string
12771293
x-stream-index: "002"
@@ -1281,10 +1297,16 @@ components:
12811297
maximum: 1000
12821298
type: array
12831299
x-stream-index: "003"
1300+
members_template:
1301+
items:
1302+
$ref: '#/components/schemas/CampaignChannelMember'
1303+
maximum: 1000
1304+
type: array
1305+
x-stream-index: "004"
12841306
team:
12851307
maxLength: 1000
12861308
type: string
1287-
x-stream-index: "004"
1309+
x-stream-index: "005"
12881310
type:
12891311
maxLength: 64
12901312
type: string
@@ -16802,7 +16824,7 @@ components:
1680216824
type: apiKey
1680316825
info:
1680416826
title: Stream API
16805-
version: v200.1.0
16827+
version: v201.0.0
1680616828
openapi: 3.0.3
1680716829
paths:
1680816830
/app:

openapi/clientside-api.json

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

openapi/clientside-api.yaml

Lines changed: 123 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1903,49 +1903,56 @@ components:
19031903
$ref: '#/components/schemas/Attachment'
19041904
title: Attachments
19051905
type: array
1906-
x-stream-index: "004"
1906+
x-stream-index: "005"
19071907
comment:
19081908
description: Text content of the comment
19091909
title: Comment
19101910
type: string
1911-
x-stream-index: "003"
1911+
x-stream-index: "004"
19121912
create_notification_activity:
19131913
description: Whether to create a notification activity for this comment
19141914
title: Create Notification Activity
19151915
type: boolean
1916-
x-stream-index: "008"
1916+
x-stream-index: "009"
19171917
custom:
19181918
additionalProperties: {}
19191919
description: Custom data for the comment
19201920
title: Custom Data
19211921
type: object
1922-
x-stream-index: "007"
1922+
x-stream-index: "008"
1923+
id:
1924+
description: Optional custom ID for the comment (max 255 characters). If
1925+
not provided, a UUID will be generated.
1926+
maxLength: 255
1927+
title: Comment ID
1928+
type: string
1929+
x-stream-index: "001"
19231930
mentioned_user_ids:
19241931
description: List of users mentioned in the reply
19251932
items:
19261933
type: string
19271934
maximum: 255
19281935
title: Mentioned User IDs
19291936
type: array
1930-
x-stream-index: "005"
1937+
x-stream-index: "006"
19311938
object_id:
19321939
description: ID of the object to comment on
19331940
title: Object ID
19341941
type: string
1935-
x-stream-index: "001"
1942+
x-stream-index: "002"
19361943
object_type:
19371944
description: Type of the object to comment on
19381945
title: Object Type
19391946
type: string
1940-
x-stream-index: "002"
1947+
x-stream-index: "003"
19411948
parent_id:
19421949
description: ID of parent comment for replies
19431950
title: Parent ID
19441951
type: string
1945-
x-stream-index: "006"
1952+
x-stream-index: "007"
19461953
skip_push:
19471954
type: boolean
1948-
x-stream-index: "009"
1955+
x-stream-index: "010"
19491956
required:
19501957
- object_id
19511958
- object_type
@@ -12255,48 +12262,44 @@ components:
1225512262
description: Client request
1225612263
nullable: true
1225712264
properties:
12258-
activity_selector_options:
12259-
additionalProperties: {}
12260-
type: object
12261-
x-stream-index: "006"
1226212265
data:
1226312266
$ref: '#/components/schemas/FeedInput'
1226412267
x-stream-index: "003"
1226512268
external_ranking:
1226612269
additionalProperties: {}
1226712270
type: object
12268-
x-stream-index: "007"
12271+
x-stream-index: "006"
1226912272
filter:
1227012273
additionalProperties: {}
1227112274
type: object
12272-
x-stream-index: "009"
12275+
x-stream-index: "008"
1227312276
followers_pagination:
1227412277
$ref: '#/components/schemas/PagerRequest'
12275-
x-stream-index: "011"
12278+
x-stream-index: "010"
1227612279
following_pagination:
1227712280
$ref: '#/components/schemas/PagerRequest'
12278-
x-stream-index: "012"
12281+
x-stream-index: "011"
1227912282
interest_weights:
1228012283
additionalProperties:
1228112284
format: float
1228212285
type: number
1228312286
type: object
12284-
x-stream-index: "008"
12287+
x-stream-index: "007"
1228512288
limit:
1228612289
format: int32
1228712290
maximum: 100
1228812291
minimum: 0
1228912292
type: integer
12290-
x-stream-index: "013.001"
12293+
x-stream-index: "012.001"
1229112294
member_pagination:
1229212295
$ref: '#/components/schemas/PagerRequest'
12293-
x-stream-index: "010"
12296+
x-stream-index: "009"
1229412297
next:
1229512298
type: string
12296-
x-stream-index: "013.002"
12299+
x-stream-index: "012.002"
1229712300
prev:
1229812301
type: string
12299-
x-stream-index: "013.003"
12302+
x-stream-index: "012.003"
1230012303
view:
1230112304
type: string
1230212305
x-stream-index: "005"
@@ -14287,7 +14290,7 @@ components:
1428714290
type: array
1428814291
x-stream-index: "001.002"
1428914292
type:
14290-
default: notification.thread_message_new
14293+
default: message.new
1429114294
type: string
1429214295
x-stream-index: "004.001"
1429314296
user:
@@ -21445,6 +21448,43 @@ components:
2144521448
- actions
2144621449
- flags_count
2144721450
type: object
21451+
RingCallRequest:
21452+
nullable: true
21453+
properties:
21454+
members_ids:
21455+
description: Members that should receive the ring. If no ids are provided,
21456+
all call members who are not already in the call will receive ring notifications.
21457+
items:
21458+
type: string
21459+
maximum: 25
21460+
title: Members IDs
21461+
type: array
21462+
x-stream-index: "003"
21463+
video:
21464+
description: Indicate if call should be video
21465+
title: Video
21466+
type: boolean
21467+
x-stream-index: "004"
21468+
title: RingCallRequest
21469+
type: object
21470+
RingCallResponse:
21471+
nullable: true
21472+
properties:
21473+
duration:
21474+
type: string
21475+
x-stream-index: "001.001"
21476+
members_ids:
21477+
description: List of members ringing notification was sent to
21478+
items:
21479+
type: string
21480+
title: Members IDs
21481+
type: array
21482+
x-stream-index: "002"
21483+
required:
21484+
- duration
21485+
- members_ids
21486+
title: RingCallResponse
21487+
type: object
2144821488
RingSettingsRequest:
2144921489
properties:
2145021490
auto_cancel_timeout_ms:
@@ -27818,7 +27858,7 @@ components:
2781827858
type: apiKey
2781927859
info:
2782027860
title: Stream API
27821-
version: v200.1.0
27861+
version: v201.0.0
2782227862
openapi: 3.0.3
2782327863
paths:
2782427864
/api/v2/app:
@@ -32233,7 +32273,7 @@ paths:
3223332273
Body or URL parameter
3223432274
title: Connection ID
3223532275
type: string
32236-
x-stream-index: "015.003"
32276+
x-stream-index: "014.003"
3223732277
requestBody:
3223832278
content:
3223932279
application/json:
@@ -35812,6 +35852,64 @@ paths:
3581235852
summary: Request permission
3581335853
tags:
3581435854
- product:video
35855+
/api/v2/video/call/{type}/{id}/ring:
35856+
post:
35857+
description: |
35858+
Sends a ring notification to the provided users who are not already in the call. All users should be members of the call
35859+
35860+
Sends events:
35861+
- call.ring
35862+
operationId: RingCall
35863+
parameters:
35864+
- in: path
35865+
name: type
35866+
required: true
35867+
schema:
35868+
description: The type of call
35869+
maxLength: 64
35870+
title: Type
35871+
type: string
35872+
writeOnly: true
35873+
x-stream-index: "001.001"
35874+
- in: path
35875+
name: id
35876+
required: true
35877+
schema:
35878+
description: Call ID
35879+
maxLength: 64
35880+
title: ID
35881+
type: string
35882+
writeOnly: true
35883+
x-stream-index: "001.002"
35884+
requestBody:
35885+
content:
35886+
application/json:
35887+
schema:
35888+
$ref: '#/components/schemas/RingCallRequest'
35889+
description: RingCallRequest
35890+
required: true
35891+
responses:
35892+
"201":
35893+
content:
35894+
application/json:
35895+
schema:
35896+
$ref: '#/components/schemas/RingCallResponse'
35897+
description: RingCallResponse
35898+
"400":
35899+
content:
35900+
application/json:
35901+
schema:
35902+
$ref: '#/components/schemas/APIError'
35903+
description: Bad request
35904+
"429":
35905+
content:
35906+
application/json:
35907+
schema:
35908+
$ref: '#/components/schemas/APIError'
35909+
description: Too many requests
35910+
summary: Ring Call Users
35911+
tags:
35912+
- product:video
3581535913
/api/v2/video/call/{type}/{id}/rtmp_broadcasts:
3581635914
post:
3581735915
description: |

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
@@ -7236,7 +7236,7 @@ components:
72367236
type: apiKey
72377237
info:
72387238
title: Stream API
7239-
version: v200.1.0
7239+
version: v201.0.0
72407240
openapi: 3.0.3
72417241
paths:
72427242
/api/v2/moderation/ban:

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
@@ -624,7 +624,7 @@ components:
624624
type: string
625625
x-stream-index: "002.001"
626626
type:
627-
default: export.bulk_image_moderation.error
627+
default: export.moderation_logs.error
628628
type: string
629629
x-stream-index: "003.002"
630630
required:
@@ -8488,7 +8488,7 @@ components:
84888488
type: apiKey
84898489
info:
84908490
title: Stream API
8491-
version: v200.1.0
8491+
version: v201.0.0
84928492
openapi: 3.0.3
84938493
paths:
84948494
/api/v2/moderation/ban:

0 commit comments

Comments
 (0)