fix(cli): allow path level parameters for openapi

Author: raymondfeng

packages/cli/generators/openapi/spec-helper.js

@@ -51,6 +51,29 @@ function getTagDescription(apiSpec, tag) {
   return undefined;
 }
 
+/**
+ * Merge path level parameters into the operation level
+ * @param {OperationObject} operationSpec Operation spec
+ * @param {ParameterObject[]} pathLevelParams Path level parameters
+ */
+function mergeParameters(operationSpec, pathLevelParams) {
+  if (!pathLevelParams || pathLevelParams.length === 0) return;
+  for (const p of pathLevelParams) {
+    operationSpec.parameters = operationSpec.parameters || [];
+    let found = false;
+    for (const param of operationSpec.parameters) {
+      if (p.name === param.name && p.in === param.in) {
+        // The parameter has been overridden at operation level
+        found = true;
+        break;
+      }
+    }
+    if (!found) {
+      operationSpec.parameters.push(p);
+    }
+  }
+}
+
 /**
  * Group operations by controller class name
  * @param {object} apiSpec OpenAPI 3.x spec
@@ -61,10 +84,12 @@ function groupOperationsByController(apiSpec) {
   for (const path in apiSpec.paths) {
     if (isExtension(path)) continue;
     debug('Path: %s', path);
+    const pathLevelParams = apiSpec.paths[path].parameters;
     for (const verb in apiSpec.paths[path]) {
       if (isExtension(verb) || !isHttpVerb(verb)) continue;
       debug('Verb: %s', verb);
       const op = apiSpec.paths[path][verb];
+      mergeParameters(op, pathLevelParams);
       const operation = {
         path,
         verb,

packages/cli/generators/openapi/utils.js

@@ -145,7 +145,7 @@ function escapeIdentifier(name) {
     return '_' + name;
   }
   if (!name.match(SAFE_IDENTIFER)) {
-    return camelCase(name);
+    return _.camelCase(name);
   }
   return name;
 }

packages/cli/test/fixtures/openapi/3.0/customer.yaml

@@ -11,10 +11,17 @@ tags:
     description: Customer resource
 paths:
   /customers:
+    parameters:
+      - name: access-token
+        in: query
+        description: Access token
+        required: false
+        schema:
+          type: string
     get:
       tags:
         - Customer
-      description: Returna all customers
+      description: Returns all customers
       parameters:
         - name: if
           in: query

packages/cli/test/unit/openapi/controller-spec.unit.js

@@ -23,17 +23,21 @@ describe('openapi to controllers/models', () => {
         imports: ["import {Customer} from '../models/customer.model';"],
         methods: [
           {
-            description: 'Returna all customers',
+            description: 'Returns all customers',
             decoration: "@operation('get', '/customers')",
             signature:
               "async ''(@param({name: 'if', in: 'query'}) _if: string[], " +
-              "@param({name: 'limit', in: 'query'}) limit: number): " +
+              "@param({name: 'limit', in: 'query'}) limit: number, " +
+              "@param({name: 'access-token', in: 'query'}) " +
+              'accessToken: string): ' +
               'Promise<Customer[]>',
           },
           {
             description: 'Creates a new customer',
             decoration: "@operation('post', '/customers')",
-            signature: 'async createCustomer(): Promise<Customer>',
+            signature:
+              "async createCustomer(@param({name: 'access-token', " +
+              "in: 'query'}) accessToken: string): Promise<Customer>",
           },
           {
             description: 'Returns a customer based on a single ID',