krikkert/habitica
1
0
Fork 0
mirror of https://github.com/HabitRPG/habitica.git synced 2025-12-16 06:07:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): remove unneeded apiVersion param

Browse Source
This commit is contained in:
Blade Barringer
2016-10-03 17:11:59 -05:00
parent 285041cdee
commit c014da297c
25 changed files with 0 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
website/server/controllers/api-v3/auth.js
View File

@@ -65,7 +65,6 @@ function hasBackupAuth (user, networkToRemove) {
/** /**
* @api {post} /api/v3/user/auth/local/register Register * @api {post} /api/v3/user/auth/local/register Register
* @apiDescription Register a new user with email, username and password or attach local auth to a social user * @apiDescription Register a new user with email, username and password or attach local auth to a social user
* @apiVersion 3.0.0
* @apiName UserRegisterLocal * @apiName UserRegisterLocal
* @apiGroup User * @apiGroup User
* *
@@ -190,7 +189,6 @@ function _loginRes (user, req, res) {
/** /**
* @api {post} /api/v3/user/auth/local/login Login * @api {post} /api/v3/user/auth/local/login Login
* @apiDescription Login a user with email / username and password * @apiDescription Login a user with email / username and password
* @apiVersion 3.0.0
* @apiName UserLoginLocal * @apiName UserLoginLocal
* @apiGroup User * @apiGroup User
* *
@@ -337,7 +335,6 @@ api.loginSocial = {
* @apiIgnore Private route * @apiIgnore Private route
* @api {post} /api/v3/user/auth/pusher Pusher.com authentication * @api {post} /api/v3/user/auth/pusher Pusher.com authentication
* @apiDescription Authentication for Pusher.com private and presence channels * @apiDescription Authentication for Pusher.com private and presence channels
* @apiVersion 3.0.0
* @apiName UserAuthPusher * @apiName UserAuthPusher
* @apiGroup User * @apiGroup User
* *
@@ -406,7 +403,6 @@ api.pusherAuth = {
/** /**
* @api {put} /api/v3/user/auth/update-username Update username * @api {put} /api/v3/user/auth/update-username Update username
* @apiDescription Update the username of a local user * @apiDescription Update the username of a local user
* @apiVersion 3.0.0
* @apiName UpdateUsername * @apiName UpdateUsername
* @apiGroup User * @apiGroup User
* *
@@ -454,7 +450,6 @@ api.updateUsername = {
/** /**
* @api {put} /api/v3/user/auth/update-password * @api {put} /api/v3/user/auth/update-password
* @apiDescription Update the password of a local user * @apiDescription Update the password of a local user
* @apiVersion 3.0.0
* @apiName UpdatePassword * @apiName UpdatePassword
* @apiGroup User * @apiGroup User
* *
@@ -505,7 +500,6 @@ api.updatePassword = {
/** /**
* @api {post} /api/v3/user/reset-password Reset password * @api {post} /api/v3/user/reset-password Reset password
* @apiDescription Reset the user password * @apiDescription Reset the user password
* @apiVersion 3.0.0
* @apiName ResetPassword * @apiName ResetPassword
* @apiGroup User * @apiGroup User
* *
@@ -560,7 +554,6 @@ api.resetPassword = {
/** /**
* @api {put} /api/v3/user/auth/update-email Update email * @api {put} /api/v3/user/auth/update-email Update email
* @apiDescription Change the user email address * @apiDescription Change the user email address
* @apiVersion 3.0.0
* @apiName UpdateEmail * @apiName UpdateEmail
* @apiGroup User * @apiGroup User
* *
@@ -599,7 +592,6 @@ api.updateEmail = {
/** /**
* @api {delete} /api/v3/user/auth/social/:network Delete social authentication method * @api {delete} /api/v3/user/auth/social/:network Delete social authentication method
* @apiDescription Remove a social authentication method (only facebook supported) from a user profile. The user must have local authentication enabled * @apiDescription Remove a social authentication method (only facebook supported) from a user profile. The user must have local authentication enabled
* @apiVersion 3.0.0
* @apiName UserDeleteSocial * @apiName UserDeleteSocial
* @apiGroup User * @apiGroup User
* *

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

@@ -22,7 +22,6 @@ let api = {};
/** /**
* @api {post} /api/v3/challenges Create a new challenge * @api {post} /api/v3/challenges Create a new challenge
* @apiVersion 3.0.0
* @apiName CreateChallenge * @apiName CreateChallenge
* @apiGroup Challenge * @apiGroup Challenge
* *
@@ -112,7 +111,6 @@ api.createChallenge = {
/** /**
* @api {post} /api/v3/challenges/:challengeId/join Join a challenge * @api {post} /api/v3/challenges/:challengeId/join Join a challenge
* @apiVersion 3.0.0
* @apiName JoinChallenge * @apiName JoinChallenge
* @apiGroup Challenge * @apiGroup Challenge
* @apiParam {UUID} challengeId The challenge _id * @apiParam {UUID} challengeId The challenge _id
@@ -159,7 +157,6 @@ api.joinChallenge = {
/** /**
* @api {post} /api/v3/challenges/:challengeId/leave Leave a challenge * @api {post} /api/v3/challenges/:challengeId/leave Leave a challenge
* @apiVersion 3.0.0
* @apiName LeaveChallenge * @apiName LeaveChallenge
* @apiGroup Challenge * @apiGroup Challenge
* @apiParam {UUID} challengeId The challenge _id * @apiParam {UUID} challengeId The challenge _id
@@ -197,7 +194,6 @@ api.leaveChallenge = {
/** /**
* @api {get} /api/v3/challenges/user Get challenges for a user * @api {get} /api/v3/challenges/user Get challenges for a user
* @apiVersion 3.0.0
* @apiName GetUserChallenges * @apiName GetUserChallenges
* @apiGroup Challenge * @apiGroup Challenge
* *
@@ -242,7 +238,6 @@ api.getUserChallenges = {
/** /**
* @api {get} /api/v3/challenges/group/:groupId 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. * @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 * @apiName GetGroupChallenges
* @apiGroup Challenge * @apiGroup Challenge
* *
@@ -285,7 +280,6 @@ api.getGroupChallenges = {
/** /**
* @api {get} /api/v3/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 * @apiName GetChallenge
* @apiGroup Challenge * @apiGroup Challenge
* *
@@ -328,7 +322,6 @@ api.getChallenge = {
/** /**
* @api {get} /api/v3/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 * @apiName ExportChallengeCsv
* @apiGroup Challenge * @apiGroup Challenge
* *
@@ -401,7 +394,6 @@ api.exportChallengeCsv = {
/** /**
* @api {put} /api/v3/challenges/:challengeId Update a challenge * @api {put} /api/v3/challenges/:challengeId Update a challenge
* @apiVersion 3.0.0
* @apiName UpdateChallenge * @apiName UpdateChallenge
* @apiGroup Challenge * @apiGroup Challenge
* *
@@ -447,7 +439,6 @@ api.updateChallenge = {
/** /**
* @api {delete} /api/v3/challenges/:challengeId Delete a challenge * @api {delete} /api/v3/challenges/:challengeId Delete a challenge
* @apiVersion 3.0.0
* @apiName DeleteChallenge * @apiName DeleteChallenge
* @apiGroup Challenge * @apiGroup Challenge
* *
@@ -479,7 +470,6 @@ api.deleteChallenge = {
/** /**
* @api {post} /api/v3/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 * @apiName SelectChallengeWinner
* @apiGroup Challenge * @apiGroup Challenge
* *

5
website/server/controllers/api-v3/chat.js
View File

@@ -37,7 +37,6 @@ async function getAuthorEmailFromMessage (message) {
/** /**
* @api {get} /api/v3/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 * @apiName GetChat
* @apiGroup Chat * @apiGroup Chat
* *
@@ -66,7 +65,6 @@ api.getChat = {
/** /**
* @api {post} /api/v3/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 PostChat * @apiName PostChat
* @apiGroup Chat * @apiGroup Chat
* *
@@ -131,7 +129,6 @@ api.postChat = {
/** /**
* @api {post} /api/v3/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 * @apiName LikeChat
* @apiGroup Chat * @apiGroup Chat
* *
@@ -364,7 +361,6 @@ api.clearChatFlags = {
/** /**
* @api {post} /api/v3/groups/:groupId/chat/seen Mark all messages as read for a group * @api {post} /api/v3/groups/:groupId/chat/seen Mark all messages as read for a group
* @apiVersion 3.0.0
* @apiName SeenChat * @apiName SeenChat
* @apiGroup Chat * @apiGroup Chat
* *
@@ -399,7 +395,6 @@ api.seenChat = {
/** /**
* @api {delete} /api/v3/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 * @apiName DeleteChat
* @apiGroup Chat * @apiGroup Chat
* *

1
website/server/controllers/api-v3/content.js
View File

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

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

@@ -13,7 +13,6 @@ let api = {};
/** /**
* @api {get} /api/v3/coupons Get coupons * @api {get} /api/v3/coupons Get coupons
* @apiDescription Sudo users only * @apiDescription Sudo users only
* @apiVersion 3.0.0
* @apiName GetCoupons * @apiName GetCoupons
* @apiGroup Coupon * @apiGroup Coupon
* *
@@ -42,7 +41,6 @@ api.getCoupons = {
/** /**
* @api {post} /api/v3/coupons/generate/:event Generate coupons for an event * @api {post} /api/v3/coupons/generate/:event Generate coupons for an event
* @apiDescription Sudo users only * @apiDescription Sudo users only
* @apiVersion 3.0.0
* @apiName GenerateCoupons * @apiName GenerateCoupons
* @apiGroup Coupon * @apiGroup Coupon
* *
@@ -69,7 +67,6 @@ api.generateCoupons = {
/** /**
* @api {post} /api/v3/coupons/enter/:code Enter coupon code * @api {post} /api/v3/coupons/enter/:code Enter coupon code
* @apiVersion 3.0.0
* @apiName EnterCouponCode * @apiName EnterCouponCode
* @apiGroup Coupon * @apiGroup Coupon
* *
@@ -96,7 +93,6 @@ api.enterCouponCode = {
/** /**
* @api {post} /api/v3/coupons/validate/:code Validate a coupon code * @api {post} /api/v3/coupons/validate/:code Validate a coupon code
* @apiVersion 3.0.0
* @apiName ValidateCoupon * @apiName ValidateCoupon
* @apiGroup Coupon * @apiGroup Coupon
* *

6
website/server/controllers/api-v3/debug.js
View File

@@ -9,7 +9,6 @@ let api = {};
/** /**
* @api {post} /api/v3/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
* @apiDescription Only available in development mode. * @apiDescription Only available in development mode.
* @apiVersion 3.0.0
* @apiName AddTenGems * @apiName AddTenGems
* @apiGroup Development * @apiGroup Development
* *
@@ -33,7 +32,6 @@ api.addTenGems = {
/** /**
* @api {post} /api/v3/debug/add-hourglass Add Hourglass to the current user * @api {post} /api/v3/debug/add-hourglass Add Hourglass to the current user
* @apiDescription Only available in development mode. * @apiDescription Only available in development mode.
* @apiVersion 3.0.0
* @apiName AddHourglass * @apiName AddHourglass
* @apiGroup Development * @apiGroup Development
* *
@@ -57,7 +55,6 @@ api.addHourglass = {
/** /**
* @api {post} /api/v3/debug/set-cron Set lastCron for user * @api {post} /api/v3/debug/set-cron Set lastCron for user
* @apiDescription Only available in development mode. * @apiDescription Only available in development mode.
* @apiVersion 3.0.0
* @apiName setCron * @apiName setCron
* @apiGroup Development * @apiGroup Development
* *
@@ -82,7 +79,6 @@ api.setCron = {
/** /**
* @api {post} /api/v3/debug/make-admin Sets contributor.admin to true * @api {post} /api/v3/debug/make-admin Sets contributor.admin to true
* @apiDescription Only available in development mode. * @apiDescription Only available in development mode.
* @apiVersion 3.0.0
* @apiName setCron * @apiName setCron
* @apiGroup Development * @apiGroup Development
* *
@@ -106,7 +102,6 @@ api.makeAdmin = {
/** /**
* @api {post} /api/v3/debug/modify-inventory Manipulate user's inventory * @api {post} /api/v3/debug/modify-inventory Manipulate user's inventory
* @apiDescription Only available in development mode. * @apiDescription Only available in development mode.
* @apiVersion 3.0.0
* @apiName modifyInventory * @apiName modifyInventory
* @apiGroup Development * @apiGroup Development
* *
@@ -147,7 +142,6 @@ api.modifyInventory = {
/** /**
* @api {post} /api/v3/debug/quest-progress Artificially accelerate quest progress * @api {post} /api/v3/debug/quest-progress Artificially accelerate quest progress
* @apiDescription Only available in development mode. * @apiDescription Only available in development mode.
* @apiVersion 3.0.0
* @apiName questProgress * @apiName questProgress
* @apiGroup Development * @apiGroup Development
* *

8
website/server/controllers/api-v3/groups.js
View File

@@ -25,7 +25,6 @@ let api = {};
/** /**
* @api {post} /api/v3/groups Create group * @api {post} /api/v3/groups Create group
* @apiVersion 3.0.0
* @apiName CreateGroup * @apiName CreateGroup
* @apiGroup Group * @apiGroup Group
* *
@@ -88,7 +87,6 @@ api.createGroup = {
/** /**
* @api {get} /api/v3/groups Get groups for a user * @api {get} /api/v3/groups Get groups for a user
* @apiVersion 3.0.0
* @apiName GetGroups * @apiName GetGroups
* @apiGroup Group * @apiGroup Group
* *
@@ -119,7 +117,6 @@ api.getGroups = {
/** /**
* @api {get} /api/v3/groups/:groupId Get group * @api {get} /api/v3/groups/:groupId Get group
* @apiVersion 3.0.0
* @apiName GetGroup * @apiName GetGroup
* @apiGroup Group * @apiGroup Group
* *
@@ -157,7 +154,6 @@ api.getGroup = {
/** /**
* @api {put} /api/v3/groups/:groupId Update group * @api {put} /api/v3/groups/:groupId Update group
* @apiVersion 3.0.0
* @apiName UpdateGroup * @apiName UpdateGroup
* @apiGroup Group * @apiGroup Group
* *
@@ -201,7 +197,6 @@ api.updateGroup = {
/** /**
* @api {post} /api/v3/groups/:groupId/join Join a group * @api {post} /api/v3/groups/:groupId/join Join a group
* @apiVersion 3.0.0
* @apiName JoinGroup * @apiName JoinGroup
* @apiGroup Group * @apiGroup Group
* *
@@ -315,7 +310,6 @@ api.joinGroup = {
/** /**
* @api {post} /api/v3/groups/:groupId/reject Reject a group invitation * @api {post} /api/v3/groups/:groupId/reject Reject a group invitation
* @apiVersion 3.0.0
* @apiName RejectGroupInvite * @apiName RejectGroupInvite
* @apiGroup Group * @apiGroup Group
* *
@@ -360,7 +354,6 @@ api.rejectGroupInvite = {
/** /**
* @api {post} /api/v3/groups/:groupId/leave Leave a group * @api {post} /api/v3/groups/:groupId/leave Leave a group
* @apiVersion 3.0.0
* @apiName LeaveGroup * @apiName LeaveGroup
* @apiGroup Group * @apiGroup Group
* *
@@ -419,7 +412,6 @@ function _sendMessageToRemoved (group, removedUser, message) {
/** /**
* @api {post} /api/v3/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 * @apiName RemoveGroupMember
* @apiGroup Group * @apiGroup Group
* *

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

@@ -11,7 +11,6 @@ let api = {};
/** /**
* @api {get} /api/v3/hall/patrons Get all patrons * @api {get} /api/v3/hall/patrons Get all patrons
* @apiDescription Only the first 50 patrons are returned. More can be accessed passing ?page=n * @apiDescription Only the first 50 patrons are returned. More can be accessed passing ?page=n
* @apiVersion 3.0.0
* @apiName GetPatrons * @apiName GetPatrons
* @apiGroup Hall * @apiGroup Hall
* *
@@ -49,7 +48,6 @@ api.getPatrons = {
/** /**
* @api {get} /api/v3/hall/heroes Get all Heroes * @api {get} /api/v3/hall/heroes Get all Heroes
* @apiVersion 3.0.0
* @apiName GetHeroes * @apiName GetHeroes
* @apiGroup Hall * @apiGroup Hall
* *
@@ -81,7 +79,6 @@ const heroAdminFields = 'contributor balance profile.name purchased items auth f
/** /**
* @api {get} /api/v3/hall/heroes/:heroId Get any user ("hero") given the UUID * @api {get} /api/v3/hall/heroes/:heroId Get any user ("hero") given the UUID
* @apiDescription Must be an admin to make this request. * @apiDescription Must be an admin to make this request.
* @apiVersion 3.0.0
* @apiName GetHero * @apiName GetHero
* @apiGroup Hall * @apiGroup Hall
* *
@@ -119,7 +116,6 @@ const gemsPerTier = {1: 3, 2: 3, 3: 3, 4: 4, 5: 4, 6: 4, 7: 4, 8: 0, 9: 0};
/** /**
* @api {put} /api/v3/hall/heroes/:heroId Update any user ("hero") * @api {put} /api/v3/hall/heroes/:heroId Update any user ("hero")
* @apiDescription Must be an admin to make this request. * @apiDescription Must be an admin to make this request.
* @apiVersion 3.0.0
* @apiName UpdateHero * @apiName UpdateHero
* @apiGroup Hall * @apiGroup Hall
* *

7
website/server/controllers/api-v3/members.js
View File

@@ -22,7 +22,6 @@ let api = {};
/** /**
* @api {get} /api/v3/members/:memberId Get a member profile * @api {get} /api/v3/members/:memberId Get a member profile
* @apiVersion 3.0.0
* @apiName GetMember * @apiName GetMember
* @apiGroup Member * @apiGroup Member
* *
@@ -156,7 +155,6 @@ function _getMembersForItem (type) {
/** /**
* @api {get} /api/v3/groups/:groupId/members Get members for a group * @api {get} /api/v3/groups/:groupId/members Get members for a group
* @apiDescription 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. * @apiDescription 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 * @apiName GetMembersForGroup
* @apiGroup Member * @apiGroup Member
* *
@@ -176,7 +174,6 @@ api.getMembersForGroup = {
/** /**
* @api {get} /api/v3/groups/:groupId/invites Get invites for a group * @api {get} /api/v3/groups/:groupId/invites Get invites for a group
* @apiDescription 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. * @apiDescription 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 * @apiName GetInvitesForGroup
* @apiGroup Member * @apiGroup Member
* *
@@ -199,7 +196,6 @@ api.getInvitesForGroup = {
* BETA You can also use ?includeAllMembers=true. This option is currently in BETA and may be removed in future. * BETA You can also use ?includeAllMembers=true. This option is currently in BETA and may be removed in future.
* Its use is discouraged and its performaces are not optimized especially for large challenges. * Its use is discouraged and its performaces are not optimized especially for large challenges.
* *
* @apiVersion 3.0.0
* @apiName GetMembersForChallenge * @apiName GetMembersForChallenge
* @apiGroup Member * @apiGroup Member
* *
@@ -218,7 +214,6 @@ api.getMembersForChallenge = {
/** /**
* @api {get} /api/v3/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 GetChallengeMemberProgress * @apiName GetChallengeMemberProgress
* @apiGroup Member * @apiGroup Member
* *
@@ -271,7 +266,6 @@ api.getChallengeMemberProgress = {
/** /**
* @api {posts} /api/v3/members/send-private-message Send a private message to a member * @api {posts} /api/v3/members/send-private-message Send a private message to a member
* @apiVersion 3.0.0
* @apiName SendPrivateMessage * @apiName SendPrivateMessage
* @apiGroup Member * @apiGroup Member
* *
@@ -332,7 +326,6 @@ api.sendPrivateMessage = {
/** /**
* @api {posts} /api/v3/members/transfer-gems Send a gem gift to a member * @api {posts} /api/v3/members/transfer-gems Send a gem gift to a member
* @apiVersion 3.0.0
* @apiName TransferGems * @apiName TransferGems
* @apiGroup Member * @apiGroup Member
* *

1
website/server/controllers/api-v3/modelsPaths.js
View File

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

1
website/server/controllers/api-v3/notifications.js
View File

@@ -9,7 +9,6 @@ let api = {};
/** /**
* @apiIgnore Not yet part of the public API * @apiIgnore Not yet part of the public API
* @api {post} /api/v3/notifications/:notificationId/read Mark one notification as read * @api {post} /api/v3/notifications/:notificationId/read Mark one notification as read
* @apiVersion 3.0.0
* @apiName ReadNotification * @apiName ReadNotification
* @apiGroup Notification * @apiGroup Notification
* *

2
website/server/controllers/api-v3/pushNotifications.js
View File

@@ -9,7 +9,6 @@ let api = {};
/** /**
* @apiIgnore * @apiIgnore
* @api {post} /api/v3/user/push-devices Add a push device to a user * @api {post} /api/v3/user/push-devices Add a push device to a user
* @apiVersion 3.0.0
* @apiName UserAddPushDevice * @apiName UserAddPushDevice
* @apiGroup User * @apiGroup User
* *
@@ -54,7 +53,6 @@ api.addPushDevice = {
/** /**
* @apiIgnore * @apiIgnore
* @api {delete} /api/v3/user/push-devices remove a push device from a user * @api {delete} /api/v3/user/push-devices remove a push device from a user
* @apiVersion 3.0.0
* @apiName UserRemovePushDevice * @apiName UserRemovePushDevice
* @apiGroup User * @apiGroup User
* *

7
website/server/controllers/api-v3/quests.js
View File

@@ -30,7 +30,6 @@ let api = {};
/** /**
* @api {post} /api/v3/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 * @apiName InviteToQuest
* @apiGroup Group * @apiGroup Group
* *
@@ -142,7 +141,6 @@ api.inviteToQuest = {
/** /**
* @api {post} /api/v3/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 * @apiName AcceptQuest
* @apiGroup Group * @apiGroup Group
* *
@@ -199,7 +197,6 @@ api.acceptQuest = {
/** /**
* @api {post} /api/v3/groups/:groupId/quests/reject Reject a quest * @api {post} /api/v3/groups/:groupId/quests/reject Reject a quest
* @apiVersion 3.0.0
* @apiName RejectQuest * @apiName RejectQuest
* @apiGroup Group * @apiGroup Group
* *
@@ -257,7 +254,6 @@ api.rejectQuest = {
/** /**
* @api {post} /api/v3/groups/:groupId/quests/force-start Force-start a pending quest * @api {post} /api/v3/groups/:groupId/quests/force-start Force-start a pending quest
* @apiVersion 3.0.0
* @apiName ForceQuestStart * @apiName ForceQuestStart
* @apiGroup Group * @apiGroup Group
* *
@@ -310,7 +306,6 @@ api.forceStart = {
/** /**
* @api {post} /api/v3/groups/:groupId/quests/cancel Cancel 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 * @apiName CancelQuest
* @apiGroup Group * @apiGroup Group
* *
@@ -359,7 +354,6 @@ api.cancelQuest = {
/** /**
* @api {post} /api/v3/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 * @apiName AbortQuest
* @apiGroup Group * @apiGroup Group
* *
@@ -412,7 +406,6 @@ api.abortQuest = {
/** /**
* @api {post} /api/v3/groups/:groupId/quests/leave Leave the active quest * @api {post} /api/v3/groups/:groupId/quests/leave Leave the active quest
* @apiVersion 3.0.0
* @apiName LeaveQuest * @apiName LeaveQuest
* @apiGroup Group * @apiGroup Group
* *

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

@@ -6,7 +6,6 @@ let api = {};
/** /**
* @apiIgnore * @apiIgnore
* @api {get} /api/v3/shops/market get the available items for the market * @api {get} /api/v3/shops/market get the available items for the market
* @apiVersion 3.0.0
* @apiName GetMarketItems * @apiName GetMarketItems
* @apiGroup Shops * @apiGroup Shops
* *
@@ -35,7 +34,6 @@ api.getMarketItems = {
/** /**
* @apiIgnore * @apiIgnore
* @api {get} /api/v3/shops/quests get the available items for the quests shop * @api {get} /api/v3/shops/quests get the available items for the quests shop
* @apiVersion 3.0.0
* @apiName GetQuestShopItems * @apiName GetQuestShopItems
* @apiGroup Shops * @apiGroup Shops
* *
@@ -64,7 +62,6 @@ api.getQuestShopItems = {
/** /**
* @apiIgnore * @apiIgnore
* @api {get} /api/v3/shops/time-travelers get the available items for the time travelers shop * @api {get} /api/v3/shops/time-travelers get the available items for the time travelers shop
* @apiVersion 3.0.0
* @apiName GetTimeTravelersShopItems * @apiName GetTimeTravelersShopItems
* @apiGroup Shops * @apiGroup Shops
* *
@@ -94,7 +91,6 @@ api.getTimeTravelerShopItems = {
/** /**
* @apiIgnore * @apiIgnore
* @api {get} /api/v3/shops/seasonal get the available items for the seasonal shop * @api {get} /api/v3/shops/seasonal get the available items for the seasonal shop
* @apiVersion 3.0.0
* @apiName GetSeasonalShopItems * @apiName GetSeasonalShopItems
* @apiGroup Shops * @apiGroup Shops
* *

1
website/server/controllers/api-v3/status.js
View File

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

6
website/server/controllers/api-v3/tags.js
View File

@@ -11,7 +11,6 @@ let api = {};
/** /**
* @api {post} /api/v3/tags Create a new tag * @api {post} /api/v3/tags Create a new tag
* @apiVersion 3.0.0
* @apiName CreateTag * @apiName CreateTag
* @apiGroup Tag * @apiGroup Tag
* *
@@ -35,7 +34,6 @@ api.createTag = {
/** /**
* @api {get} /api/v3/tags Get a user's tags * @api {get} /api/v3/tags Get a user's tags
* @apiVersion 3.0.0
* @apiName GetTags * @apiName GetTags
* @apiGroup Tag * @apiGroup Tag
* *
@@ -53,7 +51,6 @@ api.getTags = {
/** /**
* @api {get} /api/v3/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 * @apiName GetTag
* @apiGroup Tag * @apiGroup Tag
* *
@@ -81,7 +78,6 @@ api.getTag = {
/** /**
* @api {put} /api/v3/tag/:tagId Update a tag * @api {put} /api/v3/tag/:tagId Update a tag
* @apiVersion 3.0.0
* @apiName UpdateTag * @apiName UpdateTag
* @apiGroup Tag * @apiGroup Tag
* *
@@ -115,7 +111,6 @@ api.updateTag = {
/** /**
* @api {post} /api/v3/reorder-tags Reorder a tag * @api {post} /api/v3/reorder-tags Reorder a tag
* @apiVersion 3.0.0
* @apiName ReorderTags * @apiName ReorderTags
* @apiGroup Tag * @apiGroup Tag
* *
@@ -150,7 +145,6 @@ api.reorderTags = {
/** /**
* @api {delete} /api/v3/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 * @apiName DeleteTag
* @apiGroup Tag * @apiGroup Tag
* *

18
website/server/controllers/api-v3/tasks.js
View File

@@ -27,7 +27,6 @@ let requiredGroupFields = '_id leader tasksOrder name';
/** /**
* @api {post} /api/v3/tasks/user Create a new task belonging to the user * @api {post} /api/v3/tasks/user Create a new task belonging to the user
* @apiDescription Can be passed an object to create a single task or an array of objects to create multiple tasks. * @apiDescription 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 * @apiName CreateUserTasks
* @apiGroup Task * @apiGroup Task
* *
@@ -55,7 +54,6 @@ api.createUserTasks = {
/** /**
* @api {post} /api/v3/tasks/challenge/:challengeId Create a new task belonging to a challenge * @api {post} /api/v3/tasks/challenge/:challengeId Create a new task belonging to a challenge
* @apiDescription Can be passed an object to create a single task or an array of objects to create multiple tasks. * @apiDescription 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 * @apiName CreateChallengeTasks
* @apiGroup Task * @apiGroup Task
* *
@@ -93,7 +91,6 @@ api.createChallengeTasks = {
/** /**
* @api {get} /api/v3/tasks/user Get a user's tasks * @api {get} /api/v3/tasks/user Get a user's tasks
* @apiVersion 3.0.0
* @apiName GetUserTasks * @apiName GetUserTasks
* @apiGroup Task * @apiGroup Task
* *
@@ -122,7 +119,6 @@ api.getUserTasks = {
/** /**
* @api {get} /api/v3/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 * @apiName GetChallengeTasks
* @apiGroup Task * @apiGroup Task
* *
@@ -158,7 +154,6 @@ api.getChallengeTasks = {
/** /**
* @api {get} /api/v3/tasks/:taskId Get a task * @api {get} /api/v3/tasks/:taskId Get a task
* @apiVersion 3.0.0
* @apiName GetTask * @apiName GetTask
* @apiGroup Task * @apiGroup Task
* *
@@ -192,7 +187,6 @@ api.getTask = {
/** /**
* @api {put} /api/v3/tasks/:taskId Update a task * @api {put} /api/v3/tasks/:taskId Update a task
* @apiVersion 3.0.0
* @apiName UpdateTask * @apiName UpdateTask
* @apiGroup Task * @apiGroup Task
* *
@@ -272,7 +266,6 @@ api.updateTask = {
/** /**
* @api {post} /api/v3/tasks/:taskId/score/:direction Score a task * @api {post} /api/v3/tasks/:taskId/score/:direction Score a task
* @apiVersion 3.0.0
* @apiName ScoreTask * @apiName ScoreTask
* @apiGroup Task * @apiGroup Task
* *
@@ -369,7 +362,6 @@ api.scoreTask = {
/** /**
* @api {post} /api/v3/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
* @apiDescription Note: completed To-Dos are not sortable, do not appear in user.tasksOrder.todos, and are ordered by date of completion. * @apiDescription Note: completed To-Dos are not sortable, do not appear in user.tasksOrder.todos, and are ordered by date of completion.
* @apiVersion 3.0.0
* @apiName MoveTask * @apiName MoveTask
* @apiGroup Task * @apiGroup Task
* *
@@ -422,7 +414,6 @@ api.moveTask = {
/** /**
* @api {post} /api/v3/tasks/:taskId/checklist Add an item to the task's checklist * @api {post} /api/v3/tasks/:taskId/checklist Add an item to the task's checklist
* @apiVersion 3.0.0
* @apiName AddChecklistItem * @apiName AddChecklistItem
* @apiGroup Task * @apiGroup Task
* *
@@ -476,7 +467,6 @@ api.addChecklistItem = {
/** /**
* @api {post} /api/v3/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 * @apiName ScoreChecklistItem
* @apiGroup Task * @apiGroup Task
* *
@@ -516,7 +506,6 @@ api.scoreCheckListItem = {
/** /**
* @api {put} /api/v3/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 * @apiName UpdateChecklistItem
* @apiGroup Task * @apiGroup Task
* *
@@ -574,7 +563,6 @@ api.updateChecklistItem = {
/** /**
* @api {delete} /api/v3/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 * @apiName RemoveChecklistItem
* @apiGroup Task * @apiGroup Task
* *
@@ -630,7 +618,6 @@ api.removeChecklistItem = {
/** /**
* @api {post} /api/v3/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 * @apiName AddTagToTask
* @apiGroup Task * @apiGroup Task
* *
@@ -671,7 +658,6 @@ api.addTagToTask = {
/** /**
* @api {delete} /api/v3/tasks/:taskId/tags/:tagId Remove a tag from a task * @api {delete} /api/v3/tasks/:taskId/tags/:tagId Remove a tag from a task
* @apiVersion 3.0.0
* @apiName RemoveTagFromTask * @apiName RemoveTagFromTask
* @apiGroup Task * @apiGroup Task
* *
@@ -708,7 +694,6 @@ api.removeTagFromTask = {
/** /**
* @api {post} /api/v3/tasks/unlink-all/:challengeId Unlink all tasks from a challenge * @api {post} /api/v3/tasks/unlink-all/:challengeId Unlink all tasks from a challenge
* @apiVersion 3.0.0
* @apiName UnlinkAllTasks * @apiName UnlinkAllTasks
* @apiGroup Task * @apiGroup Task
* *
@@ -770,7 +755,6 @@ api.unlinkAllTasks = {
/** /**
* @api {post} /api/v3/tasks/unlink-one/:taskId Unlink a challenge task * @api {post} /api/v3/tasks/unlink-one/:taskId Unlink a challenge task
* @apiVersion 3.0.0
* @apiName UnlinkOneTask * @apiName UnlinkOneTask
* @apiGroup Task * @apiGroup Task
* *
@@ -818,7 +802,6 @@ api.unlinkOneTask = {
/** /**
* @api {post} /api/v3/tasks/clearCompletedTodos Delete user's completed todos * @api {post} /api/v3/tasks/clearCompletedTodos Delete user's completed todos
* @apiVersion 3.0.0
* @apiName ClearCompletedTodos * @apiName ClearCompletedTodos
* @apiGroup Task * @apiGroup Task
* *
@@ -849,7 +832,6 @@ api.clearCompletedTodos = {
/** /**
* @api {delete} /api/v3/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 * @apiName DeleteTask
* @apiGroup Task * @apiGroup Task
* *

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

@@ -19,7 +19,6 @@ let api = {};
/** /**
* @api {post} /api/v3/tasks/group/:groupId Create a new task belonging to a group * @api {post} /api/v3/tasks/group/:groupId Create a new task belonging to a group
* @apiDescription Can be passed an object to create a single task or an array of objects to create multiple tasks. * @apiDescription Can be passed an object to create a single task or an array of objects to create multiple tasks.
* @apiVersion 3.0.0
* @apiName CreateGroupTasks * @apiName CreateGroupTasks
* @apiGroup Task * @apiGroup Task
* @apiIgnore * @apiIgnore
@@ -53,7 +52,6 @@ api.createGroupTasks = {
/** /**
* @api {get} /api/v3/tasks/group/:groupId Get a group's tasks * @api {get} /api/v3/tasks/group/:groupId Get a group's tasks
* @apiVersion 3.0.0
* @apiName GetGroupTasks * @apiName GetGroupTasks
* @apiGroup Task * @apiGroup Task
* @apiIgnore * @apiIgnore
@@ -87,7 +85,6 @@ api.getGroupTasks = {
/** /**
* @api {post} /api/v3/tasks/:taskId/assign/:assignedUserId Assign a group task to a user * @api {post} /api/v3/tasks/:taskId/assign/:assignedUserId Assign a group task to a user
* @apiDescription Assigns a user to a group task * @apiDescription Assigns a user to a group task
* @apiVersion 3.0.0
* @apiName AssignTask * @apiName AssignTask
* @apiGroup Task * @apiGroup Task
* *
@@ -136,7 +133,6 @@ api.assignTask = {
/** /**
* @api {post} /api/v3/tasks/:taskId/unassign/:assignedUserId Unassign a user from a task * @api {post} /api/v3/tasks/:taskId/unassign/:assignedUserId Unassign a user from a task
* @apiDescription Unassigns a user to from a group task * @apiDescription Unassigns a user to from a group task
* @apiVersion 3.0.0
* @apiName UnassignTask * @apiName UnassignTask
* @apiGroup Task * @apiGroup Task
* *

39
website/server/controllers/api-v3/user.js
View File

@@ -19,7 +19,6 @@ let api = {};
/** /**
* @api {get} /api/v3/user Get the authenticated user's profile * @api {get} /api/v3/user Get the authenticated user's profile
* @apiVersion 3.0.0
* @apiName UserGet * @apiName UserGet
* @apiGroup User * @apiGroup User
* *
@@ -43,7 +42,6 @@ api.getUser = {
/** /**
* @api {get} /api/v3/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 * @apiName UserGetBuyList
* @apiGroup User * @apiGroup User
* *
@@ -140,7 +138,6 @@ let checkPreferencePurchase = (user, path, item) => {
/** /**
* @api {put} /api/v3/user Update the user * @api {put} /api/v3/user Update the user
* @apiDescription Example body: {'stats.hp':50, 'preferences.background': 'beach'} * @apiDescription Example body: {'stats.hp':50, 'preferences.background': 'beach'}
* @apiVersion 3.0.0
* @apiName UserUpdate * @apiName UserUpdate
* @apiGroup User * @apiGroup User
* *
@@ -174,7 +171,6 @@ api.updateUser = {
/** /**
* @api {delete} /api/v3/user Delete an authenticated user's account * @api {delete} /api/v3/user Delete an authenticated user's account
* @apiVersion 3.0.0
* @apiName UserDelete * @apiName UserDelete
* @apiGroup User * @apiGroup User
* *
@@ -235,7 +231,6 @@ function _cleanChecklist (task) {
/** /**
* @api {get} /api/v3/user/anonymized Get anonymized user data * @api {get} /api/v3/user/anonymized Get anonymized user data
* @apiVersion 3.0.0
* @apiName UserGetAnonymized * @apiName UserGetAnonymized
* @apiGroup User * @apiGroup User
* *
@@ -300,7 +295,6 @@ const partyMembersFields = 'profile.name stats achievements items.special';
/** /**
* @api {post} /api/v3/user/class/cast/:spellId Cast a skill (spell) on a target * @api {post} /api/v3/user/class/cast/:spellId Cast a skill (spell) on a target
* @apiVersion 3.0.0
* @apiName UserCast * @apiName UserCast
* @apiGroup User * @apiGroup User
* *
@@ -482,7 +476,6 @@ api.castSpell = {
/** /**
* @api {post} /api/v3/user/sleep Make the user start / stop sleeping (resting in the Inn) * @api {post} /api/v3/user/sleep Make the user start / stop sleeping (resting in the Inn)
* @apiVersion 3.0.0
* @apiName UserSleep * @apiName UserSleep
* @apiGroup User * @apiGroup User
* *
@@ -502,7 +495,6 @@ api.sleep = {
/** /**
* @api {post} /api/v3/user/allocate Allocate an attribute point * @api {post} /api/v3/user/allocate Allocate an attribute point
* @apiVersion 3.0.0
* @apiName UserAllocate * @apiName UserAllocate
* @apiGroup User * @apiGroup User
* *
@@ -525,7 +517,6 @@ api.allocate = {
/** /**
* @api {post} /api/v3/user/allocate-now Allocate all attribute points * @api {post} /api/v3/user/allocate-now Allocate all attribute points
* @apiDescription Uses the user's chosen automatic allocation method, or if none, assigns all to STR. * @apiDescription Uses the user's chosen automatic allocation method, or if none, assigns all to STR.
* @apiVersion 3.0.0
* @apiName UserAllocateNow * @apiName UserAllocateNow
* @apiGroup User * @apiGroup User
* *
@@ -546,7 +537,6 @@ api.allocateNow = {
/** /**
* @api {post} /user/buy/:key Buy gear, armoire or potion * @api {post} /user/buy/:key Buy gear, armoire or potion
* @apiDescription Under the hood uses UserBuyGear, UserBuyPotion and UserBuyArmoire * @apiDescription Under the hood uses UserBuyGear, UserBuyPotion and UserBuyArmoire
* @apiVersion 3.0.0
* @apiName UserBuy * @apiName UserBuy
* @apiGroup User * @apiGroup User
* *
@@ -566,7 +556,6 @@ api.buy = {
/** /**
* @api {post} /user/buy-gear/:key Buy a piece of gear * @api {post} /user/buy-gear/:key Buy a piece of gear
* @apiVersion 3.0.0
* @apiName UserBuyGear * @apiName UserBuyGear
* @apiGroup User * @apiGroup User
* *
@@ -592,7 +581,6 @@ api.buyGear = {
/** /**
* @api {post} /user/buy-armoire Buy an armoire item * @api {post} /user/buy-armoire Buy an armoire item
* @apiVersion 3.0.0
* @apiName UserBuyArmoire * @apiName UserBuyArmoire
* @apiGroup User * @apiGroup User
* *
@@ -615,7 +603,6 @@ api.buyArmoire = {
/** /**
* @api {post} /user/buy-health-potion Buy a health potion * @api {post} /user/buy-health-potion Buy a health potion
* @apiVersion 3.0.0
* @apiName UserBuyPotion * @apiName UserBuyPotion
* @apiGroup User * @apiGroup User
* *
@@ -636,7 +623,6 @@ api.buyHealthPotion = {
/** /**
* @api {post} /user/buy-mystery-set/:key Buy a mystery set * @api {post} /user/buy-mystery-set/:key Buy a mystery set
* @apiVersion 3.0.0
* @apiName UserBuyMysterySet * @apiName UserBuyMysterySet
* @apiGroup User * @apiGroup User
* *
@@ -660,7 +646,6 @@ api.buyMysterySet = {
/** /**
* @api {post} /api/v3/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 * @apiName UserBuyQuest
* @apiGroup User * @apiGroup User
* *
@@ -684,7 +669,6 @@ api.buyQuest = {
/** /**
* @api {post} /api/v3/user/buy-special-spell/:key Buy special "spell" item * @api {post} /api/v3/user/buy-special-spell/:key Buy special "spell" item
* @apiDescription Includes gift cards (e.g., birthday card), and avatar Transformation Items and their antidotes (e.g., Snowball item and Salt reward). * @apiDescription Includes gift cards (e.g., birthday card), and avatar Transformation Items and their antidotes (e.g., Snowball item and Salt reward).
* @apiVersion 3.0.0
* @apiName UserBuySpecialSpell * @apiName UserBuySpecialSpell
* @apiGroup User * @apiGroup User
* *
@@ -708,7 +692,6 @@ api.buySpecialSpell = {
/** /**
* @api {post} /api/v3/user/hatch/:egg/:hatchingPotion Hatch a pet * @api {post} /api/v3/user/hatch/:egg/:hatchingPotion Hatch a pet
* @apiVersion 3.0.0
* @apiName UserHatch * @apiName UserHatch
* @apiGroup User * @apiGroup User
* *
@@ -732,7 +715,6 @@ api.hatch = {
/** /**
* @api {post} /api/v3/user/equip/:type/:key Equip an item * @api {post} /api/v3/user/equip/:type/:key Equip an item
* @apiVersion 3.0.0
* @apiName UserEquip * @apiName UserEquip
* @apiGroup User * @apiGroup User
* *
@@ -756,7 +738,6 @@ api.equip = {
/** /**
* @api {post} /api/v3/user/feed/:pet/:food Feed a pet * @api {post} /api/v3/user/feed/:pet/:food Feed a pet
* @apiVersion 3.0.0
* @apiName UserFeed * @apiName UserFeed
* @apiGroup User * @apiGroup User
* *
@@ -781,7 +762,6 @@ api.feed = {
/** /**
* @api {post} /api/v3/user/change-class Change class * @api {post} /api/v3/user/change-class Change class
* @apiDescription User must be at least level 10. If ?class is defined and user.flags.classSelected is false it'll change the class. If user.preferences.disableClasses it'll enable classes, otherwise it sets user.flags.classSelected to false (costs 3 gems) * @apiDescription User must be at least level 10. If ?class is defined and user.flags.classSelected is false it'll change the class. If user.preferences.disableClasses it'll enable classes, otherwise it sets user.flags.classSelected to false (costs 3 gems)
* @apiVersion 3.0.0
* @apiName UserChangeClass * @apiName UserChangeClass
* @apiGroup User * @apiGroup User
* *
@@ -806,7 +786,6 @@ api.changeClass = {
/** /**
* @api {post} /api/v3/user/disable-classes Disable classes * @api {post} /api/v3/user/disable-classes Disable classes
* @apiVersion 3.0.0
* @apiName UserDisableClasses * @apiName UserDisableClasses
* @apiGroup User * @apiGroup User
* *
@@ -828,7 +807,6 @@ api.disableClasses = {
/** /**
* @api {post} /api/v3/user/purchase/:type/:key Purchase Gem or Gem-purchasable item * @api {post} /api/v3/user/purchase/:type/:key Purchase Gem or Gem-purchasable item
* @apiVersion 3.0.0
* @apiName UserPurchase * @apiName UserPurchase
* @apiGroup User * @apiGroup User
* *
@@ -853,7 +831,6 @@ api.purchase = {
/** /**
* @api {post} /api/v3/user/purchase-hourglass/:type/:key Purchase Hourglass-purchasable item * @api {post} /api/v3/user/purchase-hourglass/:type/:key Purchase Hourglass-purchasable item
* @apiVersion 3.0.0
* @apiName UserPurchaseHourglass * @apiName UserPurchaseHourglass
* @apiGroup User * @apiGroup User
* *
@@ -878,7 +855,6 @@ api.userPurchaseHourglass = {
/** /**
* @api {post} /api/v3/user/read-card/:cardType Read a card * @api {post} /api/v3/user/read-card/:cardType Read a card
* @apiVersion 3.0.0
* @apiName UserReadCard * @apiName UserReadCard
* @apiGroup User * @apiGroup User
* *
@@ -902,7 +878,6 @@ api.readCard = {
/** /**
* @api {post} /api/v3/user/open-mystery-item Open the Mystery Item box * @api {post} /api/v3/user/open-mystery-item Open the Mystery Item box
* @apiVersion 3.0.0
* @apiName UserOpenMysteryItem * @apiName UserOpenMysteryItem
* @apiGroup User * @apiGroup User
* *
@@ -922,7 +897,6 @@ api.userOpenMysteryItem = {
}; };
/* @api {post} /api/v3/user/release-pets Release pets /* @api {post} /api/v3/user/release-pets Release pets
* @apiVersion 3.0.0
* @apiName UserReleasePets * @apiName UserReleasePets
* @apiGroup User * @apiGroup User
* *
@@ -943,7 +917,6 @@ api.userReleasePets = {
/** /**
* @api {post} /api/v3/user/release-both Release pets and mounts and grants Triad Bingo * @api {post} /api/v3/user/release-both Release pets and mounts and grants Triad Bingo
* @apiVersion 3.0.0
* @apiName UserReleaseBoth * @apiName UserReleaseBoth
* @apiGroup User * @apiGroup User
@@ -966,7 +939,6 @@ api.userReleaseBoth = {
/** /**
* @api {post} /api/v3/user/release-mounts Release mounts * @api {post} /api/v3/user/release-mounts Release mounts
* @apiVersion 3.0.0
* @apiName UserReleaseMounts * @apiName UserReleaseMounts
* @apiGroup User * @apiGroup User
* *
@@ -987,7 +959,6 @@ api.userReleaseMounts = {
/** /**
* @api {post} /api/v3/user/sell/:type/:key Sell a gold-sellable item owned by the user * @api {post} /api/v3/user/sell/:type/:key Sell a gold-sellable item owned by the user
* @apiVersion 3.0.0
* @apiName UserSell * @apiName UserSell
* @apiGroup User * @apiGroup User
* *
@@ -1012,7 +983,6 @@ api.userSell = {
/** /**
* @api {post} /api/v3/user/unlock Unlock item or set of items by purchase * @api {post} /api/v3/user/unlock Unlock item or set of items by purchase
* @apiVersion 3.0.0
* @apiName UserUnlock * @apiName UserUnlock
* @apiGroup User * @apiGroup User
* *
@@ -1037,7 +1007,6 @@ api.userUnlock = {
/** /**
* @api {post} /api/v3/user/revive Revive user from death * @api {post} /api/v3/user/revive Revive user from death
* @apiVersion 3.0.0
* @apiName UserRevive * @apiName UserRevive
* @apiGroup User * @apiGroup User
* *
@@ -1058,7 +1027,6 @@ api.userRevive = {
/** /**
* @api {post} /api/v3/user/rebirth Use Orb of Rebirth on user * @api {post} /api/v3/user/rebirth Use Orb of Rebirth on user
* @apiVersion 3.0.0
* @apiName UserRebirth * @apiName UserRebirth
* @apiGroup User * @apiGroup User
* *
@@ -1095,7 +1063,6 @@ api.userRebirth = {
/** /**
* @api {post} /api/v3/user/block/:uuid Block / unblock a user from sending you a PM * @api {post} /api/v3/user/block/:uuid Block / unblock a user from sending you a PM
* @apiVersion 3.0.0
* @apiName BlockUser * @apiName BlockUser
* @apiGroup User * @apiGroup User
* *
@@ -1117,7 +1084,6 @@ api.blockUser = {
/** /**
* @api {delete} /api/v3/user/messages/:id Delete a message * @api {delete} /api/v3/user/messages/:id Delete a message
* @apiVersion 3.0.0
* @apiName deleteMessage * @apiName deleteMessage
* @apiGroup User * @apiGroup User
* *
@@ -1139,7 +1105,6 @@ api.deleteMessage = {
/** /**
* @api {delete} /api/v3/user/messages Delete all messages * @api {delete} /api/v3/user/messages Delete all messages
* @apiVersion 3.0.0
* @apiName clearMessages * @apiName clearMessages
* @apiGroup User * @apiGroup User
* *
@@ -1159,7 +1124,6 @@ api.clearMessages = {
/** /**
* @api {post} /api/v3/user/mark-pms-read Marks Private Messages as read * @api {post} /api/v3/user/mark-pms-read Marks Private Messages as read
* @apiVersion 3.0.0
* @apiName markPmsRead * @apiName markPmsRead
* @apiGroup User * @apiGroup User
* *
@@ -1179,7 +1143,6 @@ api.markPmsRead = {
/** /**
* @api {post} /api/v3/user/reroll Reroll a user using the Fortify Potion * @api {post} /api/v3/user/reroll Reroll a user using the Fortify Potion
* @apiVersion 3.0.0
* @apiName UserReroll * @apiName UserReroll
* @apiGroup User * @apiGroup User
* *
@@ -1215,7 +1178,6 @@ api.userReroll = {
/** /**
* @api {post} /api/v3/user/reset Reset user * @api {post} /api/v3/user/reset Reset user
* @apiVersion 3.0.0
* @apiName UserReset * @apiName UserReset
* @apiGroup User * @apiGroup User
* *
@@ -1251,7 +1213,6 @@ 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 for user
* @apiVersion 3.0.0
* @apiName setCustomDayStart * @apiName setCustomDayStart
* @apiGroup User * @apiGroup User
* *

5
website/server/controllers/top-level/dataexport.js
View File

@@ -27,7 +27,6 @@ let api = {};
/** /**
* @api {get} /export/history.csv Export user tasks history in CSV format * @api {get} /export/history.csv Export user tasks history in CSV format
* @apiDescription History is only available for habits and dailies so todos and rewards won't be included. NOTE: Part of the private API that may change at any time. * @apiDescription History is only available for habits and dailies so todos and rewards won't be included. NOTE: Part of the private API that may change at any time.
* @apiVersion 3.0.0
* @apiName ExportUserHistory * @apiName ExportUserHistory
* @apiGroup DataExport * @apiGroup DataExport
* *
@@ -94,7 +93,6 @@ async function _getUserDataForExport (user) {
/** /**
* @api {get} /export/userdata.json Export user data in JSON format * @api {get} /export/userdata.json Export user data in JSON format
* @apiVersion 3.0.0
* @apiName ExportUserDataJson * @apiName ExportUserDataJson
* @apiGroup DataExport * @apiGroup DataExport
* @apiDescription NOTE: Part of the private API that may change at any time. * @apiDescription NOTE: Part of the private API that may change at any time.
@@ -120,7 +118,6 @@ api.exportUserDataJson = {
/** /**
* @api {get} /export/userdata.xml Export user data in XML format * @api {get} /export/userdata.xml Export user data in XML format
* @apiVersion 3.0.0
* @apiName ExportUserDataXml * @apiName ExportUserDataXml
* @apiGroup DataExport * @apiGroup DataExport
* @apiDescription NOTE: Part of the private API that may change at any time. * @apiDescription NOTE: Part of the private API that may change at any time.
@@ -144,7 +141,6 @@ api.exportUserDataXml = {
/** /**
* @api {get} /export/avatar-:uuid.html Render a user avatar as an HTML page * @api {get} /export/avatar-:uuid.html Render a user avatar as an HTML page
* @apiVersion 3.0.0
* @apiName ExportUserAvatarHtml * @apiName ExportUserAvatarHtml
* @apiGroup DataExport * @apiGroup DataExport
* @apiDescription NOTE: Part of the private API that may change at any time. * @apiDescription NOTE: Part of the private API that may change at any time.
@@ -177,7 +173,6 @@ api.exportUserAvatarHtml = {
/** /**
* @api {get} /export/avatar-:uuid.png Render a user avatar as a PNG file * @api {get} /export/avatar-:uuid.png Render a user avatar as a PNG file
* @apiVersion 3.0.0
* @apiName ExportUserAvatarPng * @apiName ExportUserAvatarPng
* @apiGroup DataExport * @apiGroup DataExport
* @apiDescription NOTE: Part of the private API that may change at any time. * @apiDescription NOTE: Part of the private API that may change at any time.

1
website/server/controllers/top-level/email.js
View File

@@ -10,7 +10,6 @@ let api = {};
/** /**
* @api {get} /email/unsubscribe Unsubscribe an email or user from email notifications * @api {get} /email/unsubscribe Unsubscribe an email or user from email notifications
* @apiDescription Does not require authentication * @apiDescription Does not require authentication
* @apiVersion 3.0.0
* @apiName UnsubscribeEmail * @apiName UnsubscribeEmail
* @apiGroup Unsubscribe * @apiGroup Unsubscribe
* @apiDescription This is a GET method so that you can put the unsubscribe link in emails. * @apiDescription This is a GET method so that you can put the unsubscribe link in emails.

5
website/server/controllers/top-level/payments/amazon.js
View File

@@ -19,7 +19,6 @@ let api = {};
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /amazon/verifyAccessToken Amazon Payments: verify access token * @api {post} /amazon/verifyAccessToken Amazon Payments: verify access token
* @apiVersion 3.0.0
* @apiName AmazonVerifyAccessToken * @apiName AmazonVerifyAccessToken
* @apiGroup Payments * @apiGroup Payments
* *
@@ -42,7 +41,6 @@ api.verifyAccessToken = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /amazon/createOrderReferenceId Amazon Payments: create order reference id * @api {post} /amazon/createOrderReferenceId Amazon Payments: create order reference id
* @apiVersion 3.0.0
* @apiName AmazonCreateOrderReferenceId * @apiName AmazonCreateOrderReferenceId
* @apiGroup Payments * @apiGroup Payments
* *
@@ -72,7 +70,6 @@ api.createOrderReferenceId = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /amazon/checkout Amazon Payments: checkout * @api {post} /amazon/checkout Amazon Payments: checkout
* @apiVersion 3.0.0
* @apiName AmazonCheckout * @apiName AmazonCheckout
* @apiGroup Payments * @apiGroup Payments
* *
@@ -153,7 +150,6 @@ api.checkout = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /amazon/subscribe Amazon Payments: subscribe * @api {post} /amazon/subscribe Amazon Payments: subscribe
* @apiVersion 3.0.0
* @apiName AmazonSubscribe * @apiName AmazonSubscribe
* @apiGroup Payments * @apiGroup Payments
* *
@@ -226,7 +222,6 @@ api.subscribe = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {get} /amazon/subscribe/cancel Amazon Payments: subscribe cancel * @api {get} /amazon/subscribe/cancel Amazon Payments: subscribe cancel
* @apiVersion 3.0.0
* @apiName AmazonSubscribe * @apiName AmazonSubscribe
* @apiGroup Payments * @apiGroup Payments
**/ **/

2
website/server/controllers/top-level/payments/iap.js
View File

@@ -17,7 +17,6 @@ let api = {};
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /iap/android/verify Android Verify IAP * @api {post} /iap/android/verify Android Verify IAP
* @apiVersion 3.0.0
* @apiName IapAndroidVerify * @apiName IapAndroidVerify
* @apiGroup Payments * @apiGroup Payments
**/ **/
@@ -71,7 +70,6 @@ api.iapAndroidVerify = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /iap/ios/verify iOS Verify IAP * @api {post} /iap/ios/verify iOS Verify IAP
* @apiVersion 3.0.0
* @apiName IapiOSVerify * @apiName IapiOSVerify
* @apiGroup Payments * @apiGroup Payments
**/ **/

6
website/server/controllers/top-level/payments/paypal.js
View File

@@ -50,7 +50,6 @@ let api = {};
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {get} /paypal/checkout Paypal: checkout * @api {get} /paypal/checkout Paypal: checkout
* @apiVersion 3.0.0
* @apiName PaypalCheckout * @apiName PaypalCheckout
* @apiGroup Payments * @apiGroup Payments
**/ **/
@@ -108,7 +107,6 @@ api.checkout = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {get} /paypal/checkout/success Paypal: checkout success * @api {get} /paypal/checkout/success Paypal: checkout success
* @apiVersion 3.0.0
* @apiName PaypalCheckoutSuccess * @apiName PaypalCheckoutSuccess
* @apiGroup Payments * @apiGroup Payments
**/ **/
@@ -149,7 +147,6 @@ api.checkoutSuccess = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {get} /paypal/subscribe Paypal: subscribe * @api {get} /paypal/subscribe Paypal: subscribe
* @apiVersion 3.0.0
* @apiName PaypalSubscribe * @apiName PaypalSubscribe
* @apiGroup Payments * @apiGroup Payments
**/ **/
@@ -189,7 +186,6 @@ api.subscribe = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {get} /paypal/subscribe/success Paypal: subscribe success * @api {get} /paypal/subscribe/success Paypal: subscribe success
* @apiVersion 3.0.0
* @apiName PaypalSubscribeSuccess * @apiName PaypalSubscribeSuccess
* @apiGroup Payments * @apiGroup Payments
**/ **/
@@ -218,7 +214,6 @@ api.subscribeSuccess = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {get} /paypal/subscribe/cancel Paypal: subscribe cancel * @api {get} /paypal/subscribe/cancel Paypal: subscribe cancel
* @apiVersion 3.0.0
* @apiName PaypalSubscribeCancel * @apiName PaypalSubscribeCancel
* @apiGroup Payments * @apiGroup Payments
**/ **/
@@ -255,7 +250,6 @@ api.subscribeCancel = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /paypal/ipn Paypal IPN * @api {post} /paypal/ipn Paypal IPN
* @apiVersion 3.0.0
* @apiName PaypalIpn * @apiName PaypalIpn
* @apiGroup Payments * @apiGroup Payments
**/ **/

3
website/server/controllers/top-level/payments/stripe.js
View File

@@ -21,7 +21,6 @@ let api = {};
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /stripe/checkout Stripe checkout * @api {post} /stripe/checkout Stripe checkout
* @apiVersion 3.0.0
* @apiName StripeCheckout * @apiName StripeCheckout
* @apiGroup Payments * @apiGroup Payments
* *
@@ -112,7 +111,6 @@ api.checkout = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {post} /stripe/subscribe/edit Edit Stripe subscription * @api {post} /stripe/subscribe/edit Edit Stripe subscription
* @apiVersion 3.0.0
* @apiName StripeSubscribeEdit * @apiName StripeSubscribeEdit
* @apiGroup Payments * @apiGroup Payments
* *
@@ -143,7 +141,6 @@ api.subscribeEdit = {
/** /**
* @apiIgnore Payments are considered part of the private API * @apiIgnore Payments are considered part of the private API
* @api {get} /stripe/subscribe/cancel Cancel Stripe subscription * @api {get} /stripe/subscribe/cancel Cancel Stripe subscription
* @apiVersion 3.0.0
* @apiName StripeSubscribeCancel * @apiName StripeSubscribeCancel
* @apiGroup Payments * @apiGroup Payments
**/ **/