Skip to content

Commit 294dae9

Browse files
author
rchxx
committed
update docs
1 parent 2431751 commit 294dae9

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

p-healthcheck.yml

Lines changed: 15 additions & 15 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,9 +26,9 @@ 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:
@@ -37,55 +37,55 @@ components:
3737
required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version]
3838
properties:
3939
app:
40-
description: (Should be approved) Application name
40+
description: Application name.
4141
type: string
4242
licenseId:
43-
description: (Should be approved) Unique license identifier
43+
description: Unique license identifier.
4444
type: string
4545
nullable: true
4646
licenseType:
47-
description: (Should be approved) License type
47+
description: License type.
4848
type: string
4949
nullable: true
5050
licenseSerial:
51-
description: (Should be approved) License serial number
51+
description: License serial number.
5252
type: string
5353
nullable: true
5454
licenseValidUntil:
55-
description: (Should be approved) License validity date
55+
description: License validity date.
5656
type: string
5757
format: date-time
5858
nullable: true
5959
scenarios:
60-
description: (Should be approved) List of supported scenarios
60+
description: List of supported scenarios.
6161
type: array
6262
nullable: true
6363
items:
6464
type: string
6565
version:
66-
description: (Should be approved) Product version
66+
description: Product version.
6767
type: string
6868
nullable: true
6969
documentsDatabase:
70-
description: TBD
70+
description: Database information.
7171
type: object
7272
required: [id, version, exportDate, description]
7373
properties:
7474
id:
75-
description: (Should be approved) The database identifier
75+
description: Database identifier.
7676
type: string
7777
nullable: true
7878
version:
79-
description: (Should be approved) The database version
79+
description: Database version.
8080
type: string
8181
nullable: true
8282
exportDate:
83-
description: (Should be approved) The date of database creation
83+
description: Date of database creation.
8484
type: string
8585
format: date
8686
nullable: true
8787
description:
88-
description: (Should be approved) The information what database includes, like the list of supported countries and documents
88+
description: Description of the database contents, such as the list of supported countries and documents.
8989
type: string
9090
nullable: true
9191
example:

0 commit comments

Comments
 (0)