From f7b4d256572a10e52fb071e264954d6210173db3 Mon Sep 17 00:00:00 2001 From: Matteo Pagliazzi Date: Thu, 19 Nov 2020 19:40:26 +0100 Subject: [PATCH] update apidoc --- website/server/controllers/api-v3/challenges.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/server/controllers/api-v3/challenges.js b/website/server/controllers/api-v3/challenges.js index 1b35d6eb1f..aba26d8450 100644 --- a/website/server/controllers/api-v3/challenges.js +++ b/website/server/controllers/api-v3/challenges.js @@ -351,11 +351,15 @@ api.leaveChallenge = { * @apiGroup Challenge * @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. + * Returns 10 results per page. * * @apiSuccess {Object[]} challenges An array of challenges sorted with official * challenges first, followed by the challenges * 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 ChallengeArrayExample