yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-12-26 22:54:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

clean up js doc

Browse Source
This commit is contained in:
Mark Kaylor 2022-04-05 17:24:39 +02:00
parent 487b06f46d
commit dd6abff2a2
2 changed files with 2 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
packages/plugins/documentation/server/services/helpers/build-api-endpoint-path.js
View File

@ -75,6 +75,7 @@ const getPathWithPrefix = (prefix, path) => {
* @param {object} apiInfo
* @property {object} apiInfo.routeInfo - The api routes object
* @property {string} apiInfo.uniqueName - Content type name | Api name + Content type name
* @property {object} apiInfo.contentTypeInfo - The info object found on content type schemas
*
* @returns {object}
*/
@ -143,12 +144,6 @@ const getPaths = ({ routeInfo, uniqueName, contentTypeInfo }) => {
* @decription Gets all open api paths object for a given content type
*
* @param {object} apiInfo
* @property {string} apiInfo.name - The name of the api
* @property {string} apiInfo.getter - api | plugin
* @property {array} apiInfo.ctNames - All contentType names on the api
* @property {string} apiInfo.uniqueName - Api name | Api name + Content type name
* @property {object} apiInfo.attributes - Attributes on content type
* @property {object} apiInfo.routeInfo - The routes for the api
*
* @returns {object} Open API paths
*/

2
packages/plugins/documentation/server/services/helpers/utils/get-api-responses.js
View File

@ -5,7 +5,7 @@ const pascalCase = require('./pascal-case');
/**
* @description - Builds the Swagger response object for a given api
*
* @param {object} attributes - The attributes found on a contentType
* @param {object} name - Name of the api or plugin
* @param {object} route - The current route
* @param {boolean} isListOfEntities - Checks for a list of entitities
*