Skip to content

Commit 04b719c

Browse files
Update OpenAPI spec
1 parent 8010889 commit 04b719c

1 file changed

Lines changed: 46 additions & 46 deletions

File tree

site/static/mattermost-openapi-v4.yaml

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -9088,6 +9088,43 @@ paths:
90889088
$ref: '#/components/responses/Forbidden'
90899089
"404":
90909090
$ref: '#/components/responses/NotFound'
9091+
/api/v4/sharedchannels/{channel_id}/remotes:
9092+
get:
9093+
tags:
9094+
- channels
9095+
summary: Get remote clusters for a shared channel
9096+
description: |
9097+
Gets the remote clusters information for a shared channel.
9098+
9099+
__Minimum server version__: 10.10
9100+
9101+
##### Permissions
9102+
Must be authenticated and have the `read_channel` permission for the channel.
9103+
operationId: GetSharedChannelRemotes
9104+
parameters:
9105+
- name: channel_id
9106+
in: path
9107+
description: Channel GUID
9108+
required: true
9109+
schema:
9110+
type: string
9111+
responses:
9112+
"200":
9113+
description: Remote clusters retrieval successful
9114+
content:
9115+
application/json:
9116+
schema:
9117+
type: array
9118+
items:
9119+
$ref: '#/components/schemas/RemoteClusterInfo'
9120+
"400":
9121+
$ref: '#/components/responses/BadRequest'
9122+
"401":
9123+
$ref: '#/components/responses/Unauthorized'
9124+
"403":
9125+
$ref: '#/components/responses/Forbidden'
9126+
"404":
9127+
$ref: '#/components/responses/NotFound'
90919128
/api/v4/channels/{channel_id}/common_teams:
90929129
get:
90939130
tags:
@@ -19366,43 +19403,6 @@ paths:
1936619403
$ref: '#/components/responses/Unauthorized'
1936719404
"403":
1936819405
$ref: '#/components/responses/Forbidden'
19369-
/api/v4/sharedchannels/{channel_id}/remotes:
19370-
get:
19371-
tags:
19372-
- channels
19373-
summary: Get remote clusters for a shared channel
19374-
description: |
19375-
Gets the remote clusters information for a shared channel.
19376-
19377-
__Minimum server version__: 10.10
19378-
19379-
##### Permissions
19380-
Must be authenticated and have the `read_channel` permission for the channel.
19381-
operationId: GetSharedChannelRemotes
19382-
parameters:
19383-
- name: channel_id
19384-
in: path
19385-
description: Channel GUID
19386-
required: true
19387-
schema:
19388-
type: string
19389-
responses:
19390-
"200":
19391-
description: Remote clusters retrieval successful
19392-
content:
19393-
application/json:
19394-
schema:
19395-
type: array
19396-
items:
19397-
$ref: '#/components/schemas/RemoteClusterInfo'
19398-
"400":
19399-
$ref: '#/components/responses/BadRequest'
19400-
"401":
19401-
$ref: '#/components/responses/Unauthorized'
19402-
"403":
19403-
$ref: '#/components/responses/Forbidden'
19404-
"404":
19405-
$ref: '#/components/responses/NotFound'
1940619406
/api/v4/sharedchannels/users/{user_id}/can_dm/{other_user_id}:
1940719407
get:
1940819408
tags:
@@ -21940,29 +21940,29 @@ paths:
2194021940
first_page_ascending:
2194121941
summary: First page, ascending order
2194221942
value:
21943-
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2194421943
cursor: ""
2194521944
per_page: 100
21945+
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2194621946
subsequent_page:
2194721947
summary: Subsequent page using cursor
2194821948
value:
21949-
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2195021949
cursor: MTphYmMxMjM6Y3JlYXRlX2F0OmZhbHNlOmZhbHNlOmFzYzoxNjM1NzI0ODAwMDAwOnBvc3QxMjM
21950+
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2195121951
per_page: 100
2195221952
time_range_query:
2195321953
summary: Query with time range starting from specific time
2195421954
value:
2195521955
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2195621956
cursor: ""
21957-
per_page: 100
2195821957
start_time: 1635638400000
21958+
per_page: 100
2195921959
descending_order:
2196021960
summary: Descending order from recent
2196121961
value:
21962-
cursor: ""
21963-
sort_direction: desc
2196421962
channel_id: 4xp9fdt77pncbef59f4k1qe83o
21963+
cursor: ""
2196521964
per_page: 100
21965+
sort_direction: desc
2196621966
responses:
2196721967
"200":
2196821968
description: Posts retrieved successfully
@@ -21996,19 +21996,19 @@ paths:
2199621996
message: First post
2199721997
create_at: 1635638400000
2199821998
post_id_2:
21999+
create_at: 1635638500000
2199922000
id: post_id_2
2200022001
message: Second post
22001-
create_at: 1635638500000
2200222002
next_cursor:
2200322003
cursor: MTphYmMxMjM6Y3JlYXRlX2F0OmZhbHNlOmZhbHNlOmFzYzoxNjM1NjM4NTAwMDAwOnBvc3RfaWRfMg
2200422004
last_page:
2200522005
summary: Last page (no more results)
2200622006
value:
2200722007
posts:
2200822008
post_id_99:
22009+
id: post_id_99
2200922010
message: Last post
2201022011
create_at: 1635724800000
22011-
id: post_id_99
2201222012
"400":
2201322013
$ref: '#/components/responses/BadRequest'
2201422014
"401":
@@ -31668,11 +31668,11 @@ components:
3166831668
description: Team-specific reviewer configuration, keyed by team ID
3166931669
example:
3167031670
8guxic3sg7nijeu5dgxt1fh4ia:
31671-
ReviewerIds: []
3167231671
Enabled: true
31673-
u1ujk34a47gfxp856pdczs9gey:
3167431672
ReviewerIds: []
31673+
u1ujk34a47gfxp856pdczs9gey:
3167531674
Enabled: false
31675+
ReviewerIds: []
3167631676
required:
3167731677
- CommonReviewers
3167831678
- SystemAdminsAsReviewers

0 commit comments

Comments
 (0)