fix: Add actual messages to AI Core endpoints in sample app (#270)

* WiP (fixed Scenario and Config endpoints)

* Fixed Deployment endpoints

* Finishing touches

* Remove potential cross site vulnerability

* Formatting

* Minimal stuff to re-trigger CI -.-

* Make mapper static

* One more static mapper

* Use streams to build messages

* Reduce complexity by relying on Spring Boot serialization

* Remove unneeded dependency

* Improve readability

* Minor changes

---------

Co-authored-by: Jonas Israel <[email protected]>
Co-authored-by: SAP Cloud SDK Bot <[email protected]>

Author: Jonas-Isr

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

@@ -1,8 +1,12 @@
 package com.sap.ai.sdk.app.controllers;
 
 import com.sap.ai.sdk.core.client.ConfigurationApi;
-import com.sap.ai.sdk.core.model.AiConfigurationList;
+import com.sap.ai.sdk.core.model.AiConfiguration;
+import java.util.stream.Collectors;
+import javax.annotation.Nullable;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RestController;
 
 /** Endpoint for Configuration operations */
@@ -15,10 +19,20 @@ 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")
-  AiConfigurationList getConfigurations() {
-    return CLIENT.query("default");
+  ResponseEntity<Object> getConfigurations(
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+    final var configList = CLIENT.query("default");
+    if ("application/json".equals(accept)) {
+      return ResponseEntity.ok().body(configList);
+    }
+    final var items =
+        configList.getResources().stream()
+            .map(AiConfiguration::getName)
+            .collect(Collectors.joining(", "));
+    return ResponseEntity.ok("The following configurations are available: %s.".formatted(items));
   }
 }

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

@@ -1,5 +1,7 @@
 package com.sap.ai.sdk.app.controllers;
 
+import static com.sap.ai.sdk.core.model.AiDeploymentTargetStatus.STOPPED;
+
 import com.sap.ai.sdk.core.client.ConfigurationApi;
 import com.sap.ai.sdk.core.client.DeploymentApi;
 import com.sap.ai.sdk.core.model.AiConfigurationBaseData;
@@ -10,38 +12,38 @@
 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;
 import java.util.List;
+import java.util.stream.Collectors;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 /** Endpoints for AI Core AiDeployment operations */
 @Slf4j
 @RestController
+@SuppressWarnings("unused")
 @RequestMapping("/deployments")
 class DeploymentController {
 
   private static final DeploymentApi CLIENT = new DeploymentApi();
   private static final String RESOURCE_GROUP = "default";
 
   /**
-   * Create and delete a deployment with the Java specific configuration ID
+   * Create and delete a deployment with the Java specific configuration ID.
    *
    * @param configId The configuration id.
    * @return the deployment deletion response
    */
-  @GetMapping("/by-config/{id}/createDelete")
   @Nullable
-  AiDeploymentDeletionResponse createAndDeleteDeploymentByConfigId(
-      @Nonnull @PathVariable("id") final String configId) {
+  AiDeploymentDeletionResponse createAndDeleteDeploymentByConfigId(final String configId) {
     final var deployment =
         CLIENT.create(
             RESOURCE_GROUP, AiDeploymentCreationRequest.create().configurationId(configId));
@@ -52,62 +54,109 @@ AiDeploymentDeletionResponse createAndDeleteDeploymentByConfigId(
   }
 
   /**
-   * Stop all deployments with the Java specific configuration ID
+   * 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<Object> createAndDeleteDeploymentByConfigId(
+      @Nonnull @PathVariable("id") final String configId,
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+    final var response = createAndDeleteDeploymentByConfigId(configId);
+    if ("application/json".equals(accept)) {
+      return ResponseEntity.ok().body(response);
+    }
+    return ResponseEntity.ok("Deployment created and will be deleted.");
+  }
+
+  /**
+   * Stop all deployments with the Java specific configuration ID.
    *
    * <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
-  @SuppressWarnings("unused") // debug method that doesn't need to be tested
-  List<AiDeploymentModificationResponse> stopByConfigId(
-      @Nonnull @PathVariable("id") final String configId) {
+  ResponseEntity<Object> stopByConfigId(
+      @Nonnull @PathVariable("id") final String configId,
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
     final List<AiDeployment> myDeployments = getAllByConfigId(configId);
     log.info("Found {} deployments to STOP", myDeployments.size());
 
     // STOP my deployments
-    return myDeployments.stream()
-        .map(
-            deployment ->
-                CLIENT.modify(
-                    RESOURCE_GROUP,
-                    deployment.getId(),
-                    AiDeploymentModificationRequest.create()
-                        .targetStatus(AiDeploymentTargetStatus.STOPPED)))
-        .toList();
+    final var modificationRequest = AiDeploymentModificationRequest.create().targetStatus(STOPPED);
+    final var stoppedDeployments =
+        myDeployments.stream()
+            .map(AiDeployment::getId)
+            .map(id -> CLIENT.modify(RESOURCE_GROUP, id, modificationRequest))
+            .toList();
+
+    if ("application/json".equals(accept)) {
+      return ResponseEntity.ok().body(stoppedDeployments);
+    }
+    return ResponseEntity.ok("Deployments under the given config ID stopped.");
   }
 
   /**
-   * Delete all deployments with the Java specific configuration ID
+   * Delete all deployments with the Java specific configuration ID.
    *
    * <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
-  @SuppressWarnings("unused") // debug method that doesn't need to be tested
-  List<AiDeploymentDeletionResponse> deleteByConfigId(
-      @Nonnull @PathVariable("id") final String configId) {
+  ResponseEntity<Object> deleteByConfigId(
+      @Nonnull @PathVariable("id") final String configId,
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
     final List<AiDeployment> myDeployments = getAllByConfigId(configId);
     log.info("Found {} deployments to DELETE", myDeployments.size());
 
     // DELETE my deployments
-    return 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().body(responseList);
+    }
+    return ResponseEntity.ok("Deployments under the given config ID deleted.");
   }
 
   /**
-   * Get all deployments with the Java specific configuration ID
+   * 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<Object> getAllByConfigId(
+      @Nonnull @PathVariable("id") final String configId,
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+    final var deployments = getAllByConfigId(configId);
+    if ("application/json".equals(accept)) {
+      return ResponseEntity.ok().body(deployments);
+    }
+    final var items =
+        deployments.stream().map(AiDeployment::getId).collect(Collectors.joining(", "));
+    return ResponseEntity.ok(
+        "The following Java-specific deployments are available: %s.".formatted(items));
+  }
+
+  /**
+   * 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);
@@ -120,9 +169,31 @@ 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
+  ResponseEntity<Object> getAll(
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+    final var deployments = getAll();
+    if ("application/json".equals(accept)) {
+      return ResponseEntity.ok().body(deployments);
+    }
+    final var items =
+        deployments != null
+            ? deployments.getResources().stream()
+                .map(AiDeployment::getId)
+                .collect(Collectors.joining(", "))
+            : "";
+    return ResponseEntity.ok("The following deployments are available: %s.".formatted(items));
+  }
+
+  /**
+   * 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/OpenAiController.java

@@ -10,6 +10,7 @@
 import java.io.IOException;
 import java.util.Arrays;
 import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.MediaType;
@@ -26,7 +27,7 @@
 @SuppressWarnings("unused")
 public class OpenAiController {
   @Autowired private OpenAiService service;
-  private final ObjectMapper mapper =
+  private static final ObjectMapper MAPPER =
       new ObjectMapper().setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);
 
   /**
@@ -37,13 +38,11 @@ public class OpenAiController {
   @GetMapping("/chatCompletion")
   @Nonnull
   ResponseEntity<String> chatCompletion(
-      @RequestHeader(value = "accept", required = false) final String accept)
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept)
       throws JsonProcessingException {
     final var response = service.chatCompletion("Who is the prettiest");
     if ("application/json".equals(accept)) {
-      return ResponseEntity.ok()
-          .contentType(MediaType.APPLICATION_JSON)
-          .body(mapper.writeValueAsString(response));
+      return ResponseEntity.ok().body(MAPPER.writeValueAsString(response));
     }
     return ResponseEntity.ok(response.getContent());
   }
@@ -143,15 +142,13 @@ private static String objectToJson(@Nonnull final Object obj) {
   @GetMapping("/chatCompletionImage")
   @Nonnull
   ResponseEntity<String> chatCompletionImage(
-      @RequestHeader(value = "accept", required = false) final String accept)
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept)
       throws JsonProcessingException {
     final var response =
         service.chatCompletionImage(
             "https://upload.wikimedia.org/wikipedia/commons/thumb/5/59/SAP_2011_logo.svg/440px-SAP_2011_logo.svg.png");
     if ("application/json".equals(accept)) {
-      return ResponseEntity.ok()
-          .contentType(MediaType.APPLICATION_JSON)
-          .body(mapper.writeValueAsString(response));
+      return ResponseEntity.ok().body(MAPPER.writeValueAsString(response));
     }
     return ResponseEntity.ok(response.getContent());
   }
@@ -164,14 +161,12 @@ ResponseEntity<String> chatCompletionImage(
   @GetMapping("/chatCompletionTool")
   @Nonnull
   ResponseEntity<String> chatCompletionTools(
-      @RequestHeader(value = "accept", required = false) final String accept)
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept)
       throws JsonProcessingException {
     final var response =
         service.chatCompletionTools("Calculate the Fibonacci number for given sequence index.");
     if ("application/json".equals(accept)) {
-      return ResponseEntity.ok()
-          .contentType(MediaType.APPLICATION_JSON)
-          .body(mapper.writeValueAsString(response));
+      return ResponseEntity.ok().body(MAPPER.writeValueAsString(response));
     }
     return ResponseEntity.ok(response.getContent());
   }
@@ -185,9 +180,7 @@ ResponseEntity<String> chatCompletionTools(
   @Nonnull
   ResponseEntity<String> embedding() throws JsonProcessingException {
     final var response = service.embedding("Hello world");
-    return ResponseEntity.ok()
-        .contentType(MediaType.APPLICATION_JSON)
-        .body(mapper.writeValueAsString(response));
+    return ResponseEntity.ok().body(MAPPER.writeValueAsString(response));
   }
 
   /**
@@ -199,15 +192,13 @@ ResponseEntity<String> embedding() throws JsonProcessingException {
   @GetMapping("/chatCompletion/{resourceGroup}")
   @Nonnull
   ResponseEntity<String> chatCompletionWithResource(
-      @RequestHeader(value = "accept", required = false) final String accept,
+      @Nullable @RequestHeader(value = "accept", required = false) final String accept,
       @Nonnull @PathVariable("resourceGroup") final String resourceGroup)
       throws JsonProcessingException {
     final var response =
         service.chatCompletionWithResource(resourceGroup, "Where is the nearest coffee shop?");
     if ("application/json".equals(accept)) {
-      return ResponseEntity.ok()
-          .contentType(MediaType.APPLICATION_JSON)
-          .body(mapper.writeValueAsString(response));
+      return ResponseEntity.ok().body(MAPPER.writeValueAsString(response));
     }
     return ResponseEntity.ok(response.getContent());
   }