descriptions

wireapp · Jun 17, 2021 · a776d6d · a776d6d
1 parent 599f56e
commit a776d6d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git 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