MODLD-646: Update the response structure of authorityAssignmentCheck API

src/main/java/org/folio/linked/data/controller/AuthorityAssignmentController.java

@@ -4,6 +4,7 @@
 
 import lombok.RequiredArgsConstructor;
 import org.folio.linked.data.domain.dto.AssignmentCheckDto;
+import org.folio.linked.data.domain.dto.AssignmentCheckResponseDto;
 import org.folio.linked.data.rest.resource.AuthorityApi;
 import org.folio.linked.data.service.resource.marc.AssignAuthorityTarget;
 import org.folio.linked.data.service.resource.marc.ResourceMarcAuthorityService;
@@ -17,11 +18,10 @@ public class AuthorityAssignmentController implements AuthorityApi {
   private final ResourceMarcAuthorityService resourceMarcAuthorityService;
 
   @Override
-  public ResponseEntity<String> authorityAssignmentCheck(AssignmentCheckDto dto) {
-    return ok(String.valueOf(
-      resourceMarcAuthorityService.isMarcAuthorityCompatibleWithTarget(
-        dto.getRawMarc(),
-        AssignAuthorityTarget.valueOf(dto.getTarget().name()))
-      ));
+  public ResponseEntity<AssignmentCheckResponseDto> authorityAssignmentCheck(AssignmentCheckDto dto) {
+    var isValidAssignment = resourceMarcAuthorityService.isMarcAuthorityCompatibleWithTarget(
+      dto.getRawMarc(),
+      AssignAuthorityTarget.valueOf(dto.getTarget().name()));
+    return ok(new AssignmentCheckResponseDto(isValidAssignment));
   }
 }

src/main/resources/swagger.api/mod-linked-data.yaml

@@ -263,12 +263,11 @@ paths:
               $ref: schema/assignmentCheckDto.json
       responses:
         '200':
-          description: Returns plain text boolean as response
+          description: Returns the result of the assignment check, including whether the assignment is valid and, if not, the reason for invalidity
           content:
-            text/plain:
+            application/json:
               schema:
-                type: string
-                example: true|false
+                $ref: schema/assignmentCheckResponseDto.json
         '400':
           $ref: '#/components/responses/badRequestResponse'
         '500':

src/main/resources/swagger.api/schema/assignmentCheckResponseDto.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "MARC authority assignment check response",
+  "type": "object",
+  "properties": {
+    "validAssignment": {
+      "type": "boolean",
+      "description": "Indicates if the assignment is valid"
+    },
+    "invalidAssignmentReason": {
+      "type": "string",
+      "enum": ["UNSUPPORTED_MARC", "NO_LCCN", "NOT_VALID_FOR_TARGET"],
+      "description": "Indicates the reason why the assignment is not valid. Only present if 'validAssignment' is false."
+    }
+  },
+  "required": [
+    "validAssignment"
+  ]
+}

src/test/java/org/folio/linked/data/e2e/AuthorityAssignmentControllerIT.java

@@ -2,9 +2,10 @@
 
 import static org.folio.linked.data.test.TestUtil.defaultHeaders;
 import static org.folio.linked.data.test.TestUtil.loadResourceAsString;
+import static org.hamcrest.Matchers.equalTo;
 import static org.springframework.http.MediaType.APPLICATION_JSON;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
-import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -42,6 +43,7 @@ class AuthorityAssignmentControllerIT {
   void authorityAssignmentCheck(String marcFile, String expectedResponse) throws Exception {
     // given
     var requestBuilder = post(ASSIGNMENT_CHECK_ENDPOINT)
+      .accept(APPLICATION_JSON)
       .contentType(APPLICATION_JSON)
       .headers(defaultHeaders(env))
       .content(
@@ -57,6 +59,6 @@ void authorityAssignmentCheck(String marcFile, String expectedResponse) throws E
     // then
     resultActions
       .andExpect(status().isOk())
-      .andExpect(content().string(expectedResponse));
+      .andExpect(jsonPath("$.validAssignment", equalTo(Boolean.valueOf(expectedResponse))));
   }
 }