[typescript-axios] Add User-Agent Header to Default Axios (#20067)

* [typescript-axios] Add User-Agent Header to Default Axios * fix if `npmVersion` doesn't exist * generate samples * single line solution * move user agent header to config * generate samples * splat for headers as well * samples * move headers above baseOptions * samples * commas are hard * samples again
OpenAPITools · Dec 17, 2024 · 289425b · 289425b
1 parent 9fec13a
commit 289425b
Show file tree

Hide file tree

Showing 16 changed files with 112 additions and 16 deletions.
diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/configuration.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/configuration.mustache
@@ -78,7 +78,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator{{#npmVersion}}/{{npmVersion}}{{/npmVersion}}/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/echo_api/typescript-axios/build/configuration.ts b/samples/client/echo_api/typescript-axios/build/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/.../client/others/typescript-axios/with-separate-models-and-api-inheritance/configuration.ts b/.../client/others/typescript-axios/with-separate-models-and-api-inheritance/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/configuration.ts b/samples/client/petstore/typescript-axios/builds/composed-schemas/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/default/configuration.ts b/samples/client/petstore/typescript-axios/builds/default/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/configuration.ts b/samples/client/petstore/typescript-axios/builds/es6-target/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/configuration.ts b/samples/client/petstore/typescript-axios/builds/test-petstore/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-complex-headers/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/...-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/configuration.ts b/...-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/...re/typescript-axios/builds/with-interfaces-and-with-single-request-param/configuration.ts b/...re/typescript-axios/builds/with-interfaces-and-with-single-request-param/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-node-imports/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/...ore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/configuration.ts b/...ore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/...s/client/petstore/typescript-axios/builds/with-single-request-parameters/configuration.ts b/...s/client/petstore/typescript-axios/builds/with-single-request-parameters/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-string-enums/configuration.ts
@@ -89,7 +89,13 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            headers: {
+                ...param.baseOptions?.headers,
+                'User-Agent': "OpenAPI-Generator/typescript-axios"
+            },
+            ...param.baseOptions
+        };
         this.formDataCtor = param.formDataCtor;
     }