Skip to content

Commit da47477

Browse files
Added API docs for /common_teams API (mattermost#33941)
* Added API docs for /common_teams API * removed error from known error list
1 parent afbd808 commit da47477

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

api/v4/source/channels.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2497,3 +2497,43 @@
24972497
$ref: "#/components/responses/Forbidden"
24982498
"404":
24992499
$ref: "#/components/responses/NotFound"
2500+
"/api/v4/channels/{channel_id}/common_teams":
2501+
get:
2502+
tags:
2503+
- channels
2504+
- group message
2505+
summary: Get common teams for members of a Group Message.
2506+
description: |
2507+
Gets all the common teams for all active members of a Group Message channel.
2508+
Returns empty list of no common teams are found.
2509+
2510+
__Minimum server version__: 9.1
2511+
2512+
##### Permissions
2513+
Must be authenticated and have the `read_channel` permission for the channel.
2514+
operationId: GetGroupMessageMembersCommonTeams
2515+
parameters:
2516+
- name: channel_id
2517+
in: path
2518+
description: Channel GUID
2519+
required: true
2520+
schema:
2521+
type: string
2522+
responses:
2523+
"200":
2524+
description: Common teams retrieval successful
2525+
content:
2526+
application/json:
2527+
schema:
2528+
type: array
2529+
items:
2530+
$ref: "#/components/schemas/Team"
2531+
"400":
2532+
$ref: "#/components/responses/BadRequest"
2533+
"401":
2534+
$ref: "#/components/responses/Unauthorized"
2535+
"403":
2536+
$ref: "#/components/responses/Forbidden"
2537+
"404":
2538+
$ref: "#/components/responses/NotFound"
2539+

server/scripts/vet-api-check.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ OUTPUT_EXCLUDING_IGNORED=$(echo "$OUTPUT" | grep -Fv \
1919
-e 'Cannot find /api/v4/channels/members/{user_id}/mark_read method: POST in OpenAPI 3 spec.' \
2020
-e 'Cannot find /api/v4/channels/members/{user_id}/mark_read method: POST in OpenAPI 3 spec.' \
2121
-e 'Cannot find /api/v4/channels/stats/member_count method: POST in OpenAPI 3 spec.' \
22-
-e 'Cannot find /api/v4/channels/{channel_id}/common_teams method: GET in OpenAPI 3 spec.' \
2322
-e 'Cannot find /api/v4/channels/{channel_id}/convert_to_channel method: POST in OpenAPI 3 spec.' \
2423
-e 'Cannot find /api/v4/client_perf method: POST in OpenAPI 3 spec.' \
2524
-e 'Cannot find /api/v4/cloud/products/selfhosted method: GET in OpenAPI 3 spec.' \

0 commit comments

Comments
 (0)