chore(configs): Do not return bare strings. (#115)

kayenta-core/src/main/java/com/netflix/kayenta/canary/CanaryConfigUpdateResponse.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2017 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License")
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.netflix.kayenta.canary;
+
+import lombok.Builder;
+import lombok.Data;
+
+import javax.validation.constraints.NotNull;
+
+@Data
+@Builder
+public class CanaryConfigUpdateResponse {
+
+  @NotNull
+  protected String canaryConfigId;
+}

kayenta-web/src/main/java/com/netflix/kayenta/controllers/CanaryConfigController.java

@@ -17,6 +17,7 @@
 package com.netflix.kayenta.controllers;
 
 import com.netflix.kayenta.canary.CanaryConfig;
+import com.netflix.kayenta.canary.CanaryConfigUpdateResponse;
 import com.netflix.kayenta.security.AccountCredentials;
 import com.netflix.kayenta.security.AccountCredentialsRepository;
 import com.netflix.kayenta.security.CredentialsHelper;
@@ -38,6 +39,7 @@
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 import java.time.Instant;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
@@ -73,8 +75,8 @@ public CanaryConfig loadCanaryConfig(@RequestParam(required = false) final Strin
 
   @ApiOperation(value = "Write a canary config to object storage")
   @RequestMapping(consumes = "application/json", method = RequestMethod.POST)
-  public String storeCanaryConfig(@RequestParam(required = false) final String configurationAccountName,
-                                  @RequestBody CanaryConfig canaryConfig) throws IOException {
+  public CanaryConfigUpdateResponse storeCanaryConfig(@RequestParam(required = false) final String configurationAccountName,
+                                                      @RequestBody CanaryConfig canaryConfig) throws IOException {
     String resolvedConfigurationAccountName = CredentialsHelper.resolveAccountByNameOrType(configurationAccountName,
                                                                                            AccountCredentials.Type.CONFIGURATION_STORE,
                                                                                            accountCredentialsRepository);
@@ -119,17 +121,17 @@ public String storeCanaryConfig(@RequestParam(required = false) final String con
     } catch (IllegalArgumentException e) {
       configurationService.storeObject(resolvedConfigurationAccountName, ObjectType.CANARY_CONFIG, canaryConfigId, canaryConfig, canaryConfig.getName() + ".json", false);
 
-      return canaryConfigId;
+      return CanaryConfigUpdateResponse.builder().canaryConfigId(canaryConfigId).build();
     }
 
     throw new IllegalArgumentException("Canary config '" + canaryConfigId + "' already exists.");
   }
 
   @ApiOperation(value = "Update a canary config")
   @RequestMapping(value = "/{canaryConfigId:.+}", consumes = "application/json", method = RequestMethod.PUT)
-  public String updateCanaryConfig(@RequestParam(required = false) final String configurationAccountName,
-                                   @PathVariable String canaryConfigId,
-                                   @RequestBody CanaryConfig canaryConfig) throws IOException {
+  public CanaryConfigUpdateResponse updateCanaryConfig(@RequestParam(required = false) final String configurationAccountName,
+                                                       @PathVariable String canaryConfigId,
+                                                       @RequestBody CanaryConfig canaryConfig) throws IOException {
     String resolvedConfigurationAccountName = CredentialsHelper.resolveAccountByNameOrType(configurationAccountName,
                                                                                            AccountCredentials.Type.CONFIGURATION_STORE,
                                                                                            accountCredentialsRepository);
@@ -153,7 +155,7 @@ public String updateCanaryConfig(@RequestParam(required = false) final String co
 
     configurationService.storeObject(resolvedConfigurationAccountName, ObjectType.CANARY_CONFIG, canaryConfigId, canaryConfig, canaryConfig.getName() + ".json", true);
 
-    return canaryConfigId;
+    return CanaryConfigUpdateResponse.builder().canaryConfigId(canaryConfigId).build();
   }
 
   @ApiOperation(value = "Delete a canary config")