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

Refactor api description with @apiParam groups to make it more explicit (#8919)

Browse Source 
* Refactor api description for auth.js with @apiParam groups

* Refactor apiDoc toward better consistency

* Fix missing groups for get requests

* Fix missing groups for other request methods
This commit is contained in:
Pavel Pletenev
2017-08-16 02:06:19 +03:00
committed by Sabe Jones
parent b27319313d
commit 8614f11a31
13 changed files with 188 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -43,8 +43,8 @@ let api = {};
* @apiName InviteToQuest
* @apiGroup Quest
*
* @apiParam {String} groupId The group _id (or 'party')
* @apiParam {String} questKey
* @apiParam (Path) {String} groupId The group _id (or 'party')
* @apiParam (Path) {String} questKey
*
* @apiSuccess {Object} data Quest object
*
@@ -158,7 +158,7 @@ api.inviteToQuest = {
* @apiName AcceptQuest
* @apiGroup Quest
*
* @apiParam {String} groupId The group _id (or 'party')
* @apiParam (Path) {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*
@@ -217,7 +217,7 @@ api.acceptQuest = {
* @apiName RejectQuest
* @apiGroup Quest
*
* @apiParam {String} groupId The group _id (or 'party')
* @apiParam (Path) {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*
@@ -277,7 +277,7 @@ api.rejectQuest = {
* @apiName ForceQuestStart
* @apiGroup Quest
*
* @apiParam {String} groupId The group _id (or 'party')
* @apiParam (Path) {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*
@@ -335,7 +335,7 @@ api.forceStart = {
* @apiName CancelQuest
* @apiGroup Quest
*
* @apiParam {String} groupId The group _id (or 'party')
* @apiParam (Path) {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*
@@ -389,7 +389,7 @@ api.cancelQuest = {
* @apiName AbortQuest
* @apiGroup Quest
*
* @apiParam {String} groupId The group _id (or 'party')
* @apiParam (Path) {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*
@@ -451,7 +451,7 @@ api.abortQuest = {
* @apiName LeaveQuest
* @apiGroup Quest
*
* @apiParam {String} groupId The group _id (or 'party')
* @apiParam (Path) {String} groupId The group _id (or 'party')
*
* @apiSuccess {Object} data Quest Object
*