Issue 854 - Rename TS Identifier patch path parameter

USACE · Sep 30, 2024 · e69cce7 · e69cce7
1 parent 7f3ebaf
commit e69cce7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 28 deletions.
diff --git a/cwms-data-api/src/main/java/cwms/cda/ApiServlet.java b/cwms-data-api/src/main/java/cwms/cda/ApiServlet.java
@@ -492,7 +492,7 @@ protected void configureRoutes() {
 
         cdaCrudCache("/timeseries/category/{category-id}",
                 new TimeSeriesCategoryController(metrics), requiredRoles,5, TimeUnit.MINUTES);
-        cdaCrudCache("/timeseries/identifier-descriptor/{timeseries-id}",
+        cdaCrudCache("/timeseries/identifier-descriptor/{name}",
                 new TimeSeriesIdentifierDescriptorController(metrics), requiredRoles,5, TimeUnit.MINUTES);
         cdaCrudCache("/timeseries/group/{group-id}",
                 new TimeSeriesGroupController(metrics), requiredRoles,5, TimeUnit.MINUTES);

diff --git a/cwms-data-api/src/main/java/cwms/cda/api/TimeSeriesIdentifierDescriptorController.java b/cwms-data-api/src/main/java/cwms/cda/api/TimeSeriesIdentifierDescriptorController.java
@@ -25,28 +25,7 @@
 package cwms.cda.api;
 
 import static com.codahale.metrics.MetricRegistry.name;
-import static cwms.cda.api.Controllers.ACTIVE;
-import static cwms.cda.api.Controllers.CREATE;
-import static cwms.cda.api.Controllers.DELETE;
-import static cwms.cda.api.Controllers.FAIL_IF_EXISTS;
-import static cwms.cda.api.Controllers.GET_ALL;
-import static cwms.cda.api.Controllers.GET_ONE;
-import static cwms.cda.api.Controllers.INTERVAL_OFFSET;
-import static cwms.cda.api.Controllers.METHOD;
-import static cwms.cda.api.Controllers.OFFICE;
-import static cwms.cda.api.Controllers.PAGE;
-import static cwms.cda.api.Controllers.PAGE_SIZE;
-import static cwms.cda.api.Controllers.RESULTS;
-import static cwms.cda.api.Controllers.SIZE;
-import static cwms.cda.api.Controllers.SNAP_BACKWARD;
-import static cwms.cda.api.Controllers.SNAP_FORWARD;
-import static cwms.cda.api.Controllers.STATUS_200;
-import static cwms.cda.api.Controllers.STATUS_404;
-import static cwms.cda.api.Controllers.STATUS_501;
-import static cwms.cda.api.Controllers.TIMESERIES_ID;
-import static cwms.cda.api.Controllers.TIMESERIES_ID_REGEX;
-import static cwms.cda.api.Controllers.UPDATE;
-import static cwms.cda.api.Controllers.requiredParam;
+import static cwms.cda.api.Controllers.*;
 
 import com.codahale.metrics.Histogram;
 import com.codahale.metrics.MetricRegistry;
@@ -189,7 +168,7 @@ public void getAll(Context ctx) {
                             + "implemented")},
             description = "Retrieves requested timeseries identifier descriptor", tags = {TAG})
     @Override
-    public void getOne(Context ctx, @NotNull String timeseriesId) {
+    public void getOne(@NotNull Context ctx, @NotNull String timeseriesId) {
 
         try (final Timer.Context ignored = markAndTime(GET_ONE)){
             DSLContext dsl = getDslContext(ctx);
@@ -263,7 +242,7 @@ public void create(@NotNull Context ctx) {
 
     @OpenApi(
             pathParams = {
-                    @OpenApiParam(name = TIMESERIES_ID, description = "The timeseries id"),
+                    @OpenApiParam(name = NAME, description = "The timeseries id"),
             },
             queryParams = {
                     @OpenApiParam(name = OFFICE, required = true, description = "Specifies the "
@@ -280,7 +259,7 @@ public void create(@NotNull Context ctx) {
             }, tags = {TAG}
     )
     @Override
-    public void update(Context ctx, @NotNull String timeseriesId) {
+    public void update(@NotNull Context ctx, @NotNull String name) {
 
         String office = requiredParam(ctx, OFFICE);
         String newTimeseriesId = ctx.queryParam(TIMESERIES_ID);
@@ -306,13 +285,13 @@ public void update(Context ctx, @NotNull String timeseriesId) {
 
             if (foundUpdateKeys.isEmpty()) {
                 // basic rename.
-                dao.rename(office, timeseriesId, newTimeseriesId, intervalOffset);
+                dao.rename(office, name, newTimeseriesId, intervalOffset);
             } else {
                 Long forward = ctx.queryParamAsClass(SNAP_FORWARD, Long.class).getOrDefault(null);
                 Long backward = ctx.queryParamAsClass(SNAP_BACKWARD, Long.class).getOrDefault(null);
                 boolean active = ctx.queryParamAsClass(ACTIVE, Boolean.class).getOrDefault(true);
 
-                dao.update(office, timeseriesId, intervalOffset, forward, backward, active);
+                dao.update(office, name, intervalOffset, forward, backward, active);
             }
         }