Skip to content

Commit 1abe7f3

Browse files
Update OpenAPI spec
1 parent 65b72ee commit 1abe7f3

1 file changed

Lines changed: 45 additions & 45 deletions

File tree

site/static/mattermost-openapi-v4.yaml

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -9263,6 +9263,43 @@ paths:
92639263
$ref: '#/components/responses/Forbidden'
92649264
"404":
92659265
$ref: '#/components/responses/NotFound'
9266+
/api/v4/sharedchannels/{channel_id}/remotes:
9267+
get:
9268+
tags:
9269+
- channels
9270+
summary: Get remote clusters for a shared channel
9271+
description: |
9272+
Gets the remote clusters information for a shared channel.
9273+
9274+
__Minimum server version__: 10.10
9275+
9276+
##### Permissions
9277+
Must be authenticated and have the `read_channel` permission for the channel.
9278+
operationId: GetSharedChannelRemotes
9279+
parameters:
9280+
- name: channel_id
9281+
in: path
9282+
description: Channel GUID
9283+
required: true
9284+
schema:
9285+
type: string
9286+
responses:
9287+
"200":
9288+
description: Remote clusters retrieval successful
9289+
content:
9290+
application/json:
9291+
schema:
9292+
type: array
9293+
items:
9294+
$ref: '#/components/schemas/RemoteClusterInfo'
9295+
"400":
9296+
$ref: '#/components/responses/BadRequest'
9297+
"401":
9298+
$ref: '#/components/responses/Unauthorized'
9299+
"403":
9300+
$ref: '#/components/responses/Forbidden'
9301+
"404":
9302+
$ref: '#/components/responses/NotFound'
92669303
/api/v4/channels/{channel_id}/common_teams:
92679304
get:
92689305
tags:
@@ -19541,43 +19578,6 @@ paths:
1954119578
$ref: '#/components/responses/Unauthorized'
1954219579
"403":
1954319580
$ref: '#/components/responses/Forbidden'
19544-
/api/v4/sharedchannels/{channel_id}/remotes:
19545-
get:
19546-
tags:
19547-
- shared channels
19548-
summary: Get remote clusters for a shared channel
19549-
description: |
19550-
Gets the remote clusters information for a shared channel.
19551-
19552-
__Minimum server version__: 10.11
19553-
19554-
##### Permissions
19555-
Must be authenticated and have the `read_channel` permission for the channel.
19556-
operationId: GetSharedChannelRemotes
19557-
parameters:
19558-
- name: channel_id
19559-
in: path
19560-
description: Channel GUID
19561-
required: true
19562-
schema:
19563-
type: string
19564-
responses:
19565-
"200":
19566-
description: Remote clusters retrieval successful
19567-
content:
19568-
application/json:
19569-
schema:
19570-
type: array
19571-
items:
19572-
$ref: '#/components/schemas/RemoteClusterInfo'
19573-
"400":
19574-
$ref: '#/components/responses/BadRequest'
19575-
"401":
19576-
$ref: '#/components/responses/Unauthorized'
19577-
"403":
19578-
$ref: '#/components/responses/Forbidden'
19579-
"404":
19580-
$ref: '#/components/responses/NotFound'
1958119581
/api/v4/sharedchannels/users/{user_id}/can_dm/{other_user_id}:
1958219582
get:
1958319583
tags:
@@ -22115,8 +22115,8 @@ paths:
2211522115
first_page_ascending:
2211622116
summary: First page, ascending order
2211722117
value:
22118-
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2211922118
cursor: ""
22119+
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2212022120
per_page: 100
2212122121
subsequent_page:
2212222122
summary: Subsequent page using cursor
@@ -22127,17 +22127,17 @@ paths:
2212722127
time_range_query:
2212822128
summary: Query with time range starting from specific time
2212922129
value:
22130+
start_time: 1635638400000
2213022131
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2213122132
cursor: ""
22132-
start_time: 1635638400000
2213322133
per_page: 100
2213422134
descending_order:
2213522135
summary: Descending order from recent
2213622136
value:
22137-
channel_id: 4xp9fdt77pncbef59f4k1qe83o
22137+
per_page: 100
2213822138
cursor: ""
22139+
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2213922140
sort_direction: desc
22140-
per_page: 100
2214122141
responses:
2214222142
"200":
2214322143
description: Posts retrieved successfully
@@ -22181,9 +22181,9 @@ paths:
2218122181
value:
2218222182
posts:
2218322183
post_id_99:
22184-
id: post_id_99
2218522184
message: Last post
2218622185
create_at: 1635724800000
22186+
id: post_id_99
2218722187
"400":
2218822188
$ref: '#/components/responses/BadRequest'
2218922189
"401":
@@ -27577,12 +27577,12 @@ components:
2757727577
description: Additional attributes for the property field (options for select fields, visibility, etc.).
2757827578
additionalProperties: true
2757927579
example:
27580+
visibility: when_set
27581+
sortOrder: 1
2758027582
options:
2758127583
- color: '#ff0000'
2758227584
id: opt1
2758327585
name: High
27584-
sortOrder: 1
27585-
visibility: when_set
2758627586
PropertyFieldPatch:
2758727587
type: object
2758827588
properties:
@@ -31846,8 +31846,8 @@ components:
3184631846
Enabled: true
3184731847
ReviewerIds: []
3184831848
u1ujk34a47gfxp856pdczs9gey:
31849-
Enabled: false
3185031849
ReviewerIds: []
31850+
Enabled: false
3185131851
required:
3185231852
- CommonReviewers
3185331853
- SystemAdminsAsReviewers

0 commit comments

Comments
 (0)