Merge pull request #355 from ministryofjustice/HIA-540

Adding data key for person response

Author: Bingjie Liu

openapi.yml

@@ -75,10 +75,13 @@ paths:
               schema:
                 type: object
                 properties:
-                  prisonerOffenderSearch:
-                    $ref: "#/components/schemas/Person"
-                  probationOffenderSearch:
-                    $ref: "#/components/schemas/Person"
+                  data:
+                    type: object
+                    properties:
+                      prisonerOffenderSearch:
+                        $ref: "#/components/schemas/Person"
+                      probationOffenderSearch:
+                        $ref: "#/components/schemas/Person"
         "404":
           description: Failed to find a person with the provided HMPPS ID.
           content:

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/PersonController.kt

@@ -49,7 +49,7 @@ class PersonController(
   }
 
   @GetMapping("{encodedHmppsId}")
-  fun getPerson(@PathVariable encodedHmppsId: String): Person? {
+  fun getPerson(@PathVariable encodedHmppsId: String): Map<String, Person?> {
     val hmppsId = encodedHmppsId.decodeUrlCharacters()
     val response = getPersonService.execute(hmppsId)
 
@@ -58,7 +58,7 @@ class PersonController(
     }
 
     auditService.createEvent("GET_PERSON_DETAILS", "Person details with hmpps id: $hmppsId has been retrieved")
-    return response.data
+    return mapOf("data" to response.data)
   }
 
   @GetMapping("{encodedHmppsId}/images")

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/PersonControllerTest.kt

@@ -277,6 +277,7 @@ internal class PersonControllerTest(
         result.response.contentAsString.shouldBe(
           """
         {
+        "data": {
           "firstName": "Silly",
           "lastName": "Sobbers",
           "middleName": null,
@@ -292,6 +293,7 @@ internal class PersonControllerTest(
           "pncId": null,
           "hmppsId": null
         }
+        }
         """.removeWhitespaceAndNewlines(),
         )
       }

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/smoke/person/PersonSmokeTest.kt

@@ -44,32 +44,34 @@ class PersonSmokeTest : DescribeSpec(
 
       response.body().shouldBe(
         """
-          {
-            "firstName": "string",
-            "lastName": "string",
-            "middleName": "string",
-            "dateOfBirth": "2019-08-24",
-            "gender": "string",
-            "ethnicity": "string",
-            "aliases": [
-              {
-                "firstName": "string",
-                "lastName": "string",
-                "middleName": "string",
-                "dateOfBirth": "2019-08-24",
-                "gender": "string",
-                "ethnicity": null
-              }
-            ],
-            "identifiers": {
-                "nomisNumber": "string",
-                "croNumber": "string",
-                "deliusCrn": "string"
-            },
-            "pncId": "string",
-            "hmppsId": "string"
-          }
-        """.removeWhitespaceAndNewlines(),
+  {
+    "data": {
+      "firstName": "string",
+      "lastName": "string",
+      "middleName": "string",
+      "dateOfBirth": "2019-08-24",
+      "gender": "string",
+      "ethnicity": "string",
+      "aliases": [
+        {
+          "firstName": "string",
+          "lastName": "string",
+          "middleName": "string",
+          "dateOfBirth": "2019-08-24",
+          "gender": "string",
+          "ethnicity": null
+        }
+      ],
+      "identifiers": {
+          "nomisNumber": "string",
+          "croNumber": "string",
+          "deliusCrn": "string"
+      },
+      "pncId": "string",
+      "hmppsId": "string"
+    }
+  }
+    """.removeWhitespaceAndNewlines(),
       )
     }