Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements #443

Merged
merged 5 commits into from
Jun 13, 2024
Merged

Improvements #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6ec448f
Rewrote 'data' key
chiaramapellimt Jun 13, 2024
c20128c
Made descending explicit.
chiaramapellimt Jun 13, 2024
bf36b86
Explicitly saying the order is desc
chiaramapellimt Jun 13, 2024
b3edcb1
Lint
chiaramapellimt Jun 13, 2024
fd28e5e
Changed wording
chiaramapellimt Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 40 additions & 40 deletions openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ paths:
get:
tags:
- persons
summary: Returns person(s) by search criteria, sorted by date of birth. At least one query parameter must be specified.
summary: Returns person(s) by search criteria, sorted by date of birth (newest first). At least one query parameter must be specified.
parameters:
- in: query
name: first_name
Expand Down Expand Up @@ -44,7 +44,7 @@ paths:
type: boolean
default: false
required: false
description: Whether to return results that match the search criteria within the aliases of a person, sorted by date of birth.
description: Whether to return results that match the search criteria within the aliases of a person.
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/perPage"
responses:
Expand Down Expand Up @@ -126,7 +126,7 @@ paths:
get:
tags:
- persons
summary: Returns metadata of images associated with a person sorted by captureDateTime.
summary: Returns metadata of images associated with a person sorted by captureDateTime (newest first).
parameters:
- $ref: "#/components/parameters/hmppsId"
- $ref: "#/components/parameters/page"
Expand Down Expand Up @@ -254,11 +254,11 @@ paths:
tags:
- persons
summary: >
Returns offences associated with a person, ordered by startDate.

Note: This API does not contain the complete list of offences for a person.
Offences are retrieved from Prison and Probation systems exclusively.
Prison systems record only custodial sentences, while Probation systems record only the main offence and some additional offences for case management purposes. Other offences recorded by HMCTS and police may not be included.
Returns offences associated with a person, ordered by startDate (newest first).
>
Note: This API does not contain the complete list of offences for a person.
Offences are retrieved from Prison and Probation systems exclusively.
Prison systems record only custodial sentences, while Probation systems record only the main offence and some additional offences for case management purposes. Other offences recorded by HMCTS and police may not be included.
parameters:
- $ref: "#/components/parameters/hmppsId"
- $ref: "#/components/parameters/page"
Expand Down Expand Up @@ -331,7 +331,7 @@ paths:
tags:
- persons
- alerts
summary: Returns alerts associated with a person, sorted by dateCreated.
summary: Returns alerts associated with a person, sorted by dateCreated (newest first).
parameters:
- $ref: "#/components/parameters/hmppsId"
- $ref: "#/components/parameters/page"
Expand Down Expand Up @@ -375,7 +375,7 @@ paths:
tags:
- persons
- alerts
summary: Returns alerts associated with a person, sorted by dateCreated.
summary: Returns alerts associated with a person, sorted by dateCreated (newest first).
parameters:
- $ref: "#/components/parameters/hmppsId"
- $ref: "#/components/parameters/page"
Expand Down Expand Up @@ -418,7 +418,7 @@ paths:
get:
tags:
- persons
summary: Returns sentences associated with a person, sorted by dateOfSentencing.
summary: Returns sentences associated with a person, sorted by dateOfSentencing (newest first).
parameters:
- $ref: "#/components/parameters/hmppsId"
- $ref: "#/components/parameters/page"
Expand Down Expand Up @@ -497,7 +497,7 @@ paths:
get:
tags:
- risks
summary: Returns risk scores from the last year associated with a person, sorted by completedDate.
summary: Returns risk scores from the last year associated with a person, sorted by completedDate (newest first).
parameters:
- $ref: "#/components/parameters/hmppsId"
- $ref: "#/components/parameters/page"
Expand Down Expand Up @@ -802,7 +802,7 @@ paths:

/v1/persons/{hmppsId}/adjudications:
get:
summary: Returns adjudications associated with a person, sorted by dateTimeOfIncident.
summary: Returns adjudications associated with a person, sorted by dateTimeOfIncident (newest first).
parameters:
- name: hmppsId
in: path
Expand Down Expand Up @@ -871,7 +871,7 @@ paths:

