Skip to content

Commit d43fd33

Browse files
Update OpenAPI spec
1 parent 0d5e981 commit d43fd33

File tree

1 file changed

+51
-7
lines changed

1 file changed

+51
-7
lines changed

site/static/mattermost-openapi-v4.yaml

Lines changed: 51 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5984,6 +5984,9 @@ paths:
59845984
type:
59855985
type: string
59865986
description: "'O' for a public channel, 'P' for a private channel"
5987+
managed_category_name:
5988+
type: string
5989+
description: The name of the managed category to assign this channel to. Requires an Enterprise license and the `EnableManagedChannelCategories` config setting to be enabled.
59875990
description: Channel object to be created
59885991
required: true
59895992
responses:
@@ -6728,6 +6731,9 @@ paths:
67286731
description: Enable or disable automatic message translation in the channel. Requires the auto-translation feature and appropriate channel permission. May be restricted for direct and group message channels by server configuration.
67296732
banner_info:
67306733
$ref: '#/components/schemas/ChannelBanner'
6734+
managed_category_name:
6735+
type: string
6736+
description: The name of the managed category to assign this channel to. Set to an empty string to clear. Requires an Enterprise license and the `EnableManagedChannelCategories` config setting to be enabled.
67316737
description: Channel patch object; include only the fields to update. At least one field must be provided.
67326738
required: true
67336739
responses:
@@ -7290,6 +7296,44 @@ paths:
72907296
$ref: '#/components/responses/Forbidden'
72917297
"404":
72927298
$ref: '#/components/responses/NotFound'
7299+
/api/v4/teams/{team_id}/channels/managed_categories:
7300+
get:
7301+
tags:
7302+
- channels
7303+
summary: Get managed category mappings
7304+
description: >
7305+
Returns a map of channel ID to managed category name for all channels the requesting user is a member of in the given team that have a managed category assigned.
7306+
7307+
7308+
Requires an Enterprise license and the `EnableManagedChannelCategories` config setting to be enabled.
7309+
7310+
7311+
##### Permissions
7312+
7313+
Must be authenticated.
7314+
7315+
operationId: GetManagedCategories
7316+
parameters:
7317+
- name: team_id
7318+
in: path
7319+
description: Team ID
7320+
required: true
7321+
schema:
7322+
type: string
7323+
responses:
7324+
"200":
7325+
description: Managed category mappings retrieved successfully
7326+
content:
7327+
application/json:
7328+
schema:
7329+
type: object
7330+
additionalProperties:
7331+
type: string
7332+
description: A map of channel ID to managed category name
7333+
"401":
7334+
$ref: '#/components/responses/Unauthorized'
7335+
"403":
7336+
$ref: '#/components/responses/Forbidden'
72937337
/api/v4/teams/{team_id}/channels/search:
72947338
post:
72957339
tags:
@@ -19325,12 +19369,12 @@ paths:
1932519369
/api/v4/sharedchannels/{channel_id}/remotes:
1932619370
get:
1932719371
tags:
19328-
- shared channels
19372+
- channels
1932919373
summary: Get remote clusters for a shared channel
1933019374
description: |
1933119375
Gets the remote clusters information for a shared channel.
1933219376

19333-
__Minimum server version__: 10.11
19377+
__Minimum server version__: 10.10
1933419378

1933519379
##### Permissions
1933619380
Must be authenticated and have the `read_channel` permission for the channel.
@@ -21897,8 +21941,8 @@ paths:
2189721941
summary: First page, ascending order
2189821942
value:
2189921943
channel_id: 4xp9fdt77pncbef59f4k1qe83o
21900-
per_page: 100
2190121944
cursor: ""
21945+
per_page: 100
2190221946
subsequent_page:
2190321947
summary: Subsequent page using cursor
2190421948
value:
@@ -21908,15 +21952,15 @@ paths:
2190821952
time_range_query:
2190921953
summary: Query with time range starting from specific time
2191021954
value:
21911-
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2191221955
cursor: ""
2191321956
start_time: 1635638400000
2191421957
per_page: 100
21958+
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2191521959
descending_order:
2191621960
summary: Descending order from recent
2191721961
value:
21918-
cursor: ""
2191921962
channel_id: 4xp9fdt77pncbef59f4k1qe83o
21963+
cursor: ""
2192021964
sort_direction: desc
2192121965
per_page: 100
2192221966
responses:
@@ -21952,9 +21996,9 @@ paths:
2195221996
message: First post
2195321997
create_at: 1635638400000
2195421998
post_id_2:
21999+
id: post_id_2
2195522000
message: Second post
2195622001
create_at: 1635638500000
21957-
id: post_id_2
2195822002
next_cursor:
2195922003
cursor: MTphYmMxMjM6Y3JlYXRlX2F0OmZhbHNlOmZhbHNlOmFzYzoxNjM1NjM4NTAwMDAwOnBvc3RfaWRfMg
2196022004
last_page:
@@ -31624,8 +31668,8 @@ components:
3162431668
description: Team-specific reviewer configuration, keyed by team ID
3162531669
example:
3162631670
8guxic3sg7nijeu5dgxt1fh4ia:
31627-
ReviewerIds: []
3162831671
Enabled: true
31672+
ReviewerIds: []
3162931673
u1ujk34a47gfxp856pdczs9gey:
3163031674
Enabled: false
3163131675
ReviewerIds: []

0 commit comments

Comments
 (0)