yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-11-10 07:10:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix jsdoc params

Browse Source
This commit is contained in:
Ben Irvin 2022-08-19 16:41:39 +02:00
parent e79617b094
commit c6aef125c9
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
packages/core/admin/server/services/api-token.js
View File

@ -14,11 +14,11 @@ const constants = require('./constants');
* *
* @property {number|string} id * @property {number|string} id
* @property {string} name * @property {string} name
* @property {string} [description] * @property {string} description
* @property {string} accessKey * @property {string} accessKey
* @property {number} lastUsedAt * @property {number} lastUsedAt
* @property {TokenType} type * @property {TokenType} type
* @property {(number|ApiTokenPermission)[]} [permissions] * @property {(number|ApiTokenPermission)[]} permissions
*/ */
/** /**
@ -26,7 +26,7 @@ const constants = require('./constants');
* *
* @property {number|string} id * @property {number|string} id
* @property {string} action * @property {string} action
* @property {ApiToken|number} [token] * @property {ApiToken|number} token
*/ */
/** @constant {Array<string>} */ /** @constant {Array<string>} */
@ -49,11 +49,11 @@ const assertCustomTokenPermissionsValidity = (attributes) => {
/** /**
* @param {Object} whereParams * @param {Object} whereParams
* @param {string|number} [whereParams.id] * @param {string|number} whereParams.id
* @param {string} [whereParams.name] * @param {string} whereParams.name
* @param {number} [whereParams.lastUsedAt] * @param {number} whereParams.lastUsedAt
* @param {string} [whereParams.description] * @param {string} whereParams.description
* @param {string} [whereParams.accessKey] * @param {string} whereParams.accessKey
* *
* @returns {Promise<boolean>} * @returns {Promise<boolean>}
*/ */
@ -79,8 +79,8 @@ const hash = (accessKey) => {
* @param {Object} attributes * @param {Object} attributes
* @param {TokenType} attributes.type * @param {TokenType} attributes.type
* @param {string} attributes.name * @param {string} attributes.name
* @param {string[]} [attributes.permissions] * @param {string[]} attributes.permissions
* @param {string} [attributes.description] * @param {string} attributes.description
* *
* @returns {Promise<ApiToken>} * @returns {Promise<ApiToken>}
*/ */
@ -199,8 +199,8 @@ const getByName = async (name) => {
* @param {TokenType} attributes.type * @param {TokenType} attributes.type
* @param {string} attributes.name * @param {string} attributes.name
* @param {number} attributes.lastUsedAt * @param {number} attributes.lastUsedAt
* @param {string[]} [attributes.permissions] * @param {string[]} attributes.permissions
* @param {string} [attributes.description] * @param {string} attributes.description
* *
* @returns {Promise<Omit<ApiToken, 'accessKey'>>} * @returns {Promise<Omit<ApiToken, 'accessKey'>>}
*/ */
@ -310,11 +310,11 @@ const update = async (id, attributes) => {
/** /**
* @param {Object} whereParams * @param {Object} whereParams
* @param {string|number} [whereParams.id] * @param {string|number} whereParams.id
* @param {string} [whereParams.name] * @param {string} whereParams.name
* @param {number} [whereParams.lastUsedAt] * @param {number} whereParams.lastUsedAt
* @param {string} [whereParams.description] * @param {string} whereParams.description
* @param {string} [whereParams.accessKey] * @param {string} whereParams.accessKey
* *
* @returns {Promise<Omit<ApiToken, 'accessKey'> | null>} * @returns {Promise<Omit<ApiToken, 'accessKey'> | null>}
*/ */