@strapi/plugin-documentation 4.0.7 → 4.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "4.0.7",
+  "version": "4.0.8",
   "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.0.7",
-    "@strapi/utils": "4.0.7",
+    "@strapi/helper-plugin": "4.0.8",
+    "@strapi/utils": "4.0.8",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.5",
     "fs-extra": "^9.1.0",
@@ -57,5 +57,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "af0cba8c5b2ba7b371523e8f55413ef0fce98e1e"
+  "gitHead": "669bb2f0440d3b21a23c8d665fdba98bd3d8cc71"
 }

package/server/services/documentation.js

@@ -20,6 +20,10 @@ module.exports = ({ strapi }) => {
       return path.join(strapi.dirs.extensions, 'documentation', 'documentation');
     },
 
+    getCustomDocumentationPath() {
+      return path.join(strapi.dirs.extensions, 'documentation', 'config', 'settings.json');
+    },
+
     getDocumentationVersions() {
       return fs
         .readdirSync(this.getFullDocumentationPath())
@@ -103,6 +107,16 @@ module.exports = ({ strapi }) => {
       return [...apisToDocument, ...pluginsToDocument];
     },
 
+    async getCustomSettings() {
+      const customConfigPath = this.getCustomDocumentationPath();
+      const pathExists = await fs.pathExists(customConfigPath);
+      if (pathExists) {
+        return fs.readJson(customConfigPath);
+      }
+
+      return {};
+    },
+
     /**
      * @description - Creates the Swagger json files
      */
@@ -133,20 +147,24 @@ module.exports = ({ strapi }) => {
         'full_documentation.json'
       );
 
-      const settings = _.cloneDeep(defaultConfig);
+      const defaultSettings = _.cloneDeep(defaultConfig);
 
       const serverUrl = getAbsoluteServerUrl(strapi.config);
       const apiPath = strapi.config.get('api.rest.prefix');
 
-      _.set(settings, 'servers', [
+      _.set(defaultSettings, 'servers', [
         {
           url: `${serverUrl}${apiPath}`,
           description: 'Development server',
         },
       ]);
 
-      _.set(settings, ['info', 'x-generation-date'], new Date().toISOString());
-      _.set(settings, ['info', 'version'], version);
+      _.set(defaultSettings, ['info', 'x-generation-date'], new Date().toISOString());
+      _.set(defaultSettings, ['info', 'version'], version);
+
+      const customSettings = await this.getCustomSettings();
+
+      const settings = _.merge(defaultSettings, customSettings);
 
       await fs.ensureFile(fullDocJsonPath);
       await fs.writeJson(fullDocJsonPath, { ...settings, paths }, { spaces: 2 });