krikkert/habitica
1
0
Fork 0
mirror of https://github.com/HabitRPG/habitica.git synced 2025-12-17 22:57:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

make corrections and improvements to apidocs (no code changes)

Browse Source
This commit is contained in:
Alys
2020-02-08 14:12:20 +10:00
parent 71cc313c9a
commit c5d0ff63a5
16 changed files with 116 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/server/controllers/api-v4/inbox.js
View File

@@ -77,7 +77,7 @@ api.clearMessages = {
* @api {get} /api/v4/inbox/conversations Get the conversations for a user
* @apiName conversations
* @apiGroup Inbox
* @apiDescription Get the conversations for a user
* @apiDescription Get the conversations for a user. This is for API v4 which must not be used in third-party tools. Use "Get inbox messages for a user" instead.
*
* @apiSuccess {Array} data An array of inbox conversations
*

4
website/server/controllers/api-v4/members.js
View File

@@ -5,8 +5,8 @@ const api = {};
/**
* @api {post} /api/v4/members/flag-private-message/:messageId Flag a private message
* @apiDescription An email and slack message are sent
* to the moderators about every flagged message.
* @apiDescription Moderators are notified about every flagged message, including the sender, recipient, and full content of the message.
* This route is for API v4 which must not be used in third-party tools as it can change without notice. There is no equivalent route in API v3.
* @apiName FlagPrivateMessage
* @apiGroup Member
*