Skip to content

feat(java): Add WithHTTPInfo method derivatives #5712

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
MarioAlexandruDan merged 8 commits into from
Dec 3, 2025
+114 −1
Merged

feat(java): Add WithHTTPInfo method derivatives #5712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b57265c
API-135:
MarioAlexandruDan Dec 3, 2025
361d88e
updated moustache template
MarioAlexandruDan Dec 3, 2025
29eeec1
updated moustache template to accommodate the deleteUserToken case
MarioAlexandruDan Dec 3, 2025
26b6d5e
WithHTTPInfo should always have a return type for all cases
MarioAlexandruDan Dec 3, 2025
9bc00e1
Update clients/algoliasearch-client-java/algoliasearch/src/main/java/…
MarioAlexandruDan Dec 3, 2025
91a6132
Update templates/java/api.mustache
MarioAlexandruDan Dec 3, 2025
98f53f0
Scoped the import to only what is needed. Grouped the import better.
MarioAlexandruDan Dec 3, 2025
9aa2732
Removed unnecessary import.
MarioAlexandruDan Dec 3, 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
5 changes: 5 additions & 0 deletions ...liasearch-client-java/algoliasearch/src/main/java/com/algolia/internal/HttpRequester.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,11 @@ private <T> T execute(@Nonnull HttpRequest httpRequest, RequestOptions requestOp
return null; // No need to deserialize, either no content or no type provided
}

// Returns the raw response when using `*WithHTTPInfo` methods.
if (returnType.hasRawClass(Response.class)) {
return (T) response;
}

