Fix merge conflicts

Author: popey2700

.gitignore

@@ -71,6 +71,9 @@ ecr.repo
 dps-gradle-spring-boot-suppressions.xml
 sonar-project.properties
 
+# localstack
+localstack/cache
+
 # Helm
 **/Chart.lock
 

docs/guides/setting-up-a-new-consumer.md

@@ -12,14 +12,17 @@ per environment.
 - [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
 - [Access to Cloud Platform’s Kubernetes cluster](https://user-guide.cloud-platform.service.justice.gov.uk/documentation/getting-started/kubectl-config.html#installing-kubectl)
 
+As a pre-requisite to create a client certificate by running the script below, please ensure that:
+- You are logged in so that you can access AWS resources via the CLI.
+- Verify that you have all your AWS credentials ready by opening the config file in the ".aws" directory.
+
 ## Create a client certificate
 
-1. Run the [generate-client-certificate.sh](/scripts/client_certificates/generate.sh) script with the name of the environment and client.
+Run the [generate-client-certificate.sh](/scripts/client_certificates/generate.sh) script with the name of the environment and client.
 
 ```bash
 make generate-client-certificate
 ```
-
 This will output three files in the ./scripts/client_certificates directory:
 
 - a private key e.g. `dev-nhs-client.key`
@@ -114,3 +117,14 @@ kubectl -n hmpps-integration-api-[environment] get secrets [your queue secret na
 5. Create new [Cloud Platform Environments GitHub repository](https://github.com/ministryofjustice/cloud-platform-environments/tree/main) branch 
 6. Update terraform to load the secret value from AWS and update filter_policy value. Follow [Example](https://github.com/ministryofjustice/cloud-platform-environments/pull/22111/files). Note: The name of aws_secretsmanager_secret module has to be same as the secret name created from step 4/5 above. 
 7. Follow steps 3-8 in [Create an API key](#create-an-api-key) to merge branch to main. 
+
+## Create a new endpoint for a client
+
+### Create basic infrastructure
+Within the [Cloud Platform Environments GitHub repository](https://github.com/ministryofjustice/cloud-platform-environments/tree/main) and the namespace of the environment:
+
+1. Create a branch.
+2. Add a new API Gateway resource, a SQS method, a SQS method response, and an integration. Example: [api_gateway.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22695/files)
+3. Ensure that all the permissions are up-to-date and add a new role and policy for your new resource. Example: [iam.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22787/files#diff-a376622fa4a4c2fd9404d5ee4221487259264608a0cbe36b99c150c472558f29)
+4. Check that the integration is pointing to the right queue. Example: [api_gateway.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22795/files)
+5. Deploy and test (do not use Postman, rather use a GET cURL command with "x-api-key" as your header.)

openapi.yml

@@ -96,6 +96,11 @@ paths:
                 type: object
                 properties:
                   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.
@@ -605,7 +610,7 @@ paths:
                 NoQueryParametersBadRequestError:
                   $ref: "#/components/examples/InternalServerError"
 
-  /v1/persons/{hmppsId}/risks:
+  /v1/persons/{hmppsId}/risks/serious-harm:
     get:
       tags:
         - risks
@@ -640,7 +645,41 @@ paths:
               examples:
                 NoQueryParametersBadRequestError:
                   $ref: "#/components/examples/InternalServerError"
-
+  /v1/persons/{hmppsId}/risk-management-plan:
+    get:
+      tags:
+        - risks
+      summary: Returns a list of Risk Management Plans created for the person with the provided HMPPS ID.
+      parameters:
+        - $ref: "#/components/parameters/HmppsId"
+      responses:
+        "200":
+          description: Successfully found risk management plans for a person with the provided HMPPS ID.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    $ref: "#/components/schemas/RiskManagementPlan"
+        "404":
+          description: Failed to find risk management plans for a person with the provided HMPPS ID.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+              examples:
+                PersonNotFoundError:
+                  $ref: "#/components/examples/PersonNotFoundError"
+        "500":
+          description: An upstream service was not responding, so we cannot verify the accuracy of any data we did get.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+              examples:
+                NoQueryParametersBadRequestError:
+                  $ref: "#/components/examples/InternalServerError"
   /v1/epf/person-details/{hmppsId}/{eventNumber}:
     get:
       summary: Probation case information for the Effective Proposals Framework service
@@ -914,23 +953,6 @@ paths:
                 NoQueryParametersBadRequestError:
                   $ref: "#/components/examples/InternalServerError"
 
-  /{TBC}/v1/persons/{Id}/key-workers:
-    get:
-      summary: FUTURE ENDPOINT - Returns responsible officer history, transfer history and consolidated transfer review associated with a person.
-      parameters:
-        - $ref: "#/components/parameters/Id"
-      responses:
-        "200":
-          description: Success.
-        "500":
-          description: An upstream service was not responding, so we cannot verify the accuracy of any data we did get.
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Error"
-              examples:
-                NoQueryParametersBadRequestError:
-                  $ref: "#/components/examples/InternalServerError"
 
   /{TBC}/v1/persons/{Id}/prisoner-visits:
     get:
@@ -968,42 +990,6 @@ paths:
                 NoQueryParametersBadRequestError:
                   $ref: "#/components/examples/InternalServerError"
 
-  /{TBC}/v1/persons/{Id}/security:
-    get:
-      summary: FUTURE ENDPOINT - Returns security information such as prisoner non-associations and prisoner incidents for a person.
-      parameters:
-        - $ref: "#/components/parameters/Id"
-      responses:
-        "200":
-          description: Success.
-        "500":
-          description: An upstream service was not responding, so we cannot verify the accuracy of any data we did get.
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Error"
-              examples:
-                NoQueryParametersBadRequestError:
-                  $ref: "#/components/examples/InternalServerError"
-
-  /{TBC}/v1/persons/{Id}/special-needs:
-    get:
-      summary: FUTURE ENDPOINT -  Returns special needs such as drugs test summaries, drug history and drugs test lists associated with a person.
-      parameters:
-        - $ref: "#/components/parameters/Id"
-      responses:
-        "200":
-          description: Success.
-        "500":
-          description: An upstream service was not responding, so we cannot verify the accuracy of any data we did get.
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Error"
-              examples:
-                NoQueryParametersBadRequestError:
-                  $ref: "#/components/examples/InternalServerError"
-
 components:
   parameters:
     HmppsId:
@@ -1775,45 +1761,44 @@ components:
         firstName:
           type: string
           example: Arthur
-          description: first name
+          description: First name
         middleName:
           type: string
           example: John
           nullable: true
-          description: middle name
+          description: Middle name
         lastName:
           type: string
           example: Morgan
-          description: last name
+          description: Last name
         dateOfBirth:
           type: string
           format: date
           example: 1965-12-01
-          description: date of birth
+          description: Date of birth
         gender:
           type: string
           example: Male
-          description: gender
+          description: Gender
         ethnicity:
           type: string
           example: "White: Eng./Welsh/Scot./N.Irish/British"
-          description: ethnicity
+          nullable: true
+          description: Ethnicity
         aliases:
           type: array
-          minItems: 0
           items:
             $ref: "#/components/schemas/Alias"
-          description: list of aliases
+          description: List of aliases
         identifiers:
           $ref: "#/components/schemas/Identifiers"
         pncId:
           type: string
-          example: 2008/0545166T
           description: An identifier from the Police National Computer (PNC)
         hmppsId:
           type: string
-          example: X00001
-          description: Currently a hmppsId is a CRN identifier however this will change in the future to be a new unique Hmpps identifier
+          example: 2008/0545166T
+          description: Hmpps identifier
         contactDetails:
           $ref: "#/components/schemas/ContactDetails"
     PersonResponsibleOfficerName:
@@ -1955,7 +1940,6 @@ components:
           nullable: true
         prison:
           $ref: "#/components/schemas/Prison"
-
     Punishment:
       type: object
       properties:
@@ -2504,6 +2488,65 @@ components:
           type: string
           example: "Risk of self harm concerns due to ..."
           description: Supporting comments for any current concerns
+    RiskManagementPlan:
+      type: object
+      properties:
+        assessmentId:
+          type: string
+          example: "123456"
+          description: The unique ID of the risk management plan
+        dateCompleted:
+          type: string
+          example: "2024-05-04T01:04:20"
+          description: The date that the risk management plan was completed
+        initiationDate:
+          type: string
+          example: "2024-05-04T01:04:20"
+          description: The date of plan initiation
+        assessmentStatus:
+          type: string
+          example: "COMPLETE"
+          description: The status of the plan
+        assessmentType:
+          type: string
+          example: "string"
+          description: The type of assessment
+        keyInformationCurrentSituation:
+          type: string
+          example: "string"
+          description: Key information about the current situation of the subject being assessed
+        furtherConsiderationsCurrentSituation:
+          type: string
+          example: "string"
+          description: Further considerations about the situation of the subject being assessed
+        supervision:
+          type: string
+          example: "string"
+          description: Who they see, when and why, any support they get from their community, family and friends, and how well they're desisting from problematic behaviour
+        monitoringAndControl:
+          type: string
+          example: "string"
+          description: Information on restrictions in place to prevent reoffending, what steps have been taken to monitor potential reoffending, including license conditions, community order requirements, PPM restrictions and such.
+        interventionsAndTreatment:
+          type: string
+          example: "string"
+          description: Interventions delivered to develop controls and protective factors to reduce risk of reoffending, including practical support, requirements to support interventions and details of who and where these interventions will be administered.
+        victimSafetyPlanning:
+          type: string
+          example: "string"
+          description: Restrictions in place to specifically protect victims of, adults known to, and children potentially at risk from the offender.
+        contingencyPlans:
+          type: string
+          example: "string"
+          description: Future plans in the form "If X happens, we will do Y...." for if parts of the risk management plan break down or requirements or restrictions are breached by the offender.
+        latestSignLockDate:
+          type: string
+          example: "2024-05-04T01:04:20"
+          description: An assessment is considered 'Signed and locked' once it is signed by the assessor, making the plan read-only. This is the date the plan has been signed by the assessor.
+        latestCompleteDate:
+          type: string
+          example: "2024-05-04T01:04:20"
+          description: Once a countersignature has been applied to the plan, the plan is considered complete. This is the date the plan has been countersigned.
     OtherRisks:
       type: object
       properties:

scripts/client_certificates/generate.sh

@@ -51,8 +51,8 @@ upload_backup() {
   aws s3api put-object --bucket "$bucket" --key "$client_folder/" --acl private
   aws s3 cp "$file_path" "s3://$path/client.pem"
   aws s3 cp ./"$environment"-"$client"-client.pem "s3://$path/client.pem"
-  aws s3 cp ./truststore.key "s3://$path/truststore.key"
-  aws s3 cp ./truststore.pem "s3://$path/truststore.pem"
+  aws s3 cp ./"$environment"-"$client"-client.csr "s3://$path/client.csr"
+  aws s3 cp ./"$environment"-"$client"-client.key "s3://$path/client.key"
 
   aws configure set aws_access_key_id ""
   aws configure set aws_secret_access_key ""

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

@@ -0,0 +1,44 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.controllers.v1
+
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.context.properties.EnableConfigurationProperties
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RequestParam
+import org.springframework.web.bind.annotation.RestController
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.config.AuthorisationConfig
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.EntityNotFoundException
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.decodeUrlCharacters
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.RiskManagementPlan
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetRiskManagementPlansForCrnService
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.internal.AuditService
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.util.PaginatedResponse
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.util.paginateWith
+
+@RestController
+@EnableConfigurationProperties(AuthorisationConfig::class)
+class RiskManagementController(
+  @Autowired val getRiskManagementPlansForCrnService: GetRiskManagementPlansForCrnService,
+  @Autowired val auditService: AuditService,
+) {
+  @RequestMapping("/v1/persons/{encodedHmppsId}/risk-management-plan")
+  fun getRiskManagementPlans(
+    @PathVariable encodedHmppsId: String,
+    @RequestParam(required = false, defaultValue = "1", name = "page") page: Int,
+    @RequestParam(required = false, defaultValue = "10", name = "perPage") perPage: Int,
+  ): PaginatedResponse<RiskManagementPlan> {
+    val hmppsId = encodedHmppsId.decodeUrlCharacters()
+    val response = getRiskManagementPlansForCrnService.execute(hmppsId)
+    if (response.data.isNullOrEmpty()) {
+      if (response.hasErrorCausedBy(UpstreamApiError.Type.ENTITY_NOT_FOUND, causedBy = UpstreamApi.RISK_MANAGEMENT_PLAN)) {
+        throw EntityNotFoundException("Could not find person with id: $hmppsId")
+      }
+      return emptyList<RiskManagementPlan>().paginateWith(page, perPage)
+    }
+
+    auditService.createEvent("GET_RISK_MANAGEMENT_PLANS", mapOf("hmppsId" to hmppsId))
+    return response.data.paginateWith(page, perPage)
+  }
+}

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

@@ -61,16 +61,17 @@ class PersonController(
   @GetMapping("{encodedHmppsId}")
   fun getPerson(
     @PathVariable encodedHmppsId: String,
-  ): Map<String, Person?> {
+  ): Map<String, Map<String, Person?>> {
     val hmppsId = encodedHmppsId.decodeUrlCharacters()
-    val response = getPersonService.execute(hmppsId)
+    val response = getPersonService.getCombinedDataForPerson(hmppsId)
 
     if (response.hasErrorCausedBy(ENTITY_NOT_FOUND, causedBy = UpstreamApi.PROBATION_OFFENDER_SEARCH)) {
       throw EntityNotFoundException("Could not find person with id: $hmppsId")
     }
 
     auditService.createEvent("GET_PERSON_DETAILS", mapOf("hmppsId" to hmppsId))
-    return mapOf("data" to response.data)
+    val data = response.data.mapValues { it.value }
+    return mapOf("data" to data)
   }
 
   @GetMapping("{encodedHmppsId}/images")