Performance/inbox paging (#11258)

* merge all changes to one commit of PR #11157 / #11226

* rename the new paged messages route

* rename event, move map-method to the Inbox schema, fix lint

* move `mapMessage`-call to `getUserInbox`

* revert schema.method back to a normal one
This commit is contained in:
negue
2019-07-15 11:25:22 +02:00
committed by Matteo Pagliazzi
parent d28e1708c5
commit c9a56e8f3e
12 changed files with 387 additions and 126 deletions

View File

@@ -73,7 +73,7 @@ api.clearMessages = {
};
/**
* @api {get} /inbox/conversations Get the conversations for a user
* @api {get} /api/v4/inbox/conversations Get the conversations for a user
* @apiName conversations
* @apiGroup Inbox
* @apiDescription Get the conversations for a user
@@ -93,4 +93,32 @@ api.conversations = {
},
};
/**
* @api {get} /api/v4/inbox/paged-messages Get inbox messages for a user
* @apiName GetInboxMessages
* @apiGroup Inbox
* @apiDescription Get inbox messages for a user. Entries already populated with the correct `sent` - information
*
* @apiParam (Query) {Number} page Load the messages of the selected Page - 10 Messages per Page
* @apiParam (Query) {GUID} conversation Loads only the messages of a conversation
*
* @apiSuccess {Array} data An array of inbox messages
*/
api.getInboxMessages = {
method: 'GET',
url: '/inbox/paged-messages',
middlewares: [authWithHeaders()],
async handler (req, res) {
const user = res.locals.user;
const page = req.query.page;
const conversation = req.query.conversation;
const userInbox = await inboxLib.getUserInbox(user, {
page, conversation, mapProps: true,
});
res.respond(200, userInbox);
},
};
module.exports = api;