refactor: [OpenAPI] Refactor Apache related files and templates #1048
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- no more shared client in *Api.java instances
… apiclient package
- *Api.invoke method bugged and unused
- Remove debugging, connectionTimeout, defaultHeaderMap, defaultCookieMap - add TODOs - public setBasePath - Remove addDefaultHeader, setUserAgent,
- Make as manny methods static - Remove deprecated getStatusCode and getResponseHeaders - public parameterToPairs
- Make as many methods static - rename ApiClientResponseHandler to DefaultApiResponseHandler - finish up ApiClient todos
- Enhance JavaDoc - Support Vendor extension `x-sap-cloud-sdk-operation-name`
- Method overloading for required and options param in operations
- final on local vars
newtork
reviewed
Dec 30, 2025
| return this; | ||
| } | ||
| return fromHttpClient((CloseableHttpClient) ApacheHttpClient5Accessor.getHttpClient(destination)) | ||
| .withBasePath(destination.asHttp().getUri().toString()); |
Contributor
There was a problem hiding this comment.
(Minor)
I'm not sure whether the following is unnecessary: withBasePath(destination.asHttp().getUri().toString())
unit tests will show.
newtork
reviewed
Dec 30, 2025
| import lombok.Value; | ||
| import lombok.With; | ||
|
|
||
| @Value |
Contributor
There was a problem hiding this comment.
(Minor)
Happy about making it an immuatable class!
Unfortunately it's final implicitly, meaning it can never be customized e.g. for future workarounds. Potential solution could be non-value or introduction of interface.
newtork
reviewed
Dec 30, 2025
| protected DateFormat dateFormat; | ||
| @With | ||
| @Nullable | ||
| String tempFolderPath; |
Contributor
There was a problem hiding this comment.
(Minor)
You mentioned you want this field to have public getter (?)
newtork
reviewed
Dec 30, 2025
| * {{#appDescription}}{{{appDescription}}}{{/appDescription}}{{^appDescription}}No description provided.{{/appDescription}} | ||
| */ | ||
| {{!>generatedAnnotation}} | ||
| {{^isReleased}}@Beta{{/isReleased}} |
Contributor
There was a problem hiding this comment.
(Minor)
Please use fully-qualified-name for optional (deendency) anotations, e.g.
@com.google.common.annotations.Beta
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
SAP/cloud-sdk-java-backlog#464.
The parent PR contains all files as they would be if we purely relied on generation via OpenAPI code generator with commonly generated files packages with
openapi-coremodule.The scope of this PR is to reduce public API, achieve feature parity with resttemplate based generation and refactoring code for readability.
Feature scope:
auth/*.javafiles - We support authentication via destinationApiExceptionremoved in favour existingOpenApiRequestException(modified)ServerConfiguration,ServerVariable,StringUtilremoved as we do not support single client instance pointing to multi urlsapiClient/RFC3339DateFormatBaseApiImprovements in
ApiClientdefaultHeaderMaps: headers expected to be set request level, destination header provider or customClosableHttpClientdefaultCookieMap: no cookie supportservers,serverIndex,serverVariables: only singlebaseUrlsupportlastStatusCode,lastResponseHeaders: Removed due to feature engineering concerns. To compensate, new api introduced inOpenApiRequestException.debuggingflag,connectionTimeout: useless and to be configured elsewhere.cookieParamsandauthNamesthat sets request level configuration for cookies and authorization (but unused) are removed frominvokeAPIsignature@Betaon jackson exposing apistaticDefaultApiResponseHandlerFeature Parity with resttemplate (template modifications)
finalon local vars, parameters, returns as appropriate.x-sap-cloud-sdk-operation-name,x-return-nullableapache/OpenApiResponseinstead ofvoidas return type for remote calls. Existingcore/OpenApiResponsehas Spring components in public contract. 😿Definition of Done
Error handling created / updated & covered by the tests aboveDocumentation updatedRelease notes updated