chore: Fix checkstyle plugin

.pipeline/checkstyle-suppressions.xml

@@ -10,10 +10,12 @@
   <suppress files="[/\\]core[/\\]model[/\\]" checks=".*"/>
   <suppress files="[/\\]openai[/\\]generated[/\\]model[/\\]" checks=".*"/>
   <suppress files="[/\\]orchestration[/\\]model[/\\]" checks=".*"/>
-  <suppress files="[/\\]grounding[/\\]api[/\\]" checks=".*"/>
+  <suppress files="[/\\]grounding[/\\]client[/\\]" checks=".*"/>
   <suppress files="[/\\]grounding[/\\]model[/\\]" checks=".*"/>
+  <suppress files="[/\\]registry[/\\]client[/\\]" checks=".*"/>
+  <suppress files="[/\\]registry[/\\]model[/\\]" checks=".*"/>
   <!-- Suppress TODOs -->
-  <suppress files="OpenAiChatMessage.java" checks="TodoComment" lines="257,7" />
+  <suppress files="OpenAiChatMessage.java" checks="TodoComment" lines="261,7" />
   <suppress files="ChatCompletionResponseMessage.java" checks="TodoComment" lines="53,34" />
   <suppress files="CreateChatCompletionRequest.java" checks="TodoComment" lines="73,47" />
 </suppressions>

.pipeline/checkstyle.xml

@@ -35,7 +35,7 @@
 			<property name="severity" value="info"/>
 		</module>
 		<module name="JavadocVariable">
-			<property name="accessModifiers" value="protected"/>
+			<property name="accessModifiers" value="protected, public"/>
 			<property name="severity" value="info"/>
 		</module>
 		<module name="MissingJavadocMethod">
@@ -47,7 +47,7 @@
 			<property name="severity" value="info"/>
 		</module>
 		<module name="JavadocMethod">
-			<property name="accessModifiers" value="protected"/>
+			<property name="accessModifiers" value="protected, public"/>
 			<property name="allowedAnnotations" value="Override"/>
 			<property name="severity" value="info"/>
 		</module>
@@ -56,7 +56,7 @@
 			<property name="severity" value="info"/>
 		</module>
 		<module name="JavadocVariable">
-			<property name="accessModifiers" value="protected"/>
+			<property name="accessModifiers" value="protected, public"/>
 			<property name="severity" value="info"/>
 		</module>
 		<module name="IllegalCatch">

.pipeline/spotbugs-exclusions.xml

@@ -7,6 +7,8 @@
       <Package name="com.sap.ai.sdk.orchestration.model"/>
       <Package name="com.sap.ai.sdk.grounding.client"/>
       <Package name="com.sap.ai.sdk.grounding.model"/>
+      <Package name="com.sap.ai.sdk.prompt.registry.model"/>
+      <Package name="com.sap.ai.sdk.prompt.registry.client"/>
     </Or>
   </Match>
   <Match>

core/src/main/java/com/sap/ai/sdk/core/common/ClientResponseHandler.java

@@ -44,6 +44,7 @@ public class ClientResponseHandler<T, E extends ClientException>
    * Set the {@link ObjectMapper} to use for parsing JSON responses.
    *
    * @param jackson The {@link ObjectMapper} to use
+   * @return the current instance of {@link ClientResponseHandler} with the changed object mapper
    */
   @Beta
   @Nonnull

core/src/main/java/com/sap/ai/sdk/core/common/ClientStreamingHandler.java

@@ -25,6 +25,7 @@ public class ClientStreamingHandler<D extends StreamedDelta, E extends ClientExc
    * Set the {@link ObjectMapper} to use for parsing JSON responses.
    *
    * @param jackson The {@link ObjectMapper} to use
