Skip to content

Commit 30458de

Browse files
committed
Update video openapi Spec
1 parent fe16d83 commit 30458de

36 files changed

+8963
-1159
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: 110 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1384,13 +1384,13 @@ components:
13841384
x-stream-index: "013"
13851385
invites:
13861386
items:
1387-
$ref: '#/components/schemas/ChannelMember'
1387+
$ref: '#/components/schemas/ChannelMemberRequest'
13881388
maximum: 100
13891389
type: array
13901390
x-stream-index: "016"
13911391
members:
13921392
items:
1393-
$ref: '#/components/schemas/ChannelMember'
1393+
$ref: '#/components/schemas/ChannelMemberRequest'
13941394
maximum: 100
13951395
type: array
13961396
x-stream-index: "018"
@@ -1448,112 +1448,92 @@ components:
14481448
archived_at:
14491449
format: date-time
14501450
type: string
1451-
x-stream-index: "015"
1451+
x-stream-index: "021"
14521452
ban_expires:
1453-
description: Expiration date of the ban
14541453
format: date-time
1455-
title: Ban expires
14561454
type: string
1457-
x-stream-index: "013"
1455+
x-stream-index: "017"
14581456
banned:
1459-
description: Whether member is banned this channel or not
1460-
title: Banned
14611457
type: boolean
1462-
x-stream-index: "012"
1458+
x-stream-index: "016"
1459+
blocked:
1460+
type: boolean
1461+
x-stream-index: "029"
1462+
channel:
1463+
$ref: '#/components/schemas/DenormalizedChannelFields'
1464+
x-stream-index: "027"
14631465
channel_role:
1464-
description: Role of the member in the channel
1465-
title: Channel Role
14661466
type: string
1467-
x-stream-index: "018"
1467+
x-stream-index: "024"
14681468
created_at:
1469-
description: Date/time of creation
14701469
format: date-time
1471-
title: Created at
14721470
type: string
1473-
x-stream-index: "009"
1471+
x-stream-index: "012"
14741472
custom:
14751473
additionalProperties: {}
14761474
type: object
1477-
x-stream-index: "004"
1475+
x-stream-index: "006"
14781476
deleted_at:
14791477
format: date-time
14801478
type: string
1481-
x-stream-index: "011"
1479+
x-stream-index: "014"
14821480
deleted_messages:
14831481
items:
14841482
type: string
14851483
type: array
1486-
x-stream-index: "020"
1484+
x-stream-index: "030"
1485+
hidden:
1486+
type: boolean
1487+
x-stream-index: "028"
14871488
invite_accepted_at:
1488-
description: Date when invite was accepted
14891489
format: date-time
1490-
title: Invited accepted at
14911490
type: string
1492-
x-stream-index: "006"
1491+
x-stream-index: "009"
14931492
invite_rejected_at:
1494-
description: Date when invite was rejected
14951493
format: date-time
1496-
title: Invited rejected at
14971494
type: string
1498-
x-stream-index: "007"
1495+
x-stream-index: "010"
14991496
invited:
1500-
description: Whether member was invited or not
1501-
title: Invited
15021497
type: boolean
1503-
x-stream-index: "005"
1498+
x-stream-index: "008"
1499+
is_global_banned:
1500+
type: boolean
1501+
x-stream-index: "020"
15041502
is_moderator:
1505-
description: Whether member is channel moderator or not
1506-
title: Is moderator
15071503
type: boolean
1508-
x-stream-index: "003"
1504+
x-stream-index: "007"
15091505
notifications_muted:
15101506
type: boolean
1511-
x-stream-index: "019"
1507+
x-stream-index: "026"
15121508
pinned_at:
15131509
format: date-time
15141510
type: string
1515-
x-stream-index: "016"
1516-
role:
1517-
description: 'Permission level of the member in the channel (DEPRECATED:
1518-
use channel_role instead)'
1519-
enum:
1520-
- member
1521-
- moderator
1522-
- admin
1523-
- owner
1524-
title: Role
1525-
type: string
1526-
x-stream-index: "017"
1511+
x-stream-index: "022"
15271512
shadow_banned:
1528-
description: Whether member is shadow banned in this channel or not
1529-
title: Shadow banned
15301513
type: boolean
1531-
x-stream-index: "014"
1514+
x-stream-index: "019"
15321515
status:
15331516
type: string
1534-
x-stream-index: "008"
1517+
x-stream-index: "011"
15351518
updated_at:
1536-
description: Date/time of the last update
15371519
format: date-time
1538-
title: Updated at
15391520
type: string
1540-
x-stream-index: "010"
1521+
x-stream-index: "013"
15411522
user:
1542-
$ref: '#/components/schemas/UserResponse'
1543-
x-stream-index: "002"
1523+
$ref: '#/components/schemas/User'
1524+
x-stream-index: "005"
15441525
user_id:
1545-
title: User ID
15461526
type: string
1547-
x-stream-index: "001"
1527+
x-stream-index: "004"
15481528
required:
15491529
- custom
15501530
- created_at
15511531
- updated_at
15521532
- banned
15531533
- shadow_banned
1534+
- is_global_banned
15541535
- channel_role
15551536
- notifications_muted
1556-
title: Channel member
15571537
type: object
15581538
ChannelMemberLookup:
15591539
nullable: true
@@ -1592,6 +1572,29 @@ components:
15921572
- banned
15931573
- blocked
15941574
type: object
1575+
ChannelMemberRequest:
1576+
nullable: true
1577+
properties:
1578+
channel_role:
1579+
description: Role of the member in the channel
1580+
title: Channel Role
1581+
type: string
1582+
x-stream-index: "004"
1583+
custom:
1584+
additionalProperties: {}
1585+
type: object
1586+
x-stream-index: "003"
1587+
user:
1588+
$ref: '#/components/schemas/UserResponse'
1589+
x-stream-index: "002"
1590+
user_id:
1591+
title: User ID
1592+
type: string
1593+
x-stream-index: "001"
1594+
required:
1595+
- user_id
1596+
title: Channel member
1597+
type: object
15951598
ChannelMemberResponse:
15961599
properties:
15971600
channel_role:
@@ -1783,8 +1786,8 @@ components:
17831786
members:
17841787
description: List of channel members (max 100)
17851788
items:
1786-
$ref: '#/components/schemas/ChannelMember'
1787-
title: ChannelMembers
1789+
$ref: '#/components/schemas/ChannelMemberResponse'
1790+
title: Channel members
17881791
type: array
17891792
x-stream-index: "011"
17901793
message_count:
@@ -1874,11 +1877,11 @@ components:
18741877
x-stream-index: "001.012"
18751878
members:
18761879
items:
1877-
$ref: '#/components/schemas/ChannelMember'
1880+
$ref: '#/components/schemas/ChannelMemberResponse'
18781881
type: array
18791882
x-stream-index: "001.007"
18801883
membership:
1881-
$ref: '#/components/schemas/ChannelMember'
1884+
$ref: '#/components/schemas/ChannelMemberResponse'
18821885
x-stream-index: "001.008"
18831886
messages:
18841887
items:
@@ -1953,12 +1956,12 @@ components:
19531956
members:
19541957
description: List of channel members
19551958
items:
1956-
$ref: '#/components/schemas/ChannelMember'
1959+
$ref: '#/components/schemas/ChannelMemberResponse'
19571960
title: Members
19581961
type: array
19591962
x-stream-index: "007"
19601963
membership:
1961-
$ref: '#/components/schemas/ChannelMember'
1964+
$ref: '#/components/schemas/ChannelMemberResponse'
19621965
description: Current user membership object
19631966
title: Membership
19641967
x-stream-index: "008"
@@ -2668,6 +2671,44 @@ components:
26682671
required:
26692672
- enabled
26702673
type: object
2674+
DenormalizedChannelFields:
2675+
properties:
2676+
created_at:
2677+
type: string
2678+
x-stream-index: "001"
2679+
created_by_id:
2680+
type: string
2681+
x-stream-index: "008"
2682+
custom:
2683+
additionalProperties: {}
2684+
type: object
2685+
x-stream-index: "011"
2686+
disabled:
2687+
type: boolean
2688+
x-stream-index: "005"
2689+
frozen:
2690+
type: boolean
2691+
x-stream-index: "006"
2692+
id:
2693+
type: string
2694+
x-stream-index: "010"
2695+
last_message_at:
2696+
type: string
2697+
x-stream-index: "003"
2698+
member_count:
2699+
format: int32
2700+
type: integer
2701+
x-stream-index: "004"
2702+
team:
2703+
type: string
2704+
x-stream-index: "007"
2705+
type:
2706+
type: string
2707+
x-stream-index: "009"
2708+
updated_at:
2709+
type: string
2710+
x-stream-index: "002"
2711+
type: object
26712712
Device:
26722713
nullable: true
26732714
properties:
@@ -4111,7 +4152,7 @@ components:
41114152
members:
41124153
description: List of found members
41134154
items:
4114-
$ref: '#/components/schemas/ChannelMember'
4155+
$ref: '#/components/schemas/ChannelMemberResponse'
41154156
title: Members
41164157
type: array
41174158
x-stream-index: "001"
@@ -4657,7 +4698,7 @@ components:
46574698
type: array
46584699
x-stream-index: "001.002"
46594700
type:
4660-
default: notification.thread_message_new
4701+
default: message.new
46614702
type: string
46624703
x-stream-index: "004.001"
46634704
user:
@@ -7749,7 +7790,7 @@ components:
77497790
x-stream-index: "006.003"
77507791
members:
77517792
items:
7752-
$ref: '#/components/schemas/ChannelMember'
7793+
$ref: '#/components/schemas/ChannelMemberRequest'
77537794
maximum: 100
77547795
type: array
77557796
x-stream-index: "003"
@@ -10266,7 +10307,7 @@ components:
1026610307
add_members:
1026710308
description: List of user IDs to add to the channel
1026810309
items:
10269-
$ref: '#/components/schemas/ChannelMember'
10310+
$ref: '#/components/schemas/ChannelMemberRequest'
1027010311
maximum: 100
1027110312
title: Add members
1027210313
type: array
@@ -10283,7 +10324,7 @@ components:
1028310324
description: List of channel member role assignments. If any specified user
1028410325
is not part of the channel, the request will fail
1028510326
items:
10286-
$ref: '#/components/schemas/ChannelMember'
10327+
$ref: '#/components/schemas/ChannelMemberRequest'
1028710328
maximum: 100
1028810329
title: Assign roles
1028910330
type: array
@@ -10315,7 +10356,7 @@ components:
1031510356
invites:
1031610357
description: List of user IDs to invite to the channel
1031710358
items:
10318-
$ref: '#/components/schemas/ChannelMember'
10359+
$ref: '#/components/schemas/ChannelMemberRequest'
1031910360
maximum: 100
1032010361
title: Invites
1032110362
type: array
@@ -10362,7 +10403,7 @@ components:
1036210403
members:
1036310404
description: List of channel members
1036410405
items:
10365-
$ref: '#/components/schemas/ChannelMember'
10406+
$ref: '#/components/schemas/ChannelMemberResponse'
1036610407
title: Members
1036710408
type: array
1036810409
x-stream-index: "003"
@@ -12092,7 +12133,7 @@ components:
1209212133
type: apiKey
1209312134
info:
1209412135
title: Stream API
12095-
version: v198.32.0
12136+
version: v198.33.0
1209612137
openapi: 3.0.3
1209712138
paths:
1209812139
/app:

openapi/chat-openapi.json

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

0 commit comments

Comments
 (0)