change apidoc to explain that the equip route also unequips

This commit is contained in:
Alys
2018-05-16 20:45:35 +10:00
parent 4a55d36831
commit ad191c2c5c

View File

@@ -948,12 +948,12 @@ api.hatch = {
};
/**
* @api {post} /api/v3/user/equip/:type/:key Equip an item
* @api {post} /api/v3/user/equip/:type/:key Equip or unequip an item
* @apiName UserEquip
* @apiGroup User
*
* @apiParam (Path) {String="mount","pet","costume","equipped"} type The type of item to equip
* @apiParam (Path) {String} key The item to equip
* @apiParam (Path) {String="mount","pet","costume","equipped"} type The type of item to equip or unequip
* @apiParam (Path) {String} key The item to equip or unequip
*
* @apiParamExample {URL} Example-URL
* https://habitica.com/api/v3/user/equip/equipped/weapon_warrior_2