@strapi/plugin-documentation 0.0.0-113ff29005

package/server/services/helpers/build-component-schema.js

@@ -0,0 +1,159 @@
+'use strict';
+
+const _ = require('lodash');
+
+const cleanSchemaAttributes = require('./utils/clean-schema-attributes');
+const loopContentTypeNames = require('./utils/loop-content-type-names');
+const pascalCase = require('./utils/pascal-case');
+const { hasFindMethod, isLocalizedPath } = require('./utils/routes');
+
+/**
+ * @decription Get all open api schema objects for a given content type
+ *
+ * @param {object} apiInfo
+ * @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 schemas
+ */
+const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
+  // Store response and request schemas in an object
+  let schemas = {};
+  // Get all the route methods
+  const routeMethods = routeInfo.routes.map((route) => route.method);
+  // Check for localized paths
+  const hasLocalizationPath = routeInfo.routes.filter((route) =>
+    isLocalizedPath(route.path)
+  ).length;
+  // When the route methods contain any post or put requests
+  if (routeMethods.includes('POST') || routeMethods.includes('PUT')) {
+    const attributesToOmit = [
+      'createdAt',
+      'updatedAt',
+      'publishedAt',
+      'publishedBy',
+      'updatedBy',
+      'createdBy',
+      'localizations',
+    ];
+    const attributesForRequest = _.omit(attributes, attributesToOmit);
+
+    // Get a list of required attribute names
+    const requiredAttributes = Object.entries(attributesForRequest).reduce((acc, attribute) => {
+      const [attributeKey, attributeValue] = attribute;
+
+      if (attributeValue.required) {
+        acc.push(attributeKey);
+      }
+
+      return acc;
+    }, []);
+
+    if (hasLocalizationPath) {
+      schemas = {
+        ...schemas,
+        [`${pascalCase(uniqueName)}LocalizationRequest`]: {
+          required: [...requiredAttributes, 'locale'],
+          type: 'object',
+          properties: cleanSchemaAttributes(attributesForRequest, { isRequest: true }),
+        },
+      };
+    }
+
+    // Build the request schema
+    schemas = {
+      ...schemas,
+      [`${pascalCase(uniqueName)}Request`]: {
+        type: 'object',
+        required: ['data'],
+        properties: {
+          data: {
+            required: requiredAttributes,
+            type: 'object',
+            properties: cleanSchemaAttributes(attributesForRequest, { isRequest: true }),
+          },
+        },
+      },
+    };
+  }
+
+  if (hasLocalizationPath) {
+    schemas = {
+      ...schemas,
+      [`${pascalCase(uniqueName)}LocalizationResponse`]: {
+        type: 'object',
+        properties: {
+          id: { type: 'string' },
+          ...cleanSchemaAttributes(attributes),
+        },
+      },
+    };
+  }
+
+  // Check for routes that need to return a list
+  const hasListOfEntities = routeInfo.routes.filter((route) => hasFindMethod(route.handler)).length;
+  if (hasListOfEntities) {
+    // Build the list response schema
+    schemas = {
+      ...schemas,
+      [`${pascalCase(uniqueName)}ListResponse`]: {
+        type: 'object',
+        properties: {
+          data: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                id: { type: 'string' },
+                attributes: { type: 'object', properties: cleanSchemaAttributes(attributes) },
+              },
+            },
+          },
+          meta: {
+            type: 'object',
+            properties: {
+              pagination: {
+                properties: {
+                  page: { type: 'integer' },
+                  pageSize: { type: 'integer', minimum: 25 },
+                  pageCount: { type: 'integer', maximum: 1 },
+                  total: { type: 'integer' },
+                },
+              },
+            },
+          },
+        },
+      },
+    };
+  }
+
+  // Build the response schema
+  schemas = {
+    ...schemas,
+    [`${pascalCase(uniqueName)}Response`]: {
+      type: 'object',
+      properties: {
+        data: {
+          type: 'object',
+          properties: {
+            id: { type: 'string' },
+            attributes: { type: 'object', properties: cleanSchemaAttributes(attributes) },
+          },
+        },
+        meta: { type: 'object' },
+      },
+    },
+  };
+
+  return schemas;
+};
+
+const buildComponentSchema = (api) => {
+  // A reusable loop for building paths and component schemas
+  // Uses the api param to build a new set of params for each content type
+  // Passes these new params to the function provided
+  return loopContentTypeNames(api, getAllSchemasForContentType);
+};
+
+module.exports = buildComponentSchema;

package/server/services/helpers/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const builApiEndpointPath = require('./build-api-endpoint-path');
+const buildComponentSchema = require('./build-component-schema');
+
+module.exports = {
+  builApiEndpointPath,
+  buildComponentSchema,
+};

package/server/services/helpers/utils/clean-schema-attributes.js

