diff --git a/website/server/controllers/api-v3/members.js b/website/server/controllers/api-v3/members.js index ff09a2cd8a..4e77b51636 100644 --- a/website/server/controllers/api-v3/members.js +++ b/website/server/controllers/api-v3/members.js @@ -32,14 +32,14 @@ let api = {}; * * @apiSuccess {Object} data The member object * - * @apiSuccess (Object) data.inbox Basic information about person's inbox - * @apiSuccess (Object) data.stats Includes current stats and buffs - * @apiSuccess (Object) data.profile Includes name - * @apiSuccess (Object) data.preferences Includes info about appearance and public prefs - * @apiSuccess (Object) data.party Includes basic info about current party and quests - * @apiSuccess (Object) data.items Basic inventory information includes quests, food, potions, eggs, gear, special items - * @apiSuccess (Object) data.achievements Lists current achievements - * @apiSuccess (Object) data.auth Includes latest timestamps + * @apiSuccess {Object} data.inbox Basic information about person's inbox + * @apiSuccess {Object} data.stats Includes current stats and buffs + * @apiSuccess {Object} data.profile Includes name + * @apiSuccess {Object} data.preferences Includes info about appearance and public prefs + * @apiSuccess {Object} data.party Includes basic info about current party and quests + * @apiSuccess {Object} data.items Basic inventory information includes quests, food, potions, eggs, gear, special items + * @apiSuccess {Object} data.achievements Lists current achievements + * @apiSuccess {Object} data.auth Includes latest timestamps * * @apiSuccessExample {json} Success-Response: * { diff --git a/website/server/controllers/api-v3/user.js b/website/server/controllers/api-v3/user.js index a52de6b76c..6b70470896 100644 --- a/website/server/controllers/api-v3/user.js +++ b/website/server/controllers/api-v3/user.js @@ -62,7 +62,7 @@ let api = {}; * Tags * TasksOrder (list of all ids for dailys, habits, rewards and todos) * - * @apiParam (Query) {UUID} userFields A list of comma separated user fields to be returned instead of the entire document. Notifications are always returned. + * @apiParam (Query) {String} [userFields] A list of comma separated user fields to be returned instead of the entire document. Notifications are always returned. * * @apiExample {curl} Example use: * curl -i https://habitica.com/api/v3/user?userFields=achievements,items.mounts diff --git a/website/server/controllers/api-v3/webhook.js b/website/server/controllers/api-v3/webhook.js index 094e280088..a39b05ce3d 100644 --- a/website/server/controllers/api-v3/webhook.js +++ b/website/server/controllers/api-v3/webhook.js @@ -31,7 +31,7 @@ let api = {}; * @apiParam (Body) {String} url The webhook's URL * @apiParam (Body) {String} [label] A label to remind you what this webhook does * @apiParam (Body) {Boolean} [enabled=true] If the webhook should be enabled - * @apiParam (Body) {Sring="taskActivity","groupChatReceived","userActivity"} [type="taskActivity"] The webhook's type. + * @apiParam (Body) {String="taskActivity","groupChatReceived","userActivity"} [type="taskActivity"] The webhook's type. * @apiParam (Body) {Object} [options] The webhook's options. Wil differ depending on type. Required for `groupChatReceived` type. If a webhook supports options, the default values are displayed in the examples below * @apiParamExample {json} Task Activity Example * { @@ -105,7 +105,7 @@ api.addWebhook = { * @apiParam (Body) {String} [url] The webhook's URL * @apiParam (Body) {String} [label] A label to remind you what this webhook does * @apiParam (Body) {Boolean} [enabled] If the webhook should be enabled - * @apiParam (Body) {Sring="taskActivity","groupChatReceived"} [type] The webhook's type. + * @apiParam (Body) {String="taskActivity","groupChatReceived"} [type] The webhook's type. * @apiParam (Body) {Object} [options] The webhook's options. Wil differ depending on type. The options are enumerated in the [add webhook examples](#api-Webhook-UserAddWebhook). * @apiParamExample {json} Update Enabled and Type Properties * { diff --git a/website/server/controllers/api-v4/user.js b/website/server/controllers/api-v4/user.js index 01cc9e7034..77183bdf98 100644 --- a/website/server/controllers/api-v4/user.js +++ b/website/server/controllers/api-v4/user.js @@ -37,7 +37,7 @@ const api = {}; * Tags * TasksOrder (list of all ids for dailys, habits, rewards and todos) * - * @apiParam (Query) {UUID} userFields A list of comma separated user fields to be returned instead of the entire document. Notifications are always returned. + * @apiParam (Query) {String} [userFields] A list of comma separated user fields to be returned instead of the entire document. Notifications are always returned. * * @apiExample {curl} Example use: * curl -i https://habitica.com/api/v3/user?userFields=achievements,items.mounts