Merge branch 'main' into spec-update/document-grounding/main

Author: Jonas-Isr

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,4 +1,4 @@
-name: Bug Report
+name: Problem/Bug Report
 description: Released feature does not work as expected in the SAP Cloud SDK for AI (Java).
 labels:
   - bug
@@ -11,8 +11,8 @@ body:
         **Missing information may result in delayed response**
   - type: textarea
     attributes:
-      label: "Describe the Bug"
-      description: "A clear and concise description of what the bug is."
+      label: "Describe the Problem/Bug"
+      description: "A clear and concise description of what the problem/bug is."
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/question.yml

@@ -201,12 +201,12 @@ jobs:
         run: |
           PR_TITLE="Java: Add release notes for release ${{ needs.bump-version.outputs.release-version }}"
 
-          # if the minor version is a multiple of 15, then change the PR_BODY to "# ⚠️Update the `docs-java/release-notes/index.jsx` file⚠️"
+          # if the minor version is a multiple of 15, then change the PR_BODY to "# ⚠️Update the `docs-java/release-notes.mdx` file⚠️"
           # else the PR_BODY will be "Add the SAP Cloud SDK ${{ needs.bump-version.outputs.release-version }} release notes"
 
           minor_version=$(echo ${{ needs.bump-version.outputs.release-version }} | cut -d '.' -f 2)
           if [[ $((minor_version % 15)) -eq 0 ]]; then
-            PR_BODY="# ⚠️Update the \`docs-java/release-notes/index.jsx\` file⚠️"
+            PR_BODY="# ⚠️Update the \`docs-java/release-notes.mdx\` file⚠️"
           else
             PR_BODY="Add the SAP Cloud SDK ${{ needs.bump-version.outputs.release-version }} release notes"
           fi

.github/workflows/prepare-release.yaml

@@ -34,7 +34,7 @@ env:
 jobs:
   generate:
     name: "Download, Generate, Compile and Push"
-    runs-on: [ubuntu-latest]
+    runs-on: [ ubuntu-latest ]
     permissions:
       pull-requests: write
       contents: write
@@ -119,7 +119,11 @@ jobs:
         id: generate
         if: steps.spec_diff.outputs.spec_diff == 'true'
         run: |
-          mvn install -DskipTests -Dgenerate ${{ env.MVN_MULTI_THREADED_ARGS }}
+          if mvn install -DskipTests -Dgenerate ${{ env.MVN_MULTI_THREADED_ARGS }} ; then
+            echo "generation_result=success" >> "$GITHUB_OUTPUT"
+          else
+            echo "generation_result=failure" >> "$GITHUB_OUTPUT"
+          fi
 
       - name: "Compile and Test"
         id: compile
@@ -196,9 +200,15 @@ jobs:
           echo "| Spec File Changes | ${{ steps.spec_diff.outputs.spec_diff == 'true' && '🔄 Changes Detected' || '⏹️ No Changes' }}" >> $GITHUB_STEP_SUMMARY
           
           if ${{ steps.spec_diff.outputs.spec_diff == 'true' }}; then
-            echo "| Client Generation | ${{ steps.generate.outcome == 'success' && '✅' || '❌' }} ${{ steps.generate.outcome }}" >> $GITHUB_STEP_SUMMARY
+            echo "| Client Generation | ${{ steps.generate.outputs.generation_result == 'success' && '✅' || '❌' }} ${{ steps.generate.outputs.generation_result }}" >> $GITHUB_STEP_SUMMARY
             echo "| Client Compilation | ${{ steps.compile.outputs.compilation_result == 'success' && '✅' || '❌' }} ${{ steps.compile.outputs.compilation_result }}" >> $GITHUB_STEP_SUMMARY
             echo "| Client Testing | ${{ steps.compile.outputs.test_result == 'success' && '✅' || steps.compile.outputs.test_result == 'skipped' && '⏩' || '❌' }} ${{ steps.compile.outputs.test_result }}" >> $GITHUB_STEP_SUMMARY
             echo "| Branch Creation | ${{ steps.push.outcome == 'success' && '✅ [Branch Link]($DIFF_URL)' || '❌ failure' }}" >> $GITHUB_STEP_SUMMARY
             echo "| Pull Request Creation | ${{ env.CREATE_PR == 'false' && '⏩ skipped' || '' }}${{ env.CREATE_PR == 'true' && steps.push.outcome == 'success' && '✅ [PR Link]($PR_URL)' || '' }}" >> $GITHUB_STEP_SUMMARY
           fi
+
+      - name: "Fail if generation failed"
+        if: steps.generate.outputs.generation_result == 'failure'
+        run: |
+          echo "Client generation failed. Please check the Generate step logs for details."
+          exit 1

