From 356e3cfe5f9e7da2d3f304c71d3d97d91b9e5288 Mon Sep 17 00:00:00 2001 From: Marcus Aspin Date: Wed, 1 Nov 2023 16:35:01 +0000 Subject: [PATCH] Document fields in officer-view endpoint (#2482) --- .../uk/gov/justice/digital/hmpps/api/model/OfficerView.kt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/projects/workforce-allocations-to-delius/src/main/kotlin/uk/gov/justice/digital/hmpps/api/model/OfficerView.kt b/projects/workforce-allocations-to-delius/src/main/kotlin/uk/gov/justice/digital/hmpps/api/model/OfficerView.kt index 50421299b2..1f5149d59f 100644 --- a/projects/workforce-allocations-to-delius/src/main/kotlin/uk/gov/justice/digital/hmpps/api/model/OfficerView.kt +++ b/projects/workforce-allocations-to-delius/src/main/kotlin/uk/gov/justice/digital/hmpps/api/model/OfficerView.kt @@ -1,11 +1,16 @@ package uk.gov.justice.digital.hmpps.api.model +import io.swagger.v3.oas.annotations.media.Schema + data class OfficerView( val code: String, val name: Name, val grade: String?, val email: String?, + @field:Schema(description = "The number of sentenced events with an end date in the next four weeks on cases managed by the officer.") val casesDueToEndInNext4Weeks: Long, + @field:Schema(description = "The number of sentenced custodial events with an \"Expected Release Date\" key date in the next four weeks on cases managed by the officer.") val releasesWithinNext4Weeks: Long, + @field:Schema(description = "The number of parole reports required in the next four weeks on cases managed by the officer.") val paroleReportsToCompleteInNext4Weeks: Long )