chore(docs): Add documentation for valid skill ids

This commit is contained in:
Blade Barringer
2016-09-19 21:54:02 -05:00
parent 5fa76f6aeb
commit 248fd1d912
2 changed files with 28 additions and 2 deletions

View File

@@ -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',