Fix issue 10020: [BUG] [typescript-angular] Add "header" to reserved words (#10091)

* Rename queryParameters to localVarQueryParameters

* Rename headers to localVarHeaders

* Rename credential to localVarCredential

* Rename httpHeaderAcceptSelected to localVarHttpHeaderAcceptSelected

* Rename formParams to localVarFormParams

* Rename useForm to localVarUseForm

* Rename convertFormParamsToString to localVarConvertFormParamsToString

* Step 3

* update doc

Co-authored-by: Marius Møller <[email protected]>
Co-authored-by: William Cheng <[email protected]>

Author: 3 people

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

@@ -178,92 +178,92 @@ export class {{classname}} {
 {{/allParams}}
 
 {{#hasQueryParams}}
-        let queryParameters = new HttpParams({encoder: this.encoder});
+        let localVarQueryParameters = new HttpParams({encoder: this.encoder});
 {{#queryParams}}
         {{#isArray}}
         if ({{paramName}}) {
         {{#isQueryParamObjectFormatJson}}
-        queryParameters = this.addToHttpParams(queryParameters,
+        localVarQueryParameters = this.addToHttpParams(localVarQueryParameters,
             <any>{{paramName}}, '{{baseName}}');
         {{/isQueryParamObjectFormatJson}}
         {{^isQueryParamObjectFormatJson}}
         {{#isCollectionFormatMulti}}
             {{paramName}}.forEach((element) => {
-                queryParameters = this.addToHttpParams(queryParameters,
+                localVarQueryParameters = this.addToHttpParams(localVarQueryParameters,
                   <any>element, '{{baseName}}');
             })
         {{/isCollectionFormatMulti}}
         {{^isCollectionFormatMulti}}
-            queryParameters = this.addToHttpParams(queryParameters,
+            localVarQueryParameters = this.addToHttpParams(localVarQueryParameters,
                 {{paramName}}.join(COLLECTION_FORMATS['{{collectionFormat}}']), '{{baseName}}');
         {{/isCollectionFormatMulti}}
         {{/isQueryParamObjectFormatJson}}
         }
         {{/isArray}}
         {{^isArray}}
         if ({{paramName}} !== undefined && {{paramName}} !== null) {
-          queryParameters = this.addToHttpParams(queryParameters,
+          localVarQueryParameters = this.addToHttpParams(localVarQueryParameters,
             <any>{{paramName}}, '{{baseName}}');
         }
         {{/isArray}}
 {{/queryParams}}
 
 {{/hasQueryParams}}
-        let headers = this.defaultHeaders;
+        let localVarHeaders = this.defaultHeaders;
 {{#headerParams}}
         {{#isArray}}
         if ({{paramName}}) {
-            headers = headers.set('{{baseName}}', {{paramName}}.join(COLLECTION_FORMATS['{{collectionFormat}}']));
+            localVarHeaders = localVarHeaders.set('{{baseName}}', {{paramName}}.join(COLLECTION_FORMATS['{{collectionFormat}}']));
         }
         {{/isArray}}
         {{^isArray}}
         if ({{paramName}} !== undefined && {{paramName}} !== null) {
-            headers = headers.set('{{baseName}}', String({{paramName}}));
+            localVarHeaders = localVarHeaders.set('{{baseName}}', String({{paramName}}));
         }
         {{/isArray}}
 {{/headerParams}}
 
 {{#authMethods}}
 {{#-first}}
-        let credential: string | undefined;
+        let localVarCredential: string | undefined;
 {{/-first}}
         // authentication ({{name}}) required
-        credential = this.configuration.lookupCredential('{{name}}');
-        if (credential) {
+        localVarCredential = this.configuration.lookupCredential('{{name}}');
+        if (localVarCredential) {
 {{#isApiKey}}
     {{#isKeyInHeader}}
-            headers = headers.set('{{keyParamName}}', credential);
+            localVarHeaders = localVarHeaders.set('{{keyParamName}}', localVarCredential);
     {{/isKeyInHeader}}
     {{#isKeyInQuery}}
-            queryParameters = queryParameters.set('{{keyParamName}}', credential);
+            localVarQueryParameters = localVarQueryParameters.set('{{keyParamName}}', localVarCredential);
     {{/isKeyInQuery}}
 {{/isApiKey}}
 {{#isBasic}}
     {{#isBasicBasic}}
-            headers = headers.set('Authorization', 'Basic ' + credential);
+            localVarHeaders = localVarHeaders.set('Authorization', 'Basic ' + localVarCredential);
     {{/isBasicBasic}}
     {{#isBasicBearer}}
-            headers = headers.set('Authorization', 'Bearer ' + credential);
+            localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential);
     {{/isBasicBearer}}
 {{/isBasic}}
 {{#isOAuth}}
-            headers = headers.set('Authorization', 'Bearer ' + credential);
+            localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential);
 {{/isOAuth}}
         }
 
 {{/authMethods}}
-        let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
-        if (httpHeaderAcceptSelected === undefined) {
+        let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
+        if (localVarHttpHeaderAcceptSelected === undefined) {
             // to determine the Accept header
             const httpHeaderAccepts: string[] = [
                 {{#produces}}
                 '{{{mediaType}}}'{{^-last}},{{/-last}}
                 {{/produces}}
             ];
-            httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+            localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
         }
-        if (httpHeaderAcceptSelected !== undefined) {
-            headers = headers.set('Accept', httpHeaderAcceptSelected);
+        if (localVarHttpHeaderAcceptSelected !== undefined) {
+            localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
         }
 
 {{#bodyParam}}
@@ -288,68 +288,68 @@ export class {{classname}} {
 {{#bodyParam}}
         const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes);
         if (httpContentTypeSelected !== undefined) {
-            headers = headers.set('Content-Type', httpContentTypeSelected);
+            localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected);
         }
 {{/bodyParam}}
 
 {{#hasFormParams}}
         const canConsumeForm = this.canConsumeForm(consumes);
 
-        let formParams: { append(param: string, value: any): any; };
-        let useForm = false;
-        let convertFormParamsToString = false;
-{{#formParams}}
+        let localVarFormParams: { append(param: string, value: any): any; };
+        let localVarUseForm = false;
+        let localVarConvertFormParamsToString = false;
+{{#localVarFormParams}}
 {{#isFile}}
         // use FormData to transmit files using content-type "multipart/form-data"
         // see https://stackoverflow.com/questions/4007969/application-x-www-form-urlencoded-or-multipart-form-data
-        useForm = canConsumeForm;
+        localVarUseForm = canConsumeForm;
 {{/isFile}}
-{{/formParams}}
-        if (useForm) {
-            formParams = new FormData();
+{{/localVarFormParams}}
+        if (localVarUseForm) {
+            localVarFormParams = new FormData();
         } else {
-            formParams = new HttpParams({encoder: this.encoder});
+            localVarFormParams = new HttpParams({encoder: this.encoder});
         }
 
-{{#formParams}}
+{{#localVarFormParams}}
         {{#isArray}}
         if ({{paramName}}) {
         {{#isCollectionFormatMulti}}
             {{paramName}}.forEach((element) => {
-                formParams = formParams.append('{{baseName}}', <any>element) as any || formParams;
+                localVarFormParams = localVarFormParams.append('{{baseName}}', <any>element) as any || localVarFormParams;
             })
         {{/isCollectionFormatMulti}}
         {{^isCollectionFormatMulti}}
-            if (useForm) {
+            if (localVarUseForm) {
                 {{paramName}}.forEach((element) => {
-                    formParams = formParams.append('{{baseName}}', <any>element) as any || formParams;
+                    localVarFormParams = localVarFormParams.append('{{baseName}}', <any>element) as any || localVarFormParams;
             })
             } else {
-                formParams = formParams.append('{{baseName}}', {{paramName}}.join(COLLECTION_FORMATS['{{collectionFormat}}'])) as any || formParams;
+                localVarFormParams = localVarFormParams.append('{{baseName}}', {{paramName}}.join(COLLECTION_FORMATS['{{collectionFormat}}'])) as any || localVarFormParams;
             }
         {{/isCollectionFormatMulti}}
         }
         {{/isArray}}
         {{^isArray}}
         if ({{paramName}} !== undefined) {
-            formParams = formParams.append('{{baseName}}', {{^isModel}}<any>{{paramName}}{{/isModel}}{{#isModel}}useForm ? new Blob([JSON.stringify({{paramName}})], {type: 'application/json'}) : <any>{{paramName}}{{/isModel}}) as any || formParams;
+            localVarFormParams = localVarFormParams.append('{{baseName}}', {{^isModel}}<any>{{paramName}}{{/isModel}}{{#isModel}}localVarUseForm ? new Blob([JSON.stringify({{paramName}})], {type: 'application/json'}) : <any>{{paramName}}{{/isModel}}) as any || localVarFormParams;
         }
         {{/isArray}}
-{{/formParams}}
+{{/localVarFormParams}}
 
 {{/hasFormParams}}
     {{^isResponseFile}}
         let responseType_: 'text' | 'json' = 'json';
-        if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
+        if(localVarHttpHeaderAcceptSelected && localVarHttpHeaderAcceptSelected.startsWith('text')) {
             responseType_ = 'text';
         }
 
     {{/isResponseFile}}
         return this.httpClient.{{httpMethod}}{{^isResponseFile}}<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>{{/isResponseFile}}(`${this.configuration.basePath}{{{path}}}`,{{#isBodyAllowed}}
-            {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}{{#hasFormParams}}convertFormParamsToString ? formParams.toString() : formParams{{/hasFormParams}}{{^hasFormParams}}null{{/hasFormParams}}{{/bodyParam}},{{/isBodyAllowed}}
+            {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}{{#hasFormParams}}localVarConvertFormParamsToString ? localVarFormParams.toString() : localVarFormParams{{/hasFormParams}}{{^hasFormParams}}null{{/hasFormParams}}{{/bodyParam}},{{/isBodyAllowed}}
             {
     {{#hasQueryParams}}
-                params: queryParameters,
+                params: localVarQueryParameters,
     {{/hasQueryParams}}
     {{#isResponseFile}}
                 responseType: "blob",
@@ -358,7 +358,7 @@ export class {{classname}} {
                 responseType: <any>responseType_,
     {{/isResponseFile}}
                 withCredentials: this.configuration.withCredentials,
-                headers: headers,
+                localVarHeaders: localVarHeaders,
                 observe: observe,
                 reportProgress: reportProgress
             }