feat(oas): implement security declaration type (#223)

stoplightio · Apr 18, 2023 · 821f72b · 821f72b
1 parent 4d14e4a
commit 821f72b
Show file tree

Hide file tree

Showing 29 changed files with 121 additions and 16 deletions.
diff --git a/package.json b/package.json
@@ -75,7 +75,7 @@
   "dependencies": {
     "@stoplight/json": "^3.18.1",
     "@stoplight/json-schema-generator": "1.0.2",
-    "@stoplight/types": "^13.6.0",
+    "@stoplight/types": "^13.12.0",
     "@types/json-schema": "7.0.11",
     "@types/swagger-schema-official": "~2.0.22",
     "@types/type-is": "^1.6.3",

diff --git a/src/oas/__tests__/__snapshots__/operation.test.ts.snap b/src/oas/__tests__/__snapshots__/operation.test.ts.snap
@@ -178,6 +178,7 @@ Array [
         },
       ],
     ],
+    "securityDeclarationType": "declared",
     "servers": Array [
       Object {
         "id": "http_server-abc-https://petstore.swagger.io/v2",
@@ -257,6 +258,7 @@ Array [
       },
     ],
     "security": Array [],
+    "securityDeclarationType": "inheritedFromService",
     "servers": Array [
       Object {
         "id": "http_server-abc-https://petstore.swagger.io/v2",
@@ -365,6 +367,7 @@ Array [
       },
     ],
     "security": Array [],
+    "securityDeclarationType": "inheritedFromService",
     "servers": Array [
       Object {
         "id": "http_server-abc-https://petstore.swagger.io/v2",
@@ -409,6 +412,7 @@ Array [
       },
     ],
     "security": Array [],
+    "securityDeclarationType": "inheritedFromService",
     "servers": Array [
       Object {
         "id": "http_server-abc-https://petstore.swagger.io/v2",
@@ -670,6 +674,7 @@ Array [
         },
       ],
     ],
+    "securityDeclarationType": "declared",
     "servers": Array [
       Object {
         "id": "http_server-abc-https://petstore.swagger.io/v2",
@@ -888,6 +893,7 @@ Array [
         },
       ],
     ],
+    "securityDeclarationType": "declared",
     "servers": Array [
       Object {
         "id": "http_server-abc-https://petstore.swagger.io/v2",
@@ -971,6 +977,7 @@ Array [
       },
     ],
     "security": Array [],
+    "securityDeclarationType": "inheritedFromService",
     "servers": Array [
       Object {
         "id": "http_server-abc-https://petstore.swagger.io/v2",
@@ -1228,6 +1235,7 @@ Array [
         },
       ],
     ],
+    "securityDeclarationType": "declared",
     "servers": Array [
       Object {
         "id": "http_server-abc-https://petstore.swagger.io/v2",

diff --git a/src/oas/__tests__/operation.test.ts b/src/oas/__tests__/operation.test.ts
@@ -141,6 +141,7 @@ describe('oas operation', () => {
       extensions: {},
       responses: [],
       security: [],
+      securityDeclarationType: 'inheritedFromService',
       servers: [],
       summary: '/Update',
       tags: [],

diff --git a/src/oas/operation.ts b/src/oas/operation.ts
@@ -9,6 +9,7 @@ import type { Fragment, HttpOperationTransformer } from '../types';
 import { TransformerContext, TranslateFunction } from '../types';
 import { getExtensions } from './accessors';
 import { translateToTags } from './tags';
+import { translateToSecurityDeclarationType } from './transformers';
 
 const DEFAULT_METHODS = ['get', 'post', 'put', 'delete', 'options', 'head', 'patch', 'trace'];
 
@@ -95,5 +96,7 @@ export const transformOasOperation: TranslateFunction<
       },
       isString,
     ),
+
+    securityDeclarationType: translateToSecurityDeclarationType(operation),
   };
 };
diff --git a/src/oas/transformers/index.ts b/src/oas/transformers/index.ts
@@ -1,2 +1,3 @@
 export { convertSchema, translateSchemaObject } from './schema/index';
+export { translateToSecurityDeclarationType } from './securities';
 export { translateLogo } from './translateLogo';
diff --git a/src/oas/transformers/securities.ts b/src/oas/transformers/securities.ts
@@ -0,0 +1,18 @@
+import { HttpOperationSecurityDeclarationTypes, IHttpOperation } from '@stoplight/types';
+import type { OperationObject } from 'openapi3-ts/src/model/OpenApi';
+import type { Operation } from 'swagger-schema-official';
+
+export function translateToSecurityDeclarationType({
+  security,
+}: Partial<Operation | OperationObject>): IHttpOperation['securityDeclarationType'] {
+  let securityDeclarationType = HttpOperationSecurityDeclarationTypes.InheritedFromService;
+
+  if (Array.isArray(security)) {
+    securityDeclarationType =
+      security.length === 0
+        ? HttpOperationSecurityDeclarationTypes.None
+        : HttpOperationSecurityDeclarationTypes.Declared;
+  }
+
+  return securityDeclarationType;
+}
diff --git a/src/oas2/__tests__/__fixtures__/id/bundled.ts b/src/oas2/__tests__/__fixtures__/id/bundled.ts
@@ -227,6 +227,7 @@ export default {
         },
       ],
       security: [],
+      securityDeclarationType: 'inheritedFromService',
       servers: [
         {
           id: 'http_server-service_abc-http://localhost:3000',
@@ -369,6 +370,7 @@ export default {
           },
         ],
       ],
+      securityDeclarationType: 'declared',
       servers: [
         {
           id: 'http_server-service_abc-http://localhost:3000',

diff --git a/src/oas2/__tests__/__snapshots__/operation.test.ts.snap b/src/oas2/__tests__/__snapshots__/operation.test.ts.snap
@@ -78,6 +78,7 @@ Object {
       },
     ],
   ],
+  "securityDeclarationType": "declared",
   "servers": Array [],
   "summary": "osum",
   "tags": Array [],

diff --git a/src/oas2/__tests__/bundle.test.ts b/src/oas2/__tests__/bundle.test.ts
@@ -109,6 +109,7 @@ describe('bundleOas2Service', () => {
           },
           responses: [],
           security: [],
+          securityDeclarationType: 'inheritedFromService',
           servers: [],
           tags: [],
         },
@@ -129,6 +130,7 @@ describe('bundleOas2Service', () => {
           },
           responses: [],
           security: [],
+          securityDeclarationType: 'inheritedFromService',
           servers: [],
           tags: [],
         },
@@ -151,6 +153,7 @@ describe('bundleOas2Service', () => {
           },
           responses: [],
           security: [],
+          securityDeclarationType: 'inheritedFromService',
           servers: [],
           tags: [],
         },
@@ -269,6 +272,7 @@ describe('bundleOas2Service', () => {
               },
             ],
           ],
+          securityDeclarationType: 'declared',
           servers: [],
           tags: [],
         },

diff --git a/src/oas2/__tests__/operation.test.ts b/src/oas2/__tests__/operation.test.ts
@@ -210,6 +210,7 @@ describe('transformOas2Operation', () => {
         },
         responses: [],
         security: [],
+        securityDeclarationType: 'inheritedFromService',
         servers: [],
         tags: [],
         extensions: {},
@@ -259,6 +260,7 @@ describe('transformOas2Operation', () => {
       },
       responses: [],
       security: [],
+      securityDeclarationType: 'inheritedFromService',
       servers: [],
       tags: [],
       extensions: {},

diff --git a/src/oas3/__tests__/__fixtures__/examples/bundled.ts b/src/oas3/__tests__/__fixtures__/examples/bundled.ts
@@ -55,6 +55,7 @@ export default {
       },
       responses: [],
       security: [],
+      securityDeclarationType: 'inheritedFromService',
       servers: [
         {
           id: 'http_server-service_abc-http://localhost:3000',

diff --git a/src/oas3/__tests__/__fixtures__/examples/legacy.ts b/src/oas3/__tests__/__fixtures__/examples/legacy.ts
@@ -72,6 +72,7 @@ export default [
         url: 'http://localhost:3000',
       },
     ],
+    securityDeclarationType: 'inheritedFromService',
     tags: [],
   },
 ];
diff --git a/src/oas3/__tests__/__fixtures__/id/bundled.ts b/src/oas3/__tests__/__fixtures__/id/bundled.ts
@@ -251,6 +251,7 @@ export default {
         },
       ],
       security: [],
+      securityDeclarationType: 'inheritedFromService',
       servers: [
         {
           id: 'http_server-service_abc-http://localhost:3000',
@@ -365,6 +366,7 @@ export default {
           },
         ],
       ],
+      securityDeclarationType: 'declared',
       servers: [
         {
           id: 'http_server-service_abc-http://localhost:3000',

diff --git a/src/oas3/__tests__/__fixtures__/id/legacy.ts b/src/oas3/__tests__/__fixtures__/id/legacy.ts
@@ -235,6 +235,7 @@ export default [
       },
     ],
     security: [],
+    securityDeclarationType: 'inheritedFromService',
     extensions: {},
   },
 
@@ -470,6 +471,7 @@ export default [
         },
       ],
     ],
