Skip to content

Commit 5c8736f

Browse files
authored
WPB-21470 Updated OpenAPI docs for the PUT /conversations/:domain/:id/members endpoint (#4861)
1 parent 07aa11c commit 5c8736f

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

changelog.d/4-docs/WPB-21470

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Updated OpenAPI docs for the `PUT /conversations/:domain/:id/members` endpoint

libs/wire-api/src/Wire/API/Routes/Public/Galley/Conversation.hs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -835,7 +835,12 @@ type ConversationAPI =
835835
:<|> Named
836836
"replace-members-in-conversation"
837837
( Summary "Replace the members of a conversation."
838-
:> Description "This will add any members not already in the conversation, and remove any members not in the provided list except users that are associated via a user group."
838+
:> Description
839+
"This will add any members not already in the conversation, \
840+
\and remove any members not in the provided list except users that are associated via a user group. \
841+
\The given role in the request body will be applied to all added members. \
842+
\The roles of already existing members will not be changed \
843+
\even if these members are included in the request body and their role differs from the role provided in this request."
839844
:> From 'V13
840845
:> CanThrow ('ActionDenied 'AddConversationMember)
841846
:> CanThrow ('ActionDenied 'RemoveConversationMember)

0 commit comments

Comments
 (0)