apidoc: update urls and add notice about private api

package.json

@@ -162,7 +162,7 @@
     "name": "habitica",
     "title": "Habitica",
     "version": "3.0.0",
-    "url": "https://habitica-v3.herokuapp.com/api/v3",
+    "url": "https://habitica-v3.herokuapp.com",
-    "sampleUrl": "https://habitica-v3.herokuapp.com/api/v3"
+    "sampleUrl": "https://habitica-v3.herokuapp.com"
   }
 }

website/src/controllers/api-v3/auth.js

@@ -52,7 +52,7 @@ async function _handleGroupInvitation (user, invite) {
 }
 
 /**
- * @api {post} /user/auth/local/register Register a new user with email, username and password or attach local auth to a social user
+ * @api {post} /api/v3/user/auth/local/register Register a new user with email, username and password or attach local auth to a social user
  * @apiVersion 3.0.0
  * @apiName UserRegisterLocal
  * @apiGroup User
@@ -165,7 +165,7 @@ function _loginRes (user, req, res) {
 }
 
 /**
- * @api {post} /user/auth/local/login Login an user with email / username and password
+ * @api {post} /api/v3/user/auth/local/login Login an user with email / username and password
  * @apiVersion 3.0.0
  * @apiName UserLoginLocal
  * @apiGroup User
@@ -280,7 +280,7 @@ api.loginSocial = {
 };
 
 /**
- * @api {put} /user/auth/update-username
+ * @api {put} /api/v3/user/auth/update-username
  * @apiVersion 3.0.0
  * @apiName updateUsername
  * @apiGroup User
@@ -325,7 +325,7 @@ api.updateUsername = {
 };
 
 /**
- * @api {put} /user/auth/update-password
+ * @api {put} /api/v3/user/auth/update-password
  * @apiVersion 3.0.0
  * @apiName updatePassword
  * @apiGroup User
@@ -364,7 +364,7 @@ api.updatePassword = {
 };
 
 /**
- * @api {post} /user/reset-password
+ * @api {post} /api/v3/user/reset-password
  * @apiVersion 3.0.0
  * @apiName resetPassword
  * @apiGroup User
@@ -414,7 +414,7 @@ api.resetPassword = {
 };
 
 /**
- * @api {put} /user/auth/update-email
+ * @api {put} /api/v3/user/auth/update-email
  * @apiVersion 3.0.0
  * @apiName UpdateEmail
  * @apiGroup User
@@ -471,7 +471,7 @@ api.getFirebaseToken = {
 };
 
 /**
- * @api {delete} /user/auth/social/:network Delete a social authentication method (only facebook supported)
+ * @api {delete} /api/v3/user/auth/social/:network Delete a social authentication method (only facebook supported)
  * @apiVersion 3.0.0
  * @apiName UserDeleteSocial
  * @apiGroup User

website/src/controllers/api-v3/challenges.js

@@ -24,7 +24,7 @@ import csvStringify from '../../libs/api-v3/csvStringify';
 let api = {};
 
 /**
- * @api {post} /challenges Create a new challenge
+ * @api {post} /api/v3/challenges Create a new challenge
  * @apiVersion 3.0.0
  * @apiName CreateChallenge
  * @apiGroup Challenge
@@ -113,7 +113,7 @@ api.createChallenge = {
 };
 
 /**
- * @api {post} /challenges/:challengeId/join Joins a challenge
+ * @api {post} /api/v3/challenges/:challengeId/join Joins a challenge
  * @apiVersion 3.0.0
  * @apiName JoinChallenge
  * @apiGroup Challenge
@@ -159,7 +159,7 @@ api.joinChallenge = {
 };
 
 /**
- * @api {post} /challenges/:challengeId/leave Leaves a challenge
+ * @api {post} /api/v3/challenges/:challengeId/leave Leaves a challenge
  * @apiVersion 3.0.0
  * @apiName LeaveChallenge
  * @apiGroup Challenge
@@ -197,7 +197,7 @@ api.leaveChallenge = {
 };
 
 /**
- * @api {get} /challenges/user Get challenges for a user
+ * @api {get} /api/v3/challenges/user Get challenges for a user
  * @apiVersion 3.0.0
  * @apiName GetUserChallenges
  * @apiGroup Challenge
@@ -241,7 +241,7 @@ api.getUserChallenges = {
 };
 
 /**
- * @api {get} /challenges/group/group:Id Get challenges for a group
+ * @api {get} /api/v3/challenges/group/group:Id Get challenges for a group
  * @apiVersion 3.0.0
  * @apiName GetGroupChallenges
  * @apiGroup Challenge
@@ -284,7 +284,7 @@ api.getGroupChallenges = {
 };
 
 /**
- * @api {get} /challenges/:challengeId Get a challenge given its id
+ * @api {get} /api/v3/challenges/:challengeId Get a challenge given its id
  * @apiVersion 3.0.0
  * @apiName GetChallenge
  * @apiGroup Challenge
@@ -326,7 +326,7 @@ api.getChallenge = {
 };
 
 /**
- * @api {get} /challenges/:challengeId/export/csv Export a challenge in CSV
+ * @api {get} /api/v3/challenges/:challengeId/export/csv Export a challenge in CSV
  * @apiVersion 3.0.0
  * @apiName ExportChallengeCsv
  * @apiGroup Challenge
@@ -399,7 +399,7 @@ api.exportChallengeCsv = {
 };
 
 /**
- * @api {put} /challenges/:challengeId Update a challenge
+ * @api {put} /api/v3/challenges/:challengeId Update a challenge
  * @apiVersion 3.0.0
  * @apiName UpdateChallenge
  * @apiGroup Challenge
@@ -502,7 +502,7 @@ export async function _closeChal (challenge, broken = {}) {
 }
 
 /**
- * @api {delete} /challenges/:challengeId Delete a challenge
+ * @api {delete} /api/v3/challenges/:challengeId Delete a challenge
  * @apiVersion 3.0.0
  * @apiName DeleteChallenge
  * @apiGroup Challenge
@@ -532,7 +532,7 @@ api.deleteChallenge = {
 };
 
 /**
- * @api {post} /challenges/:challengeId/selectWinner/:winnerId Select winner for challenge
+ * @api {post} /api/v3/challenges/:challengeId/selectWinner/:winnerId Select winner for challenge
  * @apiVersion 3.0.0
  * @apiName SelectChallengeWinner
  * @apiGroup Challenge

website/src/controllers/api-v3/chat.js

@@ -20,7 +20,7 @@ const FLAG_REPORT_EMAILS = nconf.get('FLAG_REPORT_EMAIL').split(',').map((email)
 let api = {};
 
 /**
- * @api {get} /groups/:groupId/chat Get chat messages from a group
+ * @api {get} /api/v3/groups/:groupId/chat Get chat messages from a group
  * @apiVersion 3.0.0
  * @apiName GetChat
  * @apiGroup Chat
@@ -49,7 +49,7 @@ api.getChat = {
 };
 
 /**
- * @api {post} /groups/:groupId/chat Post chat message to a group
+ * @api {post} /api/v3/groups/:groupId/chat Post chat message to a group
  * @apiVersion 3.0.0
  * @apiName PostCat
  * @apiGroup Chat
@@ -102,7 +102,7 @@ api.postChat = {
 };
 
 /**
- * @api {post} /groups/:groupId/chat/:chatId/like Like a group chat message
+ * @api {post} /api/v3/groups/:groupId/chat/:chatId/like Like a group chat message
  * @apiVersion 3.0.0
  * @apiName LikeChat
  * @apiGroup Chat
@@ -149,7 +149,7 @@ api.likeChat = {
 };
 
 /**
- * @api {post} /groups/:groupId/chat/:chatId/like Like a group chat message
+ * @api {post} /api/v3/groups/:groupId/chat/:chatId/like Like a group chat message
  * @apiVersion 3.0.0
  * @apiName LikeChat
  * @apiGroup Chat
@@ -254,7 +254,7 @@ api.flagChat = {
 };
 
 /**
- * @api {post} /groups/:groupId/chat/:chatId/clear-flags Clear a group chat message's flags
+ * @api {post} /api/v3/groups/:groupId/chat/:chatId/clear-flags Clear a group chat message's flags
  * @apiVersion 3.0.0
  * @apiName ClearFlags
  * @apiGroup Chat
@@ -301,7 +301,7 @@ api.clearChatFlags = {
 };
 
 /**
- * @api {post} /groups/:groupId/chat/:chatId/seen Seen a group chat message
+ * @api {post} /api/v3/groups/:groupId/chat/:chatId/seen Seen a group chat message
  * @apiVersion 3.0.0
  * @apiName SeenChat
  * @apiGroup Chat
@@ -333,7 +333,7 @@ api.seenChat = {
 };
 
 /**
- * @api {delete} /groups/:groupId/chat/:chatId Delete chat message from a group
+ * @api {delete} /api/v3/groups/:groupId/chat/:chatId Delete chat message from a group
  * @apiVersion 3.0.0
  * @apiName DeleteChat
  * @apiGroup Chat

website/src/controllers/api-v3/content.js

@@ -61,7 +61,7 @@ async function saveContentToDisk (language, content) {
 }
 
 /**
- * @api {get} /content Get all available content objects. Does not require authentication.
+ * @api {get} /api/v3/content Get all available content objects. Does not require authentication.
  * @apiVersion 3.0.0
  * @apiName ContentGet
  * @apiGroup Content

website/src/controllers/api-v3/coupon.js

@@ -11,7 +11,7 @@ import couponCode from 'coupon-code';
 let api = {};
 
 /**
- * @api {get} /coupons Get coupons (sudo users only)
+ * @api {get} /api/v3/coupons Get coupons (sudo users only)
  * @apiVersion 3.0.0
  * @apiName GetCoupons
  * @apiGroup Coupon
@@ -39,7 +39,7 @@ api.getCoupons = {
 };
 
 /**
- * @api {post} /coupons/generate/:event Generate coupons for an event (sudo users only)
+ * @api {post} /api/v3/coupons/generate/:event Generate coupons for an event (sudo users only)
  * @apiVersion 3.0.0
  * @apiName GenerateCoupons
  * @apiGroup Coupon
@@ -66,7 +66,7 @@ api.generateCoupons = {
 };
 
 /**
- * @api {post} /user/coupon/:code Enter coupon code
+ * @api {post} /api/v3/user/coupon/:code Enter coupon code
  * @apiVersion 3.0.0
  * @apiName EnterCouponCode
  * @apiGroup Coupon
@@ -93,7 +93,7 @@ api.enterCouponCode = {
 };
 
 /**
- * @api {post} /coupons/validate/:code Validate a coupon code
+ * @api {post} /api/v3/coupons/validate/:code Validate a coupon code
  * @apiVersion 3.0.0
  * @apiName ValidateCoupon
  * @apiGroup Coupon

website/src/controllers/api-v3/debug.js

@@ -4,7 +4,7 @@ import ensureDevelpmentMode from '../../middlewares/api-v3/ensureDevelpmentMode'
 let api = {};
 
 /**
- * @api {post} /debug/add-ten-gems Add ten gems to the current user
+ * @api {post} /api/v3/debug/add-ten-gems Add ten gems to the current user
  * @apiVersion 3.0.0
  * @apiName AddTenGems
  * @apiGroup Development
@@ -27,7 +27,7 @@ api.addTenGems = {
 };
 
 /**
- * @api {post} /debug/add-hourglass Add Hourglass to the current user
+ * @api {post} /api/v3/debug/add-hourglass Add Hourglass to the current user
  * @apiVersion 3.0.0
  * @apiName AddHourglass
  * @apiGroup Development

website/src/controllers/api-v3/email.js

@@ -8,7 +8,7 @@ import {
 let api = {};
 
 /**
- * @api {get} /email/unsubscribe Unsubscribe an email or user from email notifications
+ * @api {get} /api/v3/email/unsubscribe Unsubscribe an email or user from email notifications
  * @apiVersion 3.0.0
  * @apiName UnsubscribeEmail
  * @apiGroup Unsubscribe

website/src/controllers/api-v3/groups.js

@@ -27,7 +27,7 @@ let api = {};
 // TODO shall we accept party as groupId in all routes?
 
 /**
- * @api {post} /groups Create group
+ * @api {post} /api/v3/groups Create group
  * @apiVersion 3.0.0
  * @apiName CreateGroup
  * @apiGroup Group
@@ -76,7 +76,7 @@ api.createGroup = {
 };
 
 /**
- * @api {get} /groups Get groups
+ * @api {get} /api/v3/groups Get groups
  * @apiVersion 3.0.0
  * @apiName GetGroups
  * @apiGroup Group
@@ -112,7 +112,7 @@ api.getGroups = {
 };
 
 /**
- * @api {get} /groups/:groupId Get group
+ * @api {get} /api/v3/groups/:groupId Get group
  * @apiVersion 3.0.0
  * @apiName GetGroup
  * @apiGroup Group
@@ -146,7 +146,7 @@ api.getGroup = {
 };
 
 /**
- * @api {put} /groups/:groupId Update group
+ * @api {put} /api/v3/groups/:groupId Update group
  * @apiVersion 3.0.0
  * @apiName UpdateGroup
  * @apiGroup Group
@@ -192,7 +192,7 @@ api.updateGroup = {
 };
 
 /**
- * @api {post} /groups/:groupId/join Join a group
+ * @api {post} /api/v3/groups/:groupId/join Join a group
  * @apiVersion 3.0.0
  * @apiName JoinGroup
  * @apiGroup Group
@@ -283,7 +283,7 @@ api.joinGroup = {
 };
 
 /**
- * @api {post} /groups/:groupId/reject Reject a group invitation
+ * @api {post} /api/v3/groups/:groupId/reject Reject a group invitation
  * @apiVersion 3.0.0
  * @apiName RejectGroupInvite
  * @apiGroup Group
@@ -328,7 +328,7 @@ api.rejectGroupInvite = {
 };
 
 /**
- * @api {post} /groups/:groupId/leave Leave a group
+ * @api {post} /api/v3/groups/:groupId/leave Leave a group
  * @apiVersion 3.0.0
  * @apiName LeaveGroup
  * @apiGroup Group
@@ -384,7 +384,7 @@ function _sendMessageToRemoved (group, removedUser, message) {
 }
 
 /**
- * @api {post} /groups/:groupId/removeMember/:memberId Remove a member from a group
+ * @api {post} /api/v3/groups/:groupId/removeMember/:memberId Remove a member from a group
  * @apiVersion 3.0.0
  * @apiName RemoveGroupMember
  * @apiGroup Group
@@ -585,7 +585,7 @@ async function _inviteByEmail (invite, group, inviter, req, res) {
 }
 
 /**
- * @api {post} /groups/:groupId/invite Invite users to a group using their UUIDs or email addresses
+ * @api {post} /api/v3/groups/:groupId/invite Invite users to a group using their UUIDs or email addresses
  * @apiVersion 3.0.0
  * @apiName InviteToGroup
  * @apiGroup Group

website/src/controllers/api-v3/hall.js

@@ -9,7 +9,7 @@ import _ from 'lodash';
 let api = {};
 
 /**
- * @api {get} /hall/patrons Get all Patrons. Only the first 50 patrons are returned. More can be accessed passing ?page=n.
+ * @api {get} /api/v3/hall/patrons Get all Patrons. Only the first 50 patrons are returned. More can be accessed passing ?page=n.
  * @apiVersion 3.0.0
  * @apiName GetPatrons
  * @apiGroup Hall
@@ -47,7 +47,7 @@ api.getPatrons = {
 };
 
 /**
- * @api {get} /hall/heroes Get all Heroes
+ * @api {get} /api/v3/hall/heroes Get all Heroes
  * @apiVersion 3.0.0
  * @apiName GetHeroes
  * @apiGroup Hall
@@ -79,7 +79,7 @@ api.getHeroes = {
 const heroAdminFields = 'contributor balance profile.name purchased items auth';
 
 /**
- * @api {get} /hall/heroes/:heroId Get an hero given his _id. Must be an admin to make this request
+ * @api {get} /api/v3/hall/heroes/:heroId Get an hero given his _id. Must be an admin to make this request
  * @apiVersion 3.0.0
  * @apiName GetHero
  * @apiGroup Hall
@@ -116,7 +116,7 @@ api.getHero = {
 const gemsPerTier = {1: 3, 2: 3, 3: 3, 4: 4, 5: 4, 6: 4, 7: 4, 8: 0, 9: 0};
 
 /**
- * @api {put} /hall/heroes/:heroId Update an hero. Must be an admin to make this request
+ * @api {put} /api/v3/hall/heroes/:heroId Update an hero. Must be an admin to make this request
  * @apiVersion 3.0.0
  * @apiName UpdateHero
  * @apiGroup Hall

website/src/controllers/api-v3/members.js

@@ -20,7 +20,7 @@ import Q from 'q';
 let api = {};
 
 /**
- * @api {get} /members/:memberId Get a member profile
+ * @api {get} /api/v3/members/:memberId Get a member profile
  * @apiVersion 3.0.0
  * @apiName GetMember
  * @apiGroup Member
@@ -129,7 +129,7 @@ function _getMembersForItem (type) {
 }
 
 /**
- * @api {get} /groups/:groupId/members Get members for a group with a limit of 30 member per request. To get all members run requests against this routes (updating the lastId query parameter) until you get less than 30 results.
+ * @api {get} /api/v3/groups/:groupId/members Get members for a group with a limit of 30 member per request. To get all members run requests against this routes (updating the lastId query parameter) until you get less than 30 results.
  * @apiVersion 3.0.0
  * @apiName GetMembersForGroup
  * @apiGroup Member
@@ -148,7 +148,7 @@ api.getMembersForGroup = {
 };
 
 /**
- * @api {get} /groups/:groupId/invites Get invites for a group with a limit of 30 member per request. To get all invites run requests against this routes (updating the lastId query parameter) until you get less than 30 results.
+ * @api {get} /api/v3/groups/:groupId/invites Get invites for a group with a limit of 30 member per request. To get all invites run requests against this routes (updating the lastId query parameter) until you get less than 30 results.
  * @apiVersion 3.0.0
  * @apiName GetInvitesForGroup
  * @apiGroup Member
@@ -166,7 +166,7 @@ api.getInvitesForGroup = {
 };
 
 /**
- * @api {get} /challenges/:challengeId/members Get members for a challenge with a limit of 30 member per request. To get all members run requests against this routes (updating the lastId query parameter) until you get less than 30 results.
+ * @api {get} /api/v3/challenges/:challengeId/members Get members for a challenge with a limit of 30 member per request. To get all members run requests against this routes (updating the lastId query parameter) until you get less than 30 results.
  * @apiVersion 3.0.0
  * @apiName GetMembersForChallenge
  * @apiGroup Member
@@ -184,7 +184,7 @@ api.getMembersForChallenge = {
 };
 
 /**
- * @api {get} /challenges/:challengeId/members/:memberId Get a challenge member progress
+ * @api {get} /api/v3/challenges/:challengeId/members/:memberId Get a challenge member progress
  * @apiVersion 3.0.0
  * @apiName GetChallenge
  * @apiGroup Challenge

website/src/controllers/api-v3/modelsPaths.js

@@ -6,7 +6,7 @@ let tasksModels = ['habit', 'daily', 'todo', 'reward'];
 let allModels = ['user', 'tag', 'challenge', 'group'].concat(tasksModels);
 
 /**
- * @api {get} /meta/models/:model/paths Get all paths for the specified model. Doesn't require authentication
+ * @api {get} /api/v3/meta/models/:model/paths Get all paths for the specified model. Doesn't require authentication
  * @apiVersion 3.0.0
  * @apiName GetUserModelPaths
  * @apiGroup Meta

website/src/controllers/api-v3/quests.js

@@ -29,7 +29,7 @@ function canStartQuestAutomatically (group)  {
 let api = {};
 
 /**
- * @api {post} /groups/:groupId/quests/invite Invite users to a quest
+ * @api {post} /api/v3/groups/:groupId/quests/invite Invite users to a quest
  * @apiVersion 3.0.0
  * @apiName InviteToQuest
  * @apiGroup Group
@@ -132,7 +132,7 @@ api.inviteToQuest = {
 };
 
 /**
- * @api {post} /groups/:groupId/quests/accept Accept a pending quest
+ * @api {post} /api/v3/groups/:groupId/quests/accept Accept a pending quest
  * @apiVersion 3.0.0
  * @apiName AcceptQuest
  * @apiGroup Group
@@ -189,7 +189,7 @@ api.acceptQuest = {
 };
 
 /**
- * @api {post} /groups/:groupId/quests/reject Reject a quest
+ * @api {post} /api/v3/groups/:groupId/quests/reject Reject a quest
  * @apiVersion 3.0.0
  * @apiName RejectQuest
  * @apiGroup Group
@@ -248,7 +248,7 @@ api.rejectQuest = {
 
 
 /**
- * @api {post} /groups/:groupId/quests/force-start Accept a pending quest
+ * @api {post} /api/v3/groups/:groupId/quests/force-start Accept a pending quest
  * @apiVersion 3.0.0
  * @apiName forceStart
  * @apiGroup Group
@@ -300,7 +300,7 @@ api.forceStart = {
 };
 
 /**
- * @api {post} /groups/:groupId/quests/cancel Cancels a quest
+ * @api {post} /api/v3/groups/:groupId/quests/cancel Cancels a quest
  * @apiVersion 3.0.0
  * @apiName CancelQuest
  * @apiGroup Group
@@ -349,7 +349,7 @@ api.cancelQuest = {
 };
 
 /**
- * @api {post} /groups/:groupId/quests/abort Abort the current quest
+ * @api {post} /api/v3/groups/:groupId/quests/abort Abort the current quest
  * @apiVersion 3.0.0
  * @apiName AbortQuest
  * @apiGroup Group
@@ -403,7 +403,7 @@ api.abortQuest = {
 };
 
 /**
- * @api {post} /groups/:groupId/quests/leave Leaves the active quest
+ * @api {post} /api/v3/groups/:groupId/quests/leave Leaves the active quest
  * @apiVersion 3.0.0
  * @apiName LeaveQuest
  * @apiGroup Group

website/src/controllers/api-v3/status.js

@@ -1,7 +1,7 @@
 let api = {};
 
 /**
- * @api {get} /status Get Habitica's status
+ * @api {get} /api/v3/status Get Habitica's status
  * @apiVersion 3.0.0
  * @apiName GetStatus
  * @apiGroup Status

website/src/controllers/api-v3/tags.js

@@ -9,7 +9,7 @@ import _ from 'lodash';
 let api = {};
 
 /**
- * @api {post} /tags Create a new tag
+ * @api {post} /api/v3/tags Create a new tag
  * @apiVersion 3.0.0
  * @apiName CreateTag
  * @apiGroup Tag
@@ -33,7 +33,7 @@ api.createTag = {
 };
 
 /**
- * @api {get} /tag Get an user's tags
+ * @api {get} /api/v3/tag Get an user's tags
  * @apiVersion 3.0.0
  * @apiName GetTags
  * @apiGroup Tag
@@ -51,7 +51,7 @@ api.getTags = {
 };
 
 /**
- * @api {get} /tags/:tagId Get a tag given its id
+ * @api {get} /api/v3/tags/:tagId Get a tag given its id
  * @apiVersion 3.0.0
  * @apiName GetTag
  * @apiGroup Tag
@@ -79,7 +79,7 @@ api.getTag = {
 };
 
 /**
- * @api {put} /tag/:tagId Update a tag
+ * @api {put} /api/v3/tag/:tagId Update a tag
  * @apiVersion 3.0.0
  * @apiName UpdateTag
  * @apiGroup Tag
@@ -113,7 +113,7 @@ api.updateTag = {
 };
 
 /**
- * @api {delete} /tag/:tagId Delete a user tag given its id
+ * @api {delete} /api/v3/tag/:tagId Delete a user tag given its id
  * @apiVersion 3.0.0
  * @apiName DeleteTag
  * @apiGroup Tag

website/src/controllers/api-v3/tasks.js

@@ -54,7 +54,7 @@ async function _createTasks (req, res, user, challenge) {
 }
 
 /**
- * @api {post} /tasks/user Create a new task belonging to the autheticated user. Can be passed an object to create a single task or an array of objects to create multiple tasks.
+ * @api {post} /api/v3/tasks/user Create a new task belonging to the autheticated user. Can be passed an object to create a single task or an array of objects to create multiple tasks.
  * @apiVersion 3.0.0
  * @apiName CreateUserTasks
  * @apiGroup Task
@@ -73,7 +73,7 @@ api.createUserTasks = {
 };
 
 /**
- * @api {post} /tasks/challenge/:challengeId Create a new task belonging to the challenge. Can be passed an object to create a single task or an array of objects to create multiple tasks.
+ * @api {post} /api/v3/tasks/challenge/:challengeId Create a new task belonging to the challenge. Can be passed an object to create a single task or an array of objects to create multiple tasks.
  * @apiVersion 3.0.0
  * @apiName CreateChallengeTasks
  * @apiGroup Task
@@ -164,7 +164,7 @@ async function _getTasks (req, res, user, challenge) {
 }
 
 /**
- * @api {get} /tasks/user Get an user's tasks
+ * @api {get} /api/v3/tasks/user Get an user's tasks
  * @apiVersion 3.0.0
  * @apiName GetUserTasks
  * @apiGroup Task
@@ -190,7 +190,7 @@ api.getUserTasks = {
 };
 
 /**
- * @api {get} /tasks/challenge/:challengeId Get a challenge's tasks
+ * @api {get} /api/v3/tasks/challenge/:challengeId Get a challenge's tasks
  * @apiVersion 3.0.0
  * @apiName GetChallengeTasks
  * @apiGroup Task
@@ -225,7 +225,7 @@ api.getChallengeTasks = {
 };
 
 /**
- * @api {get} /task/:taskId Get a task given its id
+ * @api {get} /api/v3/task/:taskId Get a task given its id
  * @apiVersion 3.0.0
  * @apiName GetTask
  * @apiGroup Task
@@ -266,7 +266,7 @@ api.getTask = {
 };
 
 /**
- * @api {put} /task/:taskId Update a task
+ * @api {put} /api/v3/task/:taskId Update a task
  * @apiVersion 3.0.0
  * @apiName UpdateTask
  * @apiGroup Task
@@ -343,7 +343,7 @@ function _generateWebhookTaskData (task, direction, delta, stats, user) {
 }
 
 /**
- * @api {put} /tasks/:taskId/score/:direction Score a task
+ * @api {put} /api/v3/tasks/:taskId/score/:direction Score a task
  * @apiVersion 3.0.0
  * @apiName ScoreTask
  * @apiGroup Task
@@ -426,7 +426,7 @@ api.scoreTask = {
 // TODO check that it works when a tag is selected or todos are split between dated and due
 // TODO support challenges?
 /**
- * @api {post} /tasks/:taskId/move/to/:position Move a task to a new position
+ * @api {post} /api/v3/tasks/:taskId/move/to/:position Move a task to a new position
  * @apiVersion 3.0.0
  * @apiName MoveTask
  * @apiGroup Task
@@ -481,7 +481,7 @@ api.moveTask = {
 };
 
 /**
- * @api {post} /tasks/:taskId/checklist Add an item to a checklist, creating the checklist if it doesn't exist
+ * @api {post} /api/v3/tasks/:taskId/checklist Add an item to a checklist, creating the checklist if it doesn't exist
  * @apiVersion 3.0.0
  * @apiName AddChecklistItem
  * @apiGroup Task
@@ -529,7 +529,7 @@ api.addChecklistItem = {
 };
 
 /**
- * @api {post} /tasks/:taskId/checklist/:itemId/score Score a checklist item
+ * @api {post} /api/v3/tasks/:taskId/checklist/:itemId/score Score a checklist item
  * @apiVersion 3.0.0
  * @apiName ScoreChecklistItem
  * @apiGroup Task
@@ -571,7 +571,7 @@ api.scoreCheckListItem = {
 };
 
 /**
- * @api {put} /tasks/:taskId/checklist/:itemId Update a checklist item
+ * @api {put} /api/v3/tasks/:taskId/checklist/:itemId Update a checklist item
  * @apiVersion 3.0.0
  * @apiName UpdateChecklistItem
  * @apiGroup Task
@@ -622,7 +622,7 @@ api.updateChecklistItem = {
 };
 
 /**
- * @api {delete} /tasks/:taskId/checklist/:itemId Remove a checklist item
+ * @api {delete} /api/v3/tasks/:taskId/checklist/:itemId Remove a checklist item
  * @apiVersion 3.0.0
  * @apiName RemoveChecklistItem
  * @apiGroup Task
@@ -671,7 +671,7 @@ api.removeChecklistItem = {
 };
 
 /**
- * @api {post} /tasks/:taskId/tags/:tagId Add a tag to a task
+ * @api {post} /api/v3/tasks/:taskId/tags/:tagId Add a tag to a task
  * @apiVersion 3.0.0
  * @apiName AddTagToTask
  * @apiGroup Task
@@ -714,7 +714,7 @@ api.addTagToTask = {
 };
 
 /**
- * @api {delete} /tasks/:taskId/tags/:tagId Remove a tag
+ * @api {delete} /api/v3/tasks/:taskId/tags/:tagId Remove a tag
  * @apiVersion 3.0.0
  * @apiName RemoveTagFromTask
  * @apiGroup Task
@@ -754,7 +754,7 @@ api.removeTagFromTask = {
 
 // TODO this method needs some limitation, like to check if the challenge is really broken?
 /**
- * @api {post} /tasks/unlink/:taskId Unlink a challenge task
+ * @api {post} /api/v3/tasks/unlink/:taskId Unlink a challenge task
  * @apiVersion 3.0.0
  * @apiName UnlinkTask
  * @apiGroup Task
@@ -803,7 +803,7 @@ api.unlinkTask = {
 };
 
 /**
- * @api {post} /tasks/clearCompletedTodos Delete user's completed todos
+ * @api {post} /api/v3/tasks/clearCompletedTodos Delete user's completed todos
  * @apiVersion 3.0.0
  * @apiName ClearCompletedTodos
  * @apiGroup Task
@@ -834,7 +834,7 @@ api.clearCompletedTodos = {
 };
 
 /**
- * @api {delete} /tasks/:taskId Delete a task given its id
+ * @api {delete} /api/v3/tasks/:taskId Delete a task given its id
  * @apiVersion 3.0.0
  * @apiName DeleteTask
  * @apiGroup Task

website/src/controllers/api-v3/user.js

@@ -19,7 +19,7 @@ import * as passwordUtils from '../../libs/api-v3/password';
 let api = {};
 
 /**
- * @api {get} /user Get the authenticated user's profile
+ * @api {get} /api/v3/user Get the authenticated user's profile
  * @apiVersion 3.0.0
  * @apiName UserGet
  * @apiGroup User
@@ -46,7 +46,7 @@ api.getUser = {
 };
 
 /**
- * @api {get} /user/inventory/buy Get the gear items available for purchase for the current user
+ * @api {get} /api/v3/user/inventory/buy Get the gear items available for purchase for the current user
  * @apiVersion 3.0.0
  * @apiName UserGetBuyList
  * @apiGroup User
@@ -140,7 +140,7 @@ let checkPreferencePurchase = (user, path, item) => {
 };
 
 /**
- * @api {put} /user Update the user. Example body: {'stats.hp':50, 'preferences.background': 'beach'}
+ * @api {put} /api/v3/user Update the user. Example body: {'stats.hp':50, 'preferences.background': 'beach'}
  * @apiVersion 3.0.0
  * @apiName UserUpdate
  * @apiGroup User
@@ -174,7 +174,7 @@ api.updateUser = {
 };
 
 /**
- * @api {delete} /user DELETE an authenticated user's profile
+ * @api {delete} /api/v3/user DELETE an authenticated user's profile
  * @apiVersion 3.0.0
  * @apiName UserDelete
  * @apiGroup User
@@ -237,7 +237,7 @@ function _cleanChecklist (task) {
 }
 
 /**
- * @api {get} /user/anonymized
+ * @api {get} /api/v3/user/anonymized
  * @apiVersion 3.0.0
  * @apiName UserGetAnonymized
  * @apiGroup User
@@ -300,7 +300,7 @@ api.getUserAnonymized = {
 const partyMembersFields = 'profile.name stats achievements items.special';
 
 /**
- * @api {post} /user/class/cast/:spellId Cast a spell on a target.
+ * @api {post} /api/v3/user/class/cast/:spellId Cast a spell on a target.
  * @apiVersion 3.0.0
  * @apiName UserCast
  * @apiGroup User
@@ -413,7 +413,7 @@ api.castSpell = {
 };
 
 /**
- * @api {post} /user/sleep Put the user in the inn.
+ * @api {post} /api/v3/user/sleep Put the user in the inn.
  * @apiVersion 3.0.0
  * @apiName UserSleep
  * @apiGroup User
@@ -433,7 +433,7 @@ api.sleep = {
 };
 
 /**
- * @api {post} /user/allocate Allocate an attribute point.
+ * @api {post} /api/v3/user/allocate Allocate an attribute point.
  * @apiVersion 3.0.0
  * @apiName UserAllocate
  * @apiGroup User
@@ -453,7 +453,7 @@ api.allocate = {
 };
 
 /**
- * @api {post} /user/allocate-now Allocate all attribute points.
+ * @api {post} /api/v3/user/allocate-now Allocate all attribute points.
  * @apiVersion 3.0.0
  * @apiName UserAllocateNow
  * @apiGroup User
@@ -473,7 +473,7 @@ api.allocateNow = {
 };
 
 /**
- * @api {post} /user/buy/:key Buy a content item.
+ * @api {post} /api/v3/user/buy/:key Buy a content item.
  * @apiVersion 3.0.0
  * @apiName UserBuy
  * @apiGroup User
@@ -497,7 +497,7 @@ api.buy = {
 };
 
 /**
- * @api {post} /user/buy-mystery-set/:key Buy a mystery set.
+ * @api {post} /api/v3/user/buy-mystery-set/:key Buy a mystery set.
  * @apiVersion 3.0.0
  * @apiName UserBuyMysterySet
  * @apiGroup User
@@ -520,7 +520,7 @@ api.buyMysterySet = {
 };
 
 /**
- * @api {post} /user/buy-quest/:key Buy a quest with gold.
+ * @api {post} /api/v3/user/buy-quest/:key Buy a quest with gold.
  * @apiVersion 3.0.0
  * @apiName UserBuyQuest
  * @apiGroup User
@@ -543,7 +543,7 @@ api.buyQuest = {
 };
 
 /**
- * @api {post} /user/buy-special-spell/:key Buy special spell.
+ * @api {post} /api/v3/user/buy-special-spell/:key Buy special spell.
  * @apiVersion 3.0.0
  * @apiName UserBuySpecialSpell
  * @apiGroup User
@@ -566,7 +566,7 @@ api.buySpecialSpell = {
 };
 
 /**
- * @api {post} /user/hatch/:egg/:hatchingPotion Hatch a pet.
+ * @api {post} /api/v3/user/hatch/:egg/:hatchingPotion Hatch a pet.
  * @apiVersion 3.0.0
  * @apiName UserHatch
  * @apiGroup User
@@ -590,7 +590,7 @@ api.hatch = {
 };
 
 /**
- * @api {post} /user/equip/:type/:key Equip an item
+ * @api {post} /api/v3/user/equip/:type/:key Equip an item
  * @apiVersion 3.0.0
  * @apiName UserEquip
  * @apiGroup User
@@ -614,7 +614,7 @@ api.equip = {
 };
 
 /**
- * @api {post} /user/equip/:pet/:food Feed a pet
+ * @api {post} /api/v3/user/equip/:pet/:food Feed a pet
  * @apiVersion 3.0.0
  * @apiName UserFeed
  * @apiGroup User
@@ -638,7 +638,7 @@ api.feed = {
 };
 
 /**
-* @api {post} /user/change-class Change class.
+* @api {post} /api/v3/user/change-class Change class.
 * @apiVersion 3.0.0
 * @apiName UserChangeClass
 * @apiGroup User
@@ -660,7 +660,7 @@ api.changeClass = {
 };
 
 /**
-* @api {post} /user/disable-classes Disable classes.
+* @api {post} /api/v3/user/disable-classes Disable classes.
 * @apiVersion 3.0.0
 * @apiName UserDisableClasses
 * @apiGroup User
@@ -680,7 +680,7 @@ api.disableClasses = {
 };
 
 /**
-* @api {post} /user/purchase/:type/:key Purchase Gem Items.
+* @api {post} /api/v3/user/purchase/:type/:key Purchase Gem Items.
 * @apiVersion 3.0.0
 * @apiName UserPurchase
 * @apiGroup User
@@ -703,7 +703,7 @@ api.purchase = {
 };
 
 /**
-* @api {post} /user/purchase-hourglass/:type/:key Purchase Hourglass.
+* @api {post} /api/v3/user/purchase-hourglass/:type/:key Purchase Hourglass.
 * @apiVersion 3.0.0
 * @apiName UserPurchaseHourglass
 * @apiGroup User
@@ -726,7 +726,7 @@ api.userPurchaseHourglass = {
 };
 
 /**
-* @api {post} /user/read-card/:cardType Reads a card.
+* @api {post} /api/v3/user/read-card/:cardType Reads a card.
 * @apiVersion 3.0.0
 * @apiName UserReadCard
 * @apiGroup User
@@ -748,7 +748,7 @@ api.readCard = {
 };
 
 /**
-* @api {post} /user/open-mystery-item Open the mystery item.
+* @api {post} /api/v3/user/open-mystery-item Open the mystery item.
 * @apiVersion 3.0.0
 * @apiName UserOpenMysteryItem
 * @apiGroup User
@@ -768,7 +768,7 @@ api.userOpenMysteryItem = {
 };
 
 /**
- * @api {post} /user/webhook
+ * @api {post} /api/v3/user/webhook
  * @apiVersion 3.0.0
  * @apiName UserAddWebhook
  * @apiGroup User
@@ -787,7 +787,7 @@ api.addWebhook = {
 };
 
 /**
- * @api {put} /user/webhook/:id
+ * @api {put} /api/v3/user/webhook/:id
  * @apiVersion 3.0.0
  * @apiName UserUpdateWebhook
  * @apiGroup User
@@ -806,7 +806,7 @@ api.updateWebhook = {
 };
 
 /**
- * @api {delete} /user/webhook/:id
+ * @api {delete} /api/v3/user/webhook/:id
  * @apiVersion 3.0.0
  * @apiName UserDeleteWebhook
  * @apiGroup User
@@ -825,7 +825,7 @@ api.deleteWebhook = {
 };
 
 
-/* @api {post} /user/release-pets Releases pets.
+/* @api {post} /api/v3/user/release-pets Releases pets.
 * @apiVersion 3.0.0
 * @apiName UserReleasePets
 * @apiGroup User
@@ -845,7 +845,7 @@ api.userReleasePets = {
 };
 
 /*
-* @api {post} /user/release-both Releases Pets and Mounts and grants Triad Bingo.
+* @api {post} /api/v3/user/release-both Releases Pets and Mounts and grants Triad Bingo.
 * @apiVersion 3.0.0
 * @apiName UserReleaseBoth
 * @apiGroup User
@@ -865,7 +865,7 @@ api.userReleaseBoth = {
 };
 
 /*
-* @api {post} /user/release-mounts Released mounts.
+* @api {post} /api/v3/user/release-mounts Released mounts.
 * @apiVersion 3.0.0
 * @apiName UserReleaseMounts
 * @apiGroup User
@@ -885,7 +885,7 @@ api.userReleaseMounts = {
 };
 
 /*
-* @api {post} /user/sell/:type/:key Sells user's items.
+* @api {post} /api/v3/user/sell/:type/:key Sells user's items.
 * @apiVersion 3.0.0
 * @apiName UserSell
 * @apiGroup User
@@ -905,7 +905,7 @@ api.userSell = {
 };
 
 /*
-* @api {post} /user/unlock Unlocks items by purchase.
+* @api {post} /api/v3/user/unlock Unlocks items by purchase.
 * @apiVersion 3.0.0
 * @apiName UserUnlock
 * @apiGroup User
@@ -925,7 +925,7 @@ api.userUnlock = {
 };
 
 /**
-* @api {post} /user/revive Revives user from death.
+* @api {post} /api/v3/user/revive Revives user from death.
 * @apiVersion 3.0.0
 * @apiName UserRevive
 * @apiGroup User
@@ -945,7 +945,7 @@ api.userRevive = {
 };
 
 /*
-* @api {post} /user/rebirth Resets a user.
+* @api {post} /api/v3/user/rebirth Resets a user.
 * @apiVersion 3.0.0
 * @apiName UserRebirth
 * @apiGroup User
@@ -974,7 +974,7 @@ api.userRebirth = {
 };
 
 /**
- * @api {post} /user/block/:uuid blocks and unblocks a user
+ * @api {post} /api/v3/user/block/:uuid blocks and unblocks a user
  * @apiVersion 3.0.0
  * @apiName BlockUser
  * @apiGroup User
@@ -993,7 +993,7 @@ api.blockUser = {
 };
 
 /**
- * @api {delete} /user/messages/:id delete this message
+ * @api {delete} /api/v3/user/messages/:id delete this message
  * @apiVersion 3.0.0
  * @apiName deleteMessage
  * @apiGroup User
@@ -1012,7 +1012,7 @@ api.deleteMessage = {
 };
 
 /**
- * @api {delete} /user/messages delete all messages
+ * @api {delete} /api/v3/user/messages delete all messages
  * @apiVersion 3.0.0
  * @apiName clearMessages
  * @apiGroup User
@@ -1031,7 +1031,7 @@ api.clearMessages = {
 };
 
 /*
-* @api {post} /user/reroll Rerolls a user.
+* @api {post} /api/v3/user/reroll Rerolls a user.
 * @apiVersion 3.0.0
 * @apiName UserReroll
 * @apiGroup User
@@ -1061,7 +1061,7 @@ api.userReroll = {
 };
 
 /*
-* @api {post} /user/addPushDevice Adds a push device to a user.
+* @api {post} /api/v3/user/addPushDevice Adds a push device to a user.
 * @apiVersion 3.0.0
 * @apiName UserAddPushDevice
 * @apiGroup User
@@ -1083,7 +1083,7 @@ api.userAddPushDevice = {
 };
 
 /*
-* @api {post} /user/reset Resets a user.
+* @api {post} /api/v3/user/reset Resets a user.
 * @apiVersion 3.0.0
 * @apiName UserReset
 * @apiGroup User

website/src/controllers/top-level/dataexport.js

@@ -25,13 +25,12 @@ const BASE_URL = nconf.get('BASE_URL');
 
 let api = {};
 
-// TODO move these routes out of the /api/v3/export namespace to the top level /export
-
 /**
  * @api {get} /export/history.csv Export user tasks history in CSV format. History is only available for habits and dailys so todos and rewards won't be included
  * @apiVersion 3.0.0
  * @apiName ExportUserHistory
  * @apiGroup DataExport
+ * @apiDescription NOTE: Part of the private API that may change at any time.
  *
  * @apiSuccess {string} A cvs file
  */
