From c072935e80fea9ca1849715eea6773eb43109c77 Mon Sep 17 00:00:00 2001 From: Alys Date: Sat, 30 Jun 2018 15:53:04 +1000 Subject: [PATCH] document the dueDate parameter for API task functions - partial fix for #8087 --- website/server/controllers/api-v3/tasks.js | 2 +- website/server/libs/taskManager.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/server/controllers/api-v3/tasks.js b/website/server/controllers/api-v3/tasks.js index 5cdb4618b8..1ccdcefcb9 100644 --- a/website/server/controllers/api-v3/tasks.js +++ b/website/server/controllers/api-v3/tasks.js @@ -273,7 +273,7 @@ api.createChallengeTasks = { * @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) [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 * diff --git a/website/server/libs/taskManager.js b/website/server/libs/taskManager.js index bac6ecc3fd..c65b1cdc52 100644 --- a/website/server/libs/taskManager.js +++ b/website/server/libs/taskManager.js @@ -148,7 +148,7 @@ export async function createTasks (req, res, options = {}) { * @param options.user The user 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.dueDate + * @param options.dueDate The date to use for computing the nextDue field for each returned task * @return The tasks found */ export async function getTasks (req, res, options = {}) {