Skip to content

feat: [OpenAPI] withDefaultHeader on Api classes #1130

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
Jonas-Isr merged 5 commits into from
Apr 9, 2026
Merged

feat: [OpenAPI] withDefaultHeader on Api classes #1130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
052fa74
first draft
rpanackal Mar 30, 2026
0ec799b
Fix javadoc
rpanackal Mar 30, 2026
3e3cef1
More javadoc
rpanackal Mar 30, 2026
d8df60d
Merge remote-tracking branch 'origin/main' into feat/openapi/apache-d…
rpanackal Apr 8, 2026
8b1e4ee
Remove BaseApi.invokeApi and handle merging in generated code
rpanackal Apr 8, 2026
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
23 changes: 19 additions & 4 deletions ...ple/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/petstore/api/DefaultApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,21 @@ public DefaultApi( @Nonnull final ApiClient apiClient )
super(apiClient);
}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders
* Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public DefaultApi withDefaultHeaders( @Nonnull final Map<String, String> defaultHeaders )
{
final var api = new DefaultApi(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}

/**
* <p>
* <p>
Expand Down Expand Up @@ -85,7 +100,7 @@ public Pet addPet( @Nonnull final PetInput pet )
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

final String[] localVarAccepts = { "application/json" };
Expand Down Expand Up @@ -145,7 +160,7 @@ public OpenApiResponse deletePet( @Nonnull final Long id )
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

final String[] localVarAccepts = { "application/json" };
Expand Down Expand Up @@ -207,7 +222,7 @@ public Pet findPetById( @Nonnull final Long id )
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

final String[] localVarAccepts = { "application/json", "application/xml", "text/xml", "text/html" };
Expand Down Expand Up @@ -264,7 +279,7 @@ public List<Pet> findPets( @Nullable final List<String> tags, @Nullable final In
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

localVarCollectionQueryParams.addAll(ApiClient.parameterToPairs("csv", "tags", tags));
Expand Down
17 changes: 16 additions & 1 deletion ...ple/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/sodastore/api/OrdersApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,21 @@ public OrdersApi( @Nonnull final ApiClient apiClient )
super(apiClient);
}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders
* Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public OrdersApi withDefaultHeaders( @Nonnull final Map<String, String> defaultHeaders )
{
final var api = new OrdersApi(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}

/**
* <p>
* Create a new order
Expand Down Expand Up @@ -80,7 +95,7 @@ public Order ordersPost( @Nonnull final Order order )
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

final String[] localVarAccepts = { "application/json" };
Expand Down
23 changes: 19 additions & 4 deletions ...mple/src/main/java/com/sap/cloud/sdk/datamodel/openapi/apache/sodastore/api/SodasApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,21 @@ public SodasApi( @Nonnull final ApiClient apiClient )
super(apiClient);
}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders
* Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public SodasApi withDefaultHeaders( @Nonnull final Map<String, String> defaultHeaders )
{
final var api = new SodasApi(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}

/**
* <p>
* Download soda product data as binary
Expand Down Expand Up @@ -86,7 +101,7 @@ public byte[] sodasDownloadIdGet( @Nonnull final Long id )
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

final String[] localVarAccepts = { "application/octet-stream" };
Expand Down Expand Up @@ -137,7 +152,7 @@ public List<SodaWithId> sodasGet()
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

final String[] localVarAccepts = { "application/json" };
Expand Down Expand Up @@ -199,7 +214,7 @@ public SodaWithId sodasIdGet( @Nonnull final Long id )
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

final String[] localVarAccepts = { "application/json" };
Expand Down Expand Up @@ -262,7 +277,7 @@ public Soda sodasPut( @Nonnull final SodaWithId sodaWithId )
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

final String[] localVarAccepts = { "application/json" };
Expand Down
8 changes: 8 additions & 0 deletions ...ore-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/BaseApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@

package com.sap.cloud.sdk.services.openapi.apache.apiclient;

import java.util.HashMap;
import java.util.Map;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
Expand All @@ -26,6 +29,11 @@ public abstract class BaseApi
*/
protected final ApiClient apiClient;

/**
* Default headers to be included in every request.
*/
protected final Map<String, String> defaultHeaders = new HashMap<>();

/**
* Creates a new BaseApi instance with default configuration.
*/
Expand Down
17 changes: 17 additions & 0 deletions ...n/resources/openapi-generator/mustache-templates/libraries/apache-httpclient/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,25 @@ public class {{classname}} extends BaseApi {
{
super(aiCoreService.getApiClient());
}

private {{classname}}(@Nonnull final ApiClient apiClient) {
super(apiClient);
}
{{/aiSdkConstructor}}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public {{classname}} withDefaultHeaders(@Nonnull final Map<String, String> defaultHeaders) {
final var api = new {{classname}}(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}

{{#operation}}
{{#hasOptionalParams}}
/**
Expand Down
2 changes: 1 addition & 1 deletion ...s/openapi-generator/mustache-templates/libraries/apache-httpclient/operationBody.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ final String localVarPath = "{{{path}}}"{{#pathParams}}
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();

{{#queryParams}}
Expand Down
19 changes: 18 additions & 1 deletion ...st/api-class-for-ai-sdk/output/com/sap/cloud/sdk/services/builder/api/AwesomeSodaApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,23 @@ public AwesomeSodaApi( @Nonnull final AiCoreService aiCoreService )
super(aiCoreService.getApiClient());
}

private AwesomeSodaApi(@Nonnull final ApiClient apiClient) {
super(apiClient);
}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public AwesomeSodaApi withDefaultHeaders(@Nonnull final Map<String, String> defaultHeaders) {
final var api = new AwesomeSodaApi(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}


/**
* <p>Add a new soda to the store
Expand All @@ -80,7 +97,7 @@ public Soda addSoda(@Nonnull final NewSoda newSoda) throws OpenApiRequestExcepti
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();


Expand Down
19 changes: 18 additions & 1 deletion ...t/api-class-for-ai-sdk/output/com/sap/cloud/sdk/services/builder/api/AwesomeSodasApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,23 @@ public AwesomeSodasApi( @Nonnull final AiCoreService aiCoreService )
super(aiCoreService.getApiClient());
}

private AwesomeSodasApi(@Nonnull final ApiClient apiClient) {
super(apiClient);
}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public AwesomeSodasApi withDefaultHeaders(@Nonnull final Map<String, String> defaultHeaders) {
final var api = new AwesomeSodasApi(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}


/**
* <p>Get a list of all sodas
Expand All @@ -71,7 +88,7 @@ public List<Soda> getSodas() throws OpenApiRequestException {
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();


Expand Down
23 changes: 20 additions & 3 deletions ...onTest/api-class-for-ai-sdk/output/com/sap/cloud/sdk/services/builder/api/DefaultApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,23 @@ public DefaultApi( @Nonnull final AiCoreService aiCoreService )
super(aiCoreService.getApiClient());
}

private DefaultApi(@Nonnull final ApiClient apiClient) {
super(apiClient);
}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public DefaultApi withDefaultHeaders(@Nonnull final Map<String, String> defaultHeaders) {
final var api = new DefaultApi(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}


/**
* <p>Delete a specific soda from the store
Expand Down Expand Up @@ -82,7 +99,7 @@ public OpenApiResponse deleteSodaById(@Nonnull final Long sodaId) throws OpenApi
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();


Expand Down Expand Up @@ -138,7 +155,7 @@ public Soda getSodaById(@Nonnull final Long sodaId) throws OpenApiRequestExcepti
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();


Expand Down Expand Up @@ -202,7 +219,7 @@ public Soda updateSodaById(@Nonnull final Long sodaId, @Nonnull final UpdateSoda
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();


Expand Down
15 changes: 14 additions & 1 deletion ...on-json/output/com/sap/cloud/sdk/services/apiclassvendorextension/api/AwesomeSodaApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,19 @@ public AwesomeSodaApi(@Nonnull final ApiClient apiClient) {
super(apiClient);
}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public AwesomeSodaApi withDefaultHeaders(@Nonnull final Map<String, String> defaultHeaders) {
final var api = new AwesomeSodaApi(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}


/**
* <p>Add a new soda to the store
Expand All @@ -82,7 +95,7 @@ public Soda addSoda(@Nonnull final NewSoda newSoda) throws OpenApiRequestExcepti
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();


Expand Down
15 changes: 14 additions & 1 deletion ...n-json/output/com/sap/cloud/sdk/services/apiclassvendorextension/api/AwesomeSodasApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,19 @@ public AwesomeSodasApi(@Nonnull final ApiClient apiClient) {
super(apiClient);
}

/**
* Creates a new API instance with additional default headers.
*
* @param defaultHeaders Additional headers to include in all requests
* @return A new API instance with the combined headers
*/
public AwesomeSodasApi withDefaultHeaders(@Nonnull final Map<String, String> defaultHeaders) {
final var api = new AwesomeSodasApi(apiClient);
api.defaultHeaders.putAll(this.defaultHeaders);
api.defaultHeaders.putAll(defaultHeaders);
return api;
}


/**
* <p>Get a list of all sodas
Expand All @@ -73,7 +86,7 @@ public List<Soda> getSodas() throws OpenApiRequestException {
final StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
final List<Pair> localVarQueryParams = new ArrayList<Pair>();
final List<Pair> localVarCollectionQueryParams = new ArrayList<Pair>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>();
final Map<String, String> localVarHeaderParams = new HashMap<String, String>(defaultHeaders);
final Map<String, Object> localVarFormParams = new HashMap<String, Object>();


Expand Down
Loading
Loading