serverless-openapi-documenter 0.0.113 → 0.0.114

package/README.md

@@ -318,6 +318,8 @@ custom:
 
 It accepts all available Security Schemes and follows the specification: https://spec.openapis.org/oas/v3.0.4#security-scheme-object
 
+This can be extended using the `^x-` specification extension.
+
 #### Security on each operation
 
 To apply an overall security scheme to all of your operations without having to add the documentation to each one, you can write it like:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.113",
+  "version": "0.0.114",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [

package/src/definitionGenerator.js

@@ -920,6 +920,12 @@ class DefinitionGenerator {
           break;
       }
 
+      const extendedSpec = this.extendSpecification(securityScheme);
+
+      if (Object.keys(extendedSpec).length) {
+        Object.assign(schema, extendedSpec);
+      }
+
       this.addToComponents(this.componentTypes.securitySchemes, schema, scheme);
     }
   }

package/test/unit/definitionGenerator.spec.js

@@ -886,6 +886,42 @@ describe("DefinitionGenerator", () => {
         ).to.have.property("api_key");
       });
     });
+
+    describe("x-amazon-* extensions", () => {
+      it("should add an x-amazon-* security scheme to components", function () {
+        mockServerless.service.custom.documentation.securitySchemes = {
+          x_amazon_api_key: {
+            type: "apiKey",
+            name: "x-amz-security-token",
+            in: "header",
+            "x-amazon-apigateway-authtype": "awsSigv4",
+          },
+        };
+
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
+        definitionGenerator.createSecuritySchemes(
+          mockServerless.service.custom.documentation.securitySchemes
+        );
+
+        expect(definitionGenerator.openAPI).to.be.an("object");
+        expect(definitionGenerator.openAPI.components).to.be.an("object");
+        expect(definitionGenerator.openAPI.components).to.have.property(
+          "securitySchemes"
+        );
+        expect(definitionGenerator.openAPI.components.securitySchemes).to.be.an(
+          "object"
+        );
+        expect(
+          definitionGenerator.openAPI.components.securitySchemes
+        ).to.have.property("x_amazon_api_key");
+        expect(
+          definitionGenerator.openAPI.components.securitySchemes.x_amazon_api_key
+        ).to.have.property("x-amazon-apigateway-authtype");
+      });
+    });
   });
 
   describe("createTags", () => {