@strapi/plugin-documentation 0.0.0-fd8e4c6bfa → 0.0.0-ffd0a215143bcafd0354d791533a57a084e53ffb

package/README.md

@@ -53,19 +53,19 @@ It has the following structure
 
 ```
 {
-  "openapi": "3.0.0" // do not change this version
+  "openapi": "3.0.0", // do not change this version
   "info": {
     "version": "1.0.0" // change this line to create a new version
     ...
-  }
+  },
   "x-strapi-config": {
     "path": "/documentation", // Change this line to change to url of the doc
     "showGeneratedFiles": true // Do not change this line at the moment...
   },
-  "servers" {} // Your servers config (it will be automated),
+  "servers": {}, // Your servers config (it will be automated)
   "externalDocs": {},
-  "paths": {} // All your Api routes,
-  "tags": [] // Group of route
+  "paths": {}, // All your Api routes
+  "tags": [], // Group of route
   "components": {} // Default generated components and custom ones
 }
 ```

package/admin/src/translations/dk.json

@@ -29,7 +29,7 @@
   "pages.PluginPage.table.icon.regenerate": "Regenerér {target}",
   "pages.PluginPage.table.icon.show": "Åben {target}",
   "pages.PluginPage.table.version": "Version",
-  "pages.SettingsPage.Button.description": "Konfigurér dokumentations pluginnet",
+  "pages.SettingsPage.header.description": "Konfigurér dokumentations pluginnet",
   "pages.SettingsPage.header.save": "Gem",
   "pages.SettingsPage.toggle.hint": "Gør dokumentationens endpoint privat",
   "pages.SettingsPage.toggle.label": "Begrænset adgang",

package/admin/src/translations/en.json

@@ -29,7 +29,7 @@
   "pages.PluginPage.table.icon.regenerate": "Regenerate {target}",
   "pages.PluginPage.table.icon.show": "Open {target}",
   "pages.PluginPage.table.version": "Version",
-  "pages.SettingsPage.Button.description": "Configure the documentation plugin",
+  "pages.SettingsPage.header.description": "Configure the documentation plugin",
   "pages.SettingsPage.header.save": "Save",
   "pages.SettingsPage.toggle.hint": "Make the documentation endpoint private",
   "pages.SettingsPage.toggle.label": "Restricted Access",

package/admin/src/translations/es.json

@@ -29,7 +29,7 @@
   "pages.PluginPage.table.icon.regenerate": "Regenerar {target}",
   "pages.PluginPage.table.icon.show": "Abrir {target}",
   "pages.PluginPage.table.version": "Versión",
-  "pages.SettingsPage.Button.description": "Configura el plugin de documentación",
+  "pages.SettingsPage.header.description": "Configura el plugin de documentación",
   "pages.SettingsPage.header.save": "Guardar",
   "pages.SettingsPage.toggle.hint": "Hacer que la documentación sea privada",
   "pages.SettingsPage.toggle.label": "Acceso restringido",

package/admin/src/translations/ko.json

@@ -29,7 +29,7 @@
   "pages.PluginPage.table.icon.regenerate": "{target} 재생성",
   "pages.PluginPage.table.icon.show": "{target} 열기",
   "pages.PluginPage.table.version": "버전",
-  "pages.SettingsPage.Button.description": "도큐멘테이션 플러그인 설정",
+  "pages.SettingsPage.header.description": "도큐멘테이션 플러그인 설정",
   "pages.SettingsPage.header.save": "저장",
   "pages.SettingsPage.toggle.hint": "도큐멘테이션 엔드포인트를 비공개로 설정합니다.",
   "pages.SettingsPage.toggle.label": "액세스 제한",

package/admin/src/translations/pl.json

@@ -29,7 +29,7 @@
   "pages.PluginPage.table.icon.regenerate": "Wygeneruj ponownie {target}",
   "pages.PluginPage.table.icon.show": "Otwórz {target}",
   "pages.PluginPage.table.version": "Wersja",
-  "pages.SettingsPage.Button.description": "Skonfiguruj plugin dokumentacji",
+  "pages.SettingsPage.header.description": "Skonfiguruj plugin dokumentacji",
   "pages.SettingsPage.header.save": "Zapisz",
   "pages.SettingsPage.toggle.hint": "Ustaw endpoint dokumentacji na prywatny",
   "pages.SettingsPage.toggle.label": "Dostęp ograniczony",

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.header.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/tr.json