.github/workflows/spec-update.yaml

@@ -2,6 +2,7 @@
 ![CodeQL](https://github.com/SAP/ai-sdk-java/actions/workflows/github-code-scanning/codeql/badge.svg)
 [![REUSE status](https://api.reuse.software/badge/git.fsfe.org/reuse/api)](https://api.reuse.software/info/git.fsfe.org/reuse/api)
 [![Fosstars security rating](https://github.com/SAP/ai-sdk-java/actions/workflows/fosstars-report.yml/badge.svg?branch=main)](https://github.com/SAP/ai-sdk-java/blob/fosstars-report/fosstars_report.md)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/SAP/ai-sdk-java)
 
 # <img src="https://sap.github.io/cloud-sdk/img/logo.svg" alt="SAP Cloud SDK" width="30"/> SAP Cloud SDK for AI (for Java)
 

README.md

@@ -22,15 +22,6 @@
   @JsonSubTypes.Type(value = SDMPipelineCreateRequest.class, name = "SDM"),
   @JsonSubTypes.Type(value = SFTPPipelineCreateRequest.class, name = "SFTP"),
   @JsonSubTypes.Type(value = WorkZonePipelineCreateRequest.class, name = "WorkZone"),
-  @JsonSubTypes.Type(
-      value = MSSharePointPipelineCreateRequest.class,
-      name = "MSSharePointPipelineCreateRequest"),
-  @JsonSubTypes.Type(value = S3PipelineCreateRequest.class, name = "S3PipelineCreateRequest"),
-  @JsonSubTypes.Type(value = SDMPipelineCreateRequest.class, name = "SDMPipelineCreateRequest"),
-  @JsonSubTypes.Type(value = SFTPPipelineCreateRequest.class, name = "SFTPPipelineCreateRequest"),
-  @JsonSubTypes.Type(
-      value = WorkZonePipelineCreateRequest.class,
-      name = "WorkZonePipelineCreateRequest"),
 })
 public interface CreatePipeline {
   Object getType();

core-services/document-grounding/src/main/java/com/sap/ai/sdk/grounding/model/CreatePipeline.java

@@ -22,15 +22,6 @@
   @JsonSubTypes.Type(value = SDMPipelineGetResponse.class, name = "SDM"),
   @JsonSubTypes.Type(value = SFTPPipelineGetResponse.class, name = "SFTP"),
   @JsonSubTypes.Type(value = WorkZonePipelineGetResponse.class, name = "WorkZone"),
-  @JsonSubTypes.Type(
-      value = MSSharePointPipelineGetResponse.class,
-      name = "MSSharePointPipelineGetResponse"),
-  @JsonSubTypes.Type(value = S3PipelineGetResponse.class, name = "S3PipelineGetResponse"),
-  @JsonSubTypes.Type(value = SDMPipelineGetResponse.class, name = "SDMPipelineGetResponse"),
-  @JsonSubTypes.Type(value = SFTPPipelineGetResponse.class, name = "SFTPPipelineGetResponse"),
-  @JsonSubTypes.Type(
-      value = WorkZonePipelineGetResponse.class,
-      name = "WorkZonePipelineGetResponse"),
 })
 public interface GetPipeline {
   Object getType();

core-services/document-grounding/src/main/java/com/sap/ai/sdk/grounding/model/GetPipeline.java

@@ -22,17 +22,6 @@
   @JsonSubTypes.Type(value = SDMPipelineMinimalResponse.class, name = "SDM"),
   @JsonSubTypes.Type(value = SFTPPipelineMinimalResponse.class, name = "SFTP"),
   @JsonSubTypes.Type(value = WorkZonePipelineMinimalResponse.class, name = "WorkZone"),
-  @JsonSubTypes.Type(
-      value = MSSharePointPipelineMinimalResponse.class,
-      name = "MSSharePointPipelineMinimalResponse"),
-  @JsonSubTypes.Type(value = S3PipelineMinimalResponse.class, name = "S3PipelineMinimalResponse"),
-  @JsonSubTypes.Type(value = SDMPipelineMinimalResponse.class, name = "SDMPipelineMinimalResponse"),
-  @JsonSubTypes.Type(
-      value = SFTPPipelineMinimalResponse.class,
-      name = "SFTPPipelineMinimalResponse"),
-  @JsonSubTypes.Type(
-      value = WorkZonePipelineMinimalResponse.class,
-      name = "WorkZonePipelineMinimalResponse"),
 })
 public interface PipelineMinimalResponse {
   Object getType();

core-services/document-grounding/src/main/java/com/sap/ai/sdk/grounding/model/PipelineMinimalResponse.java

@@ -16,36 +16,38 @@
 
 /** ChatMessageContent */
 public interface ChatMessageContent {
-  /** Helper class to create a String that implements {@link ChatMessageContent}. */
-  record InnerString(@com.fasterxml.jackson.annotation.JsonValue @Nonnull String value)
+  /**
+   * Helper class to create {@code List<TextContent> } that implements {@link ChatMessageContent}.
+   */
+  record ListOfTextContents(
+      @com.fasterxml.jackson.annotation.JsonValue @Nonnull List<TextContent> values)
       implements ChatMessageContent {}
 
   /**
-   * Creator to enable deserialization of a String.
+   * Creator to enable deserialization of {@code List<TextContent> }.
    *
    * @param val the value to use
-   * @return a new instance of {@link InnerString}.
+   * @return a new instance of {@link ListOfTextContents}.
    */
   @com.fasterxml.jackson.annotation.JsonCreator
   @Nonnull
-  static InnerString create(@Nonnull final String val) {
-    return new InnerString(val);
+  static ListOfTextContents createListOfTextContents(@Nonnull final List<TextContent> val) {
+    return new ListOfTextContents(val);
   }
 
-  /** Helper class to create a list of TextContent that implements {@link ChatMessageContent}. */
-  record InnerTextContents(
-      @com.fasterxml.jackson.annotation.JsonValue @Nonnull List<TextContent> values)
+  /** Helper class to create {@code String } that implements {@link ChatMessageContent}. */
+  record InnerString(@com.fasterxml.jackson.annotation.JsonValue @Nonnull String value)
       implements ChatMessageContent {}
 
   /**
-   * Creator to enable deserialization of a list of TextContent.
+   * Creator to enable deserialization of {@code String }.
    *
    * @param val the value to use
-   * @return a new instance of {@link InnerTextContents}.
+   * @return a new instance of {@link InnerString}.
    */
   @com.fasterxml.jackson.annotation.JsonCreator
   @Nonnull
-  static InnerTextContents create(@Nonnull final List<TextContent> val) {
-    return new InnerTextContents(val);
+  static InnerString create(@Nonnull final String val) {
+    return new InnerString(val);
   }
 }

core-services/prompt-registry/src/main/java/com/sap/ai/sdk/prompt/registry/model/ChatMessageContent.java

@@ -16,40 +16,40 @@
 
 /** UserChatMessageContent */
 public interface UserChatMessageContent {
-  /** Helper class to create a String that implements {@link UserChatMessageContent}. */
-  record InnerString(@com.fasterxml.jackson.annotation.JsonValue @Nonnull String value)
+  /**
+   * Helper class to create {@code List<UserChatMessageContentItem> } that implements {@link
+   * UserChatMessageContent}.
+   */
+  record ListOfUserChatMessageContentItems(
+      @com.fasterxml.jackson.annotation.JsonValue @Nonnull List<UserChatMessageContentItem> values)
       implements UserChatMessageContent {}
 
   /**
-   * Creator to enable deserialization of a String.
+   * Creator to enable deserialization of {@code List<UserChatMessageContentItem> }.
    *
    * @param val the value to use
-   * @return a new instance of {@link InnerString}.
+   * @return a new instance of {@link ListOfUserChatMessageContentItems}.
    */
   @com.fasterxml.jackson.annotation.JsonCreator
   @Nonnull
-  static InnerString create(@Nonnull final String val) {
-    return new InnerString(val);
+  static ListOfUserChatMessageContentItems createListOfUserChatMessageContentItems(
+      @Nonnull final List<UserChatMessageContentItem> val) {
+    return new ListOfUserChatMessageContentItems(val);
   }
 
-  /**
-   * Helper class to create a list of UserChatMessageContentItem that implements {@link
-   * UserChatMessageContent}.
-   */
-  record InnerUserChatMessageContentItems(
-      @com.fasterxml.jackson.annotation.JsonValue @Nonnull List<UserChatMessageContentItem> values)
+  /** Helper class to create {@code String } that implements {@link UserChatMessageContent}. */
+  record InnerString(@com.fasterxml.jackson.annotation.JsonValue @Nonnull String value)
       implements UserChatMessageContent {}
 
   /**
-   * Creator to enable deserialization of a list of UserChatMessageContentItem.
+   * Creator to enable deserialization of {@code String }.
    *
    * @param val the value to use
-   * @return a new instance of {@link InnerUserChatMessageContentItems}.
+   * @return a new instance of {@link InnerString}.
    */
   @com.fasterxml.jackson.annotation.JsonCreator
   @Nonnull
-  static InnerUserChatMessageContentItems create(
-      @Nonnull final List<UserChatMessageContentItem> val) {
-    return new InnerUserChatMessageContentItems(val);
+  static InnerString create(@Nonnull final String val) {
+    return new InnerString(val);
   }
 }