Skip to content

Commit 6c25697

Browse files
Update OpenAPI spec
1 parent 1ba0722 commit 6c25697

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
@@ -9323,43 +9323,6 @@ paths:
93239323
$ref: '#/components/responses/Forbidden'
93249324
"404":
93259325
$ref: '#/components/responses/NotFound'
9326-
/api/v4/sharedchannels/{channel_id}/remotes:
9327-
get:
9328-
tags:
9329-
- channels
9330-
summary: Get remote clusters for a shared channel
9331-
description: |
9332-
Gets the remote clusters information for a shared channel.
9333-
9334-
__Minimum server version__: 10.10
9335-
9336-
##### Permissions
9337-
Must be authenticated and have the `read_channel` permission for the channel.
9338-
operationId: GetSharedChannelRemotes
9339-
parameters:
9340-
- name: channel_id
9341-
in: path
9342-
description: Channel GUID
9343-
required: true
9344-
schema:
9345-
type: string
9346-
responses:
9347-
"200":
9348-
description: Remote clusters retrieval successful
9349-
content:
9350-
application/json:
9351-
schema:
9352-
type: array
9353-
items:
9354-
$ref: '#/components/schemas/RemoteClusterInfo'
9355-
"400":
9356-
$ref: '#/components/responses/BadRequest'
9357-
"401":
9358-
$ref: '#/components/responses/Unauthorized'
9359-
"403":
9360-
$ref: '#/components/responses/Forbidden'
9361-
"404":
9362-
$ref: '#/components/responses/NotFound'
93639326
/api/v4/channels/{channel_id}/common_teams:
93649327
get:
93659328
tags:
@@ -19638,6 +19601,43 @@ paths:
1963819601
$ref: '#/components/responses/Unauthorized'
1963919602
"403":
1964019603
$ref: '#/components/responses/Forbidden'
19604+
/api/v4/sharedchannels/{channel_id}/remotes:
19605+
get:
19606+
tags:
19607+
- shared channels
19608+
summary: Get remote clusters for a shared channel
19609+
description: |
19610+
Gets the remote clusters information for a shared channel.
19611+
19612+
__Minimum server version__: 10.11
19613+
19614+
##### Permissions
19615+
Must be authenticated and have the `read_channel` permission for the channel.
19616+
operationId: GetSharedChannelRemotes
19617+
parameters:
19618+
- name: channel_id
19619+
in: path
19620+
description: Channel GUID
19621+
required: true
19622+
schema:
19623+
type: string
19624+
responses:
19625+
"200":
19626+
description: Remote clusters retrieval successful
19627+
content:
19628+
application/json:
19629+
schema:
19630+
type: array
19631+
items:
19632+
$ref: '#/components/schemas/RemoteClusterInfo'
19633+
"400":
19634+
$ref: '#/components/responses/BadRequest'
19635+
"401":
19636+
$ref: '#/components/responses/Unauthorized'
19637+
"403":
19638+
$ref: '#/components/responses/Forbidden'
19639+
"404":
19640+
$ref: '#/components/responses/NotFound'
1964119641
/api/v4/sharedchannels/users/{user_id}/can_dm/{other_user_id}:
1964219642
get:
1964319643
tags:
@@ -22175,8 +22175,8 @@ paths:
2217522175
first_page_ascending:
2217622176
summary: First page, ascending order
2217722177
value:
22178-
cursor: ""
2217922178
channel_id: 4xp9fdt77pncbef59f4k1qe83o
22179+
cursor: ""
2218022180
per_page: 100
2218122181
subsequent_page:
2218222182
summary: Subsequent page using cursor
@@ -22188,15 +22188,15 @@ paths:
2218822188
summary: Query with time range starting from specific time
2218922189
value:
2219022190
channel_id: 4xp9fdt77pncbef59f4k1qe83o
22191-
cursor: ""
2219222191
start_time: 1635638400000
22192+
cursor: ""
2219322193
per_page: 100
2219422194
descending_order:
2219522195
summary: Descending order from recent
2219622196
value:
22197-
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2219822197
cursor: ""
2219922198
sort_direction: desc
22199+
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2220022200
per_page: 100
2220122201
responses:
2220222202
"200":
@@ -22225,17 +22225,17 @@ paths:
2222522225
with_more_pages:
2222622226
summary: Response with more pages available
2222722227
value:
22228+
next_cursor:
22229+
cursor: MTphYmMxMjM6Y3JlYXRlX2F0OmZhbHNlOmZhbHNlOmFzYzoxNjM1NjM4NTAwMDAwOnBvc3RfaWRfMg
2222822230
posts:
22229-
post_id_1:
22230-
id: post_id_1
22231-
message: First post
22232-
create_at: 1635638400000
2223322231
post_id_2:
2223422232
id: post_id_2
2223522233
message: Second post
2223622234
create_at: 1635638500000
22237-
next_cursor:
22238-
cursor: MTphYmMxMjM6Y3JlYXRlX2F0OmZhbHNlOmZhbHNlOmFzYzoxNjM1NjM4NTAwMDAwOnBvc3RfaWRfMg
22235+
post_id_1:
22236+
id: post_id_1
22237+
message: First post
22238+
create_at: 1635638400000
2223922239
last_page:
2224022240
summary: Last page (no more results)
2224122241
value:

0 commit comments

Comments
 (0)