feat: [OpenAPI] GZIP encoding by CharlesDuboisSAP · Pull Request #1110 · SAP/cloud-sdk-java

CharlesDuboisSAP · 2026-03-04T10:00:12Z

Context

SAP/cloud-sdk-java-backlog#363.

Smaller payload.
Corresponding AI SDK PR:

feat: [RPT] GZIP encoding ai-sdk-java#779

Feature scope:

If Content-Encoding is set to gzip -> compress the request payload

Definition of Done

Functionality scope stated & covered
Tests cover the scope above
~~Error handling created / updated & covered by the tests above~~
~~Documentation updated~~
~~Release notes updated~~

ZhongpinWang

Some clean code ideas. Bear my first Java PR review with some old JS habits. 😁

ZhongpinWang · 2026-03-05T07:37:49Z

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java

+                        "gzip".equals(headerParams.get("Content-Encoding"))
+                            ? serializeGzip(body, contentTypeObj)
+                            : serialize(body, formParams, contentTypeObj));


[pp] Maybe this part can be extracted into a separate function and do "switch case" for different encodings? Just for better code structure since gzip is only one of the many possible values of content encoding.

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java

ZhongpinWang · 2026-03-05T07:57:36Z

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java

        }
    }
+
+    private HttpEntity serializeGzip( final Object body, final ContentType contentType )


[pp/req] (req for request changes, but up to you to decide) Also the current serializeGzip() cannot handle form data?

What about using the current serialize() method first, after getting the HttpEntity, check the Content-Encoding and call HttpEntity::writeTo() to write the content to OutputStream and then compress? Makes code much cleaner IMO.

CharlesDuboisSAP · 2026-03-05T09:17:23Z

Some clean code ideas. Bear my first Java PR review with some old JS habits. 😁

The ApiClient is straight from OpenAPI Generator. We shouldn't put any effort towards generated code or modified code from OpenAPI.

ZhongpinWang · 2026-03-05T13:31:46Z

The ApiClient is straight from OpenAPI Generator.

I now get your point. But aren't you then editing a generated file? How would you make serializeGzip() work with future generated version (should there be a need to regenerate from the OpenAPI generator)? Feels like one day we need to accept the fact that this file has diverged from the original one? Or just for now we put minimal effort into this. Both fine if we know the pros and cons.

Jonas-Isr

I still feel like we should add some minimal (vibe-coded?) unit tests. I don't think the argument that this is tested through AI SDK is strong enough: If we ever discontinue the feature in AI SDK this will not be tested anymore and potentially break without us noticing.

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java

Jonas-Isr

👍

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java

rpanackal

I really like the clean approach here. Also, thanks for cleaning up the serialize method.

...com/sap/cloud/sdk/services/openapi/apache/apiclient/ApacheApiClientResponseHandlingTest.java

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java

...com/sap/cloud/sdk/services/openapi/apache/apiclient/ApacheApiClientResponseHandlingTest.java

newtork

Looks good to me!

Please consider the one exception message and give feedback on the minor case-sensitivity concern.

rpanackal

The case insensitive "Content-Encoding" check may need to be more robust. We can improve that later as needed

LGTM.

feat: [OpenAPI] GZIP encoding

e95aac7

CharlesDuboisSAP self-assigned this Mar 4, 2026

CharlesDuboisSAP added the please review Request to review a pull request label Mar 4, 2026

CharlesDuboisSAP mentioned this pull request Mar 4, 2026

feat: [RPT] GZIP encoding SAP/ai-sdk-java#779

Open

7 tasks

CharlesDuboisSAP added 2 commits March 4, 2026 11:07

PMD

660fd54

Better if

d197730

ZhongpinWang reviewed Mar 5, 2026

View reviewed changes

Jonas-Isr reviewed Mar 10, 2026

View reviewed changes

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java Outdated Show resolved Hide resolved

CharlesDuboisSAP and others added 7 commits March 10, 2026 13:29

Merge branch 'main' into gzip

dc81eaa

temporary formatting

38b8557

finito formatting

744d2c6

Added test

1f53196

Added test

341e551

format

f4d2f7b

Merge branch 'main' into gzip

a0e510d

Jonas-Isr previously approved these changes Mar 11, 2026

View reviewed changes

rpanackal reviewed Mar 12, 2026

View reviewed changes

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java Outdated Show resolved Hide resolved

rpanackal reviewed Mar 12, 2026

View reviewed changes

...com/sap/cloud/sdk/services/openapi/apache/apiclient/ApacheApiClientResponseHandlingTest.java Show resolved Hide resolved

nullable

5a72fa0

CharlesDuboisSAP dismissed Jonas-Isr’s stale review via 5a72fa0 March 13, 2026 08:13

newtork reviewed Mar 13, 2026

View reviewed changes

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java Outdated Show resolved Hide resolved

newtork reviewed Mar 13, 2026

View reviewed changes

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java Show resolved Hide resolved

newtork reviewed Mar 13, 2026

View reviewed changes

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java Outdated Show resolved Hide resolved

newtork reviewed Mar 13, 2026

View reviewed changes

...core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java Outdated Show resolved Hide resolved

newtork reviewed Mar 13, 2026

View reviewed changes

...com/sap/cloud/sdk/services/openapi/apache/apiclient/ApacheApiClientResponseHandlingTest.java Outdated Show resolved Hide resolved

newtork reviewed Mar 13, 2026

View reviewed changes

Alex's review

e7ea5d5

CharlesDuboisSAP requested a review from rpanackal March 13, 2026 10:31

rpanackal approved these changes Mar 13, 2026

View reviewed changes

CharlesDuboisSAP merged commit 72f1c0c into main Mar 13, 2026
13 checks passed

CharlesDuboisSAP deleted the gzip branch March 13, 2026 11:34

Conversation

CharlesDuboisSAP commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Feature scope:

Definition of Done

Uh oh!

ZhongpinWang left a comment

Choose a reason for hiding this comment

Uh oh!

ZhongpinWang Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ZhongpinWang Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

CharlesDuboisSAP commented Mar 5, 2026

Uh oh!

ZhongpinWang commented Mar 5, 2026

Uh oh!

Jonas-Isr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Jonas-Isr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rpanackal left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

newtork left a comment

Choose a reason for hiding this comment

Uh oh!

rpanackal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

CharlesDuboisSAP commented Mar 4, 2026 •

edited

Loading

ZhongpinWang Mar 5, 2026 •

edited

Loading

rpanackal left a comment •

edited

Loading