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

docs(get user challenges): document all query parameters for the GET /challenges/user API route

Browse Source
This commit is contained in:
Matteo Pagliazzi
2020-11-28 19:32:08 +01:00
parent 496950e97d
commit 103b4cb8a8
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
website/server/controllers/api-v3/challenges.js
View File

@@ -359,6 +359,17 @@ api.leaveChallenge = {
* *
* @apiParam (Query) {Number} page This parameter can be used to specify the page number * @apiParam (Query) {Number} page This parameter can be used to specify the page number
for the user challenges result (the initial page is number 0). for the user challenges result (the initial page is number 0).
* @apiParam (Query) {String} [member] If set to `true` it limits results to challenges where the
user is a member.
* @apiParam (Query) {String} [owned] If set to `owned` it limits results to challenges owned
by the user. If set to `not_owned` it limits results
to challenges not owned by the user.
* @apiParam (Query) {String} [search] Optional query parameter to filter results to challenges
that include (even partially) the search query parameter
in the name or description.
* @apiParam (Query) {String} [categories] Optional comma separated list of categories.
If set it limits results to challenges that are part
of the given categories.
* @apiError (400) {BadRequest} queryPageInteger Page query parameter must be a positive integer * @apiError (400) {BadRequest} queryPageInteger Page query parameter must be a positive integer
* @apiUse SuccessfulChallengeRequest * @apiUse SuccessfulChallengeRequest
* *