Return Cas1SpaceCharacteristic in space search

This commit changes the space search result to use the `Cas1SpaceCharacteristic` enum to provide characteristics for matching properties, allowing us to also list room-level characteristics (these will be added in a subsequent commit)
ministryofjustice · Jan 2, 2025 · de6172e · de6172e
1 parent 83cf95e
commit de6172e
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 58 deletions.
diff --git a/...e/digital/hmpps/approvedpremisesapi/transformer/cas1/Cas1SpaceSearchResultsTransformer.kt b/...e/digital/hmpps/approvedpremisesapi/transformer/cas1/Cas1SpaceSearchResultsTransformer.kt
@@ -2,8 +2,8 @@ package uk.gov.justice.digital.hmpps.approvedpremisesapi.transformer.cas1
 
 import org.slf4j.LoggerFactory
 import org.springframework.stereotype.Component
-import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1PremiseCharacteristic
 import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1PremisesSearchResultSummary
+import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1SpaceCharacteristic
 import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1SpaceSearchParameters
 import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1SpaceSearchResults
 import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.NamedId
@@ -39,9 +39,9 @@ class Cas1SpaceSearchResultsTransformer {
             premisesCharacteristics = emptyList(),
             characteristics = candidatePremises.characteristics.mapNotNull {
               try {
-                Cas1PremiseCharacteristic.valueOf(it)
+                Cas1SpaceCharacteristic.valueOf(it)
               } catch (e: IllegalArgumentException) {
-                log.warn("Couldn't find an enum entry for propertyName $it")
+                log.warn("Couldn't find a Cas1SpaceCharacteristic enum entry for propertyName $it")
                 null
               }
             },

diff --git a/src/main/resources/static/cas1-schemas.yml b/src/main/resources/static/cas1-schemas.yml
@@ -67,8 +67,9 @@ components:
             $ref: '_shared.yml#/components/schemas/CharacteristicPair'
         characteristics:
           type: array
+          description: "Room and premise characteristics"
           items:
-            $ref: '#/components/schemas/Cas1PremiseCharacteristic'
+            $ref: '#/components/schemas/Cas1SpaceCharacteristic'
       required:
         - id
         - apType
@@ -140,30 +141,6 @@ components:
       required:
         - startInclusive
         - endInclusive
-    Cas1PremiseCharacteristic:
-      type: string
-      description: All premise characteristics
-      enum:
-        - acceptsChildSexOffenders
-        - acceptsHateCrimeOffenders
-        - acceptsNonSexualChildOffenders
-        - acceptsSexOffenders
-        - additionalRestrictions
-        - hasBrailleSignage
-        - hasHearingLoop
-        - hasLift
-        - hasStepFreeAccessToCommunalAreas
-        - hasTactileFlooring
-        - hasWheelChairAccessibleBathrooms
-        - hasWideAccessToCommunalAreas
-        - hasWideStepFreeAccess
-        - isCatered
-        - isESAP
-        - isIAP
-        - isPIPE
-        - isRecoveryFocussed
-        - isSuitableForVulnerable
-        - isSemiSpecialistMentalHealth
     Cas1SpaceCharacteristic:
       type: string
       description: All of the characteristics of both premises and rooms

diff --git a/src/main/resources/static/codegen/built-cas1-api-spec.yml b/src/main/resources/static/codegen/built-cas1-api-spec.yml
@@ -6117,8 +6117,9 @@ components:
             $ref: '#/components/schemas/CharacteristicPair'
         characteristics:
           type: array
+          description: "Room and premise characteristics"
           items:
-            $ref: '#/components/schemas/Cas1PremiseCharacteristic'
+            $ref: '#/components/schemas/Cas1SpaceCharacteristic'
       required:
         - id
         - apType
@@ -6190,30 +6191,6 @@ components:
       required:
         - startInclusive
         - endInclusive
-    Cas1PremiseCharacteristic:
-      type: string
-      description: All premise characteristics
-      enum:
-        - acceptsChildSexOffenders
-        - acceptsHateCrimeOffenders
-        - acceptsNonSexualChildOffenders
-        - acceptsSexOffenders
-        - additionalRestrictions
-        - hasBrailleSignage
-        - hasHearingLoop
-        - hasLift
-        - hasStepFreeAccessToCommunalAreas
-        - hasTactileFlooring
-        - hasWheelChairAccessibleBathrooms
-        - hasWideAccessToCommunalAreas
-        - hasWideStepFreeAccess
-        - isCatered
-        - isESAP
-        - isIAP
-        - isPIPE
-        - isRecoveryFocussed
-        - isSuitableForVulnerable
-        - isSemiSpecialistMentalHealth
     Cas1SpaceCharacteristic:
       type: string
       description: All of the characteristics of both premises and rooms

diff --git a/.../uk/gov/justice/digital/hmpps/approvedpremisesapi/integration/cas1/Cas1SpaceSearchTest.kt b/.../uk/gov/justice/digital/hmpps/approvedpremisesapi/integration/cas1/Cas1SpaceSearchTest.kt
@@ -7,7 +7,6 @@ import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.EnumSource
 import org.springframework.beans.factory.annotation.Autowired
 import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.ApType
-import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1PremiseCharacteristic
 import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1SpaceCharacteristic
 import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1SpaceSearchParameters
 import uk.gov.justice.digital.hmpps.approvedpremisesapi.api.model.Cas1SpaceSearchRequirements
@@ -109,9 +108,9 @@ class Cas1SpaceSearchTest : InitialiseDatabasePerClassTestBase() {
       assertThat(results.searchCriteria).isEqualTo(searchParameters)
 
       val expectedCharacteristics = listOf(
-        Cas1PremiseCharacteristic.hasWideAccessToCommunalAreas,
-        Cas1PremiseCharacteristic.hasWideStepFreeAccess,
-        Cas1PremiseCharacteristic.hasLift,
+        Cas1SpaceCharacteristic.hasWideAccessToCommunalAreas,
+        Cas1SpaceCharacteristic.hasWideStepFreeAccess,
+        Cas1SpaceCharacteristic.hasLift,
       )
 
       assertThatResultMatches(results.results[0], premises[0], expectedCharacteristics = expectedCharacteristics)
@@ -341,7 +340,7 @@ class Cas1SpaceSearchTest : InitialiseDatabasePerClassTestBase() {
     actual: Cas1SpaceSearchResult,
     expected: ApprovedPremisesEntity,
     expectedApType: ApType = ApType.normal,
-    expectedCharacteristics: List<Cas1PremiseCharacteristic>? = null,
+    expectedCharacteristics: List<Cas1SpaceCharacteristic>? = null,
   ) {
     assertThat(actual.spacesAvailable).isEmpty()
     assertThat(actual.distanceInMiles).isGreaterThan(0f.toBigDecimal())