Skip to content

[Java] fix missing header parameters in the generated google-api-client Java client #22468

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
wing328 merged 4 commits into from
Dec 1, 2025
Merged

[Java] fix missing header parameters in the generated google-api-client Java client #22468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2e1ed1c
fix(java): add header parameter handling for google-api-client
artnan Nov 28, 2025
781cf25
Merge branch 'fix/google-api-client-header-params' of https://github.…
wing328 Dec 1, 2025
d424b94
update samples
wing328 Dec 1, 2025
2b74ae2
minor enhancement
wing328 Dec 1, 2025
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
32 changes: 29 additions & 3 deletions modules/openapi-generator/src/main/resources/Java/libraries/google-api-client/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,13 @@ public class {{classname}} {
GenericUrl genericUrl = new GenericUrl(localVarUrl);

HttpContent content = {{#isBodyAllowed}}{{#bodyParam}}apiClient.new JacksonJsonHttpContent({{paramName}}){{/bodyParam}}{{^bodyParam}}new EmptyContent(){{/bodyParam}}{{/isBodyAllowed}}{{^isBodyAllowed}}null{{/isBodyAllowed}};
return apiClient.getHttpRequestFactory().buildRequest(HttpMethods.{{httpMethod}}, genericUrl, content).execute();
com.google.api.client.http.HttpRequest httpRequest = apiClient.getHttpRequestFactory().buildRequest(HttpMethods.{{httpMethod}}, genericUrl, content);
{{#headerParams}}
if ({{paramName}} != null) {
httpRequest.getHeaders().set("{{baseName}}", {{paramName}});
}
{{/headerParams}}
return httpRequest.execute();
}{{#bodyParam}}

{{#isDeprecated}}
Expand Down Expand Up @@ -159,7 +165,13 @@ public class {{classname}} {
HttpContent content = {{#bodyParam}}{{paramName}} == null ?
apiClient.new JacksonJsonHttpContent(null) :
new InputStreamContent(mediaType == null ? Json.MEDIA_TYPE : mediaType, {{paramName}}){{/bodyParam}};
return apiClient.getHttpRequestFactory().buildRequest(HttpMethods.{{httpMethod}}, genericUrl, content).execute();
com.google.api.client.http.HttpRequest httpRequest = apiClient.getHttpRequestFactory().buildRequest(HttpMethods.{{httpMethod}}, genericUrl, content);
{{#headerParams}}
if ({{paramName}} != null) {
httpRequest.getHeaders().set("{{baseName}}", {{paramName}});
}
{{/headerParams}}
return httpRequest.execute();
}{{/bodyParam}}

{{#isDeprecated}}
Expand Down Expand Up @@ -201,7 +213,21 @@ public class {{classname}} {
GenericUrl genericUrl = new GenericUrl(localVarUrl);

HttpContent content = {{#isBodyAllowed}}{{#bodyParam}}apiClient.new JacksonJsonHttpContent({{paramName}}){{/bodyParam}}{{^bodyParam}}new EmptyContent(){{/bodyParam}}{{/isBodyAllowed}}{{^isBodyAllowed}}null{{/isBodyAllowed}};
return apiClient.getHttpRequestFactory().buildRequest(HttpMethods.{{httpMethod}}, genericUrl, content).execute();
com.google.api.client.http.HttpRequest httpRequest = apiClient.getHttpRequestFactory().buildRequest(HttpMethods.{{httpMethod}}, genericUrl, content);
{{#hasHeaderParams}}
// Note: Header params passed via 'params' map are handled below
for (Map.Entry<String, Object> entry: params.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
// Check if this is a header parameter by name
{{#headerParams}}
if ("{{baseName}}".equals(key) && value != null) {
httpRequest.getHeaders().set(key, value);
}
{{/headerParams}}
}
{{/hasHeaderParams}}
return httpRequest.execute();
}


Expand Down
24 changes: 21 additions & 3 deletions ...tore/java/google-api-client/src/main/java/org/openapitools/client/api/AnotherFakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,11 @@ public HttpResponse call123testSpecialTagsForHttpResponse(@javax.annotation.Nonn
GenericUrl genericUrl = new GenericUrl(localVarUrl);

HttpContent content = apiClient.new JacksonJsonHttpContent(body);
return apiClient.getHttpRequestFactory().buildRequest(HttpMethods.PATCH, genericUrl, content).execute();
com.google.api.client.http.HttpRequest httpRequest = apiClient.getHttpRequestFactory().buildRequest(HttpMethods.PATCH, genericUrl, content);
if (uuidTest != null) {
httpRequest.getHeaders().set("uuid_test", uuidTest);
}
return httpRequest.execute();
}

public HttpResponse call123testSpecialTagsForHttpResponse(@javax.annotation.Nonnull UUID uuidTest, java.io.InputStream body, String mediaType) throws IOException {
Expand All @@ -106,7 +110,11 @@ public HttpResponse call123testSpecialTagsForHttpResponse(@javax.annotation.Nonn
HttpContent content = body == null ?
apiClient.new JacksonJsonHttpContent(null) :
new InputStreamContent(mediaType == null ? Json.MEDIA_TYPE : mediaType, body);
return apiClient.getHttpRequestFactory().buildRequest(HttpMethods.PATCH, genericUrl, content).execute();
com.google.api.client.http.HttpRequest httpRequest = apiClient.getHttpRequestFactory().buildRequest(HttpMethods.PATCH, genericUrl, content);
if (uuidTest != null) {
httpRequest.getHeaders().set("uuid_test", uuidTest);
}
return httpRequest.execute();
}

public HttpResponse call123testSpecialTagsForHttpResponse(@javax.annotation.Nonnull UUID uuidTest, @javax.annotation.Nonnull Client body, Map<String, Object> params) throws IOException {
Expand Down Expand Up @@ -141,7 +149,17 @@ public HttpResponse call123testSpecialTagsForHttpResponse(@javax.annotation.Nonn
GenericUrl genericUrl = new GenericUrl(localVarUrl);

HttpContent content = apiClient.new JacksonJsonHttpContent(body);
return apiClient.getHttpRequestFactory().buildRequest(HttpMethods.PATCH, genericUrl, content).execute();
com.google.api.client.http.HttpRequest httpRequest = apiClient.getHttpRequestFactory().buildRequest(HttpMethods.PATCH, genericUrl, content);
// Note: Header params passed via 'params' map are handled below
for (Map.Entry<String, Object> entry: params.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
// Check if this is a header parameter by name
if ("uuid_test".equals(key) && value != null) {
Copy link
Member Author

@wing328 wing328 Dec 1, 2025

Choose a reason for hiding this comment

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

@artnan

thanks again for the contribution.

instead of looping through all header parameters, what about checking if params contains the key uuid_test for example and update httpRequest accordingly?

httpRequest.getHeaders().set(key, value);
}
}
return httpRequest.execute();
}


Expand Down
Loading
Loading