@strapi/plugin-documentation 0.0.0-e6cac9fe30 → 0.0.0-e90885ab911e40d21aca1728d8abca8f13d582d5

package/admin/src/translations/sv.json

@@ -0,0 +1,39 @@
+{
+  "coming-soon": "Det här innehållet är för närvarande under uppbyggnad och kommer tillbaka om några veckor!",
+  "components.Row.open": "Öppen",
+  "components.Row.regenerate": "Återskapa",
+  "containers.HomePage.Block.title": "Versioner",
+  "containers.HomePage.Button.update": "Uppdatera",
+  "containers.HomePage.PluginHeader.title": "Dokumentation - Inställningar",
+  "containers.HomePage.PopUpWarning.confirm": "Jag förstår",
+  "containers.HomePage.PopUpWarning.message": "Är du säker på att du vill ta bort denna versionen?",
+  "containers.HomePage.copied": "Token har kopierats till urklipp",
+  "containers.HomePage.form.jwtToken": "Hämta din jwt-token",
+  "containers.HomePage.form.jwtToken.description": "Kopiera denna token och använd den i swagger för att göra förfrågningar",
+  "containers.HomePage.form.password": "Lösenord",
+  "containers.HomePage.form.password.inputDescription": "Ställ in lösenordet som ska behövas för att komma åt dokumentationen",
+  "containers.HomePage.form.restrictedAccess": "Begränsad åtkomst",
+  "containers.HomePage.form.restrictedAccess.inputDescription": "Gör dokumentationensrutten privat. Som standard är åtkomsten publik",
+  "containers.HomePage.form.showGeneratedFiles": "Visa genererade filer",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Användbart när du vill överskrida den automatiskt genererade dokumentationen. \nPluginet genererar filer uppdelade efter modell och plugin. \nGenom att aktivera det här blir det lättare att anpassa din dokumentation",
+  "error.deleteDoc.versionMissing": "Den version du försöker ta bort finns inte.",
+  "error.noVersion": "En version krävs",
+  "error.regenerateDoc": "Ett fel uppstod när dokumentet återskapades",
+  "error.regenerateDoc.versionMissing": "Den version du försöker generera finns inte",
+  "notification.delete.success": "Dokument raderat",
+  "notification.generate.success": "Dokument genererat",
+  "notification.update.success": "Inställningarna har uppdaterats",
+  "pages.PluginPage.Button.open": "Öppna dokumentation",
+  "pages.PluginPage.header.description": "Konfigurera dokumentationspluginet",
+  "pages.PluginPage.table.generated": "Senast genererade",
+  "pages.PluginPage.table.icon.regenerate": "Återskapa {target}",
+  "pages.PluginPage.table.icon.show": "Öppna {target}",
+  "pages.PluginPage.table.version": "Version",
+  "pages.SettingsPage.Button.description": "Konfigurera dokumentationspluginet",
+  "pages.SettingsPage.header.save": "Spara",
+  "pages.SettingsPage.toggle.hint": "Gör dokumentationensrutten privat",
+  "pages.SettingsPage.toggle.label": "Begränsad åtkomst",
+  "plugin.description.long": "Skapa ett OpenAPI-dokument och visualisera din API med SWAGGER UI.",
+  "plugin.description.short": "Skapa ett OpenAPI-dokument och visualisera din API med SWAGGER UI.",
+  "plugin.name": "Dokumentation"
+}

package/admin/src/translations/zh.json