+   * @return the current instance of {@link ClientStreamingHandler} with the changed object mapper
    */
   @Nonnull
   public ClientStreamingHandler<D, E> objectMapper(@Nonnull final ObjectMapper jackson) {

core/src/main/java/com/sap/ai/sdk/core/common/StreamedDelta.java

@@ -37,6 +37,8 @@ public interface StreamedDelta {
    * <p>{@code content_filter}: Omitted content due to a flag from our content filters
    *
    * <p>{@code null}: API response still in progress or incomplete
+   *
+   * @return the finish reason or null.
    */
   @Nullable
   String getFinishReason();

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/OpenAiClient.java

@@ -97,6 +97,7 @@ public OpenAiClient withApiVersion(@Nonnull final String apiVersion) {
    *
    * @param destination The specific {@link HttpDestination} to use.
    * @see AiCoreService#getInferenceDestination(String)
+   * @return a new OpenAI client.
    */
   @Beta
   @Nonnull

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/model/OpenAiChatMessage.java

@@ -146,7 +146,11 @@ public OpenAiChatUserMessage addContent(@Nonnull final ContentPart... content) {
       @Type(value = ContentPartImage.class, name = "image_url")
     })
     public interface ContentPart {
-      /** Get the type of the content part. */
+      /**
+       * Get the type of the content part.
+       *
+       * @return The type of the content part as string.
+       */
       @Nonnull
       String getType();
     }

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClient.java

@@ -102,7 +102,8 @@ public OrchestrationChatResponse chatCompletion(
    * Generate a completion for the given prompt.
    *
    * @param prompt a text message.
-   * @return A stream of message deltas
+   * @param config the configuration to use
+   * @return a stream of message deltas
    * @throws OrchestrationClientException if the request fails or if the finish reason is
    *     content_filter
    * @since 1.1.0

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationModuleConfig.java

@@ -140,7 +140,8 @@ public OrchestrationModuleConfig withMaskingConfig(
    * @link <a
    *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
    *     AI Core: Orchestration - Input Filtering</a>
-   * @param contentFilters one or more content filters to apply to the input.
+   * @param contentFilter a filter to apply to the input.
+   * @param contentFilters zero or more additional content filters to apply to the input.
    * @return a new {@code OrchestrationModuleConfig} instance with the specified input filters
    *     added.
    */
@@ -174,7 +175,8 @@ public OrchestrationModuleConfig withInputFiltering(
    * @link <a
    *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
    *     AI Core: Orchestration - Output Filtering</a>
-   * @param contentFilters one or more content filters to apply to the output.
+   * @param contentFilter a filter to apply to the input.
+   * @param contentFilters zero or more additional content filters to apply to the input.
    * @return a new {@code OrchestrationModuleConfig} instance with the specified output filters
    *     added.
    */

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationPrompt.java

@@ -49,6 +49,7 @@ public OrchestrationPrompt(@Nonnull final Message message, @Nonnull final Messag
    * Initialize a prompt based on template variables.
    *
    * @param inputParams The input parameters as entries of template variables and their contents.
+   * @param messages The messages to be sent to the orchestration service.
    */
   public OrchestrationPrompt(
       @Nonnull final Map<String, String> inputParams, @Nonnull final Message... messages) {
@@ -60,6 +61,7 @@ public OrchestrationPrompt(
    * Set the chat history of this prompt.
    *
    * @param messagesHistory The chat history to add.
+   * @return The current instance of {@link OrchestrationPrompt} with the changed chat history.
    */
   @Nonnull
   public OrchestrationPrompt messageHistory(@Nonnull final List<Message> messagesHistory) {

orchestration/src/main/java/com/sap/ai/sdk/orchestration/spring/OrchestrationChatModel.java

@@ -55,6 +55,7 @@ public OrchestrationChatModel() {
   /**
    * Constructor with a custom client.
    *
+   * @param client The custom client to use.
    * @since 1.2.0
    */
   public OrchestrationChatModel(@Nonnull final OrchestrationClient client) {

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/OpenAiService.java

@@ -49,6 +49,7 @@ public OpenAiChatCompletionOutput chatCompletion(@Nonnull final String prompt) {
   /**
    * Asynchronous stream of an OpenAI chat request
    *
+   * @param message The message to send to the assistant
    * @return the emitter that streams the assistant message response
    */
   @Nonnull
@@ -64,6 +65,7 @@ public Stream<OpenAiChatCompletionDelta> streamChatCompletionDeltas(
   /**
    * Asynchronous stream of an OpenAI chat request
    *
+   * @param message The message to send to the assistant
    * @return the emitter that streams the assistant message response
    */
   @Nonnull

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/OpenAiServiceV2.java

@@ -53,6 +53,7 @@ public OpenAiChatCompletionResponse chatCompletion(@Nonnull final String prompt)
   /**
    * Asynchronous stream of an OpenAI chat request
    *
+   * @param message The message to send to the assistant
    * @return the emitter that streams the assistant message response
    */
   @Nonnull
@@ -66,6 +67,7 @@ public Stream<OpenAiChatCompletionDelta> streamChatCompletionDeltas(
   /**
    * Asynchronous stream of an OpenAI chat request
    *
+   * @param message The message to send to the assistant
    * @return the emitter that streams the assistant message response
    */
   @Nonnull

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/OrchestrationService.java

@@ -51,6 +51,7 @@ public class OrchestrationService {
   /**
    * Chat request to OpenAI through the Orchestration service with a simple prompt.
    *
+   * @param famousPhrase the phrase to send to the assistant
    * @return the assistant response object
    */
   @Nonnull
@@ -62,6 +63,7 @@ public OrchestrationChatResponse completion(@Nonnull final String famousPhrase)
   /**
    * Chat request to OpenAI through the Orchestration service with an image.
    *
+   * @param pathToImage the path to the image
    * @return the assistant response object
    */
   @Nonnull
@@ -78,6 +80,7 @@ public OrchestrationChatResponse imageInput(@Nonnull final String pathToImage) {
   /**
    * Chat request to OpenAI through the Orchestration service with multiple strings.
    *
+   * @param questions the list of questions to send to the assistant
    * @return the assistant response object
    */
   @Nonnull
@@ -91,6 +94,7 @@ public OrchestrationChatResponse multiStringInput(@Nonnull final List<String> qu
   /**
    * Asynchronous stream of an OpenAI chat request
    *
+   * @param topic the topic to send to the assistant
    * @return a stream of assistant message responses
    */
   @Nonnull
@@ -106,6 +110,7 @@ public Stream<String> streamChatCompletion(@Nonnull final String topic) {
    *
    * @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP
    *     AI Core: Orchestration - Templating</a>
+   * @param language the language to use in the template
    * @return the assistant response object
    */
   @Nonnull
@@ -124,6 +129,7 @@ public OrchestrationChatResponse template(@Nonnull final String language) {
   /**
    * Chat request to OpenAI through the Orchestration service using message history.
    *
+   * @param prevMessage the previous message to send to the assistant
    * @return the assistant response object
    */
   @Nonnull
@@ -237,6 +243,7 @@ public OrchestrationChatResponse llamaGuardInputFilter(final boolean filter)
    * @link <a
    *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP AI
    *     Core: Orchestration - Data Masking</a>
+   * @param entity the entity to be masked
    * @return the assistant response object
    */
   @Nonnull
@@ -261,6 +268,8 @@ public OrchestrationChatResponse maskingAnonymization(@Nonnull final DPIEntities
   /**
    * Chat request to OpenAI through the Orchestration deployment under a specific resource group.
    *
+   * @param resourceGroup the resource group to use
+   * @param famousPhrase the phrase to send to the assistant
    * @return the assistant response object
    */
   @Nonnull
@@ -282,6 +291,7 @@ public OrchestrationChatResponse completionWithResourceGroup(
    * @link <a
    *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP AI
    *     Core: Orchestration - Data Masking</a>
+   * @param entity the entity to be pseudonymized
    * @return the assistant response object
    */
   @Nonnull
@@ -375,6 +385,7 @@ public OrchestrationChatResponse groundingHelpSapCom(@Nonnull final String userM
    * @link <a
    *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/structured-output">SAP
    *     AI Core: Orchestration - Structured Output</a>
+   * @param word the word to translate
    * @return the assistant response object
    */
   @Nonnull
@@ -410,6 +421,7 @@ class Translation {
    * @link <a
    *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/structured-output">SAP
    *     AI Core: Orchestration - Structured Output</a>
+   * @param word the word to translate
    * @return the assistant response object
    */
   @Nonnull
@@ -436,6 +448,7 @@ public OrchestrationChatResponse responseFormatJsonObject(@Nonnull final String
    * @link <a
    *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/structured-output">SAP
    *     AI Core: Orchestration - Structured Output</a>
+   * @param word the word to translate
    * @return the assistant response object
    */
   @Nonnull
@@ -460,6 +473,7 @@ public OrchestrationChatResponse responseFormatText(@Nonnull final String word)
    *
    * @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP
    *     AI Core: Orchestration - Templating</a>
+   * @param topic the topic to send to the assistant
    * @return the assistant response object
    */
   @Nonnull
@@ -482,6 +496,7 @@ public OrchestrationChatResponse templateFromPromptRegistryById(@Nonnull final S
    *
    * @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP
    *     AI Core: Orchestration - Templating</a>
+   * @param topic the topic to send to the assistant
    * @return the assistant response object
    */
   @Nonnull

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/SpringAiOrchestrationService.java

@@ -99,6 +99,7 @@ public ChatResponse masking() {
    * href="https://docs.spring.io/spring-ai/reference/api/tools.html#_methods_as_tools">Spring AI
    * Tool Method Declarative Specification</a>
    *
+   * @param internalToolExecutionEnabled whether the internal tool execution is enabled
    * @return the assistant response object
    */
   @Nonnull