krikkert/habitica
1
0
Fork 0
mirror of https://github.com/HabitRPG/habitica.git synced 2025-12-16 22:27:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

api: Fix a few API documentation typos (#10749)

Browse Source 
Just fixes a few syntactic errors and typos.

Signed-off-by: aszlig <aszlig@nix.build>
This commit is contained in:
aszlig
2018-10-13 20:03:40 +02:00
committed by Matteo Pagliazzi
parent 6f5b9ef119
commit 2304d970a5
4 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
website/server/controllers/api-v3/members.js
View File

@@ -32,14 +32,14 @@ let api = {};
* *
* @apiSuccess {Object} data The member object * @apiSuccess {Object} data The member object
* *
* @apiSuccess (Object) data.inbox Basic information about person's inbox * @apiSuccess {Object} data.inbox Basic information about person's inbox
* @apiSuccess (Object) data.stats Includes current stats and buffs * @apiSuccess {Object} data.stats Includes current stats and buffs
* @apiSuccess (Object) data.profile Includes name * @apiSuccess {Object} data.profile Includes name
* @apiSuccess (Object) data.preferences Includes info about appearance and public prefs * @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.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.items Basic inventory information includes quests, food, potions, eggs, gear, special items
* @apiSuccess (Object) data.achievements Lists current achievements * @apiSuccess {Object} data.achievements Lists current achievements
* @apiSuccess (Object) data.auth Includes latest timestamps * @apiSuccess {Object} data.auth Includes latest timestamps
* *
* @apiSuccessExample {json} Success-Response: * @apiSuccessExample {json} Success-Response:
* { * {

2
website/server/controllers/api-v3/user.js
View File

@@ -62,7 +62,7 @@ let api = {};
* Tags * Tags
* TasksOrder (list of all ids for dailys, habits, rewards and todos) * 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: * @apiExample {curl} Example use:
* curl -i https://habitica.com/api/v3/user?userFields=achievements,items.mounts * curl -i https://habitica.com/api/v3/user?userFields=achievements,items.mounts

4
website/server/controllers/api-v3/webhook.js
View File

@@ -31,7 +31,7 @@ let api = {};
* @apiParam (Body) {String} url The webhook's URL * @apiParam (Body) {String} url The webhook's URL
* @apiParam (Body) {String} [label] A label to remind you what this webhook does * @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) {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 * @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 * @apiParamExample {json} Task Activity Example
* { * {
@@ -105,7 +105,7 @@ api.addWebhook = {
* @apiParam (Body) {String} [url] The webhook's URL * @apiParam (Body) {String} [url] The webhook's URL
* @apiParam (Body) {String} [label] A label to remind you what this webhook does * @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) {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). * @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 * @apiParamExample {json} Update Enabled and Type Properties
* { * {

2
website/server/controllers/api-v4/user.js
View File

@@ -37,7 +37,7 @@ const api = {};
* Tags * Tags
* TasksOrder (list of all ids for dailys, habits, rewards and todos) * 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: * @apiExample {curl} Example use:
* curl -i https://habitica.com/api/v3/user?userFields=achievements,items.mounts * curl -i https://habitica.com/api/v3/user?userFields=achievements,items.mounts