From 0bf7858d53bc8e877a7bf4c69679e277922401cf Mon Sep 17 00:00:00 2001 From: Alys Date: Sat, 11 Jun 2016 08:15:07 +1000 Subject: [PATCH] Fix apidocs error for /api/v3/challenges/group/:groupId. Change various descriptions to imperative mood e.g., change "Sets lastCron" to "Set lastCron" --- website/server/controllers/api-v3/challenges.js | 6 +++--- website/server/controllers/api-v3/debug.js | 2 +- website/server/controllers/api-v3/quests.js | 4 ++-- website/server/controllers/api-v3/user.js | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/website/server/controllers/api-v3/challenges.js b/website/server/controllers/api-v3/challenges.js index 652fcc76d8..b4173fa378 100644 --- a/website/server/controllers/api-v3/challenges.js +++ b/website/server/controllers/api-v3/challenges.js @@ -111,7 +111,7 @@ api.createChallenge = { }; /** - * @api {post} /api/v3/challenges/:challengeId/join Joins a challenge + * @api {post} /api/v3/challenges/:challengeId/join Join a challenge * @apiVersion 3.0.0 * @apiName JoinChallenge * @apiGroup Challenge @@ -158,7 +158,7 @@ api.joinChallenge = { }; /** - * @api {post} /api/v3/challenges/:challengeId/leave Leaves a challenge + * @api {post} /api/v3/challenges/:challengeId/leave Leave a challenge * @apiVersion 3.0.0 * @apiName LeaveChallenge * @apiGroup Challenge @@ -241,7 +241,7 @@ api.getUserChallenges = { }; /** - * @api {get} /api/v3/challenges/group/group:Id Get challenges for a group + * @api {get} /api/v3/challenges/group/:groupId Get challenges for a group * @apiDescription Get challenges that the user is a member, public challenges and the ones from the user's groups. * @apiVersion 3.0.0 * @apiName GetGroupChallenges diff --git a/website/server/controllers/api-v3/debug.js b/website/server/controllers/api-v3/debug.js index 696505551d..8533d995ff 100644 --- a/website/server/controllers/api-v3/debug.js +++ b/website/server/controllers/api-v3/debug.js @@ -55,7 +55,7 @@ api.addHourglass = { }; /** - * @api {post} /api/v3/debug/set-cron Sets lastCron for user + * @api {post} /api/v3/debug/set-cron Set lastCron for user * @apiDescription Only available in development mode. * @apiVersion 3.0.0 * @apiName setCron diff --git a/website/server/controllers/api-v3/quests.js b/website/server/controllers/api-v3/quests.js index 56fabbbd34..cf9409e86d 100644 --- a/website/server/controllers/api-v3/quests.js +++ b/website/server/controllers/api-v3/quests.js @@ -301,7 +301,7 @@ api.forceStart = { }; /** - * @api {post} /api/v3/groups/:groupId/quests/cancel Cancels a quest that is not active + * @api {post} /api/v3/groups/:groupId/quests/cancel Cancel a quest that is not active * @apiVersion 3.0.0 * @apiName CancelQuest * @apiGroup Group @@ -403,7 +403,7 @@ api.abortQuest = { }; /** - * @api {post} /api/v3/groups/:groupId/quests/leave Leaves the active quest + * @api {post} /api/v3/groups/:groupId/quests/leave Leave the active quest * @apiVersion 3.0.0 * @apiName LeaveQuest * @apiGroup Group diff --git a/website/server/controllers/api-v3/user.js b/website/server/controllers/api-v3/user.js index 64287811c7..34a64f4975 100644 --- a/website/server/controllers/api-v3/user.js +++ b/website/server/controllers/api-v3/user.js @@ -859,7 +859,7 @@ api.userPurchaseHourglass = { }; /** -* @api {post} /api/v3/user/read-card/:cardType Reads a card +* @api {post} /api/v3/user/read-card/:cardType Read a card * @apiVersion 3.0.0 * @apiName UserReadCard * @apiGroup User @@ -1329,7 +1329,7 @@ api.userReset = { }; /** -* @api {post} /api/v3/user/custom-day-start Sets preferences.dayStart for user +* @api {post} /api/v3/user/custom-day-start Set preferences.dayStart for user * @apiVersion 3.0.0 * @apiName setCustomDayStart * @apiGroup User