fix(cli): fix property schema mapping for openapi specs

Fixes #5115
loopbackio · Apr 16, 2020 · b851aed · b851aed
1 parent 63a18c8
commit b851aed
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 13 deletions.
diff --git a/packages/cli/generators/openapi/spec-helper.js b/packages/cli/generators/openapi/spec-helper.js
@@ -344,7 +344,27 @@ function buildMethodSpec(controllerSpec, op, options) {
       names[argName] = 1;
     }
     registerAnonymousSchema([methodName, argName], paramSpec.schema, options);
-    const paramType = mapSchemaType(paramSpec.schema, options);
+    let propSchema = paramSpec.schema;
+    if (propSchema == null) {
+      /*
+        {
+          name: 'where',
+          in: 'query',
+          content: { 'application/json': { schema: [Object] } }
+        }
+        */
+      const content = paramSpec.content;
+      const json = content && content['application/json'];
+      propSchema = json && json.schema;
+      if (propSchema == null && content) {
+        for (const m of content) {
+          propSchema = content[m].schema;
+          if (propSchema) break;
+        }
+      }
+    }
+    propSchema = propSchema || {type: 'string'};
+    const paramType = mapSchemaType(propSchema, options);
     addImportsForType(paramType);
     if (Array.isArray(_comments)) {
       _comments.push(`@param ${argName} ${paramSpec.description || ''}`);

diff --git a/packages/cli/generators/openapi/utils.js b/packages/cli/generators/openapi/utils.js
@@ -36,7 +36,7 @@ function isExtension(key) {
  */
 function debugJson(msg, obj) {
   if (debug.enabled) {
-    debug('%s: %s', msg, JSON.stringify(obj, null, 2));
+    debug('%s: %s', msg, util.inspect(obj, {depth: 10}));
   }
 }
 

diff --git a/packages/cli/snapshots/integration/generators/openapi-client.integration.snapshots.js b/packages/cli/snapshots/integration/generators/openapi-client.integration.snapshots.js
@@ -53,9 +53,12 @@ pulvinar elit eu, euismod sapien.
 
    * @param tags tags to filter by
    * @param limit maximum number of results to return
+   * @param where 
    * @returns pet response
    */
-  findPets(params: { tags: string[]; limit: number }): Promise<Pet[]>;
+  findPets(params: { tags: string[]; limit: number; where: {
+  [additionalProperty: string]: any;
+} }): Promise<Pet[]>;
 
   /**
    * Creates a new pet in the store. Duplicates are allowed
@@ -249,9 +252,12 @@ pulvinar elit eu, euismod sapien.
 
    * @param tags tags to filter by
    * @param limit maximum number of results to return
+   * @param where 
    * @returns pet response
    */
-  findPets(params: { tags: string[]; limit: number }): Promise<Pet[]>;
+  findPets(params: { tags: string[]; limit: number; where: {
+  [additionalProperty: string]: any;
+} }): Promise<Pet[]>;
 
   /**
    * Creates a new pet in the store. Duplicates are allowed
@@ -447,10 +453,13 @@ pulvinar elit eu, euismod sapien.
    *
    * @param tags tags to filter by
    * @param limit maximum number of results to return
+   * @param where 
    * @returns pet response
    */
   @operation('get', '/pets')
-  async findPets(@param({name: 'tags', in: 'query'}) tags: string[], @param({name: 'limit', in: 'query'}) limit: number): Promise<Pet[]> {
+  async findPets(@param({name: 'tags', in: 'query'}) tags: string[], @param({name: 'limit', in: 'query'}) limit: number, @param({name: 'where', in: 'query'}) where: {
+  [additionalProperty: string]: any;
+}): Promise<Pet[]> {
     throw new Error('Not implemented');
   }
 
@@ -692,9 +701,12 @@ pulvinar elit eu, euismod sapien.
 
    * @param tags tags to filter by
    * @param limit maximum number of results to return
+   * @param where 
    * @returns pet response
    */
-  findPets(tags: string[], limit: number): Promise<Pet[]>;
+  findPets(tags: string[], limit: number, where: {
+  [additionalProperty: string]: any;
+}): Promise<Pet[]>;
 
   /**
    * Creates a new pet in the store. Duplicates are allowed
@@ -890,10 +902,13 @@ pulvinar elit eu, euismod sapien.
    *
    * @param tags tags to filter by
    * @param limit maximum number of results to return
+   * @param where 
    * @returns pet response
    */
   @operation('get', '/pets')
-  async findPets(@param({name: 'tags', in: 'query'}) tags: string[], @param({name: 'limit', in: 'query'}) limit: number): Promise<Pet[]> {
+  async findPets(@param({name: 'tags', in: 'query'}) tags: string[], @param({name: 'limit', in: 'query'}) limit: number, @param({name: 'where', in: 'query'}) where: {
+  [additionalProperty: string]: any;
+}): Promise<Pet[]> {
     throw new Error('Not implemented');
   }
 
@@ -1030,9 +1045,12 @@ pulvinar elit eu, euismod sapien.
 
    * @param tags tags to filter by
    * @param limit maximum number of results to return
+   * @param where 
    * @returns pet response
    */
-  findPets(tags: string[], limit: number): Promise<Pet[]>;
+  findPets(tags: string[], limit: number, where: {
+  [additionalProperty: string]: any;
+}): Promise<Pet[]>;
 
   /**
    * Creates a new pet in the store. Duplicates are allowed

diff --git a/packages/cli/snapshots/integration/generators/openapi-petstore.integration.snapshots.js b/packages/cli/snapshots/integration/generators/openapi-petstore.integration.snapshots.js
@@ -55,10 +55,13 @@ pulvinar elit eu, euismod sapien.
    *
    * @param tags tags to filter by
    * @param limit maximum number of results to return
+   * @param where 
    * @returns pet response
    */
   @operation('get', '/pets')
-  async findPets(@param({name: 'tags', in: 'query'}) tags: string[], @param({name: 'limit', in: 'query'}) limit: number): Promise<Pet[]> {
+  async findPets(@param({name: 'tags', in: 'query'}) tags: string[], @param({name: 'limit', in: 'query'}) limit: number, @param({name: 'where', in: 'query'}) where: {
+  [additionalProperty: string]: any;
+}): Promise<Pet[]> {
     throw new Error('Not implemented');
   }
 

diff --git a/packages/cli/test/fixtures/openapi/3.0/petstore-expanded.yaml b/packages/cli/test/fixtures/openapi/3.0/petstore-expanded.yaml
@@ -1,4 +1,4 @@
-openapi: "3.0.0"
+openapi: '3.0.0'
 info:
   version: 1.0.0
   title: Swagger Petstore
@@ -39,6 +39,14 @@ paths:
           schema:
             type: integer
             format: int32
+        - name: where
+          in: query
+          content:
+            'application/json':
+              schema:
+                type: object
+                title": TodoList.WhereFilter
+                additionalProperties: true
       responses:
         '200':
           description: pet response
@@ -128,7 +136,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/NewPet'
         - required:
-          - id
+            - id
           properties:
             id:
               type: integer
@@ -153,4 +161,3 @@ components:
           format: int32
         message:
           type: string
-
diff --git a/packages/cli/test/integration/generators/openapi-client.integration.js b/packages/cli/test/integration/generators/openapi-client.integration.js
@@ -75,7 +75,10 @@ describe('openapi-generator with --client', function () {
   });
 });
 
-it('generates files with --client for an existing datasource', async () => {
+it('generates files with --client for an existing datasource', async function () {
+  // These tests take longer to execute, they used to time out on Travis CI
+  // eslint-disable-next-line no-invalid-this
+  this.timeout(10000);
   await testUtils
     .executeGenerator(generator)
     .inDir(sandbox.path, () =>