Merge pull request #249 from sakiv/bugfix-248

Fixed bug to support x-amazon-* in security schemes. [BUG] #248

Author: JaredCE

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);
     }
   }

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", () => {