From 85de9f3d201541b5c0d95b5f482b30571d74b131 Mon Sep 17 00:00:00 2001 From: AndreiPosohov Date: Tue, 25 Nov 2025 11:51:24 +0300 Subject: [PATCH 1/7] 43841 - update Result, Status, TextFieldType enum --- e-text-field-type.yml | 9 +++++++++ rt-status.yml | 21 +++++++++++++++++++++ rt.yml | 18 ++++++++++++++++++ 3 files changed, 48 insertions(+) diff --git a/e-text-field-type.yml b/e-text-field-type.yml index 944fda2e..71d4b44e 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -654,6 +654,9 @@ components: - 697 - 698 - 699 + - 701 + - 702 + - 703 x-enum-descriptions: - "Document class code" - "Issuing state code" @@ -1304,6 +1307,9 @@ components: - "Nationality code (Alpha-2)" - "First issue date check digit" - "First issue date checksum" + - "Commercial indicator" + - "Non domiciled indicator" + - "Jurisdiction specific data" x-enum-varnames: - "DOCUMENT_CLASS_CODE" - "ISSUING_STATE_CODE" @@ -1954,3 +1960,6 @@ components: - "FT_NATIONALITY_CODE_ALPHA2" - "FT_FIRST_ISSUE_DATE_CHECK_DIGIT" - "FT_FIRST_ISSUE_DATE_CHECKSUM" + - "FT_COMMERCIAL_INDICATOR" + - "FT_NON_DOMICILED_INDICATOR" + - "FT_JURISDICTION_SPECIFIC_DATA" diff --git a/rt-status.yml b/rt-status.yml index b0cd7ed4..40184329 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -35,6 +35,12 @@ components: $ref: "#/components/schemas/detailsRFID" detailsOptical: $ref: "#/components/schemas/detailsOptical" + age: + $ref: "./common.yml#/components/schemas/CheckResult" + detailsAge: + $ref: "#/components/schemas/DetailsAge" + mDL: + $ref: "./common.yml#/components/schemas/CheckResult" detailsOptical: title: "detailsOptical" @@ -97,3 +103,18 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" TA: # Terminal Authentication status $ref: "./common.yml#/components/schemas/CheckResult" + + DetailsAge: + title: "DetailsAge" + description: "Details age" + type: object + properties: + threshold: + description: "Threshold value" + type: string + overThreshold: + $ref: "./common.yml#/components/schemas/CheckResult" + over18: + $ref: "./common.yml#/components/schemas/CheckResult" + over21: + $ref: "./common.yml#/components/schemas/CheckResult" diff --git a/rt.yml b/rt.yml index 3752c531..cf0e6adf 100644 --- a/rt.yml +++ b/rt.yml @@ -47,6 +47,12 @@ components: - 104 - 105 - 109 + - 120 + - 121 + - 122 + - 123 + - 124 + - 125 x-enum-descriptions: - "Contains cropped and rotated with perspective compensation image of document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most of coordinates in other types defined on that image" - "Contains MRZ OCR results" @@ -84,6 +90,12 @@ components: - "Contains RFID binary data" - "Contains RFID original graphics data" - "Digital Travel Credential data" + - "Contains mDL device raw response" + - "Contains mDL device parsed response" + - "Contains mDL server raw response" + - "Contains mDL server parsed response" + - "Contains VDS NC result" + - "Contains VDS result" x-enum-varnames: - "DOCUMENT_IMAGE" - "MRZ_TEXT" @@ -121,6 +133,12 @@ components: - "RFID_BINARY_DATA" - "RFID_ORIGINAL_GRAPHICS" - "DTC_VC" + - "MDL_DEVICE_RAW_RESPONSE" + - "MDL_DEVICE_PARSED_RESPONSE" + - "MDL_SERVER_RAW_RESPONSE" + - "MDL_SERVER_PARSED_RESPONSE" + - "VDS_NC_RESULT" + - "VDS_RESULT" ResultItem: title: "ResultItem" From d6e3dc3a2e59b4538ace2f403624ab4a0b30a582 Mon Sep 17 00:00:00 2001 From: AndreiPosohov Date: Tue, 25 Nov 2025 11:53:26 +0300 Subject: [PATCH 2/7] 43841 - add new enums MDLDeviceEngagement, MDLDeviceRetrieval, MDLServerRetrieval --- common.yml | 42 ++++++++++++++++++++++++++++++++++++++++++ index.yml | 6 ++++++ 2 files changed, 48 insertions(+) diff --git a/common.yml b/common.yml index 9e834cbc..ef0bb735 100644 --- a/common.yml +++ b/common.yml @@ -518,3 +518,45 @@ components: format: float description: "The maximum allowable part of the area occupied by the glare. The same: 0.06 = 6%" example: 0.0 + + MDLDeviceEngagement: + type: integer + description: "Device engagement" + enum: + - 0 + - 1 + x-enum-descriptions: + - "mDL DE QR" + - "mDL DE NFC" + x-enum-varnames: + - "MDLDE_QR" + - "MDLDE_NFC" + + MDLDeviceRetrieval: + type: integer + description: "Device retrieval" + enum: + - 1 + - 2 + - 3 + x-enum-descriptions: + - "mDL DR NFC" + - "mDL DR BLE" + - "mDL DR WiFi Aware" + x-enum-varnames: + - "MDLDR_NFC" + - "MDLDR_BLE" + - "MDLDR_WIFI_AVARE" + + MDLServerRetrieval: + type: integer + description: "Server retrieval" + enum: + - 0 + - 1 + x-enum-descriptions: + - "mDL SR WebAPI" + - "mDL SR OIDC" + x-enum-varnames: + - "MDLSR_WEBAPI" + - "MDLSR_OIDC" \ No newline at end of file diff --git a/index.yml b/index.yml index 38fc75bb..dfc4d176 100644 --- a/index.yml +++ b/index.yml @@ -87,3 +87,9 @@ components: $ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType" ParsingErrorCodes: $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + MDLDeviceEngagement: + $ref: "./common.yml#/components/schemas/MDLDeviceEngagement" + MDLDeviceRetrieval: + $ref: "./common.yml#/components/schemas/MDLDeviceRetrieval" + MDLServerRetrieval: + $ref: "./common.yml#/components/schemas/MDLServerRetrieval" From dd57f2fb24c5892c184bd5da55a7c97b5ac954ca Mon Sep 17 00:00:00 2001 From: AndreiPosohov Date: Tue, 25 Nov 2025 13:26:08 +0300 Subject: [PATCH 3/7] 43841 - remove descriptions and change enum varnames --- common.yml | 30 ++++++++++-------------------- rt-status.yml | 2 -- rt.yml | 8 ++++---- 3 files changed, 14 insertions(+), 26 deletions(-) diff --git a/common.yml b/common.yml index ef0bb735..a4901a22 100644 --- a/common.yml +++ b/common.yml @@ -520,43 +520,33 @@ components: example: 0.0 MDLDeviceEngagement: + title: "MDLDeviceEngagement" type: integer - description: "Device engagement" enum: - 0 - 1 - x-enum-descriptions: - - "mDL DE QR" - - "mDL DE NFC" x-enum-varnames: - - "MDLDE_QR" - - "MDLDE_NFC" + - "QR" + - "NFC" MDLDeviceRetrieval: + title: "MDLDeviceRetrieval" type: integer - description: "Device retrieval" enum: - 1 - 2 - 3 - x-enum-descriptions: - - "mDL DR NFC" - - "mDL DR BLE" - - "mDL DR WiFi Aware" x-enum-varnames: - - "MDLDR_NFC" - - "MDLDR_BLE" - - "MDLDR_WIFI_AVARE" + - "NFC" + - "BLE" + - "WIFI_AVARE" MDLServerRetrieval: + title: "MDLServerRetrieval" type: integer - description: "Server retrieval" enum: - 0 - 1 - x-enum-descriptions: - - "mDL SR WebAPI" - - "mDL SR OIDC" x-enum-varnames: - - "MDLSR_WEBAPI" - - "MDLSR_OIDC" \ No newline at end of file + - "WEB_API" + - "OIDC" \ No newline at end of file diff --git a/rt-status.yml b/rt-status.yml index 40184329..66cd8552 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -106,11 +106,9 @@ components: DetailsAge: title: "DetailsAge" - description: "Details age" type: object properties: threshold: - description: "Threshold value" type: string overThreshold: $ref: "./common.yml#/components/schemas/CheckResult" diff --git a/rt.yml b/rt.yml index cf0e6adf..5be323e8 100644 --- a/rt.yml +++ b/rt.yml @@ -94,8 +94,8 @@ components: - "Contains mDL device parsed response" - "Contains mDL server raw response" - "Contains mDL server parsed response" - - "Contains VDS NC result" - - "Contains VDS result" + - "Contains result of VDS NC" + - "Contains result of VDS" x-enum-varnames: - "DOCUMENT_IMAGE" - "MRZ_TEXT" @@ -137,8 +137,8 @@ components: - "MDL_DEVICE_PARSED_RESPONSE" - "MDL_SERVER_RAW_RESPONSE" - "MDL_SERVER_PARSED_RESPONSE" - - "VDS_NC_RESULT" - - "VDS_RESULT" + - "VDS_NC" + - "VDS" ResultItem: title: "ResultItem" From 4f89372b555f718fd925244d60fad71dc2d83f1e Mon Sep 17 00:00:00 2001 From: AndreiPosohov Date: Wed, 26 Nov 2025 14:08:08 +0300 Subject: [PATCH 4/7] 43841 - add required fields in Status and DetailsAge --- rt-status.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/rt-status.yml b/rt-status.yml index 66cd8552..bca2881d 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -20,6 +20,9 @@ components: - rfid - stopList - detailsOptical + - age + - detailsAge + - mDL properties: overallStatus: # Overall checks status. Rootx status $ref: "./common.yml#/components/schemas/CheckResult" @@ -107,6 +110,11 @@ components: DetailsAge: title: "DetailsAge" type: object + required: + - threshold + - overThreshold + - over18 + - over21 properties: threshold: type: string From 51d393b700a8e9024d8cac8b7e4dfea8541b1e31 Mon Sep 17 00:00:00 2001 From: AndreiPosohov Date: Tue, 2 Dec 2025 11:30:52 +0300 Subject: [PATCH 5/7] 43841 - add keys in DetailsAge --- rt-status.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/rt-status.yml b/rt-status.yml index bca2881d..75bc36b7 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -115,6 +115,8 @@ components: - overThreshold - over18 - over21 + - over25 + - over65 properties: threshold: type: string @@ -124,3 +126,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" over21: $ref: "./common.yml#/components/schemas/CheckResult" + over25: + $ref: "./common.yml#/components/schemas/CheckResult" + over65: + $ref: "./common.yml#/components/schemas/CheckResult" From e2c73765631821908581ec9636a898373502618b Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Tue, 2 Dec 2025 14:50:02 +0300 Subject: [PATCH 6/7] 43841 - add API_BASE_PATH env --- .github/workflows/verify-clients.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/verify-clients.yml b/.github/workflows/verify-clients.yml index 2833d91d..d624414a 100644 --- a/.github/workflows/verify-clients.yml +++ b/.github/workflows/verify-clients.yml @@ -24,6 +24,8 @@ jobs: - name: Verify update Python client working-directory: python-client + env: + API_BASE_PATH: ${{ github.base_ref == 'develop' && 'https://nightly-api.regulaforensics.com' || 'https://rc-api.regulaforensics.com' }} run: | ./update-models.sh strict ./setup.sh @@ -44,6 +46,8 @@ jobs: - name: Verify update CSharp client working-directory: csharp-client + env: + API_BASE_PATH: ${{ github.base_ref == 'develop' && 'https://nightly-api.regulaforensics.com' || 'https://rc-api.regulaforensics.com' }} run: | ./update-models.sh strict ./setup.sh @@ -91,6 +95,8 @@ jobs: - name: Verify update Java client working-directory: java-client + env: + API_BASE_PATH: ${{ github.base_ref == 'develop' && 'https://nightly-api.regulaforensics.com' || 'https://rc-api.regulaforensics.com' }} run: | ./update-models.sh strict ./gradlew clean :example:run From 02c0c70d3bcc44407fdec0a3275615b07e413899 Mon Sep 17 00:00:00 2001 From: Artsiom Tsybulko Date: Fri, 5 Dec 2025 15:41:42 +0300 Subject: [PATCH 7/7] 43841 - update DetailsAge --- rt-status.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rt-status.yml b/rt-status.yml index 75bc36b7..654c4541 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -119,7 +119,7 @@ components: - over65 properties: threshold: - type: string + type: integer overThreshold: $ref: "./common.yml#/components/schemas/CheckResult" over18: