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

make further minor tweaks to apidocs that were previously changed

Browse Source
This commit is contained in:
Alys
2020-02-08 14:26:01 +10:00
parent c5d0ff63a5
commit 6fe87a8140
8 changed files with 20 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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
*

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

@@ -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

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

@@ -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
*

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

@@ -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

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

@@ -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}