diff --git a/website/server/controllers/api-v3/auth.js b/website/server/controllers/api-v3/auth.js index 676abe8bea..49b37105c2 100644 --- a/website/server/controllers/api-v3/auth.js +++ b/website/server/controllers/api-v3/auth.js @@ -29,7 +29,7 @@ const api = {}; /** * @api {post} /api/v3/user/auth/local/register Register * @apiDescription Register a new user with email, login name, and password or - * attach local authentication to a social-auth user + * attach local authentication to a social auth user * @apiName UserRegisterLocal * @apiGroup User * diff --git a/website/server/controllers/api-v3/cron.js b/website/server/controllers/api-v3/cron.js index 7acc87ea58..bea3e41201 100644 --- a/website/server/controllers/api-v3/cron.js +++ b/website/server/controllers/api-v3/cron.js @@ -6,7 +6,9 @@ const api = {}; /** * @api {post} /api/v3/cron Run cron * @apiName Cron - * @apiDescription This causes cron to run. It assumes that the user has already been shown the Record Yesterday's Activity ("Check off any Dailies you did yesterday") screen and so it will immediately apply damage for incomplete due Dailies. + * @apiDescription This causes cron to run. It assumes that the user has already been shown + * the Record Yesterday's Activity ("Check off any Dailies you did yesterday") screen and + * so it will immediately apply damage for incomplete due Dailies. * @apiGroup Cron * * @apiSuccess {Object} data An empty Object diff --git a/website/server/controllers/api-v3/members.js b/website/server/controllers/api-v3/members.js index 74b34d24e2..10021663a3 100644 --- a/website/server/controllers/api-v3/members.js +++ b/website/server/controllers/api-v3/members.js @@ -659,7 +659,7 @@ api.getObjectionsToInteraction = { * @apiGroup Member * * @apiParam (Body) {String} message The message - * @apiParam (Body) {UUID} toUserId The user to contact + * @apiParam (Body) {UUID} toUserId The id of the user to contact * * @apiSuccess {Object} data.message The message just sent * diff --git a/website/server/controllers/api-v3/tasks.js b/website/server/controllers/api-v3/tasks.js index f68506796a..6787b60a8f 100644 --- a/website/server/controllers/api-v3/tasks.js +++ b/website/server/controllers/api-v3/tasks.js @@ -1477,7 +1477,7 @@ api.unlinkOneTask = { }; /** - * @api {post} /api/v3/tasks/clearCompletedTodos Delete user's completed To-Dos + * @api {post} /api/v3/tasks/clearCompletedTodos Delete user's completed todos * @apiName ClearCompletedTodos * @apiDescription Deletes all of a user's completed To-Dos except those belonging to active Challenges and Group Plans * @apiGroup Task diff --git a/website/server/controllers/api-v3/user.js b/website/server/controllers/api-v3/user.js index 708769f6b7..fd8d60cc86 100644 --- a/website/server/controllers/api-v3/user.js +++ b/website/server/controllers/api-v3/user.js @@ -230,7 +230,8 @@ api.updateUser = { * @apiName UserDelete * @apiGroup User * - * @apiParam (Body) {String} password The user's password if the account uses local authentication, otherwise the localized word "DELETE" + * @apiParam (Body) {String} password The user's password if the account uses local authentication, + * otherwise the localized word "DELETE" * @apiParam (Body) {String} feedback User's optional feedback explaining reasons for deletion * * @apiSuccess {Object} data An empty Object @@ -244,7 +245,8 @@ api.updateUser = { * @apiError {BadRequest} MissingPassword Missing password. * @apiError {BadRequest} NotAuthorized Wrong password. * @apiError {BadRequest} NotAuthorized Please type DELETE in all capital letters to delete your account. - * @apiError {BadRequest} BadRequest Account deletion feedback is limited to 10,000 characters. For lengthy feedback, email ${TECH_ASSISTANCE_EMAIL}. + * @apiError {BadRequest} BadRequest Account deletion feedback is limited to 10,000 characters. + * For lengthy feedback, email ${TECH_ASSISTANCE_EMAIL}. * @apiError {BadRequest} NotAuthorized You have an active subscription, cancel your plan before deleting your account. * * @apiErrorExample {json} diff --git a/website/server/controllers/api-v4/inbox.js b/website/server/controllers/api-v4/inbox.js index ebade6de65..be5cca6a4d 100644 --- a/website/server/controllers/api-v4/inbox.js +++ b/website/server/controllers/api-v4/inbox.js @@ -77,7 +77,9 @@ api.clearMessages = { * @api {get} /api/v4/inbox/conversations Get the conversations for a user * @apiName conversations * @apiGroup Inbox - * @apiDescription Get the conversations for a user. This is for API v4 which must not be used in third-party tools. Use "Get inbox messages for a user" instead. + * @apiDescription Get the conversations for a user. + * This is for API v4 which must not be used in third-party tools. + * For API v3, use "Get inbox messages for a user". * * @apiSuccess {Array} data An array of inbox conversations * diff --git a/website/server/controllers/api-v4/members.js b/website/server/controllers/api-v4/members.js index 38e34a3483..88298c3bb0 100644 --- a/website/server/controllers/api-v4/members.js +++ b/website/server/controllers/api-v4/members.js @@ -5,8 +5,10 @@ const api = {}; /** * @api {post} /api/v4/members/flag-private-message/:messageId Flag a private message - * @apiDescription Moderators are notified about every flagged message, including the sender, recipient, and full content of the message. - * This route is for API v4 which must not be used in third-party tools as it can change without notice. There is no equivalent route in API v3. + * @apiDescription Moderators are notified about every flagged message, + * including the sender, recipient, and full content of the message. + * This route is for API v4 which must not be used in third-party tools as it can change without notice. + * There is no equivalent route in API v3. * @apiName FlagPrivateMessage * @apiGroup Member * diff --git a/website/server/controllers/top-level/dataexport.js b/website/server/controllers/top-level/dataexport.js index 94071b7310..715b8c2268 100644 --- a/website/server/controllers/top-level/dataexport.js +++ b/website/server/controllers/top-level/dataexport.js @@ -161,7 +161,7 @@ api.exportUserDataJson = { /** * @api {get} /export/userdata.xml Export user data in XML format * @apiName ExportUserDataXml - * @apiDescription This XML export feature is not currently working. Refer to https://github.com/HabitRPG/habitica/issues/10100 for details. + * @apiDescription This XML export feature is not currently working (https://github.com/HabitRPG/habitica/issues/10100). * @apiGroup DataExport * * @apiSuccess {XML} File An xml file of the user object. @@ -225,7 +225,7 @@ api.exportUserAvatarHtml = { /** * @api {get} /export/avatar-:uuid.png Render a user avatar as a PNG file * @apiName ExportUserAvatarPng - * @apiDescription This PNG export feature is not currently working. Refer to https://github.com/HabitRPG/habitica/issues/9489 for details. + * @apiDescription This PNG export feature is not currently working (https://github.com/HabitRPG/habitica/issues/9489). * @apiGroup DataExport * * @apiParam (Path) {String} uuid The User ID of the user @@ -295,7 +295,7 @@ api.exportUserAvatarPng = { /** * @api {get} /export/inbox.html Export user private messages as HTML document * @apiName ExportUserPrivateMessages - * @apiDescription This HTML export feature is not currently working. Refer to https://github.com/HabitRPG/habitica/issues/9489 for details. + * @apiDescription This HTML export feature is not currently working (https://github.com/HabitRPG/habitica/issues/9489). * @apiGroup DataExport * * @apiSuccess {HTML} File An html page of the user's private messages.