@@ -1,4 +1,5 @@
 {
+  "coming-soon": "此內容目前正在構建，將在幾周後回歸！",
   "components.Row.open": "開啟",
   "components.Row.regenerate": "重新產生",
   "containers.HomePage.Block.title": "版本",
@@ -6,19 +7,33 @@
   "containers.HomePage.PluginHeader.title": "文件資料 - 設定",
   "containers.HomePage.PopUpWarning.confirm": "我了解了",
   "containers.HomePage.PopUpWarning.message": "你確定要刪除這個版本嗎？",
-  "containers.HomePage.copied": "Token 已經複製到剪貼簿",
-  "containers.HomePage.form.jwtToken": "存取你的 jwt token",
-  "containers.HomePage.form.jwtToken.description": "複製這個token並於swagger中使用於發出請求",
+  "containers.HomePage.copied": "權杖已經複製到剪貼簿",
+  "containers.HomePage.form.jwtToken": "存取你的 jwt 權杖",
+  "containers.HomePage.form.jwtToken.description": "複製這個權杖並於 swagger 中使用於發出請求",
   "containers.HomePage.form.password": "密碼",
   "containers.HomePage.form.password.inputDescription": "設定密碼存取權限",
   "containers.HomePage.form.restrictedAccess": "存取受到限制",
-  "containers.HomePage.form.restrictedAccess.inputDescription": "將endpoints設定為私密的. 預設是對外公開的",
+  "containers.HomePage.form.restrictedAccess.inputDescription": "將 endpoints 設定為私密的。預設是對外公開的",
   "containers.HomePage.form.showGeneratedFiles": "顯示產生的檔案",
-  "containers.HomePage.form.showGeneratedFiles.inputDescription": "用於覆寫產生的文件檔案時. \n擴充套件會依照model及plugin分別產生檔案. \n啟用這個選項將會方便你客製化文件資料",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "用於覆寫產生的文件檔案時。\n擴充套件會依照model及plugin分別產生檔案。\n啟用這個選項將會方便你客製化文件資料",
   "error.deleteDoc.versionMissing": "你想刪除的版本不存在",
   "error.noVersion": "版本是必填欄位",
   "error.regenerateDoc": "重新產生文件資料時發生了錯誤",
   "error.regenerateDoc.versionMissing": "你想產生的版本不存在",
+  "notification.delete.success": "文件已刪除",
+  "notification.generate.success": "文件已重新產生",
   "notification.update.success": "更新設定成功",
+  "pages.PluginPage.Button.open": "開啟說明文件",
+  "pages.PluginPage.header.description": "設定說明文件外掛程式",
+  "pages.PluginPage.table.generated": "最後產生時間",
+  "pages.PluginPage.table.icon.regenerate": "重新產生 {target}",
+  "pages.PluginPage.table.icon.show": "開啟 {target}",
+  "pages.PluginPage.table.version": "版本",
+  "pages.SettingsPage.Button.description": "設定說明文件外掛程式",
+  "pages.SettingsPage.header.save": "儲存",
+  "pages.SettingsPage.toggle.hint": "將說明文件端點設為私人",
+  "pages.SettingsPage.toggle.label": "受限存取",
+  "plugin.description.long": "建立 OpenAPI 文件，並透過 SWAGGER UI 可視化您的 API。",
+  "plugin.description.short": "建立 OpenAPI 文件，並透過 SWAGGER UI 可視化您的 API。",
   "plugin.name": "文件資料"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "0.0.0-e6cac9fe30",
+  "version": "0.0.0-e90885ab911e40d21aca1728d8abca8f13d582d5",
   "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": "0.0.0-e6cac9fe30",
-    "@strapi/utils": "0.0.0-e6cac9fe30",
+    "@strapi/helper-plugin": "0.0.0-e90885ab911e40d21aca1728d8abca8f13d582d5",
+    "@strapi/utils": "0.0.0-e90885ab911e40d21aca1728d8abca8f13d582d5",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.12",
     "fs-extra": "10.0.0",
@@ -36,20 +36,24 @@
     "react": "^17.0.2",
     "react-copy-to-clipboard": "^5.1.0",
     "react-dom": "^17.0.2",
-    "react-intl": "5.20.2",
+    "react-intl": "5.25.1",
     "react-redux": "7.2.8",
     "react-router": "^5.2.0",
-    "react-router-dom": "5.2.0",
+    "react-router-dom": "5.3.4",
     "redux": "^4.0.1",
     "reselect": "^4.0.0",
-    "swagger-ui-dist": "4.12.0",
+    "swagger-ui-dist": "4.15.5",
     "yaml": "1.10.2"
   },
   "peerDependencies": {
     "@strapi/strapi": "^4.0.0"
   },
+  "devDependencies": {
+    "@testing-library/react": "12.1.4",
+    "msw": "0.49.1"
+  },
   "engines": {
-    "node": ">=14.19.1 <=16.x.x",
+    "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
   "strapi": {
@@ -58,5 +62,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "e6cac9fe309b80c9c59cde56d6b25fc6cd40bc8d"
+  "gitHead": "e90885ab911e40d21aca1728d8abca8f13d582d5"
 }

package/server/services/documentation.js

@@ -15,12 +15,13 @@ module.exports = ({ strapi }) => {
 
   return {
     registerDoc(doc) {
+      let registeredDoc = doc;
       // parseYaml
       if (typeof doc === 'string') {
-        doc = require('yaml').parse(doc);
+        registeredDoc = require('yaml').parse(registeredDoc);
       }
       // receive an object we can register it directly
-      registeredDocs.push(doc);
+      registeredDocs.push(registeredDoc);
     },
     getDocumentationVersion() {
       return _.get(config, 'info.version');

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

@@ -46,7 +46,7 @@ const getPathParams = (routePath) => {
         description: '',
         deprecated: false,
         required: true,
-        schema: { type: 'string' },
+        schema: { type: 'number' },
       };
     });
 };

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

@@ -20,6 +20,18 @@ const { hasFindMethod, isLocalizedPath } = require('./utils/routes');
 const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
   // Store response and request schemas in an object
   let schemas = {};
+  let componentSchemas = {};
+  // adds a ComponentSchema to the Schemas so it can be used as Ref
+  const addComponentSchema = (schemaName, schema) => {
+    if (!Object.keys(schema) || !Object.keys(schema.properties)) {
+      return false;
+    }
+    componentSchemas = {
+      ...componentSchemas,
+      [schemaName]: schema,
+    };
+    return true;
+  };
   // Get all the route methods
   const routeMethods = routeInfo.routes.map((route) => route.method);
   // Check for localized paths
@@ -56,7 +68,10 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
         [`${pascalCase(uniqueName)}LocalizationRequest`]: {
           required: [...requiredAttributes, 'locale'],
           type: 'object',
-          properties: cleanSchemaAttributes(attributesForRequest, { isRequest: true }),
+          properties: cleanSchemaAttributes(attributesForRequest, {
+            isRequest: true,
+            addComponentSchema,
+          }),
         },
       };
     }
