@strapi/plugin-documentation 4.1.11 → 4.1.12

package/__tests__/build-component-schema.test.js

@@ -147,8 +147,10 @@ describe('Build Component Schema', () => {
 
     const expectedShape = {
       type: 'object',
+      required: ['data'],
       properties: {
         data: {
+          required: [],
           type: 'object',
           properties: { test: { type: 'string' } },
         },
@@ -237,6 +239,7 @@ describe('Build Component Schema', () => {
 
     const expectedShape = {
       type: 'object',
+      required: ['locale'],
       properties: { test: { type: 'string' } },
     };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "4.1.11",
+  "version": "4.1.12",
   "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
   "repository": {
     "type": "git",
@@ -24,8 +24,8 @@
     "test": "echo \"no tests yet\""
   },
   "dependencies": {
-    "@strapi/helper-plugin": "4.1.11",
-    "@strapi/utils": "4.1.11",
+    "@strapi/helper-plugin": "4.1.12",
+    "@strapi/utils": "4.1.12",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.5",
     "fs-extra": "10.0.0",
@@ -57,5 +57,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "698ae33e0007811ce24b568cc5d873d7a4d2a832"
+  "gitHead": "ab698015cfc4f43fa0ce2ae94ec59e00a67e4cda"
 }

package/server/config/default-plugin-config.js

@@ -48,7 +48,7 @@ module.exports = {
         properties: {
           data: {
             nullable: true,
-            oneOf: [{ type: 'object' }, { type: 'array' }],
+            oneOf: [{ type: 'object' }, { type: 'array', items: [] }],
           },
           error: {
             type: 'object',

package/server/services/helpers/build-api-endpoint-path.js

@@ -15,10 +15,10 @@ const { hasFindMethod, isLocalizedPath } = require('./utils/routes');
  * @param {string} routePath - The route's path property
  * @returns {string}
  */
-const parsePathWithVariables = (routePath) => {
+const parsePathWithVariables = routePath => {
   return pathToRegexp
     .parse(routePath)
-    .map((token) => {
+    .map(token => {
       if (_.isObject(token)) {
         return token.prefix + '{' + token.name + '}';
       }
@@ -35,11 +35,11 @@ const parsePathWithVariables = (routePath) => {
  *
  * @returns {object } Swagger path params object
  */
-const getPathParams = (routePath) => {
+const getPathParams = routePath => {
   return pathToRegexp
     .parse(routePath)
-    .filter((token) => _.isObject(token))
-    .map((param) => {
+    .filter(token => _.isObject(token))
+    .map(param => {
       return {
         name: param.name,
         in: 'path',
@@ -83,7 +83,7 @@ const getPathWithPrefix = (prefix, route) => {
  */
 const getPaths = ({ routeInfo, uniqueName, contentTypeInfo }) => {
   // Get the routes for the current content type
-  const contentTypeRoutes = routeInfo.routes.filter((route) => {
+  const contentTypeRoutes = routeInfo.routes.filter(route => {
     return (
       route.path.includes(contentTypeInfo.pluralName) ||
       route.path.includes(contentTypeInfo.singularName)
@@ -152,7 +152,7 @@ const getPaths = ({ routeInfo, uniqueName, contentTypeInfo }) => {
  *
  * @returns {object} Open API paths
  */
-const getAllPathsForContentType = (apiInfo) => {
+const getAllPathsForContentType = apiInfo => {
   let paths = {};
 
   const pathsObject = getPaths(apiInfo);
@@ -175,7 +175,7 @@ const getAllPathsForContentType = (apiInfo) => {
  *
  * @returns {object}
  */
-const buildApiEndpointPath = (api) => {
+const buildApiEndpointPath = 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

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

@@ -20,11 +20,9 @@ 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);
+  const routeMethods = routeInfo.routes.map(route => route.method);
   // Check for localized paths
-  const hasLocalizationPath = routeInfo.routes.filter((route) =>
-    isLocalizedPath(route.path)
-  ).length;
+  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 = [
@@ -38,23 +36,24 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
     ];
     const attributesForRequest = _.omit(attributes, attributesToOmit);
 
-    const requiredAttributes = Object.entries(attributesForRequest)
-      .filter(([, attribute]) => attribute.required)
-      .map(([attributeName, attribute]) => {
-        return { [attributeName]: attribute };
-      });
+    // Get a list of required attribute names
+    const requiredAttributes = Object.entries(attributesForRequest).reduce((acc, attribute) => {
+      const [attributeKey, attributeValue] = attribute;
 
-    const requestAttributes =
-      routeMethods.includes('POST') && requiredAttributes.length
-        ? Object.assign({}, ...requiredAttributes)
-        : attributesForRequest;
+      if (attributeValue.required) {
+        acc.push(attributeKey);
+      }
+
+      return acc;
+    }, []);
 
     if (hasLocalizationPath) {
       schemas = {
         ...schemas,
         [`${pascalCase(uniqueName)}LocalizationRequest`]: {
+          required: [...requiredAttributes, 'locale'],
           type: 'object',
-          properties: cleanSchemaAttributes(requestAttributes, { isRequest: true }),
+          properties: cleanSchemaAttributes(attributesForRequest, { isRequest: true }),
         },
       };
     }
@@ -64,10 +63,12 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
       ...schemas,
       [`${pascalCase(uniqueName)}Request`]: {
         type: 'object',
+        required: ['data'],
         properties: {
           data: {
+            required: requiredAttributes,
             type: 'object',
-            properties: cleanSchemaAttributes(requestAttributes, { isRequest: true }),
+            properties: cleanSchemaAttributes(attributesForRequest, { isRequest: true }),
           },
         },
       },
@@ -88,7 +89,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
   }
 
   // Check for routes that need to return a list
-  const hasListOfEntities = routeInfo.routes.filter((route) => hasFindMethod(route.handler)).length;
+  const hasListOfEntities = routeInfo.routes.filter(route => hasFindMethod(route.handler)).length;
   if (hasListOfEntities) {
     // Build the list response schema
     schemas = {
@@ -143,7 +144,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
   return schemas;
 };
 
-const buildComponentSchema = (api) => {
+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

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

@@ -113,7 +113,7 @@ const cleanSchemaAttributes = (attributes, { typeMap = new Map(), isRequest = fa
         break;
       }
       case 'dynamiczone': {
-        const components = attribute.components.map((component) => {
+        const components = attribute.components.map(component => {
           const componentAttributes = strapi.components[component].attributes;
           return {
             type: 'object',

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

@@ -2,7 +2,7 @@
 
 const _ = require('lodash');
 
-const pascalCase = (string) => {
+const pascalCase = string => {
   return _.upperFirst(_.camelCase(string));
 };
 

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

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