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

update apidoc

Browse Source
This commit is contained in:
Matteo Pagliazzi
2020-11-19 19:40:26 +01:00
parent 284cfde935
commit f7b4d25657
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -351,11 +351,15 @@ api.leaveChallenge = {
* @apiGroup Challenge * @apiGroup Challenge
* @apiDescription Get challenges the user has access to. Includes public challenges, * @apiDescription Get challenges the user has access to. Includes public challenges,
* challenges belonging to the user's group, and challenges the user has already joined. * challenges belonging to the user's group, and challenges the user has already joined.
* Returns 10 results per page.
* *
* @apiSuccess {Object[]} challenges An array of challenges sorted with official * @apiSuccess {Object[]} challenges An array of challenges sorted with official
* challenges first, followed by the challenges * challenges first, followed by the challenges
* in order from newest to oldest. * in order from newest to oldest.
* *
* @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).
* @apiError (400) {BadRequest} queryPageInteger Page query parameter must be a positive integer
* @apiUse SuccessfulChallengeRequest * @apiUse SuccessfulChallengeRequest
* *
* @apiUse ChallengeArrayExample * @apiUse ChallengeArrayExample