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

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
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 clean from 'rimraf';
import apidoc from 'apidoc'; import apidoc from 'apidoc';
const APIDOC_DEST_PATH = './website/public/apidoc'; const APIDOC_DEST_PATH = './website/build/apidoc';
const APIDOC_SRC_PATH = './website/src'; const APIDOC_SRC_PATH = './website/src';
gulp.task('apidoc:clean', (done) => { gulp.task('apidoc:clean', (done) => {
clean(APIDOC_DEST_PATH, done); clean(APIDOC_DEST_PATH, done);

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

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

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

@@ -246,7 +246,7 @@ api.getChallengeMemberProgress = {
* @apiParam {String} message The message * @apiParam {String} message The message
* @apiParam {UUID} toUserId The toUser _id * @apiParam {UUID} toUserId The toUser _id
* *
* @apiSuccess {} Object Returns an empty object * @apiSuccess {Object} empty An empty Object
*/ */
api.sendPrivateMessage = { api.sendPrivateMessage = {
method: 'POST', method: 'POST',
@@ -295,7 +295,7 @@ api.sendPrivateMessage = {
* @apiParam {String} message The message * @apiParam {String} message The message
* @apiParam {UUID} toUserId The toUser _id * @apiParam {UUID} toUserId The toUser _id
* *
* @apiSuccess {} Object Returns an empty object * @apiSuccess {Object} empty An empty Object
*/ */
api.transferGems = { api.transferGems = {
method: 'POST', 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 * @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 = { api.deleteUser = {
method: 'DELETE', method: 'DELETE',
@@ -309,7 +309,7 @@ const partyMembersFields = 'profile.name stats achievements items.special';
* @apiParam {string} spellId The spell to cast. * @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. * @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 = { api.castSpell = {
method: 'POST', method: 'POST',
@@ -773,7 +773,7 @@ api.userOpenMysteryItem = {
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UserAddWebhook * @apiName UserAddWebhook
* @apiGroup User * @apiGroup User
* @apiSuccess {} * @apiSuccess {Object} webhook The created webhook
**/ **/
api.addWebhook = { api.addWebhook = {
method: 'POST', method: 'POST',
@@ -792,7 +792,7 @@ api.addWebhook = {
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UserUpdateWebhook * @apiName UserUpdateWebhook
* @apiGroup User * @apiGroup User
* @apiSuccess {} * @apiSuccess {Object} webhook The updated webhook
**/ **/
api.updateWebhook = { api.updateWebhook = {
method: 'PUT', method: 'PUT',
@@ -811,7 +811,7 @@ api.updateWebhook = {
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName UserDeleteWebhook * @apiName UserDeleteWebhook
* @apiGroup User * @apiGroup User
* @apiSuccess {} * @apiSuccess {Object} webhooks The user webhooks
**/ **/
api.deleteWebhook = { api.deleteWebhook = {
method: 'DELETE', method: 'DELETE',
@@ -979,7 +979,7 @@ api.userRebirth = {
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName BlockUser * @apiName BlockUser
* @apiGroup User * @apiGroup User
* @apiSuccess {} * @apiSuccess user.inbox.blocks
**/ **/
api.blockUser = { api.blockUser = {
method: 'POST', method: 'POST',
@@ -998,7 +998,7 @@ api.blockUser = {
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName deleteMessage * @apiName deleteMessage
* @apiGroup User * @apiGroup User
* @apiSuccess {} * @apiSuccess user.inbox.messages
**/ **/
api.deleteMessage = { api.deleteMessage = {
method: 'DELETE', method: 'DELETE',
@@ -1017,7 +1017,7 @@ api.deleteMessage = {
* @apiVersion 3.0.0 * @apiVersion 3.0.0
* @apiName clearMessages * @apiName clearMessages
* @apiGroup User * @apiGroup User
* @apiSuccess {} * @apiSuccess user.inbox.messages
**/ **/
api.clearMessages = { api.clearMessages = {
method: 'DELETE', method: 'DELETE',