Skip to content

Commit 4a3cab3

Browse files
[SP-18833] Update DeviceInfo model (#205)
* update DeviceInfo model * add nullable property * add descriptions * update description * update docs --------- Co-authored-by: rchxx <=>
1 parent 80522df commit 4a3cab3

File tree

1 file changed

+44
-3
lines changed

1 file changed

+44
-3
lines changed

p-healthcheck.yml

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ paths:
1111
- healthcheck
1212
responses:
1313
200:
14-
description: "Device info"
14+
description: "Device info."
1515
content:
1616
application/json:
1717
schema:
@@ -26,32 +26,68 @@ paths:
2626
- healthcheck
2727
responses:
2828
200:
29-
description: "License is valid"
29+
description: "The license is valid."
3030
400:
31-
description: "License is not valid"
31+
description: "The license is not valid."
3232

3333
components:
3434
schemas:
3535
DeviceInfo:
3636
type: object
37+
required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version]
3738
properties:
3839
app:
40+
description: Application name.
3941
type: string
4042
licenseId:
43+
description: Unique license identifier.
4144
type: string
45+
nullable: true
4246
licenseType:
47+
description: License type.
4348
type: string
49+
nullable: true
4450
licenseSerial:
51+
description: License serial number.
4552
type: string
53+
nullable: true
4654
licenseValidUntil:
55+
description: License validity date.
4756
type: string
4857
format: date-time
58+
nullable: true
4959
scenarios:
60+
description: List of supported scenarios.
5061
type: array
62+
nullable: true
5163
items:
5264
type: string
5365
version:
66+
description: Product version.
5467
type: string
68+
nullable: true
69+
documentsDatabase:
70+
description: Database information.
71+
type: object
72+
required: [id, version, exportDate, description]
73+
properties:
74+
id:
75+
description: Database identifier.
76+
type: string
77+
nullable: true
78+
version:
79+
description: Database version.
80+
type: string
81+
nullable: true
82+
exportDate:
83+
description: Date of database creation.
84+
type: string
85+
format: date
86+
nullable: true
87+
description:
88+
description: Description of the database contents, such as the list of supported countries and documents.
89+
type: string
90+
nullable: true
5591
example:
5692
app: "Regula Document Reader Web API"
5793
licenseId: "4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E"
@@ -60,3 +96,8 @@ components:
6096
licenseValidUntil: "9999-12-31T23:59:59Z"
6197
scenarios: ["Mrz", "Barcode", "Locate"]
6298
version: "7.5.297907.1721"
99+
documentsDatabase:
100+
id: "FullAuth"
101+
version: "800111"
102+
exportDate: "2024-11-11"
103+
description: "FullAuth: All documents"

0 commit comments

Comments
 (0)