From 403efd4ddcf1031d302ef463a5e8e61912008978 Mon Sep 17 00:00:00 2001
From: negue <eugen.bolz@gmail.com>
Date: Tue, 27 Aug 2019 18:33:27 +0200
Subject: [PATCH] add api doc

---
 website/server/controllers/api-v4/inbox.js | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/website/server/controllers/api-v4/inbox.js b/website/server/controllers/api-v4/inbox.js
index bb2163ad3f..d37eb62e35 100644
--- a/website/server/controllers/api-v4/inbox.js
+++ b/website/server/controllers/api-v4/inbox.js
@@ -79,6 +79,20 @@ api.clearMessages = {
  * @apiDescription Get the conversations for a user
  *
  * @apiSuccess {Array} data An array of inbox conversations
+ *
+ * @apiSuccessExample {json} Success-Response:
+ * {"success":true,"data":[
+ *    {
+ *       "_id":"8a9d461b-f5eb-4a16-97d3-c03380c422a3",
+ *       "user":"user display name",
+ *       "username":"some_user_name",
+ *       "timestamp":"12315123123",
+ *       "text":"last message of conversation",
+ *       "userStyles": {},
+ *       "contributor": {},
+ *       "count":1
+ *    }
+ * }
  */
 api.conversations = {
   method: 'GET',