/v1/persons/{hmppsId}/licences/conditions:
get:
summary: Returns license conditions associated with a person, sorted by createdDateTime.
summary: Returns license conditions associated with a person, sorted by createdDateTime (newest first).
parameters:
- $ref: "#/components/parameters/hmppsId"
responses:
Expand Down Expand Up @@ -1546,7 +1546,7 @@ components:
- OIC
description: >
View is the subject focus; describing the inner focus or subject of the image, normally referring to a marking, tattoo or deeper level focus of the orientation. In practise this is the interior foci of what is captured in the 'orientation' field.
Options include:
Possible values are:
`FACE` - Facing,
`TAT` - Tattoo,
`OTH` - Other,
Expand Down Expand Up @@ -1582,7 +1582,7 @@ components:
- TORSO
description: >
Orientation is the scope focus; describing the scope or outer focus of the image, normally referring to the highest level object of interest within the bounds of the photo itself. This is normally a body part or an angle of photography, such as a photo of someone’s facial view (`FRONT`) or arm (`ARM`).
Options include:
Possible values are:
`ANKLE` - Ankle,
`ARM` - Arm,
`DAMAGE` - Damage,
Expand Down Expand Up @@ -1616,7 +1616,7 @@ components:
- PPTY
description: >
Type is the contextual focus; describing the context or scenario the image was taken within. It could be for a particular purpose or capturing the results of a particular type of incident.
Options include:
Possible values are:
`OFF_BKG` - Offender Booking,
`OFF_IDM` - Offender Identification Marks,
`OIC` - Offence In Custody,
Expand Down Expand Up @@ -1723,7 +1723,7 @@ components:
- VARIATION_REJECTED
example: IN_PROGRESS
description: >
Licence status. Options include:
Licence status. Possible values are:
`IN_PROGRESS`,
`SUBMITTED`,
`APPROVED`,
Expand All @@ -1740,7 +1740,7 @@ components:
- PSS
- AP_PSS
description: >
The type of licence. Options include:
The type of licence. Possible values are:
`AP`,
`PSS`,
`AP_PSS`
Expand Down Expand Up @@ -1810,7 +1810,7 @@ components:
- NDELIUS
example: NOMIS
description: >
Which upstream API service the sentence originates from. Options include:
Which upstream API service the sentence originates from. Possible values are:
`NOMIS`,
`NDELIUS`
systemSource:
Expand All @@ -1820,7 +1820,7 @@ components:
- PROBATION_SYSTEMS
example: PROBATION_SYSTEMS
description: >
Which upstream API system the sentence originates from. Options include:
Which upstream API system the sentence originates from. Possible values are:
`PRISON_SYSTEMS`,
`PROBATION_SYSTEMS`
cjsCode:
Expand Down Expand Up @@ -2177,7 +2177,7 @@ components:
- NDELIUS
example: NOMIS
description: >
Which upstream API service the sentence originates from. Options include:
Which upstream API service the sentence originates from. Possible values are:
`NOMIS`,
`NDELIUS`
systemSource:
Expand All @@ -2187,7 +2187,7 @@ components:
- PROBATION_SYSTEMS
example: PROBATION_SYSTEMS
description: >
Which upstream API system the sentence originates from. Options include:
Which upstream API system the sentence originates from. Possible values are:
`PRISON_SYSTEMS`,
`PROBATION_SYSTEMS`
dateOfSentencing:
Expand Down Expand Up @@ -2321,7 +2321,7 @@ components:
- PRRD
example: ARD
description: >
Indicates which type of non-DTO release date is the effective release date. One of 'ARD', 'CRD', 'NPD' or 'PRRD'. Options include:
Indicates which type of non-DTO release date is the effective release date. One of 'ARD', 'CRD', 'NPD' or 'PRRD'. Possible values are:
`ARD`,
`CRD`,
`NPD`,
Expand Down Expand Up @@ -2441,7 +2441,7 @@ components:
- Years
example: Hours
description: >
Time unit that is used in combination with the duration field. Options include:
Time unit that is used in combination with the duration field. Possible values are:
`Hours`,
`Days`,
`Weeks`,
Expand Down Expand Up @@ -2490,7 +2490,7 @@ components:
example: IMP
description: >
The sentence term code
Options include:
Possible values are:
`CUR` - Curfew Period,
`DEF` - Deferment Period,
`DET` - Detention,
Expand Down Expand Up @@ -2558,7 +2558,7 @@ components:
- LOCKED_INCOMPLETE
example: COMPLETE
description: >
Whether the risk score calculation is complete. Options include:
Whether the risk score calculation is complete. Possible values are:
`COMPLETE`,
`LOCKED_INCOMPLETE`
groupReconviction:
Expand All @@ -2584,7 +2584,7 @@ components:
- NOT_APPLICABLE
example: LOW
description: >
Indicator for risk of group reconviction. Options include:
Indicator for risk of group reconviction. Possible values are:
`LOW`,
`MEDIUM`,
`HIGH`,
Expand All @@ -2604,7 +2604,7 @@ components:
- NOT_APPLICABLE
example: MEDIUM
description: >
Indicator for risk of violence. Options include:
Indicator for risk of violence. Possible values are:
`LOW`,
`MEDIUM`,
`HIGH`,
Expand All @@ -2624,7 +2624,7 @@ components:
- NOT_APPLICABLE
example: VERY_HIGH
description: >
Indicator for general prediction. Options include:
Indicator for general prediction. Possible values are:
`LOW`,
`MEDIUM`,
`HIGH`,
Expand All @@ -2644,7 +2644,7 @@ components:
- NOT_APPLICABLE
example: MEDIUM
description: >
Indicator for risk of serious recidivism. Options include:
Indicator for risk of serious recidivism. Possible values are:
`LOW`,
`MEDIUM`,
`HIGH`,
Expand All @@ -2664,7 +2664,7 @@ components:
- NOT_APPLICABLE
example: HIGH
description: >
Indicator for risk of sexual indecency. Options include:
Indicator for risk of sexual indecency. Possible values are:
`LOW`,
`MEDIUM`,
`HIGH`,
Expand All @@ -2680,7 +2680,7 @@ components:
- NOT_APPLICABLE
example: MEDIUM
description: >
Indicator for risk of sexual contact. Options include:
Indicator for risk of sexual contact. Possible values are:
`LOW`,
`MEDIUM`,
`HIGH`,
Expand Down Expand Up @@ -2726,7 +2726,7 @@ components:
- DK
- NA
description: >
Presence of risk. Options include:
Presence of risk. Possible values are:
`YES`,
`NO`,
`DK`,
Expand All @@ -2740,7 +2740,7 @@ components:
- DK
- NA
description: >
Previous concerns. Options include:
Previous concerns. Possible values are:
`YES`,
`NO`,
`DK`,
Expand All @@ -2758,7 +2758,7 @@ components:
- DK
- NA
description: >
Current concerns. Options include:
Current concerns. Possible values are:
`YES`,
`NO`,
`DK`,
Expand Down Expand Up @@ -2838,7 +2838,7 @@ components:
- DK
- NA
description: >
Risk of escape/abscond. Options include:
Risk of escape/abscond. Possible values are:
`YES`,
`NO`,
`DK`,
Expand All @@ -2852,7 +2852,7 @@ components:
- DK
- NA
description: >
Risk control issues/disruptive behaviour. Options include:
Risk control issues/disruptive behaviour. Possible values are:
`YES`,
`NO`,
`DK`,
Expand All @@ -2866,7 +2866,7 @@ components:
- DK
- NA
description: >
Risk of breach of trust. Options include:
Risk of breach of trust. Possible values are:
`YES`,
`NO`,
`DK`,
Expand All @@ -2880,7 +2880,7 @@ components:
- DK
- NA
description: >
Risk to other prisoners. Options include:
Risk to other prisoners. Possible values are:
`YES`,
`NO`,
`DK`,
Expand Down
2 changes: 1 addition & 1 deletion .../kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/AdjudicationsGateway.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class AdjudicationsGateway(
data =
result.data
.map { it.toAdjudication() }
.sortedBy { it.incidentDetails?.dateTimeOfIncident },
.sortedByDescending { it.incidentDetails?.dateTimeOfIncident },
)
}

