Skip to content

Commit e278a96

Browse files
authored
Update video openapi Spec (#1540)
2 parents cf10103 + 5b4b1b4 commit e278a96

36 files changed

+597
-117
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
@@ -12142,7 +12142,7 @@ components:
1214212142
type: apiKey
1214312143
info:
1214412144
title: Stream API
12145-
version: v213.21.0
12145+
version: v213.23.0
1214612146
openapi: 3.0.3
1214712147
paths:
1214812148
/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 & 2 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.bulk_image_moderation.error
610610
type: string
611611
x-stream-index: "003.002"
612612
required:
@@ -17257,7 +17257,7 @@ components:
1725717257
type: apiKey
1725817258
info:
1725917259
title: Stream API
17260-
version: v213.21.0
17260+
version: v213.23.0
1726117261
openapi: 3.0.3
1726217262
paths:
1726317263
/app:

openapi/clientside-api.json

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

openapi/clientside-api.yaml

Lines changed: 75 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10357,61 +10357,117 @@ components:
1035710357
- user_id
1035810358
type: object
1035910359
EnrichmentOptions:
10360+
description: Options to skip specific enrichments to improve performance. Default
10361+
is false (enrichments are included). Setting a field to true skips that enrichment.
1036010362
properties:
1036110363
enrich_own_followings:
10364+
description: 'Default: false. When true, includes fetching and enriching
10365+
own_followings (follows where activity author''s feeds follow current
10366+
user''s feeds).'
10367+
title: Enrich Own Followings
1036210368
type: boolean
1036310369
x-stream-index: "016"
1036410370
skip_activity:
10371+
description: 'Default: false. When true, skips all activity enrichments.'
10372+
title: Skip Activity
1036510373
type: boolean
1036610374
x-stream-index: "001"
1036710375
skip_activity_collections:
10376+
description: 'Default: false. When true, skips enriching collections on
10377+
activities.'
10378+
title: Skip Activity Collections
1036810379
type: boolean
1036910380
x-stream-index: "008"
1037010381
skip_activity_comments:
10382+
description: 'Default: false. When true, skips enriching comments on activities.'
10383+
title: Skip Activity Comments
1037110384
type: boolean
1037210385
x-stream-index: "005"
1037310386
skip_activity_current_feed:
10387+
description: 'Default: false. When true, skips enriching current_feed on
10388+
activities. Note: CurrentFeed is still computed for permission checks,
10389+
but enrichment is skipped.'
10390+
title: Skip Activity Current Feed
1037410391
type: boolean
1037510392
x-stream-index: "010"
1037610393
skip_activity_mentioned_users:
10394+
description: 'Default: false. When true, skips enriching mentioned users
10395+
on activities.'
10396+
title: Skip Activity Mentioned Users
1037710397
type: boolean
1037810398
x-stream-index: "006"
1037910399
skip_activity_own_bookmarks:
10400+
description: 'Default: false. When true, skips enriching own bookmarks on
10401+
activities.'
10402+
title: Skip Activity Own Bookmarks
1038010403
type: boolean
1038110404
x-stream-index: "004"
1038210405
skip_activity_parents:
10406+
description: 'Default: false. When true, skips enriching parent activities.'
10407+
title: Skip Activity Parents
1038310408
type: boolean
1038410409
x-stream-index: "002"
1038510410
skip_activity_poll:
10411+
description: 'Default: false. When true, skips enriching poll data on activities.'
10412+
title: Skip Activity Poll
1038610413
type: boolean
1038710414
x-stream-index: "007"
1038810415
skip_activity_reactions:
10416+
description: 'Default: false. When true, skips fetching and enriching latest
10417+
and own reactions on activities. Note: If reactions are already denormalized
10418+
in the database, they will still be included.'
10419+
title: Skip Activity Reactions
1038910420
type: boolean
1039010421
x-stream-index: "003"
1039110422
skip_activity_refresh_image_urls:
10423+
description: 'Default: false. When true, skips refreshing image URLs on
10424+
activities.'
10425+
title: Skip Activity Refresh Image URLs
1039210426
type: boolean
1039310427
x-stream-index: "009"
1039410428
skip_all:
10429+
description: 'Default: false. When true, skips all enrichments.'
10430+
title: Skip All
1039510431
type: boolean
1039610432
x-stream-index: "018"
1039710433
skip_feed_member_user:
10434+
description: 'Default: false. When true, skips enriching user data on feed
10435+
members.'
10436+
title: Skip Feed Member User
1039810437
type: boolean
1039910438
x-stream-index: "012"
1040010439
skip_followers:
10440+
description: 'Default: false. When true, skips fetching and enriching followers.
10441+
Note: If followers_pagination is explicitly provided, followers will be
10442+
fetched regardless of this setting.'
10443+
title: Skip Followers
1040110444
type: boolean
1040210445
x-stream-index: "013"
1040310446
skip_following:
10447+
description: 'Default: false. When true, skips fetching and enriching following.
10448+
Note: If following_pagination is explicitly provided, following will be
10449+
fetched regardless of this setting.'
10450+
title: Skip Following
1040410451
type: boolean
1040510452
x-stream-index: "014"
1040610453
skip_own_capabilities:
10454+
description: 'Default: false. When true, skips computing and including capabilities
10455+
for feeds.'
10456+
title: Skip Own Capabilities
1040710457
type: boolean
1040810458
x-stream-index: "017"
1040910459
skip_own_follows:
10460+
description: 'Default: false. When true, skips fetching and enriching own_follows
10461+
(follows where user''s feeds follow target feeds).'
10462+
title: Skip Own Follows
1041010463
type: boolean
1041110464
x-stream-index: "015"
1041210465
skip_pins:
10466+
description: 'Default: false. When true, skips enriching pinned activities.'
10467+
title: Skip Pins
1041310468
type: boolean
1041410469
x-stream-index: "011"
10470+
title: Enrichment Options
1041510471
type: object
1041610472
EntityCreatorResponse:
1041710473
properties:
@@ -22660,13 +22716,13 @@ components:
2266022716
x-stream-index: "009"
2266122717
image_content_params:
2266222718
$ref: '#/components/schemas/ImageContentParameters'
22663-
x-stream-index: "011"
22719+
x-stream-index: "012"
2266422720
image_rule_params:
2266522721
$ref: '#/components/schemas/ImageRuleParameters'
2266622722
x-stream-index: "004"
2266722723
text_content_params:
2266822724
$ref: '#/components/schemas/TextContentParameters'
22669-
x-stream-index: "010"
22725+
x-stream-index: "011"
2267022726
text_rule_params:
2267122727
$ref: '#/components/schemas/TextRuleParameters'
2267222728
x-stream-index: "003"
@@ -22675,22 +22731,25 @@ components:
2267522731
x-stream-index: "001"
2267622732
user_created_within_params:
2267722733
$ref: '#/components/schemas/UserCreatedWithinParameters'
22678-
x-stream-index: "013"
22734+
x-stream-index: "014"
2267922735
user_custom_property_params:
2268022736
$ref: '#/components/schemas/UserCustomPropertyParameters'
22681-
x-stream-index: "014"
22737+
x-stream-index: "015"
2268222738
user_flag_count_rule_params:
2268322739
$ref: '#/components/schemas/FlagCountRuleParameters'
2268422740
x-stream-index: "008"
2268522741
user_identical_content_count_params:
2268622742
$ref: '#/components/schemas/UserIdenticalContentCountParameters'
22687-
x-stream-index: "015"
22743+
x-stream-index: "010"
22744+
user_role_params:
22745+
$ref: '#/components/schemas/UserRoleParameters'
22746+
x-stream-index: "016"
2268822747
user_rule_params:
2268922748
$ref: '#/components/schemas/UserRuleParameters'
2269022749
x-stream-index: "006"
2269122750
video_content_params:
2269222751
$ref: '#/components/schemas/VideoContentParameters'
22693-
x-stream-index: "012"
22752+
x-stream-index: "013"
2269422753
video_rule_params:
2269522754
$ref: '#/components/schemas/VideoRuleParameters'
2269622755
x-stream-index: "005"
@@ -28162,6 +28221,15 @@ components:
2816228221
- online
2816328222
- blocked_user_ids
2816428223
type: object
28224+
UserRoleParameters:
28225+
properties:
28226+
operator:
28227+
type: string
28228+
x-stream-index: "001"
28229+
role:
28230+
type: string
28231+
x-stream-index: "002"
28232+
type: object
2816528233
UserRuleParameters:
2816628234
properties:
2816728235
max_age:
@@ -29159,7 +29227,7 @@ components:
2915929227
type: apiKey
2916029228
info:
2916129229
title: Stream API
29162-
version: v213.21.0
29230+
version: v213.23.0
2916329231
openapi: 3.0.3
2916429232
paths:
2916529233
/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: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6459,13 +6459,13 @@ components:
64596459
x-stream-index: "009"
64606460
image_content_params:
64616461
$ref: '#/components/schemas/ImageContentParameters'
6462-
x-stream-index: "011"
6462+
x-stream-index: "012"
64636463
image_rule_params:
64646464
$ref: '#/components/schemas/ImageRuleParameters'
64656465
x-stream-index: "004"
64666466
text_content_params:
64676467
$ref: '#/components/schemas/TextContentParameters'
6468-
x-stream-index: "010"
6468+
x-stream-index: "011"
64696469
text_rule_params:
64706470
$ref: '#/components/schemas/TextRuleParameters'
64716471
x-stream-index: "003"
@@ -6474,22 +6474,25 @@ components:
64746474
x-stream-index: "001"
64756475
user_created_within_params:
64766476
$ref: '#/components/schemas/UserCreatedWithinParameters'
6477-
x-stream-index: "013"
6477+
x-stream-index: "014"
64786478
user_custom_property_params:
64796479
$ref: '#/components/schemas/UserCustomPropertyParameters'
6480-
x-stream-index: "014"
6480+
x-stream-index: "015"
64816481
user_flag_count_rule_params:
64826482
$ref: '#/components/schemas/FlagCountRuleParameters'
64836483
x-stream-index: "008"
64846484
user_identical_content_count_params:
64856485
$ref: '#/components/schemas/UserIdenticalContentCountParameters'
6486-
x-stream-index: "015"
6486+
x-stream-index: "010"
6487+
user_role_params:
6488+
$ref: '#/components/schemas/UserRoleParameters'
6489+
x-stream-index: "016"
64876490
user_rule_params:
64886491
$ref: '#/components/schemas/UserRuleParameters'
64896492
x-stream-index: "006"
64906493
video_content_params:
64916494
$ref: '#/components/schemas/VideoContentParameters'
6492-
x-stream-index: "012"
6495+
x-stream-index: "013"
64936496
video_rule_params:
64946497
$ref: '#/components/schemas/VideoRuleParameters'
64956498
x-stream-index: "005"
@@ -7486,6 +7489,15 @@ components:
74867489
- invisible
74877490
title: UserResponse
74887491
type: object
7492+
UserRoleParameters:
7493+
properties:
7494+
operator:
7495+
type: string
7496+
x-stream-index: "001"
7497+
role:
7498+
type: string
7499+
x-stream-index: "002"
7500+
type: object
74897501
UserRuleParameters:
74907502
properties:
74917503
max_age:
@@ -7754,7 +7766,7 @@ components:
77547766
type: apiKey
77557767
info:
77567768
title: Stream API
7757-
version: v213.21.0
7769+
version: v213.23.0
77587770
openapi: 3.0.3
77597771
paths:
77607772
/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: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7600,13 +7600,13 @@ components:
76007600
x-stream-index: "009"
76017601
image_content_params:
76027602
$ref: '#/components/schemas/ImageContentParameters'
7603-
x-stream-index: "011"
7603+
x-stream-index: "012"
76047604
image_rule_params:
76057605
$ref: '#/components/schemas/ImageRuleParameters'
76067606
x-stream-index: "004"
76077607
text_content_params:
76087608
$ref: '#/components/schemas/TextContentParameters'
7609-
x-stream-index: "010"
7609+
x-stream-index: "011"
76107610
text_rule_params:
76117611
$ref: '#/components/schemas/TextRuleParameters'
76127612
x-stream-index: "003"
@@ -7615,22 +7615,25 @@ components:
76157615
x-stream-index: "001"
76167616
user_created_within_params:
76177617
$ref: '#/components/schemas/UserCreatedWithinParameters'
7618-
x-stream-index: "013"
7618+
x-stream-index: "014"
76197619
user_custom_property_params:
76207620
$ref: '#/components/schemas/UserCustomPropertyParameters'
7621-
x-stream-index: "014"
7621+
x-stream-index: "015"
76227622
user_flag_count_rule_params:
76237623
$ref: '#/components/schemas/FlagCountRuleParameters'
76247624
x-stream-index: "008"
76257625
user_identical_content_count_params:
76267626
$ref: '#/components/schemas/UserIdenticalContentCountParameters'
7627-
x-stream-index: "015"
7627+
x-stream-index: "010"
7628+
user_role_params:
7629+
$ref: '#/components/schemas/UserRoleParameters'
7630+
x-stream-index: "016"
76287631
user_rule_params:
76297632
$ref: '#/components/schemas/UserRuleParameters'
76307633
x-stream-index: "006"
76317634
video_content_params:
76327635
$ref: '#/components/schemas/VideoContentParameters'
7633-
x-stream-index: "012"
7636+
x-stream-index: "013"
76347637
video_rule_params:
76357638
$ref: '#/components/schemas/VideoRuleParameters'
76367639
x-stream-index: "005"
@@ -8878,6 +8881,15 @@ components:
88788881
- invisible
88798882
title: UserResponse
88808883
type: object
8884+
UserRoleParameters:
8885+
properties:
8886+
operator:
8887+
type: string
8888+
x-stream-index: "001"
8889+
role:
8890+
type: string
8891+
x-stream-index: "002"
8892+
type: object
88818893
UserRuleParameters:
88828894
properties:
88838895
max_age:
@@ -9132,7 +9144,7 @@ components:
91329144
type: apiKey
91339145
info:
91349146
title: Stream API
9135-
version: v213.21.0
9147+
version: v213.23.0
91369148
openapi: 3.0.3
91379149
paths:
91389150
/api/v2/moderation/appeal:

0 commit comments

Comments
 (0)