chore: Fix checkstyle plugin (#408)

* add accessModifiers

* Fix exclusion/suppression of tests regarding prompt registry

* Fix new checkstyle violations

* Fix more checkstyle violations

* remove duplicate module block

---------

Co-authored-by: Jonas Israel <[email protected]>

Author: Jonas-Isr

.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

@@ -34,10 +34,6 @@
 			<property name="checkFirstSentence" value="false"/>
 			<property name="severity" value="info"/>
 		</module>
-		<module name="JavadocVariable">
-			<property name="accessModifiers" value="protected"/>
-			<property name="severity" value="info"/>
-		</module>
 		<module name="MissingJavadocMethod">
 			<property name="scope" value="protected"/>
 			<property name="severity" value="info"/>
@@ -47,7 +43,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 +52,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.
    */