sudoxreboot/habitica
1
0
Fork 0
mirror of https://github.com/sudoxnym/habitica.git synced 2026-05-22 05:38:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

APIDoc update for Tasks: fixes #10943 (#11594)

Browse source 
* Adding monthly and yearly to the frequency parameter.

* Adjusting frequency description to be more accurate.

* Adding missing fields: daysOfMonth and weeksOfMonth.

* Adjusting line length to meet lint standards.
This commit is contained in:
Jonathan Duncan 2019-12-13 06:18:02 -07:00 committed by Matteo Pagliazzi
parent a49f95e1a5
commit a45b04b1cf
1 changed files with 30 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
website/server/controllers/api-v3/tasks.js
View file

@ -76,10 +76,12 @@ const requiredGroupFields = '_id leader tasksOrder name';
* include: a UUID, startDate and time.
* For example {"id":"ed427623-9a69-4aac-9852-13deb9c190c3",
* "startDate":"1/16/17","time":"1/16/17" }
* @apiParam (Body) {String="weekly","daily"} [frequency=weekly] Value "weekly" enables
* "On days of the week", value
* "daily" enables "EveryX Days".
* Only valid for type "daily".
* @apiParam (Body) {String="daily","weekly","monthly","yearly"} [frequency=weekly] Values "weekly"
* and "monthly" enable use of the "repeat" field.
* All frequency values enable use of the "everyX" field.
* Value "monthly" enables use of the "weeksOfMonth" and
* "daysOfMonth" fields.
* Frequency is only valid for type "daily".
* @apiParam (Body) {String} [repeat=true] List of objects for days of the week,
* Days that are true will be repeated upon.
* Only valid for type "daily". Any days not specified
@ -92,6 +94,10 @@ const requiredGroupFields = '_id leader tasksOrder name';
* task is available again.
* @apiParam (Body) {Number} [streak=0] Number of days that the task has consecutively
* been checked off. Only valid for type "daily"
* @apiParam (Body) {Integer[]} daysOfMonth Array of integers.
* Only valid for type "daily"
* @apiParam (Body) {Integer[]} weeksOfMonth Array of integers.
* Only valid for type "daily"
* @apiParam (Body) {Date} [startDate] Date when the task will first become available.
* Only valid for type "daily"
* @apiParam (Body) {Boolean} [up=true] Only valid for type "habit"
@ -240,10 +246,12 @@ api.createUserTasks = {
* include: a UUID, startDate and time.
* For example {"id":"ed427623-9a69-4aac-9852-13deb9c190c3",
* "startDate":"1/16/17","time":"1/16/17" }
* @apiParam (Body) {String="weekly","daily"} [frequency=weekly] Value "weekly" enables
* "On days of the week", value
* "daily" enables "EveryX Days".
* Only valid for type "daily".
* @apiParam (Body) {String="daily","weekly","monthly","yearly"} [frequency=weekly] Values "weekly"
* and "monthly" enable use of the "repeat" field.
* All frequency values enable use of the "everyX" field.
* Value "monthly" enables use of the "weeksOfMonth" and
* "daysOfMonth" fields.
* Frequency is only valid for type "daily".
* @apiParam (Body) {String} [repeat=true] List of objects for days of the week,
* Days that are true will be repeated upon.
* Only valid for type "daily". Any days not
@ -255,6 +263,10 @@ api.createUserTasks = {
* of days until this daily task is available again.
* @apiParam (Body) {Number} [streak=0] Number of days that the task has consecutively
* been checked off. Only valid for type "daily"
* @apiParam (Body) {Integer[]} daysOfMonth Array of integers.
* Only valid for type "daily"
* @apiParam (Body) {Integer[]} weeksOfMonth Array of integers.
* Only valid for type "daily"
* @apiParam (Body) {Date} [startDate] Date when the task will first become available.
* Only valid for type "daily"
* @apiParam (Body) {Boolean} [up=true] Only valid for type "habit" If true,
@ -544,10 +556,12 @@ api.getTask = {
* Easy, Medium, Hard.
* @apiParam (Body) {String[]} [reminders] Array of reminders, each an object that must include:
* a UUID, startDate and time.
* @apiParam (Body) {String="weekly","daily"} [frequency=weekly] Value "weekly" enables "On days
* of the week", value "daily"
* enables "EveryX Days".
* Only valid for type "daily".
* @apiParam (Body) {String="daily","weekly","monthly","yearly"} [frequency=weekly] Values "weekly"
* and "monthly" enable use of the "repeat" field.
* All frequency values enable use of the "everyX" field.
* Value "monthly" enables use of the "weeksOfMonth" and
* "daysOfMonth" fields.
* Frequency is only valid for type "daily".
* @apiParam (Body) {String} [repeat=true] List of objects for days of the week, Days that
* are true will be repeated upon. Only valid for type
* "daily". Any days not specified will be marked as true.
@ -558,6 +572,10 @@ api.getTask = {
* of days until this daily task is available again.
* @apiParam (Body) {Number} [streak=0] Number of days that the task has consecutively
* been checked off. Only valid for type "daily",
* @apiParam (Body) {Integer[]} daysOfMonth Array of integers.
* Only valid for type "daily"
* @apiParam (Body) {Integer[]} weeksOfMonth Array of integers.
* Only valid for type "daily"
* @apiParam (Body) {Date} [startDate] Date when the task will first become available.
* Only valid for type "daily".
* @apiParam (Body) {Boolean} [up=true] Only valid for type "habit" If true, enables