Skip to content

Commit

Permalink
Deploying to gh-pages from @ 9f0de37 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
marcus-bcl committed Dec 17, 2024
1 parent 0bcfda5 commit b97cd78
Showing 6 changed files with 785 additions and 395 deletions.

Large diffs are not rendered by default.

242 changes: 176 additions & 66 deletions tech-docs/projects/manage-supervision-and-delius/api-docs.yaml
Original file line number Diff line number Diff line change
@@ -125,6 +125,25 @@ paths:
responses:
"200":
description: OK
/user/{username}/locations:
get:
tags:
- Locations
summary: Display user locations
operationId: getUserOfficeLocations
parameters:
- name: username
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/UserOfficeLocation"
/user/{username}/access/{crn}:
get:
tags:
@@ -148,12 +167,36 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CaseAccess"
/sentences/{crn}:
get:
tags:
- Sentences
summary: Display active events
operationId: getOverview
parameters:
- name: crn
in: path
required: true
schema:
type: string
- name: number
in: query
required: false
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/MinimalSentenceOverview"
/sentence/{crn}:
get:
tags:
- Sentence
summary: Display active events
operationId: getOverview
operationId: getOverview_1
parameters:
- name: crn
in: path
@@ -560,7 +603,7 @@ paths:
- Overview
summary: "MAS Overview containing Personal Details, Activity, Compliance, Schedule,\
\ Orders and Sentences "
operationId: getOverview_1
operationId: getOverview_2
parameters:
- name: crn
in: path
@@ -910,14 +953,15 @@ components:
format: date-time
User:
required:
- team
- locationId
- username
type: object
properties:
username:
type: string
team:
type: string
locationId:
type: integer
format: int64
AppointmentDetail:
required:
- appointments
@@ -953,6 +997,133 @@ components:
type: boolean
notes:
type: string
Address:
type: object
properties:
buildingNumber:
type: string
streetName:
type: string
town:
type: string
county:
type: string
postcode:
type: string
LocationDetails:
required:
- address
- description
- id
type: object
properties:
id:
type: integer
format: int64
description:
type: string
address:
$ref: "#/components/schemas/Address"
UserOfficeLocation:
required:
- locations
- name
type: object
properties:
name:
$ref: "#/components/schemas/Name"
locations:
type: array
items:
$ref: "#/components/schemas/LocationDetails"
MinimalLicenceCondition:
required:
- id
- mainDescription
type: object
properties:
id:
type: integer
format: int64
mainDescription:
type: string
MinimalOrder:
required:
- description
- startDate
type: object
properties:
description:
type: string
startDate:
type: string
format: date
endDate:
type: string
format: date
MinimalRequirement:
required:
- description
- id
type: object
properties:
id:
type: integer
format: int64
description:
type: string
MinimalSentence:
required:
- id
- licenceConditions
- requirements
type: object
properties:
id:
type: integer
format: int64
order:
$ref: "#/components/schemas/MinimalOrder"
licenceConditions:
type: array
items:
$ref: "#/components/schemas/MinimalLicenceCondition"
requirements:
type: array
items:
$ref: "#/components/schemas/MinimalRequirement"
MinimalSentenceOverview:
required:
- personSummary
- sentences
type: object
properties:
personSummary:
$ref: "#/components/schemas/PersonSummary"
sentences:
type: array
items:
$ref: "#/components/schemas/MinimalSentence"
PersonSummary:
required:
- crn
- dateOfBirth
- name
- offenderId
type: object
properties:
name:
$ref: "#/components/schemas/Name"
crn:
type: string
offenderId:
type: integer
format: int64
pnc:
type: string
dateOfBirth:
type: string
format: date
AdditionalSentence:
required:
- description
@@ -1097,26 +1268,6 @@ components:
breaches:
type: integer
format: int32
PersonSummary:
required:
- crn
- dateOfBirth
- name
- offenderId
type: object
properties:
name:
$ref: "#/components/schemas/Name"
crn:
type: string
offenderId:
type: integer
format: int64
pnc:
type: string
dateOfBirth:
type: string
format: date
Rar:
required:
- completed
@@ -1572,47 +1723,6 @@ components:
$ref: "#/components/schemas/PersonSummary"
riskFlag:
$ref: "#/components/schemas/RiskFlag"
Address:
required:
- from
- lastUpdatedBy
type: object
properties:
buildingName:
type: string
buildingNumber:
type: string
streetName:
type: string
district:
type: string
town:
type: string
county:
type: string
postcode:
type: string
telephoneNumber:
type: string
from:
type: string
format: date
to:
type: string
format: date
verified:
type: boolean
lastUpdated:
type: string
format: date
lastUpdatedBy:
$ref: "#/components/schemas/Name"
type:
type: string
status:
type: string
notes:
type: string
Circumstances:
required:
- circumstances
Loading

0 comments on commit b97cd78

Please sign in to comment.