Added JSON/Message form back

Author: CharlesDuboisSAP

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

@@ -1,15 +1,37 @@
 package com.sap.ai.sdk.app;
 
+import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
+import com.fasterxml.jackson.annotation.PropertyAccessor;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.sap.ai.sdk.orchestration.OrchestrationJacksonConfiguration;
+import javax.annotation.Nonnull;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.web.servlet.ServletComponentScan;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Primary;
 
 /** Main class to start the Spring Boot application. */
 @SpringBootApplication
 @ComponentScan({"com.sap.cloud.sdk", "com.sap.ai.sdk.app"})
 @ServletComponentScan({"com.sap.cloud.sdk", "com.sap.ai.sdk.app"})
 public class Application {
+
+  /**
+   * Temporary workaround to fix the issue with the Orchestration spec.
+   *
+   * @see OrchestrationJacksonConfiguration#getOrchestrationObjectMapper()
+   * @return a modified object mapper that works for Orchestration.
+   */
+  @Bean
+  @Primary
+  @SuppressWarnings("unused")
+  @Nonnull
+  public ObjectMapper objectMapper() {
+    return new ObjectMapper().setVisibility(PropertyAccessor.FIELD, Visibility.ANY);
+  }
+
   /**
    * Main method to start the Spring Boot application.
    *

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

@@ -14,7 +14,7 @@
 class ControllerExceptionHandler {
   /** Exceptions thrown by the Spring Boot controllers are turned into a readable text response. */
   @ExceptionHandler(Exception.class)
-  ResponseEntity<String> handleError(final Exception ex) {
+  Object handleError(final Exception ex) {
     final var headers = new HttpHeaders();
     headers.setContentType(MediaType.TEXT_PLAIN);
 

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

@@ -4,9 +4,8 @@
 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.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 /** Endpoint for Configuration operations */
@@ -16,23 +15,17 @@ class ConfigurationController {
 
   private static final ConfigurationApi CLIENT = new ConfigurationApi();
 
-  /**
-   * Get 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<Object> getConfigurations(
-      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+  Object getConfigurations(
+      @Nullable @RequestParam(value = "view", required = false) final String view) {
     final var configList = CLIENT.query("default");
-    if ("application/json".equals(accept)) {
-      return ResponseEntity.ok().body(configList);
+    if ("json".equals(view)) {
+      return configList;
     }
     final var items =
         configList.getResources().stream()
             .map(AiConfiguration::getName)
             .collect(Collectors.joining(", "));
-    return ResponseEntity.ok("The following configurations are available: %s.".formatted(items));
+    return "The following configurations are available: %s.".formatted(items);
   }
 }

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

@@ -22,8 +22,8 @@
 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.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 /** Endpoints for AI Core AiDeployment operations */
@@ -36,12 +36,7 @@ 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.
-   *
-   * @param configId The configuration id.
-   * @return the deployment deletion response
-   */
+  /** Create and delete a deployment with the Java specific configuration ID. */
   @Nullable
   AiDeploymentDeletionResponse createAndDeleteDeploymentByConfigId(final String configId) {
     final var deployment =
@@ -53,20 +48,14 @@ 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
-   */
+  /** Create and delete a deployment with the Java specific configuration ID. */
   @GetMapping("/by-config/{id}/createDelete")
-  ResponseEntity<Object> createAndDeleteDeploymentByConfigId(
+  Object createAndDeleteDeploymentByConfigId(
       @Nonnull @PathVariable("id") final String configId,
-      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+      @Nullable @RequestParam(value = "view", required = false) final String view) {
     final var response = createAndDeleteDeploymentByConfigId(configId);
-    if ("application/json".equals(accept)) {
-      return ResponseEntity.ok().body(response);
+    if ("json".equals(view)) {
+      return response;
     }
     return ResponseEntity.ok("Deployment created and will be deleted.");
   }
@@ -75,16 +64,11 @@ ResponseEntity<Object> createAndDeleteDeploymentByConfigId(
    * Stop all deployments with the Java specific configuration ID.
    *
    * <p>Only RUNNING deployments can be STOPPED
-   *
-   * @param configId The configuration id.
-   * @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<Object> stopByConfigId(
+  Object stopByConfigId(
       @Nonnull @PathVariable("id") final String configId,
-      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+      @Nullable @RequestParam(value = "view", required = false) final String view) {
     final List<AiDeployment> myDeployments = getAllByConfigId(configId);
     log.info("Found {} deployments to STOP", myDeployments.size());
 
@@ -96,26 +80,21 @@ ResponseEntity<Object> stopByConfigId(
             .map(id -> CLIENT.modify(RESOURCE_GROUP, id, modificationRequest))
             .toList();
 
-    if ("application/json".equals(accept)) {
-      return ResponseEntity.ok().body(stoppedDeployments);
+    if ("json".equals(view)) {
+      return stoppedDeployments;
     }
-    return ResponseEntity.ok("Deployments under the given config ID stopped.");
+    return "Deployments under the given config ID stopped.";
   }
 
   /**
    * Delete all deployments with the Java specific configuration ID.
    *
    * <p>Only UNKNOWN and STOPPED deployments can be DELETED
-   *
-   * @param configId The configuration id.
-   * @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<Object> deleteByConfigId(
+  Object deleteByConfigId(
       @Nonnull @PathVariable("id") final String configId,
-      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+      @Nullable @RequestParam(value = "view", required = false) final String view) {
     final List<AiDeployment> myDeployments = getAllByConfigId(configId);
     log.info("Found {} deployments to DELETE", myDeployments.size());
 
@@ -124,40 +103,27 @@ ResponseEntity<Object> deleteByConfigId(
         myDeployments.stream()
             .map(deployment -> CLIENT.delete(RESOURCE_GROUP, deployment.getId()))
             .toList();
-    if ("application/json".equals(accept)) {
-      return ResponseEntity.ok().body(responseList);
+    if ("json".equals(view)) {
+      return responseList;
     }
-    return ResponseEntity.ok("Deployments under the given config ID deleted.");
+    return "Deployments under the given config ID deleted.";
   }
 
-  /**
-   * Get all deployments 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 Java specific deployments
-   */
+  /** Get all deployments with the Java specific configuration ID. */
   @GetMapping("/by-config/{id}/getAll")
-  ResponseEntity<Object> getAllByConfigId(
+  Object getAllByConfigId(
       @Nonnull @PathVariable("id") final String configId,
-      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+      @Nullable @RequestParam(value = "view", required = false) final String view) {
     final var deployments = getAllByConfigId(configId);
-    if ("application/json".equals(accept)) {
-      return ResponseEntity.ok().body(deployments);
+    if ("json".equals(view)) {
+      return 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));
+    return "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
+  /** Get all deployments with the Java specific configuration ID. */
   List<AiDeployment> getAllByConfigId(@Nonnull @PathVariable("id") final String configId) {
     final AiDeploymentList deploymentList = CLIENT.query(RESOURCE_GROUP);
 
@@ -166,34 +132,23 @@ List<AiDeployment> getAllByConfigId(@Nonnull @PathVariable("id") final String co
         .toList();
   }
 
-  /**
-   * Get all deployments, including non-Java specific deployments
-   *
-   * @param accept The accept header.
-   * @return a response entity with a string representation of the Java specific deployments
-   */
+  /** Get all deployments, including non-Java specific deployments */
   @GetMapping("/getAll")
-  @Nonnull
-  ResponseEntity<Object> getAll(
-      @Nullable @RequestHeader(value = "accept", required = false) final String accept) {
+  Object getAll(@Nullable @RequestParam(value = "view", required = false) final String view) {
     final var deployments = getAll();
-    if ("application/json".equals(accept)) {
-      return ResponseEntity.ok().body(deployments);
+    if ("json".equals(view)) {
+      return 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));
+    return "The following deployments are available: %s.".formatted(items);
   }
 
-  /**
-   * Get all deployments
-   *
-   * @return all deployments
-   */
+  /** Get all deployments */
   @Nullable
   AiDeploymentList getAll() {
     return CLIENT.query(RESOURCE_GROUP);
@@ -203,9 +158,6 @@ AiDeploymentList getAll() {
    * Create a configuration, and deploy it.
    *
    * <p>This is to be invoked from a unit test.
-   *
-   * @param model The OpenAI model to deploy
-   * @return the deployment creation response
    */
   @Nonnull
   @SuppressWarnings("unused") // debug method that doesn't need to be tested