+    securityDeclarationType: 'declared',
     extensions: {},
   },
 ];
diff --git a/src/oas3/__tests__/__fixtures__/shared-components/bundled.ts b/src/oas3/__tests__/__fixtures__/shared-components/bundled.ts
@@ -26,6 +26,7 @@ export default {
         },
       ],
       security: [],
+      securityDeclarationType: 'inheritedFromService',
       servers: [],
       summary: 'Get a organization repository',
       tags: [],
@@ -55,6 +56,7 @@ export default {
         },
       ],
       security: [],
+      securityDeclarationType: 'inheritedFromService',
       servers: [],
       summary: 'Create a organization repository',
       tags: [],

diff --git a/src/oas3/__tests__/__fixtures__/shared-components/legacy.ts b/src/oas3/__tests__/__fixtures__/shared-components/legacy.ts
@@ -130,6 +130,7 @@ export default [
     },
     tags: [],
     security: [],
+    securityDeclarationType: 'inheritedFromService',
     extensions: {},
   },
   /**
@@ -276,6 +277,7 @@ export default [
     },
     tags: [],
     security: [],
+    securityDeclarationType: 'inheritedFromService',
     extensions: {},
   },
 ];
diff --git a/src/oas3/__tests__/__snapshots__/operation.test.ts.snap b/src/oas3/__tests__/__snapshots__/operation.test.ts.snap
@@ -18,6 +18,7 @@ Object {
       },
       "responses": Array [],
       "security": Array [],
+      "securityDeclarationType": "inheritedFromService",
       "servers": Array [],
       "tags": Array [],
     },
@@ -58,6 +59,7 @@ Object {
   },
   "responses": Array [],
   "security": Array [],
+  "securityDeclarationType": "inheritedFromService",
   "servers": Array [],
   "tags": Array [],
 }
@@ -80,6 +82,7 @@ Object {
   },
   "responses": Array [],
   "security": Array [],
+  "securityDeclarationType": "inheritedFromService",
   "servers": Array [],
   "summary": "summary",
   "tags": Array [],
@@ -103,6 +106,7 @@ Object {
   },
   "responses": Array [],
   "security": Array [],
+  "securityDeclarationType": "inheritedFromService",
   "servers": Array [
     Object {
       "id": Any<String>,
@@ -132,6 +136,7 @@ Object {
   },
   "responses": Array [],
   "security": Array [],
+  "securityDeclarationType": "inheritedFromService",
   "servers": Array [
     Object {
       "id": Any<String>,
@@ -161,6 +166,7 @@ Object {
   },
   "responses": Array [],
   "security": Array [],
+  "securityDeclarationType": "inheritedFromService",
   "servers": Array [],
   "summary": "summary",
   "tags": Array [
@@ -189,6 +195,7 @@ Object {
   },
   "responses": Array [],
   "security": Array [],
+  "securityDeclarationType": "inheritedFromService",
   "servers": Array [
     Object {
       "id": Any<String>,

diff --git a/src/oas3/__tests__/accessors.test.ts b/src/oas3/__tests__/accessors.test.ts
@@ -46,6 +46,7 @@ describe('getOas3Securities', () => {
           'operationScheme',
           {
             type: 'apiKey',
+            extensions: {},
           },
         ],
       ],
@@ -72,6 +73,7 @@ describe('getOas3Securities', () => {
           'specScheme',
           {
             type: 'apiKey',
+            extensions: {},
           },
         ],
       ],
@@ -102,6 +104,7 @@ describe('getOas3Securities', () => {
           'specScheme',
           {
             type: 'apiKey',
+            extensions: {},
           },
         ],
       ],

diff --git a/src/oas3/__tests__/bundle.test.ts b/src/oas3/__tests__/bundle.test.ts
@@ -107,6 +107,7 @@ describe('bundleOas3Service', () => {
             ],
           },
           security: [],
+          securityDeclarationType: 'inheritedFromService',
           servers: [],
         },
       ],
@@ -684,6 +685,7 @@ describe('bundleOas3Service', () => {
             },
           ],
           security: [],
+          securityDeclarationType: 'inheritedFromService',
           servers: [],
           tags: [],
         },
@@ -743,6 +745,7 @@ describe('bundleOas3Service', () => {
           },
           responses: [],
           security: [],
+          securityDeclarationType: 'inheritedFromService',
           servers: [],
           tags: [],
         },
@@ -849,6 +852,7 @@ describe('bundleOas3Service', () => {
               },
             ],
           ],
+          securityDeclarationType: 'declared',
           servers: [],
           tags: [],
         },