@strapi/plugin-documentation 0.0.0-00a3f69152eb918683ed5c05bfed9c45495c0a87

package/server/services/helpers/utils/get-api-responses.js

@@ -0,0 +1,105 @@
+'use strict';
+
+const pascalCase = require('./pascal-case');
+
+/**
+ * @description - Builds the Swagger response object for a given api
+ *
+ * @param {object} name - Name of the api or plugin
+ * @param {object} route - The current route
+ * @param {boolean} isListOfEntities - Checks for a list of entitities
+ *
+ * @returns The Swagger responses
+ */
+const getApiResponse = ({
+  uniqueName,
+  route,
+  isListOfEntities = false,
+  isLocalizationPath = false,
+}) => {
+  const getSchema = () => {
+    if (route.method === 'DELETE') {
+      return {
+        type: 'integer',
+        format: 'int64',
+      };
+    }
+
+    if (isLocalizationPath) {
+      return { $ref: `#/components/schemas/${pascalCase(uniqueName)}LocalizationResponse` };
+    }
+
+    if (isListOfEntities) {
+      return { $ref: `#/components/schemas/${pascalCase(uniqueName)}ListResponse` };
+    }
+
+    return { $ref: `#/components/schemas/${pascalCase(uniqueName)}Response` };
+  };
+
+  const schema = getSchema();
+
+  return {
+    responses: {
+      200: {
+        description: 'OK',
+        content: {
+          'application/json': {
+            schema,
+          },
+        },
+      },
+      400: {
+        description: 'Bad Request',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+      401: {
+        description: 'Unauthorized',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+      403: {
+        description: 'Forbidden',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+      404: {
+        description: 'Not Found',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+      500: {
+        description: 'Internal Server Error',
+        content: {
+          'application/json': {
+            schema: {
+              $ref: '#/components/schemas/Error',
+            },
+          },
+        },
+      },
+    },
+  };
+};
+
+module.exports = getApiResponse;

package/server/services/helpers/utils/get-schema-data.js

@@ -0,0 +1,32 @@
+'use strict';
+
+/**
+ * @description Determines the format of the data response
+ * 
+ * @param {boolean} isListOfEntities - Checks for a multiple entities
+ * @param {object} attributes - The attributes found on a contentType
+ 
+ * @returns object | array of attributes
+ */
+module.exports = (isListOfEntities, attributes) => {
+  if (isListOfEntities) {
+    return {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          id: { type: 'number' },
+          attributes: { type: 'object', properties: attributes },
+        },
+      },
+    };
+  }
+
+  return {
+    type: 'object',
+    properties: {
+      id: { type: 'number' },
+      attributes: { type: 'object', properties: attributes },
+    },
+  };
+};

package/server/services/helpers/utils/loop-content-type-names.js

@@ -0,0 +1,53 @@
+'use strict';
+
+const _ = require('lodash');
+
+/**
+ * @description A reusable loop for building api endpoint paths and component schemas
+ *
+ * @param {object} api - Api information to pass to the callback
+ * @param {function} callback - Logic to execute for the given api
+ *
+ * @returns {object}
+ */
+const loopContentTypeNames = (api, callback) => {
+  let result = {};
+  for (const contentTypeName of api.ctNames) {
+    // Get the attributes found on the api's contentType
+    const uid = `${api.getter}::${api.name}.${contentTypeName}`;
+    const { attributes, info: contentTypeInfo } = strapi.contentType(uid);
+
+    // Get the routes for the current api
+    const routeInfo =
+      api.getter === 'plugin'
+        ? strapi.plugin(api.name).routes['content-api']
+        : strapi.api[api.name].routes[contentTypeName];
+
+    // Continue to next iteration if routeInfo is undefined
+    if (!routeInfo) continue;
+
+    // Uppercase the first letter of the api name
+    const apiName = _.upperFirst(api.name);
+
+    // Create a unique name if the api name and contentType name don't match
+    const uniqueName =
+      api.name === contentTypeName ? apiName : `${apiName} - ${_.upperFirst(contentTypeName)}`;
+
+    const apiInfo = {
+      ...api,
+      routeInfo,
+      attributes,
+      uniqueName,
+      contentTypeInfo,
+    };
+
+    result = {
+      ...result,
+      ...callback(apiInfo),
+    };
+  }
+
+  return result;
+};
+
+module.exports = loopContentTypeNames;

package/server/services/helpers/utils/pascal-case.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const _ = require('lodash');
+
+const pascalCase = (string) => {
+  return _.upperFirst(_.camelCase(string));
+};
+
+module.exports = pascalCase;

package/server/services/helpers/utils/query-params.js

@@ -0,0 +1,95 @@
+'use strict';
+
+module.exports = [
+  {
+    name: 'sort',
+    in: 'query',
+    description: 'Sort by attributes ascending (asc) or descending (desc)',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'string',
+    },
+  },
+  {
+    name: 'pagination[withCount]',
+    in: 'query',
+    description: 'Retun page/pageSize (default: true)',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'boolean',
+    },
+  },
+  {
+    name: 'pagination[page]',
+    in: 'query',
+    description: 'Page number (default: 0)',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'integer',
+    },
+  },
+  {
+    name: 'pagination[pageSize]',
+    in: 'query',
+    description: 'Page size (default: 25)',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'integer',
+    },
+  },
+  {
+    name: 'pagination[start]',
+    in: 'query',
+    description: 'Offset value (default: 0)',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'integer',
+    },
+  },
+  {
+    name: 'pagination[limit]',
+    in: 'query',
+    description: 'Number of entities to return (default: 25)',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'integer',
+    },
+  },
+  {
+    name: 'fields',
+    in: 'query',
+    description: 'Fields to return (ex: title,author)',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'string',
+    },
+  },
+  {
+    name: 'populate',
+    in: 'query',
+    description: 'Relations to return',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'string',
+    },
+  },
+  {
+    name: 'filters',
+    in: 'query',
+    description: 'Filters to apply',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'object',
+    },
+    style: 'deepObject',
+  },
+];

package/server/services/helpers/utils/routes.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const hasFindMethod = (handler) => handler.split('.').pop() === 'find';
+
+const isLocalizedPath = (routePath) => routePath.includes('localizations');
+
+module.exports = {
+  isLocalizedPath,
+  hasFindMethod,
+};

package/server/services/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const documentation = require('./documentation');
+
+module.exports = {
+  documentation,
+};

package/strapi-admin.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./admin/src').default;

package/strapi-server.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./server');