@@ -1,20 +1,39 @@
 {
-  "components.Row.open": "Open",
-  "components.Row.regenerate": "Regenerate",
-  "containers.HomePage.Block.title": "Versions",
-  "containers.HomePage.Button.update": "Update",
-  "containers.HomePage.PluginHeader.title": "Documentation - Settings",
-  "containers.HomePage.PopUpWarning.confirm": "I understand",
-  "containers.HomePage.PopUpWarning.message": "Are you sure you want to delete this version?",
-  "containers.HomePage.form.password": "Password",
-  "containers.HomePage.form.password.inputDescription": "Set the password to access the documentation",
-  "containers.HomePage.form.restrictedAccess": "Restricted access",
-  "containers.HomePage.form.restrictedAccess.inputDescription": "Make the documentation endpoint private. By default, the access is public",
-  "containers.HomePage.form.showGeneratedFiles": "Show generated files",
-  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Useful when you want to override the generated documentation. \nThe plugin will generate files split by model and plugin. \nBy enabling this option it will be easier to customize your documentation",
-  "error.deleteDoc.versionMissing": "The version you are trying to delete does not exist.",
-  "error.noVersion": "A version is required",
-  "error.regenerateDoc": "An error occurred while regenerating the doc",
-  "error.regenerateDoc.versionMissing": "The version you are trying to generate doesn't exist",
-  "notification.update.success": "Settings updated successfully"
+  "coming-soon": "Bu içerik şuanda düzenleniyor. Bir kaç hafta sonra yayında olacak!",
+  "components.Row.open": "Aç",
+  "components.Row.regenerate": "Yeniden üret",
+  "containers.HomePage.Block.title": "Versiyonlar",
+  "containers.HomePage.Button.update": "Güncelle",
+  "containers.HomePage.PluginHeader.title": "Dokümantasyon - Ayarlar",
+  "containers.HomePage.PopUpWarning.confirm": "Anladım",
+  "containers.HomePage.PopUpWarning.message": "Bu versiyonu silmek istediğinden emin misin?",
+  "containers.HomePage.copied": "Token panoya kopyalandı",
+  "containers.HomePage.form.jwtToken": "JWT tokenını al",
+  "containers.HomePage.form.jwtToken.description": "İstek atmak için bu tokenı kopyala ve swaggerda kullan",
+  "containers.HomePage.form.password": "Şifre",
+  "containers.HomePage.form.password.inputDescription": "Dokümantasyona erişmek için şifreyi belirle",
+  "containers.HomePage.form.restrictedAccess": "Kısıtlı erişim",
+  "containers.HomePage.form.restrictedAccess.inputDescription": "Dokümantasyon uç noktasını gizle. Varsayılan olarak erişim herkese açıktır",
+  "containers.HomePage.form.showGeneratedFiles": "Üretilen dosyaları göster",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Üretilen dokümantasyonun üzerine yazmak istediğinde kullanışlıdır. \nEklenti dosyaları model ve eklentilere göre ayrı olarak üretecektir. \nBu seçeneği etkinleştirerek dokümantasyonu özelleştirmen kolaylaşacaktır.",
+  "error.deleteDoc.versionMissing": "Silmek istediğin versiyon bulunmuyor.",
+  "error.noVersion": "Bir versiyon gerekli.",
+  "error.regenerateDoc": "Dokümanı yeniden üretirken bir hata oluştu",
+  "error.regenerateDoc.versionMissing": "Üretmeye çalıştığın versiyon bulunmuyor",
+  "notification.delete.success": "Doküman silindi",
+  "notification.generate.success": "Doküman üretildi",
+  "notification.update.success": "Ayarlar başarıyla güncellendi",
+  "pages.PluginPage.Button.open": "Dokümanı aç",
+  "pages.PluginPage.header.description": "Dokümantasyon eklentisini ayarla",
+  "pages.PluginPage.table.generated": "Son üretilme",
+  "pages.PluginPage.table.icon.regenerate": "Yeniden üret: {target}",
+  "pages.PluginPage.table.icon.show": "Aç: {target}",
+  "pages.PluginPage.table.version": "Versiyon",
+  "pages.SettingsPage.header.description": "Dokümantasyon eklentisini ayarla",
+  "pages.SettingsPage.header.save": "Kaydet",
+  "pages.SettingsPage.toggle.hint": "Dokümantasyon uç noktasını gizli yap",
+  "pages.SettingsPage.toggle.label": "Kısıtlı Erişim",
+  "plugin.description.long": "Bir OpenAPI Dokümanı oluştur ve SWAGGER UI ile APIni görselleştir.",
+  "plugin.description.short": "Bir OpenAPI Dokümanı oluştur ve SWAGGER UI ile APIni görselleştir.",
+  "plugin.name": "Dokümantasyon"
 }

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.header.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-fd8e4c6bfa",
+  "version": "0.0.0-ffd0a215143bcafd0354d791533a57a084e53ffb",
   "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-fd8e4c6bfa",
