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

fix(docs): correct apidoc param for task alias|id

Browse Source
This commit is contained in:
Blade Barringer
2016-06-16 12:55:56 -05:00
parent b7b61e6251
commit 5a3082bd88
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
website/server/controllers/api-v3/tasks.js
View File

@@ -254,7 +254,7 @@ api.getChallengeTasks = {
* @apiName GetTask * @apiName GetTask
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* *
* @apiSuccess {object} data The task object * @apiSuccess {object} data The task object
*/ */
@@ -288,7 +288,7 @@ api.getTask = {
* @apiName UpdateTask * @apiName UpdateTask
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* *
* @apiSuccess {object} data The updated task * @apiSuccess {object} data The updated task
*/ */
@@ -374,7 +374,7 @@ function _generateWebhookTaskData (task, direction, delta, stats, user) {
* @apiName ScoreTask * @apiName ScoreTask
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* @apiParam {string="up","down"} direction The direction for scoring the task * @apiParam {string="up","down"} direction The direction for scoring the task
* *
* @apiSuccess {object} data._tmp If an item was dropped it'll be returned in te _tmp object * @apiSuccess {object} data._tmp If an item was dropped it'll be returned in te _tmp object
@@ -457,7 +457,7 @@ api.scoreTask = {
* @apiName MoveTask * @apiName MoveTask
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* @apiParam {Number} position Query parameter - Where to move the task (-1 means push to bottom). First position is 0 * @apiParam {Number} position Query parameter - Where to move the task (-1 means push to bottom). First position is 0
* *
* @apiSuccess {array} data The new tasks order (user.tasksOrder.{task.type}s) * @apiSuccess {array} data The new tasks order (user.tasksOrder.{task.type}s)
@@ -510,7 +510,7 @@ api.moveTask = {
* @apiName AddChecklistItem * @apiName AddChecklistItem
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* *
* @apiSuccess {object} data The updated task * @apiSuccess {object} data The updated task
*/ */
@@ -558,7 +558,7 @@ api.addChecklistItem = {
* @apiName ScoreChecklistItem * @apiName ScoreChecklistItem
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* @apiParam {UUID} itemId The checklist item _id * @apiParam {UUID} itemId The checklist item _id
* *
* @apiSuccess {object} data The updated task * @apiSuccess {object} data The updated task
@@ -598,7 +598,7 @@ api.scoreCheckListItem = {
* @apiName UpdateChecklistItem * @apiName UpdateChecklistItem
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* @apiParam {UUID} itemId The checklist item _id * @apiParam {UUID} itemId The checklist item _id
* *
* @apiSuccess {object} data The updated task * @apiSuccess {object} data The updated task
@@ -650,7 +650,7 @@ api.updateChecklistItem = {
* @apiName RemoveChecklistItem * @apiName RemoveChecklistItem
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* @apiParam {UUID} itemId The checklist item _id * @apiParam {UUID} itemId The checklist item _id
* *
* @apiSuccess {object} data The updated task * @apiSuccess {object} data The updated task
@@ -700,7 +700,7 @@ api.removeChecklistItem = {
* @apiName AddTagToTask * @apiName AddTagToTask
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* @apiParam {UUID} tagId The tag id * @apiParam {UUID} tagId The tag id
* *
* @apiSuccess {object} data The updated task * @apiSuccess {object} data The updated task
@@ -741,7 +741,7 @@ api.addTagToTask = {
* @apiName RemoveTagFromTask * @apiName RemoveTagFromTask
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* @apiParam {UUID} tagId The tag id * @apiParam {UUID} tagId The tag id
* *
* @apiSuccess {object} data The updated task * @apiSuccess {object} data The updated task
@@ -840,7 +840,7 @@ api.unlinkAllTasks = {
* @apiName UnlinkOneTask * @apiName UnlinkOneTask
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* @apiParam {string} keep Query parameter - keep or remove * @apiParam {string} keep Query parameter - keep or remove
* *
* @apiSuccess {object} data An empty object * @apiSuccess {object} data An empty object
@@ -919,7 +919,7 @@ api.clearCompletedTodos = {
* @apiName DeleteTask * @apiName DeleteTask
* @apiGroup Task * @apiGroup Task
* *
* @apiParam {UUID|string} taskId The task _id or alias * @apiParam {string} taskId The task _id or alias
* *
* @apiSuccess {object} data An empty object * @apiSuccess {object} data An empty object
*/ */