fix: Openapi-generator array schema with nested array (#4630)

* fix: generate nested array objects * added changelog * update test services * Update .changeset/heavy-terms-dance.md Co-authored-by: Deeksha Sinha <88374536+deekshas8@users.noreply.github.com> * separate impl for simple and nested arrays * added comment * refactoring * Changes from lint:fix * small fix * modify test for nested array * Changes from lint:fix * changes to tests --------- Co-authored-by: Deeksha Sinha <88374536+deekshas8@users.noreply.github.com> Co-authored-by: cloud-sdk-js <cloud-sdk-js@github.com>
SAP · Apr 16, 2024 · ff3ede6 · ff3ede6
1 parent 66be02a
commit ff3ede6
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 5 deletions.
diff --git a/.changeset/heavy-terms-dance.md b/.changeset/heavy-terms-dance.md
@@ -0,0 +1,5 @@
+---
+"@sap-cloud-sdk/openapi-generator": minor
+---
+
+[Fixed Issue] Fix nested array type in generated OpenAPI schemas such that array wraps the whole object.
diff --git a/packages/openapi-generator/src/file-serializer/schema.spec.ts b/packages/openapi-generator/src/file-serializer/schema.spec.ts
@@ -105,9 +105,53 @@ describe('serializeSchema for object schemas', () => {
           } & Record<string, string>"
     `);
   });
+
+  it('serializes object schema with array items and no additional properties', () => {
+    expect(
+      serializeSchema({
+        properties: [
+          {
+            name: 'objectArrayProp',
+            required: true,
+            schema: {
+              uniqueItems: false,
+              items: {
+                properties: [
+                  {
+                    name: 'name',
+                    required: true,
+                    schema: { type: 'string' },
+                    schemaProperties: {}
+                  }
+                ],
+                additionalProperties: { type: 'any' }
+              }
+            },
+            schemaProperties: {}
+          }
+        ],
+        additionalProperties: { type: 'any' }
+      })
+    ).toMatchInlineSnapshot(`
+    "{
+          'objectArrayProp': ({
+                'name': string;
+              } & Record<string, any>)[];
+        } & Record<string, any>"
+    `);
+  });
 });
 
 describe('serializeSchema for array schemas', () => {
+  it('serializes array schema', () => {
+    expect(
+      serializeSchema({
+        uniqueItems: false,
+        items: { type: 'string' }
+      })
+    ).toEqual('string[]');
+  });
+
   it('serializes array schema with nested array', () => {
     expect(
       serializeSchema({

diff --git a/packages/openapi-generator/src/file-serializer/schema.ts b/packages/openapi-generator/src/file-serializer/schema.ts
@@ -27,10 +27,16 @@ export function serializeSchema(schema: OpenApiSchema): string {
   if (isReferenceObject(schema)) {
     return schema.schemaName;
   }
+
   if (isArraySchema(schema)) {
     const type = serializeSchema(schema.items);
-    return schema.uniqueItems ? `Set<${type}>` : `${type}[]`;
+    return schema.uniqueItems
+      ? `Set<${type}>`
+      : 'properties' in schema.items
+        ? `(${type})[]`
+        : `${type}[]`;
   }
+
   if (isObjectSchema(schema)) {
     return serializeObjectSchema(schema);
   }

diff --git a/test-packages/test-services-openapi/test-service/schema/complex-test-entity.d.ts b/test-packages/test-services-openapi/test-service/schema/complex-test-entity.d.ts
@@ -10,9 +10,9 @@ import type { TestEntity } from './test-entity';
  */
 export type ComplexTestEntity = {
   referenceProperty?: SimpleTestEntity;
-  arrayProperty?: {
+  arrayProperty?: ({
     item?: string;
-  } & Record<string, any>[];
+  } & Record<string, any>)[];
   uniqueItemsProperty?: Set<string>;
   requiredPropertiesProperty?: {
     optionalProperty?: string;

diff --git a/test-packages/test-services-openapi/test-service/schema/complex-test-entity.ts b/test-packages/test-services-openapi/test-service/schema/complex-test-entity.ts
@@ -10,9 +10,9 @@ import type { TestEntity } from './test-entity';
  */
 export type ComplexTestEntity = {
   referenceProperty?: SimpleTestEntity;
-  arrayProperty?: {
+  arrayProperty?: ({
     item?: string;
-  } & Record<string, any>[];
+  } & Record<string, any>)[];
   uniqueItemsProperty?: Set<string>;
   requiredPropertiesProperty?: {
     optionalProperty?: string;