@@ -0,0 +1,212 @@
+'use strict';
+
+const _ = require('lodash');
+const getSchemaData = require('./get-schema-data');
+
+/**
+ * @description - Converts types found on attributes to OpenAPI acceptable data types
+ *
+ * @param {object} attributes - The attributes found on a contentType
+ * @param {{ typeMap: Map, isRequest: boolean }} opts
+ * @returns Attributes using OpenAPI acceptable data types
+ */
+const cleanSchemaAttributes = (attributes, { typeMap = new Map(), isRequest = false } = {}) => {
+  const attributesCopy = _.cloneDeep(attributes);
+
+  for (const prop of Object.keys(attributesCopy)) {
+    const attribute = attributesCopy[prop];
+    if (attribute.default) {
+      delete attributesCopy[prop].default;
+    }
+
+    switch (attribute.type) {
+      case 'password': {
+        if (!isRequest) {
+          delete attributesCopy[prop];
+          break;
+        }
+
+        attributesCopy[prop] = { type: 'string', format: 'password', example: '*******' };
+        break;
+      }
+      case 'email': {
+        attributesCopy[prop] = { type: 'string', format: 'email' };
+        break;
+      }
+      case 'string':
+      case 'text':
+      case 'richtext': {
+        attributesCopy[prop] = { type: 'string' };
+        break;
+      }
+      case 'timestamp': {
+        attributesCopy[prop] = { type: 'string', format: 'timestamp', example: Date.now() };
+        break;
+      }
+      case 'time': {
+        attributesCopy[prop] = { type: 'string', format: 'time', example: '12:54.000' };
+        break;
+      }
+      case 'date': {
+        attributesCopy[prop] = { type: 'string', format: 'date' };
+        break;
+      }
+      case 'datetime': {
+        attributesCopy[prop] = { type: 'string', format: 'date-time' };
+        break;
+      }
+      case 'boolean': {
+        attributesCopy[prop] = { type: 'boolean' };
+        break;
+      }
+      case 'enumeration': {
+        attributesCopy[prop] = { type: 'string', enum: attribute.enum };
+        break;
+      }
+      case 'decimal':
+      case 'float': {
+        attributesCopy[prop] = { type: 'number', format: 'float' };
+        break;
+      }
+      case 'integer': {
+        attributesCopy[prop] = { type: 'integer' };
+        break;
+      }
+      case 'biginteger': {
+        attributesCopy[prop] = { type: 'string', pattern: '^\\d*$', example: '123456789' };
+        break;
+      }
+      case 'json': {
+        attributesCopy[prop] = {};
+        break;
+      }
+      case 'uid': {
+        attributesCopy[prop] = { type: 'string' };
+        break;
+      }
+      case 'component': {
+        const componentAttributes = strapi.components[attribute.component].attributes;
+
+        if (attribute.repeatable) {
+          attributesCopy[prop] = {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                ...(isRequest ? {} : { id: { type: 'string' } }),
+                ...cleanSchemaAttributes(componentAttributes, { typeMap, isRequest }),
+              },
+            },
+          };
+        } else {
+          attributesCopy[prop] = {
+            type: 'object',
+            properties: {
+              ...(isRequest ? {} : { id: { type: 'string' } }),
+              ...cleanSchemaAttributes(componentAttributes, {
+                typeMap,
+                isRequest,
+              }),
+            },
+          };
+        }
+        break;
+      }
+      case 'dynamiczone': {
+        const components = attribute.components.map((component) => {
+          const componentAttributes = strapi.components[component].attributes;
+          return {
+            type: 'object',
+            properties: {
+              ...(isRequest ? {} : { id: { type: 'string' } }),
+              __component: { type: 'string' },
+              ...cleanSchemaAttributes(componentAttributes, { typeMap, isRequest }),
+            },
+          };
+        });
+
+        attributesCopy[prop] = {
+          type: 'array',
+          items: {
+            anyOf: components,
+          },
+        };
+        break;
+      }
+      case 'media': {
+        const imageAttributes = strapi.contentType('plugin::upload.file').attributes;
+        const isListOfEntities = attribute.multiple;
+
+        if (isRequest) {
+          const oneOfType = {
+            oneOf: [{ type: 'integer' }, { type: 'string' }],
+            example: 'string or id',
+          };
+
+          attributesCopy[prop] = isListOfEntities ? { type: 'array', items: oneOfType } : oneOfType;
+          break;
+        }
+
+        attributesCopy[prop] = {
+          type: 'object',
+          properties: {
+            data: getSchemaData(isListOfEntities, cleanSchemaAttributes(imageAttributes)),
+          },
+        };
+        break;
+      }
+
+      case 'relation': {
+        const isListOfEntities = attribute.relation.includes('ToMany');
+
+        if (isRequest) {
+          const oneOfType = {
+            oneOf: [{ type: 'integer' }, { type: 'string' }],
+            example: 'string or id',
+          };
+
+          attributesCopy[prop] = isListOfEntities ? { type: 'array', items: oneOfType } : oneOfType;
+          break;
+        }
+
+        if (prop === 'localizations') {
+          attributesCopy[prop] = {
+            type: 'array',
+            items: { type: 'object', properties: {} },
+          };
+          break;
+        }
+
+        if (!attribute.target || typeMap.has(attribute.target)) {
+          attributesCopy[prop] = {
+            type: 'object',
+            properties: { data: getSchemaData(isListOfEntities, {}) },
+          };
+          break;
+        }
+
+        typeMap.set(attribute.target, true);
+        const targetAttributes = strapi.contentType(attribute.target).attributes;
+
+        attributesCopy[prop] = {
+          type: 'object',
+          properties: {
+            data: getSchemaData(
+              isListOfEntities,
+              cleanSchemaAttributes(targetAttributes, { typeMap, isRequest })
+            ),
+          },
+        };
+
+        break;
+      }
+      default: {
+        throw new Error(`Invalid type ${attribute.type} while generating open api schema.`);
+      }
+    }
+  }
+
+  return attributesCopy;
+};
+
+module.exports = cleanSchemaAttributes;

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: 'string' },
+          attributes: { type: 'object', properties: attributes },
+        },
+      },
+    };
+  }
+
+  return {
+    type: 'object',
+    properties: {
+      id: { type: 'string' },
+      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,84 @@
+'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',
+    },
+  },
+];

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');