@strapi/plugin-documentation 4.3.0-beta.1 → 4.3.1

package/README.md

@@ -1,7 +1,6 @@
 # Plugin documentation
 
 This plugin automates your API documentation creation. It basically generates a swagger file. It follows the [Open API specification version 3.0.1](https://swagger.io/specification/).
-The documentation plugin is not release on npm yet, Here's how to install it.
 
 ## Usage
 
@@ -17,7 +16,7 @@ The documentation plugin is not release on npm yet, Here's how to install it.
 
 ### Config
 
-The plugin comes with a `settings.json` file located in `./my-project/plugins/documentation/config` folder where you can specify all your environment variables, licenses, external documentation and so one...
+Create a `settings.json` file located in `src/extensions/documentation/config` folder where you can specify all your environment variables, licenses, external documentation and so one...
 You can add all the entries listed in the [specification](https://swagger.io/specification/).
 
 _NOTE_ if you need to add a custom key you can do it by prefixing your key by `x-{something}`
@@ -48,7 +47,7 @@ When you start your server with this plugin installed it will automatically crea
 
 #### full_documentation.json
 
-The combined documentation is merged into the `full_documentation.json` file and it's located in `./plugins/documentation/{version}/full_documentation.json`
+The combined documentation is merged into the `full_documentation.json` file and it's located in `src/extensions/documentation/documentation/{version}/full_documentation.json`
 
 It has the following structure
 
@@ -84,7 +83,7 @@ Overriding the `full_documentation.json` is a bad idea since it will be regenera
 
 **_NOTE 2_**
 
-You can easily modify the description, summary, parameters of a path however, for a response like the `200` you will need to write the full object. Take a look at the `./plugins/users-permissions/documentation/overrides/1.0.0/users-permissions-User.json` for a complete example.
+You can modify the `tags`, `paths`, and `components` keys on the generated documentation by providing replacement values. You can see how the API is used in the users-permissions plugin: `packages/plugins/users-permissions/server/register.js`
 
 ### FAQ
 

package/admin/src/translations/pl.json

@@ -1,9 +1,10 @@
 {
+  "coming-soon": "Zawartość w trakcie budowy, wróci w ciągu kilku tygodni!",
   "components.Row.open": "Otwórz",
   "components.Row.regenerate": "Wygeneruj ponownie",
   "containers.HomePage.Block.title": "Wersje",
   "containers.HomePage.Button.update": "Zaktualizuj",
-  "containers.HomePage.PluginHeader.title": "Dokuemntacja - Ustawienia",
+  "containers.HomePage.PluginHeader.title": "Dokumentacja - Ustawienia",
   "containers.HomePage.PopUpWarning.confirm": "Rozumiem",
   "containers.HomePage.PopUpWarning.message": "Czy jesteś pewien, że chcesz usunąć tę wersję?",
   "containers.HomePage.copied": "Token skopiowany do schowka",
@@ -11,14 +12,28 @@
   "containers.HomePage.form.jwtToken.description": "Skopiuj token i użyj go w swaggerze aby wykonać request",
   "containers.HomePage.form.password": "Hasło",
   "containers.HomePage.form.password.inputDescription": "Ustaw hasło aby uzyskać dostęp do dokumentacji",
-  "containers.HomePage.form.restrictedAccess": "Dostęp Ograniczony",
+  "containers.HomePage.form.restrictedAccess": "Dostęp ograniczony",
   "containers.HomePage.form.restrictedAccess.inputDescription": "Ustaw endpoint dokumentacji jako prywatny. Domyślnie dostęp jest publiczny.",
   "containers.HomePage.form.showGeneratedFiles": "Pokaż wygenerowane pliki",
-  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Przydatne, gdy chcesz nadpisać wygenerowaną dokumentację. \nWtyczka wygeneruje pliki i podzieli je według modelu i wtyczki. \nWłączenie tej opcji ułatwi dostosowywanie dokumentacji",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Przydatne, gdy chcesz nadpisać wygenerowaną dokumentację. \nPlugin wygeneruje pliki i podzieli je według modelu i pluginu. \nWłączenie tej opcji ułatwi dostosowywanie dokumentacji",
   "error.deleteDoc.versionMissing": "Wersja, którą próbujesz usunąć nie istnieje.",
   "error.noVersion": "Wersja jest wymagana",
   "error.regenerateDoc": "Wystąpił błąd podczas ponownego generowania dokumentacji",
-  "error.regenerateDoc.versionMissing": "Wersja, którą prubujesz wygenerować nie istnieje.",
+  "error.regenerateDoc.versionMissing": "Wersja, którą próbujesz wygenerować nie istnieje.",
+  "notification.delete.success": "Dokumentacja usunięta",
+  "notification.generate.success": "Dokumentacja wygenerowana",
   "notification.update.success": "Ustawienia zaktualizowane pomyślnie",
+  "pages.PluginPage.Button.open": "Otwórz dokumentację",
+  "pages.PluginPage.header.description": "Skonfiguruj plugin dokumentacji",
+  "pages.PluginPage.table.generated": "Ostatnio wygenerowane",
+  "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.save": "Zapisz",
+  "pages.SettingsPage.toggle.hint": "Ustaw endpoint dokumentacji na prywatny",
+  "pages.SettingsPage.toggle.label": "Dostęp ograniczony",
+  "plugin.description.long": "Stwórz dokument OpenAPI i zwizualizuj swoje API z SWAGGER UI.",
+  "plugin.description.short": "Stwórz dokument OpenAPI i zwizualizuj swoje API z SWAGGER UI.",
   "plugin.name": "Dokumentacja"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "4.3.0-beta.1",
+  "version": "4.3.1",
   "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
   "repository": {
     "type": "git",
@@ -24,25 +24,26 @@
     "test": "echo \"no tests yet\""
   },
   "dependencies": {
-    "@strapi/helper-plugin": "4.3.0-beta.1",
-    "@strapi/utils": "4.3.0-beta.1",
+    "@strapi/helper-plugin": "4.3.1",
+    "@strapi/utils": "4.3.1",
     "bcryptjs": "2.4.3",
-    "cheerio": "^1.0.0-rc.5",
+    "cheerio": "^1.0.0-rc.12",
     "fs-extra": "10.0.0",
     "koa-static": "^5.0.0",
     "lodash": "4.17.21",
-    "path-to-regexp": "6.2.0",
+    "path-to-regexp": "6.2.1",
     "pluralize": "8.0.0",
     "react": "^17.0.2",
-    "react-copy-to-clipboard": "^5.0.3",
+    "react-copy-to-clipboard": "^5.1.0",
     "react-dom": "^17.0.2",
     "react-intl": "5.20.2",
-    "react-redux": "7.2.3",
+    "react-redux": "7.2.8",
     "react-router": "^5.2.0",
     "react-router-dom": "5.2.0",
     "redux": "^4.0.1",
     "reselect": "^4.0.0",
-    "swagger-ui-dist": "4.11.1"
+    "swagger-ui-dist": "4.12.0",
+    "yaml": "1.10.2"
   },
   "peerDependencies": {
     "@strapi/strapi": "^4.0.0"
@@ -57,5 +58,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "9d6555398960c39159d66bb4eea3bcb0362e37e3"
+  "gitHead": "1eab2fb08c7a4d3d40a5a7ff3b2f137ce0afcf8a"
 }

package/server/services/documentation.js

@@ -11,7 +11,17 @@ const { builApiEndpointPath, buildComponentSchema } = require('./helpers');
 module.exports = ({ strapi }) => {
   const config = strapi.config.get('plugin.documentation');
 
+  const registeredDocs = [];
+
   return {
+    registerDoc(doc) {
+      // parseYaml
+      if (typeof doc === 'string') {
+        doc = require('yaml').parse(doc);
+      }
+      // receive an object we can register it directly
+      registeredDocs.push(doc);
+    },
     getDocumentationVersion() {
       return _.get(config, 'info.version');
     },
@@ -174,8 +184,26 @@ module.exports = ({ strapi }) => {
       const customConfig = await this.getCustomConfig();
       const config = _.merge(defaultConfig, customConfig);
 
+      const finalDoc = { ...config, paths };
+
+      registeredDocs.forEach(doc => {
+        // Add tags
+        finalDoc.tags = finalDoc.tags || [];
+        finalDoc.tags.push(...(doc.tags || []));
+
+        // Add Paths
+        _.assign(finalDoc.paths, doc.paths);
+
+        // Add components
+        _.forEach(doc.components || {}, (val, key) => {
+          finalDoc.components[key] = finalDoc.components[key] || {};
+
+          _.assign(finalDoc.components[key], val);
+        });
+      });
+
       await fs.ensureFile(fullDocJsonPath);
-      await fs.writeJson(fullDocJsonPath, { ...config, paths }, { spaces: 2 });
+      await fs.writeJson(fullDocJsonPath, finalDoc, { spaces: 2 });
     },
   };
 };