Skip to content

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

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

Merged
macjohnny merged 13 commits into from
Dec 17, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d41e73c
[typescript-axios] Add User-Agent Header to Default Axios
ckoegel Nov 8, 2024
be617cf
fix if `npmVersion` doesn't exist
ckoegel Nov 8, 2024
fd18887
generate samples
ckoegel Nov 8, 2024
221c322
single line solution
ckoegel Nov 8, 2024
2889f63
Merge branch 'master' of https://github.com/ckoegel/openapi-generator…
ckoegel Dec 6, 2024
7b1e9c7
move user agent header to config
ckoegel Dec 6, 2024
25669c5
generate samples
ckoegel Dec 6, 2024
195d019
splat for headers as well
ckoegel Dec 6, 2024
db33010
samples
ckoegel Dec 6, 2024
7d370bb
move headers above baseOptions
ckoegel Dec 17, 2024
59086c7
samples
ckoegel Dec 17, 2024
949dd9b
commas are hard
ckoegel Dec 17, 2024
34f2792
samples again
ckoegel Dec 17, 2024
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
8 changes: 7 additions & 1 deletion modules/openapi-generator/src/main/resources/typescript-axios/configuration.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Copy link
Member

@macjohnny macjohnny Dec 16, 2024

Choose a reason for hiding this comment

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

please move this before the ...param.baseOptions, so it can be overridden

Copy link
Member

@macjohnny macjohnny Jan 29, 2025

Choose a reason for hiding this comment

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

@ckoegel actually thinking about it again, how about changing this to

this.baseOptions = {
            ...param.baseOptions,
            headers: {
                'User-Agent': "OpenAPI-Generator{{#npmVersion}}/{{npmVersion}}{{/npmVersion}}/typescript-axios",
                ...param.baseOptions?.headers,
            },
        };

in a separate pull request?

Copy link
Contributor Author

@ckoegel ckoegel Jan 30, 2025

Choose a reason for hiding this comment

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

Would you like me to open a PR with this change and we can get that into the 7.12.0 milestone?

Copy link
Member

@macjohnny macjohnny Feb 3, 2025

Choose a reason for hiding this comment

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

@DavidWittman opened #20571, which should address the issue

...param.baseOptions?.headers,
'User-Agent': "OpenAPI-Generator{{#npmVersion}}/{{npmVersion}}{{/npmVersion}}/typescript-axios"
},
...param.baseOptions
};
this.formDataCtor = param.formDataCtor;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/echo_api/typescript-axios/build/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion .../client/others/typescript-axios/with-separate-models-and-api-inheritance/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/composed-schemas/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/default/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/es6-target/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/test-petstore/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/with-complex-headers/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion ...-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion ...re/typescript-axios/builds/with-interfaces-and-with-single-request-param/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/with-interfaces/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/with-node-imports/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion ...ore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/with-npm-version/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion ...s/client/petstore/typescript-axios/builds/with-single-request-parameters/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
8 changes: 7 additions & 1 deletion samples/client/petstore/typescript-axios/builds/with-string-enums/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
Loading