fix typos and missing information in apidocs - fixes https://github.com/HabitRPG/habitrpg/issues/7277 (#7282)

This commit is contained in:
Alys
2016-05-16 06:37:31 +10:00
committed by Matteo Pagliazzi
parent faaa52035d
commit 4ceab38d0b
5 changed files with 12 additions and 12 deletions

View File

@@ -373,7 +373,7 @@ api.updatePassword = {
}; };
/** /**
* @api {post} /api/v3/user/reset-password Reser password * @api {post} /api/v3/user/reset-password Reset password
* @apiDescription Reset the user password * @apiDescription Reset the user password
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName ResetPassword * @apiName ResetPassword
@@ -427,7 +427,7 @@ api.resetPassword = {
/** /**
* @api {put} /api/v3/user/auth/update-email Update email * @api {put} /api/v3/user/auth/update-email Update email
* @apiDescription Che the user email * @apiDescription Change the user email address
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UpdateEmail * @apiName UpdateEmail
* @apiGroup User * @apiGroup User

View File

@@ -6,7 +6,7 @@ let tasksModels = ['habit', 'daily', 'todo', 'reward'];
let allModels = ['user', 'tag', 'challenge', 'group'].concat(tasksModels); let allModels = ['user', 'tag', 'challenge', 'group'].concat(tasksModels);
/** /**
* @api {get} /api/v3s/models/:model/paths Get all paths for the specified model. * @api {get} /api/v3/models/:model/paths Get all paths for the specified model.
* @apiDescription Doesn't require authentication * @apiDescription Doesn't require authentication
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName GetUserModelPaths * @apiName GetUserModelPaths

View File

@@ -249,7 +249,7 @@ api.rejectQuest = {
/** /**
* @api {post} /api/v3/groups/:groupId/quests/force-start Accept a pending quest * @api {post} /api/v3/groups/:groupId/quests/force-start Force-start a pending quest
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName ForceQuestStart * @apiName ForceQuestStart
* @apiGroup Group * @apiGroup Group

View File

@@ -54,7 +54,7 @@ async function _createTasks (req, res, user, challenge) {
} }
/** /**
* @api {post} /api/v3/tasks/user Create a new task the user. * @api {post} /api/v3/tasks/user Create a new task belonging to the user.
* @apiDescription Can be passed an object to create a single task or an array of objects to create multiple tasks. * @apiDescription Can be passed an object to create a single task or an array of objects to create multiple tasks.
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName CreateUserTasks * @apiName CreateUserTasks

View File

@@ -177,7 +177,7 @@ api.updateUser = {
}; };
/** /**
* @api {delete} /api/v3/user DELETE an authenticated user's account * @api {delete} /api/v3/user Delete an authenticated user's account
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UserDelete * @apiName UserDelete
* @apiGroup User * @apiGroup User
@@ -240,7 +240,7 @@ function _cleanChecklist (task) {
} }
/** /**
* @api {get} /api/v3/user/anonymized * @api {get} /api/v3/user/anonymized Get anonymized user data
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UserGetAnonymized * @apiName UserGetAnonymized
* @apiGroup User * @apiGroup User
@@ -886,12 +886,12 @@ api.userOpenMysteryItem = {
}; };
/* /*
* @api {post} /api/v3/user/webhook * @api {post} /api/v3/user/webhook Create a new webhook
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UserAddWebhook * @apiName UserAddWebhook
* @apiGroup User * @apiGroup User
* *
* @apiParam {string} url Body parameter - The webhook's urò * @apiParam {string} url Body parameter - The webhook's URL
* @apiParam {boolean} enabled Body parameter - If the webhook should be enabled * @apiParam {boolean} enabled Body parameter - If the webhook should be enabled
* *
* @apiSuccess {Object} data The created webhook * @apiSuccess {Object} data The created webhook
@@ -909,13 +909,13 @@ api.addWebhook = {
}; };
/* /*
* @api {put} /api/v3/user/webhook/:id * @api {put} /api/v3/user/webhook/:id Edit a webhook
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UserUpdateWebhook * @apiName UserUpdateWebhook
* @apiGroup User * @apiGroup User
* *
* @apiParam {UUID} id The id of the webhook to update * @apiParam {UUID} id The id of the webhook to update
* @apiParam {string} url Body parameter - The webhook's urò * @apiParam {string} url Body parameter - The webhook's URL
* @apiParam {boolean} enabled Body parameter - If the webhook should be enabled * @apiParam {boolean} enabled Body parameter - If the webhook should be enabled
* *
* @apiSuccess {Object} data The updated webhook * @apiSuccess {Object} data The updated webhook
@@ -933,7 +933,7 @@ api.updateWebhook = {
}; };
/* /*
* @api {delete} /api/v3/user/webhook/:id * @api {delete} /api/v3/user/webhook/:id Delete a webhook
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UserDeleteWebhook * @apiName UserDeleteWebhook
* @apiGroup User * @apiGroup User