Finishing touches

Author: Jonas-Isr

sample-code/spring-app/pom.xml

@@ -112,6 +112,10 @@
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-databind</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.datatype</groupId>
+      <artifactId>jackson-datatype-jsr310</artifactId>
+    </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-core</artifactId>

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/ConfigurationController.java

@@ -28,13 +28,14 @@ class ConfigurationController {
   /**
    * Get the list of configurations.
    *
-   * @return the list of configurations
+   * @param accept the accept header
+   * @return a response entity with a string representation of the list of configurations
    */
   @GetMapping("/configurations")
   ResponseEntity<String> getConfigurations(
       @RequestHeader(value = "accept", required = false) final String accept)
       throws JsonProcessingException {
-    var configList = CLIENT.query("default");
+    final var configList = CLIENT.query("default");
     if ("application/json".equals(accept)) {
       return ResponseEntity.ok()
           .contentType(MediaType.APPLICATION_JSON)
@@ -43,9 +44,15 @@ ResponseEntity<String> getConfigurations(
     return ResponseEntity.ok(buildMessage(configList));
   }
 
-  String buildMessage(AiConfigurationList configList) {
-    var message = new StringBuilder("The following configurations are available: ");
-    for (var resource : configList.getResources()) {
+  /**
+   * Build a message from the configuration list.
+   *
+   * @param configList The configuration list.
+   * @return the message
+   */
+  private String buildMessage(final AiConfigurationList configList) {
+    final var message = new StringBuilder("The following configurations are available: ");
+    for (final var resource : configList.getResources()) {
       message.append(resource.getName()).append(", ");
     }
     message.setCharAt(message.length() - 2, '.');

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/DeploymentController.java

@@ -15,7 +15,6 @@
 import com.sap.ai.sdk.core.model.AiDeploymentDeletionResponse;
 import com.sap.ai.sdk.core.model.AiDeploymentList;
 import com.sap.ai.sdk.core.model.AiDeploymentModificationRequest;
-import com.sap.ai.sdk.core.model.AiDeploymentModificationResponse;
 import com.sap.ai.sdk.core.model.AiDeploymentTargetStatus;
 import com.sap.ai.sdk.core.model.AiParameterArgumentBinding;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiModel;
@@ -41,7 +40,8 @@ class DeploymentController {
   private static final DeploymentApi CLIENT = new DeploymentApi();
   private static final String RESOURCE_GROUP = "default";
   private final ObjectMapper mapper =
-      new ObjectMapper().setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY)
+      new ObjectMapper()
+          .setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY)
           .registerModule(new JavaTimeModule());
 
   /**
@@ -61,6 +61,13 @@ AiDeploymentDeletionResponse createAndDeleteDeploymentByConfigId(final String co
     return CLIENT.delete(RESOURCE_GROUP, deployment.getId());
   }
 
+  /**
+   * Create and delete a deployment with the Java specific configuration ID
+   *
+   * @param configId The configuration id.
+   * @param accept The accept header.
+   * @return a response entity with a string representation of the deployment creation response
+   */
   @GetMapping("/by-config/{id}/createDelete")
   ResponseEntity<String> createAndDeleteDeploymentByConfigId(
       @Nonnull @PathVariable("id") final String configId,
@@ -72,7 +79,8 @@ ResponseEntity<String> createAndDeleteDeploymentByConfigId(
           .contentType(MediaType.APPLICATION_JSON)
           .body(mapper.writeValueAsString(response));
     }
-    return ResponseEntity.ok("Deployment under config with id " + configId + " created and deleted.");
+    return ResponseEntity.ok(
+        "Deployment under config with id " + configId + " created and deleted.");
   }
 
   /**
@@ -81,26 +89,29 @@ ResponseEntity<String> createAndDeleteDeploymentByConfigId(
    * <p>Only RUNNING deployments can be STOPPED
    *
    * @param configId The configuration id.
-   * @return the deployment modification response
+   * @param accept The accept header.
+   * @return a response entity with a string representation of the deployment modification response
    */
   @GetMapping("/by-config/{id}/stop")
   @Nonnull
   ResponseEntity<String> stopByConfigId(
       @Nonnull @PathVariable("id") final String configId,
-      @RequestHeader(value = "accept", required = false) final String accept) throws JsonProcessingException {
+      @RequestHeader(value = "accept", required = false) final String accept)
+      throws JsonProcessingException {
     final List<AiDeployment> myDeployments = getAllByConfigId(configId);
     log.info("Found {} deployments to STOP", myDeployments.size());
 
     // STOP my deployments
-    var stoppedDeployments = myDeployments.stream()
-        .map(
-            deployment ->
-                CLIENT.modify(
-                    RESOURCE_GROUP,
-                    deployment.getId(),
-                    AiDeploymentModificationRequest.create()
-                        .targetStatus(AiDeploymentTargetStatus.STOPPED)))
-        .toList();
+    final var stoppedDeployments =
+        myDeployments.stream()
+            .map(
+                deployment ->
+                    CLIENT.modify(
+                        RESOURCE_GROUP,
+                        deployment.getId(),
+                        AiDeploymentModificationRequest.create()
+                            .targetStatus(AiDeploymentTargetStatus.STOPPED)))
+            .toList();
 
     if ("application/json".equals(accept)) {
       return ResponseEntity.ok()
@@ -116,19 +127,23 @@ ResponseEntity<String> stopByConfigId(
    * <p>Only UNKNOWN and STOPPED deployments can be DELETED
    *
    * @param configId The configuration id.
-   * @return the deployment deletion response
+   * @param accept The accept header.
+   * @return a response entity with a string representation of the deployment deletion response
    */
   @GetMapping("/by-config/{id}/delete")
   @Nonnull
   ResponseEntity<String> deleteByConfigId(
-      @Nonnull @PathVariable("id") final String configId, @RequestHeader(value = "accept", required = false) final String accept) throws JsonProcessingException {
+      @Nonnull @PathVariable("id") final String configId,
+      @RequestHeader(value = "accept", required = false) final String accept)
+      throws JsonProcessingException {
     final List<AiDeployment> myDeployments = getAllByConfigId(configId);
     log.info("Found {} deployments to DELETE", myDeployments.size());
 
     // DELETE my deployments
-    var responseList = myDeployments.stream()
-        .map(deployment -> CLIENT.delete(RESOURCE_GROUP, deployment.getId()))
-        .toList();
+    final var responseList =
+        myDeployments.stream()
+            .map(deployment -> CLIENT.delete(RESOURCE_GROUP, deployment.getId()))
+            .toList();
     if ("application/json".equals(accept)) {
       return ResponseEntity.ok()
           .contentType(MediaType.APPLICATION_JSON)
@@ -141,7 +156,8 @@ ResponseEntity<String> deleteByConfigId(
    * Get all deployments with the Java specific configuration ID
    *
    * @param configId The configuration id.
-   * @return the Java specific deployments
+   * @param accept The accept header.
+   * @return a response entity with a string representation of the Java specific deployments
    */
   @GetMapping("/by-config/{id}/getAll")
   ResponseEntity<String> getAllByConfigId(
@@ -157,16 +173,27 @@ ResponseEntity<String> getAllByConfigId(
     return ResponseEntity.ok(buildMessage(deployments));
   }
 
-  private String buildMessage(List<AiDeployment> deployments) {
-    var message = new StringBuilder("The following deployments are available: ");
-    for (var deployment : deployments) {
+  /**
+   * Build a message from the deployment list.
+   *
+   * @param deployments The deployment list.
+   * @return the message
+   */
+  private String buildMessage(final List<AiDeployment> deployments) {
+    final var message = new StringBuilder("The following deployments are available: ");
+    for (final var deployment : deployments) {
       message.append(deployment.getId()).append(", ");
     }
     message.setCharAt(message.length() - 2, '.');
     return message.toString();
   }
 
-
+  /**
+   * Get all deployments with the Java specific configuration ID
+   *
+   * @param configId The configuration id.
+   * @return the Java specific deployments
+   */
   @Nonnull
   List<AiDeployment> getAllByConfigId(@Nonnull @PathVariable("id") final String configId) {
     final AiDeploymentList deploymentList = CLIENT.query(RESOURCE_GROUP);
@@ -179,7 +206,8 @@ List<AiDeployment> getAllByConfigId(@Nonnull @PathVariable("id") final String co
   /**
    * Get all deployments, including non-Java specific deployments
    *
-   * @return the Java specific deployments
+   * @param accept The accept header.
+   * @return a response entity with a string representation of the Java specific deployments
    */
   @GetMapping("/getAll")
   @Nonnull
@@ -195,6 +223,11 @@ ResponseEntity<String> getAll(
     return ResponseEntity.ok(buildMessage(deployments.getResources().stream().toList()));
   }
 
+  /**
+   * Get all deployments
+   *
+   * @return all deployments
+   */
   @Nullable
   AiDeploymentList getAll() {
     return CLIENT.query(RESOURCE_GROUP);

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/ScenarioController.java

@@ -9,7 +9,6 @@
 import com.sap.ai.sdk.core.model.AiModelList;
 import com.sap.ai.sdk.core.model.AiScenarioList;
 import javax.annotation.Nonnull;
-
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -21,8 +20,6 @@
 @SuppressWarnings("unused") // debug method that doesn't need to be tested
 class ScenarioController {
 
-//  TODO: Fix javadocs
-
   private static final ScenarioApi CLIENT = new ScenarioApi();
   private final ObjectMapper mapper =
       new ObjectMapper()
@@ -32,14 +29,15 @@ class ScenarioController {
   /**
    * Get the list of available scenarios
    *
-   * @return the list of available scenarios
+   * @param accept the accept header
+   * @return a response entity with a string representation of the list of available scenarios
    */
   @GetMapping("/scenarios")
   @Nonnull
   ResponseEntity<String> getScenarios(
       @RequestHeader(value = "accept", required = false) final String accept)
       throws JsonProcessingException {
-    var scenarioList = CLIENT.query("default");
+    final var scenarioList = CLIENT.query("default");
     if ("application/json".equals(accept)) {
       return ResponseEntity.ok()
           .contentType(MediaType.APPLICATION_JSON)
@@ -48,6 +46,11 @@ ResponseEntity<String> getScenarios(
     return ResponseEntity.ok(buildScenarioMessage(scenarioList));
   }
 
+  /**
+   * Get the list of available models
+   *
+   * @return the list of available models
+   */
   @Nonnull
   AiModelList getModels() {
     return CLIENT.queryModels("foundation-models", "default");
@@ -56,14 +59,15 @@ AiModelList getModels() {
   /**
    * Get the list of available models
    *
-   * @return the list of available models
+   * @param accept the accept header
+   * @return a response entity with a string representation of the list of available models
    */
   @GetMapping("/models")
   @Nonnull
   ResponseEntity<String> getModels(
       @RequestHeader(value = "accept", required = false) final String accept)
       throws JsonProcessingException {
-    var modelList = getModels();
+    final var modelList = getModels();
     if ("application/json".equals(accept)) {
       return ResponseEntity.ok()
           .contentType(MediaType.APPLICATION_JSON)
@@ -72,18 +76,30 @@ ResponseEntity<String> getModels(
     return ResponseEntity.ok(buildModelMessage(modelList));
   }
 
-  String buildScenarioMessage(AiScenarioList scenarioList) {
-    var message = new StringBuilder("The following scenarios are available: ");
-    for (var resource : scenarioList.getResources()) {
+  /**
+   * Build a message from the scenario list
+   *
+   * @param scenarioList the list of scenarios
+   * @return a string representation of the list of scenarios
+   */
+  private String buildScenarioMessage(final AiScenarioList scenarioList) {
+    final var message = new StringBuilder("The following scenarios are available: ");
+    for (final var resource : scenarioList.getResources()) {
       message.append(resource.getName()).append(", ");
     }
     message.setCharAt(message.length() - 2, '.');
     return message.toString();
   }
 
-  String buildModelMessage(AiModelList modelList) {
-    var message = new StringBuilder("The following models are available: ");
-    for (var resource : modelList.getResources()) {
+  /**
+   * Build a message from the model list
+   *
+   * @param modelList the list of models
+   * @return a string representation of the list of models
+   */
+  private String buildModelMessage(final AiModelList modelList) {
+    final var message = new StringBuilder("The following models are available: ");
+    for (final var resource : modelList.getResources()) {
       message.append(resource.getModel()).append(", ");
     }
     message.setCharAt(message.length() - 2, '.');