Expand Down
7 changes: 6 additions & 1 deletion ...n/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/AssessRisksAndNeedsGateway.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,12 @@ class AssessRisksAndNeedsGateway(

return when (result) {
is WebClientWrapperResponse.Success -> {
Response(data = result.data.map { it.toRiskPredictorScore() }.sortedBy { it.completedDate })
Response(
data =
result.data
.map { it.toRiskPredictorScore() }
.sortedByDescending { it.completedDate },
)
}

is WebClientWrapperResponse.Error -> {
Expand Down
2 changes: 1 addition & 1 deletion .../uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/CreateAndVaryLicenceGateway.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class CreateAndVaryLicenceGateway(

return when (result) {
is WebClientWrapperResponse.Success -> {
val sortedLicences = result.data.sortedBy { it.createdDateTime }
val sortedLicences = result.data.sortedByDescending { it.createdDateTime }
Response(data = sortedLicences.map { it.toLicence() })
}

Expand Down
8 changes: 4 additions & 4 deletions src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/NomisGateway.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ class NomisGateway(

return when (result) {
is WebClientWrapperResponse.Success -> {
Response(data = result.data.map { it.toAddress() }.sortedBy { it.startDate })
Response(data = result.data.map { it.toAddress() }.sortedByDescending { it.startDate })
}

is WebClientWrapperResponse.Error -> {
Expand All @@ -111,7 +111,7 @@ class NomisGateway(
)
return when (result) {
is WebClientWrapperResponse.Success -> {
Response(data = result.data.map { it.toOffence() }.sortedBy { it.startDate })
Response(data = result.data.map { it.toOffence() }.sortedByDescending { it.startDate })
}

is WebClientWrapperResponse.Error -> {
Expand All @@ -133,7 +133,7 @@ class NomisGateway(
)
return when (result) {
is WebClientWrapperResponse.Success -> {
Response(data = result.data.map { it.toAlert() }.sortedBy { it.dateCreated })
Response(data = result.data.map { it.toAlert() }.sortedByDescending { it.dateCreated })
}

is WebClientWrapperResponse.Error -> {
Expand All @@ -155,7 +155,7 @@ class NomisGateway(
)
return when (result) {
is WebClientWrapperResponse.Success -> {
Response(data = result.data.map { it.toSentence() }.sortedBy { it.dateOfSentencing })
Response(data = result.data.map { it.toSentence() }.sortedByDescending { it.dateOfSentencing })
}

is WebClientWrapperResponse.Error -> {
Expand Down
Loading
Loading