Skip to content

Commit 320ffd9

Browse files
authored
Merge branch 'master' into master
2 parents 38f0854 + b6701db commit 320ffd9

File tree

1 file changed

+77
-52
lines changed

1 file changed

+77
-52
lines changed

site/static/mattermost-openapi-v4.yaml

Lines changed: 77 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1502,9 +1502,9 @@ paths:
15021502
put:
15031503
tags:
15041504
- users
1505-
summary: Update user active status
1505+
summary: Activate or deactivate a user
15061506
description: >
1507-
Update user active or inactive status.
1507+
Activate or deactivate a user's account. A deactivated user can't log into Mattermost or use it without being reactivated.
15081508

15091509

15101510
__Since server version 4.6, users using a SSO provider to login can be activated or deactivated with this endpoint. However, if their activation status in Mattermost does not reflect their status in the SSO provider, the next synchronization or login by that user will reset the activation status to that of their account in the SSO provider. Server versions 4.5 and before do not allow activation or deactivation of SSO users from this endpoint.__
@@ -1533,11 +1533,11 @@ paths:
15331533
properties:
15341534
active:
15351535
type: boolean
1536-
description: Use `true` to set the user active, `false` for inactive
1536+
description: Use `true` to activate the user or `false` to deactivate them
15371537
required: true
15381538
responses:
15391539
"200":
1540-
description: User active status update successful
1540+
description: User activation/deactivation update successful
15411541
content:
15421542
application/json:
15431543
schema:
@@ -8827,6 +8827,43 @@ paths:
88278827
$ref: '#/components/responses/Forbidden'
88288828
"404":
88298829
$ref: '#/components/responses/NotFound'
8830+
/api/v4/sharedchannels/{channel_id}/remotes:
8831+
get:
8832+
tags:
8833+
- shared channels
8834+
summary: Get remote clusters for a shared channel
8835+
description: |
8836+
Gets the remote clusters information for a shared channel.
8837+
8838+
__Minimum server version__: 10.11
8839+
8840+
##### Permissions
8841+
Must be authenticated and have the `read_channel` permission for the channel.
8842+
operationId: GetSharedChannelRemotes
8843+
parameters:
8844+
- name: channel_id
8845+
in: path
8846+
description: Channel GUID
8847+
required: true
8848+
schema:
8849+
type: string
8850+
responses:
8851+
"200":
8852+
description: Remote clusters retrieval successful
8853+
content:
8854+
application/json:
8855+
schema:
8856+
type: array
8857+
items:
8858+
$ref: '#/components/schemas/RemoteClusterInfo'
8859+
"400":
8860+
$ref: '#/components/responses/BadRequest'
8861+
"401":
8862+
$ref: '#/components/responses/Unauthorized'
8863+
"403":
8864+
$ref: '#/components/responses/Forbidden'
8865+
"404":
8866+
$ref: '#/components/responses/NotFound'
88308867
/api/v4/channels/{channel_id}/common_teams:
88318868
get:
88328869
tags:
@@ -18628,43 +18665,6 @@ paths:
1862818665
$ref: '#/components/responses/Unauthorized'
1862918666
"403":
1863018667
$ref: '#/components/responses/Forbidden'
18631-
/api/v4/sharedchannels/{channel_id}/remotes:
18632-
get:
18633-
tags:
18634-
- channels
18635-
summary: Get remote clusters for a shared channel
18636-
description: |
18637-
Gets the remote clusters information for a shared channel.
18638-
18639-
__Minimum server version__: 10.10
18640-
18641-
##### Permissions
18642-
Must be authenticated and have the `read_channel` permission for the channel.
18643-
operationId: GetSharedChannelRemotes
18644-
parameters:
18645-
- name: channel_id
18646-
in: path
18647-
description: Channel GUID
18648-
required: true
18649-
schema:
18650-
type: string
18651-
responses:
18652-
"200":
18653-
description: Remote clusters retrieval successful
18654-
content:
18655-
application/json:
18656-
schema:
18657-
type: array
18658-
items:
18659-
$ref: '#/components/schemas/RemoteClusterInfo'
18660-
"400":
18661-
$ref: '#/components/responses/BadRequest'
18662-
"401":
18663-
$ref: '#/components/responses/Unauthorized'
18664-
"403":
18665-
$ref: '#/components/responses/Forbidden'
18666-
"404":
18667-
$ref: '#/components/responses/NotFound'
1866818668
/api/v4/sharedchannels/users/{user_id}/can_dm/{other_user_id}:
1866918669
get:
1867018670
tags:
@@ -20801,9 +20801,9 @@ paths:
2080120801
subsequent_page:
2080220802
summary: Subsequent page using cursor
2080320803
value:
20804+
cursor: MTphYmMxMjM6Y3JlYXRlX2F0OmZhbHNlOmZhbHNlOmFzYzoxNjM1NzI0ODAwMDAwOnBvc3QxMjM
2080420805
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2080520806
per_page: 100
20806-
cursor: MTphYmMxMjM6Y3JlYXRlX2F0OmZhbHNlOmZhbHNlOmFzYzoxNjM1NzI0ODAwMDAwOnBvc3QxMjM
2080720807
time_range_query:
2080820808
summary: Query with time range starting from specific time
2080920809
value:
@@ -20814,9 +20814,9 @@ paths:
2081420814
descending_order:
2081520815
summary: Descending order from recent
2081620816
value:
20817-
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2081820817
cursor: ""
2081920818
sort_direction: desc
20819+
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2082020820
per_page: 100
2082120821
responses:
2082220822
"200":
@@ -20847,9 +20847,9 @@ paths:
2084720847
value:
2084820848
posts:
2084920849
post_id_1:
20850-
id: post_id_1
2085120850
message: First post
2085220851
create_at: 1635638400000
20852+
id: post_id_1
2085320853
post_id_2:
2085420854
id: post_id_2
2085520855
message: Second post
@@ -25734,12 +25734,12 @@ components:
2573425734
description: Additional attributes for the property field (options for select fields, visibility, etc.).
2573525735
additionalProperties: true
2573625736
example:
25737+
visibility: when_set
25738+
sortOrder: 1
2573725739
options:
2573825740
- color: '#ff0000'
2573925741
id: opt1
2574025742
name: High
25741-
visibility: when_set
25742-
sortOrder: 1
2574325743
PropertyFieldPatch:
2574425744
type: object
2574525745
properties:
@@ -29575,15 +29575,34 @@ components:
2957529575
term:
2957629576
type: string
2957729577
description: The search term to match against policy names or display names.
29578-
is_active:
29578+
type:
29579+
type: string
29580+
description: The type of policy (e.g., 'parent' or 'channel').
29581+
parent_id:
29582+
type: string
29583+
description: The ID of the parent policy to search within.
29584+
ids:
29585+
type: array
29586+
items:
29587+
type: string
29588+
description: List of policy IDs to filter by.
29589+
active:
2957929590
type: boolean
2958029591
description: Filter policies by active status.
29581-
page:
29582-
type: integer
29583-
description: The page number to return.
29584-
per_page:
29592+
include_children:
29593+
type: boolean
29594+
description: Whether to include child policies in the result.
29595+
cursor:
29596+
$ref: '#/components/schemas/AccessControlPolicyCursor'
29597+
limit:
2958529598
type: integer
29586-
description: The number of policies to return per page.
29599+
description: The maximum number of policies to return.
29600+
AccessControlPolicyCursor:
29601+
type: object
29602+
properties:
29603+
id:
29604+
type: string
29605+
description: The ID of the policy to start searching after.
2958729606
AccessControlPolicyTestResponse:
2958829607
type: object
2958929608
properties:
@@ -29656,12 +29675,18 @@ components:
2965629675
after:
2965729676
type: string
2965829677
description: The ID of the user to start the test after (for pagination).
29678+
channelId:
29679+
type: string
29680+
description: The channel ID to contextually test the expression against (required for channel admins).
2965929681
CELExpression:
2966029682
type: object
2966129683
properties:
2966229684
expression:
2966329685
type: string
2966429686
description: The CEL expression to visualize.
29687+
channelId:
29688+
type: string
29689+
description: The channel ID to contextually test the expression against (required for channel admins).
2966529690
VisualExpression:
2966629691
type: object
2966729692
properties:

0 commit comments

Comments
 (0)