@adaptivestone/framework 3.4.0 → 3.4.1

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 3.4.1
+
+[FIX] fix documentation generation
+
 ### 3.4.0
 
 [NEW] now we pass 'req' to validation and casting as a second parameter. This done mostly for custom validators

package/commands/GetOpenApiJson.js

@@ -90,15 +90,15 @@ class GetOpenApiJson extends AbstractCommand {
         ];
 
         const securitySchemaNames = [];
-
+        let permissionString = '';
         if (middlewares?.length) {
           for (const middleware of middlewares) {
             if (middleware?.authParams?.length) {
               for (const authParam of middleware.authParams) {
                 const { permissions, ...mainFields } = authParam;
-                let fullName = authParam.name;
+                const fullName = authParam.name;
                 if (permissions) {
-                  fullName = `${fullName}-permissions-${permissions}`;
+                  permissionString = permissions;
                 }
 
                 if (!openApi.components.securitySchemes[fullName]) {
@@ -148,10 +148,12 @@ class GetOpenApiJson extends AbstractCommand {
           openApi.paths[routeName] = {};
         }
 
-        const methodName = route[Object.keys(route)[0]].method.toLowerCase();
-        const routeTitle = route[Object.keys(route)[0]].name;
         const routeDescription =
           route[Object.keys(route)[0]]?.description || 'empty description';
+        const routeDescriptionWithPermissions = `${permissionString} ${routeDescription}`;
+        const methodName = route[Object.keys(route)[0]].method.toLowerCase();
+        const routeTitle = route[Object.keys(route)[0]].name;
+
         const routeFields = route[Object.keys(route)[0]].fields;
 
         if (!openApi.paths[routeName][methodName]) {
@@ -165,7 +167,8 @@ class GetOpenApiJson extends AbstractCommand {
         );
 
         openApi.paths[routeName][methodName].summary = routeTitle;
-        openApi.paths[routeName][methodName].description = routeDescription;
+        openApi.paths[routeName][methodName].description =
+          routeDescriptionWithPermissions;
         openApi.paths[routeName][methodName].parameters = [];
         openApi.paths[routeName][methodName].security = securitySchemaNames;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "Adaptive stone node js framework",
   "main": "src/index.js",
   "engines": {