fix: add api id to stack outputs (#11)

deliveryhero · Dec 28, 2016 · 83f8d76 · 83f8d76
1 parent ea38024
commit 83f8d76
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 3 deletions.
diff --git a/src/documentation.js b/src/documentation.js
@@ -129,7 +129,7 @@ module.exports = function(AWS) {
 
     _buildDocumentation: function _buildDocumentation(result) {
       this.restApiId = result.Stacks[0].Outputs
-        .filter(output => output.OutputKey === 'ApiId')
+        .filter(output => output.OutputKey === 'AwsDocApiId')
         .map(output => output.OutputValue)[0];
 
       this.getGlobalDocumentationParts();

diff --git a/src/index.js b/src/index.js
@@ -46,6 +46,14 @@ class ServerlessAWSDocumentation {
       const func = this.serverless.service.getFunction(functionName);
       func.events.forEach(this.updateCfTemplateFromHttp.bind(this));
     });
+
+    // Add models
+    this.cfTemplate.Outputs.AwsDocApiId = {
+      Description: 'API ID',
+      Value: {
+        Ref: 'ApiGatewayRestApi',
+      },
+    };
   }
 
   afterDeploy() {

diff --git a/src/index.spec.js b/src/index.spec.js
@@ -27,7 +27,8 @@ describe('ServerlessAWSDocumentation', function() {
               ExistingResource: {
                 with: 'configuration',
               },
-            }
+            },
+            Outputs: {},
           }
         },
         getFunction: jasmine.createSpy('getFunction').and.callFake((functionName) => {
@@ -135,6 +136,14 @@ describe('ServerlessAWSDocumentation', function() {
             with: 'configuration',
           },
         },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              Ref: 'ApiGatewayRestApi',
+            },
+          }
+        },
       });
     });
 
@@ -162,6 +171,14 @@ describe('ServerlessAWSDocumentation', function() {
             with: 'configuration',
           },
         },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              Ref: 'ApiGatewayRestApi',
+            },
+          }
+        },
       });
     });
 
@@ -277,6 +294,14 @@ describe('ServerlessAWSDocumentation', function() {
             }
           },
         },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              Ref: 'ApiGatewayRestApi',
+            },
+          }
+        },
       });
     });
 
@@ -354,6 +379,14 @@ describe('ServerlessAWSDocumentation', function() {
             }
           },
         },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              Ref: 'ApiGatewayRestApi',
+            },
+          }
+        },
       });
     });
 
@@ -422,6 +455,14 @@ describe('ServerlessAWSDocumentation', function() {
             }
           },
         },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              Ref: 'ApiGatewayRestApi',
+            },
+          }
+        },
       });
     });
 
@@ -533,6 +574,14 @@ describe('ServerlessAWSDocumentation', function() {
             },
           },
         },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              Ref: 'ApiGatewayRestApi',
+            },
+          }
+        },
       });
     });
 
@@ -588,6 +637,14 @@ describe('ServerlessAWSDocumentation', function() {
             Properties: {},
           },
         },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              Ref: 'ApiGatewayRestApi',
+            },
+          }
+        },
       });
     });
   });
@@ -750,7 +807,7 @@ describe('ServerlessAWSDocumentation', function() {
             OutputKey: 'ApiKey',
             OutputValue: 'nothing',
           }, {
-            OutputKey: 'ApiId',
+            OutputKey: 'AwsDocApiId',
             OutputValue: 'superid',
           }],
         }],