-    "@strapi/utils": "0.0.0-fd8e4c6bfa",
+    "@strapi/helper-plugin": "0.0.0-ffd0a215143bcafd0354d791533a57a084e53ffb",
+    "@strapi/utils": "0.0.0-ffd0a215143bcafd0354d791533a57a084e53ffb",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.12",
     "fs-extra": "10.0.0",
@@ -36,24 +36,24 @@
     "react": "^17.0.2",
     "react-copy-to-clipboard": "^5.1.0",
     "react-dom": "^17.0.2",
-    "react-intl": "5.25.1",
-    "react-redux": "7.2.8",
+    "react-intl": "6.2.7",
+    "react-redux": "8.0.5",
     "react-router": "^5.2.0",
-    "react-router-dom": "5.2.0",
-    "redux": "^4.0.1",
+    "react-router-dom": "5.3.4",
+    "redux": "^4.2.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": "11.2.7",
-    "msw": "0.42.3"
+    "@testing-library/react": "12.1.4",
+    "msw": "1.0.1"
   },
   "engines": {
-    "node": ">=14.19.1 <=16.x.x",
+    "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
   "strapi": {
@@ -62,5 +62,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "fd8e4c6bfa2fd687a3c62f8428e00f3b320c32c2"
+  "gitHead": "ffd0a215143bcafd0354d791533a57a084e53ffb"
 }

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

@@ -102,7 +102,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
       [`${pascalCase(uniqueName)}LocalizationResponse`]: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
+          id: { type: 'number' },
           ...cleanSchemaAttributes(attributes, { addComponentSchema }),
         },
       },
@@ -118,7 +118,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
       [`${pascalCase(uniqueName)}ListResponseDataItem`]: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
+          id: { type: 'number' },
           attributes: {
             type: 'object',
             properties: cleanSchemaAttributes(attributes, {
@@ -133,7 +133,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
       [`${pascalCase(uniqueName)}ListResponseDataItemLocalized`]: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
+          id: { type: 'number' },
           attributes: {
             type: 'object',
             properties: cleanSchemaAttributes(attributes, { addComponentSchema }),
@@ -172,7 +172,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
     [`${pascalCase(uniqueName)}ResponseDataObject`]: {
       type: 'object',
       properties: {
-        id: { type: 'string' },
+        id: { type: 'number' },
         attributes: {
           type: 'object',
           properties: cleanSchemaAttributes(attributes, {
@@ -187,7 +187,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
     [`${pascalCase(uniqueName)}ResponseDataObjectLocalized`]: {
       type: 'object',
       properties: {
-        id: { type: 'string' },
+        id: { type: 'number' },
         attributes: {
           type: 'object',
           properties: cleanSchemaAttributes(attributes, { addComponentSchema }),

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

@@ -97,7 +97,7 @@ const cleanSchemaAttributes = (
         const rawComponentSchema = {
           type: 'object',
           properties: {
-            ...(isRequest ? {} : { id: { type: 'string' } }),
+            ...(isRequest ? {} : { id: { type: 'number' } }),
             ...cleanSchemaAttributes(componentAttributes, {
               typeMap,
               isRequest,
@@ -128,7 +128,7 @@ const cleanSchemaAttributes = (
           const rawComponentSchema = {
             type: 'object',
             properties: {
-              ...(isRequest ? {} : { id: { type: 'string' } }),
+              ...(isRequest ? {} : { id: { type: 'number' } }),
               __component: { type: 'string' },
               ...cleanSchemaAttributes(componentAttributes, {
                 typeMap,

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',
+    },
+  },
 ];