@@ -71,7 +86,10 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
           data: {
             required: requiredAttributes,
             type: 'object',
-            properties: cleanSchemaAttributes(attributesForRequest, { isRequest: true }),
+            properties: cleanSchemaAttributes(attributesForRequest, {
+              isRequest: true,
+              addComponentSchema,
+            }),
           },
         },
       },
@@ -84,8 +102,8 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
       [`${pascalCase(uniqueName)}LocalizationResponse`]: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
-          ...cleanSchemaAttributes(attributes),
+          id: { type: 'number' },
+          ...cleanSchemaAttributes(attributes, { addComponentSchema }),
         },
       },
     };
@@ -97,17 +115,37 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
     // Build the list response schema
     schemas = {
       ...schemas,
-      [`${pascalCase(uniqueName)}ListResponse`]: {
+      [`${pascalCase(uniqueName)}ListResponseDataItem`]: {
         type: 'object',
+        properties: {
+          id: { type: 'number' },
+          attributes: {
+            type: 'object',
+            properties: cleanSchemaAttributes(attributes, {
+              addComponentSchema,
+              componentSchemaRefName: `#/components/schemas/${pascalCase(
+                uniqueName
+              )}ListResponseDataItemLocalized`,
+            }),
+          },
+        },
+      },
+      [`${pascalCase(uniqueName)}ListResponseDataItemLocalized`]: {
+        type: 'object',
+        properties: {
+          id: { type: 'number' },
+          attributes: {
+            type: 'object',
+            properties: cleanSchemaAttributes(attributes, { addComponentSchema }),
+          },
+        },
+      },
+      [`${pascalCase(uniqueName)}ListResponse`]: {
         properties: {
           data: {
             type: 'array',
             items: {
-              type: 'object',
-              properties: {
-                id: { type: 'string' },
-                attributes: { type: 'object', properties: cleanSchemaAttributes(attributes) },
-              },
+              $ref: `#/components/schemas/${pascalCase(uniqueName)}ListResponseDataItem`,
             },
           },
           meta: {
@@ -131,22 +169,41 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
   // Build the response schema
   schemas = {
     ...schemas,
-    [`${pascalCase(uniqueName)}Response`]: {
+    [`${pascalCase(uniqueName)}ResponseDataObject`]: {
       type: 'object',
       properties: {
-        data: {
+        id: { type: 'number' },
+        attributes: {
           type: 'object',
-          properties: {
-            id: { type: 'string' },
-            attributes: { type: 'object', properties: cleanSchemaAttributes(attributes) },
-          },
+          properties: cleanSchemaAttributes(attributes, {
+            addComponentSchema,
+            componentSchemaRefName: `#/components/schemas/${pascalCase(
+              uniqueName
+            )}ResponseDataObjectLocalized`,
+          }),
+        },
+      },
+    },
+    [`${pascalCase(uniqueName)}ResponseDataObjectLocalized`]: {
+      type: 'object',
+      properties: {
+        id: { type: 'number' },
+        attributes: {
+          type: 'object',
+          properties: cleanSchemaAttributes(attributes, { addComponentSchema }),
+        },
+      },
+    },
+    [`${pascalCase(uniqueName)}Response`]: {
+      properties: {
+        data: {
+          $ref: `#/components/schemas/${pascalCase(uniqueName)}ResponseDataObject`,
         },
         meta: { type: 'object' },
       },
     },
   };
-
-  return schemas;
+  return { ...schemas, ...componentSchemas };
 };
 
 const buildComponentSchema = (api) => {

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

@@ -2,15 +2,23 @@
 
 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 of Object.keys(attributesCopy)) {
@@ -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 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/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',
+    },
+  },
 ];