Skip to content

Commit 60836e4

Browse files
Added extra fields
1 parent 4a97cc1 commit 60836e4

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/InductionSchedule.kt

+18-6
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ import java.time.LocalDate
1616
data class InductionSchedules(
1717
@Schema(
1818
description = """
19-
A list of induction schedule versions for this prisoner. The prisoner will only have one induction schedule but for various reasons the schedule can be updated.
19+
A list of induction schedule versions for this prisoner.
20+
The prisoner will only have one induction schedule but for various reasons the schedule can be updated.
2021
This list will show each change the schedule has been through. This allows for reports to be generated.
2122
""",
2223
)
@@ -78,7 +79,8 @@ data class InductionSchedule(
7879
)
7980
val nomisNumber: String? = null,
8081
@Schema(
81-
description = "The name of the person who used the PLP system to update the Induction Schedule, or 'system' for system generated updates.",
82+
description = "The name of the person who used the PLP system to update the Induction Schedule, " +
83+
"or 'system' for system generated updates.",
8284
example = "John Smith",
8385
)
8486
val systemUpdatedBy: String? = null,
@@ -88,17 +90,26 @@ data class InductionSchedule(
8890
)
8991
val systemUpdatedAt: Instant? = null,
9092
@Schema(
91-
description = "The name of the person who performed the Induction with the prisoner. In the case of system generated updates or setting an exemption this field will not be present.",
93+
description = """
94+
The name of the person who performed the Induction with the prisoner.
95+
In the case of system generated updates or setting an exemption this field will not be present.
96+
""",
9297
example = "Fred Jones",
9398
)
9499
val inductionPerformedBy: String? = null,
95100
@Schema(
96-
description = "An ISO-8601 date representing when the Induction was performed with the prisoner. In the case of system generated updates this field will not be present.",
101+
description = """
102+
An ISO-8601 date representing when the Induction was performed with the prisoner.
103+
In the case of system generated updates this field will not be present.
104+
""",
97105
example = "2023-06-30",
98106
)
99107
val inductionPerformedAt: LocalDate? = null,
100108
@Schema(
101-
description = "The role of the person who performed the Induction with the prisoner. In the case of system generated updates or setting an exemption this field will not be present.",
109+
description = """
110+
The role of the person who performed the Induction with the prisoner.
111+
In the case of system generated updates or setting an exemption this field will not be present.
112+
""",
102113
example = "Peer Mentor",
103114
)
104115
val inductionPerformedByRole: String? = null,
@@ -116,7 +127,8 @@ data class InductionSchedule(
116127
description = """
117128
The induction schedule can change status numerous times.
118129
When looking at the plp-induction-schedule/history of the inductions.
119-
The version number indicates which version of the induction schedule this one is, the higher the number the newer the update.
130+
The version number indicates which version of the induction schedule this one is,
131+
the higher the number the newer the update.
120132
""",
121133
)
122134
val version: Int? = null,

0 commit comments

Comments
 (0)