diff --git a/website/server/controllers/api-v3/user.js b/website/server/controllers/api-v3/user.js index d76fd6ba90..e475e95e02 100644 --- a/website/server/controllers/api-v3/user.js +++ b/website/server/controllers/api-v3/user.js @@ -409,12 +409,15 @@ const partyMembersFields = 'profile.name stats achievements items.special'; * @apiName UserCast * @apiGroup User * - * @apiParam {String=fireball, mpheal, earth, frost, smash, defensiveStance, valorousPresence, intimidate, pickPocket, backStab, toolsOfTrade, stealth, heal, protectAura, brightness, healAll} spellId The skill to cast. - * @apiParam (Body) {UUID} targetId Query parameter, necessary if the spell is cast on a party member or task. Not used if the spell is case on onesself or the user's current party. + + * @apiParam {String=fireball, mpHeal, earth, frost, smash, defensiveStance, valorousPresence, intimidate, pickPocket, backStab, toolsOfTrade, stealth, heal, protectAura, brightness, healAll} spellId The skill to cast. + * @apiParam (Query) {UUID} targetId Query parameter, necessary if the spell is cast on a party member or task. Not used if the spell is case on the user or the user's current party. * @apiParamExample {json} Query example: - * { - * "targetId":"fd427623-9a69-4aac-9852-13deb9c190c3" - * } + * Cast "Pickpocket" on a task: + * https://habitica.com/api/v3/user/class/cast/pickPocket?targetId=fd427623... + * + * Cast "Tools of the Trade" on the party: + * https://habitica.com/api/v3/user/class/cast/toolsOfTrade * * @apiSuccess data Will return the modified targets. For party members only the necessary fields will be populated. The user is always returned. *