From e7497479a970ad2c2eafacc846276d6adbce69cf Mon Sep 17 00:00:00 2001 From: rchxx <=> Date: Wed, 30 Oct 2024 12:15:42 +0300 Subject: [PATCH 1/5] update DeviceInfo model --- p-healthcheck.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index f87cc2c4..01ac790f 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -34,6 +34,7 @@ components: schemas: DeviceInfo: type: object + required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version] properties: app: type: string @@ -52,6 +53,19 @@ components: type: string version: type: string + documentsDatabase: + type: object + required: [id, version, exportDate, description] + properties: + id: + type: string + version: + type: string + exportDate: + type: string + format: date + description: + type: string example: app: "Regula Document Reader Web API" licenseId: "4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E" @@ -60,3 +74,8 @@ components: licenseValidUntil: "9999-12-31T23:59:59Z" scenarios: ["Mrz", "Barcode", "Locate"] version: "7.5.297907.1721" + documentsDatabase: + id: "FullAuth" + version: "800111" + exportDate: "2024-11-11" + description: "FullAuth: All documents" From c7ecfb33eebef8b01fa6eaa7e349bcba09634d17 Mon Sep 17 00:00:00 2001 From: rchxx <=> Date: Wed, 30 Oct 2024 12:36:31 +0300 Subject: [PATCH 2/5] add nullable property --- p-healthcheck.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index 01ac790f..568a2740 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -40,32 +40,42 @@ components: type: string licenseId: type: string + nullable: true licenseType: type: string + nullable: true licenseSerial: type: string + nullable: true licenseValidUntil: type: string format: date-time + nullable: true scenarios: type: array + nullable: true items: type: string version: type: string + nullable: true documentsDatabase: type: object required: [id, version, exportDate, description] properties: id: type: string + nullable: true version: type: string + nullable: true exportDate: type: string format: date + nullable: true description: type: string + nullable: true example: app: "Regula Document Reader Web API" licenseId: "4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E" From 0c0f0c82f0c30d6c11348545ed1b723bed429506 Mon Sep 17 00:00:00 2001 From: rchxx <=> Date: Fri, 1 Nov 2024 13:35:03 +0300 Subject: [PATCH 3/5] add descriptions --- p-healthcheck.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index 568a2740..1b2b38a2 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -33,47 +33,60 @@ paths: components: schemas: DeviceInfo: + description: TBD type: object required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version] properties: app: + description: (Should be approved) Application name type: string licenseId: + description: (Should be approved) Unique license identifier type: string nullable: true licenseType: + description: (Should be approved) License type type: string nullable: true licenseSerial: + description: (Should be approved) License serial number type: string nullable: true licenseValidUntil: + description: (Should be approved) License validity date type: string format: date-time nullable: true scenarios: + description: (Should be approved) List of supported scenarios type: array nullable: true items: type: string version: + description: (Should be approved) Product version type: string nullable: true documentsDatabase: + description: TBD type: object required: [id, version, exportDate, description] properties: id: + description: (Should be approved) The database identifier type: string nullable: true version: + description: (Should be approved) The database version type: string nullable: true exportDate: + description: (Should be approved) The date of database creation type: string format: date nullable: true description: + description: (Should be approved) The information what database includes, like the list of supported countries and documents type: string nullable: true example: From 24317518b43c46c8211cbbfd511ef9561c38d997 Mon Sep 17 00:00:00 2001 From: rchxx <=> Date: Fri, 1 Nov 2024 13:38:50 +0300 Subject: [PATCH 4/5] update description --- p-healthcheck.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index 1b2b38a2..cc2d6e02 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -33,7 +33,6 @@ paths: components: schemas: DeviceInfo: - description: TBD type: object required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version] properties: From 294dae9ff982fbf34a7dae0f114f6de99e5eb30d Mon Sep 17 00:00:00 2001 From: rchxx <=> Date: Mon, 4 Nov 2024 15:44:30 +0300 Subject: [PATCH 5/5] update docs --- p-healthcheck.yml | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index cc2d6e02..d8d30013 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -11,7 +11,7 @@ paths: - healthcheck responses: 200: - description: "Device info" + description: "Device info." content: application/json: schema: @@ -26,9 +26,9 @@ paths: - healthcheck responses: 200: - description: "License is valid" + description: "The license is valid." 400: - description: "License is not valid" + description: "The license is not valid." components: schemas: @@ -37,55 +37,55 @@ components: required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version] properties: app: - description: (Should be approved) Application name + description: Application name. type: string licenseId: - description: (Should be approved) Unique license identifier + description: Unique license identifier. type: string nullable: true licenseType: - description: (Should be approved) License type + description: License type. type: string nullable: true licenseSerial: - description: (Should be approved) License serial number + description: License serial number. type: string nullable: true licenseValidUntil: - description: (Should be approved) License validity date + description: License validity date. type: string format: date-time nullable: true scenarios: - description: (Should be approved) List of supported scenarios + description: List of supported scenarios. type: array nullable: true items: type: string version: - description: (Should be approved) Product version + description: Product version. type: string nullable: true documentsDatabase: - description: TBD + description: Database information. type: object required: [id, version, exportDate, description] properties: id: - description: (Should be approved) The database identifier + description: Database identifier. type: string nullable: true version: - description: (Should be approved) The database version + description: Database version. type: string nullable: true exportDate: - description: (Should be approved) The date of database creation + description: Date of database creation. type: string format: date nullable: true description: - description: (Should be approved) The information what database includes, like the list of supported countries and documents + description: Description of the database contents, such as the list of supported countries and documents. type: string nullable: true example: