sudoxreboot/habitica-self-host
1
0
Fork 0
mirror of https://github.com/sudoxnym/habitica-self-host.git synced 2026-08-03 04:29:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(apidoc): apidoc now builds correctly

Browse source
This commit is contained in:
Matteo Pagliazzi 2016-04-11 18:05:54 +02:00
parent 020b7c5464
commit 36594b668a
5 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
tasks/gulp-apidoc.js
View file

@ -2,7 +2,7 @@ import gulp from 'gulp';
import clean from 'rimraf';
import apidoc from 'apidoc';
const APIDOC_DEST_PATH = './website/public/apidoc';
const APIDOC_DEST_PATH = './website/build/apidoc';
const APIDOC_SRC_PATH = './website/src';
gulp.task('apidoc:clean', (done) => {
clean(APIDOC_DEST_PATH, done);

4
website/src/controllers/api-v3/debug.js
View file

@ -16,7 +16,7 @@ api.debug = {
* @apiName AddTenGems
* @apiGroup Development
*
* @apiSuccess {} An empty Object
* @apiSuccess {Object} empty An empty Object
*/
api.addTenGems = {
method: 'POST',
@ -38,7 +38,7 @@ api.addTenGems = {
* @apiName AddHourglass
* @apiGroup Development
*
* @apiSuccess {} An empty Object
* @apiSuccess {Object} empty An empty Object
*/
api.addHourglass = {
method: 'POST',

4
website/src/controllers/api-v3/members.js
View file

@ -246,7 +246,7 @@ api.getChallengeMemberProgress = {
* @apiParam {String} message The message
* @apiParam {UUID} toUserId The toUser _id
*
* @apiSuccess {} Object Returns an empty object
* @apiSuccess {Object} empty An empty Object
*/
api.sendPrivateMessage = {
method: 'POST',
@ -295,7 +295,7 @@ api.sendPrivateMessage = {
* @apiParam {String} message The message
* @apiParam {UUID} toUserId The toUser _id
*
* @apiSuccess {} Object Returns an empty object
* @apiSuccess {Object} empty An empty Object
*/
api.transferGems = {
method: 'POST',

0
website/src/controllers/api-v3/meta/modelsPaths.js → website/src/controllers/api-v3/modelsPaths.js
View file

16
website/src/controllers/api-v3/user.js
View file

@ -182,7 +182,7 @@ api.updateUser = {
*
* @apiParam {string} password The user's password unless it's a Facebook account
*
* @apiSuccess {} object An empty object
* @apiSuccess {Object} empty An empty Object
*/
api.deleteUser = {
method: 'DELETE',
@ -309,7 +309,7 @@ const partyMembersFields = 'profile.name stats achievements items.special';
* @apiParam {string} spellId The spell to cast.
* @apiParam {UUID} targetId Optional query parameter, the id of the target when casting a spell on a party member or a task.
*
* @apiSuccess {Object|Array} mixed Will return the modified targets. For party members only the necessary fields will be populated.
* @apiSuccess mixed Will return the modified targets. For party members only the necessary fields will be populated.
*/
api.castSpell = {
method: 'POST',
@ -773,7 +773,7 @@ api.userOpenMysteryItem = {
* @apiVersion 3.0.0
* @apiName UserAddWebhook
* @apiGroup User
* @apiSuccess {}
* @apiSuccess {Object} webhook The created webhook
**/
api.addWebhook = {
method: 'POST',
@ -792,7 +792,7 @@ api.addWebhook = {
* @apiVersion 3.0.0
* @apiName UserUpdateWebhook
* @apiGroup User
* @apiSuccess {}
* @apiSuccess {Object} webhook The updated webhook
**/
api.updateWebhook = {
method: 'PUT',
@ -811,7 +811,7 @@ api.updateWebhook = {
* @apiVersion 3.0.0
* @apiName UserDeleteWebhook
* @apiGroup User
* @apiSuccess {}
* @apiSuccess {Object} webhooks The user webhooks
**/
api.deleteWebhook = {
method: 'DELETE',
@ -979,7 +979,7 @@ api.userRebirth = {
* @apiVersion 3.0.0
* @apiName BlockUser
* @apiGroup User
* @apiSuccess {}
* @apiSuccess user.inbox.blocks
**/
api.blockUser = {
method: 'POST',
@ -998,7 +998,7 @@ api.blockUser = {
* @apiVersion 3.0.0
* @apiName deleteMessage
* @apiGroup User
* @apiSuccess {}
* @apiSuccess user.inbox.messages
**/
api.deleteMessage = {
method: 'DELETE',
@ -1017,7 +1017,7 @@ api.deleteMessage = {
* @apiVersion 3.0.0
* @apiName clearMessages
* @apiGroup User
* @apiSuccess {}
* @apiSuccess user.inbox.messages
**/
api.clearMessages = {
method: 'DELETE',