Skip to content

Commit f71195e

Browse files
Edit api spec (#417)
* Editing API spec * Changing Open api spec * Edit
1 parent 23eb262 commit f71195e

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

openapi.yml

+41-1
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ paths:
9595
schema:
9696
type: object
9797
properties:
98+
data:
9899
prisonerOffenderSearch:
99100
$ref: "#/components/schemas/Person"
100101
probationOffenderSearch:
@@ -1721,7 +1722,7 @@ components:
17211722
Person:
17221723
type: object
17231724
properties:
1724-
data:
1725+
prisonerOffenderSearch:
17251726
type: object
17261727
properties:
17271728
firstName:
@@ -1760,6 +1761,45 @@ components:
17601761
description: Hmpps identifier
17611762
contactDetails:
17621763
$ref: "#/components/schemas/ContactDetails"
1764+
probationOffenderSearch:
1765+
type: object
1766+
properties:
1767+
firstName:
1768+
type: string
1769+
description: First name
1770+
lastName:
1771+
type: string
1772+
description: Last name
1773+
middleName:
1774+
type: string
1775+
nullable: true
1776+
description: Middle name
1777+
dateOfBirth:
1778+
type: string
1779+
format: date
1780+
description: Date of birth
1781+
gender:
1782+
type: string
1783+
description: Gender
1784+
ethnicity:
1785+
type: string
1786+
nullable: true
1787+
description: Ethnicity
1788+
aliases:
1789+
type: array
1790+
items:
1791+
$ref: "#/components/schemas/Alias"
1792+
description: List of aliases
1793+
identifiers:
1794+
$ref: "#/components/schemas/Identifiers"
1795+
pncId:
1796+
type: string
1797+
description: An identifier from the Police National Computer (PNC)
1798+
hmppsId:
1799+
type: string
1800+
description: Hmpps identifier
1801+
contactDetails:
1802+
$ref: "#/components/schemas/ContactDetails"
17631803
PersonResponsibleOfficerName:
17641804
type: object
17651805
properties:

0 commit comments

Comments
 (0)