Skip to content

[typescript-angular] Fix recursive Query-Param Object name #23896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
angelaki wants to merge 3 commits into
base: master
Choose a base branch
from
+483 −59
Open

[typescript-angular] Fix recursive Query-Param Object name #23896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
339c354
Fix recursive Query-Param Object name
angelaki May 28, 2026
8e17470
Added `addToHttpParamsDeepObject`
angelaki Jun 2, 2026
66bad2b
Refactoring
angelaki Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions modules/openapi-generator/src/main/resources/typescript-angular/api.base.service.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export class BaseService {
}

return Object.keys(value as Record<string, any>).reduce(
(hp, k) => hp.append(`${key}[${k}]`, value[k]),
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);
} else if (paramStyle === QueryParamStyle.Json) {
Expand Down Expand Up @@ -69,8 +69,8 @@ export class BaseService {
// Otherwise, if it's an object, add each field.
if (paramStyle === QueryParamStyle.Form) {
if (explode) {
Object.keys(value).forEach(k => {
httpParams = this.addToHttpParams(httpParams, k, value[k], paramStyle, explode);
Object.entries(value).forEach(([k, v]) => {
httpParams = this.addToHttpParams(httpParams, `${key}.${k}`, v, paramStyle, explode);
});
return httpParams;
} else {
Expand All @@ -85,4 +85,25 @@ export class BaseService {
}
}
}

private addToHttpParamsDeepObject(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined): OpenApiHttpParams {
if (value == null) {
return httpParams;
} else if (value instanceof Date) {
return httpParams.append(key, value.toISOString());
} else if (Object(value) !== value) {
return httpParams.append(key, value.toString());
} else if (Array.isArray(value) || value instanceof Set) {
const array = Array.isArray(value) ? value : Array.from(value);
array.forEach((item, index) => {
httpParams = this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item);
});
return httpParams;
} else {
return Object.entries(value).reduce(
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1: Object.entries is not available under the generator’s current TypeScript lib setup, so this change breaks generated Angular builds/type-checking.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/resources/typescript-angular/api.base.service.mustache, line 103:

<comment>`Object.entries` is not available under the generator’s current TypeScript lib setup, so this change breaks generated Angular builds/type-checking.</comment>

<file context>
@@ -85,4 +85,25 @@ export class BaseService {
+            });
+            return httpParams;
+        } else {
+            return Object.entries(value).reduce(
+                (hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
+                httpParams,
</file context>
Suggested change
return Object.entries(value).reduce(
return Object.keys(value).reduce(
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);

(hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
httpParams,
);
}
}
}
4 changes: 4 additions & 0 deletions ...openapitools/codegen/typescript/typescriptangular/TypeScriptAngularClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,10 @@ public void testDeepObject() throws IOException {
final String fileContents = Files.readString(Paths.get(output + "/api/default.service.ts"));
assertThat(fileContents).containsSubsequence("'options',\n", "<any>options,\n", "QueryParamStyle.DeepObject,\n", "true,\n");
assertThat(fileContents).containsSubsequence("'inputOptions',\n", "<any>inputOptions,\n", "QueryParamStyle.DeepObject,\n", "true,\n");

final String baseServiceContents = Files.readString(Paths.get(output + "/api.base.service.ts"));
assertThat(baseServiceContents).contains("this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k])");
assertThat(baseServiceContents).contains("this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item)");
}

@Test
Expand Down
27 changes: 24 additions & 3 deletions .../resources/integrationtests/typescript/additional-properties-expected/api.base.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class BaseService {
}

return Object.keys(value as Record<string, any>).reduce(
(hp, k) => hp.append(`${key}[${k}]`, value[k]),
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);
} else if (paramStyle === QueryParamStyle.Json) {
Expand All @@ -76,8 +76,8 @@ export class BaseService {
// Otherwise, if it's an object, add each field.
if (paramStyle === QueryParamStyle.Form) {
if (explode) {
Object.keys(value).forEach(k => {
httpParams = this.addToHttpParams(httpParams, k, value[k], paramStyle, explode);
Object.entries(value).forEach(([k, v]) => {
httpParams = this.addToHttpParams(httpParams, `${key}.${k}`, v, paramStyle, explode);
});
return httpParams;
} else {
Expand All @@ -92,4 +92,25 @@ export class BaseService {
}
}
}

private addToHttpParamsDeepObject(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined): OpenApiHttpParams {
if (value == null) {
return httpParams;
} else if (value instanceof Date) {
return httpParams.append(key, value.toISOString());
} else if (Object(value) !== value) {
return httpParams.append(key, value.toString());
} else if (Array.isArray(value) || value instanceof Set) {
const array = Array.isArray(value) ? value : Array.from(value);
array.forEach((item, index) => {
httpParams = this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item);
});
return httpParams;
} else {
return Object.entries(value).reduce(
(hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
httpParams,
);
}
}
}
27 changes: 24 additions & 3 deletions .../test/resources/integrationtests/typescript/array-and-object-expected/api.base.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class BaseService {
}

return Object.keys(value as Record<string, any>).reduce(
(hp, k) => hp.append(`${key}[${k}]`, value[k]),
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);
} else if (paramStyle === QueryParamStyle.Json) {
Expand All @@ -76,8 +76,8 @@ export class BaseService {
// Otherwise, if it's an object, add each field.
if (paramStyle === QueryParamStyle.Form) {
if (explode) {
Object.keys(value).forEach(k => {
httpParams = this.addToHttpParams(httpParams, k, value[k], paramStyle, explode);
Object.entries(value).forEach(([k, v]) => {
httpParams = this.addToHttpParams(httpParams, `${key}.${k}`, v, paramStyle, explode);
});
return httpParams;
} else {
Expand All @@ -92,4 +92,25 @@ export class BaseService {
}
}
}

private addToHttpParamsDeepObject(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined): OpenApiHttpParams {
if (value == null) {
return httpParams;
} else if (value instanceof Date) {
return httpParams.append(key, value.toISOString());
} else if (Object(value) !== value) {
return httpParams.append(key, value.toString());
} else if (Array.isArray(value) || value instanceof Set) {
const array = Array.isArray(value) ? value : Array.from(value);
array.forEach((item, index) => {
httpParams = this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item);
});
return httpParams;
} else {
return Object.entries(value).reduce(
(hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
httpParams,
);
}
}
}
27 changes: 24 additions & 3 deletions ...est/resources/integrationtests/typescript/custom-path-params-expected/api.base.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class BaseService {
}

return Object.keys(value as Record<string, any>).reduce(
(hp, k) => hp.append(`${key}[${k}]`, value[k]),
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);
} else if (paramStyle === QueryParamStyle.Json) {
Expand All @@ -76,8 +76,8 @@ export class BaseService {
// Otherwise, if it's an object, add each field.
if (paramStyle === QueryParamStyle.Form) {
if (explode) {
Object.keys(value).forEach(k => {
httpParams = this.addToHttpParams(httpParams, k, value[k], paramStyle, explode);
Object.entries(value).forEach(([k, v]) => {
httpParams = this.addToHttpParams(httpParams, `${key}.${k}`, v, paramStyle, explode);
});
return httpParams;
} else {
Expand All @@ -92,4 +92,25 @@ export class BaseService {
}
}
}

private addToHttpParamsDeepObject(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined): OpenApiHttpParams {
if (value == null) {
return httpParams;
} else if (value instanceof Date) {
return httpParams.append(key, value.toISOString());
} else if (Object(value) !== value) {
return httpParams.append(key, value.toString());
} else if (Array.isArray(value) || value instanceof Set) {
const array = Array.isArray(value) ? value : Array.from(value);
array.forEach((item, index) => {
httpParams = this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item);
});
return httpParams;
} else {
return Object.entries(value).reduce(
(hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
httpParams,
);
}
}
}
27 changes: 24 additions & 3 deletions ...ator/src/test/resources/integrationtests/typescript/petstore-expected/api.base.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class BaseService {
}

return Object.keys(value as Record<string, any>).reduce(
(hp, k) => hp.append(`${key}[${k}]`, value[k]),
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);
} else if (paramStyle === QueryParamStyle.Json) {
Expand All @@ -76,8 +76,8 @@ export class BaseService {
// Otherwise, if it's an object, add each field.
if (paramStyle === QueryParamStyle.Form) {
if (explode) {
Object.keys(value).forEach(k => {
httpParams = this.addToHttpParams(httpParams, k, value[k], paramStyle, explode);
Object.entries(value).forEach(([k, v]) => {
httpParams = this.addToHttpParams(httpParams, `${key}.${k}`, v, paramStyle, explode);
});
return httpParams;
} else {
Expand All @@ -92,4 +92,25 @@ export class BaseService {
}
}
}

private addToHttpParamsDeepObject(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined): OpenApiHttpParams {
if (value == null) {
return httpParams;
} else if (value instanceof Date) {
return httpParams.append(key, value.toISOString());
} else if (Object(value) !== value) {
return httpParams.append(key, value.toString());
} else if (Array.isArray(value) || value instanceof Set) {
const array = Array.isArray(value) ? value : Array.from(value);
array.forEach((item, index) => {
httpParams = this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item);
});
return httpParams;
} else {
return Object.entries(value).reduce(
(hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
httpParams,
);
}
}
}
27 changes: 24 additions & 3 deletions ...s/client/others/typescript-angular-v20/builds/query-param-deep-object/api.base.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class BaseService {
}

return Object.keys(value as Record<string, any>).reduce(
(hp, k) => hp.append(`${key}[${k}]`, value[k]),
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);
} else if (paramStyle === QueryParamStyle.Json) {
Expand Down Expand Up @@ -77,8 +77,8 @@ export class BaseService {
// Otherwise, if it's an object, add each field.
if (paramStyle === QueryParamStyle.Form) {
if (explode) {
Object.keys(value).forEach(k => {
httpParams = this.addToHttpParams(httpParams, k, value[k], paramStyle, explode);
Object.entries(value).forEach(([k, v]) => {
httpParams = this.addToHttpParams(httpParams, `${key}.${k}`, v, paramStyle, explode);
});
return httpParams;
} else {
Expand All @@ -93,4 +93,25 @@ export class BaseService {
}
}
}

private addToHttpParamsDeepObject(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined): OpenApiHttpParams {
if (value == null) {
return httpParams;
} else if (value instanceof Date) {
return httpParams.append(key, value.toISOString());
} else if (Object(value) !== value) {
return httpParams.append(key, value.toString());
} else if (Array.isArray(value) || value instanceof Set) {
const array = Array.isArray(value) ? value : Array.from(value);
array.forEach((item, index) => {
httpParams = this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item);
});
return httpParams;
} else {
return Object.entries(value).reduce(
(hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
httpParams,
);
}
}
}
27 changes: 24 additions & 3 deletions samples/client/others/typescript-angular-v20/builds/query-param-form/api.base.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class BaseService {
}

return Object.keys(value as Record<string, any>).reduce(
(hp, k) => hp.append(`${key}[${k}]`, value[k]),
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);
} else if (paramStyle === QueryParamStyle.Json) {
Expand Down Expand Up @@ -77,8 +77,8 @@ export class BaseService {
// Otherwise, if it's an object, add each field.
if (paramStyle === QueryParamStyle.Form) {
if (explode) {
Object.keys(value).forEach(k => {
httpParams = this.addToHttpParams(httpParams, k, value[k], paramStyle, explode);
Object.entries(value).forEach(([k, v]) => {
httpParams = this.addToHttpParams(httpParams, `${key}.${k}`, v, paramStyle, explode);
});
return httpParams;
} else {
Expand All @@ -93,4 +93,25 @@ export class BaseService {
}
}
}

private addToHttpParamsDeepObject(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined): OpenApiHttpParams {
if (value == null) {
return httpParams;
} else if (value instanceof Date) {
return httpParams.append(key, value.toISOString());
} else if (Object(value) !== value) {
return httpParams.append(key, value.toString());
} else if (Array.isArray(value) || value instanceof Set) {
const array = Array.isArray(value) ? value : Array.from(value);
array.forEach((item, index) => {
httpParams = this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item);
});
return httpParams;
} else {
return Object.entries(value).reduce(
(hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
httpParams,
);
}
}
}
27 changes: 24 additions & 3 deletions samples/client/others/typescript-angular-v20/builds/query-param-json/api.base.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class BaseService {
}

return Object.keys(value as Record<string, any>).reduce(
(hp, k) => hp.append(`${key}[${k}]`, value[k]),
(hp, k) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, value[k]),
httpParams,
);
} else if (paramStyle === QueryParamStyle.Json) {
Expand Down Expand Up @@ -77,8 +77,8 @@ export class BaseService {
// Otherwise, if it's an object, add each field.
if (paramStyle === QueryParamStyle.Form) {
if (explode) {
Object.keys(value).forEach(k => {
httpParams = this.addToHttpParams(httpParams, k, value[k], paramStyle, explode);
Object.entries(value).forEach(([k, v]) => {
httpParams = this.addToHttpParams(httpParams, `${key}.${k}`, v, paramStyle, explode);
});
return httpParams;
} else {
Expand All @@ -93,4 +93,25 @@ export class BaseService {
}
}
}

private addToHttpParamsDeepObject(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined): OpenApiHttpParams {
if (value == null) {
return httpParams;
} else if (value instanceof Date) {
return httpParams.append(key, value.toISOString());
} else if (Object(value) !== value) {
return httpParams.append(key, value.toString());
} else if (Array.isArray(value) || value instanceof Set) {
const array = Array.isArray(value) ? value : Array.from(value);
array.forEach((item, index) => {
httpParams = this.addToHttpParamsDeepObject(httpParams, `${key}[${index}]`, item);
});
return httpParams;
} else {
return Object.entries(value).reduce(
(hp, [k, v]) => this.addToHttpParamsDeepObject(hp, `${key}[${k}]`, v),
httpParams,
);
}
}
}
Loading
Loading