fix(apidoc): make sure v4 routes do not show up in docs

This commit is contained in:
Matteo Pagliazzi
2020-06-25 16:07:03 +02:00
parent 7a2f05d136
commit 97857dbe9c
7 changed files with 14 additions and 0 deletions

View File

@@ -55,6 +55,7 @@ api.verifyUsername = {
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {post} /api/v4/user/auth/local/register Register
* @apiDescription Register a new user with email, login name, and password
* or attach local auth to a social user

View File

@@ -12,6 +12,7 @@ const api = {};
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {post} /api/v4/coupons/enter/:code Redeem a coupon code
* @apiName RedeemCouponCode
* @apiGroup Coupon

View File

@@ -33,6 +33,7 @@ function _deleteOtherPlatformsAnswers (faqObject, platform) {
}
/**
* @apiIgnore
* @api {get} /api/v4/faq Get faq in json format
* @apiDescription Does not require authentication.
* @apiName FaqGet

View File

@@ -15,6 +15,7 @@ const api = {};
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {delete} /api/v4/inbox/messages/:messageId Delete a message
* @apiName deleteMessage
* @apiGroup User
@@ -51,6 +52,7 @@ api.deleteMessage = {
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {delete} /api/v4/inbox/clear Delete all messages
* @apiName clearMessages
* @apiGroup User
@@ -74,6 +76,7 @@ api.clearMessages = {
};
/**
* @apiIgnore
* @api {get} /api/v4/inbox/conversations Get the conversations for a user
* @apiName conversations
* @apiGroup Inbox
@@ -116,6 +119,7 @@ api.conversations = {
};
/**
* @apiIgnore
* @api {get} /api/v4/inbox/paged-messages Get inbox messages for a user
* @apiName GetInboxMessages
* @apiGroup Inbox

View File

@@ -4,6 +4,7 @@ import { chatReporterFactory } from '../../libs/chatReporting/chatReporterFactor
const api = {};
/**
* @apiIgnore
* @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.

View File

@@ -13,6 +13,7 @@ const api = {};
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {get} /api/v4/user Get the authenticated user's profile
* @apiName UserGet
* @apiGroup User
@@ -70,6 +71,7 @@ api.getUser = {
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {put} /api/v4/user Update the user
* @apiName UserUpdate
* @apiGroup User
@@ -110,6 +112,7 @@ api.updateUser = {
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {post} /api/v4/user/rebirth Use Orb of Rebirth on user
* @apiName UserRebirth
* @apiGroup User
@@ -149,6 +152,7 @@ api.userRebirth = {
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {post} /api/v4/user/reroll Reroll a user using the Fortify Potion
* @apiName UserReroll
* @apiGroup User
@@ -182,6 +186,7 @@ api.userReroll = {
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {post} /api/v4/user/reset Reset user
* @apiName UserReset
* @apiGroup User

View File

@@ -14,6 +14,7 @@ const api = {};
/* NOTE this route has also an API v3 version */
/**
* @apiIgnore
* @api {post} /api/v4/user/class/cast/:spellId Cast a skill (spell) on a target
* @apiName UserCast
* @apiGroup User