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

document the dueDate parameter for API task functions - partial fix for #8087

Browse Source
This commit is contained in:
Alys
2018-06-30 15:53:04 +10:00
parent 54e49ca3b9
commit c072935e80
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -273,7 +273,7 @@ api.createChallengeTasks = {
* @apiGroup Task * @apiGroup Task
* *
* @apiParam (Query) {String="habits","dailys","todos","rewards","completedTodos"} type Optional query parameter to return just a type of tasks. By default all types will be returned except completed todos that must be requested separately. The "completedTodos" type returns only the 30 most recently completed. * @apiParam (Query) {String="habits","dailys","todos","rewards","completedTodos"} type Optional query parameter to return just a type of tasks. By default all types will be returned except completed todos that must be requested separately. The "completedTodos" type returns only the 30 most recently completed.
* @apiParam (Query) [dueDate] * @apiParam (Query) [dueDate] type Optional date to use for computing the nextDue field for each returned task.
* *
* @apiSuccess {Array} data An array of tasks * @apiSuccess {Array} data An array of tasks
* *

2
website/server/libs/taskManager.js
View File

@@ -148,7 +148,7 @@ export async function createTasks (req, res, options = {}) {
* @param options.user The user that these tasks belong to * @param options.user The user that these tasks belong to
* @param options.challenge The challenge that these tasks belong to * @param options.challenge The challenge that these tasks belong to
* @param options.group The group that these tasks belong to * @param options.group The group that these tasks belong to
* @param options.dueDate * @param options.dueDate The date to use for computing the nextDue field for each returned task
* @return The tasks found * @return The tasks found
*/ */
export async function getTasks (req, res, options = {}) { export async function getTasks (req, res, options = {}) {