From 544a703df53cb9598b276d313bd5bed3b2817291 Mon Sep 17 00:00:00 2001
From: Alys <Alys@users.noreply.github.com>
Date: Wed, 10 Jul 2019 00:18:41 +1000
Subject: [PATCH] Minor fixes for apidocs and comments (#11249)

* improve comments for api.getUserChallenges

* clarify members parameter when creating test guilds

I was uncertain about this parameter and read the code to clarify it.
Reading a comment is easier. :)

* add "Custom Day Start time" to api route's title as it's the common name
---
 test/helpers/api-integration/v3/object-generators.js | 2 +-
 test/helpers/api-integration/v4/object-generators.js | 2 +-
 website/server/controllers/api-v3/challenges.js      | 6 +++---
 website/server/controllers/api-v3/user.js            | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/test/helpers/api-integration/v3/object-generators.js b/test/helpers/api-integration/v3/object-generators.js
index 7a0e2cbcf8..fc06344c9e 100644
--- a/test/helpers/api-integration/v3/object-generators.js
+++ b/test/helpers/api-integration/v3/object-generators.js
@@ -86,7 +86,7 @@ export async function generateGroup (leader, details = {}, update = {}) {
 // This is generate group + the ability to create
 // real users to populate it. The settings object
 // takes in:
-// members: Number - the number of group members to create. Defaults to 0.
+// members: Number - the number of group members to create. Defaults to 0. Does not include group leader.
 // inivtes: Number - the number of users to create and invite to the group. Defaults to 0.
 // groupDetails: Object - how to initialize the group
 // leaderDetails: Object - defaults for the leader, defaults with a gem balance so the user
diff --git a/test/helpers/api-integration/v4/object-generators.js b/test/helpers/api-integration/v4/object-generators.js
index 4e177ace00..1c215de361 100644
--- a/test/helpers/api-integration/v4/object-generators.js
+++ b/test/helpers/api-integration/v4/object-generators.js
@@ -80,7 +80,7 @@ export async function generateGroup (leader, details = {}, update = {}) {
 // This is generate group + the ability to create
 // real users to populate it. The settings object
 // takes in:
-// members: Number - the number of group members to create. Defaults to 0.
+// members: Number - the number of group members to create. Defaults to 0. Does not include group leader.
 // inivtes: Number - the number of users to create and invite to the group. Defaults to 0.
 // groupDetails: Object - how to initialize the group
 // leaderDetails: Object - defaults for the leader, defaults with a gem balance so the user
diff --git a/website/server/controllers/api-v3/challenges.js b/website/server/controllers/api-v3/challenges.js
index 87a530fcf1..f0a60396a9 100644
--- a/website/server/controllers/api-v3/challenges.js
+++ b/website/server/controllers/api-v3/challenges.js
@@ -425,11 +425,11 @@ api.getUserChallenges = {
 
 /**
  * @api {get} /api/v3/challenges/groups/: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.
+ * @apiDescription Get challenges hosted in the specified group.
  * @apiName GetGroupChallenges
  * @apiGroup Challenge
  *
- * @apiParam (Path) {UUID} groupId The group _id
+ * @apiParam (Path) {UUID} groupId The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
  *
  * @apiSuccess {Array} data An array of challenges sorted with official challenges first, followed by the challenges in order from newest to oldest
  *
@@ -462,7 +462,7 @@ api.getGroupChallenges = {
 
     const challenges = await Challenge.find({ group: groupId })
       .sort('-createdAt')
-      // .populate('leader', nameFields) // Only populate the leader as the group is implicit
+      // .populate('leader', nameFields) // Only populate the leader as the group is implicit // see below why we're not using populate
       .exec();
 
     let resChals = challenges.map(challenge => challenge.toJSON());
diff --git a/website/server/controllers/api-v3/user.js b/website/server/controllers/api-v3/user.js
index 839c7cd06f..e3e17571f2 100644
--- a/website/server/controllers/api-v3/user.js
+++ b/website/server/controllers/api-v3/user.js
@@ -1539,7 +1539,7 @@ api.userReset = {
 };
 
 /**
- * @api {post} /api/v3/user/custom-day-start Set preferences.dayStart for user
+ * @api {post} /api/v3/user/custom-day-start Set preferences.dayStart (Custom Day Start time) for user
  * @apiName setCustomDayStart
  * @apiGroup User
  *