// Deserialize and return the response.
return serializer.deserialize(response.body().byteStream(), returnType);
} catch (IOException exception) {
Expand Down
110 changes: 109 additions & 1 deletion templates/java/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import javax.annotation.Nullable;

import okhttp3.Call;
import okhttp3.Request;
import okhttp3.Response;

import {{invokerPackage}}.utils.*;
import {{modelPackage}}.*;
Expand Down Expand Up @@ -163,6 +164,17 @@ public class {{classname}} extends ApiClient {
{{^returnType}}return ;{{/returnType}}
}

{{! This case is used for `WithHTTPInfo` methods }}
/**
* {{{notes}}}{{#allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
{{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class for an HTTP response.{{/x-is-generic}}{{/vendorExtensions}}
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
{{> api_javadoc}}
public Response {{operationId}}WithHTTPInfo({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}} {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<Response> innerType{{/x-is-generic}}{{/vendorExtensions}}{{#hasParams}}, {{/hasParams}}@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
return LaunderThrowable.await({{operationId}}WithHTTPInfoAsync({{#allParams}}{{paramName}}, {{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}requestOptions));
}

{{! This case only sets `requestOptions` as optional }}
/**
* {{{notes}}}{{#allParams}}
Expand All @@ -173,6 +185,16 @@ public class {{classname}} extends ApiClient {
{{#returnType}}return {{/returnType}}this.{{operationId}}({{#allParams}}{{paramName}}, {{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}null);
}

{{! This case sets `requestOptions` as optional and is used for`WithHTTPInfo`}}
/**
* {{{notes}}}{{#allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
{{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class for an HTTP response.{{/x-is-generic}}{{/vendorExtensions}}
{{> api_javadoc}}
public Response {{operationId}}WithHTTPInfo({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<Response> innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException {
return this.{{operationId}}WithHTTPInfo({{#allParams}}{{paramName}}, {{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}null);
}

{{! This case sets `requiredParams` + `requestOptions` }}
{{#optionalParams.0}}
/**
Expand All @@ -186,6 +208,19 @@ public class {{classname}} extends ApiClient {
}
{{/optionalParams.0}}

{{! This case sets `requiredParams` + `requestOptions` and is used for`WithHTTPInfo`}}
{{#optionalParams.0}}
/**
* {{{notes}}}{{#requiredParams}}
* @param {{paramName}} {{{description}}} (required){{/requiredParams}}
{{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class for an HTTP response.{{/x-is-generic}}{{/vendorExtensions}}
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
{{> api_javadoc}}
public Response {{operationId}}WithHTTPInfo({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}, {{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<Response> innerType, {{/x-is-generic}}{{/vendorExtensions}} @Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
return this.{{operationId}}WithHTTPInfo({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, {{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}requestOptions);
}
{{/optionalParams.0}}

{{! This case only sets `requiredParams` }}
{{#optionalParams.0}}
/**
Expand All @@ -198,6 +233,18 @@ public class {{classname}} extends ApiClient {
}
{{/optionalParams.0}}

{{! This case sets `requiredParams` and is used for`WithHTTPInfo`}}
{{#optionalParams.0}}
/**
* {{{notes}}}{{#requiredParams}}
* @param {{paramName}} {{{description}}} (required){{/requiredParams}}
{{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class for an HTTP response.{{/x-is-generic}}{{/vendorExtensions}}
{{> api_javadoc}}
public Response {{operationId}}WithHTTPInfo({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<Response> innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException {
return this.{{operationId}}WithHTTPInfo({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, {{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}null);
}
{{/optionalParams.0}}

/**
* (asynchronously)
* {{{notes}}}{{#allParams}}
Expand All @@ -221,6 +268,29 @@ public class {{classname}} extends ApiClient {
return executeAsync(request, {{#vendorExtensions.x-timeouts}}new RequestOptions().setReadTimeout(Duration.ofMillis({{{read}}}L)).setWriteTimeout(Duration.ofMillis({{{write}}}L)).setConnectTimeout(Duration.ofMillis({{{connect}}}L)).mergeRight({{/vendorExtensions.x-timeouts}}requestOptions{{#vendorExtensions.x-timeouts}}){{/vendorExtensions.x-timeouts}}, {{#vendorExtensions}}{{#x-is-generic}}{{{returnType}}}.class, innerType{{/x-is-generic}}{{/vendorExtensions}}{{^vendorExtensions.x-is-generic}}{{^returnType}}null{{/returnType}}{{#returnType}}new TypeReference<{{{.}}}>(){}{{/returnType}}{{/vendorExtensions.x-is-generic}});
}

/**
* (asynchronously)
* {{{notes}}}{{#allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
* @param innerType The class for an HTTP response.{{/x-is-generic}}{{/vendorExtensions}}
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
{{> api_javadoc}}
public CompletableFuture<Response> {{operationId}}WithHTTPInfoAsync({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}},{{/requiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}, {{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<Response> innerType, {{/x-is-generic}}{{/vendorExtensions}}@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
{{#allParams}}{{#required}}
Parameters.requireNonNull({{paramName}}, "Parameter `{{paramName}}` is required when calling `{{operationId}}`.");
{{/required}}{{/allParams}}

HttpRequest request = HttpRequest.builder()
{{#vendorExtensions}}{{#x-is-custom-request}}.setPathEncoded("{{{path}}}", path){{/x-is-custom-request}}{{^x-is-custom-request}}.setPath("{{{path}}}"{{#pathParams}}, {{{paramName}}}{{/pathParams}}){{/x-is-custom-request}}{{/vendorExtensions}}
.setMethod("{{httpMethod}}")
{{#bodyParam}}.setBody({{paramName}}){{/bodyParam}}
{{#vendorExtensions.x-use-read-transporter}}.setRead(true){{/vendorExtensions.x-use-read-transporter}}
{{#headerParams}}.addHeader("{{baseName}}", {{paramName}}){{/headerParams}}
{{#vendorExtensions}}{{#queryParams}}{{^x-is-custom-request}}.addQueryParameter("{{baseName}}", {{paramName}}){{/x-is-custom-request}}{{#x-is-custom-request}}.addQueryParameters(parameters){{/x-is-custom-request}}{{/queryParams}}{{/vendorExtensions}}
.build();
return executeAsync(request, {{#vendorExtensions.x-timeouts}}new RequestOptions().setReadTimeout(Duration.ofMillis({{{read}}}L)).setWriteTimeout(Duration.ofMillis({{{write}}}L)).setConnectTimeout(Duration.ofMillis({{{connect}}}L)).mergeRight({{/vendorExtensions.x-timeouts}}requestOptions{{#vendorExtensions.x-timeouts}}){{/vendorExtensions.x-timeouts}}, {{#vendorExtensions}}{{#x-is-generic}}{{{returnType}}}.class, innerType{{/x-is-generic}}{{/vendorExtensions}}{{^vendorExtensions.x-is-generic}}{{^returnType}}null{{/returnType}}{{#returnType}}new TypeReference<Response>(){}{{/returnType}}{{/vendorExtensions.x-is-generic}});
}

{{! This case only sets `requestOptions` as optional }}
/**
* (asynchronously)
Expand All @@ -232,6 +302,17 @@ public class {{classname}} extends ApiClient {
return this.{{operationId}}Async({{#allParams}}{{paramName}}, {{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}null);
}

{{! This case sets `requestOptions` as optional and is used for`WithHTTPInfo`}}
/**
* (asynchronously)
* {{{notes}}}{{#allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
* @param innerType The class for an HTTP response.{{/x-is-generic}}{{/vendorExtensions}}
{{> api_javadoc}}
public CompletableFuture<Response> {{operationId}}WithHTTPInfoAsync({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<Response> innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException {
return this.{{operationId}}WithHTTPInfoAsync({{#allParams}}{{paramName}}, {{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}null);
}

{{! This case sets `requiredParams` + `requestOptions` }}
{{#optionalParams.0}}
/**
Expand All @@ -246,6 +327,20 @@ public class {{classname}} extends ApiClient {
}
{{/optionalParams.0}}

{{! This case sets `requiredParams` + `requestOptions` and is used for`WithHTTPInfo`}}
{{#optionalParams.0}}
/**
* (asynchronously)
* {{{notes}}}{{#requiredParams}}
* @param {{paramName}} {{{description}}} (required){{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}
* @param innerType The class for an HTTP response.{{/x-is-generic}}{{/vendorExtensions}}
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
{{> api_javadoc}}
public CompletableFuture<Response> {{operationId}}WithHTTPInfoAsync({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}, {{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}Class<Response> innerType, {{/x-is-generic}}{{/vendorExtensions}}@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
return this.{{operationId}}WithHTTPInfoAsync({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, {{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}requestOptions);
}
{{/optionalParams.0}}

{{! This case only sets `requiredParams` }}
{{#optionalParams.0}}
/**
Expand All @@ -258,7 +353,20 @@ public class {{classname}} extends ApiClient {
return this.{{operationId}}Async({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, {{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}null);
}
{{/optionalParams.0}}
{{/operation}}

{{! This case sets `requiredParams` and is used for`WithHTTPInfo`}}
{{#optionalParams.0}}
/**
* (asynchronously)
* {{{notes}}}{{#requiredParams}}
* @param {{paramName}} {{{description}}} (required){{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}
* @param innerType The class for an HTTP response.{{/x-is-generic}}{{/vendorExtensions}}
{{> api_javadoc}}
public CompletableFuture<Response> {{operationId}}WithHTTPInfoAsync({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<Response> innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException {
return this.{{operationId}}WithHTTPInfoAsync({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#requiredParams.0}},{{/requiredParams.0}}{{#optionalParams}}null{{^-last}},{{/-last}}{{/optionalParams}}, {{#vendorExtensions}}{{#x-is-generic}}innerType, {{/x-is-generic}}{{/vendorExtensions}}null);
}
{{/optionalParams.0}}
{{/operation}}

{{> api_helpers}}
}
Expand Down