@strapi/plugin-documentation 0.0.0-d0fee44d6f → 0.0.0-d36609ff26fb4e00a41a7e2b657f16c7466203fe

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

@@ -2,18 +2,26 @@
 
 const _ = require('lodash');
 const getSchemaData = require('./get-schema-data');
-
+const pascalCase = require('./pascal-case');
 /**
  * @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
+ * @param {{ typeMap: Map, isRequest: boolean, addComponentSchema: function, componentSchemaRefName: string }} opts
  * @returns Attributes using OpenAPI acceptable data types
  */
-const cleanSchemaAttributes = (attributes, { typeMap = new Map(), isRequest = false } = {}) => {
+const cleanSchemaAttributes = (
+  attributes,
+  {
+    typeMap = new Map(),
+    isRequest = false,
+    addComponentSchema = () => {},
+    componentSchemaRefName = '',
+  } = {}
+) => {
   const attributesCopy = _.cloneDeep(attributes);
 
-  for (const prop in attributesCopy) {
+  for (const prop of Object.keys(attributesCopy)) {
     const attribute = attributesCopy[prop];
     if (attribute.default) {
       delete attributesCopy[prop].default;
@@ -86,43 +94,53 @@ const cleanSchemaAttributes = (attributes, { typeMap = new Map(), isRequest = fa
       }
       case 'component': {
         const componentAttributes = strapi.components[attribute.component].attributes;
-
+        const rawComponentSchema = {
+          type: 'object',
+          properties: {
+            ...(isRequest ? {} : { id: { type: 'number' } }),
+            ...cleanSchemaAttributes(componentAttributes, {
+              typeMap,
+              isRequest,
+            }),
+          },
+        };
+        const refComponentSchema = {
+          $ref: `#/components/schemas/${pascalCase(attribute.component)}Component`,
+        };
+        const componentExists = addComponentSchema(
+          `${pascalCase(attribute.component)}Component`,
+          rawComponentSchema
+        );
+        const finalComponentSchema = componentExists ? refComponentSchema : rawComponentSchema;
         if (attribute.repeatable) {
           attributesCopy[prop] = {
             type: 'array',
-            items: {
-              type: 'object',
-              properties: {
-                ...(isRequest ? {} : { id: { type: 'string' } }),
-                ...cleanSchemaAttributes(componentAttributes, { typeMap, isRequest }),
-              },
-            },
+            items: finalComponentSchema,
           };
         } else {
-          attributesCopy[prop] = {
-            type: 'object',
-            properties: {
-              ...(isRequest ? {} : { id: { type: 'string' } }),
-              ...cleanSchemaAttributes(componentAttributes, {
-                typeMap,
-                isRequest,
-              }),
-            },
-          };
+          attributesCopy[prop] = finalComponentSchema;
         }
         break;
       }
       case 'dynamiczone': {
-        const components = attribute.components.map(component => {
+        const components = attribute.components.map((component) => {
           const componentAttributes = strapi.components[component].attributes;
-          return {
+          const rawComponentSchema = {
             type: 'object',
             properties: {
-              ...(isRequest ? {} : { id: { type: 'string' } }),
+              ...(isRequest ? {} : { id: { type: 'number' } }),
               __component: { type: 'string' },
-              ...cleanSchemaAttributes(componentAttributes, { typeMap, isRequest }),
+              ...cleanSchemaAttributes(componentAttributes, {
+                typeMap,
+                isRequest,
+                addComponentSchema,
+              }),
             },
           };
+          const refComponentSchema = { $ref: `#/components/schemas/${pascalCase(component)}` };
+          const componentExists = addComponentSchema(pascalCase(component), rawComponentSchema);
+          const finalComponentSchema = componentExists ? refComponentSchema : rawComponentSchema;
+          return finalComponentSchema;
         });
 
         attributesCopy[prop] = {
@@ -171,8 +189,13 @@ const cleanSchemaAttributes = (attributes, { typeMap = new Map(), isRequest = fa
 
         if (prop === 'localizations') {
           attributesCopy[prop] = {
-            type: 'array',
-            items: { type: 'object', properties: {} },
+            type: 'object',
+            properties: {
+              data: {
+                type: 'array',
+                items: componentSchemaRefName.length ? { $ref: componentSchemaRefName } : {},
+              },
+            },
           };
           break;
         }

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

@@ -15,7 +15,7 @@ module.exports = (isListOfEntities, attributes) => {
       items: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
+          id: { type: 'number' },
           attributes: { type: 'object', properties: attributes },
         },
       },
@@ -25,7 +25,7 @@ module.exports = (isListOfEntities, attributes) => {
   return {
     type: 'object',
     properties: {
-      id: { type: 'string' },
+      id: { type: 'number' },
       attributes: { type: 'object', properties: attributes },
     },
   };

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

@@ -1,4 +1,5 @@
 'use strict';
+
 const _ = require('lodash');
 
 /**

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/query-params.js

@@ -14,7 +14,7 @@ module.exports = [
   {
     name: 'pagination[withCount]',
     in: 'query',
-    description: 'Retun page/pageSize (default: true)',
+    description: 'Return page/pageSize (default: true)',
     deprecated: false,
     required: false,
     schema: {
@@ -81,4 +81,25 @@ module.exports = [
       type: 'string',
     },
   },
+  {
+    name: 'filters',
+    in: 'query',
+    description: 'Filters to apply',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'object',
+    },
+    style: 'deepObject',
+  },
+  {
+    name: 'locale',
+    in: 'query',
+    description: 'Locale to apply',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: '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,