Skip to content

Commit 79a4ce7

Browse files
DavidWittmanDavidWittman
committed
[typescript-axios] Conditionally set user-agent
The change in OpenAPITools#20067 has caused some issues with clients which run in a Browser. This commit replaces that change, leaving the default User-Agent for axios unmodified, and only sets the User-Agent if the `http-user-agent` parameter is provided during generation time.
1 parent 187af2e commit 79a4ce7

18 files changed

Lines changed: 39 additions & 104 deletions

File tree

‎bin/configs/typescript-axios-echo-api.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ generatorName: typescript-axios
22
outputDir: samples/client/echo_api/typescript-axios/build
33
inputSpec: modules/openapi-generator/src/test/resources/3_0/echo_api.yaml
44
templateDir: modules/openapi-generator/src/main/resources/typescript-axios
5+
httpUserAgent: EchoApi/1.0.0
56
additionalProperties:
67
artifactId: echo-api-typescript-axios
78
hideGenerationTimestamp: "true"

‎docs/generators/typescript-axios.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
167167
| ---- | --------- | ---------- |
168168
|BasePath|✓|ToolingExtension
169169
|Authorizations|✗|ToolingExtension
170-
|UserAgent|✗|ToolingExtension
170+
|UserAgent|✓|ToolingExtension
171171
|MockServer|✗|ToolingExtension
172172

173173
### Data Type Feature

‎modules/openapi-generator/src/main/resources/typescript-axios/configuration.mustache‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,17 @@ export class Configuration {
7878
this.accessToken = param.accessToken;
7979
this.basePath = param.basePath;
8080
this.serverIndex = param.serverIndex;
81+
{{#httpUserAgent}}
8182
this.baseOptions = {
83+
...param.baseOptions,
8284
headers: {
8385
...param.baseOptions?.headers,
84-
'User-Agent': "OpenAPI-Generator{{#npmVersion}}/{{npmVersion}}{{/npmVersion}}/typescript-axios"
86+
'User-Agent': "{{httpUserAgent}}",
8587
},
86-
...param.baseOptions
87-
};
88+
};{{/httpUserAgent}}
89+
{{^httpUserAgent}}
90+
this.baseOptions = param.baseOptions;
91+
{{/httpUserAgent}}
8892
this.formDataCtor = param.formDataCtor;
8993
}
9094

‎samples/client/echo_api/typescript-axios/build/configuration.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,11 @@ export class Configuration {
9090
this.basePath = param.basePath;
9191
this.serverIndex = param.serverIndex;
9292
this.baseOptions = {
93+
...param.baseOptions,
9394
headers: {
9495
...param.baseOptions?.headers,
95-
'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios"
96+
'User-Agent': "EchoApi/1.0.0",
9697
},
97-
...param.baseOptions
9898
};
9999
this.formDataCtor = param.formDataCtor;
100100
}

‎samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/configuration.ts‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,8 @@ export class Configuration {
8989
this.accessToken = param.accessToken;
9090
this.basePath = param.basePath;
9191
this.serverIndex = param.serverIndex;
92-
this.baseOptions = {
93-
headers: {
94-
...param.baseOptions?.headers,
95-
'User-Agent': "OpenAPI-Generator/typescript-axios"
96-
},
97-
...param.baseOptions
98-
};
92+
93+
this.baseOptions = param.baseOptions;
9994
this.formDataCtor = param.formDataCtor;
10095
}
10196

‎samples/client/petstore/typescript-axios/builds/composed-schemas/configuration.ts‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,8 @@ export class Configuration {
8989
this.accessToken = param.accessToken;
9090
this.basePath = param.basePath;
9191
this.serverIndex = param.serverIndex;
92-
this.baseOptions = {
93-
headers: {
94-
...param.baseOptions?.headers,
95-
'User-Agent': "OpenAPI-Generator/typescript-axios"
96-
},
97-
...param.baseOptions
98-
};
92+
93+
this.baseOptions = param.baseOptions;
9994
this.formDataCtor = param.formDataCtor;
10095
}
10196

‎samples/client/petstore/typescript-axios/builds/default/configuration.ts‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,8 @@ export class Configuration {
8989
this.accessToken = param.accessToken;
9090
this.basePath = param.basePath;
9191
this.serverIndex = param.serverIndex;
92-
this.baseOptions = {
93-
headers: {
94-
...param.baseOptions?.headers,
95-
'User-Agent': "OpenAPI-Generator/typescript-axios"
96-
},
97-
...param.baseOptions
98-
};
92+
93+
this.baseOptions = param.baseOptions;
9994
this.formDataCtor = param.formDataCtor;
10095
}
10196

‎samples/client/petstore/typescript-axios/builds/es6-target/configuration.ts‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,8 @@ export class Configuration {
8989
this.accessToken = param.accessToken;
9090
this.basePath = param.basePath;
9191
this.serverIndex = param.serverIndex;
92-
this.baseOptions = {
93-
headers: {
94-
...param.baseOptions?.headers,
95-
'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios"
96-
},
97-
...param.baseOptions
98-
};
92+
93+
this.baseOptions = param.baseOptions;
9994
this.formDataCtor = param.formDataCtor;
10095
}
10196

‎samples/client/petstore/typescript-axios/builds/test-petstore/configuration.ts‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,8 @@ export class Configuration {
8989
this.accessToken = param.accessToken;
9090
this.basePath = param.basePath;
9191
this.serverIndex = param.serverIndex;
92-
this.baseOptions = {
93-
headers: {
94-
...param.baseOptions?.headers,
95-
'User-Agent': "OpenAPI-Generator/typescript-axios"
96-
},
97-
...param.baseOptions
98-
};
92+
93+
this.baseOptions = param.baseOptions;
9994
this.formDataCtor = param.formDataCtor;
10095
}
10196

‎samples/client/petstore/typescript-axios/builds/with-complex-headers/configuration.ts‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,8 @@ export class Configuration {
8989
this.accessToken = param.accessToken;
9090
this.basePath = param.basePath;
9191
this.serverIndex = param.serverIndex;
92-
this.baseOptions = {
93-
headers: {
94-
...param.baseOptions?.headers,
95-
'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios"
96-
},
97-
...param.baseOptions
98-
};
92+
93+
this.baseOptions = param.baseOptions;
9994
this.formDataCtor = param.formDataCtor;
10095
}
10196

0 commit comments

Comments
 (0)