Skip to content

Commit

Permalink
Deploying to gh-pages from @ 7984fb3 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
marcus-bcl committed Mar 29, 2024
1 parent fd02e85 commit 40dd3a9
Show file tree
Hide file tree
Showing 10 changed files with 753 additions and 139 deletions.

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions tech-docs/projects/approved-premises-and-delius/api-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -632,15 +632,15 @@ components:
type: array
items:
$ref: '#/components/schemas/SortObject'
first:
type: boolean
last:
type: boolean
numberOfElements:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/PageableObject'
first:
type: boolean
last:
type: boolean
empty:
type: boolean
PageableObject:
Expand Down
24 changes: 12 additions & 12 deletions tech-docs/projects/approved-premises-and-delius/api-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -1068,6 +1068,8 @@ <h4 id="approved-premises-code-staff-get-responses">Responses</h4>
"ignoreCase": "boolean"
}
],
"first": "boolean",
"last": "boolean",
"numberOfElements": "integer",
"pageable": {
"offset": "integer",
Expand All @@ -1085,8 +1087,6 @@ <h4 id="approved-premises-code-staff-get-responses">Responses</h4>
"paged": "boolean",
"unpaged": "boolean"
},
"first": "boolean",
"last": "boolean",
"empty": "boolean"
}</code></pre>

Expand Down Expand Up @@ -2199,8 +2199,8 @@ <h3 id="schema-pagestaffresponse">PageStaffResponse</h3>
</tr>

<tr>
<td>numberOfElements</td>
<td>integer</td>
<td>first</td>
<td>boolean</td>
<td>false</td>
<td></td>
<td>
Expand All @@ -2209,18 +2209,18 @@ <h3 id="schema-pagestaffresponse">PageStaffResponse</h3>
</tr>

<tr>
<td>pageable</td>
<td>object</td>
<td>last</td>
<td>boolean</td>
<td>false</td>
<td></td>
<td>
<a href='#schema-pageableobject'>PageableObject</a>

</td>
</tr>

<tr>
<td>first</td>
<td>boolean</td>
<td>numberOfElements</td>
<td>integer</td>
<td>false</td>
<td></td>
<td>
Expand All @@ -2229,12 +2229,12 @@ <h3 id="schema-pagestaffresponse">PageStaffResponse</h3>
</tr>

<tr>
<td>last</td>
<td>boolean</td>
<td>pageable</td>
<td>object</td>
<td>false</td>
<td></td>
<td>

<a href='#schema-pageableobject'>PageableObject</a>
</td>
</tr>

Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

139 changes: 112 additions & 27 deletions tech-docs/projects/manage-supervision-and-delius/api-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ paths:
/schedule/{crn}/upcoming:
get:
tags:
- Sentence
- Schedule
summary: 'Gets upcoming schedule information’ '
operationId: getUpcomingSchedule
parameters:
Expand All @@ -55,7 +55,7 @@ paths:
/schedule/{crn}/previous:
get:
tags:
- Sentence
- Schedule
summary: 'Gets previous schedule information’ '
operationId: getPreviousSchedule
parameters:
Expand All @@ -74,7 +74,7 @@ paths:
/schedule/{crn}/appointment/{contactId}:
get:
tags:
- Sentence
- Schedule
summary: 'Gets individual appointment information’ '
operationId: getContact
parameters:
Expand Down Expand Up @@ -279,6 +279,25 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Overview'
/activity/{crn}:
get:
tags:
- Activity
summary: 'Gets all activity for a person’ '
operationId: getPersonActivity
parameters:
- name: crn
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PersonActivity'
components:
schemas:
AdditionalSentence:
Expand Down Expand Up @@ -354,15 +373,69 @@ components:
type: array
items:
$ref: '#/components/schemas/Offence'
Order:
required:
- description
- startDate
type: object
properties:
description:
type: string
length:
type: integer
format: int64
endDate:
type: string
format: date
startDate:
type: string
format: date
Rar:
required:
- completed
- scheduled
- totalDays
type: object
properties:
completed:
type: integer
format: int32
scheduled:
type: integer
format: int32
totalDays:
type: integer
format: int32
Requirement:
type: object
properties:
description:
type: string
codeDescription:
type: string
length:
type: integer
format: int64
notes:
type: string
rar:
$ref: '#/components/schemas/Rar'
Sentence:
required:
- offenceDetails
- requirements
type: object
properties:
offenceDetails:
$ref: '#/components/schemas/OffenceDetails'
conviction:
$ref: '#/components/schemas/Conviction'
order:
$ref: '#/components/schemas/Order'
requirements:
type: array
items:
$ref: '#/components/schemas/Requirement'
SentenceOverview:
required:
- name
Expand All @@ -375,16 +448,19 @@ components:
type: array
items:
$ref: '#/components/schemas/Sentence'
Appointment:
Activity:
required:
- documents
- hasOutcome
- id
- isAppointment
- isInitial
- isNationalStandard
- lastUpdated
- lastUpdatedBy
- rescheduled
- rescheduledPop
- rescheduledStaff
- startDateTime
- type
type: object
Expand Down Expand Up @@ -420,6 +496,10 @@ components:
$ref: '#/components/schemas/OfficeAddress'
rescheduled:
type: boolean
rescheduledStaff:
type: boolean
rescheduledPop:
type: boolean
didTheyComply:
type: boolean
absentWaitingEvidence:
Expand All @@ -442,6 +522,20 @@ components:
type: boolean
acceptableAbsenceReason:
type: string
isAppointment:
type: boolean
action:
type: string
isSystemContact:
type: boolean
isEmailOrTextFromPop:
type: boolean
isPhoneCallFromPop:
type: boolean
isEmailOrTextToPop:
type: boolean
isPhoneCallToPop:
type: boolean
lastUpdated:
type: string
format: date-time
Expand All @@ -463,7 +557,6 @@ components:
OfficeAddress:
required:
- ldu
- officeName
type: object
properties:
officeName:
Expand Down Expand Up @@ -517,7 +610,7 @@ components:
appointments:
type: array
items:
$ref: '#/components/schemas/Appointment'
$ref: '#/components/schemas/Activity'
PersonAppointment:
required:
- appointment
Expand All @@ -527,7 +620,7 @@ components:
personSummary:
$ref: '#/components/schemas/PersonSummary'
appointment:
$ref: '#/components/schemas/Appointment'
$ref: '#/components/schemas/Activity'
Address:
required:
- from
Expand Down Expand Up @@ -875,26 +968,6 @@ components:
type: array
items:
$ref: '#/components/schemas/Address'
Activity:
required:
- acceptableAbsences
- complied
- nationalStandardsAppointments
- rescheduled
type: object
properties:
acceptableAbsences:
type: integer
format: int32
complied:
type: integer
format: int32
nationalStandardsAppointments:
type: integer
format: int32
rescheduled:
type: integer
format: int32
Compliance:
required:
- currentBreaches
Expand Down Expand Up @@ -954,6 +1027,18 @@ components:
count:
type: integer
format: int32
PersonActivity:
required:
- activities
- personSummary
type: object
properties:
personSummary:
$ref: '#/components/schemas/PersonSummary'
activities:
type: array
items:
$ref: '#/components/schemas/Activity'
securitySchemes:
hmpps-auth-token:
type: http
Expand Down
Loading

0 comments on commit 40dd3a9

Please sign in to comment.