Skip to content

feat: revisit beta annotations - #1045

Open
vladimir-a-sap wants to merge 19 commits into
v2from
revisit-beta-annotations
Open

vladimir-a-sap wants to merge 19 commits into
v2from
revisit-beta-annotations

Conversation

@vladimir-a-sap

@vladimir-a-sap vladimir-a-sap commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Context
https://github.com/SAP/ai-sdk-java-backlog/issues/432

related documentation task: https://github.com/SAP/ai-sdk-java-backlog/issues/438

Definition of Done

  • Functionality scope stated & covered
  • Tests cover the scope above
  • Relevant E2E tests are green (at least locally)
  • Error handling created / updated & covered by the tests above
  • Aligned changes with the JavaScript SDK (not applicable, java code only)
  • Documentation updated
  • Release notes updated (seems to be irrelevant for this particular task, documentation will be updated instead)

* @param jackson The {@link ObjectMapper} to use
* @return the current instance of {@link ClientResponseHandler} with the changed object mapper
*/
@Beta

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • last update was in august 2025
  • it looks like an internal SDK class not supposed to be directly used by our users

* @since 1.15.0
*/
@Beta
public class OrchestrationConfigClient extends OrchestrationConfigsApi {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • created in Jan 2026
  • no method signature changes or field changes since creation

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • removed @beta from standard java methods (equals, hashcode, etc.)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • removed @beta from standard java methods (equals, hashcode, etc.)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • removed @beta from standard java methods (equals, hashcode, etc.)

* @param apiVersion the API version to target.
* @return a new client.
*/
@Beta

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • api introduced in december 2024
  • signature never changed since then

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • internal sdk class (not supposed to be used directly, as it seems)
  • was introduced in april 2026
  • has never been changes since its introduction

* @return The completion response.
* @throws OrchestrationClientException If the request fails.
*/
@Beta

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • implemented in november 2024
  • no changes to method signature or meaningful changes to method behavior since then

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • introduced in jan 2025
  • package-private scope, intermal SDK usage only
  • no meaningful changes since its introduction

*
* @param resourceGroup the resource group of the deleted deployment, usually "default".
*/
@Beta

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • introduced in december 2024
  • no signature changes since then

*/
@Nonnull
@Beta
public ClientStreamingHandler<D, R, E> objectMapper(@Nonnull final ObjectMapper jackson) {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • no signature changes since aug 2025
  • apparently not supposed to be used by users directly, rather inside SDK

@vladimir-a-sap vladimir-a-sap left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

added clarifications on proposed changes

*/
@Slf4j
@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
@Beta

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • while the class itself seems to be stable enough, there are still multiple method-level @beta annotations where API still doesn't look stable enough

@vladimir-a-sap
vladimir-a-sap marked this pull request as ready for review September 17, 2026 13:00
@vladimir-a-sap vladimir-a-sap changed the title feat: WIP revisit beta annotations feat: revisit beta annotations Sep 17, 2026
@vladimir-a-sap vladimir-a-sap added the please-review Request to review a pull-request label Sep 18, 2026
vladimir-a-sap and others added 2 commits September 18, 2026 10:36
# Conflicts:
#	core-services/prompt-registry/src/main/java/com/sap/ai/sdk/prompt/registry/OrchestrationConfigMixin.java
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

please-review Request to review a pull-request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants