Skip to content

Commit a3e09d4

Browse files
Change open-api (#410)
* GetPerson service - added another method * Controller code and smoke test * Adding data to test response * Fixed import * Changes in Person open-api to reflect new schema * Rekicking pipeline * Rekick pipeline * Changing open api * Changed response structure.
1 parent 1da751c commit a3e09d4

File tree

1 file changed

+46
-45
lines changed

1 file changed

+46
-45
lines changed

openapi.yml

+46-45
Original file line numberDiff line numberDiff line change
@@ -1719,50 +1719,13 @@ components:
17191719
Person:
17201720
type: object
17211721
properties:
1722-
firstName:
1723-
type: string
1724-
example: Arthur
1725-
description: first name
1726-
middleName:
1727-
type: string
1728-
example: John
1729-
nullable: true
1730-
description: middle name
1731-
lastName:
1732-
type: string
1733-
example: Morgan
1734-
description: last name
1735-
dateOfBirth:
1736-
type: string
1737-
format: date
1738-
example: 1965-12-01
1739-
description: date of birth
1740-
gender:
1741-
type: string
1742-
example: Male
1743-
description: gender
1744-
ethnicity:
1745-
type: string
1746-
example: "White: Eng./Welsh/Scot./N.Irish/British"
1747-
description: ethnicity
1748-
aliases:
1749-
type: array
1750-
minItems: 0
1751-
items:
1752-
$ref: "#/components/schemas/Alias"
1753-
description: list of aliases
1754-
identifiers:
1755-
$ref: "#/components/schemas/Identifiers"
1756-
pncId:
1757-
type: string
1758-
example: 2008/0545166T
1759-
description: An identifier from the Police National Computer (PNC)
1760-
hmppsId:
1761-
type: string
1762-
example: X00001
1763-
description: Currently a hmppsId is a CRN identifier however this will change in the future to be a new unique Hmpps identifier
1764-
contactDetails:
1765-
$ref: "#/components/schemas/ContactDetails"
1722+
data:
1723+
type: object
1724+
properties:
1725+
prisonerOffenderSearch:
1726+
$ref: "#/components/schemas/OffenderSearch"
1727+
probationOffenderSearch:
1728+
$ref: "#/components/schemas/OffenderSearch"
17661729
PersonResponsibleOfficerName:
17671730
type: object
17681731
properties:
@@ -1902,7 +1865,45 @@ components:
19021865
nullable: true
19031866
prison:
19041867
$ref: "#/components/schemas/Prison"
1905-
1868+
OffenderSearch:
1869+
type: object
1870+
properties:
1871+
firstName:
1872+
type: string
1873+
description: First name
1874+
lastName:
1875+
type: string
1876+
description: Last name
1877+
middleName:
1878+
type: string
1879+
nullable: true
1880+
description: Middle name
1881+
dateOfBirth:
1882+
type: string
1883+
format: date
1884+
description: Date of birth
1885+
gender:
1886+
type: string
1887+
description: Gender
1888+
ethnicity:
1889+
type: string
1890+
nullable: true
1891+
description: Ethnicity
1892+
aliases:
1893+
type: array
1894+
items:
1895+
$ref: "#/components/schemas/Alias"
1896+
description: List of aliases
1897+
identifiers:
1898+
$ref: "#/components/schemas/Identifiers"
1899+
pncId:
1900+
type: string
1901+
description: An identifier from the Police National Computer (PNC)
1902+
hmppsId:
1903+
type: string
1904+
description: Hmpps identifier
1905+
contactDetails:
1906+
$ref: "#/components/schemas/ContactDetails"
19061907
Punishment:
19071908
type: object
19081909
properties:

0 commit comments

Comments
 (0)