[BUG][typescript-angular] apiKeys cause service compilation errors (#22775)

saxicek · web-flow · commit 695f7076bf5d · 2026-01-26T11:51:31.000+01:00
* [BUG][typescript-angular] apiKeys cause service compilation errors Updated TypeScript Angular `configuration.mustache` to properly handle apiKeys in query parameters by using `OpenApiHttpParams` instead of `HttpHeaders` to avoid compilation errors. Fixes #22774 * add generated samples
diff --git a/modules/openapi-generator/src/main/resources/typescript-angular/configuration.mustache b/modules/openapi-generator/src/main/resources/typescript-angular/configuration.mustache
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface {{configurationParametersInterfaceName}} {
     /**
@@ -198,7 +199,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/others/typescript-angular-v20/builds/query-param-deep-object/configuration.ts b/samples/client/others/typescript-angular-v20/builds/query-param-deep-object/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -159,7 +160,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/others/typescript-angular-v20/builds/query-param-form/configuration.ts b/samples/client/others/typescript-angular-v20/builds/query-param-form/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -159,7 +160,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/others/typescript-angular-v20/builds/query-param-json/configuration.ts b/samples/client/others/typescript-angular-v20/builds/query-param-json/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -159,7 +160,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/configuration.ts b/samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -159,7 +160,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/others/typescript-angular/builds/composed-schemas/configuration.ts b/samples/client/others/typescript-angular/builds/composed-schemas/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -159,7 +160,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v16-provided-in-root/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v16-provided-in-root/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v17-provided-in-root/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v17-provided-in-root/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v18-provided-in-root/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v18-provided-in-root/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v19-provided-in-root/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v19-provided-in-root/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v19-with-angular-dependency-params/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v19-with-angular-dependency-params/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v19/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v19/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v20-provided-in-root/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v20-provided-in-root/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v20/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v20/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v21-provided-in-root/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v21-provided-in-root/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
diff --git a/samples/client/petstore/typescript-angular-v21/builds/default/configuration.ts b/samples/client/petstore/typescript-angular-v21/builds/default/configuration.ts
@@ -1,5 +1,6 @@
-import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 
 export interface ConfigurationParameters {
     /**
@@ -179,7 +180,7 @@ constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder,
             : headers;
     }
 
-    public addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams {
+    public addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams {
         const value = this.lookupCredential(credentialKey);
         return value
             ? query.set(paramName, value)
