From 248fd1d9126c9f92e9407dcb09410a1b5e4fe255 Mon Sep 17 00:00:00 2001 From: Blade Barringer Date: Mon, 19 Sep 2016 21:54:02 -0500 Subject: [PATCH] chore(docs): Add documentation for valid skill ids --- website/common/script/content/spells.js | 2 +- website/server/controllers/api-v3/user.js | 28 ++++++++++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/website/common/script/content/spells.js b/website/common/script/content/spells.js index ae6eae53ad..ee582a7522 100644 --- a/website/common/script/content/spells.js +++ b/website/common/script/content/spells.js @@ -116,7 +116,7 @@ spells.warrior = { user.stats.buffs.con += Math.ceil(diminishingReturns(bonus, 40, 200)); }, }, - valorousPresence: { // Valorous Prescence + valorousPresence: { // Valorous Presence text: t('spellWarriorValorousPresenceText'), mana: 20, lvl: 13, diff --git a/website/server/controllers/api-v3/user.js b/website/server/controllers/api-v3/user.js index 33aa3728ac..5aaf7015e5 100644 --- a/website/server/controllers/api-v3/user.js +++ b/website/server/controllers/api-v3/user.js @@ -304,10 +304,36 @@ const partyMembersFields = 'profile.name stats achievements items.special'; * @apiName UserCast * @apiGroup User * - * @apiParam {String} spellId The skill to cast + * @apiParam {String=fireball, mpHeal, earth, frost, smash, defensiveStance, valorousPresence, intimidate, pickPocket, backStab, toolsOfTrade, stealth, heal, protectAura, brightness, healAll} spellId The skill to cast. * @apiParam {UUID} targetId Optional query parameter, the id of the target when casting a skill on a party member or a task * * @apiSuccess data Will return the modified targets. For party members only the necessary fields will be populated. The user is always returned. + * + * @apiExample Skill Key to Name Mapping + * Mage + * fireball: "Burst of Flames" + * mpHeal: "Ethereal Surge" + * earth: "Earthquake" + * frost: "Chilling Frost" + * + * Warrior + * smash: "Brutal Smash" + * defensiveStance: "Defensive Stance" + * valorousPresence: "Valorous Presence" + * intimidate: "Intimidating Gaze" + * + * Rogue + * pickPocket: "Pickpocket" + * backStab: "Backstab" + * toolsOfTrade: "Tools of the Trade" + * stealth: "Stealth" + * + * Healer + * heal: "Healing Light" + * protectAura: "Protective Aura" + * brightness: "Searing Brightness" + * healAll: "Blessing" + * */ api.castSpell = { method: 'POST',