@@ -94,12 +93,12 @@ async function _getUserDataForExport (user) {
   return userData;
 }
 
-// TODO export tasks too
 /**
  * @api {get} /export/userdata.json Export user data in JSON format.
  * @apiVersion 3.0.0
  * @apiName ExportUserDataJson
  * @apiGroup DataExport
+ * @apiDescription NOTE: Part of the private API that may change at any time.
  *
  * @apiSuccess {string} A json file
  */
@@ -125,6 +124,7 @@ api.exportUserDataJson = {
  * @apiVersion 3.0.0
  * @apiName ExportUserDataXml
  * @apiGroup DataExport
+ * @apiDescription NOTE: Part of the private API that may change at any time.
  *
  * @apiSuccess {string} A xml file
  */
@@ -148,6 +148,7 @@ api.exportUserDataXml = {
  * @apiVersion 3.0.0
  * @apiName ExportUserAvatarHtml
  * @apiGroup DataExport
+ * @apiDescription NOTE: Part of the private API that may change at any time.
  *
  * @apiSuccess {string} An html page
  */
@@ -180,6 +181,7 @@ api.exportUserAvatarHtml = {
  * @apiVersion 3.0.0
  * @apiName ExportUserAvatarPng
  * @apiGroup DataExport
+ * @apiDescription NOTE: Part of the private API that may change at any time.
  *
  * @apiSuccess {string} A png file
  */