Fixes #157

Parse and add optional path parameters to APIGW Swagger

Author: jthomas

compile/apigw/index.js

@@ -256,11 +256,42 @@ class OpenWhiskCompileHttpEvents {
       action: httpEvent.action, namespace: httpEvent.namespace,
       package: httpEvent.pkge, url: webaction_url
     }
-
+    
     const swaggerPath = { operationId, responses, "x-openwhisk": x_ow }
+    const pathParameters = this.parsePathParameters(httpEvent.relpath)
+
+    if (pathParameters.length) {
+      swaggerPath.parameters = pathParameters.map(this.createPathParameter)
+    }
+
     return swaggerPath
   }
 
+  parsePathParameters (path) {
+    const regex = /{([^}]+)\}/g
+    const findAllParams = p => {
+      const ids = []
+      let id = regex.exec(p)
+      while (id) {
+        ids.push(id[1])
+        id = regex.exec(p)
+      }
+      return ids
+    }
+
+    return path.split('/')
+      .map(findAllParams)
+      .reduce((sum, el) => sum.concat(el), [])
+  }
+
+  createPathParameter (name) {
+    return {
+      name: name, in: 'path',
+      description: `Default description for '${name}'`,
+      required: true, type: 'string'
+    }
+  }
+
   compileSwaggerCaseSwitch(httpEvent, host) {
     const webaction_url = this.webActionUrl(httpEvent, host)
     const operationId = this.operationId(httpEvent)

compile/apigw/tests/index.js

@@ -253,6 +253,40 @@ describe('OpenWhiskCompileHttpEvents', () => {
 
       return expect(result).to.deep.equal(expectedResult)
     });
+
+    it('should define swagger definition with path parameters', () => {
+      openwhiskCompileHttpEvents.serverless.service.service = 'my-service' 
+      openwhiskCompileHttpEvents.serverless.service.provider = {namespace: "sample_ns"};
+
+      const httpEvent = {
+        relpath: '/api/foo/{id}', operation: 'GET', secure_key: 'auth-token',
+        action: 'action-name', namespace: '[email protected]_space', pkge: 'default', responsetype: 'json'
+      }
+
+      const host = 'openwhisk.somewhere.com'
+      const result = openwhiskCompileHttpEvents.compileSwaggerPath(httpEvent, host);
+
+      const expectedResult = {
+        operationId: "get-/api/foo/{id}",
+        parameters: [{
+          name: "id", in: "path",
+          description: "Default description for 'id'",
+          required: true, type: "string"
+        }],
+        responses: {
+          "200": { description: "A successful invocation response" }
+        },
+        "x-openwhisk": {
+          action: "action-name",
+          namespace: "[email protected]_space",
+          package: "default",
+          url: "https://openwhisk.somewhere.com/api/v1/web/[email protected]_space/default/action-name.json"
+        }
+      }
+
+      return expect(result).to.deep.equal(expectedResult)
+    });
+ 
   });
 
   describe('#compileSwaggerCaseSwitch()', () => {