Update path transform to make the security key optional (#179)

* Update path transform to make the security key optional If the security key is present in a path swagger will take that definition over the global security one. By always adding this key we are disabling security globally. Modified the transform for a path to only set the key when values are found. * fix(linting): error not related to my change ???? forced by commit hook feat(security): Added the ability to disable security By adding an empty @security tag to the jsdoc block for a path * fix(test): test failed after making an unrelated change These tests broke. I'm not sure why only making a change in transforms/paths/index.js under the parsePath response triggers the failures. * fix(test): fixed tests and added a couple Co-authored-by: Kevin Julián Martínez Escobar <kevinccbsg@gmail.com>
BRIKEV · Sep 1, 2021 · 62de8aa · 62de8aa
1 parent b5fdcca
commit 62de8aa
Show file tree

Hide file tree

Showing 13 changed files with 102 additions and 65 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/test/e2e/configuration/configuration.test.js b/test/e2e/configuration/configuration.test.js
@@ -38,6 +38,13 @@ const options = {
       },
     },
   ],
+  security: {
+    BearerAuth: {
+      type: 'http',
+      scheme: 'bearer',
+      bearerFormat: 'JWT',
+    },
+  },
   filesPattern: './main.js',
   baseDir: __dirname,
 };
@@ -82,11 +89,22 @@ test('should parse basic info', async () => {
         },
       },
     ],
-    security: undefined,
+    security: [
+      {
+        BearerAuth: [],
+      },
+    ],
     paths: {},
     tags: [],
     components: {
       schemas: {},
+      securitySchemes: {
+        BearerAuth: {
+          bearerFormat: 'JWT',
+          scheme: 'bearer',
+          type: 'http',
+        },
+      },
     },
   };
   const result = await processSwagger(options);

diff --git a/test/e2e/parameters/parameters.test.js b/test/e2e/parameters/parameters.test.js
@@ -64,7 +64,6 @@ test('should parse parameters from jsdoc-example', async () => {
               },
             },
           ],
-          security: [],
           tags: [],
         },
       },
@@ -110,7 +109,6 @@ test('should parse parameters from jsdoc-example', async () => {
               },
             },
           ],
-          security: [],
           tags: [],
         },
       },

diff --git a/test/transforms/paths/combineSchemas.test.js b/test/transforms/paths/combineSchemas.test.js
@@ -19,7 +19,6 @@ test('should parse jsdoc path response with oneOf keyword', () => {
           summary: 'This is the summary of the endpoint',
           parameters: [],
           tags: [],
-          security: [],
           responses: {
             200: {
               description: 'success response',
@@ -130,7 +129,6 @@ test('should parse jsdoc path reference params with allOf keyword', () => {
           summary: '',
           responses: {},
           tags: [],
-          security: [],
           parameters: [{
             deprecated: false,
             description: 'name param description',

diff --git a/test/transforms/paths/formParameters.test.js b/test/transforms/paths/formParameters.test.js
@@ -18,7 +18,6 @@ describe('form requestBody tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               content: {
@@ -66,7 +65,6 @@ describe('form requestBody tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [
               {
                 deprecated: false,
@@ -126,7 +124,6 @@ describe('form requestBody tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'name body description',
@@ -177,7 +174,6 @@ describe('form requestBody tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [
               {
                 deprecated: false,
@@ -247,7 +243,6 @@ describe('form requestBody tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [
               {
                 deprecated: false,

diff --git a/test/transforms/paths/index.test.js b/test/transforms/paths/index.test.js
@@ -40,7 +40,6 @@ describe('setPaths method', () => {
             description: 'This is the description of the endpoint',
             parameters: [],
             tags: [],
-            security: [],
             responses: {
               200: {
                 description: 'success response',
@@ -79,7 +78,6 @@ describe('setPaths method', () => {
             summary: 'This is the summary of the endpoint',
             parameters: [],
             tags: [],
-            security: [],
             responses: {
               200: {
                 description: 'success response',
@@ -125,7 +123,6 @@ describe('setPaths method', () => {
             summary: 'This is the summary of the endpoint',
             parameters: [],
             tags: [],
-            security: [],
             responses: {
               200: {
                 description: 'success response',
@@ -147,7 +144,6 @@ describe('setPaths method', () => {
             summary: 'This is the summary of the endpoint',
             parameters: [],
             tags: [],
-            security: [],
             responses: {
               200: {
                 description: 'success response',
@@ -193,7 +189,6 @@ describe('setPaths method', () => {
             summary: 'This is the summary of the endpoint',
             parameters: [],
             tags: [],
-            security: [],
             responses: {
               200: {
                 description: 'success response',
@@ -213,7 +208,6 @@ describe('setPaths method', () => {
             summary: 'This is the summary of the endpoint',
             parameters: [],
             tags: [],
-            security: [],
             responses: {
               200: {
                 description: 'success response',

diff --git a/test/transforms/paths/parameters.test.js b/test/transforms/paths/parameters.test.js
@@ -19,7 +19,6 @@ describe('params tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             operationId: 'getInfo',
             parameters: [{
               deprecated: false,
@@ -56,7 +55,6 @@ describe('params tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
           },
         },
@@ -83,7 +81,6 @@ describe('params tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [{
               deprecated: true,
               description: 'name param description',
@@ -123,7 +120,6 @@ describe('params tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [{
               deprecated: true,
               description: 'name param description',
@@ -171,7 +167,6 @@ describe('params tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [{
               deprecated: false,
               description: 'name param description',
@@ -207,7 +202,6 @@ describe('params tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [{
               deprecated: true,
               description: 'name param description',
@@ -246,7 +240,6 @@ describe('params tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [{
               deprecated: false,
               description: 'name param description',
@@ -286,7 +279,6 @@ describe('params tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [{
               deprecated: false,
               description: 'name param description',

diff --git a/test/transforms/paths/requestBody.test.js b/test/transforms/paths/requestBody.test.js
@@ -17,7 +17,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
           },
         },
@@ -44,7 +43,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'name body description',
@@ -83,7 +81,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: '',
@@ -124,7 +121,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'name body description',
@@ -166,7 +162,6 @@ describe('request body tests', () => {
             summary: 'Delete messages listed under the specified tags',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'Tags of the messages to delete',
@@ -208,7 +203,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'name body description',
@@ -249,7 +243,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'name body description',
@@ -287,7 +280,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'name body description',
@@ -330,7 +322,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'name body description',
@@ -383,7 +374,6 @@ describe('request body tests', () => {
             summary: '',
             responses: {},
             tags: [],
-            security: [],
             parameters: [],
             requestBody: {
               description: 'name body description',