diff --git a/libs/wire-api/src/Wire/API/Routes/Public/Galley.hs b/libs/wire-api/src/Wire/API/Routes/Public/Galley.hs index 3681540a71e..c857122d75a 100644 --- a/libs/wire-api/src/Wire/API/Routes/Public/Galley.hs +++ b/libs/wire-api/src/Wire/API/Routes/Public/Galley.hs @@ -111,7 +111,8 @@ data Api routes = Api :> Get '[Servant.JSON] (Public.ConversationList ConvId), getConversations :: routes - :- Summary "Get all conversations (deprecated)" + :- Summary "Get all *local* conversations." + :> Description "Will not return remote conversations (will eventually be deprecated in favour of list-conversations)" :> ZUser :> "conversations" :> QueryParam' @@ -139,6 +140,7 @@ data Api routes = Api listConversations :: routes :- Summary "Get all conversations (also returns remote conversations)" + :> Description "Like GET /conversations, but allows specifying a list of remote conversations in its request body. Will return all or the requested qualified conversations, including remote ones. WIP: Size parameter is not yet honoured for remote conversations." :> ZUser :> "list-conversations" :> ReqBody '[Servant.JSON] Public.ListConversations