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

7837-Update API Docs (#7839)

Browse Source 
* Updated API Docs for api-v3

* Updated API Docs for top-level

* Updates relating to @crookedneighbor comments

* Updated type and field of 'to' param.
This commit is contained in:
Ryan Castner
2016-07-27 19:48:03 -04:00
committed by Blade Barringer
parent 795ea8ba80
commit 7c579bf850
17 changed files with 190 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
website/server/controllers/api-v3/quests.js
View File

@@ -34,8 +34,8 @@ let api = {};
* @apiName InviteToQuest
* @apiGroup Group
*
* @apiParam {string} groupId The group _id (or 'party')
* @apiParam {string} questKey
* @apiParam {String} groupId The group _id (or 'party')
* @apiParam {String} questKey
*
* @apiSuccess {Object} data Quest object
*/
@@ -145,7 +145,7 @@ api.inviteToQuest = {
* @apiName AcceptQuest
* @apiGroup Group
*
* @apiParam {string} groupId The group _id (or 'party')
* @apiParam {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*/
@@ -202,7 +202,7 @@ api.acceptQuest = {
* @apiName RejectQuest
* @apiGroup Group
*
* @apiParam {string} groupId The group _id (or 'party')
* @apiParam {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*/
@@ -261,7 +261,7 @@ api.rejectQuest = {
* @apiName ForceQuestStart
* @apiGroup Group
*
* @apiParam {string} groupId The group _id (or 'party')
* @apiParam {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*/
@@ -313,7 +313,7 @@ api.forceStart = {
* @apiName CancelQuest
* @apiGroup Group
*
* @apiParam {string} groupId The group _id (or 'party')
* @apiParam {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*/
@@ -362,7 +362,7 @@ api.cancelQuest = {
* @apiName AbortQuest
* @apiGroup Group
*
* @apiParam {string} groupId The group _id (or 'party')
* @apiParam {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*/
@@ -415,7 +415,7 @@ api.abortQuest = {
* @apiName LeaveQuest
* @apiGroup Group
*
* @apiParam {string} groupId The group _id (or 'party')
* @apiParam {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*/