Fix for Entity Controller setup causing build fails. (#1509)

Refactored and cleaned Entity Controller to address clean runner build
fail PR #1507.

- Fixed entity controller integration tests to incorporate unique data
per test
- Added test utility helpers for cleanup and unique entityJson test
values
- Cleaned up global variables to remove hard coded param values
- Fixed teardown method to ensure all test entities cleaned up after
testing.
- Added check in Entity Controller to fix unused documented query param
errors and check for required params

Author: rma-kayla

cwms-data-api/src/main/java/cwms/cda/api/EntityController.java

@@ -55,7 +55,7 @@ private Timer.Context markAndTime(String subject) {
             },
             responses = {
                     @OpenApiResponse(status = STATUS_200, content = {
-                            @OpenApiContent(isArray = true, from = Entity.class, type = Formats.JSONV2)
+                            @OpenApiContent(isArray = true, from = Entity.class, type = Formats.JSONV1)
                     })
             },
             tags = {TAG}
@@ -69,8 +69,14 @@ public void getAll(@NotNull Context ctx) {
             String officeId = ctx.queryParam(OFFICE);
             String entityId = ctx.queryParam(ENTITY_ID);
             String parentId = ctx.queryParam(PARENT_ENTITY_ID);
-            Boolean matchNullParents = ctx.queryParamAsClass(MATCH_NULL_PARENTS, Boolean.class)
-                    .getOrDefault(true);
+            Boolean matchNullParents;
+            if (parentId != null) {
+                matchNullParents = false;
+            } else {
+                matchNullParents = ctx.queryParamAsClass(MATCH_NULL_PARENTS, Boolean.class)
+                        .getOrDefault(true);
+            }
+
             String categoryId = ctx.queryParam(CATEGORY_ID);
             String entityName = ctx.queryParam(LONG_NAME);
 
@@ -100,7 +106,7 @@ public void getAll(@NotNull Context ctx) {
             },
             responses = {
                     @OpenApiResponse(status = STATUS_200, content = {
-                                    @OpenApiContent(from = Entity.class, type = Formats.JSONV2)
+                                    @OpenApiContent(from = Entity.class, type = Formats.JSONV1)
                     })
             },
             tags = {TAG}
@@ -133,7 +139,7 @@ public void getOne(@NotNull Context ctx, @NotNull String entityId) {
             description = "Create CWMS Entity",
             requestBody = @OpenApiRequestBody(
                     content = {
-                            @OpenApiContent(from = Entity.class, type = Formats.JSONV2)
+                            @OpenApiContent(from = Entity.class, type = Formats.JSONV1)
                     },
                     required = true),
             responses = {
@@ -161,16 +167,12 @@ public void create(@NotNull Context ctx) {
     @OpenApi(
             description = "Update an existing Entity.",
             requestBody = @OpenApiRequestBody(
-                    content = {@OpenApiContent(from = Entity.class, type = Formats.JSONV2)},
+                    content = {@OpenApiContent(from = Entity.class, type = Formats.JSONV1)},
                     required = true),
             pathParams = {
                     @OpenApiParam(name = ENTITY_ID, required = true, description = "Specifies the entity ID of the " +
                             " Entity to be updated. (e.g., NWS)")
             },
-            queryParams = {
-                    @OpenApiParam(name = OFFICE, required = true, description = "Specifies the owning office "+
-                            " of the entity to be updated. (e.g., SPK)")
-            },
             method = HttpMethod.PATCH,
             tags = {TAG},
             responses = {
@@ -185,9 +187,12 @@ public void update(@NotNull Context ctx, @NotNull String entityId) {
             String formatHeader = ctx.req.getContentType();
             ContentType contentType = Formats.parseHeader(formatHeader, Entity.class);
             Entity entity = Formats.parseContent(contentType, ctx.bodyAsInputStream(), Entity.class);
-            if (entity.getId() == null || entity.getId().getOfficeId() == null || entity.getId().getName() == null) {
-                ctx.status(HttpServletResponse.SC_BAD_REQUEST);
-                ctx.result("Entity ID and Office ID must be provided in the request body.");
+            // Validate the office ID and entity ID are provided.
+            entity.validate();
+
+            if (!entityId.equalsIgnoreCase(entity.getId().getName())) {
+                ctx.status(HttpServletResponse.SC_NOT_FOUND);
+                ctx.result("Entity ID in path parameter must match the Entity ID in the request body.");
                 return;
             }
             EntityDao dao = new EntityDao(dsl);
@@ -196,7 +201,8 @@ public void update(@NotNull Context ctx, @NotNull String entityId) {
         }
     }
 
-    @OpenApi(
+
+        @OpenApi(
             description = "Delete CWMS Entity.",
             pathParams = {
                     @OpenApiParam(name = ENTITY_ID, required = true, description = "Specifies the entity ID " +

cwms-data-api/src/main/java/cwms/cda/data/dto/Entity.java

@@ -7,9 +7,9 @@
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import cwms.cda.formatters.Formats;
 import cwms.cda.formatters.annotations.FormattableWith;
-import cwms.cda.formatters.json.JsonV2;
+import cwms.cda.formatters.json.JsonV1;
 
-@FormattableWith(contentType = Formats.JSONV2, formatter = JsonV2.class, aliases = {Formats.DEFAULT, Formats.JSON})
+@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class, aliases = {Formats.DEFAULT, Formats.JSON})
 @JsonDeserialize(builder = Entity.Builder.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)