From 214c8896aa7b245799dc037710cbb29b0a111173 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 11 Oct 2024 14:55:22 +0300 Subject: [PATCH 001/106] SP-18211 - update schemas, bug fix --- README.md | 6 +- authenticity/e-check-diagnose.yml | 1 + authenticity/e-critical.yml | 1 + authenticity/e-result-type.yml | 16 + authenticity/e-visibility.yml | 1 + authenticity/rt-fiber.yml | 13 +- authenticity/rt-ident.yml | 11 +- authenticity/rt-ocr-security-text.yml | 17 +- authenticity/rt-photo-ident.yml | 18 +- authenticity/rt-security-feature.yml | 10 +- common.yml | 160 ++- e-barcode-type.yml | 42 +- e-document-type.yml | 1 + e-graphic-field-type.yml | 6 + e-lcid.yml | 28 +- e-parsing-error-codes.yml | 253 ++--- e-parsing-notification-codes.yml | 445 ++++---- e-rfid-data-file-type.yml | 184 ++++ e-rfid-data-group-type-tag.yml | 177 ++++ e-rfid-error-codes.yml | 229 ++--- e-security-feature-type.yml | 1 + e-text-field-type.yml | 3 +- index.yml | 16 +- p-ping.yml | 4 + p-process.yml | 127 ++- p-transaction.yml | 83 +- rt-authenticity.yml | 74 +- rt-barcodes.yml | 76 +- rt-doc-type-old.yml | 47 +- rt-document-position.yml | 20 +- rt-encrypted-rcl.yml | 3 +- rt-image-data.yml | 70 +- rt-image-quality.yml | 32 +- rt-images.yml | 25 +- rt-license.yml | 3 +- ...nalisis.yml => rt-ocr-lexical-analysis.yml | 20 +- rt-raw-image.yml | 23 +- rt-rfid-binary-data.yml | 956 ++++++++++++++++++ rt-status.yml | 11 +- rt-text-data.yml | 101 +- rt-text.yml | 28 +- rt.yml | 125 +-- 42 files changed, 2634 insertions(+), 833 deletions(-) create mode 100644 e-rfid-data-file-type.yml create mode 100644 e-rfid-data-group-type-tag.yml rename rt-ocr-lexical-analisis.yml => rt-ocr-lexical-analysis.yml (88%) create mode 100644 rt-rfid-binary-data.yml diff --git a/README.md b/README.md index af81f61..68d8f7d 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,7 @@ docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate - ## Building Redoc single page html documentation -Edit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node - -Edit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator** - -Then run next command: +Run next command: ``` npx redoc-cli bundle "$PWD/index.yml" --output document-reader-static-doc.html \ --options.maxDisplayedEnumValues=5 --options.theme.logo.gutter="20px" \ diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 20be320..37d35f2 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: CheckDiagnose: + title: "CheckDiagnose" type: integer description: "Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/" enum: diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml index eac10bd..f2f621c 100644 --- a/authenticity/e-critical.yml +++ b/authenticity/e-critical.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: Critical: + title: "Critical" type: integer description: "Enumeration contains identifiers determining the criticality of the security element" enum: diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index e747e8f..8017b3e 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -2,9 +2,11 @@ openapi: 3.0.3 components: schemas: AuthenticityResultType: + title: "AuthenticityResultType" type: integer description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/." enum: + - 0 - 1 - 2 - 4 @@ -13,10 +15,13 @@ components: - 32 - 64 - 128 + - 256 - 512 - 1024 + - 2048 - 4096 - 8192 + - 16384 - 32768 - 65536 - 131072 @@ -27,7 +32,9 @@ components: - 4194304 - 8388608 - 16777216 + - 2147483648 x-enum-descriptions: + - "No authenticity control procedure" - "Document luminescence check in UV light" - "B900 ink MRZ contrast check in IR light" - "Image patterns presence/absence check (position, shape, color)" @@ -36,10 +43,13 @@ components: - "Document elements visibility check in IR light" - "OCR for the text field in UV light comparison with other text sources check" - "Invisible Personal Information (IPI) visualization" + - "Document photo check in IR light" - "Owner's photo embedding check (is photo printed or sticked)" - "OVI check" + - "IR luminescence check" - "Hologram presence check" - "Owner's photo area advanced check (photo shape, size, position, etc.)" + - "UV background check" - "Portrait comparison check (document printed vs chip vs live)" - "Barcode format check (code metadata, data format, contents format, etc.)" - "Kinegram check" @@ -50,7 +60,9 @@ components: - "Extended OCR Check" - "Extended MRZ check" - "Encrypted IPI" + - "Flag for status-only authenticity" x-enum-varnames: + - "NONE" - "UV_LUMINESCENCE" - "IR_B900" - "IMAGE_PATTERN" @@ -59,10 +71,13 @@ components: - "IR_VISIBILITY" - "OCR_SECURITY_TEXT" - "IPI" + - "IR_PHOTO" - "PHOTO_EMBED_TYPE" - "OVI" + - "IR_LUMINESCENCE" - "HOLOGRAMS" - "PHOTO_AREA" + - "UV_BACKGROUND" - "PORTRAIT_COMPARISON" - "BARCODE_FORMAT_CHECK" - "KINEGRAM" @@ -73,3 +88,4 @@ components: - "EXTENDED_OCR_CHECK" - "EXTENDED_MRZ_CHECK" - "ENCRYPTED_IPI" + - "STATUS_ONLY" diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml index 042f366..a77e52e 100644 --- a/authenticity/e-visibility.yml +++ b/authenticity/e-visibility.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: Visibility: + title: "Visibility" type: integer description: "Enumeration contains visibility status of the security element" enum: diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index 4952b4b..0451861 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -1,12 +1,19 @@ openapi: 3.0.3 components: schemas: - FiberResult: - title: "Fibers Check" + title: "FiberResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - RectCount + - ExpectedCount + - RectArray + - Width + - Length + - Area + - ColorValues properties: RectCount: description: "For UV_Fibers authenticity result type" @@ -45,4 +52,4 @@ components: example: [BLUE, GREEN, RED] type: array items: - type: integer \ No newline at end of file + type: integer diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index feca0b6..ae078bb 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -1,12 +1,17 @@ openapi: 3.0.3 components: schemas: - IdentResult: - title: "Ident Check" + title: "IdentResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - ElementType + - LightIndex + - Area + - Image + - EtalonImage properties: ElementType: $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" @@ -21,4 +26,4 @@ components: description: "Reference image" $ref: "../common.yml#/components/schemas/ImageData" AreaList: - $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" \ No newline at end of file + $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index 6ddfd2b..1bacbce 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -1,12 +1,21 @@ openapi: 3.0.3 components: schemas: - OCRSecurityTextResult: - title: "OCR Security Text Check" + title: "OCRSecurityTextResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - CriticalFlag + - LightType + - FieldRect + - EtalonResultType + - EtalonFieldType + - EtalonLightType + - EtalonFieldRect + - SecurityTextResultOCR + - EtalonResultOCR properties: CriticalFlag: $ref: "./e-critical.yml#/components/schemas/Critical" @@ -20,6 +29,8 @@ components: type: integer EtalonLightType: type: integer + EtalonFieldRect: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" SecurityTextResultOCR: type: string EtalonResultOCR: @@ -27,4 +38,4 @@ components: Reserved1: type: integer Reserved2: - type: integer \ No newline at end of file + type: integer diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 94f32ad..19d1070 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -1,12 +1,16 @@ openapi: 3.0.3 components: schemas: - PhotoIdentResult: - title: "Photo Ident Check" + title: "PhotoIdentResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - LightIndex + - Area + - SourceImage + - ResultImages properties: LightIndex: $ref: "../common.yml#/components/schemas/Light" @@ -26,15 +30,23 @@ components: type: integer Angle: type: integer + Reserved1: + type: integer + Reserved2: + type: integer Reserved3: type: integer RawImageContainerList: + title: "RawImageContainerList" type: object + required: + - Count + - Images properties: Count: type: integer Images: type: array items: - $ref: "../common.yml#/components/schemas/ImageData" \ No newline at end of file + $ref: "../common.yml#/components/schemas/ImageData" diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index e7d7ca7..bac38f3 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -1,12 +1,16 @@ openapi: 3.0.3 components: schemas: - SecurityFeatureResult: - title: "Security Feature Check" + title: "SecurityFeatureResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - ElementType + - ElementRect + - Visibility + - CriticalFlag properties: ElementType: $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" @@ -19,4 +23,4 @@ components: AreaList: $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" Reserved2: - type: integer \ No newline at end of file + type: integer diff --git a/common.yml b/common.yml index cdda9da..a69f763 100644 --- a/common.yml +++ b/common.yml @@ -1,6 +1,4 @@ openapi: 3.0.3 - - components: parameters: x-request: @@ -12,10 +10,12 @@ components: schemas: PageIndex: + title: "PageIndex" description: "Page index of the image from input list" type: integer Source: + title: "Source" description: "Document data sources" type: string enum: @@ -24,20 +24,24 @@ components: - "BARCODE" - "RFID" - "MAGNETIC" + - "EXTERNAL" x-enum-varnames: - "MRZ" - "VISUAL" - "BARCODE" - "RFID" - "MAGNETIC" + - "EXTERNAL" x-enum-descriptions: - "Machine readable zone (MRZ)" - "Visual zone" - "Barcode" - "RFID" - "Magnetic" + - "External" CheckResult: + title: "CheckResult" type: integer description: "0 - result is negative; 1 - result is positive; 2 - сheck was not performed" enum: @@ -53,8 +57,8 @@ components: - "Check was performed and result is POSITIVE" - "Check was NOT PERFORMED" - # todo update x-enum-descriptions Scenario: + title: "Scenario" type: string description: "Document processing scenario" enum: @@ -116,6 +120,7 @@ components: - "Scenario for obtaining an original image without any processing" ImageData: + title: "ImageData" type: object required: - image @@ -124,18 +129,21 @@ components: $ref: "#/components/schemas/ImageBase64" ImageTransactionData: + title: "ImageTransactionData" type: object properties: image: $ref: './rt-images.yml#/components/schemas/ImagesFieldValue' ImageBase64: + title: "ImageBase64" description: "Base64 encoded image" type: string format: base64 example: "Base64 encoded image" RectangleCoordinates: + title: "RectangleCoordinates" description: "Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)" type: object required: @@ -154,6 +162,7 @@ components: type: integer RfidLocation: + title: "RfidLocation" type: integer description: "Determines the presence and location of an RFID chip in a document. 0 - no rfid chip; 1 - chip is located in the document data page; 2 - chip is located in the back page or inlay of the document" enum: @@ -170,10 +179,14 @@ components: - "BACK_PAGE" RfidOrigin: + title: "RfidOrigin" type: object description: "Location of data in RFID chip" required: - dg + - dgTag + - tagEntry + - entryView properties: dg: description: "Source data group file" @@ -189,26 +202,145 @@ components: type: integer Light: + title: "Light" type: integer description: "Image light index" enum: - - 0 - - 6 - - 24 - - 128 + - 0x00000000 + - 0x00000001 + - 0x00000002 + - 0x00000004 + - 0x00800000 + - 0x00000006 + - 0x00000008 + - 0x00000010 + - 0x01000000 + - 0x00000018 + - 0x02000000 + - 0x00000080 + - 0x04000000 + - 0x08000000 + - 0x10000000 + - 0x00000100 + - 0x00000400 + - 0x00000800 + - 0x00000200 + - 0x00001000 + - 0x00002000 + - 0x00000C00 + - 0x80000000 + - 0x90000000 + - 0xA0000000 + - 0xB0000000 + - 0xC0000000 + - 0x00000020 + - 0x00000040 + - 0x00010000 + - 0x00004000 + - 0x00040000 + - 0x00020000 + - 0x00008000 + - 0x01000000 + - 0x04000000 + - 0x00000040 + - 0x00000020 + - 0x00080000 + - 0x00100000 + - 0x00200000 + - 0x00400000 x-enum-descriptions: - - "No Light" - - "White" - - "Infrared" - - "Ultraviolet" + - "Lighting schemes are off" + - "OVI scheme" + - "Upper/lower lighters of white light scheme" + - "Side lighters of white light scheme" + - "General white light without separate control of side and upper/lower lighters scheme" + - "Upper/lower and side lighters of white light scheme" + - "Upper/lower lighters of IR light scheme" + - "Side lighters of IR light scheme" + - "General IR light without separate control of side and upper/lower lighters scheme" + - "Upper/lower and side lighters of IR light scheme" + - "general white image converted to grayscale" + - "General UV light scheme" + - "OVD light for hologram visualization" + - "Video detection light for internal use only" + - "Light IR 870 oblique" + - "IR luminescence" + - "Left lighter of white coaxial light scheme" + - "Right lighter of white coaxial light scheme" + - "Coaxial white light without separate control of left and right lighters scheme" + - "IR720" + - "IR940" + - "Right and left lighters of white coaxial light scheme" + - "For internal use" + - "For internal use" + - "For internal use" + - "For internal use" + - "For internal use" + - "Transmitted" + - "Transmitted IR" + - "Transmitted AntiStokes" + - "Transmitted IR940" + - "OVD right" + - "OVD left" + - "IR 700" + - "Front IR870 (mod. 8803)" + - "OVD light (hologram visualization) (mod. 8850)" + - "For internal use" + - "For internal use" + - "UVС 254 (mod. 88X0)" + - "UVB 313 (mod. 88X0)" + - "White oblique light" + - "For internal use" x-enum-varnames: - "OFF" + - "OVI" + - "WHITE_TOP" + - "WHITE_SIDE" + - "WHITE_FRONT" - "WHITE" + - "IR_TOP" + - "IR_SIDE" + - "IR_FRONT" - "IR" + - "WHITE_GRAY" - "UV" + - "OVD" + - "VIDEODETECTION" + - "IR_870_OBL" + - "IR_LUMINESCENCE" + - "AXIAL_WHITE_LEFT" + - "AXIAL_WHITE_RIGHT" + - "AXIAL_WHITE_FRONT" + - "IR_720" + - "IR_940" + - "AXIAL_WHITE_FULL" + - "RAW_DATA" + - "RAW_DATA_GRBG" + - "RAW_DATA_GBGR" + - "RAW_DATA_RGGB" + - "RAW_DATA_BGGR" + - "TRANSMITTED" + - "TRANSMITTED_IR" + - "ANTI_STOKES" + - "TRANSMITTED_IR940" + - "OVD_RIGHT" + - "OVD_LEFT" + - "IR_700" + - "IR_870" + - "HOLO" + - "IR_BOTTOM" + - "WHITE_BOTTOM" + - "UVC" + - "UVB" + - "WHITE_OBL" + - "WHITE_SPECIAL" Point: + title: "Point" type: object + required: + - x + - y properties: x: type: integer @@ -216,18 +348,21 @@ components: type: integer License: + title: "License" description: "Base64 encoded data" type: string format: byte example: "Base64 encoded data" EncryptedRCL: + title: "EncryptedRCL" description: "Base64 encoded data" type: string format: byte example: "Base64 encoded data" FaceApi: + title: "FaceApi" type: object properties: url: @@ -246,7 +381,8 @@ components: type: integer description: "The maximum number of results to be returned." threshold: - type: float + type: number + format: float description: "The similarity threshold." group_ids: type: array diff --git a/e-barcode-type.yml b/e-barcode-type.yml index 3335b56..d961cee 100644 --- a/e-barcode-type.yml +++ b/e-barcode-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: BarcodeType: + title: "BarcodeType" type: integer description: "Enumeration contains the types of barcodes that can be processed" enum: @@ -25,6 +26,7 @@ components: - 17 - 18 - 19 + - 20 x-enum-varnames: - "UNKNOWN" - "CODE128" @@ -46,24 +48,26 @@ components: - "ALL_1D" - "CODE11" - "JABCODE" + - "END" x-enum-descriptions: - - "Unknown" - - "Code 128" - - "Code 39" - - "EAN-8" - - "ITF" - - "PDF417" - - "STF" - - "MTF" - - "IATA" - - "Codabar" - - "UPC-A" - - "Code 93" - - "UPC-E" - - "EAN-13" - - "QR code" - - "Aztec code" - - "Datamatrix" - - "All 1D barcodes" - - "Code 11" + - "Unknown type" + - "One-dimensional bar-code, ISO 15417 (ANSI/AIM BC4-1999 Code 128)" + - "One-dimensional bar-code, ISO 16388 (ANSI/AIM BC1-1995 Code 39)" + - "One-dimensional bar-code, EAN8, ISO 15418" + - "One-dimensional bar-code, Interleaved 2 of 5, ISO 16390 (ANSI/AIM BC2-1995 Interleaved 2 of 5)" + - "Two-dimensional bar-code, ISO 15438 (AIM USS PDF417)" + - "One-dimensional bar-code, Standard 2 of 5 (Industrial)" + - "One-dimensional bar-code, Matrix 2 of 5" + - "One-dimensional bar-code, IATA 2 of 5 (Airline)" + - "One-dimensional bar-code, (ANSI/AIM BC3-1995, USS - Codabar)" + - "One-dimensional bar-code, UPC-A" + - "One-dimensional bar-code, (ANSI/AIM BC5-1995, USS - Code 93)" + - "One-dimensional bar-code, UPC-E" + - "One-dimensional bar-code, EAN13, ISO 15418" + - "Two-dimensional QRCODE bar-code" + - "Two-dimensional AZTEC bar-code" + - "Two-dimensional DATAMATRIX bar-code" + - "Type for internal use, representing all 1D bar-codes" + - "One-dimensional bar-code CODE11" - "JAB code" + - "For internal use" diff --git a/e-document-type.yml b/e-document-type.yml index 2e25c5a..9fe94c4 100644 --- a/e-document-type.yml +++ b/e-document-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: DocumentType: + title: "DocumentType" type: integer description: "Possible values for document types" enum: diff --git a/e-graphic-field-type.yml b/e-graphic-field-type.yml index e29bf96..64d2979 100644 --- a/e-graphic-field-type.yml +++ b/e-graphic-field-type.yml @@ -2,9 +2,12 @@ openapi: 3.0.3 components: schemas: GraphicFieldName: + title: "GraphicFieldName" description: "Human readable field name. Do not bind to this name - use GraphicFieldType instead." type: string + GraphicFieldType: + title: "GraphicFieldType" type: integer enum: - 201 @@ -18,6 +21,7 @@ components: - 209 - 210 - 211 + - 212 - 213 - 250 - 300 @@ -45,6 +49,7 @@ components: - "Area with dynamic color change" - "Additional Portrait" - "Stamp" + - "Portrait of child" - "Contact chip" - "Undefined image type" - "Fingerprint (thumb, left hand)" @@ -72,6 +77,7 @@ components: - "COLOR_DYNAMIC" - "GHOST_PORTRAIT" - "STAMP" + - "PORTRAIT_OF_CHILD" - "CONTACT_CHIP" - "OTHER" - "FINGER_LEFT_THUMB" diff --git a/e-lcid.yml b/e-lcid.yml index bd8bca7..780c13f 100644 --- a/e-lcid.yml +++ b/e-lcid.yml @@ -1,8 +1,8 @@ openapi: 3.0.3 components: schemas: - LCID: + title: "LCID" description: | Locale id. Used to tag same typed fields declared in several languages. For example: name can be provided in both native and latin variants. @@ -36,10 +36,15 @@ components: - 1026 - 1109 - 1027 + - 3076 + - 5124 - 2052 + - 4100 + - 1028 - 1050 - 1029 - 1030 + - 1125 - 2067 - 1043 - 3081 @@ -134,6 +139,7 @@ components: - 1089 - 1053 - 2077 + - 1114 - 1097 - 1092 - 1098 @@ -197,10 +203,15 @@ components: - "BULGARIAN" - "BURMESE" - "CATALAN" + - "CHINESE_HONGKONG_SAR" + - "CHINESE_MACAO_SAR" - "CHINESE" + - "CHINESE_SINGAPORE" + - "CHINESE_TAIWAN" - "CROATIAN" - "CZECH" - "DANISH" + - "DIVEHI" - "DUTCH_BELGIUM" - "DUTCH_NETHERLANDS" - "ENGLISH_AUSTRALIA" @@ -295,6 +306,7 @@ components: - "SWAHILI" - "SWEDISH" - "SWEDISH_FINLAND" + - "SYRIAC" - "TAMIL" - "TATAR" - "TELUGU" @@ -309,9 +321,9 @@ components: - "VIETNAMESE" - "CTC_SIMPLIFIED" - "CTC_TRADITIONAL" - - "BengaliBangladesh" - - "BengaliIndia" - - "Assamese" + - "BENGALI_BANGLADESH" + - "BENGALI_INDIA" + - "ASSAMESE" - "ORIYA" - "MALAYALAM" - "LAO" @@ -358,10 +370,15 @@ components: - "Bulgarian" - "Burmese" - "Catalan" + - "Chinese (HongKong S.A.R.)" + - "Chinese (Macao S.A.R.)" - "Chinese" + - "Chinese (Singapore)" + - "Chinese (Taiwan)" - "Croatian" - "Czech" - "Danish" + - "Divehi" - "Dutch (Belgium)" - "Dutch (Netherlands)" - "English (Australia)" @@ -456,6 +473,7 @@ components: - "Swahili" - "Swedish" - "Swedish (Finland)" + - "Syriac" - "Tamil" - "Tatar" - "Telugu" @@ -490,4 +508,4 @@ components: - "Bank Card CVV2" - "Abkhazian (Cyrillic)" - "Karakalpak (Latin)" - - "Urdu Detection" \ No newline at end of file + - "Urdu Detection" diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 7469f92..e08e321 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -2,135 +2,136 @@ openapi: 3.0.3 components: schemas: ParsingErrorCodes: + title: "ParsingErrorCodes" type: integer description: "The enumeration contains error codes that can return during the RFID chip processing." enum: - - 1 - - -2147483647 - - -2147483646 - - -2147483645 - - -2147483640 - - -2147483639 - - -2147483638 - - -2147483631 - - -2147483629 - - -2147483628 - - -2147483627 - - -2147483626 - - -2147483630 - - -2147483625 - - -2147483624 - - -2147483623 - - -2147483622 - - -2147483621 - - -2147483620 - - -2147483619 - - -2147483618 - - -2147483617 - - -2147483616 - - -2147483615 - - -2147483614 - - -2147483613 - - -2147483612 - - -2147483611 - - -2147483610 - - -2147483609 - - -2147483600 - - -2147483599 - - -2147483598 - - -2147483597 - - -2147483596 - - -2147483594 - - -2147483595 - - -2147483568 - - -2147483567 - - -2147483566 - - -2147483565 - - -2147483564 - - -2147483563 - - -2147483562 - - -2147483561 - - -2147483560 - - -2147483559 - - -2147483558 - - -2147483536 - - -2147483535 - - -2130706415 - - -2130706400 - - -2130706399 - - -2130706398 - - -2130706397 - - -2130706396 - - -2130706395 - - -2130706394 - - -2130706393 - - -2130706392 - - -2130706391 - - -2130706390 - - -2130706389 - - -2130706388 - - -2130706387 - - -2130706386 - - -2130706385 - - -2130706384 - - -2130706383 - - -2130706382 - - -2130706381 - - -2130706380 - - -2130706379 - - -2130706378 - - -2130706377 - - -2130706376 - - -2130706368 - - -2130706367 - - -2130706366 - - -2130706365 - - -2130706364 - - -2130706363 - - -2130706352 - - -2130706351 - - -2130706350 - - -2130706349 - - -2130706348 - - -2130706347 - - -2130706346 - - -2130706345 - - -2130706320 - - -2130706319 - - -2130706318 - - -2130706336 - - -2130706334 - - -2130706333 - - -2130706332 - - -2130706331 - - -2130706080 - - -2130706079 - - -2130706078 - - -2130706077 - - -2130706076 - - -2130706075 - - -2130706074 - - -2130706073 - - -2130706072 - - -2130706071 - - -2130706070 - - -2130705920 - - -2130705919 - - -2130705918 - - -2130705917 - - -2130705916 - - -2130705915 - - -2130705664 - - -2130705663 - - -2130705662 - - -2130705661 - - -2130705660 - - -2130705659 - - -2130705658 - - -2130705657 - - -2130705656 - - -2130705655 - - -2130705654 + - 0x00000001 + - 0x80000001 + - 0x80000002 + - 0x80000003 + - 0x80000008 + - 0x80000009 + - 0x8000000A + - 0x80000011 + - 0x80000013 + - 0x80000014 + - 0x80000015 + - 0x80000016 + - 0x80000012 + - 0x80000017 + - 0x80000018 + - 0x80000019 + - 0x8000001A + - 0x8000001B + - 0x8000001C + - 0x8000001D + - 0x8000001E + - 0x8000001F + - 0x80000020 + - 0x80000021 + - 0x80000022 + - 0x80000023 + - 0x80000024 + - 0x80000025 + - 0x80000026 + - 0x80000027 + - 0x80000030 + - 0x80000031 + - 0x80000032 + - 0x80000033 + - 0x80000034 + - 0x80000036 + - 0x80000035 + - 0x80000050 + - 0x80000051 + - 0x80000052 + - 0x80000053 + - 0x80000054 + - 0x80000055 + - 0x80000056 + - 0x80000057 + - 0x80000058 + - 0x80000059 + - 0x8000005A + - 0x80000070 + - 0x80000071 + - 0x81000011 + - 0x81000020 + - 0x81000021 + - 0x81000022 + - 0x81000023 + - 0x81000024 + - 0x81000025 + - 0x81000026 + - 0x81000027 + - 0x81000028 + - 0x81000029 + - 0x8100002A + - 0x8100002B + - 0x8100002C + - 0x8100002D + - 0x8100002E + - 0x8100002F + - 0x81000030 + - 0x81000031 + - 0x81000032 + - 0x81000033 + - 0x81000034 + - 0x81000035 + - 0x81000036 + - 0x81000037 + - 0x81000038 + - 0x81000040 + - 0x81000041 + - 0x81000042 + - 0x81000043 + - 0x81000044 + - 0x81000045 + - 0x81000050 + - 0x81000051 + - 0x81000052 + - 0x81000053 + - 0x81000054 + - 0x81000055 + - 0x81000056 + - 0x81000057 + - 0x81000070 + - 0x81000071 + - 0x81000072 + - 0x81000060 + - 0x81000062 + - 0x81000063 + - 0x81000064 + - 0x81000065 + - 0x81000160 + - 0x81000161 + - 0x81000162 + - 0x81000163 + - 0x81000164 + - 0x81000165 + - 0x81000166 + - 0x81000167 + - 0x81000168 + - 0x81000169 + - 0x8100016A + - 0x81000200 + - 0x81000201 + - 0x81000202 + - 0x81000203 + - 0x81000204 + - 0x81000205 + - 0x81000300 + - 0x81000301 + - 0x81000302 + - 0x81000303 + - 0x81000304 + - 0x81000305 + - 0x81000306 + - 0x81000307 + - 0x81000308 + - 0x81000309 + - 0x8100030A x-enum-descriptions: - "OK" - "ASN: Incorrect data" diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 4a3d1d3..2333acb 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -2,231 +2,232 @@ openapi: 3.0.3 components: schemas: ParsingNotificationCodes: + title: "ParsingNotificationCodes" type: integer description: "The enumeration contains possible values of notification codes returned during the RFID chip processing." enum: - - -1879048191 - - -1879048190 - - -1879048189 - - -1879048188 - - -1879048187 - - -1879048186 - - -1879048184 - - -1879048178 - - -1879048177 - - -1879048176 - - -1879048169 - - -1879047680 - - -1879047679 - - -1879047678 - - -1879047677 - - -1879047676 - - -1879047675 - - -1879047674 - - -1879047673 - - -1879047672 - - -1879047671 - - -1879047670 - - -1879047669 - - -1879047668 - - -1879047667 - - -1879047666 - - -1879047665 - - -1879047664 - - -1879047663 - - -1879047662 - - -1879047661 - - -1879047660 - - -1879047659 - - -1879047658 - - -1879047657 - - -1879047656 - - -1879047655 - - -1879047654 - - -1879047653 - - -1879047652 - - -1879047651 - - -1879047650 - - -1879047649 - - -1879047648 - - -1879047647 - - -1879047646 - - -1879047645 - - -1879047644 - - -1879047643 - - -1879047642 - - -1879047640 - - -1879047639 - - -1879047638 - - -1879047637 - - -1879047636 - - -1879047635 - - -1879047634 - - -1879047633 - - -1879047631 - - -1879047630 - - -1879047629 - - -1879047628 - - -1879047627 - - -1879047626 - - -1879047625 - - -1879047624 - - -1879047623 - - -1879047622 - - -1879047621 - - -1879047620 - - -1879047619 - - -1879047618 - - -1879047617 - - -1879047616 - - -1879047615 - - -1879047614 - - -1879047613 - - -1879047612 - - -1879047611 - - -1879047610 - - -1879047609 - - -1879047608 - - -1879047607 - - -1879047606 - - -1879047605 - - -1879047604 - - -1879047603 - - -1879047602 - - -1879047601 - - -1879048160 - - -1879048159 - - -1879048158 - - -1879048157 - - -1879048156 - - -1879048155 - - -1879048154 - - -1879048144 - - -1879048143 - - -1879048142 - - -1879048141 - - -1879047936 - - -1879047776 - - -1879047775 - - -1879047935 - - -1879047934 - - -1879047933 - - -1879047927 - - -1879047760 - - -1879047759 - - -1879047758 - - -1879047932 - - -1879047931 - - -1879047930 - - -1879047929 - - -1879047928 - - -1879047744 - - -1879047736 - - -1879047728 - - -1879047720 - - -1879047926 - - -1879047925 - - -1879047924 - - -1879047923 - - -1879047922 - - -1879047921 - - -1879047920 - - -1879047919 - - -1879047918 - - -1879047909 - - -1879047908 - - -1879047907 - - -1879047906 - - -1879047905 - - -1879047915 - - -1879047914 - - -1879047913 - - -1879047912 - - -1879047911 - - -1879047910 - - 139272 - - 139273 - - 139274 - - 139277 - - 139278 - - 139279 - - 139280 - - 139281 - - 139282 - - 139283 - - 139284 - - 139285 - - 139286 - - 139287 - - 139288 - - -1878982656 - - -1878917120 - - -1878851584 - - -1878786048 - - -1878720512 - - -1878654976 - - -1878589440 - - -1878523904 - - -1878458368 - - -1878392832 - - -1878327296 - - -1877999616 - - -1877934080 - - -1877868544 - - -1877803008 - - -1877737472 - - -1877671936 - - -1877606400 - - -1877540864 - - -1877475328 - - -1877409792 - - -1877344256 - - -1862270976 - - -1862270975 - - -1862270974 - - -1862270973 - - -1862270972 - - -1862270971 - - -1862270970 - - -1862270969 - - -1862270968 - - -1862270967 - - -1862270966 - - -1862270965 - - -1862270964 - - -1862270963 - - -1862270962 - - -1862270720 - - -1862270719 - - -1862270718 - - -1862270717 - - -1862270716 - - -1862270715 - - -1862270714 - - -1862270713 - - -1862270712 - - -1862270711 - - -1862270710 - - -1862270709 - - -1862270708 - - -1862270707 - - -1862270706 - - -1862270705 - - -1862270704 - - -1862270463 - - -1862270462 - - -1862270461 - - -1862270460 - - -1862270208 - - -1845493483 - - -1845493482 - - -1845493481 - - -1845493480 - - -1845493479 - - -1879047600 - - -1879047599 - - 139289 - - -1879047598 + - 0x90000001 + - 0x90000002 + - 0x90000003 + - 0x90000004 + - 0x90000005 + - 0x90000006 + - 0x90000008 + - 0x9000000E + - 0x9000000F + - 0x90000010 + - 0x90000017 + - 0x90000200 + - 0x90000201 + - 0x90000202 + - 0x90000203 + - 0x90000204 + - 0x90000205 + - 0x90000206 + - 0x90000207 + - 0x90000208 + - 0x90000209 + - 0x9000020A + - 0x9000020B + - 0x9000020C + - 0x9000020D + - 0x9000020E + - 0x9000020F + - 0x90000210 + - 0x90000211 + - 0x90000212 + - 0x90000213 + - 0x90000214 + - 0x90000215 + - 0x90000216 + - 0x90000217 + - 0x90000218 + - 0x90000219 + - 0x9000021A + - 0x9000021B + - 0x9000021C + - 0x9000021D + - 0x9000021E + - 0x9000021F + - 0x90000220 + - 0x90000221 + - 0x90000222 + - 0x90000223 + - 0x90000224 + - 0x90000225 + - 0x90000226 + - 0x90000228 + - 0x90000229 + - 0x9000022A + - 0x9000022B + - 0x9000022C + - 0x9000022D + - 0x9000022E + - 0x9000022F + - 0x90000231 + - 0x90000232 + - 0x90000233 + - 0x90000234 + - 0x90000235 + - 0x90000236 + - 0x90000237 + - 0x90000238 + - 0x90000239 + - 0x9000023A + - 0x9000023B + - 0x9000023C + - 0x9000023D + - 0x9000023E + - 0x9000023F + - 0x90000240 + - 0x90000241 + - 0x90000242 + - 0x90000243 + - 0x90000244 + - 0x90000245 + - 0x90000246 + - 0x90000247 + - 0x90000248 + - 0x90000249 + - 0x9000024A + - 0x9000024B + - 0x9000024C + - 0x9000024D + - 0x9000024E + - 0x9000024F + - 0x90000020 + - 0x90000021 + - 0x90000022 + - 0x90000023 + - 0x90000024 + - 0x90000025 + - 0x90000026 + - 0x90000030 + - 0x90000031 + - 0x90000032 + - 0x90000033 + - 0x90000100 + - 0x900001A0 + - 0x900001A1 + - 0x90000101 + - 0x90000102 + - 0x90000103 + - 0x90000109 + - 0x900001B0 + - 0x900001B1 + - 0x900001B2 + - 0x90000104 + - 0x90000105 + - 0x90000106 + - 0x90000107 + - 0x90000108 + - 0x900001C0 + - 0x900001C8 + - 0x900001D0 + - 0x900001D8 + - 0x9000010A + - 0x9000010B + - 0x9000010C + - 0x9000010D + - 0x9000010E + - 0x9000010F + - 0x90000110 + - 0x90000111 + - 0x90000112 + - 0x9000011B + - 0x9000011C + - 0x9000011D + - 0x9000011E + - 0x9000011F + - 0x90000115 + - 0x90000116 + - 0x90000117 + - 0x90000118 + - 0x90000119 + - 0x9000011A + - 0x00022008 + - 0x00022009 + - 0x0002200A + - 0x0002200D + - 0x0002200E + - 0x0002200F + - 0x00022010 + - 0x00022011 + - 0x00022012 + - 0x00022013 + - 0x00022014 + - 0x00022015 + - 0x00022016 + - 0x00022017 + - 0x00022018 + - 0x90010000 + - 0x90020000 + - 0x90030000 + - 0x90040000 + - 0x90050000 + - 0x90060000 + - 0x90070000 + - 0x90080000 + - 0x90090000 + - 0x900A0000 + - 0x900B0000 + - 0x90100000 + - 0x90110000 + - 0x90120000 + - 0x90130000 + - 0x90140000 + - 0x90150000 + - 0x90160000 + - 0x90170000 + - 0x90180000 + - 0x90190000 + - 0x901A0000 + - 0x91000000 + - 0x91000001 + - 0x91000002 + - 0x91000003 + - 0x91000004 + - 0x91000005 + - 0x91000006 + - 0x91000007 + - 0x91000008 + - 0x91000009 + - 0x9100000A + - 0x9100000B + - 0x9100000C + - 0x9100000D + - 0x9100000E + - 0x91000100 + - 0x91000101 + - 0x91000102 + - 0x91000103 + - 0x91000104 + - 0x91000105 + - 0x91000106 + - 0x91000107 + - 0x91000108 + - 0x91000109 + - 0x9100010A + - 0x9100010B + - 0x9100010C + - 0x9100010D + - 0x9100010E + - 0x9100010F + - 0x91000110 + - 0x91000201 + - 0x91000202 + - 0x91000203 + - 0x91000204 + - 0x91000300 + - 0x92000115 + - 0x92000116 + - 0x92000117 + - 0x92000118 + - 0x92000119 + - 0x90000250 + - 0x90000251 + - 0x00022019 + - 0x90000252 x-enum-descriptions: - "ASN certificate: Incorrect version" - "ASN certificate: Non-matching signature algorithm" diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml new file mode 100644 index 0000000..4bc971a --- /dev/null +++ b/e-rfid-data-file-type.yml @@ -0,0 +1,184 @@ +openapi: 3.0.3 +components: + schemas: + RfidDataFileType: + title: "RfidDataFileType" + type: integer + description: "Enumeration contains a set of constants that define the file type + (or logical belonging of the data object) within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 113 + - 114 + - 115 + - 116 + - 117 + - 118 + - 119 + - 120 + - 121 + - 150 + - 151 + - 152 + - 153 + - 154 + - 155 + - 156 + - 157 + - 158 + - 159 + - 160 + - 161 + - 162 + - 163 + - 164 + - 165 + - 166 + - 167 + - 200 + - 201 + - 202 + - 300 + - 301 + - 302 + - 400 + - 500 + - 501 + - 600 + - 601 + - 602 + - 603 + - 700 + - 701 + - 702 + - 703 + - 710 + - 711 + - 712 + - 713 + - 714 + - 715 + - 1000 + x-enum-varnames: + - "UNSPECIFIED" + - "PASSPORT_DG1" + - "PASSPORT_DG2" + - "PASSPORT_DG3" + - "PASSPORT_DG4" + - "PASSPORT_DG5" + - "PASSPORT_DG6" + - "PASSPORT_DG7" + - "PASSPORT_DG8" + - "PASSPORT_DG9" + - "PASSPORT_DG10" + - "PASSPORT_DG11" + - "PASSPORT_DG12" + - "PASSPORT_DG13" + - "PASSPORT_DG14" + - "PASSPORT_DG15" + - "PASSPORT_DG16" + - "PASSPORT_DG17" + - "PASSPORT_DG18" + - "PASSPORT_DG19" + - "PASSPORT_DG20" + - "PASSPORT_SOD" + - "PASSPORT_CVCA" + - "PASSPORT_COM" + - "ID_DG1" + - "ID_DG2" + - "ID_DG3" + - "ID_DG4" + - "ID_DG5" + - "ID_DG6" + - "ID_DG7" + - "ID_DG8" + - "ID_DG9" + - "ID_DG10" + - "ID_DG11" + - "ID_DG12" + - "ID_DG13" + - "ID_DG14" + - "ID_DG15" + - "ID_DG16" + - "ID_DG17" + - "ID_DG18" + - "ID_DG19" + - "ID_DG20" + - "ID_DG21" + - "DL_COM" + - "DL_DG1" + - "DL_DG2" + - "DL_DG3" + - "DL_DG4" + - "DL_DG5" + - "DL_DG6" + - "DL_DG7" + - "DL_DG8" + - "DL_DG9" + - "DL_DG10" + - "DL_DG11" + - "DL_DG12" + - "DL_DG13" + - "DL_DG14" + - "DL_SOD" + - "DL_CE" + - "DL_CVCA" + - "PACE_CARD_ACCESS" + - "PACE_CARD_SECURITY" + - "PACE_CHIP_SECURITY" + - "MIFARE_DATA" + - "MIFARE_VALIDITY" + - "AUTHENTICITY_V2" + - "ATR" + - "_E_SIGN_PK" + - "_E_SIGN_SIGNED_DATA" + - "CERTIFICATE" + - "MASTER_LIST" + - "DEFECT_LIST" + - "BLACK_LIST" + - "APP_DIRECTORY" + - "SESSION" + - "LOG_DATA" + - "CHIP_PROPERTIES" + - "POST_CA_RESPONSE" + - "POST_CA_PUBLIC_KEY" + - "POST_CA_INFO" + - "POST_CA_D_PARAMS" + - "POST_CA_CHECK_PK" + - "POST_CA_CHECK_SK" + - "USER_DEFINED" diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml new file mode 100644 index 0000000..9f72811 --- /dev/null +++ b/e-rfid-data-group-type-tag.yml @@ -0,0 +1,177 @@ +openapi: 3.0.3 +components: + schemas: + RfidDataGroupTypeTag: + title: "RfidDataGroupTypeTag" + type: integer + description: "Enumeration representing RFID Data Group Types. + Constants with prefix correspond to the informational data groups of ePassport + application, with prefix EID_ – those of eID application, with prefix EDL_ – + eDL application" + enum: + - 0x60 + - 0x61 + - 0x75 + - 0x63 + - 0x76 + - 0x65 + - 0x66 + - 0x67 + - 0x68 + - 0x69 + - 0x6A + - 0x6B + - 0x6C + - 0x6D + - 0x6E + - 0x6F + - 0x70 + - 0x77 + - 0x61 + - 0x62 + - 0x63 + - 0x64 + - 0x65 + - 0x66 + - 0x67 + - 0x68 + - 0x69 + - 0x6A + - 0x6B + - 0x6C + - 0x6D + - 0x6E + - 0x6F + - 0x70 + - 0x71 + - 0x72 + - 0x73 + - 0x74 + - 0x75 + - 0x60 + - 0x77 + - 0x77 + - 0x61 + - 0x6B + - 0x6C + - 0x65 + - 0x67 + - 0x75 + - 0x63 + - 0x76 + - 0x70 + - 0x6D + - 0x71 + - 0x6F + - 0x6E + x-enum-descriptions: + - "Common Data Group Type" + - "Data Group 1" + - "Data Group 2" + - "Data Group 3" + - "Data Group 4" + - "Data Group 5" + - "Data Group 6" + - "Data Group 7" + - "Data Group 8" + - "Data Group 9" + - "Data Group 10" + - "Data Group 11" + - "Data Group 12" + - "Data Group 13" + - "Data Group 14" + - "Data Group 15" + - "Data Group 16" + - "Start of Data" + - "Extended Interoperable Data, Data Group 1" + - "Extended Interoperable Data, Data Group 2" + - "Extended Interoperable Data, Data Group 3" + - "Extended Interoperable Data, Data Group 4" + - "Extended Interoperable Data, Data Group 5" + - "Extended Interoperable Data, Data Group 6" + - "Extended Interoperable Data, Data Group 7" + - "Extended Interoperable Data, Data Group 8" + - "Extended Interoperable Data, Data Group 9" + - "Extended Interoperable Data, Data Group 10" + - "Extended Interoperable Data, Data Group 11" + - "Extended Interoperable Data, Data Group 12" + - "Extended Interoperable Data, Data Group 13" + - "Extended Interoperable Data, Data Group 14" + - "Extended Interoperable Data, Data Group 15" + - "Extended Interoperable Data, Data Group 16" + - "Extended Interoperable Data, Data Group 17" + - "Extended Interoperable Data, Data Group 18" + - "Extended Interoperable Data, Data Group 19" + - "Extended Interoperable Data, Data Group 20" + - "Extended Interoperable Data, Data Group 21" + - "Extended Length Data, Common Data Group Type" + - "Extended Length Data, Start of Data" + - "Extended Length Data, Certificate Holder Authorization" + - "Extended Length Data, Data Group 1" + - "Extended Length Data, Data Group 2" + - "Extended Length Data, Data Group 3" + - "Extended Length Data, Data Group 4" + - "Extended Length Data, Data Group 5" + - "Extended Length Data, Data Group 6" + - "Extended Length Data, Data Group 7" + - "Extended Length Data, Data Group 8" + - "Extended Length Data, Data Group 9" + - "Extended Length Data, Data Group 11" + - "Extended Length Data, Data Group 12" + - "Extended Length Data, Data Group 13" + - "Extended Length Data, Data Group 14" + x-enum-varnames: + - "COM" + - "DG1" + - "DG2" + - "DG3" + - "DG4" + - "DG5" + - "DG6" + - "DG7" + - "DG8" + - "DG9" + - "DG10" + - "DG11" + - "DG12" + - "DG13" + - "DG14" + - "DG15" + - "DG16" + - "SOD" + - "EID_DG1" + - "EID_DG2" + - "EID_DG3" + - "EID_DG4" + - "EID_DG5" + - "EID_DG6" + - "EID_DG7" + - "EID_DG8" + - "EID_DG9" + - "EID_DG10" + - "EID_DG11" + - "EID_DG12" + - "EID_DG13" + - "EID_DG14" + - "EID_DG15" + - "EID_DG16" + - "EID_DG17" + - "EID_DG18" + - "EID_DG19" + - "EID_DG20" + - "EID_DG21" + - "EDL_COM" + - "EDL_SOD" + - "EDL_CE" + - "EDL_DG1" + - "EDL_DG2" + - "EDL_DG3" + - "EDL_DG4" + - "EDL_DG5" + - "EDL_DG6" + - "EDL_DG7" + - "EDL_DG8" + - "EDL_DG9" + - "EDL_DG11" + - "EDL_DG12" + - "EDL_DG14" diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index a656f7d..127ba64 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -2,123 +2,124 @@ openapi: 3.0.3 components: schemas: RFIDErrorCodes: + title: "RFIDErrorCodes" type: integer description: "Enumeration contains a set of error codes returned by SDK" enum: - - -2147458430 - - -2147458429 - - -2147458112 - - -2147458111 - - -2147456637 - - -2147456636 - - -2147456635 - - -2147456384 - - -2147456382 - - -2147456376 - - -2147456256 - - -2147418111 - - -2147418110 - - -2147418108 - - -2147418107 - - -2147418106 - - -2147418104 - - -2147418103 - - -2147418102 - - -2147418101 - - -2147418100 - - -2147352576 - - -2147352575 - - -2147352574 - - -2147352573 - - -2147352572 - - -2147352571 - - -2147352570 - - -2147352560 - - -2146409536 - - -2097152000 - - -2097151999 - - -2097151998 - - -2097151984 - - -2097151983 - - -2097151982 - - -2097151981 - - -2097151980 - - -2097151979 - - -2097151978 - - -2097151977 - - -2097151976 - - -2097151975 - - -2097151974 - - -2097151973 - - -2097151972 - - -2097151968 - - -2097151967 - - -2097151966 - - -2097151965 - - -2097151964 - - -2097151963 - - -2097151962 - - -2097151961 - - -2097151960 - - -2097151959 - - -2097151958 - - -2097151952 - - -2097151951 - - -2097151936 - - -2097151935 - - -2097151934 - - -2097151920 - - -2097151919 - - -2097151918 - - -2097151904 - - -2097086464 - - -2097020928 - - -2096955392 - - -2096889856 - - -2096824320 - - -2096758784 - - -2096693248 - - -2096627712 - - -2080374784 - - -2080309248 - - -2080243712 - - -2080178176 - - -2080112640 - - -2080047104 - - -2079981568 - - -2079916032 - - -2079850496 - - -2079784960 - - -2079719424 - - -2079653888 - - -2079588352 - - -2079522816 - - -2079457280 - - -2079391744 - - -2046820352 - - -2046820351 - - -2046820096 - - -2046820095 - - -2046820094 - - -2046820093 - - -2046819840 - - -2046819839 - - -2046819838 - - -2046819837 - - -2046819836 - - -2046819584 - - -2046819583 - - -2046819582 - - -2046819581 - - -2046819580 - - -2046819579 - - -2046819578 - - -2046819577 - - -2046819576 - - -2046819575 - - -1 - - 1 - - 2 + - 0x80006282 + - 0x80006283 + - 0x800063C0 + - 0x800063C1 + - 0x80006983 + - 0x80006984 + - 0x80006985 + - 0x80006A80 + - 0x80006A82 + - 0x80006A88 + - 0x80006B00 + - 0x80010001 + - 0x80010002 + - 0x80010004 + - 0x80010005 + - 0x80010006 + - 0x80010008 + - 0x80010009 + - 0x8001000A + - 0x8001000B + - 0x8001000C + - 0x80020000 + - 0x80020001 + - 0x80020002 + - 0x80020003 + - 0x80020004 + - 0x80020005 + - 0x80020006 + - 0x80020010 + - 0x801063C0 + - 0x83000000 + - 0x83000001 + - 0x83000002 + - 0x83000010 + - 0x83000011 + - 0x83000012 + - 0x83000013 + - 0x83000014 + - 0x83000015 + - 0x83000016 + - 0x83000017 + - 0x83000018 + - 0x83000019 + - 0x8300001A + - 0x8300001B + - 0x8300001C + - 0x83000020 + - 0x83000021 + - 0x83000022 + - 0x83000023 + - 0x83000024 + - 0x83000025 + - 0x83000026 + - 0x83000027 + - 0x83000028 + - 0x83000029 + - 0x8300002A + - 0x83000030 + - 0x83000031 + - 0x83000040 + - 0x83000041 + - 0x83000042 + - 0x83000050 + - 0x83000051 + - 0x83000052 + - 0x83000060 + - 0x83010000 + - 0x83020000 + - 0x83030000 + - 0x83040000 + - 0x83050000 + - 0x83060000 + - 0x83070000 + - 0x83080000 + - 0x84000000 + - 0x84010000 + - 0x84020000 + - 0x84030000 + - 0x84040000 + - 0x84050000 + - 0x84060000 + - 0x84070000 + - 0x84080000 + - 0x84090000 + - 0x840A0000 + - 0x840B0000 + - 0x840C0000 + - 0x840D0000 + - 0x840E0000 + - 0x840F0000 + - 0x86000000 + - 0x86000001 + - 0x86000100 + - 0x86000101 + - 0x86000102 + - 0x86000103 + - 0x86000200 + - 0x86000201 + - 0x86000202 + - 0x86000203 + - 0x86000204 + - 0x86000300 + - 0x86000301 + - 0x86000302 + - 0x86000303 + - 0x86000304 + - 0x86000305 + - 0x86000306 + - 0x86000307 + - 0x86000308 + - 0x86000309 + - 0xFFFFFFFF + - 0x00000001 + - 0x00000002 x-enum-descriptions: - "LAYER6: Reading beyond EOF / Unexpected EOF" - "LAYER6: PWD deactivated" diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 1150803..471e932 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: SecurityFeatureType: + title: "SecurityFeatureType" type: integer description: "Enumeration contains identifiers determining type of features for a document authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/security-feature-type/" enum: diff --git a/e-text-field-type.yml b/e-text-field-type.yml index 3646d9e..603c9d7 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: TextFieldType: + title: "TextFieldType" type: integer enum: - 0 @@ -1919,4 +1920,4 @@ components: - "FT_RESULT_OF_TESTING" - "FT_METHOD_OF_TESTING" - "FT_DIGITAL_TRAVEL_AUTHORIZATION_NUMBER" - - "FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT" \ No newline at end of file + - "FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT" diff --git a/index.yml b/index.yml index 53a4b58..7be3ab4 100644 --- a/index.yml +++ b/index.yml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 7.2.0 + version: 7.4.0 title: Regula Document Reader Web API x-logo: url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg" @@ -22,7 +22,6 @@ servers: - url: http://localhost:8080/ description: Local on-premise installation - paths: /api/process: $ref: "./p-process.yml#/paths/~1process" @@ -62,7 +61,7 @@ tags: - name: document_model x-displayName: Document Model description: | - **Choosen Document model:** + **Chosen Document model:** **Candidates model:** @@ -71,7 +70,6 @@ tags: description: | - x-tagGroups: - name: Requests tags: @@ -87,12 +85,6 @@ x-tagGroups: components: schemas: - Status: - $ref: "./rt-status.yml#/components/schemas/Status" - Text: - $ref: "./rt-text.yml#/components/schemas/Text" - Images: - $ref: "./rt-images.yml#/components/schemas/Images" DocumentImage: $ref: "./common.yml#/components/schemas/ImageData" TransactionImage: @@ -101,7 +93,3 @@ components: $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList" ChosenDocumentType: $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" - AuthenticityCheckResult: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityCheckResult" - AuthenticityResultType: - $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" diff --git a/p-ping.yml b/p-ping.yml index 91a1eff..892af54 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -1,4 +1,7 @@ openapi: 3.0.3 +info: + version: 7.4.0 + title: Regula Document Reader Web API paths: /ping: @@ -18,6 +21,7 @@ paths: components: schemas: DeviceInfo: + title: "DeviceInfo" type: object properties: app-name: diff --git a/p-process.yml b/p-process.yml index 1517255..c4a004f 100644 --- a/p-process.yml +++ b/p-process.yml @@ -1,4 +1,7 @@ openapi: 3.0.3 +info: + version: 7.4.0 + title: Regula Document Reader Web API paths: /process: @@ -135,14 +138,19 @@ paths: components: schemas: - ############################# ############################# Requests objects - - # todo different image input types ProcessRequest: + title: "ProcessRequest" type: object + required: + - processParam properties: + lcidFilter: + type: array + description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." + items: + $ref: "./e-lcid.yml#/components/schemas/LCID" processParam: $ref: "#/components/schemas/ProcessParams" List: @@ -177,22 +185,26 @@ components: description: "Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs." additionalProperties: true - required: - - processParam ProcessParams: + title: "ProcessParams" type: object + required: + - scenario properties: lcidFilter: description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." type: array items: - type: integer + $ref: "./e-lcid.yml#/components/schemas/LCID" + checkLiveness: + description: "This parameter is used to enable document liveness check." + type: boolean lcidIgnoreFilter: description: "The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default." type: array items: - type: integer + $ref: "./e-lcid.yml#/components/schemas/LCID" oneShotIdentification: type: boolean description: "This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person's face" @@ -416,7 +428,7 @@ components: checkAuth: type: boolean description: "This parameter is used to enable authenticity checks" -# default: true + # default: true authParams: $ref: '#/components/schemas/AuthParams' mrzDetectMode: @@ -424,11 +436,10 @@ components: generateNumericCodes: type: boolean description: "This parameter is used to generate numeric representation for issuing state and nationality codes" -# default: false - required: - - scenario + # default: false MRZFormat: + title: "MRZFormat" type: string enum: - "1x30" @@ -453,6 +464,7 @@ components: - "2x30" TextPostProcessing: + title: "TextPostProcessing" type: integer enum: - 0 @@ -471,6 +483,7 @@ components: - "Capital" mrzDetectModeEnum: + title: "mrzDetectModeEnum" type: integer description: "Make better MRZ detection on complex noisy backgrounds, like BW photocopy of some documents." enum: @@ -483,103 +496,91 @@ components: - "eMDM_BlurBeforeBinarization" AuthParams: + title: "AuthParams" type: object properties: checkLiveness: type: boolean description: "This parameter is used to enable document liveness check" -# default: true - + # default: true livenessParams: $ref: '#/components/schemas/LivenessParams' - checkUVLuminiscence: type: boolean description: "This parameter is used to enable Document luminescence check in UV light" -# default: true - + # default: true checkIRB900: type: boolean description: "This parameter is used to enable B900 ink MRZ contrast check in IR light" -# default: true - + # default: true checkImagePatterns: type: boolean description: "This parameter is used to enable Image patterns presence/absence check (position, shape, color)" -# default: true - + # default: true checkFibers: type: boolean description: "This parameter is used to enable Fibers detection" -# default: true - + # default: true checkExtMRZ: type: boolean description: "This parameter is used to enable Extended MRZ Check" -# default: true - + # default: true checkExtOCR: type: boolean description: "This parameter is used to enable Extended OCR Check" -# default: true - + # default: true checkAxial: type: boolean description: "This parameter is used to enable laminate integrity check in axial light" -# default: true - + # default: true checkBarcodeFormat: type: boolean description: "This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)" -# default: true - + # default: true checkIRVisibility: type: boolean description: "This parameter is used to enable Document elements visibility check in IR light" -# default: true - + # default: true checkIPI: type: boolean description: "This parameter is used to enable Invisible Personal Information (IPI) check" -# default: true - + # default: true checkPhotoEmbedding: type: boolean description: "This parameter is used to enable Owner's photo embedding check (is photo printed or sticked)" -# default: true - + # default: true checkPhotoComparison: type: boolean description: "This parameter is used to enable Portrait comparison check" -# default: true - + # default: true checkLetterScreen: type: boolean description: "This parameter is used to enable LetterScreen check" -# default: false - + # default: false LivenessParams: + title: "LivenessParams" type: object properties: checkOVI: type: boolean description: "This parameter is used to enable OVI check" -# default: true + # default: true checkMLI: type: boolean description: "This parameter is used to enable MLI check" -# default: true + # default: true checkHolo: type: boolean description: "This parameter is used to enable Hologram detection" -# default: true + # default: true checkED: type: boolean description: "This parameter is used to enable Electronic device detection" -# default: true + # default: true MeasureSystem: + title: "MeasureSystem" type: integer example: 0 enum: @@ -593,6 +594,7 @@ components: - "IMPERIAL" LogLevel: + title: "LogLevel" type: string enum: - FatalError @@ -613,8 +615,8 @@ components: - "Info" - "Debug" - PerDocumentConfig: + title: "PerDocumentConfig" type: object properties: docID: @@ -627,8 +629,8 @@ components: type: integer example: 2 - ImageQA: + title: "ImageQA" type: object properties: brightnessThreshold: @@ -657,12 +659,16 @@ components: description: "This option enables colorness check while performing image quality validation." type: boolean # default: false + moireCheck: + description: "This option enables screen capture (moire patterns) check while performing image quality validation." + type: boolean documentPositionIndent: description: "This parameter specifies the necessary margin. Default 0." type: integer # default: 0 ProcessRequestImage: + title: "ProcessRequestImage" type: object required: - ImageData @@ -682,6 +688,7 @@ components: image: "" ProcessSystemInfo: + title: "ProcessSystemInfo" type: object properties: license: @@ -694,11 +701,15 @@ components: ############################# ############################# Response objects ProcessResponse: + title: "ProcessResponse" type: object required: + - ChipPage - ProcessingFinished - ContainerList - TransactionInfo + - morePagesAvailable + - elapsedTime properties: ChipPage: $ref: "./common.yml#/components/schemas/RfidLocation" @@ -720,8 +731,12 @@ components: elapsedTime: type: integer description: "Time the document processing has taken, ms." + metadata: + type: object + additionalProperties: true ProcessingStatus: + title: "ProcessingStatus" type: integer enum: - 0 @@ -737,19 +752,39 @@ components: - "TIMEOUT" TransactionInfo: + title: "TransactionInfo" type: object properties: ComputerName: type: string DateTime: type: string + DocumentsDatabase: + $ref: "#/components/schemas/DocumentsDatabase" + SystemInfo: + type: string + Tag: + type: string TransactionID: type: string UserName: type: string + Version: + type: string example: "ComputerName": "7cded6852d20" "DateTime": "2020-05-27T08:17:03.247Z" "TransactionID": "dc5eb444-ad6e-4ebc-8102-d62d5bb56a4e" "UserName": "user" + DocumentsDatabase: + type: object + properties: + Description: + type: string + ExportDate: + type: string + ID: + type: string + Version: + type: string diff --git a/p-transaction.yml b/p-transaction.yml index 6f53059..bd13c8e 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 6.9.0 + version: 7.4.0 title: Regula Document Reader Web API paths: @@ -29,17 +29,7 @@ paths: content: application/json: schema: - type: object - properties: - OutData: - $ref: '#/components/schemas/OutData' - InData: - $ref: '#/components/schemas/InData' - tag: - type: string - transactionId: - type: string - format: uuid + $ref: '#/components/schemas/TransactionProcessResult' "400": description: "Bad request. Check your input data." "403": @@ -97,35 +87,12 @@ paths: content: application/json: schema: - type: object - properties: - ChipPage: - $ref: "./common.yml#/components/schemas/RfidLocation" - ProcessingFinished: - $ref: "./p-process.yml#/components/schemas/ProcessingStatus" - ContainerList: - $ref: "./rt.yml#/components/schemas/ContainerList" - TransactionInfo: - $ref: "./p-process.yml#/components/schemas/TransactionInfo" - log: - description: "Base64 encoded transaction processing log" - type: string - passBackObject: - type: object - description: "Free-form object provided in request. See passBackObject property of ProcessRequest." - additionalProperties: true - morePagesAvailable: - type: integer - elapsedTime: - type: integer - description: "Time the document processing has taken, ms." - CoreLibResultCode: - type: integer - + $ref: '#/components/schemas/TransactionProcessResponse' "400": description: "Bad request. Check your input data." "403": description: "Bad license. Either server or request does not contain valid license." + /transaction/{transactionId}/file: get: parameters: @@ -155,6 +122,7 @@ paths: format: binary "404": description: "File not found" + /tag/{tagId}: delete: parameters: @@ -178,6 +146,7 @@ paths: description: "Bad request. Check your input data." "403": description: "Bad license. Either server or request does not contain valid license." + /tag/{tagId}/transactions: get: parameters: @@ -205,6 +174,7 @@ paths: components: schemas: ListTransactionsByTagResponse: + title: "ListTransactionsByTagResponse" type: object properties: items: @@ -214,7 +184,9 @@ components: metadata: type: object additionalProperties: true + GetTransactionsByTagResponse: + title: "GetTransactionsByTagResponse" type: object properties: id: @@ -228,7 +200,34 @@ components: type: string format: 'date-time' description: "Last time updated" + + TransactionProcessResult: + title: "TransactionProcessResult" + type: object + properties: + OutData: + $ref: '#/components/schemas/OutData' + InData: + $ref: '#/components/schemas/InData' + tag: + type: string + transactionId: + type: string + format: uuid + + TransactionProcessResponse: + title: "TransactionProcessResponse" + allOf: + - type: object + required: + - CoreLibResultCode + properties: + CoreLibResultCode: + type: integer + - $ref: "./p-process.yml#/components/schemas/ProcessResponse" + TransactionProcessGetResponse: + title: "TransactionProcessGetResponse" type: object properties: transactionId: @@ -242,6 +241,7 @@ components: $ref: '#/components/schemas/InData' OutData: + title: "OutData" type: object properties: url: @@ -253,6 +253,7 @@ components: $ref: "#/components/schemas/OutDataTransactionImagesFieldValue" InData: + title: "InData" type: object properties: video: @@ -272,7 +273,10 @@ components: $ref: "#/components/schemas/InDataTransactionImagesFieldValue" TransactionProcessRequest: + title: "TransactionProcessRequest" type: object + required: + - processParam properties: processParam: $ref: "./p-process.yml#/components/schemas/ProcessParams" @@ -299,10 +303,9 @@ components: description: "Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs." additionalProperties: true - required: - - processParam InDataTransactionImagesFieldValue: + title: "InDataTransactionImagesFieldValue" type: object properties: light: @@ -316,6 +319,7 @@ components: description: "Image url" OutDataTransactionImagesFieldValue: + title: "OutDataTransactionImagesFieldValue" type: object properties: fieldType: @@ -331,6 +335,7 @@ components: description: "Image url" TransactionScenarioRequest: + title: "TransactionScenarioRequest" type: object properties: scenario: diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 9773d9d..f6709b9 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -1,9 +1,8 @@ -openapi: 3.0.3 +openapi: 3.1.0 components: schemas: - AuthenticityResult: - title: "Authenticity Checks" + title: "AuthenticityResult" allOf: - type: object required: @@ -14,8 +13,10 @@ components: - $ref: "./rt.yml#/components/schemas/ResultItem" AuthenticityCheckList: + title: "AuthenticityCheckList" type: object required: + - Count - List properties: Count: @@ -28,6 +29,7 @@ components: $ref: "#/components/schemas/AuthenticityCheckResult" AuthenticityCheckResult: + title: "AuthenticityCheckResult" type: object required: - Type @@ -38,22 +40,27 @@ components: $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" Result: $ref: "./common.yml#/components/schemas/CheckResult" + Count: + type: integer + description: "Count of items in List" List: type: array items: anyOf: - - $ref: "#/components/schemas/SecurityFeatureResult" - - $ref: "#/components/schemas/IdentResult" - - $ref: "#/components/schemas/FiberResult" - - $ref: "#/components/schemas/OCRSecurityTextResult" - - $ref: "#/components/schemas/PhotoIdentResult" + - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" + - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" + - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" + - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" + - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" AuthenticityType: + title: "AuthenticityType" type: integer description: "Same as authenticity result type, but used for safe parsing of not-described values: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/" default: 0 AuthenticityCheckResultItem: + title: "AuthenticityCheckResultItem" description: "Common fields for all authenticity result objects" type: object required: @@ -68,51 +75,15 @@ components: PercentValue: type: integer format: double - discriminator: - propertyName: Type - mapping: - 1: "SecurityFeatureResult" - 2: "SecurityFeatureResult" - 4: "IdentResult" - 8: "SecurityFeatureResult" - 16: "FiberResult" - 32: "IdentResult" - 64: "OCRSecurityTextResult" - 128: "PhotoIdentResult" - 256: "PhotoIdentResult" - 512: "SecurityFeatureResult" - 1024: "IdentResult" - 2048: "IdentResult" - 4096: "SecurityFeatureResult" - 8192: "SecurityFeatureResult" - 16384: "FiberResult" - 32768: "IdentResult" - 65536: "SecurityFeatureResult" - 131072: "IdentResult" - 262144: "IdentResult" - 524288: "IdentResult" - 1048576: "IdentResult" - 8388608: "SecurityFeatureResult" - - - SecurityFeatureResult: - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" - - IdentResult: - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" - - FiberResult: - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" - - OCRSecurityTextResult: - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" - - PhotoIdentResult: - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" AreaContainer: + title: "AreaContainer" description: "Checked fragment coordinates" type: object + required: + - Count + - List + - Points properties: Count: type: integer @@ -126,11 +97,14 @@ components: $ref: "#/components/schemas/PointsContainer" PointsContainer: + title: "PointsContainer" type: object + required: + - PointsList properties: PointCount: type: integer PointsList: type: array items: - $ref: "./common.yml#/components/schemas/Point" \ No newline at end of file + $ref: "./common.yml#/components/schemas/Point" diff --git a/rt-barcodes.yml b/rt-barcodes.yml index 415cd59..ce5283a 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -1,20 +1,24 @@ openapi: 3.0.3 components: schemas: - DocBarCodeInfo: - title: "Document BarCode Info" + title: "DocBarCodeInfo" description: "Raw data from BarCodes" allOf: - type: object + required: + - DocBarCodeInfo properties: DocBarCodeInfo: $ref: "#/components/schemas/DocBarCodeInfoFieldsList" - $ref: "./rt.yml#/components/schemas/ResultItem" - DocBarCodeInfoFieldsList: + title: "DocBarCodeInfoFieldsList" type: object + required: + - nFields + - pArrayFields properties: nFields: type: integer @@ -26,10 +30,20 @@ components: $ref: "#/components/schemas/pArrayField" pArrayField: + title: "pArrayField" type: object + required: + - bcAngle_DETECT + - bcCodeResult + - bcCountModule + - bcDataModule + - bcROI_DETECT + - bcType_DECODE + - bcType_DETECT properties: bcAngle_DETECT: - type: float + type: number + format: float bcCodeResult: type: integer bcCountModule: @@ -47,15 +61,24 @@ components: bcTextFieldType: type: integer bcType_DECODE: - type: integer + $ref: "./e-barcode-type.yml#/components/schemas/BarcodeType" bcType_DETECT: type: integer bcPDF417INFO: + title: "bcPDF417INFO" type: object + required: + - Angle + - bcColumn + - bcErrorLevel + - bcRow + - minX + - minY properties: Angle: - type: float + type: number + format: float bcColumn: type: integer bcErrorLevel: @@ -63,12 +86,20 @@ components: bcRow: type: integer minX: - type: float + type: number + format: float minY: - type: float + type: number + format: float bcROI_DETECT: + title: "bcROI_DETECT" type: object + required: + - bottom + - left + - right + - top properties: bottom: type: integer @@ -80,7 +111,12 @@ components: type: integer DataModule: + title: "DataModule" type: object + required: + - mData + - mLength + - mType properties: mData: type: string @@ -91,4 +127,26 @@ components: mReserver2: type: integer mType: - type: integer + $ref: "#/components/schemas/BarCodeModuleType" + + BarCodeModuleType: + title: "BarCodeModuleType" + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + x-enum-descriptions: + - "Module contains text data" + - "Module contains byte data" + - "Module contains numeric data" + - "Shifts in byte compaction mode (for PDF417)" + - "Module contains any data" + x-enum-varnames: + - "TEXT" + - "BYTE" + - "NUM" + - "SHIFT" + - "ALL" diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index d4ef6c0..9f1e299 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -1,13 +1,14 @@ openapi: 3.0.3 components: schemas: - ChosenDocumentTypeResult: - title: "Chosen Document Type" + title: "ChosenDocumentTypeResult" description: "Contains information about the type of document that was determined based on the analysis of the provided image" allOf: - type: object + required: + - OneCandidate properties: OneCandidate: $ref: "#/components/schemas/OneCandidate" @@ -17,7 +18,7 @@ components: - $ref: "./rt.yml#/components/schemas/ResultItem" DocumentTypesCandidatesResult: - title: "Document Types Candidates" + title: "DocumentTypesCandidatesResult" allOf: - type: object properties: @@ -25,8 +26,8 @@ components: $ref: "#/components/schemas/DocumentTypesCandidatesList" - $ref: "./rt.yml#/components/schemas/ResultItem" - DocumentTypesCandidatesList: + title: "DocumentTypesCandidatesList" type: object properties: RecResult: @@ -38,6 +39,7 @@ components: $ref: "#/components/schemas/OneCandidate" DocumentTypeRecognitionResult: + title: "DocumentTypeRecognitionResult" type: integer enum: - 0 @@ -54,8 +56,21 @@ components: OneCandidate: + title: "OneCandidate" type: object description: "Contains information about one document type candidate" + required: + - DocumentName + - ID + - P + - Rotated180 + - RFID_Presence + - FDSIDList + - NecessaryLights + - CheckAuthenticity + - UVExp + - AuthenticityNecessaryLights + - OVIExp properties: DocumentName: type: string @@ -69,6 +84,9 @@ components: example: 0.9913095831871032 minimum: 0 maximum: 1 + Rotated180: + description: "true if the document of the given type is rotated by 180 degrees" + type: boolean RFID_Presence: description: "Indication of the presence of an RFID chip in the document (electronic document indicator)" $ref: "./common.yml#/components/schemas/RfidLocation" @@ -88,16 +106,33 @@ components: type: integer description: "Combination of lighting scheme identifiers (combination of Light enum) needed to perform all authenticity checks specified in CheckAuthenticity" + OVIExp: + description: "Camera exposure value necessary when obtaining document images of the given type for AXIAL lighting scheme" + type: number FDSIDList: + title: "FDSIDList" description: "Extended document type info and Regula's 'Information Reference Systems' links" type: object + required: + - ICAOCode + - Count + - List + - dType + - dFormat + - dMRZ + - dYear + - dCountryName + - isDeprecated properties: ICAOCode: type: string minLength: 3 maxLength: 3 description: "ICAO code of the issuing country" + Count: + description: "Number of elements in the List" + type: number List: type: array items: @@ -130,9 +165,11 @@ components: description: "Whether the document is deprecated" DocumentFormat: + title: "DocumentFormat" type: integer description: "Defining the geometric format of documents in accordance with ISO / IEC 7810" enum: + - -1 - 0 - 1 - 2 @@ -147,6 +184,7 @@ components: - 1000 - 1002 x-enum-descriptions: + - "Unknown document format" - "ID1 document format" - "ID2 document format" - "ID3 document format" @@ -161,6 +199,7 @@ components: - "Arbitrary format" - "Flexible format. Standard formats can be resized during cropping, depending on various factors: light, background..." x-enum-varnames: + - "UNKNOWN" - "ID1" - "ID2" - "ID3" diff --git a/rt-document-position.yml b/rt-document-position.yml index a25739d..f427b16 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -1,27 +1,43 @@ openapi: 3.0.3 components: schemas: - DocumentPositionResult: - title: "Document Position" + title: "DocumentPositionResult" description: "Contains information about document position on the input image, its center, angle, etc" allOf: - type: object + required: + - DocumentPosition properties: DocumentPosition: $ref: "#/components/schemas/DocumentPosition" - $ref: "./rt.yml#/components/schemas/ResultItem" DocumentPosition: + title: "DocumentPosition" type: object + required: + - docFormat + - Angle + - Width + - Height + - Center + - LeftBottom + - LeftTop + - RightBottom + - RightTop + - Dpi properties: docFormat: $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" Angle: + description: "Document rotation angle" type: number Width: + description: "Document width" type: integer Height: + description: "Document height" type: integer Center: $ref: "./common.yml#/components/schemas/Point" diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml index 524cecc..edc5976 100644 --- a/rt-encrypted-rcl.yml +++ b/rt-encrypted-rcl.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - EncryptedRCLResult: - title: "EncryptedRCL" + title: "EncryptedRCLResult" allOf: - type: object description: "Contains encrypted result container list" diff --git a/rt-image-data.yml b/rt-image-data.yml index 44fa57b..9c13170 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - GraphicsResult: - title: "Graphics (legacy)" + title: "GraphicsResult" description: "Graphic fields extracted from one of the document sources. Returns separate results for each provided page." required: @@ -15,39 +14,72 @@ components: $ref: "#/components/schemas/GraphicFieldsList" - $ref: "./rt.yml#/components/schemas/ResultItem" - GraphicFieldsList: + title: "GraphicFieldsList" type: object required: - pArrayFields + - nFields properties: pArrayFields: type: array items: - $ref: "#/components/schemas/GraphicField" + anyOf: + - $ref: "#/components/schemas/GraphicFieldRect" + - $ref: "#/components/schemas/GraphicFieldRfid" + nFields: + description: "Number of pArrayFields array elements" + type: number + + GraphicFieldRect: + title: "GraphicFieldRect" + description: "Information about one graphic field, which is a rectangle" + required: + - FieldRect + allOf: + - type: object + properties: + FieldRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + - $ref: "#/components/schemas/GraphicField" + + GraphicFieldRfid: + title: "GraphicFieldRfid" + description: "Information about one graphic field, which is a RFID" + required: + - RFID_OriginDG + - RFID_OriginDGTag + - RFID_OriginTagEntry + - RFID_OriginEntryView + allOf: + - type: object + properties: + RFID_OriginDG: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + RFID_OriginDGTag: + description: "Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result." + type: integer + RFID_OriginTagEntry: + type: integer + description: "Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result." + RFID_OriginEntryView: + type: integer + description: "Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result." + - $ref: "#/components/schemas/GraphicField" GraphicField: + title: "GraphicField" + description: "Information about one graphic field - abstract class" type: object required: - FieldType + - FieldName - image properties: FieldType: $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + FieldName: + description: "Graphic field symbolic name" + type: string image: $ref: "./common.yml#/components/schemas/ImageData" - FieldRect: - description: "Coordinates of the graphic field in the normalized image of the document" - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - RFID_OriginDG: - description: "Source data group file. Only for Result.RFID_GRAPHICS result." - type: integer - RFID_OriginDGTag: - description: "Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result." - type: integer - RFID_OriginTagEntry: - type: integer - description: "Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result." - RFID_OriginEntryView: - type: integer - description: "Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result." diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 4a4e2f2..440a808 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - ImageQualityResult: - title: "Image Quality Checks" + title: "ImageQualityResult" allOf: - type: object required: @@ -13,12 +12,13 @@ components: $ref: "#/components/schemas/ImageQualityCheckList" - $ref: "./rt.yml#/components/schemas/ResultItem" - ImageQualityCheckList: + title: "ImageQualityCheckList" type: object required: - result - List + - Count properties: result: description: "Overall image quality status, combined from check statuses in the list." @@ -27,8 +27,12 @@ components: type: array items: $ref: "#/components/schemas/ImageQualityCheck" + Count: + description: "Number of List array elements" + type: number ImageQualityCheckType: + title: "ImageQualityCheckType" type: integer description: "Image quality check type" enum: @@ -60,8 +64,16 @@ components: - "Signals if the document image is bright enough" AreaArray: + title: "AreaArray" type: object + required: + - Count + - List + - Points properties: + Count: + description: "Number of elements in List and Points" + type: number List: type: array items: @@ -72,7 +84,10 @@ components: $ref: "#/components/schemas/PointArray" PointArray: + title: "PointArray" type: object + required: + - PointsList properties: PointsList: type: array @@ -80,7 +95,15 @@ components: $ref: "./common.yml#/components/schemas/Point" ImageQualityCheck: + title: "ImageQualityCheck" type: object + required: + - type + - result + - featureType + - mean + - std_dev + - probability properties: type: $ref: "#/components/schemas/ImageQualityCheckType" @@ -91,10 +114,13 @@ components: areas: $ref: "#/components/schemas/AreaArray" mean: + description: "Check mean value" type: number format: float std_dev: + description: "Check deviation value" type: number format: float probability: + description: "Check probability value" type: integer diff --git a/rt-images.yml b/rt-images.yml index ec74b62..7d6f398 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - ImagesResult: - title: "Images" + title: "ImagesResult" allOf: - type: object required: @@ -13,13 +12,21 @@ components: $ref: "#/components/schemas/Images" - $ref: "./rt.yml#/components/schemas/ResultItem" - Images: + title: "Images" type: object required: + - fieldCount + - availableSourceCount - availableSourceList - fieldList properties: + fieldCount: + type: integer + description: "Fields count" + availableSourceCount: + type: integer + description: "Available sources count" availableSourceList: type: array items: @@ -30,10 +37,11 @@ components: $ref: "#/components/schemas/ImagesField" ImagesAvailableSource: + title: "ImagesAvailableSource" type: object required: + - containerType - source - - sourceName properties: containerType: $ref: "./rt.yml#/components/schemas/ContainerType" @@ -41,11 +49,13 @@ components: $ref: "./common.yml#/components/schemas/Source" ImagesField: + title: "ImagesField" type: object required: - fieldName - fieldType - valueList + - valueCount properties: fieldName: $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldName" @@ -55,15 +65,18 @@ components: type: array items: $ref: "#/components/schemas/ImagesFieldValue" + valueCount: + description: "Field value count" + type: number ImagesFieldValue: + title: "ImagesFieldValue" type: object required: - containerType - lightIndex - pageIndex - source - - value properties: source: $ref: "./common.yml#/components/schemas/Source" @@ -86,4 +99,4 @@ components: $ref: "./common.yml#/components/schemas/RectangleCoordinates" rfidOrigin: description: "Only for images from RFID. Image location in RFID chip." - $ref: "./common.yml#/components/schemas/RfidOrigin" \ No newline at end of file + $ref: "./common.yml#/components/schemas/RfidOrigin" diff --git a/rt-license.yml b/rt-license.yml index fdfe20a..b89d64f 100644 --- a/rt-license.yml +++ b/rt-license.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - LicenseResult: - title: "License" + title: "LicenseResult" allOf: - type: object description: "Contains license" diff --git a/rt-ocr-lexical-analisis.yml b/rt-ocr-lexical-analysis.yml similarity index 88% rename from rt-ocr-lexical-analisis.yml rename to rt-ocr-lexical-analysis.yml index f5c0f35..1e01fac 100644 --- a/rt-ocr-lexical-analisis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - LexicalAnalysisResult: - title: "Lexical Analysis" + title: "LexicalAnalysisResult" description: | Lexical data analysis allows you to compare the results of reading the text data of the MRZ, the document filling area, barcodes and data from the memory of the RFID chip for an additional @@ -11,22 +10,35 @@ components: Consider using Result.TEXT type for more simplicity. allOf: - type: object + required: + - ListVerifiedFields properties: ListVerifiedFields: $ref: "#/components/schemas/ListVerifiedFields" - $ref: "./rt.yml#/components/schemas/ResultItem" - ListVerifiedFields: + title: "ListVerifiedFields" type: object + required: + - Count + - pFieldMaps properties: + Count: + description: "Number of pFieldMaps array elements" + type: number pFieldMaps: type: array items: $ref: "#/components/schemas/VerifiedFieldMap" VerifiedFieldMap: + title: "VerifiedFieldMap" type: object + required: + - wFieldType + - wLCID + - Matrix properties: wFieldType: $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" @@ -51,6 +63,7 @@ components: {FieldType: 185, Field_MRZ: "37", Field_Visual: "37", Matrix: [1,0,0,0,0,3,0,0,0,0]} ComparisonMatrix: + title: "ComparisonMatrix" type: array minItems: 10 maxItems: 10 @@ -74,6 +87,7 @@ components: example: [1,0,0,0,0,3,0,0,0,0] VerificationResult: + title: "VerificationResult" type: integer enum: - 0 diff --git a/rt-raw-image.yml b/rt-raw-image.yml index 9812450..4f1eedc 100644 --- a/rt-raw-image.yml +++ b/rt-raw-image.yml @@ -1,17 +1,28 @@ openapi: 3.0.3 components: schemas: - DocumentImageResult: - title: "Document Image" + title: "DocumentImageResult" + description: "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" allOf: - type: object - description: "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" required: - RawImageContainer properties: RawImageContainer: - $ref: "./common.yml#/components/schemas/ImageData" + $ref: "#/components/schemas/RawImageContainerFieldList" - $ref: "./rt.yml#/components/schemas/ResultItem" + + RawImageContainerFieldList: + title: "RawImageContainerFieldList" + allOf: + - type: object + required: + - format + properties: + format: + description: "Image format" + type: string + - $ref: "./common.yml#/components/schemas/ImageData" diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml new file mode 100644 index 0000000..bc8cbc3 --- /dev/null +++ b/rt-rfid-binary-data.yml @@ -0,0 +1,956 @@ +openapi: 3.0.3 +components: + schemas: + DocumentBinaryInfoResult: + title: "DocumentBinaryInfoResult" + allOf: + - type: object + description: "Structure is used to store the data reading results from the RFID-chip in + a form of a list of the logically separated data groups." + required: + - TDocBinaryInfo + properties: + TDocBinaryInfo: + $ref: "#/components/schemas/TDocBinaryInfo" + - $ref: "./rt.yml#/components/schemas/ResultItem" + + TDocBinaryInfo: + title: "TDocBinaryInfo" + type: object + required: + - RFID_BINARY_DATA + properties: + RFID_BINARY_DATA: + $ref: "#/components/schemas/BinaryData" + + BinaryData: + title: "BinaryData" + description: "Structure is used for storing the results of one bar-code module reading." + type: object + required: + - RFID_DG1 + - RFID_Session_Data + - RFID_ePassp_Directory + properties: + RFID_DG1: + $ref: "#/components/schemas/RfidDG1" + RFID_Session_Data: + $ref: "#/components/schemas/RfidSessionData" + RFID_ePassp_Directory: + description: Indexes of groups that aren't read + type: array + items: + type: integer + + RfidDG1: + title: "RfidDG1" + description: "Structure used to store the contents of EF.DG1 informational data group of + ePassport application – document MRZ data" + type: object + required: + - Type + - DocumentID + - DocumentType + - State + - Holder + - DocumentNumber + - CheckDigitDocumentNumber + - Nationality + - Birthday + - CheckDigitBirthday + - Sex + - ExpiryDate + - CheckDigitExpiryDate + - OptionalData + - CheckDigitOptionalData + - CheckDigitComposite + properties: + Type: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + DocumentID: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" + DocumentType: + description: "Symbolic code of document type" + type: string + State: + description: "Symbolic code of document issuing state" + type: string + Holder: + description: "DO’s name and surname" + type: string + DocumentNumber: + description: "Document number" + type: string + CheckDigitDocumentNumber: + description: "Check digit of document number" + type: number + Nationality: + description: "Symbolic code of DO’s nationality" + type: string + Birthday: + description: "DO’s date of birth" + type: string + CheckDigitBirthday: + description: "Check digit of DO’s date of birth" + type: number + Sex: + description: "DO’s sex" + type: string + ExpiryDate: + description: "Term of validity of the document" + type: string + CheckDigitExpiryDate: + description: "Check digit of term of validity of the document" + type: number + OptionalData: + description: "DO’s personal number or other additional data" + type: string + CheckDigitOptionalData: + description: "Check digit of additional data" + type: number + CheckDigitComposite: + description: "General check digit" + type: number + + RfidSessionData: + title: "RfidSessionData" + description: "Structure is used to describe the results of work with the SDK within the context of the current communication + session with electronic document" + type: object + required: + - VirtualMode + - SDKVersion + - DriverVersion + - FirmwareVersion + - Applications + - AccessControls + - CardProperties + - ExtLeSupport + - ProcessTime + - RootFiles + - TotalBytesSent + - TotalBytesReceived + - Session_key + - Session_terminal + - Session_procedure + - SecurityObjects + properties: + VirtualMode: + description: "Sign of virtual session when working with loaded data from a previous communication session + with the electronic document" + SDKVersion: + description: "Text SDKVersion value in format A.B (e.g. 3.1)" + DriverVersion: + description: "Text DriverVersion value in format A.B.C.D (e.g. 6.2.5.4)" + FirmwareVersion: + description: "Text FirmwareVersion value in format A.B (e.g. 5.19)" + Applications: + description: "List of containers to store information about the involved applications of electronic document" + type: array + items: + $ref: "#/components/schemas/RfidApplication" + AccessControls: + description: "List of containers to store information about the supported procedures of authentication and secure data access + within the context of the session" + type: array + items: + $ref: "#/components/schemas/RfidAccessControlInfo" + CardProperties: + $ref: "#/components/schemas/RfidCardPropertiesExt" + ExtLeSupport: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ProcessTime: + description: "Time of processing, milliseconds" + type: number + RootFiles: + description: "List of containers to store information about the read files of the root Master File" + type: array + items: {} + TotalBytesSent: + description: "Total number of bytes transmitted to the RFID-chip during the whole session" + type: number + TotalBytesReceived: + description: "Total number of bytes received from the RFID-chip during the whole session" + type: number + Session_key: + $ref: "#/components/schemas/RfidAccessKey" + Session_terminal: + $ref: "#/components/schemas/RfidTerminal" + Session_procedure: + $ref: "#/components/schemas/RfidAuthenticationProcedureType" + SecurityObjects: + description: "List of containers to store information about the detected document security objects" + type: array + items: + $ref: "#/components/schemas/RfidSecurityObject" + + RfidSecurityObject: + title: "RfidSecurityObject" + description: "Structure is used to describe the contents of a single document security object (SO) and the results of its check + within the context of the communication session with electronic document" + type: object + required: + - Version + - ObjectType + - FileReference + - Notifications + - SignerInfos + properties: + Version: + description: "Security object version" + type: number + ObjectType: + description: "Identifier of the security object" + type: string + FileReference: + description: "Reference to the source file of the security object data" + type: number + Notifications: + description: "List of remarks arisen during the analysis of SO data structure." + type: array + items: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + SignerInfos: + description: "List of containers to store information about digital signature objects contained in the SO" + type: array + items: + $ref: "#/components/schemas/RfidSignerInfoEx" + + RfidSignerInfoEx: + title: "RfidSignerInfoEx" + description: "Structure is used to describe the contents of a single copy of + digital signature of the document security object and the results of its check within the + context of the communication session with electronic document" + type: object + required: + - Version + - Issuer + - SerialNumber + - SubjectKeyIdentifier + - DigestAlgorithm + - SignedAttributes + - SignatureAlgorithm + - Signature + - PA_Status + - CertificateChain + - DataToHash + - Notifications + properties: + Version: + description: "Version of SignerInfo ASN.1 structure" + type: number + Issuer: + $ref: "#/components/schemas/RfidDistinguishedName" + SerialNumber: + $ref: "#/components/schemas/TrfFtBytes" + SubjectKeyIdentifier: + $ref: "#/components/schemas/TrfFtBytes" + DigestAlgorithm: + description: "Hash algorithm identifier (OID) for digital signature generation" + type: string + SignedAttributes: + description: "List of the signed attributes" + type: array + items: + $ref: "#/components/schemas/RfidAttributeData" + SignatureAlgorithm: + description: "Digital signature algorithm identifier (OID)" + type: string + Signature: + $ref: "#/components/schemas/TrfFtBytes" + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + CertificateChain: + description: "Certificate chain, used for the digital signature verification." + type: array + items: + $ref: "#/components/schemas/RfidCertificateEx" + DataToHash: + description: "Binary data array used to calculate the hash value for digital signature verification. Base64 encoded." + type: string + Notifications: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + + RfidCertificateEx: + title: "RfidCertificateEx" + description: "Structure is used to describe the certificate contents used for the digital signature verification + of the document security object within the context of the communication session with electronic document." + type: object + required: + - Version + - SerialNumber + - SignatureAlgorithm + - Issuer + - Validity + - Subject + - SubjectPKAlgorithm + - Extensions + - Notifications + - Origin + - Type + - FileName + - PA_Status + properties: + Version: + description: "Version of Certificate ASN.1 structure" + type: number + SerialNumber: + description: "Certificate serial number. Base64 encoded." + type: string + SignatureAlgorithm: + description: "Certificate digital signature algorithm identifier (OID); + String in the format S1 (S2), where S1 – algorithm name, S2 – identifier (OID string)." + type: string + Issuer: + $ref: "#/components/schemas/RfidDistinguishedName" + Validity: + $ref: "#/components/schemas/RfidValidity" + Subject: + $ref: "#/components/schemas/RfidDistinguishedName" + SubjectPKAlgorithm: + description: "Certificate public key algorithm identifier (OID); + String in the format S1 (S2), where S1 – algorithm name, S2 – identifier (OID string)." + type: string + Extensions: + description: "List of the certificate extensions" + type: array + items: + $ref: "#/components/schemas/RfidPkiExtension" + Notifications: + description: "List of remarks arisen during the analysis of the certificate data + structure and its validity verification." + type: array + items: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + Origin: + $ref: "#/components/schemas/RfidCertificateOrigin" + Type: + $ref: "#/components/schemas/RfidCertificateType" + FileName: + $ref: "#/components/schemas/TrfFtString" + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + + RfidPkiExtension: + title: "RfidPkiExtension" + description: "Extension identifier (OID, ASCII string); + Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: object + required: + - Type + - Data + properties: + Type: + description: "Extension identifier (OID, ASCII string); + Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: string + Data: + description: "Extension binary data. Base64 encoded." + type: string + + RfidValidity: + title: "RfidValidity" + description: "Structure contains information on a certificate validity." + type: object + required: + - NotBefore + - NotAfter + properties: + NotBefore: + $ref: "#/components/schemas/TrfFtString" + NotAfter: + $ref: "#/components/schemas/TrfFtString" + + RfidAttributeData: + title: "RfidAttributeData" + description: "Structure contains the data of one attribute of the digital signature object." + type: object + required: + - Type + - Data + properties: + Type: + description: "Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: string + Data: + description: "Attribute binary data. Base64 encoded." + type: string + + RfidDistinguishedName: + title: "RfidDistinguishedName" + description: "Contents of the identifier in binary form. Base64 encoded." + type: object + required: + - Data + - FriendlyName + - Attributes + properties: + Data: + description: "Contents of the identifier in binary form. Base64 encoded." + type: string + FriendlyName: + $ref: "#/components/schemas/TrfFtString" + Attributes: + description: "List of individual attributes contained in the identifier" + type: array + items: + $ref: "#/components/schemas/RfidAttributeName" + + RfidAttributeName: + title: "RfidAttributeName" + description: "Structure contains information that serves as the distinguished name (identifier) of an object." + type: object + required: + - Type + - Value + properties: + Type: + description: "Attribute identifier (OID ASCII string); contents of the identifier in the format S1 (S2), + where S1 – attribute name, S2 – identifier (OID string)" + type: string + Value: + $ref: "#/components/schemas/TrfFtString" + + TrfFtString: + title: "TrfFtString" + description: "Structure is used to store information about the numeric field (4 bytes) that is a part of one of the informational + data groups." + type: object + required: + - Type + - Status + - Format + - Data + properties: + Type: + anyOf: + - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + Status: + description: "Result of logical analysis of compliance of the contents of the field + with the requirements of the specification" + anyOf: + - $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" + - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + Format: + description: "Mask of format of text information (for example, «YYMMDD» for date of birth)" + type: string + Data: + description: "Numeric value." + type: string + + RfidApplication: + title: "RfidApplication" + description: "Structure is used to describe the contents of a single LDS application and their analysis within the context + of the communication session with electronic document" + type: object + required: + - Type + - Status + - ApplicationID + - Version + - UnicodeVersion + - DataHashAlgorithm + - Files + properties: + Type: + $ref: "#/components/schemas/RfidApplicationType" + Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ApplicationID: + description: "Application identifier" + type: string + Version: + description: "Version of the application" + type: string + UnicodeVersion: + description: "Unicode version for application" + type: string + DataHashAlgorithm: + description: "Algorithm for calculating hash values for files for the procedure of PA" + type: string + Files: + description: "List of containers to store information about the read files of the application" + type: array + items: + $ref: "#/components/schemas/RfidDataFile" + + RfidApplicationType: + title: "RfidApplicationType" + type: integer + description: "Enumeration contains a set of constants that define the type + of application within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 0 + x-enum-descriptions: + - "Not defined" + - "ePassport application" + - "eID application" + - "eSign application" + - "eDL application" + - "Master File" + x-enum-varnames: + - "UNSPECIFIED" + - "E_PASSPORT" + - "E_ID" + - "E_SIGN" + - "E_DL" + - "ROOT_FILES" + + RfidDataFile: + title: "RfidDataFile" + description: "Structure is used to describe the contents of a single file of the LDS of electronic document and the analysis + of its contents within the context of the communication session with electronic document" + type: object + required: + - Type + - ReadingStatus + - ReadingTime + - PA_Status + - Notifications + - DocFields_Text + - DocFields_Graphics + - DocFields_Originals + properties: + FileID: + description: "File identifier. Each byte of FileID represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. 01 1E)" + type: string + Type: + $ref: "./e-rfid-data-file-type.yml#/components/schemas/RfidDataFileType" + FileData: + $ref: "#/components/schemas/TrfFtBytes" + ReadingStatus: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ReadingTime: + description: "Time of reading, milliseconds" + type: number + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + Notifications: + description: "List of remarks arisen when reading data from the memory of the chip and analysing their ASN.1-structure." + type: array + items: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + DocFields_Text: + description: "List of document text fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + DocFields_Graphics: + description: "List of document graphic fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + DocFields_Originals: + description: "List of the original binary representation of graphic document fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + + TrfFtBytes: + title: "TrfFtBytes" + description: "Structure is used to store an array of binary information that is a part of one of the informational data groups" + type: object + required: + - Type + - Status + - Length + - Data + properties: + Type: + description: "Logical type of the field" + anyOf: + - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + Status: + description: "Result of logical analysis of compliance of the contents of the field + with the requirements of the specification" + type: number + Length: + description: "Length of Data array" + type: number + Data: + description: "Binary data array. Base64 encoded." + type: string + + RfidAccessControlInfo: + title: "RfidAccessControlInfo" + description: "Structure is used to describe the results of a single authentication procedure or a procedure of secure data access + within the context of the communication session with electronic document" + type: object + required: + - Type + - Status + - Notifications + properties: + Type: + $ref: "#/components/schemas/RfidAccessControlProcedureType" + Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ActiveOptionIdx: + description: "Index of the active variant of the procedure" + type: number + Notifications: + description: "List of remarks arisen during the procedure." + type: array + items: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + AccessControlOptions: + description: "List of structures with are used to describe the variants of the authentication or secure data access procedure + performance within the context of the communication session with electronic document" + type: array + items: {} + + RfidAccessControlProcedureType: + title: "RfidAccessControlProcedureType" + type: integer + description: "Enumeration contains a set of constants that + define the type of authentication or secure data access procedure" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 10 + x-enum-descriptions: + - "Type is not defined" + - "BAC/BAP" + - "PACE" + - "CA" + - "TA" + - "AA" + - "RI" + - "Card info" + x-enum-varnames: + - "UNDEFINED" + - "BAC" + - "PACE" + - "CA" + - "TA" + - "AA" + - "RI" + - "CARD_INFO" + + RfidCardPropertiesExt: + title: "RfidCardPropertiesExt" + description: "Structure is used to store extended information about the + characteristics of the RFID-chip located in the scope of the reader" + type: object + required: + - RFID_Type + - Baudrate1 + - Baudrate2 + - Support_4 + - ChipType_A + - Support_Mifare + - MifareMemory + - UID + - ATQ_A + - SAK + - ATQ_B + - BitRateS + - BitRateR + - ATR + properties: + RFID_Type: + $ref: "#/components/schemas/RfidType" + Baudrate1: + description: "Numeric Baudrate1 value in hexadecimal format (e.g. 0x0000000F)" + type: string + Baudrate2: + description: "Numeric Baudrate2 value in hexadecimal format" + type: string + Support_4: + description: "Boolean Support_4 value" + type: boolean + ChipType_A: + $ref: "#/components/schemas/RfidAChip" + Support_Mifare: + description: "Sign of support for ISO/IEC 14443-3 data exchange protocol" + type: boolean + MifareMemory: + description: "Amount of operational memory MIFARE® of the chip, kilobytes" + type: number + UID: + description: "UID contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are separated + by spaces (e.g. F9 4F 41 60)" + type: string + ATQ_A: + description: "Reply of the «A» type chip to «REQA» command of ISO/IEC 14443-3 + protocol (Answer To Request, Type A – ATQA) – for the internal use by + the main control library" + SAK: + description: "Response of type-A RFID-chip to SELECT command of ISO/IEC 14443-3 protocol (Select Acknowledge, SAK)." + ATQ_B: + description: "ATQ_B contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are + separated by spaces (e.g. 50 F9 4F 41 60 00 00 00 00 77 81 81)" + BitRateS: + $ref: "#/components/schemas/RfidBaudRate" + BitRateR: + $ref: "#/components/schemas/RfidBaudRate" + ATR: + description: "ATR-string of RFID-chip" + type: string + + RfidType: + title: "RfidType" + type: integer + description: "Enumeration contains a set of constants specifying the type of the RFID-chip + by the physical parameters of connection between antennas of the chip and the reader" + enum: + - 0 + - 1 + - 2 + x-enum-descriptions: + - "Unknown" + - "Type A" + - "Type B" + x-enum-varnames: + - "UNKNOWN" + - "A" + - "B" + + RfidAChip: + title: "RfidAChip" + type: integer + description: "Enumeration contains a set of constants specifying the type of the RFIDchip from MIFARE® family + (for chips of type A)" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + x-enum-descriptions: + - "Unknown" + - "MIFARE® 1K" + - "MIFARE® 4K" + - "MIFARE® Ultralight" + - "MIFARE® DESFire" + - "MIFARE® ProX or SmartMX xD(T)" + x-enum-varnames: + - "UNKNOWN" + - "MIFARE_1K" + - "MIFARE_4K" + - "MIFARE_ULTRALIGHT" + - "MIFARE_DES_FIRE" + - "MIFARE_PROX" + + RfidBaudRate: + title: "RfidBaudRate" + type: integer + description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" + enum: + - 0X00 + - 0X01 + - 0X02 + - 0X04 + - 0X08 + x-enum-descriptions: + - "Unknown" + - "106 bits/s" + - "212 bits/s" + - "424 bits/s" + - "848 bits/s" + x-enum-varnames: + - "UNKNOWN" + - "RFBR_106" + - "RFBR_212" + - "RFBR_424" + - "RFBR_848" + + RfidAccessKey: + title: "RfidAccessKey" + description: "Structure is used to describe the contents of secure data access key within + the context of the communication session with electronic document" + type: object + required: + - AccessKey + - KeyType + - AccessType + - CheckFullKeyMatching + properties: + AccessKey: + description: "Key contents" + type: string + KeyType: + $ref: "#/components/schemas/RfidPasswordType" + AccessType: + $ref: "#/components/schemas/RfidAccessControlProcedureType" + CheckFullKeyMatching: + description: "Logical sign of the need for a full comparison of AccessKey + contents with the contents of DG1 (MRZ) data group" + type: boolean + + RfidPasswordType: + title: "RfidPasswordType" + type: integer + description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + x-enum-descriptions: + - "Unknown type" + - "MRZ" + - "CAN" + - "PIN" + - "PUK" + - "eSign-PIN" + - "Scanning Area Identifier (for eDL application)" + x-enum-varnames: + - "UNKNOWN" + - "MRZ" + - "CAN" + - "PIN" + - "PUK" + - "PIN_E_SIGN" + - "SAI" + + RfidTerminal: + title: "RfidTerminal" + description: "Structure is used to describe the terminal type within the context of the + communication session with electronic document" + type: object + required: + - TermType + - AuthReq + - AuthReq2 + properties: + TermType: + $ref: "#/components/schemas/RfidTerminalType" + AuthReq: + description: "Declared (set) combination of flags of access rights to the functionality of the document (combination of + eRfidTerminalAuthorizationRequirement values)" + type: number + AuthReq2: + description: "Declared (set) combination of flags of access rights to the functionality of the document (combination of + RfidTerminalAuthorizationRequirement values)" + type: number + + RfidTerminalType: + title: "RfidTerminalType" + type: integer + description: "Enumeration contains a set of constants that define the type + of terminal within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + x-enum-descriptions: + - "Not defined" + - "Inspection system" + - "Authentication terminal" + - "Signature terminal" + - "Unauthenticated terminal" + x-enum-varnames: + - "UNDEFINED" + - "INSPECTION_SYSTEM" + - "AUTHENTICATION_TERMINAL" + - "SIGNATURE_TERMINAL" + - "UNAUTHENTICATED_TERMINAL" + + RfidAuthenticationProcedureType: + title: "RfidAuthenticationProcedureType" + type: integer + description: "Enumeration contains a set of constants that define the type of performed procedure of document authentication + within the current session" + enum: + - 0 + - 1 + - 2 + - 3 + x-enum-descriptions: + - "Not defined" + - "Standard authentication procedure" + - "Advanced authentication procedure" + - "General authentication procedure" + x-enum-varnames: + - "UNDEFINED" + - "STANDARD" + - "ADVANCED" + - "GENERAL" + + RfidCertificateOrigin: + title: "RfidCertificateOrigin" + type: integer + description: "Enumeration contains a set of constants that define the source of certificate used in the procedure + of document security object digital signature verification" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + x-enum-descriptions: + - "The source is not defined" + - "Local PKD" + - "Document security object" + - "User-defined" + - "Contents of the Master List" + - "Security object of the Master List" + - "Security object of the Defect List" + - "Security object of the Deviation List" + - "Security object of the Black List" + x-enum-varnames: + - "UNDEFINED" + - "PKD" + - "SECURITY_OBJECT" + - "USER_DEFINED" + - "MASTER_LIST_PKD" + - "MASTER_LIST_SO" + - "DEFECT_LIST_SO" + - "DEVIATION_LIST_SO" + - "BLACK_LIST_SO" + + RfidCertificateType: + title: "RfidCertificateType" + type: integer + description: "Enumeration contains a set of constants that define the type + of certificate used in the procedure of document security object digital signature verification" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + x-enum-descriptions: + - "Type is not defined" + - "CSCA" + - "CSCA-link" + - "DS" + - "Master List signer" + - "Deviaton List signer" + - "Defect List signer" + - "Black List signer" + x-enum-varnames: + - "UNDEFINED" + - "CSCA" + - "CSCA_LINK" + - "DS" + - "MLS" + - "DEV_LS" + - "DEF_LS" + - "BLS" diff --git a/rt-status.yml b/rt-status.yml index f394618..59d2a5e 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - StatusResult: - title: "Status" + title: "StatusResult" allOf: - type: object required: @@ -19,14 +18,18 @@ components: # see https://github.com/OAI/OpenAPI-Specification/issues/556#issuecomment-192007034 # but java codegen produce invalid code for allOf `int complete=null` Status: + title: "Status" type: object required: - overallStatus - optical + - portrait + - rfid + - stopList - detailsOptical properties: overallStatus: - description: "Overall checks status. Root status." + description: "Overall checks status. Rootx status." $ref: "./common.yml#/components/schemas/CheckResult" optical: description: "Overall optical checks combined status" @@ -48,6 +51,7 @@ components: $ref: "#/components/schemas/detailsOptical" detailsOptical: + title: "detailsOptical" type: object required: - overallStatus @@ -85,6 +89,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" detailsRFID: + title: "detailsRFID" type: object required: - overallStatus diff --git a/rt-text-data.yml b/rt-text-data.yml index f7f1d67..10944c3 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -1,94 +1,160 @@ openapi: 3.0.3 components: schemas: - TextDataResult: - title: "Text Data (legacy)" + title: "TextDataResult" description: "Text fields extracted from one document source. Contains results of specific source for each provided page." allOf: - type: object + required: + - DocVisualExtendedInfo properties: DocVisualExtendedInfo: $ref: "#/components/schemas/DocVisualExtendedInfo" - $ref: "./rt.yml#/components/schemas/ResultItem" DocVisualExtendedInfo: + title: "DocVisualExtendedInfo" type: object description: "Container for extracted text fields. Fields are identified by type and language" required: + - nFields - pArrayFields properties: + nFields: + description: "Number of pArrayFields array elements" + type: number pArrayFields: type: array items: - $ref: "#/components/schemas/DocVisualExtendedField" + anyOf: + - $ref: "#/components/schemas/DocVisualExtendedFieldRect" + - $ref: "#/components/schemas/DocVisualExtendedFieldRfid" + + DocVisualExtendedFieldRfid: + title: "DocVisualExtendedFieldRfid" + description: "Structure and serves for storing information from one text data field. + Variant with field logical type and RFID data." + allOf: + - type: object + required: + - RFID_OriginDG + - RFID_OriginTagEntry + properties: + RFID_OriginDG: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + RFID_OriginDGTag: {} + RFID_OriginTagEntry: + description: "Record index of the text field source in the data group" + type: number + RFID_OriginEntryView: {} + - $ref: "#/components/schemas/DocVisualExtendedField" + + DocVisualExtendedFieldRect: + title: "DocVisualExtendedFieldRect" + description: "Structure and serves for storing information from one text data field. + Variant with field logical type and field rectangular area coordinates on the image." + allOf: + - type: object + properties: + FieldRect: + description: "Coordinates of the text field in the normalized image of the document. + Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + - $ref: "#/components/schemas/DocVisualExtendedField" + DocVisualExtendedField: + title: "DocVisualExtendedField" type: object required: + - FieldType - wFieldType - FieldName - - wLCID + - StringsCount + - StringsResult + - Buf_Length + - Buf_Text properties: + FieldType: {} wFieldType: $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" FieldName: - description: "Field name. Only use to search values for fields with fieldType=50(other). In general, use wFieldType for lookup." + description: "Field symbolic name (null-terminated string)" type: string - wLCID: - $ref: "./e-lcid.yml#/components/schemas/LCID" + StringsCount: + description: "Number of StringsResult array elements" + type: number StringsResult: type: array description: "Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." items: $ref: "#/components/schemas/StringRecognitionResult" + Buf_Length: + description: "Buf_Text text string length" + type: number Buf_Text: type: string description: "Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'" - FieldRect: - description: "Coordinates of the text field in the normalized image of the document. - Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - RFID_OriginDG: - description: "Origin data group information. Only for Result.RFID_TEXT results." - type: integer - RFID_OriginTagEntry: - type: integer - description: "Index of the text field record in origin data group. Only for Result.RFID_TEXT results." + FieldMask: {} + Validity: {} + InComparison: {} + Reserved2: {} + Reserved3: {} StringRecognitionResult: + title: "StringRecognitionResult" type: object description: "Describes single row recognition results in multi-line text field of a document" required: + - SymbolsCount - StringResult properties: + SymbolsCount: + description: "Number of StringResult array elements" + type: number + Reserved: {} StringResult: type: array description: "Array of recognition results for individual characters of a string" items: $ref: "#/components/schemas/SymbolRecognitionResult" + Buf_Length: + description: "Buf_Text text string length" + type: number + Buf_Text: + type: string + description: "Text field data in UTF8 format. + Results of reading different lines of a multi-line field are separated by '^'" SymbolRecognitionResult: + title: "SymbolRecognitionResult" type: object description: "Describes a single character recognition results in the text field line" required: - SymbolRect + - CandidatesCount - ListOfCandidates properties: SymbolRect: description: "Coordinates of the symbol in the normalized image of the document" $ref: "./common.yml#/components/schemas/RectangleCoordinates" + CandidatesCount: + description: "Number of significant elements of ListOfCandidates array" + type: number ListOfCandidates: type: array description: "Array of candidate characters. Sorted in descending order of recognition probabilities (the first element has highest probability)" items: $ref: "#/components/schemas/SymbolCandidate" + Reserved: {} SymbolCandidate: + title: "SymbolCandidate" required: - SymbolCode - SymbolProbability @@ -103,3 +169,4 @@ components: description: "character recognition probability (0–100,%)" minimum: 0 maximum: 100 + Reserved: {} diff --git a/rt-text.yml b/rt-text.yml index fdbaf63..81bdc08 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - TextResult: - title: "Text" + title: "TextResult" allOf: - type: object required: @@ -14,12 +13,14 @@ components: - $ref: "./rt.yml#/components/schemas/ResultItem" Text: + title: "Text" type: object description: "Contains all document text fields data with validity and cross-source compare checks" required: - status - validityStatus - comparisonStatus + - dateFormat - fieldList - availableSourceList properties: @@ -32,6 +33,9 @@ components: comparisonStatus: description: "Overall status of data comparison from different sources for each text field" $ref: "./common.yml#/components/schemas/CheckResult" + dateFormat: + description: "Date format" + type: string fieldList: type: array items: @@ -42,10 +46,13 @@ components: $ref: "#/components/schemas/TextAvailableSource" TextField: + title: "TextField" type: object required: - fieldType - fieldName + - lcid + - lcidName - status - validityStatus - comparisonStatus @@ -61,6 +68,9 @@ components: type: string lcid: $ref: "./e-lcid.yml#/components/schemas/LCID" + lcidName: + description: "LCID name" + type: string status: description: "Overall status of all checks from all values" $ref: "./common.yml#/components/schemas/CheckResult" @@ -90,13 +100,16 @@ components: items: $ref: "#/components/schemas/CrossSourceValueComparison" - # todo originalValidity очн путает, может в validityList сделать validityList = originalValidity && validityList + # todo originalValidity очень путает, может в validityList сделать validityList = originalValidity && validityList TextFieldValue: + title: "TextFieldValue" type: object required: - value - pageIndex - source + - originalValidity + - probability properties: source: $ref: "./common.yml#/components/schemas/Source" @@ -106,6 +119,8 @@ components: originalValue: description: "Original value as seen in the document" type: string + originalValidity: + $ref: "./common.yml#/components/schemas/CheckResult" originalSymbols: type: array items: @@ -125,7 +140,11 @@ components: $ref: "./common.yml#/components/schemas/RfidOrigin" OriginalSymbol: + title: "OriginalSymbol" type: object + required: + - code + - probability properties: code: description: "Unicode symbol code" @@ -140,6 +159,7 @@ components: $ref: "./common.yml#/components/schemas/RectangleCoordinates" SourceValidity: + title: "SourceValidity" type: object required: - source @@ -151,6 +171,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" CrossSourceValueComparison: + title: "CrossSourceValueComparison" type: object required: - sourceLeft @@ -165,6 +186,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" TextAvailableSource: + title: "TextAvailableSource" type: object required: - source diff --git a/rt.yml b/rt.yml index e381956..78d9a69 100644 --- a/rt.yml +++ b/rt.yml @@ -1,13 +1,14 @@ openapi: 3.0.3 components: schemas: - ContainerType: + title: "ContainerType" type: integer description: "Same as Result type, but used for safe parsing of not-described values. See Result type." default: 0 Result: + title: "Result" type: integer enum: - 1 @@ -22,14 +23,20 @@ components: - 18 - 19 - 20 + - 26 - 30 + - 32 - 33 - 34 + - 35 - 36 - 37 + - 38 - 39 - 49 - 50 + - 61 + - 62 - 85 - 101 - 102 @@ -49,14 +56,20 @@ components: - "Contains barcode parsing result with text fields" - "Contains barcode parsing result with graphic fields" - "Contains result of document authenticity checks" + - "Contains result of DocVisualExtendedInfoContainer" - "Contains image quality check results" + - "Contains result of DocGraphicsInfoContainer" - "Contains check statuses with details, grouped by source" - "Contains result of portraits comparison" + - "Contains result of DocGraphicsInfoContainer" - "Contains document textual fields from all sources (mrz, rfid, visual, barcode) with validity and cross-source compare checks" - "Contains images from all document sources (mrz, rfid, visual, barcode)" + - "Contains result of DocGraphicsInfoContainer" - "Contains result of fingerprints comparison" - "Contains encrypted ResultContainerList" - "Contains license" + - "Contains result of DocumentPosition" + - "Contains result of DocumentPosition" - "Contains information about document position on the input image, its center, angle, etc" - "Contains RFID raw data" - "Contains RFID text results" @@ -76,14 +89,20 @@ components: - "BARCODE_TEXT" - "BARCODE_GRAPHICS" - "AUTHENTICITY" + - "MAGNETIC_STRIPE_TEXT_DATA" - "IMAGE_QUALITY" + - "LIVE_PORTRAIT" - "STATUS" - "PORTRAIT_COMPARISON" + - "EXT_PORTRAIT" - "TEXT" - "IMAGES" + - "FINGERPRINTS" - "FINGERPRINT_COMPARISON" - "ENCRYPTED_RCL" - "LICENSE" + - "MRZ_POSITION" + - "BARCODE_POSITION" - "DOCUMENT_POSITION" - "RFID_RAW_DATA" - "RFID_TEXT" @@ -92,6 +111,7 @@ components: - "RFID_ORIGINAL_GRAPHICS" ResultItem: + title: "ResultItem" type: object description: "Common fields for all result objects" required: @@ -107,36 +127,13 @@ components: type: integer result_type: $ref: "#/components/schemas/ContainerType" - discriminator: - propertyName: result_type - mapping: - 1: "DocumentImageResult" - 3: "TextDataResult" - 5: "DocBarCodeInfo" - 6: "GraphicsResult" - 8: "DocumentTypesCandidatesResult" - 9: "ChosenDocumentTypeResult" - 15: "LexicalAnalysisResult" - 17: "TextDataResult" - 18: "TextDataResult" - 19: "GraphicsResult" - 20: "AuthenticityResult" - 30: "ImageQualityResult" - 33: "StatusResult" - 34: "AuthenticityResult" - 36: "TextResult" - 37: "ImagesResult" - 39: "AuthenticityResult" - 49: "EncryptedRCLResult" - 50: "LicenseResult" - 85: "DocumentPositionResult" - 102: "TextDataResult" - 103: "GraphicsResult" ContainerList: + title: "ContainerList" type: object description: "List with various objects, containing processing results" required: + - Count - List properties: Count: @@ -146,63 +143,19 @@ components: type: array items: anyOf: - - $ref: "#/components/schemas/StatusResult" - - $ref: "#/components/schemas/TextResult" - - $ref: "#/components/schemas/DocumentImageResult" - - $ref: "#/components/schemas/ImagesResult" - - $ref: "#/components/schemas/ChosenDocumentTypeResult" - - $ref: "#/components/schemas/DocumentTypesCandidatesResult" - - $ref: "#/components/schemas/TextDataResult" - - $ref: "#/components/schemas/GraphicsResult" - - $ref: "#/components/schemas/LexicalAnalysisResult" - - $ref: "#/components/schemas/AuthenticityResult" - - $ref: "#/components/schemas/ImageQualityResult" - - $ref: "#/components/schemas/DocumentPositionResult" - - $ref: "#/components/schemas/DocBarCodeInfo" - - $ref: "#/components/schemas/LicenseResult" - - $ref: "#/components/schemas/EncryptedRCLResult" - - DocumentPositionResult: - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" - - DocumentImageResult: - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" - - StatusResult: - $ref: "./rt-status.yml#/components/schemas/StatusResult" - - TextResult: - $ref: "./rt-text.yml#/components/schemas/TextResult" - - ImagesResult: - $ref: "./rt-images.yml#/components/schemas/ImagesResult" - - LexicalAnalysisResult: - $ref: "./rt-ocr-lexical-analisis.yml#/components/schemas/LexicalAnalysisResult" - - TextDataResult: - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" - - GraphicsResult: - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" - - DocumentTypesCandidatesResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" - - ChosenDocumentTypeResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" - - AuthenticityResult: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" - - ImageQualityResult: - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" - - DocBarCodeInfo: - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" - - LicenseResult: - $ref: "./rt-license.yml#/components/schemas/LicenseResult" - - EncryptedRCLResult: - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + - $ref: "./rt-status.yml#/components/schemas/StatusResult" + - $ref: "./rt-text.yml#/components/schemas/TextResult" + - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" + - $ref: "./rt-images.yml#/components/schemas/ImagesResult" + - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" + - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" + - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" + - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" + - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" + - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" + - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" + - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" + - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" + - $ref: "./rt-license.yml#/components/schemas/LicenseResult" + - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + - $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" From c1d7113fce07a57776fa1641055260d0f478e0e4 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 11 Oct 2024 15:34:52 +0300 Subject: [PATCH 002/106] SP-18211 - fix enum --- rt-rfid-binary-data.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index bc8cbc3..c5c363a 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -750,11 +750,11 @@ components: type: integer description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" enum: - - 0X00 - - 0X01 - - 0X02 - - 0X04 - - 0X08 + - 0x00 + - 0x01 + - 0x02 + - 0x04 + - 0x08 x-enum-descriptions: - "Unknown" - "106 bits/s" From 735e582cdd4827e8ba400b87ea26694a3f9c9529 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Oct 2024 11:47:55 +0300 Subject: [PATCH 003/106] SP-18211 - add enum to RFID_ePassp_Directory --- rt-rfid-binary-data.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index c5c363a..8c6336b 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -40,7 +40,7 @@ components: description: Indexes of groups that aren't read type: array items: - type: integer + $ref: "./e-rfid-data-file-type.yml#/components/schemas/RfidDataFileType" RfidDG1: title: "RfidDG1" From fcc2516a771fedcfd6a2fed26e98e5f858d48e6a Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Oct 2024 16:35:29 +0300 Subject: [PATCH 004/106] SP-18211 - update BinaryData --- rt-rfid-binary-data.yml | 186 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 182 insertions(+), 4 deletions(-) diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 8c6336b..70cd3f0 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -27,15 +27,193 @@ components: title: "BinaryData" description: "Structure is used for storing the results of one bar-code module reading." type: object - required: - - RFID_DG1 - - RFID_Session_Data - - RFID_ePassp_Directory properties: + RFID_Authentication_Info: + type: object + additionalProperties: true + RFID_MIFARE_Data_Validity: + type: object + additionalProperties: true + RFID_MIFARE_Data: + type: object + additionalProperties: true + RFID_EF_COM: + type: object + additionalProperties: true RFID_DG1: $ref: "#/components/schemas/RfidDG1" + RFID_DG2: + type: object + additionalProperties: true + RFID_DG3: + type: object + additionalProperties: true + RFID_DG4: + type: object + additionalProperties: true + RFID_DG5: + type: object + additionalProperties: true + RFID_DG6: + type: object + additionalProperties: true + RFID_DG7: + type: object + additionalProperties: true + RFID_DG8: + type: object + additionalProperties: true + RFID_DG9: + type: object + additionalProperties: true + RFID_DG10: + type: object + additionalProperties: true + RFID_DG11: + type: object + additionalProperties: true + RFID_DG12: + type: object + additionalProperties: true + RFID_DG13: + type: object + additionalProperties: true + RFID_DG14: + type: object + additionalProperties: true + RFID_DG15: + type: object + additionalProperties: true + RFID_DG16: + type: object + additionalProperties: true + RFID_EF_SOD: + type: object + additionalProperties: true + eID_DG1: + type: object + additionalProperties: true + eID_DG2: + type: object + additionalProperties: true + eID_DG3: + type: object + additionalProperties: true + eID_DG4: + type: object + additionalProperties: true + eID_DG5: + type: object + additionalProperties: true + eID_DG6: + type: object + additionalProperties: true + eID_DG7: + type: object + additionalProperties: true + eID_DG8: + type: object + additionalProperties: true + eID_DG9: + type: object + additionalProperties: true + eID_DG10: + type: object + additionalProperties: true + eID_DG11: + type: object + additionalProperties: true + eID_DG12: + type: object + additionalProperties: true + eID_DG13: + type: object + additionalProperties: true + eID_DG14: + type: object + additionalProperties: true + eID_DG15: + type: object + additionalProperties: true + eID_DG16: + type: object + additionalProperties: true + eID_DG17: + type: object + additionalProperties: true + eID_DG18: + type: object + additionalProperties: true + eID_DG19: + type: object + additionalProperties: true + eID_DG20: + type: object + additionalProperties: true + eID_DG21: + type: object + additionalProperties: true + eDL_COM: + type: object + additionalProperties: true + eDL_SOD: + type: object + additionalProperties: true + eDL_DG1: + type: object + additionalProperties: true + eDL_DG2: + type: object + additionalProperties: true + eDL_DG3: + type: object + additionalProperties: true + eDL_DG4: + type: object + additionalProperties: true + eDL_DG5: + type: object + additionalProperties: true + eDL_DG6: + type: object + additionalProperties: true + eDL_DG7: + type: object + additionalProperties: true + eDL_DG8: + type: object + additionalProperties: true + eDL_DG9: + type: object + additionalProperties: true + eDL_DG10: + type: object + additionalProperties: true + eDL_DG11: + type: object + additionalProperties: true + eDL_DG12: + type: object + additionalProperties: true + eDL_DG13: + type: object + additionalProperties: true + eDL_DG14: + type: object + additionalProperties: true + Visible_Digital_Seal: + type: object + additionalProperties: true + Visible_Digital_Seal_NC: + type: object + additionalProperties: true + Digital_Signature: + type: object + additionalProperties: true RFID_Session_Data: $ref: "#/components/schemas/RfidSessionData" + RFID_Session_Data_Status: + $ref: "./rt-status.yml#/components/schemas/detailsRFID" RFID_ePassp_Directory: description: Indexes of groups that aren't read type: array From b2a45885a30a392a26d35bf53f9f194abbaa6ef3 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Oct 2024 17:13:12 +0300 Subject: [PATCH 005/106] SP-18211 - DeviceInfo deprecate --- p-healthcheck.yml | 1 + p-ping.yml | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index f87cc2c..4279445 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -33,6 +33,7 @@ paths: components: schemas: DeviceInfo: + title: "DeviceInfo" type: object properties: app: diff --git a/p-ping.yml b/p-ping.yml index 167aecc..74f48ae 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -19,12 +19,12 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/DeviceInfo" + $ref: "#/components/schemas/DeviceInfoDeprecated" components: schemas: - DeviceInfo: - title: "DeviceInfo" + DeviceInfoDeprecated: + title: "DeviceInfoDeprecated" type: object properties: app-name: From b114015163dd0309f29a744c2eb6b13c1a00a42e Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Oct 2024 17:33:46 +0300 Subject: [PATCH 006/106] SP-18211 - update action --- .github/workflows/update-clients.yml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/update-clients.yml b/.github/workflows/update-clients.yml index 50dabb9..ea71abe 100644 --- a/.github/workflows/update-clients.yml +++ b/.github/workflows/update-clients.yml @@ -6,6 +6,10 @@ on: title: description: "Title For PR's" required: true + branch: + description: "OpenAPI branch" + required: true + default: "develop" jobs: @@ -16,7 +20,7 @@ jobs: uses: actions/checkout@v4 with: path: 'DocumentReader-web-openapi' - ref: 'develop' + ref: ${{ github.event.inputs.branch }} - name: Checkout JS Client Repo uses: actions/checkout@v4 with: @@ -55,7 +59,7 @@ jobs: uses: actions/checkout@v4 with: path: 'DocumentReader-web-openapi' - ref: 'develop' + ref: ${{ github.event.inputs.branch }} - name: Checkout Java Client Repo uses: actions/checkout@v4 with: @@ -87,7 +91,7 @@ jobs: uses: actions/checkout@v4 with: path: 'DocumentReader-web-openapi' - ref: 'develop' + ref: ${{ github.event.inputs.branch }} - name: Checkout Python Client Repo uses: actions/checkout@v4 with: @@ -119,7 +123,7 @@ jobs: uses: actions/checkout@v4 with: path: 'DocumentReader-web-openapi' - ref: 'develop' + ref: ${{ github.event.inputs.branch }} - name: Checkout C# Client Repo uses: actions/checkout@v4 with: From 0042f921c570357b4009997a583d9d576436b985 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 22 Oct 2024 11:18:11 +0300 Subject: [PATCH 007/106] SP-18211 - add RFIDPKDResourceType enum --- e-rfid-pkd-resourcetype.yml | 1 + index.yml | 2 ++ 2 files changed, 3 insertions(+) diff --git a/e-rfid-pkd-resourcetype.yml b/e-rfid-pkd-resourcetype.yml index ae5ce0f..20a2f4a 100644 --- a/e-rfid-pkd-resourcetype.yml +++ b/e-rfid-pkd-resourcetype.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: RFIDPKDResourceType: + title: "RFIDPKDResourceType" type: integer description: "Enumeration contains a set of constants that define the type of certificate" enum: diff --git a/index.yml b/index.yml index 19be01c..050df9c 100644 --- a/index.yml +++ b/index.yml @@ -98,3 +98,5 @@ components: $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList" ChosenDocumentType: $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" + RFIDPKDResourceType: + $ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType" From 565be3e255dc5e7b30efb5425c688d80c52a9fad Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 22 Oct 2024 12:09:56 +0300 Subject: [PATCH 008/106] SP-18211 - typo --- index.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yml b/index.yml index 050df9c..6763adf 100644 --- a/index.yml +++ b/index.yml @@ -46,7 +46,7 @@ paths: tags: - name: process - description: Everything about perfoming request and parsing response + description: Everything about performing request and parsing response - name: status_model x-displayName: Status Model description: | From 9a4c86c66bb464886e6ea95ca84325514653d01e Mon Sep 17 00:00:00 2001 From: Kiryl Kovaliov Date: Thu, 24 Oct 2024 10:58:27 +0200 Subject: [PATCH 009/106] Update index.yml --- index.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yml b/index.yml index 6763adf..401ddd5 100644 --- a/index.yml +++ b/index.yml @@ -7,7 +7,7 @@ info: href: "https://regulaforensics.com" description: | Documents recognition as easy as reading two bytes. - + # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android From 144089fc008a12036dfd476ca860920c297ccece Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 24 Oct 2024 13:46:57 +0300 Subject: [PATCH 010/106] SP-18211 - add result_type discriminator --- rt.yml | 113 +++++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 97 insertions(+), 16 deletions(-) diff --git a/rt.yml b/rt.yml index 78d9a69..1e6f942 100644 --- a/rt.yml +++ b/rt.yml @@ -127,6 +127,39 @@ components: type: integer result_type: $ref: "#/components/schemas/ContainerType" + discriminator: + propertyName: result_type + mapping: + 33: "StatusResult" + 36: "TextResult" + 1: "DocumentImageResult" + 16: "DocumentImageResult" + 37: "ImagesResult" + 9: "ChosenDocumentTypeResult" + 8: "DocumentTypesCandidatesResult" + 17: "TextDataResult" + 3: "TextDataResult" + 18: "TextDataResult" + 26: "TextDataResult" + 102: "TextDataResult" + 6: "GraphicsResult" + 19: "GraphicsResult" + 32: "GraphicsResult" + 35: "GraphicsResult" + 38: "GraphicsResult" + 103: "GraphicsResult" + 15: "LexicalAnalysisResult" + 20: "AuthenticityResult" + 39: "AuthenticityResult" + 34: "AuthenticityResult" + 30: "ImageQualityResult" + 85: "DocumentPositionResult" + 61: "DocumentPositionResult" + 62: "DocumentPositionResult" + 5: "DocBarCodeInfo" + 50: "LicenseResult" + 49: "EncryptedRCLResult" + 104: "DocumentBinaryInfoResult" ContainerList: title: "ContainerList" @@ -143,19 +176,67 @@ components: type: array items: anyOf: - - $ref: "./rt-status.yml#/components/schemas/StatusResult" - - $ref: "./rt-text.yml#/components/schemas/TextResult" - - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" - - $ref: "./rt-images.yml#/components/schemas/ImagesResult" - - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" - - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" - - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" - - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" - - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" - - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" - - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" - - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" - - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" - - $ref: "./rt-license.yml#/components/schemas/LicenseResult" - - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" - - $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" + - $ref: "#/components/schemas/StatusResult" + - $ref: "#/components/schemas/TextResult" + - $ref: "#/components/schemas/DocumentImageResult" + - $ref: "#/components/schemas/ImagesResult" + - $ref: "#/components/schemas/ChosenDocumentTypeResult" + - $ref: "#/components/schemas/DocumentTypesCandidatesResult" + - $ref: "#/components/schemas/TextDataResult" + - $ref: "#/components/schemas/GraphicsResult" + - $ref: "#/components/schemas/LexicalAnalysisResult" + - $ref: "#/components/schemas/AuthenticityResult" + - $ref: "#/components/schemas/ImageQualityResult" + - $ref: "#/components/schemas/DocumentPositionResult" + - $ref: "#/components/schemas/DocBarCodeInfo" + - $ref: "#/components/schemas/LicenseResult" + - $ref: "#/components/schemas/EncryptedRCLResult" + - $ref: "#/components/schemas/DocumentBinaryInfoResult" + + StatusResult: + $ref: "./rt-status.yml#/components/schemas/StatusResult" + + TextResult: + $ref: "./rt-text.yml#/components/schemas/TextResult" + + DocumentImageResult: + $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" + + ImagesResult: + $ref: "./rt-images.yml#/components/schemas/ImagesResult" + + ChosenDocumentTypeResult: + $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" + + DocumentTypesCandidatesResult: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" + + TextDataResult: + $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" + + GraphicsResult: + $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" + + LexicalAnalysisResult: + $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" + + AuthenticityResult: + $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" + + ImageQualityResult: + $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" + + DocumentPositionResult: + $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" + + DocBarCodeInfo: + $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" + + LicenseResult: + $ref: "./rt-license.yml#/components/schemas/LicenseResult" + + EncryptedRCLResult: + $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + + DocumentBinaryInfoResult: + $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" From d91e79a4ccdb490921c36c62c3a6cd48388f6752 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 29 Oct 2024 16:05:22 +0300 Subject: [PATCH 011/106] SP-18211 - update enums --- e-rfid-data-file-type.yml | 10 ++++++++++ rt-rfid-binary-data.yml | 12 ++++++++++++ 2 files changed, 22 insertions(+) diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index 4bc971a..e6c9a99 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -31,6 +31,11 @@ components: - 21 - 22 - 23 + - 57 + - 58 + - 62 + - 63 + - 64 - 101 - 102 - 103 @@ -119,6 +124,11 @@ components: - "PASSPORT_SOD" - "PASSPORT_CVCA" - "PASSPORT_COM" + - "DTC_DG17" + - "DTC_DG18" + - "DTC_DG22" + - "DTC_DG23" + - "DTC_DG24" - "ID_DG1" - "ID_DG2" - "ID_DG3" diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 70cd3f0..258cb92 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -664,6 +664,10 @@ components: - 2 - 3 - 4 + - 5 + - 6 + - 7 + - 8 - 0 x-enum-descriptions: - "Not defined" @@ -671,6 +675,10 @@ components: - "eID application" - "eSign application" - "eDL application" + - "TravelRecords application" + - "VisaRecords application" + - "AddBiometrics application" + - "Digital Travel Credentials" - "Master File" x-enum-varnames: - "UNSPECIFIED" @@ -678,6 +686,10 @@ components: - "E_ID" - "E_SIGN" - "E_DL" + - "LDS2_TravelRecords" + - "LDS2_VisaRecords" + - "LDS2_AddBiometrics" + - "eDTC_PC" - "ROOT_FILES" RfidDataFile: From 79ef8b3bf25bcc74c82928bd2730ccfb88070838 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 11 Oct 2024 14:55:22 +0300 Subject: [PATCH 012/106] SP-18211 - update schemas, bug fix --- README.md | 6 +- authenticity/e-check-diagnose.yml | 1 + authenticity/e-critical.yml | 1 + authenticity/e-result-type.yml | 16 + authenticity/e-visibility.yml | 1 + authenticity/rt-fiber.yml | 13 +- authenticity/rt-ident.yml | 11 +- authenticity/rt-ocr-security-text.yml | 17 +- authenticity/rt-photo-ident.yml | 18 +- authenticity/rt-security-feature.yml | 10 +- common.yml | 160 ++- e-barcode-type.yml | 42 +- e-document-type.yml | 1 + e-graphic-field-type.yml | 6 + e-lcid.yml | 28 +- e-parsing-error-codes.yml | 253 ++--- e-parsing-notification-codes.yml | 445 ++++---- e-rfid-data-file-type.yml | 184 ++++ e-rfid-data-group-type-tag.yml | 177 ++++ e-rfid-error-codes.yml | 229 ++--- e-security-feature-type.yml | 1 + e-text-field-type.yml | 3 +- index.yml | 15 +- p-ping.yml | 4 + p-process.yml | 127 ++- p-transaction.yml | 83 +- rt-authenticity.yml | 74 +- rt-barcodes.yml | 76 +- rt-doc-type-old.yml | 47 +- rt-document-position.yml | 20 +- rt-encrypted-rcl.yml | 3 +- rt-image-data.yml | 70 +- rt-image-quality.yml | 32 +- rt-images.yml | 25 +- rt-license.yml | 3 +- ...nalisis.yml => rt-ocr-lexical-analysis.yml | 20 +- rt-raw-image.yml | 23 +- rt-rfid-binary-data.yml | 956 ++++++++++++++++++ rt-status.yml | 11 +- rt-text-data.yml | 101 +- rt-text.yml | 28 +- rt.yml | 125 +-- 42 files changed, 2634 insertions(+), 832 deletions(-) create mode 100644 e-rfid-data-file-type.yml create mode 100644 e-rfid-data-group-type-tag.yml rename rt-ocr-lexical-analisis.yml => rt-ocr-lexical-analysis.yml (88%) create mode 100644 rt-rfid-binary-data.yml diff --git a/README.md b/README.md index af81f61..68d8f7d 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,7 @@ docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate - ## Building Redoc single page html documentation -Edit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node - -Edit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator** - -Then run next command: +Run next command: ``` npx redoc-cli bundle "$PWD/index.yml" --output document-reader-static-doc.html \ --options.maxDisplayedEnumValues=5 --options.theme.logo.gutter="20px" \ diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 20be320..37d35f2 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: CheckDiagnose: + title: "CheckDiagnose" type: integer description: "Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/" enum: diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml index eac10bd..f2f621c 100644 --- a/authenticity/e-critical.yml +++ b/authenticity/e-critical.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: Critical: + title: "Critical" type: integer description: "Enumeration contains identifiers determining the criticality of the security element" enum: diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index 6fd64e4..2a5a900 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -2,9 +2,11 @@ openapi: 3.0.3 components: schemas: AuthenticityResultType: + title: "AuthenticityResultType" type: integer description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/." enum: + - 0 - 1 - 2 - 4 @@ -13,10 +15,13 @@ components: - 32 - 64 - 128 + - 256 - 512 - 1024 + - 2048 - 4096 - 8192 + - 16384 - 32768 - 65536 - 131072 @@ -27,7 +32,9 @@ components: - 4194304 - 8388608 - 16777216 + - 2147483648 x-enum-descriptions: + - "No authenticity control procedure" - "Document luminescence check in UV light" - "B900 ink MRZ contrast check in IR light" - "Image patterns presence/absence check (position, shape, color)" @@ -36,10 +43,13 @@ components: - "Document elements visibility check in IR light" - "OCR for the text field in UV light comparison with other text sources check" - "Invisible Personal Information (IPI) visualization" + - "Document photo check in IR light" - "Owner's photo embedding check (is photo printed or sticked)" - "OVI check. Deprecated, use Document liveness check instead" + - "IR luminescence check" - "Hologram presence check. Deprecated" - "Owner's photo area advanced check (photo shape, size, position, etc.)" + - "UV background check" - "Portrait comparison check (document printed vs chip vs live)" - "Barcode format check (code metadata, data format, contents format, etc.)" - "Kinegram check" @@ -50,7 +60,9 @@ components: - "Extended OCR Check" - "Extended MRZ check" - "Encrypted IPI" + - "Flag for status-only authenticity" x-enum-varnames: + - "NONE" - "UV_LUMINESCENCE" - "IR_B900" - "IMAGE_PATTERN" @@ -59,10 +71,13 @@ components: - "IR_VISIBILITY" - "OCR_SECURITY_TEXT" - "IPI" + - "IR_PHOTO" - "PHOTO_EMBED_TYPE" - "OVI" + - "IR_LUMINESCENCE" - "HOLOGRAMS" - "PHOTO_AREA" + - "UV_BACKGROUND" - "PORTRAIT_COMPARISON" - "BARCODE_FORMAT_CHECK" - "KINEGRAM" @@ -73,3 +88,4 @@ components: - "EXTENDED_OCR_CHECK" - "EXTENDED_MRZ_CHECK" - "ENCRYPTED_IPI" + - "STATUS_ONLY" diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml index 042f366..a77e52e 100644 --- a/authenticity/e-visibility.yml +++ b/authenticity/e-visibility.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: Visibility: + title: "Visibility" type: integer description: "Enumeration contains visibility status of the security element" enum: diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index 4952b4b..0451861 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -1,12 +1,19 @@ openapi: 3.0.3 components: schemas: - FiberResult: - title: "Fibers Check" + title: "FiberResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - RectCount + - ExpectedCount + - RectArray + - Width + - Length + - Area + - ColorValues properties: RectCount: description: "For UV_Fibers authenticity result type" @@ -45,4 +52,4 @@ components: example: [BLUE, GREEN, RED] type: array items: - type: integer \ No newline at end of file + type: integer diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index feca0b6..ae078bb 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -1,12 +1,17 @@ openapi: 3.0.3 components: schemas: - IdentResult: - title: "Ident Check" + title: "IdentResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - ElementType + - LightIndex + - Area + - Image + - EtalonImage properties: ElementType: $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" @@ -21,4 +26,4 @@ components: description: "Reference image" $ref: "../common.yml#/components/schemas/ImageData" AreaList: - $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" \ No newline at end of file + $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index 6ddfd2b..1bacbce 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -1,12 +1,21 @@ openapi: 3.0.3 components: schemas: - OCRSecurityTextResult: - title: "OCR Security Text Check" + title: "OCRSecurityTextResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - CriticalFlag + - LightType + - FieldRect + - EtalonResultType + - EtalonFieldType + - EtalonLightType + - EtalonFieldRect + - SecurityTextResultOCR + - EtalonResultOCR properties: CriticalFlag: $ref: "./e-critical.yml#/components/schemas/Critical" @@ -20,6 +29,8 @@ components: type: integer EtalonLightType: type: integer + EtalonFieldRect: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" SecurityTextResultOCR: type: string EtalonResultOCR: @@ -27,4 +38,4 @@ components: Reserved1: type: integer Reserved2: - type: integer \ No newline at end of file + type: integer diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 94f32ad..19d1070 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -1,12 +1,16 @@ openapi: 3.0.3 components: schemas: - PhotoIdentResult: - title: "Photo Ident Check" + title: "PhotoIdentResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - LightIndex + - Area + - SourceImage + - ResultImages properties: LightIndex: $ref: "../common.yml#/components/schemas/Light" @@ -26,15 +30,23 @@ components: type: integer Angle: type: integer + Reserved1: + type: integer + Reserved2: + type: integer Reserved3: type: integer RawImageContainerList: + title: "RawImageContainerList" type: object + required: + - Count + - Images properties: Count: type: integer Images: type: array items: - $ref: "../common.yml#/components/schemas/ImageData" \ No newline at end of file + $ref: "../common.yml#/components/schemas/ImageData" diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index e7d7ca7..bac38f3 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -1,12 +1,16 @@ openapi: 3.0.3 components: schemas: - SecurityFeatureResult: - title: "Security Feature Check" + title: "SecurityFeatureResult" allOf: - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - type: object + required: + - ElementType + - ElementRect + - Visibility + - CriticalFlag properties: ElementType: $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" @@ -19,4 +23,4 @@ components: AreaList: $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" Reserved2: - type: integer \ No newline at end of file + type: integer diff --git a/common.yml b/common.yml index cdda9da..a69f763 100644 --- a/common.yml +++ b/common.yml @@ -1,6 +1,4 @@ openapi: 3.0.3 - - components: parameters: x-request: @@ -12,10 +10,12 @@ components: schemas: PageIndex: + title: "PageIndex" description: "Page index of the image from input list" type: integer Source: + title: "Source" description: "Document data sources" type: string enum: @@ -24,20 +24,24 @@ components: - "BARCODE" - "RFID" - "MAGNETIC" + - "EXTERNAL" x-enum-varnames: - "MRZ" - "VISUAL" - "BARCODE" - "RFID" - "MAGNETIC" + - "EXTERNAL" x-enum-descriptions: - "Machine readable zone (MRZ)" - "Visual zone" - "Barcode" - "RFID" - "Magnetic" + - "External" CheckResult: + title: "CheckResult" type: integer description: "0 - result is negative; 1 - result is positive; 2 - сheck was not performed" enum: @@ -53,8 +57,8 @@ components: - "Check was performed and result is POSITIVE" - "Check was NOT PERFORMED" - # todo update x-enum-descriptions Scenario: + title: "Scenario" type: string description: "Document processing scenario" enum: @@ -116,6 +120,7 @@ components: - "Scenario for obtaining an original image without any processing" ImageData: + title: "ImageData" type: object required: - image @@ -124,18 +129,21 @@ components: $ref: "#/components/schemas/ImageBase64" ImageTransactionData: + title: "ImageTransactionData" type: object properties: image: $ref: './rt-images.yml#/components/schemas/ImagesFieldValue' ImageBase64: + title: "ImageBase64" description: "Base64 encoded image" type: string format: base64 example: "Base64 encoded image" RectangleCoordinates: + title: "RectangleCoordinates" description: "Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)" type: object required: @@ -154,6 +162,7 @@ components: type: integer RfidLocation: + title: "RfidLocation" type: integer description: "Determines the presence and location of an RFID chip in a document. 0 - no rfid chip; 1 - chip is located in the document data page; 2 - chip is located in the back page or inlay of the document" enum: @@ -170,10 +179,14 @@ components: - "BACK_PAGE" RfidOrigin: + title: "RfidOrigin" type: object description: "Location of data in RFID chip" required: - dg + - dgTag + - tagEntry + - entryView properties: dg: description: "Source data group file" @@ -189,26 +202,145 @@ components: type: integer Light: + title: "Light" type: integer description: "Image light index" enum: - - 0 - - 6 - - 24 - - 128 + - 0x00000000 + - 0x00000001 + - 0x00000002 + - 0x00000004 + - 0x00800000 + - 0x00000006 + - 0x00000008 + - 0x00000010 + - 0x01000000 + - 0x00000018 + - 0x02000000 + - 0x00000080 + - 0x04000000 + - 0x08000000 + - 0x10000000 + - 0x00000100 + - 0x00000400 + - 0x00000800 + - 0x00000200 + - 0x00001000 + - 0x00002000 + - 0x00000C00 + - 0x80000000 + - 0x90000000 + - 0xA0000000 + - 0xB0000000 + - 0xC0000000 + - 0x00000020 + - 0x00000040 + - 0x00010000 + - 0x00004000 + - 0x00040000 + - 0x00020000 + - 0x00008000 + - 0x01000000 + - 0x04000000 + - 0x00000040 + - 0x00000020 + - 0x00080000 + - 0x00100000 + - 0x00200000 + - 0x00400000 x-enum-descriptions: - - "No Light" - - "White" - - "Infrared" - - "Ultraviolet" + - "Lighting schemes are off" + - "OVI scheme" + - "Upper/lower lighters of white light scheme" + - "Side lighters of white light scheme" + - "General white light without separate control of side and upper/lower lighters scheme" + - "Upper/lower and side lighters of white light scheme" + - "Upper/lower lighters of IR light scheme" + - "Side lighters of IR light scheme" + - "General IR light without separate control of side and upper/lower lighters scheme" + - "Upper/lower and side lighters of IR light scheme" + - "general white image converted to grayscale" + - "General UV light scheme" + - "OVD light for hologram visualization" + - "Video detection light for internal use only" + - "Light IR 870 oblique" + - "IR luminescence" + - "Left lighter of white coaxial light scheme" + - "Right lighter of white coaxial light scheme" + - "Coaxial white light without separate control of left and right lighters scheme" + - "IR720" + - "IR940" + - "Right and left lighters of white coaxial light scheme" + - "For internal use" + - "For internal use" + - "For internal use" + - "For internal use" + - "For internal use" + - "Transmitted" + - "Transmitted IR" + - "Transmitted AntiStokes" + - "Transmitted IR940" + - "OVD right" + - "OVD left" + - "IR 700" + - "Front IR870 (mod. 8803)" + - "OVD light (hologram visualization) (mod. 8850)" + - "For internal use" + - "For internal use" + - "UVС 254 (mod. 88X0)" + - "UVB 313 (mod. 88X0)" + - "White oblique light" + - "For internal use" x-enum-varnames: - "OFF" + - "OVI" + - "WHITE_TOP" + - "WHITE_SIDE" + - "WHITE_FRONT" - "WHITE" + - "IR_TOP" + - "IR_SIDE" + - "IR_FRONT" - "IR" + - "WHITE_GRAY" - "UV" + - "OVD" + - "VIDEODETECTION" + - "IR_870_OBL" + - "IR_LUMINESCENCE" + - "AXIAL_WHITE_LEFT" + - "AXIAL_WHITE_RIGHT" + - "AXIAL_WHITE_FRONT" + - "IR_720" + - "IR_940" + - "AXIAL_WHITE_FULL" + - "RAW_DATA" + - "RAW_DATA_GRBG" + - "RAW_DATA_GBGR" + - "RAW_DATA_RGGB" + - "RAW_DATA_BGGR" + - "TRANSMITTED" + - "TRANSMITTED_IR" + - "ANTI_STOKES" + - "TRANSMITTED_IR940" + - "OVD_RIGHT" + - "OVD_LEFT" + - "IR_700" + - "IR_870" + - "HOLO" + - "IR_BOTTOM" + - "WHITE_BOTTOM" + - "UVC" + - "UVB" + - "WHITE_OBL" + - "WHITE_SPECIAL" Point: + title: "Point" type: object + required: + - x + - y properties: x: type: integer @@ -216,18 +348,21 @@ components: type: integer License: + title: "License" description: "Base64 encoded data" type: string format: byte example: "Base64 encoded data" EncryptedRCL: + title: "EncryptedRCL" description: "Base64 encoded data" type: string format: byte example: "Base64 encoded data" FaceApi: + title: "FaceApi" type: object properties: url: @@ -246,7 +381,8 @@ components: type: integer description: "The maximum number of results to be returned." threshold: - type: float + type: number + format: float description: "The similarity threshold." group_ids: type: array diff --git a/e-barcode-type.yml b/e-barcode-type.yml index 3335b56..d961cee 100644 --- a/e-barcode-type.yml +++ b/e-barcode-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: BarcodeType: + title: "BarcodeType" type: integer description: "Enumeration contains the types of barcodes that can be processed" enum: @@ -25,6 +26,7 @@ components: - 17 - 18 - 19 + - 20 x-enum-varnames: - "UNKNOWN" - "CODE128" @@ -46,24 +48,26 @@ components: - "ALL_1D" - "CODE11" - "JABCODE" + - "END" x-enum-descriptions: - - "Unknown" - - "Code 128" - - "Code 39" - - "EAN-8" - - "ITF" - - "PDF417" - - "STF" - - "MTF" - - "IATA" - - "Codabar" - - "UPC-A" - - "Code 93" - - "UPC-E" - - "EAN-13" - - "QR code" - - "Aztec code" - - "Datamatrix" - - "All 1D barcodes" - - "Code 11" + - "Unknown type" + - "One-dimensional bar-code, ISO 15417 (ANSI/AIM BC4-1999 Code 128)" + - "One-dimensional bar-code, ISO 16388 (ANSI/AIM BC1-1995 Code 39)" + - "One-dimensional bar-code, EAN8, ISO 15418" + - "One-dimensional bar-code, Interleaved 2 of 5, ISO 16390 (ANSI/AIM BC2-1995 Interleaved 2 of 5)" + - "Two-dimensional bar-code, ISO 15438 (AIM USS PDF417)" + - "One-dimensional bar-code, Standard 2 of 5 (Industrial)" + - "One-dimensional bar-code, Matrix 2 of 5" + - "One-dimensional bar-code, IATA 2 of 5 (Airline)" + - "One-dimensional bar-code, (ANSI/AIM BC3-1995, USS - Codabar)" + - "One-dimensional bar-code, UPC-A" + - "One-dimensional bar-code, (ANSI/AIM BC5-1995, USS - Code 93)" + - "One-dimensional bar-code, UPC-E" + - "One-dimensional bar-code, EAN13, ISO 15418" + - "Two-dimensional QRCODE bar-code" + - "Two-dimensional AZTEC bar-code" + - "Two-dimensional DATAMATRIX bar-code" + - "Type for internal use, representing all 1D bar-codes" + - "One-dimensional bar-code CODE11" - "JAB code" + - "For internal use" diff --git a/e-document-type.yml b/e-document-type.yml index 2e25c5a..9fe94c4 100644 --- a/e-document-type.yml +++ b/e-document-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: DocumentType: + title: "DocumentType" type: integer description: "Possible values for document types" enum: diff --git a/e-graphic-field-type.yml b/e-graphic-field-type.yml index e29bf96..64d2979 100644 --- a/e-graphic-field-type.yml +++ b/e-graphic-field-type.yml @@ -2,9 +2,12 @@ openapi: 3.0.3 components: schemas: GraphicFieldName: + title: "GraphicFieldName" description: "Human readable field name. Do not bind to this name - use GraphicFieldType instead." type: string + GraphicFieldType: + title: "GraphicFieldType" type: integer enum: - 201 @@ -18,6 +21,7 @@ components: - 209 - 210 - 211 + - 212 - 213 - 250 - 300 @@ -45,6 +49,7 @@ components: - "Area with dynamic color change" - "Additional Portrait" - "Stamp" + - "Portrait of child" - "Contact chip" - "Undefined image type" - "Fingerprint (thumb, left hand)" @@ -72,6 +77,7 @@ components: - "COLOR_DYNAMIC" - "GHOST_PORTRAIT" - "STAMP" + - "PORTRAIT_OF_CHILD" - "CONTACT_CHIP" - "OTHER" - "FINGER_LEFT_THUMB" diff --git a/e-lcid.yml b/e-lcid.yml index bd8bca7..780c13f 100644 --- a/e-lcid.yml +++ b/e-lcid.yml @@ -1,8 +1,8 @@ openapi: 3.0.3 components: schemas: - LCID: + title: "LCID" description: | Locale id. Used to tag same typed fields declared in several languages. For example: name can be provided in both native and latin variants. @@ -36,10 +36,15 @@ components: - 1026 - 1109 - 1027 + - 3076 + - 5124 - 2052 + - 4100 + - 1028 - 1050 - 1029 - 1030 + - 1125 - 2067 - 1043 - 3081 @@ -134,6 +139,7 @@ components: - 1089 - 1053 - 2077 + - 1114 - 1097 - 1092 - 1098 @@ -197,10 +203,15 @@ components: - "BULGARIAN" - "BURMESE" - "CATALAN" + - "CHINESE_HONGKONG_SAR" + - "CHINESE_MACAO_SAR" - "CHINESE" + - "CHINESE_SINGAPORE" + - "CHINESE_TAIWAN" - "CROATIAN" - "CZECH" - "DANISH" + - "DIVEHI" - "DUTCH_BELGIUM" - "DUTCH_NETHERLANDS" - "ENGLISH_AUSTRALIA" @@ -295,6 +306,7 @@ components: - "SWAHILI" - "SWEDISH" - "SWEDISH_FINLAND" + - "SYRIAC" - "TAMIL" - "TATAR" - "TELUGU" @@ -309,9 +321,9 @@ components: - "VIETNAMESE" - "CTC_SIMPLIFIED" - "CTC_TRADITIONAL" - - "BengaliBangladesh" - - "BengaliIndia" - - "Assamese" + - "BENGALI_BANGLADESH" + - "BENGALI_INDIA" + - "ASSAMESE" - "ORIYA" - "MALAYALAM" - "LAO" @@ -358,10 +370,15 @@ components: - "Bulgarian" - "Burmese" - "Catalan" + - "Chinese (HongKong S.A.R.)" + - "Chinese (Macao S.A.R.)" - "Chinese" + - "Chinese (Singapore)" + - "Chinese (Taiwan)" - "Croatian" - "Czech" - "Danish" + - "Divehi" - "Dutch (Belgium)" - "Dutch (Netherlands)" - "English (Australia)" @@ -456,6 +473,7 @@ components: - "Swahili" - "Swedish" - "Swedish (Finland)" + - "Syriac" - "Tamil" - "Tatar" - "Telugu" @@ -490,4 +508,4 @@ components: - "Bank Card CVV2" - "Abkhazian (Cyrillic)" - "Karakalpak (Latin)" - - "Urdu Detection" \ No newline at end of file + - "Urdu Detection" diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 7469f92..e08e321 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -2,135 +2,136 @@ openapi: 3.0.3 components: schemas: ParsingErrorCodes: + title: "ParsingErrorCodes" type: integer description: "The enumeration contains error codes that can return during the RFID chip processing." enum: - - 1 - - -2147483647 - - -2147483646 - - -2147483645 - - -2147483640 - - -2147483639 - - -2147483638 - - -2147483631 - - -2147483629 - - -2147483628 - - -2147483627 - - -2147483626 - - -2147483630 - - -2147483625 - - -2147483624 - - -2147483623 - - -2147483622 - - -2147483621 - - -2147483620 - - -2147483619 - - -2147483618 - - -2147483617 - - -2147483616 - - -2147483615 - - -2147483614 - - -2147483613 - - -2147483612 - - -2147483611 - - -2147483610 - - -2147483609 - - -2147483600 - - -2147483599 - - -2147483598 - - -2147483597 - - -2147483596 - - -2147483594 - - -2147483595 - - -2147483568 - - -2147483567 - - -2147483566 - - -2147483565 - - -2147483564 - - -2147483563 - - -2147483562 - - -2147483561 - - -2147483560 - - -2147483559 - - -2147483558 - - -2147483536 - - -2147483535 - - -2130706415 - - -2130706400 - - -2130706399 - - -2130706398 - - -2130706397 - - -2130706396 - - -2130706395 - - -2130706394 - - -2130706393 - - -2130706392 - - -2130706391 - - -2130706390 - - -2130706389 - - -2130706388 - - -2130706387 - - -2130706386 - - -2130706385 - - -2130706384 - - -2130706383 - - -2130706382 - - -2130706381 - - -2130706380 - - -2130706379 - - -2130706378 - - -2130706377 - - -2130706376 - - -2130706368 - - -2130706367 - - -2130706366 - - -2130706365 - - -2130706364 - - -2130706363 - - -2130706352 - - -2130706351 - - -2130706350 - - -2130706349 - - -2130706348 - - -2130706347 - - -2130706346 - - -2130706345 - - -2130706320 - - -2130706319 - - -2130706318 - - -2130706336 - - -2130706334 - - -2130706333 - - -2130706332 - - -2130706331 - - -2130706080 - - -2130706079 - - -2130706078 - - -2130706077 - - -2130706076 - - -2130706075 - - -2130706074 - - -2130706073 - - -2130706072 - - -2130706071 - - -2130706070 - - -2130705920 - - -2130705919 - - -2130705918 - - -2130705917 - - -2130705916 - - -2130705915 - - -2130705664 - - -2130705663 - - -2130705662 - - -2130705661 - - -2130705660 - - -2130705659 - - -2130705658 - - -2130705657 - - -2130705656 - - -2130705655 - - -2130705654 + - 0x00000001 + - 0x80000001 + - 0x80000002 + - 0x80000003 + - 0x80000008 + - 0x80000009 + - 0x8000000A + - 0x80000011 + - 0x80000013 + - 0x80000014 + - 0x80000015 + - 0x80000016 + - 0x80000012 + - 0x80000017 + - 0x80000018 + - 0x80000019 + - 0x8000001A + - 0x8000001B + - 0x8000001C + - 0x8000001D + - 0x8000001E + - 0x8000001F + - 0x80000020 + - 0x80000021 + - 0x80000022 + - 0x80000023 + - 0x80000024 + - 0x80000025 + - 0x80000026 + - 0x80000027 + - 0x80000030 + - 0x80000031 + - 0x80000032 + - 0x80000033 + - 0x80000034 + - 0x80000036 + - 0x80000035 + - 0x80000050 + - 0x80000051 + - 0x80000052 + - 0x80000053 + - 0x80000054 + - 0x80000055 + - 0x80000056 + - 0x80000057 + - 0x80000058 + - 0x80000059 + - 0x8000005A + - 0x80000070 + - 0x80000071 + - 0x81000011 + - 0x81000020 + - 0x81000021 + - 0x81000022 + - 0x81000023 + - 0x81000024 + - 0x81000025 + - 0x81000026 + - 0x81000027 + - 0x81000028 + - 0x81000029 + - 0x8100002A + - 0x8100002B + - 0x8100002C + - 0x8100002D + - 0x8100002E + - 0x8100002F + - 0x81000030 + - 0x81000031 + - 0x81000032 + - 0x81000033 + - 0x81000034 + - 0x81000035 + - 0x81000036 + - 0x81000037 + - 0x81000038 + - 0x81000040 + - 0x81000041 + - 0x81000042 + - 0x81000043 + - 0x81000044 + - 0x81000045 + - 0x81000050 + - 0x81000051 + - 0x81000052 + - 0x81000053 + - 0x81000054 + - 0x81000055 + - 0x81000056 + - 0x81000057 + - 0x81000070 + - 0x81000071 + - 0x81000072 + - 0x81000060 + - 0x81000062 + - 0x81000063 + - 0x81000064 + - 0x81000065 + - 0x81000160 + - 0x81000161 + - 0x81000162 + - 0x81000163 + - 0x81000164 + - 0x81000165 + - 0x81000166 + - 0x81000167 + - 0x81000168 + - 0x81000169 + - 0x8100016A + - 0x81000200 + - 0x81000201 + - 0x81000202 + - 0x81000203 + - 0x81000204 + - 0x81000205 + - 0x81000300 + - 0x81000301 + - 0x81000302 + - 0x81000303 + - 0x81000304 + - 0x81000305 + - 0x81000306 + - 0x81000307 + - 0x81000308 + - 0x81000309 + - 0x8100030A x-enum-descriptions: - "OK" - "ASN: Incorrect data" diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 4a3d1d3..2333acb 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -2,231 +2,232 @@ openapi: 3.0.3 components: schemas: ParsingNotificationCodes: + title: "ParsingNotificationCodes" type: integer description: "The enumeration contains possible values of notification codes returned during the RFID chip processing." enum: - - -1879048191 - - -1879048190 - - -1879048189 - - -1879048188 - - -1879048187 - - -1879048186 - - -1879048184 - - -1879048178 - - -1879048177 - - -1879048176 - - -1879048169 - - -1879047680 - - -1879047679 - - -1879047678 - - -1879047677 - - -1879047676 - - -1879047675 - - -1879047674 - - -1879047673 - - -1879047672 - - -1879047671 - - -1879047670 - - -1879047669 - - -1879047668 - - -1879047667 - - -1879047666 - - -1879047665 - - -1879047664 - - -1879047663 - - -1879047662 - - -1879047661 - - -1879047660 - - -1879047659 - - -1879047658 - - -1879047657 - - -1879047656 - - -1879047655 - - -1879047654 - - -1879047653 - - -1879047652 - - -1879047651 - - -1879047650 - - -1879047649 - - -1879047648 - - -1879047647 - - -1879047646 - - -1879047645 - - -1879047644 - - -1879047643 - - -1879047642 - - -1879047640 - - -1879047639 - - -1879047638 - - -1879047637 - - -1879047636 - - -1879047635 - - -1879047634 - - -1879047633 - - -1879047631 - - -1879047630 - - -1879047629 - - -1879047628 - - -1879047627 - - -1879047626 - - -1879047625 - - -1879047624 - - -1879047623 - - -1879047622 - - -1879047621 - - -1879047620 - - -1879047619 - - -1879047618 - - -1879047617 - - -1879047616 - - -1879047615 - - -1879047614 - - -1879047613 - - -1879047612 - - -1879047611 - - -1879047610 - - -1879047609 - - -1879047608 - - -1879047607 - - -1879047606 - - -1879047605 - - -1879047604 - - -1879047603 - - -1879047602 - - -1879047601 - - -1879048160 - - -1879048159 - - -1879048158 - - -1879048157 - - -1879048156 - - -1879048155 - - -1879048154 - - -1879048144 - - -1879048143 - - -1879048142 - - -1879048141 - - -1879047936 - - -1879047776 - - -1879047775 - - -1879047935 - - -1879047934 - - -1879047933 - - -1879047927 - - -1879047760 - - -1879047759 - - -1879047758 - - -1879047932 - - -1879047931 - - -1879047930 - - -1879047929 - - -1879047928 - - -1879047744 - - -1879047736 - - -1879047728 - - -1879047720 - - -1879047926 - - -1879047925 - - -1879047924 - - -1879047923 - - -1879047922 - - -1879047921 - - -1879047920 - - -1879047919 - - -1879047918 - - -1879047909 - - -1879047908 - - -1879047907 - - -1879047906 - - -1879047905 - - -1879047915 - - -1879047914 - - -1879047913 - - -1879047912 - - -1879047911 - - -1879047910 - - 139272 - - 139273 - - 139274 - - 139277 - - 139278 - - 139279 - - 139280 - - 139281 - - 139282 - - 139283 - - 139284 - - 139285 - - 139286 - - 139287 - - 139288 - - -1878982656 - - -1878917120 - - -1878851584 - - -1878786048 - - -1878720512 - - -1878654976 - - -1878589440 - - -1878523904 - - -1878458368 - - -1878392832 - - -1878327296 - - -1877999616 - - -1877934080 - - -1877868544 - - -1877803008 - - -1877737472 - - -1877671936 - - -1877606400 - - -1877540864 - - -1877475328 - - -1877409792 - - -1877344256 - - -1862270976 - - -1862270975 - - -1862270974 - - -1862270973 - - -1862270972 - - -1862270971 - - -1862270970 - - -1862270969 - - -1862270968 - - -1862270967 - - -1862270966 - - -1862270965 - - -1862270964 - - -1862270963 - - -1862270962 - - -1862270720 - - -1862270719 - - -1862270718 - - -1862270717 - - -1862270716 - - -1862270715 - - -1862270714 - - -1862270713 - - -1862270712 - - -1862270711 - - -1862270710 - - -1862270709 - - -1862270708 - - -1862270707 - - -1862270706 - - -1862270705 - - -1862270704 - - -1862270463 - - -1862270462 - - -1862270461 - - -1862270460 - - -1862270208 - - -1845493483 - - -1845493482 - - -1845493481 - - -1845493480 - - -1845493479 - - -1879047600 - - -1879047599 - - 139289 - - -1879047598 + - 0x90000001 + - 0x90000002 + - 0x90000003 + - 0x90000004 + - 0x90000005 + - 0x90000006 + - 0x90000008 + - 0x9000000E + - 0x9000000F + - 0x90000010 + - 0x90000017 + - 0x90000200 + - 0x90000201 + - 0x90000202 + - 0x90000203 + - 0x90000204 + - 0x90000205 + - 0x90000206 + - 0x90000207 + - 0x90000208 + - 0x90000209 + - 0x9000020A + - 0x9000020B + - 0x9000020C + - 0x9000020D + - 0x9000020E + - 0x9000020F + - 0x90000210 + - 0x90000211 + - 0x90000212 + - 0x90000213 + - 0x90000214 + - 0x90000215 + - 0x90000216 + - 0x90000217 + - 0x90000218 + - 0x90000219 + - 0x9000021A + - 0x9000021B + - 0x9000021C + - 0x9000021D + - 0x9000021E + - 0x9000021F + - 0x90000220 + - 0x90000221 + - 0x90000222 + - 0x90000223 + - 0x90000224 + - 0x90000225 + - 0x90000226 + - 0x90000228 + - 0x90000229 + - 0x9000022A + - 0x9000022B + - 0x9000022C + - 0x9000022D + - 0x9000022E + - 0x9000022F + - 0x90000231 + - 0x90000232 + - 0x90000233 + - 0x90000234 + - 0x90000235 + - 0x90000236 + - 0x90000237 + - 0x90000238 + - 0x90000239 + - 0x9000023A + - 0x9000023B + - 0x9000023C + - 0x9000023D + - 0x9000023E + - 0x9000023F + - 0x90000240 + - 0x90000241 + - 0x90000242 + - 0x90000243 + - 0x90000244 + - 0x90000245 + - 0x90000246 + - 0x90000247 + - 0x90000248 + - 0x90000249 + - 0x9000024A + - 0x9000024B + - 0x9000024C + - 0x9000024D + - 0x9000024E + - 0x9000024F + - 0x90000020 + - 0x90000021 + - 0x90000022 + - 0x90000023 + - 0x90000024 + - 0x90000025 + - 0x90000026 + - 0x90000030 + - 0x90000031 + - 0x90000032 + - 0x90000033 + - 0x90000100 + - 0x900001A0 + - 0x900001A1 + - 0x90000101 + - 0x90000102 + - 0x90000103 + - 0x90000109 + - 0x900001B0 + - 0x900001B1 + - 0x900001B2 + - 0x90000104 + - 0x90000105 + - 0x90000106 + - 0x90000107 + - 0x90000108 + - 0x900001C0 + - 0x900001C8 + - 0x900001D0 + - 0x900001D8 + - 0x9000010A + - 0x9000010B + - 0x9000010C + - 0x9000010D + - 0x9000010E + - 0x9000010F + - 0x90000110 + - 0x90000111 + - 0x90000112 + - 0x9000011B + - 0x9000011C + - 0x9000011D + - 0x9000011E + - 0x9000011F + - 0x90000115 + - 0x90000116 + - 0x90000117 + - 0x90000118 + - 0x90000119 + - 0x9000011A + - 0x00022008 + - 0x00022009 + - 0x0002200A + - 0x0002200D + - 0x0002200E + - 0x0002200F + - 0x00022010 + - 0x00022011 + - 0x00022012 + - 0x00022013 + - 0x00022014 + - 0x00022015 + - 0x00022016 + - 0x00022017 + - 0x00022018 + - 0x90010000 + - 0x90020000 + - 0x90030000 + - 0x90040000 + - 0x90050000 + - 0x90060000 + - 0x90070000 + - 0x90080000 + - 0x90090000 + - 0x900A0000 + - 0x900B0000 + - 0x90100000 + - 0x90110000 + - 0x90120000 + - 0x90130000 + - 0x90140000 + - 0x90150000 + - 0x90160000 + - 0x90170000 + - 0x90180000 + - 0x90190000 + - 0x901A0000 + - 0x91000000 + - 0x91000001 + - 0x91000002 + - 0x91000003 + - 0x91000004 + - 0x91000005 + - 0x91000006 + - 0x91000007 + - 0x91000008 + - 0x91000009 + - 0x9100000A + - 0x9100000B + - 0x9100000C + - 0x9100000D + - 0x9100000E + - 0x91000100 + - 0x91000101 + - 0x91000102 + - 0x91000103 + - 0x91000104 + - 0x91000105 + - 0x91000106 + - 0x91000107 + - 0x91000108 + - 0x91000109 + - 0x9100010A + - 0x9100010B + - 0x9100010C + - 0x9100010D + - 0x9100010E + - 0x9100010F + - 0x91000110 + - 0x91000201 + - 0x91000202 + - 0x91000203 + - 0x91000204 + - 0x91000300 + - 0x92000115 + - 0x92000116 + - 0x92000117 + - 0x92000118 + - 0x92000119 + - 0x90000250 + - 0x90000251 + - 0x00022019 + - 0x90000252 x-enum-descriptions: - "ASN certificate: Incorrect version" - "ASN certificate: Non-matching signature algorithm" diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml new file mode 100644 index 0000000..4bc971a --- /dev/null +++ b/e-rfid-data-file-type.yml @@ -0,0 +1,184 @@ +openapi: 3.0.3 +components: + schemas: + RfidDataFileType: + title: "RfidDataFileType" + type: integer + description: "Enumeration contains a set of constants that define the file type + (or logical belonging of the data object) within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 113 + - 114 + - 115 + - 116 + - 117 + - 118 + - 119 + - 120 + - 121 + - 150 + - 151 + - 152 + - 153 + - 154 + - 155 + - 156 + - 157 + - 158 + - 159 + - 160 + - 161 + - 162 + - 163 + - 164 + - 165 + - 166 + - 167 + - 200 + - 201 + - 202 + - 300 + - 301 + - 302 + - 400 + - 500 + - 501 + - 600 + - 601 + - 602 + - 603 + - 700 + - 701 + - 702 + - 703 + - 710 + - 711 + - 712 + - 713 + - 714 + - 715 + - 1000 + x-enum-varnames: + - "UNSPECIFIED" + - "PASSPORT_DG1" + - "PASSPORT_DG2" + - "PASSPORT_DG3" + - "PASSPORT_DG4" + - "PASSPORT_DG5" + - "PASSPORT_DG6" + - "PASSPORT_DG7" + - "PASSPORT_DG8" + - "PASSPORT_DG9" + - "PASSPORT_DG10" + - "PASSPORT_DG11" + - "PASSPORT_DG12" + - "PASSPORT_DG13" + - "PASSPORT_DG14" + - "PASSPORT_DG15" + - "PASSPORT_DG16" + - "PASSPORT_DG17" + - "PASSPORT_DG18" + - "PASSPORT_DG19" + - "PASSPORT_DG20" + - "PASSPORT_SOD" + - "PASSPORT_CVCA" + - "PASSPORT_COM" + - "ID_DG1" + - "ID_DG2" + - "ID_DG3" + - "ID_DG4" + - "ID_DG5" + - "ID_DG6" + - "ID_DG7" + - "ID_DG8" + - "ID_DG9" + - "ID_DG10" + - "ID_DG11" + - "ID_DG12" + - "ID_DG13" + - "ID_DG14" + - "ID_DG15" + - "ID_DG16" + - "ID_DG17" + - "ID_DG18" + - "ID_DG19" + - "ID_DG20" + - "ID_DG21" + - "DL_COM" + - "DL_DG1" + - "DL_DG2" + - "DL_DG3" + - "DL_DG4" + - "DL_DG5" + - "DL_DG6" + - "DL_DG7" + - "DL_DG8" + - "DL_DG9" + - "DL_DG10" + - "DL_DG11" + - "DL_DG12" + - "DL_DG13" + - "DL_DG14" + - "DL_SOD" + - "DL_CE" + - "DL_CVCA" + - "PACE_CARD_ACCESS" + - "PACE_CARD_SECURITY" + - "PACE_CHIP_SECURITY" + - "MIFARE_DATA" + - "MIFARE_VALIDITY" + - "AUTHENTICITY_V2" + - "ATR" + - "_E_SIGN_PK" + - "_E_SIGN_SIGNED_DATA" + - "CERTIFICATE" + - "MASTER_LIST" + - "DEFECT_LIST" + - "BLACK_LIST" + - "APP_DIRECTORY" + - "SESSION" + - "LOG_DATA" + - "CHIP_PROPERTIES" + - "POST_CA_RESPONSE" + - "POST_CA_PUBLIC_KEY" + - "POST_CA_INFO" + - "POST_CA_D_PARAMS" + - "POST_CA_CHECK_PK" + - "POST_CA_CHECK_SK" + - "USER_DEFINED" diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml new file mode 100644 index 0000000..9f72811 --- /dev/null +++ b/e-rfid-data-group-type-tag.yml @@ -0,0 +1,177 @@ +openapi: 3.0.3 +components: + schemas: + RfidDataGroupTypeTag: + title: "RfidDataGroupTypeTag" + type: integer + description: "Enumeration representing RFID Data Group Types. + Constants with prefix correspond to the informational data groups of ePassport + application, with prefix EID_ – those of eID application, with prefix EDL_ – + eDL application" + enum: + - 0x60 + - 0x61 + - 0x75 + - 0x63 + - 0x76 + - 0x65 + - 0x66 + - 0x67 + - 0x68 + - 0x69 + - 0x6A + - 0x6B + - 0x6C + - 0x6D + - 0x6E + - 0x6F + - 0x70 + - 0x77 + - 0x61 + - 0x62 + - 0x63 + - 0x64 + - 0x65 + - 0x66 + - 0x67 + - 0x68 + - 0x69 + - 0x6A + - 0x6B + - 0x6C + - 0x6D + - 0x6E + - 0x6F + - 0x70 + - 0x71 + - 0x72 + - 0x73 + - 0x74 + - 0x75 + - 0x60 + - 0x77 + - 0x77 + - 0x61 + - 0x6B + - 0x6C + - 0x65 + - 0x67 + - 0x75 + - 0x63 + - 0x76 + - 0x70 + - 0x6D + - 0x71 + - 0x6F + - 0x6E + x-enum-descriptions: + - "Common Data Group Type" + - "Data Group 1" + - "Data Group 2" + - "Data Group 3" + - "Data Group 4" + - "Data Group 5" + - "Data Group 6" + - "Data Group 7" + - "Data Group 8" + - "Data Group 9" + - "Data Group 10" + - "Data Group 11" + - "Data Group 12" + - "Data Group 13" + - "Data Group 14" + - "Data Group 15" + - "Data Group 16" + - "Start of Data" + - "Extended Interoperable Data, Data Group 1" + - "Extended Interoperable Data, Data Group 2" + - "Extended Interoperable Data, Data Group 3" + - "Extended Interoperable Data, Data Group 4" + - "Extended Interoperable Data, Data Group 5" + - "Extended Interoperable Data, Data Group 6" + - "Extended Interoperable Data, Data Group 7" + - "Extended Interoperable Data, Data Group 8" + - "Extended Interoperable Data, Data Group 9" + - "Extended Interoperable Data, Data Group 10" + - "Extended Interoperable Data, Data Group 11" + - "Extended Interoperable Data, Data Group 12" + - "Extended Interoperable Data, Data Group 13" + - "Extended Interoperable Data, Data Group 14" + - "Extended Interoperable Data, Data Group 15" + - "Extended Interoperable Data, Data Group 16" + - "Extended Interoperable Data, Data Group 17" + - "Extended Interoperable Data, Data Group 18" + - "Extended Interoperable Data, Data Group 19" + - "Extended Interoperable Data, Data Group 20" + - "Extended Interoperable Data, Data Group 21" + - "Extended Length Data, Common Data Group Type" + - "Extended Length Data, Start of Data" + - "Extended Length Data, Certificate Holder Authorization" + - "Extended Length Data, Data Group 1" + - "Extended Length Data, Data Group 2" + - "Extended Length Data, Data Group 3" + - "Extended Length Data, Data Group 4" + - "Extended Length Data, Data Group 5" + - "Extended Length Data, Data Group 6" + - "Extended Length Data, Data Group 7" + - "Extended Length Data, Data Group 8" + - "Extended Length Data, Data Group 9" + - "Extended Length Data, Data Group 11" + - "Extended Length Data, Data Group 12" + - "Extended Length Data, Data Group 13" + - "Extended Length Data, Data Group 14" + x-enum-varnames: + - "COM" + - "DG1" + - "DG2" + - "DG3" + - "DG4" + - "DG5" + - "DG6" + - "DG7" + - "DG8" + - "DG9" + - "DG10" + - "DG11" + - "DG12" + - "DG13" + - "DG14" + - "DG15" + - "DG16" + - "SOD" + - "EID_DG1" + - "EID_DG2" + - "EID_DG3" + - "EID_DG4" + - "EID_DG5" + - "EID_DG6" + - "EID_DG7" + - "EID_DG8" + - "EID_DG9" + - "EID_DG10" + - "EID_DG11" + - "EID_DG12" + - "EID_DG13" + - "EID_DG14" + - "EID_DG15" + - "EID_DG16" + - "EID_DG17" + - "EID_DG18" + - "EID_DG19" + - "EID_DG20" + - "EID_DG21" + - "EDL_COM" + - "EDL_SOD" + - "EDL_CE" + - "EDL_DG1" + - "EDL_DG2" + - "EDL_DG3" + - "EDL_DG4" + - "EDL_DG5" + - "EDL_DG6" + - "EDL_DG7" + - "EDL_DG8" + - "EDL_DG9" + - "EDL_DG11" + - "EDL_DG12" + - "EDL_DG14" diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index a656f7d..127ba64 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -2,123 +2,124 @@ openapi: 3.0.3 components: schemas: RFIDErrorCodes: + title: "RFIDErrorCodes" type: integer description: "Enumeration contains a set of error codes returned by SDK" enum: - - -2147458430 - - -2147458429 - - -2147458112 - - -2147458111 - - -2147456637 - - -2147456636 - - -2147456635 - - -2147456384 - - -2147456382 - - -2147456376 - - -2147456256 - - -2147418111 - - -2147418110 - - -2147418108 - - -2147418107 - - -2147418106 - - -2147418104 - - -2147418103 - - -2147418102 - - -2147418101 - - -2147418100 - - -2147352576 - - -2147352575 - - -2147352574 - - -2147352573 - - -2147352572 - - -2147352571 - - -2147352570 - - -2147352560 - - -2146409536 - - -2097152000 - - -2097151999 - - -2097151998 - - -2097151984 - - -2097151983 - - -2097151982 - - -2097151981 - - -2097151980 - - -2097151979 - - -2097151978 - - -2097151977 - - -2097151976 - - -2097151975 - - -2097151974 - - -2097151973 - - -2097151972 - - -2097151968 - - -2097151967 - - -2097151966 - - -2097151965 - - -2097151964 - - -2097151963 - - -2097151962 - - -2097151961 - - -2097151960 - - -2097151959 - - -2097151958 - - -2097151952 - - -2097151951 - - -2097151936 - - -2097151935 - - -2097151934 - - -2097151920 - - -2097151919 - - -2097151918 - - -2097151904 - - -2097086464 - - -2097020928 - - -2096955392 - - -2096889856 - - -2096824320 - - -2096758784 - - -2096693248 - - -2096627712 - - -2080374784 - - -2080309248 - - -2080243712 - - -2080178176 - - -2080112640 - - -2080047104 - - -2079981568 - - -2079916032 - - -2079850496 - - -2079784960 - - -2079719424 - - -2079653888 - - -2079588352 - - -2079522816 - - -2079457280 - - -2079391744 - - -2046820352 - - -2046820351 - - -2046820096 - - -2046820095 - - -2046820094 - - -2046820093 - - -2046819840 - - -2046819839 - - -2046819838 - - -2046819837 - - -2046819836 - - -2046819584 - - -2046819583 - - -2046819582 - - -2046819581 - - -2046819580 - - -2046819579 - - -2046819578 - - -2046819577 - - -2046819576 - - -2046819575 - - -1 - - 1 - - 2 + - 0x80006282 + - 0x80006283 + - 0x800063C0 + - 0x800063C1 + - 0x80006983 + - 0x80006984 + - 0x80006985 + - 0x80006A80 + - 0x80006A82 + - 0x80006A88 + - 0x80006B00 + - 0x80010001 + - 0x80010002 + - 0x80010004 + - 0x80010005 + - 0x80010006 + - 0x80010008 + - 0x80010009 + - 0x8001000A + - 0x8001000B + - 0x8001000C + - 0x80020000 + - 0x80020001 + - 0x80020002 + - 0x80020003 + - 0x80020004 + - 0x80020005 + - 0x80020006 + - 0x80020010 + - 0x801063C0 + - 0x83000000 + - 0x83000001 + - 0x83000002 + - 0x83000010 + - 0x83000011 + - 0x83000012 + - 0x83000013 + - 0x83000014 + - 0x83000015 + - 0x83000016 + - 0x83000017 + - 0x83000018 + - 0x83000019 + - 0x8300001A + - 0x8300001B + - 0x8300001C + - 0x83000020 + - 0x83000021 + - 0x83000022 + - 0x83000023 + - 0x83000024 + - 0x83000025 + - 0x83000026 + - 0x83000027 + - 0x83000028 + - 0x83000029 + - 0x8300002A + - 0x83000030 + - 0x83000031 + - 0x83000040 + - 0x83000041 + - 0x83000042 + - 0x83000050 + - 0x83000051 + - 0x83000052 + - 0x83000060 + - 0x83010000 + - 0x83020000 + - 0x83030000 + - 0x83040000 + - 0x83050000 + - 0x83060000 + - 0x83070000 + - 0x83080000 + - 0x84000000 + - 0x84010000 + - 0x84020000 + - 0x84030000 + - 0x84040000 + - 0x84050000 + - 0x84060000 + - 0x84070000 + - 0x84080000 + - 0x84090000 + - 0x840A0000 + - 0x840B0000 + - 0x840C0000 + - 0x840D0000 + - 0x840E0000 + - 0x840F0000 + - 0x86000000 + - 0x86000001 + - 0x86000100 + - 0x86000101 + - 0x86000102 + - 0x86000103 + - 0x86000200 + - 0x86000201 + - 0x86000202 + - 0x86000203 + - 0x86000204 + - 0x86000300 + - 0x86000301 + - 0x86000302 + - 0x86000303 + - 0x86000304 + - 0x86000305 + - 0x86000306 + - 0x86000307 + - 0x86000308 + - 0x86000309 + - 0xFFFFFFFF + - 0x00000001 + - 0x00000002 x-enum-descriptions: - "LAYER6: Reading beyond EOF / Unexpected EOF" - "LAYER6: PWD deactivated" diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 1150803..471e932 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: SecurityFeatureType: + title: "SecurityFeatureType" type: integer description: "Enumeration contains identifiers determining type of features for a document authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/security-feature-type/" enum: diff --git a/e-text-field-type.yml b/e-text-field-type.yml index 3646d9e..603c9d7 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: TextFieldType: + title: "TextFieldType" type: integer enum: - 0 @@ -1919,4 +1920,4 @@ components: - "FT_RESULT_OF_TESTING" - "FT_METHOD_OF_TESTING" - "FT_DIGITAL_TRAVEL_AUTHORIZATION_NUMBER" - - "FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT" \ No newline at end of file + - "FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT" diff --git a/index.yml b/index.yml index 2098914..19be01c 100644 --- a/index.yml +++ b/index.yml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 7.2.0 + version: 7.4.0 title: Regula Document Reader Web API x-logo: url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg" @@ -65,7 +65,7 @@ tags: - name: document_model x-displayName: Document Model description: | - **Choosen Document model:** + **Chosen Document model:** **Candidates model:** @@ -74,7 +74,6 @@ tags: description: | - x-tagGroups: - name: Requests tags: @@ -91,12 +90,6 @@ x-tagGroups: components: schemas: - Status: - $ref: "./rt-status.yml#/components/schemas/Status" - Text: - $ref: "./rt-text.yml#/components/schemas/Text" - Images: - $ref: "./rt-images.yml#/components/schemas/Images" DocumentImage: $ref: "./common.yml#/components/schemas/ImageData" TransactionImage: @@ -105,7 +98,3 @@ components: $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList" ChosenDocumentType: $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" - AuthenticityCheckResult: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityCheckResult" - AuthenticityResultType: - $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" diff --git a/p-ping.yml b/p-ping.yml index 8805fa1..167aecc 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -1,4 +1,7 @@ openapi: 3.0.3 +info: + version: 7.4.0 + title: Regula Document Reader Web API paths: /ping: @@ -21,6 +24,7 @@ paths: components: schemas: DeviceInfo: + title: "DeviceInfo" type: object properties: app-name: diff --git a/p-process.yml b/p-process.yml index 1517255..c4a004f 100644 --- a/p-process.yml +++ b/p-process.yml @@ -1,4 +1,7 @@ openapi: 3.0.3 +info: + version: 7.4.0 + title: Regula Document Reader Web API paths: /process: @@ -135,14 +138,19 @@ paths: components: schemas: - ############################# ############################# Requests objects - - # todo different image input types ProcessRequest: + title: "ProcessRequest" type: object + required: + - processParam properties: + lcidFilter: + type: array + description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." + items: + $ref: "./e-lcid.yml#/components/schemas/LCID" processParam: $ref: "#/components/schemas/ProcessParams" List: @@ -177,22 +185,26 @@ components: description: "Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs." additionalProperties: true - required: - - processParam ProcessParams: + title: "ProcessParams" type: object + required: + - scenario properties: lcidFilter: description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." type: array items: - type: integer + $ref: "./e-lcid.yml#/components/schemas/LCID" + checkLiveness: + description: "This parameter is used to enable document liveness check." + type: boolean lcidIgnoreFilter: description: "The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default." type: array items: - type: integer + $ref: "./e-lcid.yml#/components/schemas/LCID" oneShotIdentification: type: boolean description: "This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person's face" @@ -416,7 +428,7 @@ components: checkAuth: type: boolean description: "This parameter is used to enable authenticity checks" -# default: true + # default: true authParams: $ref: '#/components/schemas/AuthParams' mrzDetectMode: @@ -424,11 +436,10 @@ components: generateNumericCodes: type: boolean description: "This parameter is used to generate numeric representation for issuing state and nationality codes" -# default: false - required: - - scenario + # default: false MRZFormat: + title: "MRZFormat" type: string enum: - "1x30" @@ -453,6 +464,7 @@ components: - "2x30" TextPostProcessing: + title: "TextPostProcessing" type: integer enum: - 0 @@ -471,6 +483,7 @@ components: - "Capital" mrzDetectModeEnum: + title: "mrzDetectModeEnum" type: integer description: "Make better MRZ detection on complex noisy backgrounds, like BW photocopy of some documents." enum: @@ -483,103 +496,91 @@ components: - "eMDM_BlurBeforeBinarization" AuthParams: + title: "AuthParams" type: object properties: checkLiveness: type: boolean description: "This parameter is used to enable document liveness check" -# default: true - + # default: true livenessParams: $ref: '#/components/schemas/LivenessParams' - checkUVLuminiscence: type: boolean description: "This parameter is used to enable Document luminescence check in UV light" -# default: true - + # default: true checkIRB900: type: boolean description: "This parameter is used to enable B900 ink MRZ contrast check in IR light" -# default: true - + # default: true checkImagePatterns: type: boolean description: "This parameter is used to enable Image patterns presence/absence check (position, shape, color)" -# default: true - + # default: true checkFibers: type: boolean description: "This parameter is used to enable Fibers detection" -# default: true - + # default: true checkExtMRZ: type: boolean description: "This parameter is used to enable Extended MRZ Check" -# default: true - + # default: true checkExtOCR: type: boolean description: "This parameter is used to enable Extended OCR Check" -# default: true - + # default: true checkAxial: type: boolean description: "This parameter is used to enable laminate integrity check in axial light" -# default: true - + # default: true checkBarcodeFormat: type: boolean description: "This parameter is used to enable Barcode format check (code metadata, data format, contents format, etc.)" -# default: true - + # default: true checkIRVisibility: type: boolean description: "This parameter is used to enable Document elements visibility check in IR light" -# default: true - + # default: true checkIPI: type: boolean description: "This parameter is used to enable Invisible Personal Information (IPI) check" -# default: true - + # default: true checkPhotoEmbedding: type: boolean description: "This parameter is used to enable Owner's photo embedding check (is photo printed or sticked)" -# default: true - + # default: true checkPhotoComparison: type: boolean description: "This parameter is used to enable Portrait comparison check" -# default: true - + # default: true checkLetterScreen: type: boolean description: "This parameter is used to enable LetterScreen check" -# default: false - + # default: false LivenessParams: + title: "LivenessParams" type: object properties: checkOVI: type: boolean description: "This parameter is used to enable OVI check" -# default: true + # default: true checkMLI: type: boolean description: "This parameter is used to enable MLI check" -# default: true + # default: true checkHolo: type: boolean description: "This parameter is used to enable Hologram detection" -# default: true + # default: true checkED: type: boolean description: "This parameter is used to enable Electronic device detection" -# default: true + # default: true MeasureSystem: + title: "MeasureSystem" type: integer example: 0 enum: @@ -593,6 +594,7 @@ components: - "IMPERIAL" LogLevel: + title: "LogLevel" type: string enum: - FatalError @@ -613,8 +615,8 @@ components: - "Info" - "Debug" - PerDocumentConfig: + title: "PerDocumentConfig" type: object properties: docID: @@ -627,8 +629,8 @@ components: type: integer example: 2 - ImageQA: + title: "ImageQA" type: object properties: brightnessThreshold: @@ -657,12 +659,16 @@ components: description: "This option enables colorness check while performing image quality validation." type: boolean # default: false + moireCheck: + description: "This option enables screen capture (moire patterns) check while performing image quality validation." + type: boolean documentPositionIndent: description: "This parameter specifies the necessary margin. Default 0." type: integer # default: 0 ProcessRequestImage: + title: "ProcessRequestImage" type: object required: - ImageData @@ -682,6 +688,7 @@ components: image: "" ProcessSystemInfo: + title: "ProcessSystemInfo" type: object properties: license: @@ -694,11 +701,15 @@ components: ############################# ############################# Response objects ProcessResponse: + title: "ProcessResponse" type: object required: + - ChipPage - ProcessingFinished - ContainerList - TransactionInfo + - morePagesAvailable + - elapsedTime properties: ChipPage: $ref: "./common.yml#/components/schemas/RfidLocation" @@ -720,8 +731,12 @@ components: elapsedTime: type: integer description: "Time the document processing has taken, ms." + metadata: + type: object + additionalProperties: true ProcessingStatus: + title: "ProcessingStatus" type: integer enum: - 0 @@ -737,19 +752,39 @@ components: - "TIMEOUT" TransactionInfo: + title: "TransactionInfo" type: object properties: ComputerName: type: string DateTime: type: string + DocumentsDatabase: + $ref: "#/components/schemas/DocumentsDatabase" + SystemInfo: + type: string + Tag: + type: string TransactionID: type: string UserName: type: string + Version: + type: string example: "ComputerName": "7cded6852d20" "DateTime": "2020-05-27T08:17:03.247Z" "TransactionID": "dc5eb444-ad6e-4ebc-8102-d62d5bb56a4e" "UserName": "user" + DocumentsDatabase: + type: object + properties: + Description: + type: string + ExportDate: + type: string + ID: + type: string + Version: + type: string diff --git a/p-transaction.yml b/p-transaction.yml index 6f53059..bd13c8e 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 6.9.0 + version: 7.4.0 title: Regula Document Reader Web API paths: @@ -29,17 +29,7 @@ paths: content: application/json: schema: - type: object - properties: - OutData: - $ref: '#/components/schemas/OutData' - InData: - $ref: '#/components/schemas/InData' - tag: - type: string - transactionId: - type: string - format: uuid + $ref: '#/components/schemas/TransactionProcessResult' "400": description: "Bad request. Check your input data." "403": @@ -97,35 +87,12 @@ paths: content: application/json: schema: - type: object - properties: - ChipPage: - $ref: "./common.yml#/components/schemas/RfidLocation" - ProcessingFinished: - $ref: "./p-process.yml#/components/schemas/ProcessingStatus" - ContainerList: - $ref: "./rt.yml#/components/schemas/ContainerList" - TransactionInfo: - $ref: "./p-process.yml#/components/schemas/TransactionInfo" - log: - description: "Base64 encoded transaction processing log" - type: string - passBackObject: - type: object - description: "Free-form object provided in request. See passBackObject property of ProcessRequest." - additionalProperties: true - morePagesAvailable: - type: integer - elapsedTime: - type: integer - description: "Time the document processing has taken, ms." - CoreLibResultCode: - type: integer - + $ref: '#/components/schemas/TransactionProcessResponse' "400": description: "Bad request. Check your input data." "403": description: "Bad license. Either server or request does not contain valid license." + /transaction/{transactionId}/file: get: parameters: @@ -155,6 +122,7 @@ paths: format: binary "404": description: "File not found" + /tag/{tagId}: delete: parameters: @@ -178,6 +146,7 @@ paths: description: "Bad request. Check your input data." "403": description: "Bad license. Either server or request does not contain valid license." + /tag/{tagId}/transactions: get: parameters: @@ -205,6 +174,7 @@ paths: components: schemas: ListTransactionsByTagResponse: + title: "ListTransactionsByTagResponse" type: object properties: items: @@ -214,7 +184,9 @@ components: metadata: type: object additionalProperties: true + GetTransactionsByTagResponse: + title: "GetTransactionsByTagResponse" type: object properties: id: @@ -228,7 +200,34 @@ components: type: string format: 'date-time' description: "Last time updated" + + TransactionProcessResult: + title: "TransactionProcessResult" + type: object + properties: + OutData: + $ref: '#/components/schemas/OutData' + InData: + $ref: '#/components/schemas/InData' + tag: + type: string + transactionId: + type: string + format: uuid + + TransactionProcessResponse: + title: "TransactionProcessResponse" + allOf: + - type: object + required: + - CoreLibResultCode + properties: + CoreLibResultCode: + type: integer + - $ref: "./p-process.yml#/components/schemas/ProcessResponse" + TransactionProcessGetResponse: + title: "TransactionProcessGetResponse" type: object properties: transactionId: @@ -242,6 +241,7 @@ components: $ref: '#/components/schemas/InData' OutData: + title: "OutData" type: object properties: url: @@ -253,6 +253,7 @@ components: $ref: "#/components/schemas/OutDataTransactionImagesFieldValue" InData: + title: "InData" type: object properties: video: @@ -272,7 +273,10 @@ components: $ref: "#/components/schemas/InDataTransactionImagesFieldValue" TransactionProcessRequest: + title: "TransactionProcessRequest" type: object + required: + - processParam properties: processParam: $ref: "./p-process.yml#/components/schemas/ProcessParams" @@ -299,10 +303,9 @@ components: description: "Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs." additionalProperties: true - required: - - processParam InDataTransactionImagesFieldValue: + title: "InDataTransactionImagesFieldValue" type: object properties: light: @@ -316,6 +319,7 @@ components: description: "Image url" OutDataTransactionImagesFieldValue: + title: "OutDataTransactionImagesFieldValue" type: object properties: fieldType: @@ -331,6 +335,7 @@ components: description: "Image url" TransactionScenarioRequest: + title: "TransactionScenarioRequest" type: object properties: scenario: diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 9773d9d..f6709b9 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -1,9 +1,8 @@ -openapi: 3.0.3 +openapi: 3.1.0 components: schemas: - AuthenticityResult: - title: "Authenticity Checks" + title: "AuthenticityResult" allOf: - type: object required: @@ -14,8 +13,10 @@ components: - $ref: "./rt.yml#/components/schemas/ResultItem" AuthenticityCheckList: + title: "AuthenticityCheckList" type: object required: + - Count - List properties: Count: @@ -28,6 +29,7 @@ components: $ref: "#/components/schemas/AuthenticityCheckResult" AuthenticityCheckResult: + title: "AuthenticityCheckResult" type: object required: - Type @@ -38,22 +40,27 @@ components: $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" Result: $ref: "./common.yml#/components/schemas/CheckResult" + Count: + type: integer + description: "Count of items in List" List: type: array items: anyOf: - - $ref: "#/components/schemas/SecurityFeatureResult" - - $ref: "#/components/schemas/IdentResult" - - $ref: "#/components/schemas/FiberResult" - - $ref: "#/components/schemas/OCRSecurityTextResult" - - $ref: "#/components/schemas/PhotoIdentResult" + - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" + - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" + - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" + - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" + - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" AuthenticityType: + title: "AuthenticityType" type: integer description: "Same as authenticity result type, but used for safe parsing of not-described values: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/" default: 0 AuthenticityCheckResultItem: + title: "AuthenticityCheckResultItem" description: "Common fields for all authenticity result objects" type: object required: @@ -68,51 +75,15 @@ components: PercentValue: type: integer format: double - discriminator: - propertyName: Type - mapping: - 1: "SecurityFeatureResult" - 2: "SecurityFeatureResult" - 4: "IdentResult" - 8: "SecurityFeatureResult" - 16: "FiberResult" - 32: "IdentResult" - 64: "OCRSecurityTextResult" - 128: "PhotoIdentResult" - 256: "PhotoIdentResult" - 512: "SecurityFeatureResult" - 1024: "IdentResult" - 2048: "IdentResult" - 4096: "SecurityFeatureResult" - 8192: "SecurityFeatureResult" - 16384: "FiberResult" - 32768: "IdentResult" - 65536: "SecurityFeatureResult" - 131072: "IdentResult" - 262144: "IdentResult" - 524288: "IdentResult" - 1048576: "IdentResult" - 8388608: "SecurityFeatureResult" - - - SecurityFeatureResult: - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" - - IdentResult: - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" - - FiberResult: - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" - - OCRSecurityTextResult: - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" - - PhotoIdentResult: - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" AreaContainer: + title: "AreaContainer" description: "Checked fragment coordinates" type: object + required: + - Count + - List + - Points properties: Count: type: integer @@ -126,11 +97,14 @@ components: $ref: "#/components/schemas/PointsContainer" PointsContainer: + title: "PointsContainer" type: object + required: + - PointsList properties: PointCount: type: integer PointsList: type: array items: - $ref: "./common.yml#/components/schemas/Point" \ No newline at end of file + $ref: "./common.yml#/components/schemas/Point" diff --git a/rt-barcodes.yml b/rt-barcodes.yml index 415cd59..ce5283a 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -1,20 +1,24 @@ openapi: 3.0.3 components: schemas: - DocBarCodeInfo: - title: "Document BarCode Info" + title: "DocBarCodeInfo" description: "Raw data from BarCodes" allOf: - type: object + required: + - DocBarCodeInfo properties: DocBarCodeInfo: $ref: "#/components/schemas/DocBarCodeInfoFieldsList" - $ref: "./rt.yml#/components/schemas/ResultItem" - DocBarCodeInfoFieldsList: + title: "DocBarCodeInfoFieldsList" type: object + required: + - nFields + - pArrayFields properties: nFields: type: integer @@ -26,10 +30,20 @@ components: $ref: "#/components/schemas/pArrayField" pArrayField: + title: "pArrayField" type: object + required: + - bcAngle_DETECT + - bcCodeResult + - bcCountModule + - bcDataModule + - bcROI_DETECT + - bcType_DECODE + - bcType_DETECT properties: bcAngle_DETECT: - type: float + type: number + format: float bcCodeResult: type: integer bcCountModule: @@ -47,15 +61,24 @@ components: bcTextFieldType: type: integer bcType_DECODE: - type: integer + $ref: "./e-barcode-type.yml#/components/schemas/BarcodeType" bcType_DETECT: type: integer bcPDF417INFO: + title: "bcPDF417INFO" type: object + required: + - Angle + - bcColumn + - bcErrorLevel + - bcRow + - minX + - minY properties: Angle: - type: float + type: number + format: float bcColumn: type: integer bcErrorLevel: @@ -63,12 +86,20 @@ components: bcRow: type: integer minX: - type: float + type: number + format: float minY: - type: float + type: number + format: float bcROI_DETECT: + title: "bcROI_DETECT" type: object + required: + - bottom + - left + - right + - top properties: bottom: type: integer @@ -80,7 +111,12 @@ components: type: integer DataModule: + title: "DataModule" type: object + required: + - mData + - mLength + - mType properties: mData: type: string @@ -91,4 +127,26 @@ components: mReserver2: type: integer mType: - type: integer + $ref: "#/components/schemas/BarCodeModuleType" + + BarCodeModuleType: + title: "BarCodeModuleType" + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + x-enum-descriptions: + - "Module contains text data" + - "Module contains byte data" + - "Module contains numeric data" + - "Shifts in byte compaction mode (for PDF417)" + - "Module contains any data" + x-enum-varnames: + - "TEXT" + - "BYTE" + - "NUM" + - "SHIFT" + - "ALL" diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index d4ef6c0..9f1e299 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -1,13 +1,14 @@ openapi: 3.0.3 components: schemas: - ChosenDocumentTypeResult: - title: "Chosen Document Type" + title: "ChosenDocumentTypeResult" description: "Contains information about the type of document that was determined based on the analysis of the provided image" allOf: - type: object + required: + - OneCandidate properties: OneCandidate: $ref: "#/components/schemas/OneCandidate" @@ -17,7 +18,7 @@ components: - $ref: "./rt.yml#/components/schemas/ResultItem" DocumentTypesCandidatesResult: - title: "Document Types Candidates" + title: "DocumentTypesCandidatesResult" allOf: - type: object properties: @@ -25,8 +26,8 @@ components: $ref: "#/components/schemas/DocumentTypesCandidatesList" - $ref: "./rt.yml#/components/schemas/ResultItem" - DocumentTypesCandidatesList: + title: "DocumentTypesCandidatesList" type: object properties: RecResult: @@ -38,6 +39,7 @@ components: $ref: "#/components/schemas/OneCandidate" DocumentTypeRecognitionResult: + title: "DocumentTypeRecognitionResult" type: integer enum: - 0 @@ -54,8 +56,21 @@ components: OneCandidate: + title: "OneCandidate" type: object description: "Contains information about one document type candidate" + required: + - DocumentName + - ID + - P + - Rotated180 + - RFID_Presence + - FDSIDList + - NecessaryLights + - CheckAuthenticity + - UVExp + - AuthenticityNecessaryLights + - OVIExp properties: DocumentName: type: string @@ -69,6 +84,9 @@ components: example: 0.9913095831871032 minimum: 0 maximum: 1 + Rotated180: + description: "true if the document of the given type is rotated by 180 degrees" + type: boolean RFID_Presence: description: "Indication of the presence of an RFID chip in the document (electronic document indicator)" $ref: "./common.yml#/components/schemas/RfidLocation" @@ -88,16 +106,33 @@ components: type: integer description: "Combination of lighting scheme identifiers (combination of Light enum) needed to perform all authenticity checks specified in CheckAuthenticity" + OVIExp: + description: "Camera exposure value necessary when obtaining document images of the given type for AXIAL lighting scheme" + type: number FDSIDList: + title: "FDSIDList" description: "Extended document type info and Regula's 'Information Reference Systems' links" type: object + required: + - ICAOCode + - Count + - List + - dType + - dFormat + - dMRZ + - dYear + - dCountryName + - isDeprecated properties: ICAOCode: type: string minLength: 3 maxLength: 3 description: "ICAO code of the issuing country" + Count: + description: "Number of elements in the List" + type: number List: type: array items: @@ -130,9 +165,11 @@ components: description: "Whether the document is deprecated" DocumentFormat: + title: "DocumentFormat" type: integer description: "Defining the geometric format of documents in accordance with ISO / IEC 7810" enum: + - -1 - 0 - 1 - 2 @@ -147,6 +184,7 @@ components: - 1000 - 1002 x-enum-descriptions: + - "Unknown document format" - "ID1 document format" - "ID2 document format" - "ID3 document format" @@ -161,6 +199,7 @@ components: - "Arbitrary format" - "Flexible format. Standard formats can be resized during cropping, depending on various factors: light, background..." x-enum-varnames: + - "UNKNOWN" - "ID1" - "ID2" - "ID3" diff --git a/rt-document-position.yml b/rt-document-position.yml index a25739d..f427b16 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -1,27 +1,43 @@ openapi: 3.0.3 components: schemas: - DocumentPositionResult: - title: "Document Position" + title: "DocumentPositionResult" description: "Contains information about document position on the input image, its center, angle, etc" allOf: - type: object + required: + - DocumentPosition properties: DocumentPosition: $ref: "#/components/schemas/DocumentPosition" - $ref: "./rt.yml#/components/schemas/ResultItem" DocumentPosition: + title: "DocumentPosition" type: object + required: + - docFormat + - Angle + - Width + - Height + - Center + - LeftBottom + - LeftTop + - RightBottom + - RightTop + - Dpi properties: docFormat: $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" Angle: + description: "Document rotation angle" type: number Width: + description: "Document width" type: integer Height: + description: "Document height" type: integer Center: $ref: "./common.yml#/components/schemas/Point" diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml index 524cecc..edc5976 100644 --- a/rt-encrypted-rcl.yml +++ b/rt-encrypted-rcl.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - EncryptedRCLResult: - title: "EncryptedRCL" + title: "EncryptedRCLResult" allOf: - type: object description: "Contains encrypted result container list" diff --git a/rt-image-data.yml b/rt-image-data.yml index 44fa57b..9c13170 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - GraphicsResult: - title: "Graphics (legacy)" + title: "GraphicsResult" description: "Graphic fields extracted from one of the document sources. Returns separate results for each provided page." required: @@ -15,39 +14,72 @@ components: $ref: "#/components/schemas/GraphicFieldsList" - $ref: "./rt.yml#/components/schemas/ResultItem" - GraphicFieldsList: + title: "GraphicFieldsList" type: object required: - pArrayFields + - nFields properties: pArrayFields: type: array items: - $ref: "#/components/schemas/GraphicField" + anyOf: + - $ref: "#/components/schemas/GraphicFieldRect" + - $ref: "#/components/schemas/GraphicFieldRfid" + nFields: + description: "Number of pArrayFields array elements" + type: number + + GraphicFieldRect: + title: "GraphicFieldRect" + description: "Information about one graphic field, which is a rectangle" + required: + - FieldRect + allOf: + - type: object + properties: + FieldRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + - $ref: "#/components/schemas/GraphicField" + + GraphicFieldRfid: + title: "GraphicFieldRfid" + description: "Information about one graphic field, which is a RFID" + required: + - RFID_OriginDG + - RFID_OriginDGTag + - RFID_OriginTagEntry + - RFID_OriginEntryView + allOf: + - type: object + properties: + RFID_OriginDG: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + RFID_OriginDGTag: + description: "Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result." + type: integer + RFID_OriginTagEntry: + type: integer + description: "Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result." + RFID_OriginEntryView: + type: integer + description: "Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result." + - $ref: "#/components/schemas/GraphicField" GraphicField: + title: "GraphicField" + description: "Information about one graphic field - abstract class" type: object required: - FieldType + - FieldName - image properties: FieldType: $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + FieldName: + description: "Graphic field symbolic name" + type: string image: $ref: "./common.yml#/components/schemas/ImageData" - FieldRect: - description: "Coordinates of the graphic field in the normalized image of the document" - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - RFID_OriginDG: - description: "Source data group file. Only for Result.RFID_GRAPHICS result." - type: integer - RFID_OriginDGTag: - description: "Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result." - type: integer - RFID_OriginTagEntry: - type: integer - description: "Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result." - RFID_OriginEntryView: - type: integer - description: "Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result." diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 4a4e2f2..440a808 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - ImageQualityResult: - title: "Image Quality Checks" + title: "ImageQualityResult" allOf: - type: object required: @@ -13,12 +12,13 @@ components: $ref: "#/components/schemas/ImageQualityCheckList" - $ref: "./rt.yml#/components/schemas/ResultItem" - ImageQualityCheckList: + title: "ImageQualityCheckList" type: object required: - result - List + - Count properties: result: description: "Overall image quality status, combined from check statuses in the list." @@ -27,8 +27,12 @@ components: type: array items: $ref: "#/components/schemas/ImageQualityCheck" + Count: + description: "Number of List array elements" + type: number ImageQualityCheckType: + title: "ImageQualityCheckType" type: integer description: "Image quality check type" enum: @@ -60,8 +64,16 @@ components: - "Signals if the document image is bright enough" AreaArray: + title: "AreaArray" type: object + required: + - Count + - List + - Points properties: + Count: + description: "Number of elements in List and Points" + type: number List: type: array items: @@ -72,7 +84,10 @@ components: $ref: "#/components/schemas/PointArray" PointArray: + title: "PointArray" type: object + required: + - PointsList properties: PointsList: type: array @@ -80,7 +95,15 @@ components: $ref: "./common.yml#/components/schemas/Point" ImageQualityCheck: + title: "ImageQualityCheck" type: object + required: + - type + - result + - featureType + - mean + - std_dev + - probability properties: type: $ref: "#/components/schemas/ImageQualityCheckType" @@ -91,10 +114,13 @@ components: areas: $ref: "#/components/schemas/AreaArray" mean: + description: "Check mean value" type: number format: float std_dev: + description: "Check deviation value" type: number format: float probability: + description: "Check probability value" type: integer diff --git a/rt-images.yml b/rt-images.yml index ec74b62..7d6f398 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - ImagesResult: - title: "Images" + title: "ImagesResult" allOf: - type: object required: @@ -13,13 +12,21 @@ components: $ref: "#/components/schemas/Images" - $ref: "./rt.yml#/components/schemas/ResultItem" - Images: + title: "Images" type: object required: + - fieldCount + - availableSourceCount - availableSourceList - fieldList properties: + fieldCount: + type: integer + description: "Fields count" + availableSourceCount: + type: integer + description: "Available sources count" availableSourceList: type: array items: @@ -30,10 +37,11 @@ components: $ref: "#/components/schemas/ImagesField" ImagesAvailableSource: + title: "ImagesAvailableSource" type: object required: + - containerType - source - - sourceName properties: containerType: $ref: "./rt.yml#/components/schemas/ContainerType" @@ -41,11 +49,13 @@ components: $ref: "./common.yml#/components/schemas/Source" ImagesField: + title: "ImagesField" type: object required: - fieldName - fieldType - valueList + - valueCount properties: fieldName: $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldName" @@ -55,15 +65,18 @@ components: type: array items: $ref: "#/components/schemas/ImagesFieldValue" + valueCount: + description: "Field value count" + type: number ImagesFieldValue: + title: "ImagesFieldValue" type: object required: - containerType - lightIndex - pageIndex - source - - value properties: source: $ref: "./common.yml#/components/schemas/Source" @@ -86,4 +99,4 @@ components: $ref: "./common.yml#/components/schemas/RectangleCoordinates" rfidOrigin: description: "Only for images from RFID. Image location in RFID chip." - $ref: "./common.yml#/components/schemas/RfidOrigin" \ No newline at end of file + $ref: "./common.yml#/components/schemas/RfidOrigin" diff --git a/rt-license.yml b/rt-license.yml index fdfe20a..b89d64f 100644 --- a/rt-license.yml +++ b/rt-license.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - LicenseResult: - title: "License" + title: "LicenseResult" allOf: - type: object description: "Contains license" diff --git a/rt-ocr-lexical-analisis.yml b/rt-ocr-lexical-analysis.yml similarity index 88% rename from rt-ocr-lexical-analisis.yml rename to rt-ocr-lexical-analysis.yml index f5c0f35..1e01fac 100644 --- a/rt-ocr-lexical-analisis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - LexicalAnalysisResult: - title: "Lexical Analysis" + title: "LexicalAnalysisResult" description: | Lexical data analysis allows you to compare the results of reading the text data of the MRZ, the document filling area, barcodes and data from the memory of the RFID chip for an additional @@ -11,22 +10,35 @@ components: Consider using Result.TEXT type for more simplicity. allOf: - type: object + required: + - ListVerifiedFields properties: ListVerifiedFields: $ref: "#/components/schemas/ListVerifiedFields" - $ref: "./rt.yml#/components/schemas/ResultItem" - ListVerifiedFields: + title: "ListVerifiedFields" type: object + required: + - Count + - pFieldMaps properties: + Count: + description: "Number of pFieldMaps array elements" + type: number pFieldMaps: type: array items: $ref: "#/components/schemas/VerifiedFieldMap" VerifiedFieldMap: + title: "VerifiedFieldMap" type: object + required: + - wFieldType + - wLCID + - Matrix properties: wFieldType: $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" @@ -51,6 +63,7 @@ components: {FieldType: 185, Field_MRZ: "37", Field_Visual: "37", Matrix: [1,0,0,0,0,3,0,0,0,0]} ComparisonMatrix: + title: "ComparisonMatrix" type: array minItems: 10 maxItems: 10 @@ -74,6 +87,7 @@ components: example: [1,0,0,0,0,3,0,0,0,0] VerificationResult: + title: "VerificationResult" type: integer enum: - 0 diff --git a/rt-raw-image.yml b/rt-raw-image.yml index 9812450..4f1eedc 100644 --- a/rt-raw-image.yml +++ b/rt-raw-image.yml @@ -1,17 +1,28 @@ openapi: 3.0.3 components: schemas: - DocumentImageResult: - title: "Document Image" + title: "DocumentImageResult" + description: "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" allOf: - type: object - description: "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" required: - RawImageContainer properties: RawImageContainer: - $ref: "./common.yml#/components/schemas/ImageData" + $ref: "#/components/schemas/RawImageContainerFieldList" - $ref: "./rt.yml#/components/schemas/ResultItem" + + RawImageContainerFieldList: + title: "RawImageContainerFieldList" + allOf: + - type: object + required: + - format + properties: + format: + description: "Image format" + type: string + - $ref: "./common.yml#/components/schemas/ImageData" diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml new file mode 100644 index 0000000..bc8cbc3 --- /dev/null +++ b/rt-rfid-binary-data.yml @@ -0,0 +1,956 @@ +openapi: 3.0.3 +components: + schemas: + DocumentBinaryInfoResult: + title: "DocumentBinaryInfoResult" + allOf: + - type: object + description: "Structure is used to store the data reading results from the RFID-chip in + a form of a list of the logically separated data groups." + required: + - TDocBinaryInfo + properties: + TDocBinaryInfo: + $ref: "#/components/schemas/TDocBinaryInfo" + - $ref: "./rt.yml#/components/schemas/ResultItem" + + TDocBinaryInfo: + title: "TDocBinaryInfo" + type: object + required: + - RFID_BINARY_DATA + properties: + RFID_BINARY_DATA: + $ref: "#/components/schemas/BinaryData" + + BinaryData: + title: "BinaryData" + description: "Structure is used for storing the results of one bar-code module reading." + type: object + required: + - RFID_DG1 + - RFID_Session_Data + - RFID_ePassp_Directory + properties: + RFID_DG1: + $ref: "#/components/schemas/RfidDG1" + RFID_Session_Data: + $ref: "#/components/schemas/RfidSessionData" + RFID_ePassp_Directory: + description: Indexes of groups that aren't read + type: array + items: + type: integer + + RfidDG1: + title: "RfidDG1" + description: "Structure used to store the contents of EF.DG1 informational data group of + ePassport application – document MRZ data" + type: object + required: + - Type + - DocumentID + - DocumentType + - State + - Holder + - DocumentNumber + - CheckDigitDocumentNumber + - Nationality + - Birthday + - CheckDigitBirthday + - Sex + - ExpiryDate + - CheckDigitExpiryDate + - OptionalData + - CheckDigitOptionalData + - CheckDigitComposite + properties: + Type: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + DocumentID: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" + DocumentType: + description: "Symbolic code of document type" + type: string + State: + description: "Symbolic code of document issuing state" + type: string + Holder: + description: "DO’s name and surname" + type: string + DocumentNumber: + description: "Document number" + type: string + CheckDigitDocumentNumber: + description: "Check digit of document number" + type: number + Nationality: + description: "Symbolic code of DO’s nationality" + type: string + Birthday: + description: "DO’s date of birth" + type: string + CheckDigitBirthday: + description: "Check digit of DO’s date of birth" + type: number + Sex: + description: "DO’s sex" + type: string + ExpiryDate: + description: "Term of validity of the document" + type: string + CheckDigitExpiryDate: + description: "Check digit of term of validity of the document" + type: number + OptionalData: + description: "DO’s personal number or other additional data" + type: string + CheckDigitOptionalData: + description: "Check digit of additional data" + type: number + CheckDigitComposite: + description: "General check digit" + type: number + + RfidSessionData: + title: "RfidSessionData" + description: "Structure is used to describe the results of work with the SDK within the context of the current communication + session with electronic document" + type: object + required: + - VirtualMode + - SDKVersion + - DriverVersion + - FirmwareVersion + - Applications + - AccessControls + - CardProperties + - ExtLeSupport + - ProcessTime + - RootFiles + - TotalBytesSent + - TotalBytesReceived + - Session_key + - Session_terminal + - Session_procedure + - SecurityObjects + properties: + VirtualMode: + description: "Sign of virtual session when working with loaded data from a previous communication session + with the electronic document" + SDKVersion: + description: "Text SDKVersion value in format A.B (e.g. 3.1)" + DriverVersion: + description: "Text DriverVersion value in format A.B.C.D (e.g. 6.2.5.4)" + FirmwareVersion: + description: "Text FirmwareVersion value in format A.B (e.g. 5.19)" + Applications: + description: "List of containers to store information about the involved applications of electronic document" + type: array + items: + $ref: "#/components/schemas/RfidApplication" + AccessControls: + description: "List of containers to store information about the supported procedures of authentication and secure data access + within the context of the session" + type: array + items: + $ref: "#/components/schemas/RfidAccessControlInfo" + CardProperties: + $ref: "#/components/schemas/RfidCardPropertiesExt" + ExtLeSupport: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ProcessTime: + description: "Time of processing, milliseconds" + type: number + RootFiles: + description: "List of containers to store information about the read files of the root Master File" + type: array + items: {} + TotalBytesSent: + description: "Total number of bytes transmitted to the RFID-chip during the whole session" + type: number + TotalBytesReceived: + description: "Total number of bytes received from the RFID-chip during the whole session" + type: number + Session_key: + $ref: "#/components/schemas/RfidAccessKey" + Session_terminal: + $ref: "#/components/schemas/RfidTerminal" + Session_procedure: + $ref: "#/components/schemas/RfidAuthenticationProcedureType" + SecurityObjects: + description: "List of containers to store information about the detected document security objects" + type: array + items: + $ref: "#/components/schemas/RfidSecurityObject" + + RfidSecurityObject: + title: "RfidSecurityObject" + description: "Structure is used to describe the contents of a single document security object (SO) and the results of its check + within the context of the communication session with electronic document" + type: object + required: + - Version + - ObjectType + - FileReference + - Notifications + - SignerInfos + properties: + Version: + description: "Security object version" + type: number + ObjectType: + description: "Identifier of the security object" + type: string + FileReference: + description: "Reference to the source file of the security object data" + type: number + Notifications: + description: "List of remarks arisen during the analysis of SO data structure." + type: array + items: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + SignerInfos: + description: "List of containers to store information about digital signature objects contained in the SO" + type: array + items: + $ref: "#/components/schemas/RfidSignerInfoEx" + + RfidSignerInfoEx: + title: "RfidSignerInfoEx" + description: "Structure is used to describe the contents of a single copy of + digital signature of the document security object and the results of its check within the + context of the communication session with electronic document" + type: object + required: + - Version + - Issuer + - SerialNumber + - SubjectKeyIdentifier + - DigestAlgorithm + - SignedAttributes + - SignatureAlgorithm + - Signature + - PA_Status + - CertificateChain + - DataToHash + - Notifications + properties: + Version: + description: "Version of SignerInfo ASN.1 structure" + type: number + Issuer: + $ref: "#/components/schemas/RfidDistinguishedName" + SerialNumber: + $ref: "#/components/schemas/TrfFtBytes" + SubjectKeyIdentifier: + $ref: "#/components/schemas/TrfFtBytes" + DigestAlgorithm: + description: "Hash algorithm identifier (OID) for digital signature generation" + type: string + SignedAttributes: + description: "List of the signed attributes" + type: array + items: + $ref: "#/components/schemas/RfidAttributeData" + SignatureAlgorithm: + description: "Digital signature algorithm identifier (OID)" + type: string + Signature: + $ref: "#/components/schemas/TrfFtBytes" + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + CertificateChain: + description: "Certificate chain, used for the digital signature verification." + type: array + items: + $ref: "#/components/schemas/RfidCertificateEx" + DataToHash: + description: "Binary data array used to calculate the hash value for digital signature verification. Base64 encoded." + type: string + Notifications: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + + RfidCertificateEx: + title: "RfidCertificateEx" + description: "Structure is used to describe the certificate contents used for the digital signature verification + of the document security object within the context of the communication session with electronic document." + type: object + required: + - Version + - SerialNumber + - SignatureAlgorithm + - Issuer + - Validity + - Subject + - SubjectPKAlgorithm + - Extensions + - Notifications + - Origin + - Type + - FileName + - PA_Status + properties: + Version: + description: "Version of Certificate ASN.1 structure" + type: number + SerialNumber: + description: "Certificate serial number. Base64 encoded." + type: string + SignatureAlgorithm: + description: "Certificate digital signature algorithm identifier (OID); + String in the format S1 (S2), where S1 – algorithm name, S2 – identifier (OID string)." + type: string + Issuer: + $ref: "#/components/schemas/RfidDistinguishedName" + Validity: + $ref: "#/components/schemas/RfidValidity" + Subject: + $ref: "#/components/schemas/RfidDistinguishedName" + SubjectPKAlgorithm: + description: "Certificate public key algorithm identifier (OID); + String in the format S1 (S2), where S1 – algorithm name, S2 – identifier (OID string)." + type: string + Extensions: + description: "List of the certificate extensions" + type: array + items: + $ref: "#/components/schemas/RfidPkiExtension" + Notifications: + description: "List of remarks arisen during the analysis of the certificate data + structure and its validity verification." + type: array + items: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + Origin: + $ref: "#/components/schemas/RfidCertificateOrigin" + Type: + $ref: "#/components/schemas/RfidCertificateType" + FileName: + $ref: "#/components/schemas/TrfFtString" + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + + RfidPkiExtension: + title: "RfidPkiExtension" + description: "Extension identifier (OID, ASCII string); + Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: object + required: + - Type + - Data + properties: + Type: + description: "Extension identifier (OID, ASCII string); + Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: string + Data: + description: "Extension binary data. Base64 encoded." + type: string + + RfidValidity: + title: "RfidValidity" + description: "Structure contains information on a certificate validity." + type: object + required: + - NotBefore + - NotAfter + properties: + NotBefore: + $ref: "#/components/schemas/TrfFtString" + NotAfter: + $ref: "#/components/schemas/TrfFtString" + + RfidAttributeData: + title: "RfidAttributeData" + description: "Structure contains the data of one attribute of the digital signature object." + type: object + required: + - Type + - Data + properties: + Type: + description: "Contents of the identifier in the format S1 (S2), where S1 – attribute name, S2 – identifier (OID string)" + type: string + Data: + description: "Attribute binary data. Base64 encoded." + type: string + + RfidDistinguishedName: + title: "RfidDistinguishedName" + description: "Contents of the identifier in binary form. Base64 encoded." + type: object + required: + - Data + - FriendlyName + - Attributes + properties: + Data: + description: "Contents of the identifier in binary form. Base64 encoded." + type: string + FriendlyName: + $ref: "#/components/schemas/TrfFtString" + Attributes: + description: "List of individual attributes contained in the identifier" + type: array + items: + $ref: "#/components/schemas/RfidAttributeName" + + RfidAttributeName: + title: "RfidAttributeName" + description: "Structure contains information that serves as the distinguished name (identifier) of an object." + type: object + required: + - Type + - Value + properties: + Type: + description: "Attribute identifier (OID ASCII string); contents of the identifier in the format S1 (S2), + where S1 – attribute name, S2 – identifier (OID string)" + type: string + Value: + $ref: "#/components/schemas/TrfFtString" + + TrfFtString: + title: "TrfFtString" + description: "Structure is used to store information about the numeric field (4 bytes) that is a part of one of the informational + data groups." + type: object + required: + - Type + - Status + - Format + - Data + properties: + Type: + anyOf: + - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + Status: + description: "Result of logical analysis of compliance of the contents of the field + with the requirements of the specification" + anyOf: + - $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" + - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + Format: + description: "Mask of format of text information (for example, «YYMMDD» for date of birth)" + type: string + Data: + description: "Numeric value." + type: string + + RfidApplication: + title: "RfidApplication" + description: "Structure is used to describe the contents of a single LDS application and their analysis within the context + of the communication session with electronic document" + type: object + required: + - Type + - Status + - ApplicationID + - Version + - UnicodeVersion + - DataHashAlgorithm + - Files + properties: + Type: + $ref: "#/components/schemas/RfidApplicationType" + Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ApplicationID: + description: "Application identifier" + type: string + Version: + description: "Version of the application" + type: string + UnicodeVersion: + description: "Unicode version for application" + type: string + DataHashAlgorithm: + description: "Algorithm for calculating hash values for files for the procedure of PA" + type: string + Files: + description: "List of containers to store information about the read files of the application" + type: array + items: + $ref: "#/components/schemas/RfidDataFile" + + RfidApplicationType: + title: "RfidApplicationType" + type: integer + description: "Enumeration contains a set of constants that define the type + of application within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 0 + x-enum-descriptions: + - "Not defined" + - "ePassport application" + - "eID application" + - "eSign application" + - "eDL application" + - "Master File" + x-enum-varnames: + - "UNSPECIFIED" + - "E_PASSPORT" + - "E_ID" + - "E_SIGN" + - "E_DL" + - "ROOT_FILES" + + RfidDataFile: + title: "RfidDataFile" + description: "Structure is used to describe the contents of a single file of the LDS of electronic document and the analysis + of its contents within the context of the communication session with electronic document" + type: object + required: + - Type + - ReadingStatus + - ReadingTime + - PA_Status + - Notifications + - DocFields_Text + - DocFields_Graphics + - DocFields_Originals + properties: + FileID: + description: "File identifier. Each byte of FileID represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. 01 1E)" + type: string + Type: + $ref: "./e-rfid-data-file-type.yml#/components/schemas/RfidDataFileType" + FileData: + $ref: "#/components/schemas/TrfFtBytes" + ReadingStatus: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ReadingTime: + description: "Time of reading, milliseconds" + type: number + PA_Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + Notifications: + description: "List of remarks arisen when reading data from the memory of the chip and analysing their ASN.1-structure." + type: array + items: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + DocFields_Text: + description: "List of document text fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + DocFields_Graphics: + description: "List of document graphic fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + DocFields_Originals: + description: "List of the original binary representation of graphic document fields formed on the basis of the file contents" + type: array + items: + $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + + TrfFtBytes: + title: "TrfFtBytes" + description: "Structure is used to store an array of binary information that is a part of one of the informational data groups" + type: object + required: + - Type + - Status + - Length + - Data + properties: + Type: + description: "Logical type of the field" + anyOf: + - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + Status: + description: "Result of logical analysis of compliance of the contents of the field + with the requirements of the specification" + type: number + Length: + description: "Length of Data array" + type: number + Data: + description: "Binary data array. Base64 encoded." + type: string + + RfidAccessControlInfo: + title: "RfidAccessControlInfo" + description: "Structure is used to describe the results of a single authentication procedure or a procedure of secure data access + within the context of the communication session with electronic document" + type: object + required: + - Type + - Status + - Notifications + properties: + Type: + $ref: "#/components/schemas/RfidAccessControlProcedureType" + Status: + $ref: "./e-rfid-error-codes.yml#/components/schemas/RFIDErrorCodes" + ActiveOptionIdx: + description: "Index of the active variant of the procedure" + type: number + Notifications: + description: "List of remarks arisen during the procedure." + type: array + items: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + AccessControlOptions: + description: "List of structures with are used to describe the variants of the authentication or secure data access procedure + performance within the context of the communication session with electronic document" + type: array + items: {} + + RfidAccessControlProcedureType: + title: "RfidAccessControlProcedureType" + type: integer + description: "Enumeration contains a set of constants that + define the type of authentication or secure data access procedure" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 10 + x-enum-descriptions: + - "Type is not defined" + - "BAC/BAP" + - "PACE" + - "CA" + - "TA" + - "AA" + - "RI" + - "Card info" + x-enum-varnames: + - "UNDEFINED" + - "BAC" + - "PACE" + - "CA" + - "TA" + - "AA" + - "RI" + - "CARD_INFO" + + RfidCardPropertiesExt: + title: "RfidCardPropertiesExt" + description: "Structure is used to store extended information about the + characteristics of the RFID-chip located in the scope of the reader" + type: object + required: + - RFID_Type + - Baudrate1 + - Baudrate2 + - Support_4 + - ChipType_A + - Support_Mifare + - MifareMemory + - UID + - ATQ_A + - SAK + - ATQ_B + - BitRateS + - BitRateR + - ATR + properties: + RFID_Type: + $ref: "#/components/schemas/RfidType" + Baudrate1: + description: "Numeric Baudrate1 value in hexadecimal format (e.g. 0x0000000F)" + type: string + Baudrate2: + description: "Numeric Baudrate2 value in hexadecimal format" + type: string + Support_4: + description: "Boolean Support_4 value" + type: boolean + ChipType_A: + $ref: "#/components/schemas/RfidAChip" + Support_Mifare: + description: "Sign of support for ISO/IEC 14443-3 data exchange protocol" + type: boolean + MifareMemory: + description: "Amount of operational memory MIFARE® of the chip, kilobytes" + type: number + UID: + description: "UID contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are separated + by spaces (e.g. F9 4F 41 60)" + type: string + ATQ_A: + description: "Reply of the «A» type chip to «REQA» command of ISO/IEC 14443-3 + protocol (Answer To Request, Type A – ATQA) – for the internal use by + the main control library" + SAK: + description: "Response of type-A RFID-chip to SELECT command of ISO/IEC 14443-3 protocol (Select Acknowledge, SAK)." + ATQ_B: + description: "ATQ_B contents in text format. Each byte is represented by its hexadecimal value. The individual bytes are + separated by spaces (e.g. 50 F9 4F 41 60 00 00 00 00 77 81 81)" + BitRateS: + $ref: "#/components/schemas/RfidBaudRate" + BitRateR: + $ref: "#/components/schemas/RfidBaudRate" + ATR: + description: "ATR-string of RFID-chip" + type: string + + RfidType: + title: "RfidType" + type: integer + description: "Enumeration contains a set of constants specifying the type of the RFID-chip + by the physical parameters of connection between antennas of the chip and the reader" + enum: + - 0 + - 1 + - 2 + x-enum-descriptions: + - "Unknown" + - "Type A" + - "Type B" + x-enum-varnames: + - "UNKNOWN" + - "A" + - "B" + + RfidAChip: + title: "RfidAChip" + type: integer + description: "Enumeration contains a set of constants specifying the type of the RFIDchip from MIFARE® family + (for chips of type A)" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + x-enum-descriptions: + - "Unknown" + - "MIFARE® 1K" + - "MIFARE® 4K" + - "MIFARE® Ultralight" + - "MIFARE® DESFire" + - "MIFARE® ProX or SmartMX xD(T)" + x-enum-varnames: + - "UNKNOWN" + - "MIFARE_1K" + - "MIFARE_4K" + - "MIFARE_ULTRALIGHT" + - "MIFARE_DES_FIRE" + - "MIFARE_PROX" + + RfidBaudRate: + title: "RfidBaudRate" + type: integer + description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" + enum: + - 0X00 + - 0X01 + - 0X02 + - 0X04 + - 0X08 + x-enum-descriptions: + - "Unknown" + - "106 bits/s" + - "212 bits/s" + - "424 bits/s" + - "848 bits/s" + x-enum-varnames: + - "UNKNOWN" + - "RFBR_106" + - "RFBR_212" + - "RFBR_424" + - "RFBR_848" + + RfidAccessKey: + title: "RfidAccessKey" + description: "Structure is used to describe the contents of secure data access key within + the context of the communication session with electronic document" + type: object + required: + - AccessKey + - KeyType + - AccessType + - CheckFullKeyMatching + properties: + AccessKey: + description: "Key contents" + type: string + KeyType: + $ref: "#/components/schemas/RfidPasswordType" + AccessType: + $ref: "#/components/schemas/RfidAccessControlProcedureType" + CheckFullKeyMatching: + description: "Logical sign of the need for a full comparison of AccessKey + contents with the contents of DG1 (MRZ) data group" + type: boolean + + RfidPasswordType: + title: "RfidPasswordType" + type: integer + description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + x-enum-descriptions: + - "Unknown type" + - "MRZ" + - "CAN" + - "PIN" + - "PUK" + - "eSign-PIN" + - "Scanning Area Identifier (for eDL application)" + x-enum-varnames: + - "UNKNOWN" + - "MRZ" + - "CAN" + - "PIN" + - "PUK" + - "PIN_E_SIGN" + - "SAI" + + RfidTerminal: + title: "RfidTerminal" + description: "Structure is used to describe the terminal type within the context of the + communication session with electronic document" + type: object + required: + - TermType + - AuthReq + - AuthReq2 + properties: + TermType: + $ref: "#/components/schemas/RfidTerminalType" + AuthReq: + description: "Declared (set) combination of flags of access rights to the functionality of the document (combination of + eRfidTerminalAuthorizationRequirement values)" + type: number + AuthReq2: + description: "Declared (set) combination of flags of access rights to the functionality of the document (combination of + RfidTerminalAuthorizationRequirement values)" + type: number + + RfidTerminalType: + title: "RfidTerminalType" + type: integer + description: "Enumeration contains a set of constants that define the type + of terminal within the context of the communication session with electronic document" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + x-enum-descriptions: + - "Not defined" + - "Inspection system" + - "Authentication terminal" + - "Signature terminal" + - "Unauthenticated terminal" + x-enum-varnames: + - "UNDEFINED" + - "INSPECTION_SYSTEM" + - "AUTHENTICATION_TERMINAL" + - "SIGNATURE_TERMINAL" + - "UNAUTHENTICATED_TERMINAL" + + RfidAuthenticationProcedureType: + title: "RfidAuthenticationProcedureType" + type: integer + description: "Enumeration contains a set of constants that define the type of performed procedure of document authentication + within the current session" + enum: + - 0 + - 1 + - 2 + - 3 + x-enum-descriptions: + - "Not defined" + - "Standard authentication procedure" + - "Advanced authentication procedure" + - "General authentication procedure" + x-enum-varnames: + - "UNDEFINED" + - "STANDARD" + - "ADVANCED" + - "GENERAL" + + RfidCertificateOrigin: + title: "RfidCertificateOrigin" + type: integer + description: "Enumeration contains a set of constants that define the source of certificate used in the procedure + of document security object digital signature verification" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + x-enum-descriptions: + - "The source is not defined" + - "Local PKD" + - "Document security object" + - "User-defined" + - "Contents of the Master List" + - "Security object of the Master List" + - "Security object of the Defect List" + - "Security object of the Deviation List" + - "Security object of the Black List" + x-enum-varnames: + - "UNDEFINED" + - "PKD" + - "SECURITY_OBJECT" + - "USER_DEFINED" + - "MASTER_LIST_PKD" + - "MASTER_LIST_SO" + - "DEFECT_LIST_SO" + - "DEVIATION_LIST_SO" + - "BLACK_LIST_SO" + + RfidCertificateType: + title: "RfidCertificateType" + type: integer + description: "Enumeration contains a set of constants that define the type + of certificate used in the procedure of document security object digital signature verification" + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + x-enum-descriptions: + - "Type is not defined" + - "CSCA" + - "CSCA-link" + - "DS" + - "Master List signer" + - "Deviaton List signer" + - "Defect List signer" + - "Black List signer" + x-enum-varnames: + - "UNDEFINED" + - "CSCA" + - "CSCA_LINK" + - "DS" + - "MLS" + - "DEV_LS" + - "DEF_LS" + - "BLS" diff --git a/rt-status.yml b/rt-status.yml index f394618..59d2a5e 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - StatusResult: - title: "Status" + title: "StatusResult" allOf: - type: object required: @@ -19,14 +18,18 @@ components: # see https://github.com/OAI/OpenAPI-Specification/issues/556#issuecomment-192007034 # but java codegen produce invalid code for allOf `int complete=null` Status: + title: "Status" type: object required: - overallStatus - optical + - portrait + - rfid + - stopList - detailsOptical properties: overallStatus: - description: "Overall checks status. Root status." + description: "Overall checks status. Rootx status." $ref: "./common.yml#/components/schemas/CheckResult" optical: description: "Overall optical checks combined status" @@ -48,6 +51,7 @@ components: $ref: "#/components/schemas/detailsOptical" detailsOptical: + title: "detailsOptical" type: object required: - overallStatus @@ -85,6 +89,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" detailsRFID: + title: "detailsRFID" type: object required: - overallStatus diff --git a/rt-text-data.yml b/rt-text-data.yml index f7f1d67..10944c3 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -1,94 +1,160 @@ openapi: 3.0.3 components: schemas: - TextDataResult: - title: "Text Data (legacy)" + title: "TextDataResult" description: "Text fields extracted from one document source. Contains results of specific source for each provided page." allOf: - type: object + required: + - DocVisualExtendedInfo properties: DocVisualExtendedInfo: $ref: "#/components/schemas/DocVisualExtendedInfo" - $ref: "./rt.yml#/components/schemas/ResultItem" DocVisualExtendedInfo: + title: "DocVisualExtendedInfo" type: object description: "Container for extracted text fields. Fields are identified by type and language" required: + - nFields - pArrayFields properties: + nFields: + description: "Number of pArrayFields array elements" + type: number pArrayFields: type: array items: - $ref: "#/components/schemas/DocVisualExtendedField" + anyOf: + - $ref: "#/components/schemas/DocVisualExtendedFieldRect" + - $ref: "#/components/schemas/DocVisualExtendedFieldRfid" + + DocVisualExtendedFieldRfid: + title: "DocVisualExtendedFieldRfid" + description: "Structure and serves for storing information from one text data field. + Variant with field logical type and RFID data." + allOf: + - type: object + required: + - RFID_OriginDG + - RFID_OriginTagEntry + properties: + RFID_OriginDG: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + RFID_OriginDGTag: {} + RFID_OriginTagEntry: + description: "Record index of the text field source in the data group" + type: number + RFID_OriginEntryView: {} + - $ref: "#/components/schemas/DocVisualExtendedField" + + DocVisualExtendedFieldRect: + title: "DocVisualExtendedFieldRect" + description: "Structure and serves for storing information from one text data field. + Variant with field logical type and field rectangular area coordinates on the image." + allOf: + - type: object + properties: + FieldRect: + description: "Coordinates of the text field in the normalized image of the document. + Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + - $ref: "#/components/schemas/DocVisualExtendedField" + DocVisualExtendedField: + title: "DocVisualExtendedField" type: object required: + - FieldType - wFieldType - FieldName - - wLCID + - StringsCount + - StringsResult + - Buf_Length + - Buf_Text properties: + FieldType: {} wFieldType: $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" FieldName: - description: "Field name. Only use to search values for fields with fieldType=50(other). In general, use wFieldType for lookup." + description: "Field symbolic name (null-terminated string)" type: string - wLCID: - $ref: "./e-lcid.yml#/components/schemas/LCID" + StringsCount: + description: "Number of StringsResult array elements" + type: number StringsResult: type: array description: "Array of recognizing probabilities for a each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." items: $ref: "#/components/schemas/StringRecognitionResult" + Buf_Length: + description: "Buf_Text text string length" + type: number Buf_Text: type: string description: "Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'" - FieldRect: - description: "Coordinates of the text field in the normalized image of the document. - Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - RFID_OriginDG: - description: "Origin data group information. Only for Result.RFID_TEXT results." - type: integer - RFID_OriginTagEntry: - type: integer - description: "Index of the text field record in origin data group. Only for Result.RFID_TEXT results." + FieldMask: {} + Validity: {} + InComparison: {} + Reserved2: {} + Reserved3: {} StringRecognitionResult: + title: "StringRecognitionResult" type: object description: "Describes single row recognition results in multi-line text field of a document" required: + - SymbolsCount - StringResult properties: + SymbolsCount: + description: "Number of StringResult array elements" + type: number + Reserved: {} StringResult: type: array description: "Array of recognition results for individual characters of a string" items: $ref: "#/components/schemas/SymbolRecognitionResult" + Buf_Length: + description: "Buf_Text text string length" + type: number + Buf_Text: + type: string + description: "Text field data in UTF8 format. + Results of reading different lines of a multi-line field are separated by '^'" SymbolRecognitionResult: + title: "SymbolRecognitionResult" type: object description: "Describes a single character recognition results in the text field line" required: - SymbolRect + - CandidatesCount - ListOfCandidates properties: SymbolRect: description: "Coordinates of the symbol in the normalized image of the document" $ref: "./common.yml#/components/schemas/RectangleCoordinates" + CandidatesCount: + description: "Number of significant elements of ListOfCandidates array" + type: number ListOfCandidates: type: array description: "Array of candidate characters. Sorted in descending order of recognition probabilities (the first element has highest probability)" items: $ref: "#/components/schemas/SymbolCandidate" + Reserved: {} SymbolCandidate: + title: "SymbolCandidate" required: - SymbolCode - SymbolProbability @@ -103,3 +169,4 @@ components: description: "character recognition probability (0–100,%)" minimum: 0 maximum: 100 + Reserved: {} diff --git a/rt-text.yml b/rt-text.yml index fdbaf63..81bdc08 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -1,9 +1,8 @@ openapi: 3.0.3 components: schemas: - TextResult: - title: "Text" + title: "TextResult" allOf: - type: object required: @@ -14,12 +13,14 @@ components: - $ref: "./rt.yml#/components/schemas/ResultItem" Text: + title: "Text" type: object description: "Contains all document text fields data with validity and cross-source compare checks" required: - status - validityStatus - comparisonStatus + - dateFormat - fieldList - availableSourceList properties: @@ -32,6 +33,9 @@ components: comparisonStatus: description: "Overall status of data comparison from different sources for each text field" $ref: "./common.yml#/components/schemas/CheckResult" + dateFormat: + description: "Date format" + type: string fieldList: type: array items: @@ -42,10 +46,13 @@ components: $ref: "#/components/schemas/TextAvailableSource" TextField: + title: "TextField" type: object required: - fieldType - fieldName + - lcid + - lcidName - status - validityStatus - comparisonStatus @@ -61,6 +68,9 @@ components: type: string lcid: $ref: "./e-lcid.yml#/components/schemas/LCID" + lcidName: + description: "LCID name" + type: string status: description: "Overall status of all checks from all values" $ref: "./common.yml#/components/schemas/CheckResult" @@ -90,13 +100,16 @@ components: items: $ref: "#/components/schemas/CrossSourceValueComparison" - # todo originalValidity очн путает, может в validityList сделать validityList = originalValidity && validityList + # todo originalValidity очень путает, может в validityList сделать validityList = originalValidity && validityList TextFieldValue: + title: "TextFieldValue" type: object required: - value - pageIndex - source + - originalValidity + - probability properties: source: $ref: "./common.yml#/components/schemas/Source" @@ -106,6 +119,8 @@ components: originalValue: description: "Original value as seen in the document" type: string + originalValidity: + $ref: "./common.yml#/components/schemas/CheckResult" originalSymbols: type: array items: @@ -125,7 +140,11 @@ components: $ref: "./common.yml#/components/schemas/RfidOrigin" OriginalSymbol: + title: "OriginalSymbol" type: object + required: + - code + - probability properties: code: description: "Unicode symbol code" @@ -140,6 +159,7 @@ components: $ref: "./common.yml#/components/schemas/RectangleCoordinates" SourceValidity: + title: "SourceValidity" type: object required: - source @@ -151,6 +171,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" CrossSourceValueComparison: + title: "CrossSourceValueComparison" type: object required: - sourceLeft @@ -165,6 +186,7 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" TextAvailableSource: + title: "TextAvailableSource" type: object required: - source diff --git a/rt.yml b/rt.yml index e381956..78d9a69 100644 --- a/rt.yml +++ b/rt.yml @@ -1,13 +1,14 @@ openapi: 3.0.3 components: schemas: - ContainerType: + title: "ContainerType" type: integer description: "Same as Result type, but used for safe parsing of not-described values. See Result type." default: 0 Result: + title: "Result" type: integer enum: - 1 @@ -22,14 +23,20 @@ components: - 18 - 19 - 20 + - 26 - 30 + - 32 - 33 - 34 + - 35 - 36 - 37 + - 38 - 39 - 49 - 50 + - 61 + - 62 - 85 - 101 - 102 @@ -49,14 +56,20 @@ components: - "Contains barcode parsing result with text fields" - "Contains barcode parsing result with graphic fields" - "Contains result of document authenticity checks" + - "Contains result of DocVisualExtendedInfoContainer" - "Contains image quality check results" + - "Contains result of DocGraphicsInfoContainer" - "Contains check statuses with details, grouped by source" - "Contains result of portraits comparison" + - "Contains result of DocGraphicsInfoContainer" - "Contains document textual fields from all sources (mrz, rfid, visual, barcode) with validity and cross-source compare checks" - "Contains images from all document sources (mrz, rfid, visual, barcode)" + - "Contains result of DocGraphicsInfoContainer" - "Contains result of fingerprints comparison" - "Contains encrypted ResultContainerList" - "Contains license" + - "Contains result of DocumentPosition" + - "Contains result of DocumentPosition" - "Contains information about document position on the input image, its center, angle, etc" - "Contains RFID raw data" - "Contains RFID text results" @@ -76,14 +89,20 @@ components: - "BARCODE_TEXT" - "BARCODE_GRAPHICS" - "AUTHENTICITY" + - "MAGNETIC_STRIPE_TEXT_DATA" - "IMAGE_QUALITY" + - "LIVE_PORTRAIT" - "STATUS" - "PORTRAIT_COMPARISON" + - "EXT_PORTRAIT" - "TEXT" - "IMAGES" + - "FINGERPRINTS" - "FINGERPRINT_COMPARISON" - "ENCRYPTED_RCL" - "LICENSE" + - "MRZ_POSITION" + - "BARCODE_POSITION" - "DOCUMENT_POSITION" - "RFID_RAW_DATA" - "RFID_TEXT" @@ -92,6 +111,7 @@ components: - "RFID_ORIGINAL_GRAPHICS" ResultItem: + title: "ResultItem" type: object description: "Common fields for all result objects" required: @@ -107,36 +127,13 @@ components: type: integer result_type: $ref: "#/components/schemas/ContainerType" - discriminator: - propertyName: result_type - mapping: - 1: "DocumentImageResult" - 3: "TextDataResult" - 5: "DocBarCodeInfo" - 6: "GraphicsResult" - 8: "DocumentTypesCandidatesResult" - 9: "ChosenDocumentTypeResult" - 15: "LexicalAnalysisResult" - 17: "TextDataResult" - 18: "TextDataResult" - 19: "GraphicsResult" - 20: "AuthenticityResult" - 30: "ImageQualityResult" - 33: "StatusResult" - 34: "AuthenticityResult" - 36: "TextResult" - 37: "ImagesResult" - 39: "AuthenticityResult" - 49: "EncryptedRCLResult" - 50: "LicenseResult" - 85: "DocumentPositionResult" - 102: "TextDataResult" - 103: "GraphicsResult" ContainerList: + title: "ContainerList" type: object description: "List with various objects, containing processing results" required: + - Count - List properties: Count: @@ -146,63 +143,19 @@ components: type: array items: anyOf: - - $ref: "#/components/schemas/StatusResult" - - $ref: "#/components/schemas/TextResult" - - $ref: "#/components/schemas/DocumentImageResult" - - $ref: "#/components/schemas/ImagesResult" - - $ref: "#/components/schemas/ChosenDocumentTypeResult" - - $ref: "#/components/schemas/DocumentTypesCandidatesResult" - - $ref: "#/components/schemas/TextDataResult" - - $ref: "#/components/schemas/GraphicsResult" - - $ref: "#/components/schemas/LexicalAnalysisResult" - - $ref: "#/components/schemas/AuthenticityResult" - - $ref: "#/components/schemas/ImageQualityResult" - - $ref: "#/components/schemas/DocumentPositionResult" - - $ref: "#/components/schemas/DocBarCodeInfo" - - $ref: "#/components/schemas/LicenseResult" - - $ref: "#/components/schemas/EncryptedRCLResult" - - DocumentPositionResult: - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" - - DocumentImageResult: - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" - - StatusResult: - $ref: "./rt-status.yml#/components/schemas/StatusResult" - - TextResult: - $ref: "./rt-text.yml#/components/schemas/TextResult" - - ImagesResult: - $ref: "./rt-images.yml#/components/schemas/ImagesResult" - - LexicalAnalysisResult: - $ref: "./rt-ocr-lexical-analisis.yml#/components/schemas/LexicalAnalysisResult" - - TextDataResult: - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" - - GraphicsResult: - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" - - DocumentTypesCandidatesResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" - - ChosenDocumentTypeResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" - - AuthenticityResult: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" - - ImageQualityResult: - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" - - DocBarCodeInfo: - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" - - LicenseResult: - $ref: "./rt-license.yml#/components/schemas/LicenseResult" - - EncryptedRCLResult: - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + - $ref: "./rt-status.yml#/components/schemas/StatusResult" + - $ref: "./rt-text.yml#/components/schemas/TextResult" + - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" + - $ref: "./rt-images.yml#/components/schemas/ImagesResult" + - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" + - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" + - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" + - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" + - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" + - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" + - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" + - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" + - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" + - $ref: "./rt-license.yml#/components/schemas/LicenseResult" + - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + - $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" From ddcf8693416b3f97981f3c9c2c0992d6c2b7d662 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 11 Oct 2024 15:34:52 +0300 Subject: [PATCH 013/106] SP-18211 - fix enum --- rt-rfid-binary-data.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index bc8cbc3..c5c363a 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -750,11 +750,11 @@ components: type: integer description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" enum: - - 0X00 - - 0X01 - - 0X02 - - 0X04 - - 0X08 + - 0x00 + - 0x01 + - 0x02 + - 0x04 + - 0x08 x-enum-descriptions: - "Unknown" - "106 bits/s" From 8db2c09fa56d2e70e688e747cb89ace49465669d Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Oct 2024 11:47:55 +0300 Subject: [PATCH 014/106] SP-18211 - add enum to RFID_ePassp_Directory --- rt-rfid-binary-data.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index c5c363a..8c6336b 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -40,7 +40,7 @@ components: description: Indexes of groups that aren't read type: array items: - type: integer + $ref: "./e-rfid-data-file-type.yml#/components/schemas/RfidDataFileType" RfidDG1: title: "RfidDG1" From 8fc9d6c78ded272dc77871646d1e805b6a8634b0 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Oct 2024 16:35:29 +0300 Subject: [PATCH 015/106] SP-18211 - update BinaryData --- rt-rfid-binary-data.yml | 186 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 182 insertions(+), 4 deletions(-) diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 8c6336b..70cd3f0 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -27,15 +27,193 @@ components: title: "BinaryData" description: "Structure is used for storing the results of one bar-code module reading." type: object - required: - - RFID_DG1 - - RFID_Session_Data - - RFID_ePassp_Directory properties: + RFID_Authentication_Info: + type: object + additionalProperties: true + RFID_MIFARE_Data_Validity: + type: object + additionalProperties: true + RFID_MIFARE_Data: + type: object + additionalProperties: true + RFID_EF_COM: + type: object + additionalProperties: true RFID_DG1: $ref: "#/components/schemas/RfidDG1" + RFID_DG2: + type: object + additionalProperties: true + RFID_DG3: + type: object + additionalProperties: true + RFID_DG4: + type: object + additionalProperties: true + RFID_DG5: + type: object + additionalProperties: true + RFID_DG6: + type: object + additionalProperties: true + RFID_DG7: + type: object + additionalProperties: true + RFID_DG8: + type: object + additionalProperties: true + RFID_DG9: + type: object + additionalProperties: true + RFID_DG10: + type: object + additionalProperties: true + RFID_DG11: + type: object + additionalProperties: true + RFID_DG12: + type: object + additionalProperties: true + RFID_DG13: + type: object + additionalProperties: true + RFID_DG14: + type: object + additionalProperties: true + RFID_DG15: + type: object + additionalProperties: true + RFID_DG16: + type: object + additionalProperties: true + RFID_EF_SOD: + type: object + additionalProperties: true + eID_DG1: + type: object + additionalProperties: true + eID_DG2: + type: object + additionalProperties: true + eID_DG3: + type: object + additionalProperties: true + eID_DG4: + type: object + additionalProperties: true + eID_DG5: + type: object + additionalProperties: true + eID_DG6: + type: object + additionalProperties: true + eID_DG7: + type: object + additionalProperties: true + eID_DG8: + type: object + additionalProperties: true + eID_DG9: + type: object + additionalProperties: true + eID_DG10: + type: object + additionalProperties: true + eID_DG11: + type: object + additionalProperties: true + eID_DG12: + type: object + additionalProperties: true + eID_DG13: + type: object + additionalProperties: true + eID_DG14: + type: object + additionalProperties: true + eID_DG15: + type: object + additionalProperties: true + eID_DG16: + type: object + additionalProperties: true + eID_DG17: + type: object + additionalProperties: true + eID_DG18: + type: object + additionalProperties: true + eID_DG19: + type: object + additionalProperties: true + eID_DG20: + type: object + additionalProperties: true + eID_DG21: + type: object + additionalProperties: true + eDL_COM: + type: object + additionalProperties: true + eDL_SOD: + type: object + additionalProperties: true + eDL_DG1: + type: object + additionalProperties: true + eDL_DG2: + type: object + additionalProperties: true + eDL_DG3: + type: object + additionalProperties: true + eDL_DG4: + type: object + additionalProperties: true + eDL_DG5: + type: object + additionalProperties: true + eDL_DG6: + type: object + additionalProperties: true + eDL_DG7: + type: object + additionalProperties: true + eDL_DG8: + type: object + additionalProperties: true + eDL_DG9: + type: object + additionalProperties: true + eDL_DG10: + type: object + additionalProperties: true + eDL_DG11: + type: object + additionalProperties: true + eDL_DG12: + type: object + additionalProperties: true + eDL_DG13: + type: object + additionalProperties: true + eDL_DG14: + type: object + additionalProperties: true + Visible_Digital_Seal: + type: object + additionalProperties: true + Visible_Digital_Seal_NC: + type: object + additionalProperties: true + Digital_Signature: + type: object + additionalProperties: true RFID_Session_Data: $ref: "#/components/schemas/RfidSessionData" + RFID_Session_Data_Status: + $ref: "./rt-status.yml#/components/schemas/detailsRFID" RFID_ePassp_Directory: description: Indexes of groups that aren't read type: array From a17a53dd13596aa7e5fb3b90437b3ef46bd510d4 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Oct 2024 17:13:12 +0300 Subject: [PATCH 016/106] SP-18211 - DeviceInfo deprecate --- p-healthcheck.yml | 1 + p-ping.yml | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index d8d3001..b4414b3 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -33,6 +33,7 @@ paths: components: schemas: DeviceInfo: + title: "DeviceInfo" type: object required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version] properties: diff --git a/p-ping.yml b/p-ping.yml index 167aecc..74f48ae 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -19,12 +19,12 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/DeviceInfo" + $ref: "#/components/schemas/DeviceInfoDeprecated" components: schemas: - DeviceInfo: - title: "DeviceInfo" + DeviceInfoDeprecated: + title: "DeviceInfoDeprecated" type: object properties: app-name: From ff4b9cd747a78ba54d8fc72a7fbeb1f72a739818 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Oct 2024 17:33:46 +0300 Subject: [PATCH 017/106] SP-18211 - update action --- .github/workflows/update-clients.yml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/update-clients.yml b/.github/workflows/update-clients.yml index 50dabb9..ea71abe 100644 --- a/.github/workflows/update-clients.yml +++ b/.github/workflows/update-clients.yml @@ -6,6 +6,10 @@ on: title: description: "Title For PR's" required: true + branch: + description: "OpenAPI branch" + required: true + default: "develop" jobs: @@ -16,7 +20,7 @@ jobs: uses: actions/checkout@v4 with: path: 'DocumentReader-web-openapi' - ref: 'develop' + ref: ${{ github.event.inputs.branch }} - name: Checkout JS Client Repo uses: actions/checkout@v4 with: @@ -55,7 +59,7 @@ jobs: uses: actions/checkout@v4 with: path: 'DocumentReader-web-openapi' - ref: 'develop' + ref: ${{ github.event.inputs.branch }} - name: Checkout Java Client Repo uses: actions/checkout@v4 with: @@ -87,7 +91,7 @@ jobs: uses: actions/checkout@v4 with: path: 'DocumentReader-web-openapi' - ref: 'develop' + ref: ${{ github.event.inputs.branch }} - name: Checkout Python Client Repo uses: actions/checkout@v4 with: @@ -119,7 +123,7 @@ jobs: uses: actions/checkout@v4 with: path: 'DocumentReader-web-openapi' - ref: 'develop' + ref: ${{ github.event.inputs.branch }} - name: Checkout C# Client Repo uses: actions/checkout@v4 with: From 8efb057e808b22b6a2b1bf8f3e857a5054d3af38 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 22 Oct 2024 11:18:11 +0300 Subject: [PATCH 018/106] SP-18211 - add RFIDPKDResourceType enum --- e-rfid-pkd-resourcetype.yml | 1 + index.yml | 2 ++ 2 files changed, 3 insertions(+) diff --git a/e-rfid-pkd-resourcetype.yml b/e-rfid-pkd-resourcetype.yml index ae5ce0f..20a2f4a 100644 --- a/e-rfid-pkd-resourcetype.yml +++ b/e-rfid-pkd-resourcetype.yml @@ -2,6 +2,7 @@ openapi: 3.0.3 components: schemas: RFIDPKDResourceType: + title: "RFIDPKDResourceType" type: integer description: "Enumeration contains a set of constants that define the type of certificate" enum: diff --git a/index.yml b/index.yml index 19be01c..050df9c 100644 --- a/index.yml +++ b/index.yml @@ -98,3 +98,5 @@ components: $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList" ChosenDocumentType: $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" + RFIDPKDResourceType: + $ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType" From 503d41592de7ee2555e573ca14f915361cfa17b7 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 22 Oct 2024 12:09:56 +0300 Subject: [PATCH 019/106] SP-18211 - typo --- index.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yml b/index.yml index 050df9c..6763adf 100644 --- a/index.yml +++ b/index.yml @@ -46,7 +46,7 @@ paths: tags: - name: process - description: Everything about perfoming request and parsing response + description: Everything about performing request and parsing response - name: status_model x-displayName: Status Model description: | From 12bf8d757821bcc25bf11c9a97babe3c875c1b37 Mon Sep 17 00:00:00 2001 From: Kiryl Kovaliov Date: Thu, 24 Oct 2024 10:58:27 +0200 Subject: [PATCH 020/106] Update index.yml --- index.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yml b/index.yml index 6763adf..401ddd5 100644 --- a/index.yml +++ b/index.yml @@ -7,7 +7,7 @@ info: href: "https://regulaforensics.com" description: | Documents recognition as easy as reading two bytes. - + # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android From fe086344e7f4d83a9abfa5ebbfed21af8a1d9507 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 24 Oct 2024 13:46:57 +0300 Subject: [PATCH 021/106] SP-18211 - add result_type discriminator --- rt.yml | 113 +++++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 97 insertions(+), 16 deletions(-) diff --git a/rt.yml b/rt.yml index 78d9a69..1e6f942 100644 --- a/rt.yml +++ b/rt.yml @@ -127,6 +127,39 @@ components: type: integer result_type: $ref: "#/components/schemas/ContainerType" + discriminator: + propertyName: result_type + mapping: + 33: "StatusResult" + 36: "TextResult" + 1: "DocumentImageResult" + 16: "DocumentImageResult" + 37: "ImagesResult" + 9: "ChosenDocumentTypeResult" + 8: "DocumentTypesCandidatesResult" + 17: "TextDataResult" + 3: "TextDataResult" + 18: "TextDataResult" + 26: "TextDataResult" + 102: "TextDataResult" + 6: "GraphicsResult" + 19: "GraphicsResult" + 32: "GraphicsResult" + 35: "GraphicsResult" + 38: "GraphicsResult" + 103: "GraphicsResult" + 15: "LexicalAnalysisResult" + 20: "AuthenticityResult" + 39: "AuthenticityResult" + 34: "AuthenticityResult" + 30: "ImageQualityResult" + 85: "DocumentPositionResult" + 61: "DocumentPositionResult" + 62: "DocumentPositionResult" + 5: "DocBarCodeInfo" + 50: "LicenseResult" + 49: "EncryptedRCLResult" + 104: "DocumentBinaryInfoResult" ContainerList: title: "ContainerList" @@ -143,19 +176,67 @@ components: type: array items: anyOf: - - $ref: "./rt-status.yml#/components/schemas/StatusResult" - - $ref: "./rt-text.yml#/components/schemas/TextResult" - - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" - - $ref: "./rt-images.yml#/components/schemas/ImagesResult" - - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" - - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" - - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" - - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" - - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" - - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" - - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" - - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" - - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" - - $ref: "./rt-license.yml#/components/schemas/LicenseResult" - - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" - - $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" + - $ref: "#/components/schemas/StatusResult" + - $ref: "#/components/schemas/TextResult" + - $ref: "#/components/schemas/DocumentImageResult" + - $ref: "#/components/schemas/ImagesResult" + - $ref: "#/components/schemas/ChosenDocumentTypeResult" + - $ref: "#/components/schemas/DocumentTypesCandidatesResult" + - $ref: "#/components/schemas/TextDataResult" + - $ref: "#/components/schemas/GraphicsResult" + - $ref: "#/components/schemas/LexicalAnalysisResult" + - $ref: "#/components/schemas/AuthenticityResult" + - $ref: "#/components/schemas/ImageQualityResult" + - $ref: "#/components/schemas/DocumentPositionResult" + - $ref: "#/components/schemas/DocBarCodeInfo" + - $ref: "#/components/schemas/LicenseResult" + - $ref: "#/components/schemas/EncryptedRCLResult" + - $ref: "#/components/schemas/DocumentBinaryInfoResult" + + StatusResult: + $ref: "./rt-status.yml#/components/schemas/StatusResult" + + TextResult: + $ref: "./rt-text.yml#/components/schemas/TextResult" + + DocumentImageResult: + $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" + + ImagesResult: + $ref: "./rt-images.yml#/components/schemas/ImagesResult" + + ChosenDocumentTypeResult: + $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" + + DocumentTypesCandidatesResult: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" + + TextDataResult: + $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" + + GraphicsResult: + $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" + + LexicalAnalysisResult: + $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" + + AuthenticityResult: + $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" + + ImageQualityResult: + $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" + + DocumentPositionResult: + $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" + + DocBarCodeInfo: + $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" + + LicenseResult: + $ref: "./rt-license.yml#/components/schemas/LicenseResult" + + EncryptedRCLResult: + $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + + DocumentBinaryInfoResult: + $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" From 74e3d7f9627baa80e8d308ad4a2e3f0cbb49ef2b Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 29 Oct 2024 16:05:22 +0300 Subject: [PATCH 022/106] SP-18211 - update enums --- e-rfid-data-file-type.yml | 10 ++++++++++ rt-rfid-binary-data.yml | 12 ++++++++++++ 2 files changed, 22 insertions(+) diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index 4bc971a..e6c9a99 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -31,6 +31,11 @@ components: - 21 - 22 - 23 + - 57 + - 58 + - 62 + - 63 + - 64 - 101 - 102 - 103 @@ -119,6 +124,11 @@ components: - "PASSPORT_SOD" - "PASSPORT_CVCA" - "PASSPORT_COM" + - "DTC_DG17" + - "DTC_DG18" + - "DTC_DG22" + - "DTC_DG23" + - "DTC_DG24" - "ID_DG1" - "ID_DG2" - "ID_DG3" diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 70cd3f0..258cb92 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -664,6 +664,10 @@ components: - 2 - 3 - 4 + - 5 + - 6 + - 7 + - 8 - 0 x-enum-descriptions: - "Not defined" @@ -671,6 +675,10 @@ components: - "eID application" - "eSign application" - "eDL application" + - "TravelRecords application" + - "VisaRecords application" + - "AddBiometrics application" + - "Digital Travel Credentials" - "Master File" x-enum-varnames: - "UNSPECIFIED" @@ -678,6 +686,10 @@ components: - "E_ID" - "E_SIGN" - "E_DL" + - "LDS2_TravelRecords" + - "LDS2_VisaRecords" + - "LDS2_AddBiometrics" + - "eDTC_PC" - "ROOT_FILES" RfidDataFile: From d10e097a84775a0eea864a32474aa73b27a08c99 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 15 Nov 2024 13:57:30 +0300 Subject: [PATCH 023/106] SP-18211 - sort result_type mapping --- rt.yml | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/rt.yml b/rt.yml index 1e6f942..f06df43 100644 --- a/rt.yml +++ b/rt.yml @@ -130,35 +130,35 @@ components: discriminator: propertyName: result_type mapping: - 33: "StatusResult" - 36: "TextResult" 1: "DocumentImageResult" - 16: "DocumentImageResult" - 37: "ImagesResult" - 9: "ChosenDocumentTypeResult" + 3: "TextDataResult" + 5: "DocBarCodeInfo" + 6: "GraphicsResult" 8: "DocumentTypesCandidatesResult" + 9: "ChosenDocumentTypeResult" + 15: "LexicalAnalysisResult" + 16: "DocumentImageResult" 17: "TextDataResult" - 3: "TextDataResult" 18: "TextDataResult" - 26: "TextDataResult" - 102: "TextDataResult" - 6: "GraphicsResult" 19: "GraphicsResult" + 20: "AuthenticityResult" + 26: "TextDataResult" + 30: "ImageQualityResult" 32: "GraphicsResult" + 33: "StatusResult" + 34: "AuthenticityResult" 35: "GraphicsResult" + 36: "TextResult" + 37: "ImagesResult" 38: "GraphicsResult" - 103: "GraphicsResult" - 15: "LexicalAnalysisResult" - 20: "AuthenticityResult" 39: "AuthenticityResult" - 34: "AuthenticityResult" - 30: "ImageQualityResult" - 85: "DocumentPositionResult" + 49: "EncryptedRCLResult" + 50: "LicenseResult" 61: "DocumentPositionResult" 62: "DocumentPositionResult" - 5: "DocBarCodeInfo" - 50: "LicenseResult" - 49: "EncryptedRCLResult" + 85: "DocumentPositionResult" + 102: "TextDataResult" + 103: "GraphicsResult" 104: "DocumentBinaryInfoResult" ContainerList: From d37e6af5e73c86fe681f2a471bb2295716c3c82d Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Sat, 16 Nov 2024 11:32:42 +0300 Subject: [PATCH 024/106] SP-18211 - update schemas --- p-transaction.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/p-transaction.yml b/p-transaction.yml index bd13c8e..e13dff2 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -10,7 +10,7 @@ paths: - in: path name: transactionId schema: - type: integer + type: string format: uuid required: true description: Transaction id @@ -41,7 +41,7 @@ paths: - in: path name: transactionId schema: - type: integer + type: string format: uuid required: true description: Transaction id @@ -66,7 +66,7 @@ paths: - in: path name: transactionId schema: - type: integer + type: string format: uuid required: true description: Transaction id @@ -99,7 +99,7 @@ paths: - in: path name: transactionId schema: - type: integer + type: string format: uuid required: true description: Transaction id @@ -129,7 +129,7 @@ paths: - in: path name: tagId schema: - type: integer + type: string format: uuid required: true description: Tag id @@ -190,7 +190,7 @@ components: type: object properties: id: - type: integer + type: string format: uuid description: "Transaction id" state: @@ -231,7 +231,7 @@ components: type: object properties: transactionId: - type: integer + type: string format: uuid tag: type: string From 3f7ee85325e8fd8a3aea47f8450887c641bff955 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 20 Nov 2024 18:06:58 +0300 Subject: [PATCH 025/106] SP-18211 - update schemas --- rt-byte-array-data.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rt-byte-array-data.yml b/rt-byte-array-data.yml index cd8a883..52309df 100644 --- a/rt-byte-array-data.yml +++ b/rt-byte-array-data.yml @@ -2,7 +2,7 @@ openapi: 3.0.3 components: schemas: ByteArrayResult: - title: "ByteArray" + title: "ByteArrayResult" allOf: - type: object required: From a7f98b1367a832f80770d1a81d806894ca231e5e Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 15 Jan 2025 09:52:32 +0300 Subject: [PATCH 026/106] SP-18211 - update docs --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 38bc4db..0ede455 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,11 @@ docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate - ## Building Redoc single page html documentation -Run next command: +Edit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node + +Edit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator** + +Then run next command: ``` npx @redocly/cli build-docs index.yml -o=document-reader-static-doc.html ``` From 5831a0af9f93767ac200e456ce5c4645cabd643d Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 15 Jan 2025 10:02:05 +0300 Subject: [PATCH 027/106] SP-18211 - update update-clients.yml --- .github/workflows/update-clients.yml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/update-clients.yml b/.github/workflows/update-clients.yml index 098ef4a..cf136ad 100644 --- a/.github/workflows/update-clients.yml +++ b/.github/workflows/update-clients.yml @@ -8,6 +8,10 @@ on: title: description: "Title For PR's" required: true + branch: + description: "OpenAPI branch" + required: true + default: "develop" jobs: title: @@ -31,7 +35,7 @@ jobs: uses: actions/checkout@v4 with: path: "DocumentReader-web-openapi" - ref: "develop" + ref: ${{ github.event.inputs.branch }} - name: Checkout JS Client Repo uses: actions/checkout@v4 @@ -75,7 +79,7 @@ jobs: uses: actions/checkout@v4 with: path: "DocumentReader-web-openapi" - ref: "develop" + ref: ${{ github.event.inputs.branch }} - name: Checkout Java Client Repo uses: actions/checkout@v4 @@ -111,7 +115,7 @@ jobs: uses: actions/checkout@v4 with: path: "DocumentReader-web-openapi" - ref: "develop" + ref: ${{ github.event.inputs.branch }} - name: Checkout Python Client Repo uses: actions/checkout@v4 @@ -147,7 +151,7 @@ jobs: uses: actions/checkout@v4 with: path: "DocumentReader-web-openapi" - ref: "develop" + ref: ${{ github.event.inputs.branch }} - name: Checkout C# Client Repo uses: actions/checkout@v4 From f54bc16ebc2925cdb9c5c713f104f382eda327a1 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 17 Jan 2025 14:01:21 +0300 Subject: [PATCH 028/106] SP-18211 - set Area optional --- authenticity/rt-ident.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index ae078bb..6e99a4f 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -9,7 +9,6 @@ components: required: - ElementType - LightIndex - - Area - Image - EtalonImage properties: From aefa6f0c005a1557b99b17b1e8fee4423436e347 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 22 Jan 2025 11:10:04 +0300 Subject: [PATCH 029/106] SP-18211 - update enums --- e-parsing-error-codes.yml | 252 +++++++++--------- e-parsing-notification-codes.yml | 444 +++++++++++++++---------------- e-rfid-error-codes.yml | 228 ++++++++-------- 3 files changed, 462 insertions(+), 462 deletions(-) diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index e08e321..87ab50c 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -6,132 +6,132 @@ components: type: integer description: "The enumeration contains error codes that can return during the RFID chip processing." enum: - - 0x00000001 - - 0x80000001 - - 0x80000002 - - 0x80000003 - - 0x80000008 - - 0x80000009 - - 0x8000000A - - 0x80000011 - - 0x80000013 - - 0x80000014 - - 0x80000015 - - 0x80000016 - - 0x80000012 - - 0x80000017 - - 0x80000018 - - 0x80000019 - - 0x8000001A - - 0x8000001B - - 0x8000001C - - 0x8000001D - - 0x8000001E - - 0x8000001F - - 0x80000020 - - 0x80000021 - - 0x80000022 - - 0x80000023 - - 0x80000024 - - 0x80000025 - - 0x80000026 - - 0x80000027 - - 0x80000030 - - 0x80000031 - - 0x80000032 - - 0x80000033 - - 0x80000034 - - 0x80000036 - - 0x80000035 - - 0x80000050 - - 0x80000051 - - 0x80000052 - - 0x80000053 - - 0x80000054 - - 0x80000055 - - 0x80000056 - - 0x80000057 - - 0x80000058 - - 0x80000059 - - 0x8000005A - - 0x80000070 - - 0x80000071 - - 0x81000011 - - 0x81000020 - - 0x81000021 - - 0x81000022 - - 0x81000023 - - 0x81000024 - - 0x81000025 - - 0x81000026 - - 0x81000027 - - 0x81000028 - - 0x81000029 - - 0x8100002A - - 0x8100002B - - 0x8100002C - - 0x8100002D - - 0x8100002E - - 0x8100002F - - 0x81000030 - - 0x81000031 - - 0x81000032 - - 0x81000033 - - 0x81000034 - - 0x81000035 - - 0x81000036 - - 0x81000037 - - 0x81000038 - - 0x81000040 - - 0x81000041 - - 0x81000042 - - 0x81000043 - - 0x81000044 - - 0x81000045 - - 0x81000050 - - 0x81000051 - - 0x81000052 - - 0x81000053 - - 0x81000054 - - 0x81000055 - - 0x81000056 - - 0x81000057 - - 0x81000070 - - 0x81000071 - - 0x81000072 - - 0x81000060 - - 0x81000062 - - 0x81000063 - - 0x81000064 - - 0x81000065 - - 0x81000160 - - 0x81000161 - - 0x81000162 - - 0x81000163 - - 0x81000164 - - 0x81000165 - - 0x81000166 - - 0x81000167 - - 0x81000168 - - 0x81000169 - - 0x8100016A - - 0x81000200 - - 0x81000201 - - 0x81000202 - - 0x81000203 - - 0x81000204 - - 0x81000205 - - 0x81000300 - - 0x81000301 - - 0x81000302 - - 0x81000303 - - 0x81000304 - - 0x81000305 - - 0x81000306 - - 0x81000307 - - 0x81000308 - - 0x81000309 - - 0x8100030A + - 1 + - -2147483647 + - -2147483646 + - -2147483645 + - -2147483640 + - -2147483639 + - -2147483638 + - -2147483631 + - -2147483629 + - -2147483628 + - -2147483627 + - -2147483626 + - -2147483630 + - -2147483625 + - -2147483624 + - -2147483623 + - -2147483622 + - -2147483621 + - -2147483620 + - -2147483619 + - -2147483618 + - -2147483617 + - -2147483616 + - -2147483615 + - -2147483614 + - -2147483613 + - -2147483612 + - -2147483611 + - -2147483610 + - -2147483609 + - -2147483600 + - -2147483599 + - -2147483598 + - -2147483597 + - -2147483596 + - -2147483594 + - -2147483595 + - -2147483568 + - -2147483567 + - -2147483566 + - -2147483565 + - -2147483564 + - -2147483563 + - -2147483562 + - -2147483561 + - -2147483560 + - -2147483559 + - -2147483558 + - -2147483536 + - -2147483535 + - -2130706415 + - -2130706400 + - -2130706399 + - -2130706398 + - -2130706397 + - -2130706396 + - -2130706395 + - -2130706394 + - -2130706393 + - -2130706392 + - -2130706391 + - -2130706390 + - -2130706389 + - -2130706388 + - -2130706387 + - -2130706386 + - -2130706385 + - -2130706384 + - -2130706383 + - -2130706382 + - -2130706381 + - -2130706380 + - -2130706379 + - -2130706378 + - -2130706377 + - -2130706376 + - -2130706368 + - -2130706367 + - -2130706366 + - -2130706365 + - -2130706364 + - -2130706363 + - -2130706352 + - -2130706351 + - -2130706350 + - -2130706349 + - -2130706348 + - -2130706347 + - -2130706346 + - -2130706345 + - -2130706320 + - -2130706319 + - -2130706318 + - -2130706336 + - -2130706334 + - -2130706333 + - -2130706332 + - -2130706331 + - -2130706080 + - -2130706079 + - -2130706078 + - -2130706077 + - -2130706076 + - -2130706075 + - -2130706074 + - -2130706073 + - -2130706072 + - -2130706071 + - -2130706070 + - -2130705920 + - -2130705919 + - -2130705918 + - -2130705917 + - -2130705916 + - -2130705915 + - -2130705664 + - -2130705663 + - -2130705662 + - -2130705661 + - -2130705660 + - -2130705659 + - -2130705658 + - -2130705657 + - -2130705656 + - -2130705655 + - -2130705654 x-enum-descriptions: - "OK" - "ASN: Incorrect data" diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 2333acb..5a79abd 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -6,228 +6,228 @@ components: type: integer description: "The enumeration contains possible values of notification codes returned during the RFID chip processing." enum: - - 0x90000001 - - 0x90000002 - - 0x90000003 - - 0x90000004 - - 0x90000005 - - 0x90000006 - - 0x90000008 - - 0x9000000E - - 0x9000000F - - 0x90000010 - - 0x90000017 - - 0x90000200 - - 0x90000201 - - 0x90000202 - - 0x90000203 - - 0x90000204 - - 0x90000205 - - 0x90000206 - - 0x90000207 - - 0x90000208 - - 0x90000209 - - 0x9000020A - - 0x9000020B - - 0x9000020C - - 0x9000020D - - 0x9000020E - - 0x9000020F - - 0x90000210 - - 0x90000211 - - 0x90000212 - - 0x90000213 - - 0x90000214 - - 0x90000215 - - 0x90000216 - - 0x90000217 - - 0x90000218 - - 0x90000219 - - 0x9000021A - - 0x9000021B - - 0x9000021C - - 0x9000021D - - 0x9000021E - - 0x9000021F - - 0x90000220 - - 0x90000221 - - 0x90000222 - - 0x90000223 - - 0x90000224 - - 0x90000225 - - 0x90000226 - - 0x90000228 - - 0x90000229 - - 0x9000022A - - 0x9000022B - - 0x9000022C - - 0x9000022D - - 0x9000022E - - 0x9000022F - - 0x90000231 - - 0x90000232 - - 0x90000233 - - 0x90000234 - - 0x90000235 - - 0x90000236 - - 0x90000237 - - 0x90000238 - - 0x90000239 - - 0x9000023A - - 0x9000023B - - 0x9000023C - - 0x9000023D - - 0x9000023E - - 0x9000023F - - 0x90000240 - - 0x90000241 - - 0x90000242 - - 0x90000243 - - 0x90000244 - - 0x90000245 - - 0x90000246 - - 0x90000247 - - 0x90000248 - - 0x90000249 - - 0x9000024A - - 0x9000024B - - 0x9000024C - - 0x9000024D - - 0x9000024E - - 0x9000024F - - 0x90000020 - - 0x90000021 - - 0x90000022 - - 0x90000023 - - 0x90000024 - - 0x90000025 - - 0x90000026 - - 0x90000030 - - 0x90000031 - - 0x90000032 - - 0x90000033 - - 0x90000100 - - 0x900001A0 - - 0x900001A1 - - 0x90000101 - - 0x90000102 - - 0x90000103 - - 0x90000109 - - 0x900001B0 - - 0x900001B1 - - 0x900001B2 - - 0x90000104 - - 0x90000105 - - 0x90000106 - - 0x90000107 - - 0x90000108 - - 0x900001C0 - - 0x900001C8 - - 0x900001D0 - - 0x900001D8 - - 0x9000010A - - 0x9000010B - - 0x9000010C - - 0x9000010D - - 0x9000010E - - 0x9000010F - - 0x90000110 - - 0x90000111 - - 0x90000112 - - 0x9000011B - - 0x9000011C - - 0x9000011D - - 0x9000011E - - 0x9000011F - - 0x90000115 - - 0x90000116 - - 0x90000117 - - 0x90000118 - - 0x90000119 - - 0x9000011A - - 0x00022008 - - 0x00022009 - - 0x0002200A - - 0x0002200D - - 0x0002200E - - 0x0002200F - - 0x00022010 - - 0x00022011 - - 0x00022012 - - 0x00022013 - - 0x00022014 - - 0x00022015 - - 0x00022016 - - 0x00022017 - - 0x00022018 - - 0x90010000 - - 0x90020000 - - 0x90030000 - - 0x90040000 - - 0x90050000 - - 0x90060000 - - 0x90070000 - - 0x90080000 - - 0x90090000 - - 0x900A0000 - - 0x900B0000 - - 0x90100000 - - 0x90110000 - - 0x90120000 - - 0x90130000 - - 0x90140000 - - 0x90150000 - - 0x90160000 - - 0x90170000 - - 0x90180000 - - 0x90190000 - - 0x901A0000 - - 0x91000000 - - 0x91000001 - - 0x91000002 - - 0x91000003 - - 0x91000004 - - 0x91000005 - - 0x91000006 - - 0x91000007 - - 0x91000008 - - 0x91000009 - - 0x9100000A - - 0x9100000B - - 0x9100000C - - 0x9100000D - - 0x9100000E - - 0x91000100 - - 0x91000101 - - 0x91000102 - - 0x91000103 - - 0x91000104 - - 0x91000105 - - 0x91000106 - - 0x91000107 - - 0x91000108 - - 0x91000109 - - 0x9100010A - - 0x9100010B - - 0x9100010C - - 0x9100010D - - 0x9100010E - - 0x9100010F - - 0x91000110 - - 0x91000201 - - 0x91000202 - - 0x91000203 - - 0x91000204 - - 0x91000300 - - 0x92000115 - - 0x92000116 - - 0x92000117 - - 0x92000118 - - 0x92000119 - - 0x90000250 - - 0x90000251 - - 0x00022019 - - 0x90000252 + - -1879048191 + - -1879048190 + - -1879048189 + - -1879048188 + - -1879048187 + - -1879048186 + - -1879048184 + - -1879048178 + - -1879048177 + - -1879048176 + - -1879048169 + - -1879047680 + - -1879047679 + - -1879047678 + - -1879047677 + - -1879047676 + - -1879047675 + - -1879047674 + - -1879047673 + - -1879047672 + - -1879047671 + - -1879047670 + - -1879047669 + - -1879047668 + - -1879047667 + - -1879047666 + - -1879047665 + - -1879047664 + - -1879047663 + - -1879047662 + - -1879047661 + - -1879047660 + - -1879047659 + - -1879047658 + - -1879047657 + - -1879047656 + - -1879047655 + - -1879047654 + - -1879047653 + - -1879047652 + - -1879047651 + - -1879047650 + - -1879047649 + - -1879047648 + - -1879047647 + - -1879047646 + - -1879047645 + - -1879047644 + - -1879047643 + - -1879047642 + - -1879047640 + - -1879047639 + - -1879047638 + - -1879047637 + - -1879047636 + - -1879047635 + - -1879047634 + - -1879047633 + - -1879047631 + - -1879047630 + - -1879047629 + - -1879047628 + - -1879047627 + - -1879047626 + - -1879047625 + - -1879047624 + - -1879047623 + - -1879047622 + - -1879047621 + - -1879047620 + - -1879047619 + - -1879047618 + - -1879047617 + - -1879047616 + - -1879047615 + - -1879047614 + - -1879047613 + - -1879047612 + - -1879047611 + - -1879047610 + - -1879047609 + - -1879047608 + - -1879047607 + - -1879047606 + - -1879047605 + - -1879047604 + - -1879047603 + - -1879047602 + - -1879047601 + - -1879048160 + - -1879048159 + - -1879048158 + - -1879048157 + - -1879048156 + - -1879048155 + - -1879048154 + - -1879048144 + - -1879048143 + - -1879048142 + - -1879048141 + - -1879047936 + - -1879047776 + - -1879047775 + - -1879047935 + - -1879047934 + - -1879047933 + - -1879047927 + - -1879047760 + - -1879047759 + - -1879047758 + - -1879047932 + - -1879047931 + - -1879047930 + - -1879047929 + - -1879047928 + - -1879047744 + - -1879047736 + - -1879047728 + - -1879047720 + - -1879047926 + - -1879047925 + - -1879047924 + - -1879047923 + - -1879047922 + - -1879047921 + - -1879047920 + - -1879047919 + - -1879047918 + - -1879047909 + - -1879047908 + - -1879047907 + - -1879047906 + - -1879047905 + - -1879047915 + - -1879047914 + - -1879047913 + - -1879047912 + - -1879047911 + - -1879047910 + - 139272 + - 139273 + - 139274 + - 139277 + - 139278 + - 139279 + - 139280 + - 139281 + - 139282 + - 139283 + - 139284 + - 139285 + - 139286 + - 139287 + - 139288 + - -1878982656 + - -1878917120 + - -1878851584 + - -1878786048 + - -1878720512 + - -1878654976 + - -1878589440 + - -1878523904 + - -1878458368 + - -1878392832 + - -1878327296 + - -1877999616 + - -1877934080 + - -1877868544 + - -1877803008 + - -1877737472 + - -1877671936 + - -1877606400 + - -1877540864 + - -1877475328 + - -1877409792 + - -1877344256 + - -1862270976 + - -1862270975 + - -1862270974 + - -1862270973 + - -1862270972 + - -1862270971 + - -1862270970 + - -1862270969 + - -1862270968 + - -1862270967 + - -1862270966 + - -1862270965 + - -1862270964 + - -1862270963 + - -1862270962 + - -1862270720 + - -1862270719 + - -1862270718 + - -1862270717 + - -1862270716 + - -1862270715 + - -1862270714 + - -1862270713 + - -1862270712 + - -1862270711 + - -1862270710 + - -1862270709 + - -1862270708 + - -1862270707 + - -1862270706 + - -1862270705 + - -1862270704 + - -1862270463 + - -1862270462 + - -1862270461 + - -1862270460 + - -1862270208 + - -1845493483 + - -1845493482 + - -1845493481 + - -1845493480 + - -1845493479 + - -1879047600 + - -1879047599 + - 139289 + - -1879047598 x-enum-descriptions: - "ASN certificate: Incorrect version" - "ASN certificate: Non-matching signature algorithm" diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index 127ba64..16efc0c 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -6,120 +6,120 @@ components: type: integer description: "Enumeration contains a set of error codes returned by SDK" enum: - - 0x80006282 - - 0x80006283 - - 0x800063C0 - - 0x800063C1 - - 0x80006983 - - 0x80006984 - - 0x80006985 - - 0x80006A80 - - 0x80006A82 - - 0x80006A88 - - 0x80006B00 - - 0x80010001 - - 0x80010002 - - 0x80010004 - - 0x80010005 - - 0x80010006 - - 0x80010008 - - 0x80010009 - - 0x8001000A - - 0x8001000B - - 0x8001000C - - 0x80020000 - - 0x80020001 - - 0x80020002 - - 0x80020003 - - 0x80020004 - - 0x80020005 - - 0x80020006 - - 0x80020010 - - 0x801063C0 - - 0x83000000 - - 0x83000001 - - 0x83000002 - - 0x83000010 - - 0x83000011 - - 0x83000012 - - 0x83000013 - - 0x83000014 - - 0x83000015 - - 0x83000016 - - 0x83000017 - - 0x83000018 - - 0x83000019 - - 0x8300001A - - 0x8300001B - - 0x8300001C - - 0x83000020 - - 0x83000021 - - 0x83000022 - - 0x83000023 - - 0x83000024 - - 0x83000025 - - 0x83000026 - - 0x83000027 - - 0x83000028 - - 0x83000029 - - 0x8300002A - - 0x83000030 - - 0x83000031 - - 0x83000040 - - 0x83000041 - - 0x83000042 - - 0x83000050 - - 0x83000051 - - 0x83000052 - - 0x83000060 - - 0x83010000 - - 0x83020000 - - 0x83030000 - - 0x83040000 - - 0x83050000 - - 0x83060000 - - 0x83070000 - - 0x83080000 - - 0x84000000 - - 0x84010000 - - 0x84020000 - - 0x84030000 - - 0x84040000 - - 0x84050000 - - 0x84060000 - - 0x84070000 - - 0x84080000 - - 0x84090000 - - 0x840A0000 - - 0x840B0000 - - 0x840C0000 - - 0x840D0000 - - 0x840E0000 - - 0x840F0000 - - 0x86000000 - - 0x86000001 - - 0x86000100 - - 0x86000101 - - 0x86000102 - - 0x86000103 - - 0x86000200 - - 0x86000201 - - 0x86000202 - - 0x86000203 - - 0x86000204 - - 0x86000300 - - 0x86000301 - - 0x86000302 - - 0x86000303 - - 0x86000304 - - 0x86000305 - - 0x86000306 - - 0x86000307 - - 0x86000308 - - 0x86000309 - - 0xFFFFFFFF - - 0x00000001 - - 0x00000002 + - -2147458430 + - -2147458429 + - -2147458112 + - -2147458111 + - -2147456637 + - -2147456636 + - -2147456635 + - -2147456384 + - -2147456382 + - -2147456376 + - -2147456256 + - -2147418111 + - -2147418110 + - -2147418108 + - -2147418107 + - -2147418106 + - -2147418104 + - -2147418103 + - -2147418102 + - -2147418101 + - -2147418100 + - -2147352576 + - -2147352575 + - -2147352574 + - -2147352573 + - -2147352572 + - -2147352571 + - -2147352570 + - -2147352560 + - -2146409536 + - -2097152000 + - -2097151999 + - -2097151998 + - -2097151984 + - -2097151983 + - -2097151982 + - -2097151981 + - -2097151980 + - -2097151979 + - -2097151978 + - -2097151977 + - -2097151976 + - -2097151975 + - -2097151974 + - -2097151973 + - -2097151972 + - -2097151968 + - -2097151967 + - -2097151966 + - -2097151965 + - -2097151964 + - -2097151963 + - -2097151962 + - -2097151961 + - -2097151960 + - -2097151959 + - -2097151958 + - -2097151952 + - -2097151951 + - -2097151936 + - -2097151935 + - -2097151934 + - -2097151920 + - -2097151919 + - -2097151918 + - -2097151904 + - -2097086464 + - -2097020928 + - -2096955392 + - -2096889856 + - -2096824320 + - -2096758784 + - -2096693248 + - -2096627712 + - -2080374784 + - -2080309248 + - -2080243712 + - -2080178176 + - -2080112640 + - -2080047104 + - -2079981568 + - -2079916032 + - -2079850496 + - -2079784960 + - -2079719424 + - -2079653888 + - -2079588352 + - -2079522816 + - -2079457280 + - -2079391744 + - -2046820352 + - -2046820351 + - -2046820096 + - -2046820095 + - -2046820094 + - -2046820093 + - -2046819840 + - -2046819839 + - -2046819838 + - -2046819837 + - -2046819836 + - -2046819584 + - -2046819583 + - -2046819582 + - -2046819581 + - -2046819580 + - -2046819579 + - -2046819578 + - -2046819577 + - -2046819576 + - -2046819575 + - -1 + - 1 + - 2 x-enum-descriptions: - "LAYER6: Reading beyond EOF / Unexpected EOF" - "LAYER6: PWD deactivated" From 3bc932d8c09c1778d53007890c797904c427631a Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 28 Jan 2025 17:52:57 +0300 Subject: [PATCH 030/106] SP-18211 - update enums --- authenticity/e-result-type.yml | 1 + common.yml | 1 + e-parsing-error-codes.yml | 253 +++++++++--------- e-parsing-notification-codes.yml | 445 ++++++++++++++++--------------- e-rfid-error-codes.yml | 229 ++++++++-------- 5 files changed, 467 insertions(+), 462 deletions(-) diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index 2a5a900..b21d263 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -4,6 +4,7 @@ components: AuthenticityResultType: title: "AuthenticityResultType" type: integer + format: int64 description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/." enum: - 0 diff --git a/common.yml b/common.yml index c53c575..22fa445 100644 --- a/common.yml +++ b/common.yml @@ -210,6 +210,7 @@ components: Light: title: "Light" type: integer + format: int64 description: "Image light index" enum: - 0x00000000 diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 87ab50c..8d85f1c 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -4,134 +4,135 @@ components: ParsingErrorCodes: title: "ParsingErrorCodes" type: integer + format: int64 description: "The enumeration contains error codes that can return during the RFID chip processing." enum: - - 1 - - -2147483647 - - -2147483646 - - -2147483645 - - -2147483640 - - -2147483639 - - -2147483638 - - -2147483631 - - -2147483629 - - -2147483628 - - -2147483627 - - -2147483626 - - -2147483630 - - -2147483625 - - -2147483624 - - -2147483623 - - -2147483622 - - -2147483621 - - -2147483620 - - -2147483619 - - -2147483618 - - -2147483617 - - -2147483616 - - -2147483615 - - -2147483614 - - -2147483613 - - -2147483612 - - -2147483611 - - -2147483610 - - -2147483609 - - -2147483600 - - -2147483599 - - -2147483598 - - -2147483597 - - -2147483596 - - -2147483594 - - -2147483595 - - -2147483568 - - -2147483567 - - -2147483566 - - -2147483565 - - -2147483564 - - -2147483563 - - -2147483562 - - -2147483561 - - -2147483560 - - -2147483559 - - -2147483558 - - -2147483536 - - -2147483535 - - -2130706415 - - -2130706400 - - -2130706399 - - -2130706398 - - -2130706397 - - -2130706396 - - -2130706395 - - -2130706394 - - -2130706393 - - -2130706392 - - -2130706391 - - -2130706390 - - -2130706389 - - -2130706388 - - -2130706387 - - -2130706386 - - -2130706385 - - -2130706384 - - -2130706383 - - -2130706382 - - -2130706381 - - -2130706380 - - -2130706379 - - -2130706378 - - -2130706377 - - -2130706376 - - -2130706368 - - -2130706367 - - -2130706366 - - -2130706365 - - -2130706364 - - -2130706363 - - -2130706352 - - -2130706351 - - -2130706350 - - -2130706349 - - -2130706348 - - -2130706347 - - -2130706346 - - -2130706345 - - -2130706320 - - -2130706319 - - -2130706318 - - -2130706336 - - -2130706334 - - -2130706333 - - -2130706332 - - -2130706331 - - -2130706080 - - -2130706079 - - -2130706078 - - -2130706077 - - -2130706076 - - -2130706075 - - -2130706074 - - -2130706073 - - -2130706072 - - -2130706071 - - -2130706070 - - -2130705920 - - -2130705919 - - -2130705918 - - -2130705917 - - -2130705916 - - -2130705915 - - -2130705664 - - -2130705663 - - -2130705662 - - -2130705661 - - -2130705660 - - -2130705659 - - -2130705658 - - -2130705657 - - -2130705656 - - -2130705655 - - -2130705654 + - 0x00000001 + - 0x80000001 + - 0x80000002 + - 0x80000003 + - 0x80000008 + - 0x80000009 + - 0x8000000A + - 0x80000011 + - 0x80000013 + - 0x80000014 + - 0x80000015 + - 0x80000016 + - 0x80000012 + - 0x80000017 + - 0x80000018 + - 0x80000019 + - 0x8000001A + - 0x8000001B + - 0x8000001C + - 0x8000001D + - 0x8000001E + - 0x8000001F + - 0x80000020 + - 0x80000021 + - 0x80000022 + - 0x80000023 + - 0x80000024 + - 0x80000025 + - 0x80000026 + - 0x80000027 + - 0x80000030 + - 0x80000031 + - 0x80000032 + - 0x80000033 + - 0x80000034 + - 0x80000036 + - 0x80000035 + - 0x80000050 + - 0x80000051 + - 0x80000052 + - 0x80000053 + - 0x80000054 + - 0x80000055 + - 0x80000056 + - 0x80000057 + - 0x80000058 + - 0x80000059 + - 0x8000005A + - 0x80000070 + - 0x80000071 + - 0x81000011 + - 0x81000020 + - 0x81000021 + - 0x81000022 + - 0x81000023 + - 0x81000024 + - 0x81000025 + - 0x81000026 + - 0x81000027 + - 0x81000028 + - 0x81000029 + - 0x8100002A + - 0x8100002B + - 0x8100002C + - 0x8100002D + - 0x8100002E + - 0x8100002F + - 0x81000030 + - 0x81000031 + - 0x81000032 + - 0x81000033 + - 0x81000034 + - 0x81000035 + - 0x81000036 + - 0x81000037 + - 0x81000038 + - 0x81000040 + - 0x81000041 + - 0x81000042 + - 0x81000043 + - 0x81000044 + - 0x81000045 + - 0x81000050 + - 0x81000051 + - 0x81000052 + - 0x81000053 + - 0x81000054 + - 0x81000055 + - 0x81000056 + - 0x81000057 + - 0x81000070 + - 0x81000071 + - 0x81000072 + - 0x81000060 + - 0x81000062 + - 0x81000063 + - 0x81000064 + - 0x81000065 + - 0x81000160 + - 0x81000161 + - 0x81000162 + - 0x81000163 + - 0x81000164 + - 0x81000165 + - 0x81000166 + - 0x81000167 + - 0x81000168 + - 0x81000169 + - 0x8100016A + - 0x81000200 + - 0x81000201 + - 0x81000202 + - 0x81000203 + - 0x81000204 + - 0x81000205 + - 0x81000300 + - 0x81000301 + - 0x81000302 + - 0x81000303 + - 0x81000304 + - 0x81000305 + - 0x81000306 + - 0x81000307 + - 0x81000308 + - 0x81000309 + - 0x8100030A x-enum-descriptions: - "OK" - "ASN: Incorrect data" diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 5a79abd..63f0424 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -4,230 +4,231 @@ components: ParsingNotificationCodes: title: "ParsingNotificationCodes" type: integer + format: int64 description: "The enumeration contains possible values of notification codes returned during the RFID chip processing." enum: - - -1879048191 - - -1879048190 - - -1879048189 - - -1879048188 - - -1879048187 - - -1879048186 - - -1879048184 - - -1879048178 - - -1879048177 - - -1879048176 - - -1879048169 - - -1879047680 - - -1879047679 - - -1879047678 - - -1879047677 - - -1879047676 - - -1879047675 - - -1879047674 - - -1879047673 - - -1879047672 - - -1879047671 - - -1879047670 - - -1879047669 - - -1879047668 - - -1879047667 - - -1879047666 - - -1879047665 - - -1879047664 - - -1879047663 - - -1879047662 - - -1879047661 - - -1879047660 - - -1879047659 - - -1879047658 - - -1879047657 - - -1879047656 - - -1879047655 - - -1879047654 - - -1879047653 - - -1879047652 - - -1879047651 - - -1879047650 - - -1879047649 - - -1879047648 - - -1879047647 - - -1879047646 - - -1879047645 - - -1879047644 - - -1879047643 - - -1879047642 - - -1879047640 - - -1879047639 - - -1879047638 - - -1879047637 - - -1879047636 - - -1879047635 - - -1879047634 - - -1879047633 - - -1879047631 - - -1879047630 - - -1879047629 - - -1879047628 - - -1879047627 - - -1879047626 - - -1879047625 - - -1879047624 - - -1879047623 - - -1879047622 - - -1879047621 - - -1879047620 - - -1879047619 - - -1879047618 - - -1879047617 - - -1879047616 - - -1879047615 - - -1879047614 - - -1879047613 - - -1879047612 - - -1879047611 - - -1879047610 - - -1879047609 - - -1879047608 - - -1879047607 - - -1879047606 - - -1879047605 - - -1879047604 - - -1879047603 - - -1879047602 - - -1879047601 - - -1879048160 - - -1879048159 - - -1879048158 - - -1879048157 - - -1879048156 - - -1879048155 - - -1879048154 - - -1879048144 - - -1879048143 - - -1879048142 - - -1879048141 - - -1879047936 - - -1879047776 - - -1879047775 - - -1879047935 - - -1879047934 - - -1879047933 - - -1879047927 - - -1879047760 - - -1879047759 - - -1879047758 - - -1879047932 - - -1879047931 - - -1879047930 - - -1879047929 - - -1879047928 - - -1879047744 - - -1879047736 - - -1879047728 - - -1879047720 - - -1879047926 - - -1879047925 - - -1879047924 - - -1879047923 - - -1879047922 - - -1879047921 - - -1879047920 - - -1879047919 - - -1879047918 - - -1879047909 - - -1879047908 - - -1879047907 - - -1879047906 - - -1879047905 - - -1879047915 - - -1879047914 - - -1879047913 - - -1879047912 - - -1879047911 - - -1879047910 - - 139272 - - 139273 - - 139274 - - 139277 - - 139278 - - 139279 - - 139280 - - 139281 - - 139282 - - 139283 - - 139284 - - 139285 - - 139286 - - 139287 - - 139288 - - -1878982656 - - -1878917120 - - -1878851584 - - -1878786048 - - -1878720512 - - -1878654976 - - -1878589440 - - -1878523904 - - -1878458368 - - -1878392832 - - -1878327296 - - -1877999616 - - -1877934080 - - -1877868544 - - -1877803008 - - -1877737472 - - -1877671936 - - -1877606400 - - -1877540864 - - -1877475328 - - -1877409792 - - -1877344256 - - -1862270976 - - -1862270975 - - -1862270974 - - -1862270973 - - -1862270972 - - -1862270971 - - -1862270970 - - -1862270969 - - -1862270968 - - -1862270967 - - -1862270966 - - -1862270965 - - -1862270964 - - -1862270963 - - -1862270962 - - -1862270720 - - -1862270719 - - -1862270718 - - -1862270717 - - -1862270716 - - -1862270715 - - -1862270714 - - -1862270713 - - -1862270712 - - -1862270711 - - -1862270710 - - -1862270709 - - -1862270708 - - -1862270707 - - -1862270706 - - -1862270705 - - -1862270704 - - -1862270463 - - -1862270462 - - -1862270461 - - -1862270460 - - -1862270208 - - -1845493483 - - -1845493482 - - -1845493481 - - -1845493480 - - -1845493479 - - -1879047600 - - -1879047599 - - 139289 - - -1879047598 + - 0x90000001 + - 0x90000002 + - 0x90000003 + - 0x90000004 + - 0x90000005 + - 0x90000006 + - 0x90000008 + - 0x9000000E + - 0x9000000F + - 0x90000010 + - 0x90000017 + - 0x90000200 + - 0x90000201 + - 0x90000202 + - 0x90000203 + - 0x90000204 + - 0x90000205 + - 0x90000206 + - 0x90000207 + - 0x90000208 + - 0x90000209 + - 0x9000020A + - 0x9000020B + - 0x9000020C + - 0x9000020D + - 0x9000020E + - 0x9000020F + - 0x90000210 + - 0x90000211 + - 0x90000212 + - 0x90000213 + - 0x90000214 + - 0x90000215 + - 0x90000216 + - 0x90000217 + - 0x90000218 + - 0x90000219 + - 0x9000021A + - 0x9000021B + - 0x9000021C + - 0x9000021D + - 0x9000021E + - 0x9000021F + - 0x90000220 + - 0x90000221 + - 0x90000222 + - 0x90000223 + - 0x90000224 + - 0x90000225 + - 0x90000226 + - 0x90000228 + - 0x90000229 + - 0x9000022A + - 0x9000022B + - 0x9000022C + - 0x9000022D + - 0x9000022E + - 0x9000022F + - 0x90000231 + - 0x90000232 + - 0x90000233 + - 0x90000234 + - 0x90000235 + - 0x90000236 + - 0x90000237 + - 0x90000238 + - 0x90000239 + - 0x9000023A + - 0x9000023B + - 0x9000023C + - 0x9000023D + - 0x9000023E + - 0x9000023F + - 0x90000240 + - 0x90000241 + - 0x90000242 + - 0x90000243 + - 0x90000244 + - 0x90000245 + - 0x90000246 + - 0x90000247 + - 0x90000248 + - 0x90000249 + - 0x9000024A + - 0x9000024B + - 0x9000024C + - 0x9000024D + - 0x9000024E + - 0x9000024F + - 0x90000020 + - 0x90000021 + - 0x90000022 + - 0x90000023 + - 0x90000024 + - 0x90000025 + - 0x90000026 + - 0x90000030 + - 0x90000031 + - 0x90000032 + - 0x90000033 + - 0x90000100 + - 0x900001A0 + - 0x900001A1 + - 0x90000101 + - 0x90000102 + - 0x90000103 + - 0x90000109 + - 0x900001B0 + - 0x900001B1 + - 0x900001B2 + - 0x90000104 + - 0x90000105 + - 0x90000106 + - 0x90000107 + - 0x90000108 + - 0x900001C0 + - 0x900001C8 + - 0x900001D0 + - 0x900001D8 + - 0x9000010A + - 0x9000010B + - 0x9000010C + - 0x9000010D + - 0x9000010E + - 0x9000010F + - 0x90000110 + - 0x90000111 + - 0x90000112 + - 0x9000011B + - 0x9000011C + - 0x9000011D + - 0x9000011E + - 0x9000011F + - 0x90000115 + - 0x90000116 + - 0x90000117 + - 0x90000118 + - 0x90000119 + - 0x9000011A + - 0x00022008 + - 0x00022009 + - 0x0002200A + - 0x0002200D + - 0x0002200E + - 0x0002200F + - 0x00022010 + - 0x00022011 + - 0x00022012 + - 0x00022013 + - 0x00022014 + - 0x00022015 + - 0x00022016 + - 0x00022017 + - 0x00022018 + - 0x90010000 + - 0x90020000 + - 0x90030000 + - 0x90040000 + - 0x90050000 + - 0x90060000 + - 0x90070000 + - 0x90080000 + - 0x90090000 + - 0x900A0000 + - 0x900B0000 + - 0x90100000 + - 0x90110000 + - 0x90120000 + - 0x90130000 + - 0x90140000 + - 0x90150000 + - 0x90160000 + - 0x90170000 + - 0x90180000 + - 0x90190000 + - 0x901A0000 + - 0x91000000 + - 0x91000001 + - 0x91000002 + - 0x91000003 + - 0x91000004 + - 0x91000005 + - 0x91000006 + - 0x91000007 + - 0x91000008 + - 0x91000009 + - 0x9100000A + - 0x9100000B + - 0x9100000C + - 0x9100000D + - 0x9100000E + - 0x91000100 + - 0x91000101 + - 0x91000102 + - 0x91000103 + - 0x91000104 + - 0x91000105 + - 0x91000106 + - 0x91000107 + - 0x91000108 + - 0x91000109 + - 0x9100010A + - 0x9100010B + - 0x9100010C + - 0x9100010D + - 0x9100010E + - 0x9100010F + - 0x91000110 + - 0x91000201 + - 0x91000202 + - 0x91000203 + - 0x91000204 + - 0x91000300 + - 0x92000115 + - 0x92000116 + - 0x92000117 + - 0x92000118 + - 0x92000119 + - 0x90000250 + - 0x90000251 + - 0x00022019 + - 0x90000252 x-enum-descriptions: - "ASN certificate: Incorrect version" - "ASN certificate: Non-matching signature algorithm" diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index 16efc0c..5343262 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -4,122 +4,123 @@ components: RFIDErrorCodes: title: "RFIDErrorCodes" type: integer + format: int64 description: "Enumeration contains a set of error codes returned by SDK" enum: - - -2147458430 - - -2147458429 - - -2147458112 - - -2147458111 - - -2147456637 - - -2147456636 - - -2147456635 - - -2147456384 - - -2147456382 - - -2147456376 - - -2147456256 - - -2147418111 - - -2147418110 - - -2147418108 - - -2147418107 - - -2147418106 - - -2147418104 - - -2147418103 - - -2147418102 - - -2147418101 - - -2147418100 - - -2147352576 - - -2147352575 - - -2147352574 - - -2147352573 - - -2147352572 - - -2147352571 - - -2147352570 - - -2147352560 - - -2146409536 - - -2097152000 - - -2097151999 - - -2097151998 - - -2097151984 - - -2097151983 - - -2097151982 - - -2097151981 - - -2097151980 - - -2097151979 - - -2097151978 - - -2097151977 - - -2097151976 - - -2097151975 - - -2097151974 - - -2097151973 - - -2097151972 - - -2097151968 - - -2097151967 - - -2097151966 - - -2097151965 - - -2097151964 - - -2097151963 - - -2097151962 - - -2097151961 - - -2097151960 - - -2097151959 - - -2097151958 - - -2097151952 - - -2097151951 - - -2097151936 - - -2097151935 - - -2097151934 - - -2097151920 - - -2097151919 - - -2097151918 - - -2097151904 - - -2097086464 - - -2097020928 - - -2096955392 - - -2096889856 - - -2096824320 - - -2096758784 - - -2096693248 - - -2096627712 - - -2080374784 - - -2080309248 - - -2080243712 - - -2080178176 - - -2080112640 - - -2080047104 - - -2079981568 - - -2079916032 - - -2079850496 - - -2079784960 - - -2079719424 - - -2079653888 - - -2079588352 - - -2079522816 - - -2079457280 - - -2079391744 - - -2046820352 - - -2046820351 - - -2046820096 - - -2046820095 - - -2046820094 - - -2046820093 - - -2046819840 - - -2046819839 - - -2046819838 - - -2046819837 - - -2046819836 - - -2046819584 - - -2046819583 - - -2046819582 - - -2046819581 - - -2046819580 - - -2046819579 - - -2046819578 - - -2046819577 - - -2046819576 - - -2046819575 - - -1 - - 1 - - 2 + - 0x80006282 + - 0x80006283 + - 0x800063C0 + - 0x800063C1 + - 0x80006983 + - 0x80006984 + - 0x80006985 + - 0x80006A80 + - 0x80006A82 + - 0x80006A88 + - 0x80006B00 + - 0x80010001 + - 0x80010002 + - 0x80010004 + - 0x80010005 + - 0x80010006 + - 0x80010008 + - 0x80010009 + - 0x8001000A + - 0x8001000B + - 0x8001000C + - 0x80020000 + - 0x80020001 + - 0x80020002 + - 0x80020003 + - 0x80020004 + - 0x80020005 + - 0x80020006 + - 0x80020010 + - 0x801063C0 + - 0x83000000 + - 0x83000001 + - 0x83000002 + - 0x83000010 + - 0x83000011 + - 0x83000012 + - 0x83000013 + - 0x83000014 + - 0x83000015 + - 0x83000016 + - 0x83000017 + - 0x83000018 + - 0x83000019 + - 0x8300001A + - 0x8300001B + - 0x8300001C + - 0x83000020 + - 0x83000021 + - 0x83000022 + - 0x83000023 + - 0x83000024 + - 0x83000025 + - 0x83000026 + - 0x83000027 + - 0x83000028 + - 0x83000029 + - 0x8300002A + - 0x83000030 + - 0x83000031 + - 0x83000040 + - 0x83000041 + - 0x83000042 + - 0x83000050 + - 0x83000051 + - 0x83000052 + - 0x83000060 + - 0x83010000 + - 0x83020000 + - 0x83030000 + - 0x83040000 + - 0x83050000 + - 0x83060000 + - 0x83070000 + - 0x83080000 + - 0x84000000 + - 0x84010000 + - 0x84020000 + - 0x84030000 + - 0x84040000 + - 0x84050000 + - 0x84060000 + - 0x84070000 + - 0x84080000 + - 0x84090000 + - 0x840A0000 + - 0x840B0000 + - 0x840C0000 + - 0x840D0000 + - 0x840E0000 + - 0x840F0000 + - 0x86000000 + - 0x86000001 + - 0x86000100 + - 0x86000101 + - 0x86000102 + - 0x86000103 + - 0x86000200 + - 0x86000201 + - 0x86000202 + - 0x86000203 + - 0x86000204 + - 0x86000300 + - 0x86000301 + - 0x86000302 + - 0x86000303 + - 0x86000304 + - 0x86000305 + - 0x86000306 + - 0x86000307 + - 0x86000308 + - 0x86000309 + - 0xFFFFFFFF + - 0x00000001 + - 0x00000002 x-enum-descriptions: - "LAYER6: Reading beyond EOF / Unexpected EOF" - "LAYER6: PWD deactivated" From ba843ffae0618c6178f3a6911b0fb907e03ec695 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 30 Jan 2025 14:03:42 +0300 Subject: [PATCH 031/106] SP-18211 - update enums --- rt-image-quality.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 667e1b2..edb9a19 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -64,6 +64,7 @@ components: - "Signals if the document image is bright enough" InputImageQualityChecks: + title: "InputImageQualityChecks" type: string description: "Input image quality checks for the document processing" enum: From d61fecc6741c54cd0ae66c374b62dfc302cc3661 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 4 Feb 2025 15:18:17 +0300 Subject: [PATCH 032/106] SP-18211 - update open api version, remove description from ref+description --- authenticity/e-check-diagnose.yml | 2 +- authenticity/e-critical.yml | 2 +- authenticity/e-result-type.yml | 2 +- authenticity/e-visibility.yml | 2 +- authenticity/rt-fiber.yml | 5 +- authenticity/rt-ident.yml | 8 +- authenticity/rt-ocr-security-text.yml | 2 +- authenticity/rt-photo-ident.yml | 2 +- authenticity/rt-security-feature.yml | 2 +- common.yml | 2 +- e-barcode-type.yml | 2 +- e-document-type.yml | 2 +- e-graphic-field-type.yml | 2 +- e-lcid.yml | 2 +- e-parsing-error-codes.yml | 2 +- e-parsing-notification-codes.yml | 2 +- e-rfid-data-file-type.yml | 2 +- e-rfid-data-group-type-tag.yml | 2 +- e-rfid-error-codes.yml | 2 +- e-rfid-pkd-resourcetype.yml | 2 +- e-security-feature-type.yml | 2 +- e-text-field-type.yml | 2 +- index.yml | 14 +-- p-healthcheck.yml | 2 +- p-ping.yml | 2 +- p-process.yml | 15 ++-- p-transaction.yml | 2 +- rt-authenticity.yml | 4 +- rt-barcodes.yml | 2 +- rt-byte-array-data.yml | 2 +- rt-doc-type-old.yml | 7 +- rt-document-position.yml | 2 +- rt-encrypted-rcl.yml | 2 +- rt-image-data.yml | 4 +- rt-image-quality.yml | 6 +- rt-images.yml | 10 +-- rt-license.yml | 2 +- rt-ocr-lexical-analysis.yml | 3 +- rt-raw-image.yml | 2 +- rt-rfid-binary-data.yml | 8 +- rt-status.yml | 68 +++++--------- rt-text-data.yml | 11 +-- rt-text.yml | 29 +++--- rt.yml | 123 ++++---------------------- 44 files changed, 119 insertions(+), 254 deletions(-) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index a6a5a15..77cb380 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: CheckDiagnose: diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml index f2f621c..1e401cf 100644 --- a/authenticity/e-critical.yml +++ b/authenticity/e-critical.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: Critical: diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index b21d263..93a5c2c 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: AuthenticityResultType: diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml index a77e52e..bf9dfda 100644 --- a/authenticity/e-visibility.yml +++ b/authenticity/e-visibility.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: Visibility: diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index 0451861..c56dce3 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: FiberResult: @@ -21,8 +21,7 @@ components: ExpectedCount: description: "Expected fibers number. For UV_Fibers authentication result type" type: integer - LightValue: - description: "For UV_Background authentication result type" + LightValue: # For UV_Background authentication result type $ref: "../common.yml#/components/schemas/Light" LightDisp: description: "For UV_Background authentication result type" diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index 6e99a4f..b6c049a 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: IdentResult: @@ -18,11 +18,9 @@ components: $ref: "../common.yml#/components/schemas/Light" Area: $ref: "../common.yml#/components/schemas/RectangleCoordinates" - Image: - description: "Original image" + Image: # Original image $ref: "../common.yml#/components/schemas/ImageData" - EtalonImage: - description: "Reference image" + EtalonImage: # Reference image $ref: "../common.yml#/components/schemas/ImageData" AreaList: $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index 1bacbce..f396c06 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: OCRSecurityTextResult: diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 19d1070..2cee779 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: PhotoIdentResult: diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index bac38f3..814951d 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: SecurityFeatureResult: diff --git a/common.yml b/common.yml index 22fa445..a93d4d5 100644 --- a/common.yml +++ b/common.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: parameters: x-request: diff --git a/e-barcode-type.yml b/e-barcode-type.yml index d961cee..2c541d7 100644 --- a/e-barcode-type.yml +++ b/e-barcode-type.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: BarcodeType: diff --git a/e-document-type.yml b/e-document-type.yml index 9fe94c4..b6e7c25 100644 --- a/e-document-type.yml +++ b/e-document-type.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: DocumentType: diff --git a/e-graphic-field-type.yml b/e-graphic-field-type.yml index 64d2979..18ff324 100644 --- a/e-graphic-field-type.yml +++ b/e-graphic-field-type.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: GraphicFieldName: diff --git a/e-lcid.yml b/e-lcid.yml index 780c13f..c67d29e 100644 --- a/e-lcid.yml +++ b/e-lcid.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: LCID: diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 8d85f1c..6c97e2d 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: ParsingErrorCodes: diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 63f0424..0af2eef 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: ParsingNotificationCodes: diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index e6c9a99..11e0806 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: RfidDataFileType: diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml index 9f72811..a445861 100644 --- a/e-rfid-data-group-type-tag.yml +++ b/e-rfid-data-group-type-tag.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: RfidDataGroupTypeTag: diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index 5343262..ad12d25 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: RFIDErrorCodes: diff --git a/e-rfid-pkd-resourcetype.yml b/e-rfid-pkd-resourcetype.yml index 20a2f4a..f0401a1 100644 --- a/e-rfid-pkd-resourcetype.yml +++ b/e-rfid-pkd-resourcetype.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: RFIDPKDResourceType: diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index ccca84a..0e7e893 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: SecurityFeatureType: diff --git a/e-text-field-type.yml b/e-text-field-type.yml index ea10d45..4121932 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: TextFieldType: diff --git a/index.yml b/index.yml index 401ddd5..4eb0a13 100644 --- a/index.yml +++ b/index.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 info: version: 7.4.0 title: Regula Document Reader Web API @@ -26,17 +26,17 @@ paths: /api/process: $ref: "./p-process.yml#/paths/~1process" /api/v2/transaction/{transactionId}/process: - $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1process" + $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1process" /api/v2/transaction/{transactionId}: - $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}" + $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D" /api/v2/transaction/{transactionId}/results: - $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1results" + $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1results" /api/v2/transaction/{transactionId}/file: - $ref: "./p-transaction.yml#/paths/~1transaction~1{transactionId}~1file" + $ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1file" /api/v2/tag/{tagId}: - $ref: "./p-transaction.yml#/paths/~1tag~1{tagId}" + $ref: "./p-transaction.yml#/paths/~1tag~1%7BtagId%7D" /api/v2/tag/{tagId}/transactions: - $ref: "./p-transaction.yml#/paths/~1tag~1{tagId}~1transactions" + $ref: "./p-transaction.yml#/paths/~1tag~1%7BtagId%7D~1transactions" /api/ping: $ref: "./p-ping.yml#/paths/~1ping" /api/healthz: diff --git a/p-healthcheck.yml b/p-healthcheck.yml index b87c5ac..617e8c5 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 paths: /healthz: diff --git a/p-ping.yml b/p-ping.yml index 167aecc..aec0291 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 info: version: 7.4.0 title: Regula Document Reader Web API diff --git a/p-process.yml b/p-process.yml index 225b480..302c692 100644 --- a/p-process.yml +++ b/p-process.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 info: version: 7.4.0 title: Regula Document Reader Web API @@ -267,9 +267,7 @@ components: By default it is set to system locale default (where the service is running)." type: string example: "MM/dd/yyyy" - measureSystem: - description: "This option allows you to set the system of measurement used for converting original values - in document to output result values. Metric by default." + measureSystem: # This option allows you to set the system of measurement used for converting original values in document to output result values. Metric by default. $ref: "#/components/schemas/MeasureSystem" imageDpiOutMax: description: "This parameter controls maximum resolution in dpi of output images. @@ -297,8 +295,7 @@ components: description: "When enabled, results will contain transaction processing log. Disabled by default" type: boolean # default false - logLevel: - description: "When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default." + logLevel: # When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default. $ref: "#/components/schemas/LogLevel" # default: "INFO" forceDocID: @@ -341,8 +338,7 @@ components: type: boolean deprecated: true # default: false - forceDocFormat: - description: "Force use of specified document format when locating and recognizing document to reduce the number of candidates." + forceDocFormat: # Force use of specified document format when locating and recognizing document to reduce the number of candidates. $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" noGraphics: description: "When enabled, no graphic fields will be cropped from document image. Disabled by default." @@ -387,8 +383,7 @@ components: description: "This option can be disabled to stop parsing after barcode is read. Enabled by default." type: boolean # default true - convertCase: - description: "This option allows output text case transformation. No changes applied by default to original values." + convertCase: # This option allows output text case transformation. No changes applied by default to original values. $ref: "#/components/schemas/TextPostProcessing" splitNames: description: "When enabled, the Surname and GivenNames fields from MRZ will be divided into diff --git a/p-transaction.yml b/p-transaction.yml index a630bee..eb2d5fd 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 info: version: 7.4.0 title: Regula Document Reader Web API diff --git a/rt-authenticity.yml b/rt-authenticity.yml index f6709b9..d9d0ab5 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -1,4 +1,4 @@ -openapi: 3.1.0 +openapi: 3.1.1 components: schemas: AuthenticityResult: @@ -46,7 +46,7 @@ components: List: type: array items: - anyOf: + oneOf: - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" diff --git a/rt-barcodes.yml b/rt-barcodes.yml index ce5283a..605d761 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: DocBarCodeInfo: diff --git a/rt-byte-array-data.yml b/rt-byte-array-data.yml index 52309df..ef6f4c6 100644 --- a/rt-byte-array-data.yml +++ b/rt-byte-array-data.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: ByteArrayResult: diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index 9f1e299..52edebf 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: ChosenDocumentTypeResult: @@ -30,8 +30,7 @@ components: title: "DocumentTypesCandidatesList" type: object properties: - RecResult: - description: "Overall recognition result" + RecResult: # Overall recognition result $ref: "#/components/schemas/DocumentTypeRecognitionResult" Candidates: type: array @@ -88,7 +87,7 @@ components: description: "true if the document of the given type is rotated by 180 degrees" type: boolean RFID_Presence: - description: "Indication of the presence of an RFID chip in the document (electronic document indicator)" + description: # Indication of the presence of an RFID chip in the document (electronic document indicator) $ref: "./common.yml#/components/schemas/RfidLocation" FDSIDList: $ref: "#/components/schemas/FDSIDList" diff --git a/rt-document-position.yml b/rt-document-position.yml index f427b16..6bcacca 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: DocumentPositionResult: diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml index edc5976..ce1513f 100644 --- a/rt-encrypted-rcl.yml +++ b/rt-encrypted-rcl.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: EncryptedRCLResult: diff --git a/rt-image-data.yml b/rt-image-data.yml index 9c13170..00919a7 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: GraphicsResult: @@ -24,7 +24,7 @@ components: pArrayFields: type: array items: - anyOf: + oneOf: - $ref: "#/components/schemas/GraphicFieldRect" - $ref: "#/components/schemas/GraphicFieldRfid" nFields: diff --git a/rt-image-quality.yml b/rt-image-quality.yml index edb9a19..140f436 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: ImageQualityResult: @@ -20,8 +20,7 @@ components: - List - Count properties: - result: - description: "Overall image quality status, combined from check statuses in the list." + result: # Overall image quality status, combined from check statuses in the list. $ref: "./common.yml#/components/schemas/CheckResult" List: type: array @@ -95,7 +94,6 @@ components: - "Signals if the portrait is present" - "Signals if the document image is bright enough" - AreaArray: title: "AreaArray" type: object diff --git a/rt-images.yml b/rt-images.yml index 7d6f398..95403e5 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: ImagesResult: @@ -82,8 +82,7 @@ components: $ref: "./common.yml#/components/schemas/Source" value: $ref: "./common.yml#/components/schemas/ImageBase64" - originalValue: - description: "Only for images from RFID. Image as was originally stored in the RFID chip." + originalValue: # Only for images from RFID. Image as was originally stored in the RFID chip. $ref: "./common.yml#/components/schemas/ImageBase64" originalPageIndex: description: "Original page index" @@ -94,9 +93,8 @@ components: $ref: "./common.yml#/components/schemas/Light" containerType: $ref: "./rt.yml#/components/schemas/ContainerType" - fieldRect: - description: "Only for images from VISUAL. Coordinates of the image in the normalized image of the document." + fieldRect: # Only for images from VISUAL. Coordinates of the image in the normalized image of the document. $ref: "./common.yml#/components/schemas/RectangleCoordinates" rfidOrigin: - description: "Only for images from RFID. Image location in RFID chip." + description: # Only for images from RFID. Image location in RFID chip. $ref: "./common.yml#/components/schemas/RfidOrigin" diff --git a/rt-license.yml b/rt-license.yml index b89d64f..736e8f1 100644 --- a/rt-license.yml +++ b/rt-license.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: LicenseResult: diff --git a/rt-ocr-lexical-analysis.yml b/rt-ocr-lexical-analysis.yml index 1e01fac..0979e86 100644 --- a/rt-ocr-lexical-analysis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: LexicalAnalysisResult: @@ -58,7 +58,6 @@ components: type: string Matrix: $ref: "#/components/schemas/ComparisonMatrix" - example: {FieldType: 185, Field_MRZ: "37", Field_Visual: "37", Matrix: [1,0,0,0,0,3,0,0,0,0]} diff --git a/rt-raw-image.yml b/rt-raw-image.yml index e3206d4..a6e391e 100644 --- a/rt-raw-image.yml +++ b/rt-raw-image.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: DocumentImageResult: diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 258cb92..ed4d87d 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: DocumentBinaryInfoResult: @@ -601,13 +601,13 @@ components: - Data properties: Type: - anyOf: + oneOf: - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" Status: description: "Result of logical analysis of compliance of the contents of the field with the requirements of the specification" - anyOf: + oneOf: - $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" Format: @@ -754,7 +754,7 @@ components: properties: Type: description: "Logical type of the field" - anyOf: + oneOf: - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" Status: diff --git a/rt-status.yml b/rt-status.yml index 59d2a5e..26ef696 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: StatusResult: @@ -12,11 +12,6 @@ components: $ref: "#/components/schemas/Status" - $ref: "./rt.yml#/components/schemas/ResultItem" - - # $ref with description doesnt work right now, waiting for OAS 3.1 (comming soon) - # allOf should be used here to replace description from CheckResult - # see https://github.com/OAI/OpenAPI-Specification/issues/556#issuecomment-192007034 - # but java codegen produce invalid code for allOf `int complete=null` Status: title: "Status" type: object @@ -28,30 +23,24 @@ components: - stopList - detailsOptical properties: - overallStatus: - description: "Overall checks status. Rootx status." + overallStatus: # Overall checks status. Rootx status $ref: "./common.yml#/components/schemas/CheckResult" - optical: - description: "Overall optical checks combined status" + optical: # Overall optical checks combined status $ref: "./common.yml#/components/schemas/CheckResult" - portrait: - description: "Portrait comparison status" + portrait: # Portrait comparison status $ref: "./common.yml#/components/schemas/CheckResult" - rfid: - description: "Overall RFID checks combined status" + rfid: # Overall RFID checks combined status $ref: "./common.yml#/components/schemas/CheckResult" - stopList: - description: "Stop list check status" + stopList: # Stop list check status $ref: "./common.yml#/components/schemas/CheckResult" detailsRFID: - description: "Details on performed RFID checks" $ref: "#/components/schemas/detailsRFID" detailsOptical: - description: "Details on performed optical checks" $ref: "#/components/schemas/detailsOptical" detailsOptical: title: "detailsOptical" + description: "Details on performed optical checks" type: object required: - overallStatus @@ -63,33 +52,27 @@ components: - security - text properties: - overallStatus: - description: "Overall optical checks combined status" + overallStatus: # Overall optical checks combined status $ref: "./common.yml#/components/schemas/CheckResult" - docType: - description: "Status of document type recognition" + docType: # Status of document type recognition $ref: "./common.yml#/components/schemas/CheckResult" - expiry: - description: "Status of document expiration" + expiry: # Status of document expiration $ref: "./common.yml#/components/schemas/CheckResult" - imageQA: - description: "Status of document image quality check" + imageQA: # Status of document image quality check $ref: "./common.yml#/components/schemas/CheckResult" - mrz: - description: "Status of document MRZ" + mrz: # Status of document MRZ $ref: "./common.yml#/components/schemas/CheckResult" pagesCount: description: "Number of processed pages in the document" type: integer - security: - description: "Authenticity verification status" + security: # Authenticity verification status $ref: "./common.yml#/components/schemas/CheckResult" - text: - description: "Status of text fields analysis" + text: # Status of text fields analysis $ref: "./common.yml#/components/schemas/CheckResult" detailsRFID: title: "detailsRFID" + description: "Details on performed RFID checks" type: object required: - overallStatus @@ -100,24 +83,17 @@ components: - PACE - TA properties: - overallStatus: - description: "Overall RFID checks combined status" + overallStatus: # Overall RFID checks combined status $ref: "./common.yml#/components/schemas/CheckResult" - AA: - description: "Active Authentication status" + AA: # Active Authentication status $ref: "./common.yml#/components/schemas/CheckResult" - BAC: - description: "Basic Access Control (BAC) status" + BAC: # Basic Access Control (BAC) status $ref: "./common.yml#/components/schemas/CheckResult" - CA: - description: "Chip Authentication status" + CA: # Chip Authentication status $ref: "./common.yml#/components/schemas/CheckResult" - PA: - description: "Passive Authentication status" + PA: # Passive Authentication status $ref: "./common.yml#/components/schemas/CheckResult" - PACE: - description: "Password Authenticated Connection Establishment (PACE) status" + PACE: # Password Authenticated Connection Establishment (PACE) status $ref: "./common.yml#/components/schemas/CheckResult" - TA: - description: "Terminal Authentication status" + TA: # Terminal Authentication status $ref: "./common.yml#/components/schemas/CheckResult" diff --git a/rt-text-data.yml b/rt-text-data.yml index 10944c3..6cd065d 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: TextDataResult: @@ -28,7 +28,7 @@ components: pArrayFields: type: array items: - anyOf: + oneOf: - $ref: "#/components/schemas/DocVisualExtendedFieldRect" - $ref: "#/components/schemas/DocVisualExtendedFieldRfid" @@ -58,9 +58,7 @@ components: allOf: - type: object properties: - FieldRect: - description: "Coordinates of the text field in the normalized image of the document. - Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." + FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. $ref: "./common.yml#/components/schemas/RectangleCoordinates" - $ref: "#/components/schemas/DocVisualExtendedField" @@ -139,8 +137,7 @@ components: - CandidatesCount - ListOfCandidates properties: - SymbolRect: - description: "Coordinates of the symbol in the normalized image of the document" + SymbolRect: # Coordinates of the symbol in the normalized image of the document $ref: "./common.yml#/components/schemas/RectangleCoordinates" CandidatesCount: description: "Number of significant elements of ListOfCandidates array" diff --git a/rt-text.yml b/rt-text.yml index 81bdc08..023f998 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: TextResult: @@ -24,14 +24,11 @@ components: - fieldList - availableSourceList properties: - status: - description: "Overall status of all checks from all text fields" + status: # Overall status of all checks from all text fields $ref: "./common.yml#/components/schemas/CheckResult" - validityStatus: - description: "Overall status of validity from all text fields from all sources" + validityStatus: # Overall status of validity from all text fields from all sources $ref: "./common.yml#/components/schemas/CheckResult" - comparisonStatus: - description: "Overall status of data comparison from different sources for each text field" + comparisonStatus: # Overall status of data comparison from different sources for each text field $ref: "./common.yml#/components/schemas/CheckResult" dateFormat: description: "Date format" @@ -71,14 +68,11 @@ components: lcidName: description: "LCID name" type: string - status: - description: "Overall status of all checks from all values" + status: # Overall status of all checks from all values $ref: "./common.yml#/components/schemas/CheckResult" - validityStatus: - description: "Overall status of validity from all values" + validityStatus: # Overall status of validity from all values $ref: "./common.yml#/components/schemas/CheckResult" - comparisonStatus: - description: "Overall status of data comparison from different sources" + comparisonStatus: # Overall status of data comparison from different sources $ref: "./common.yml#/components/schemas/CheckResult" value: description: "The most confidence value, selected from valueList" @@ -132,11 +126,9 @@ components: type: integer minimum: 0 maximum: 100 - fieldRect: - description: "Only for visual and mrz results. Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)" + fieldRect: # Only for visual and mrz results. Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom) $ref: "./common.yml#/components/schemas/RectangleCoordinates" - rfidOrigin: - description: "Only for rfid images. Text location in rfid chip." + rfidOrigin: # Only for rfid images. Text location in rfid chip. $ref: "./common.yml#/components/schemas/RfidOrigin" OriginalSymbol: @@ -194,8 +186,7 @@ components: properties: source: $ref: "./common.yml#/components/schemas/Source" - validityStatus: - description: "Overall status of validity from all fields for given source" + validityStatus: # Overall status of validity from all fields for given source $ref: "./common.yml#/components/schemas/CheckResult" containerType: $ref: "./rt.yml#/components/schemas/ContainerType" diff --git a/rt.yml b/rt.yml index c4b198f..78c3e07 100644 --- a/rt.yml +++ b/rt.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: ContainerType: @@ -130,40 +130,6 @@ components: type: integer result_type: $ref: "#/components/schemas/ContainerType" - discriminator: - propertyName: result_type - mapping: - 1: "DocumentImageResult" - 3: "TextDataResult" - 5: "DocBarCodeInfo" - 6: "GraphicsResult" - 8: "DocumentTypesCandidatesResult" - 9: "ChosenDocumentTypeResult" - 15: "LexicalAnalysisResult" - 16: "DocumentImageResult" - 17: "TextDataResult" - 18: "TextDataResult" - 19: "GraphicsResult" - 20: "AuthenticityResult" - 26: "TextDataResult" - 30: "ImageQualityResult" - 32: "GraphicsResult" - 33: "StatusResult" - 34: "AuthenticityResult" - 35: "GraphicsResult" - 36: "TextResult" - 37: "ImagesResult" - 38: "GraphicsResult" - 39: "AuthenticityResult" - 49: "EncryptedRCLResult" - 50: "LicenseResult" - 61: "DocumentPositionResult" - 62: "DocumentPositionResult" - 85: "DocumentPositionResult" - 102: "TextDataResult" - 103: "GraphicsResult" - 104: "DocumentBinaryInfoResult" - 109: "ByteArrayResult" ContainerList: title: "ContainerList" @@ -179,72 +145,21 @@ components: List: type: array items: - anyOf: - - $ref: "#/components/schemas/StatusResult" - - $ref: "#/components/schemas/TextResult" - - $ref: "#/components/schemas/DocumentImageResult" - - $ref: "#/components/schemas/ImagesResult" - - $ref: "#/components/schemas/ChosenDocumentTypeResult" - - $ref: "#/components/schemas/DocumentTypesCandidatesResult" - - $ref: "#/components/schemas/TextDataResult" - - $ref: "#/components/schemas/GraphicsResult" - - $ref: "#/components/schemas/LexicalAnalysisResult" - - $ref: "#/components/schemas/AuthenticityResult" - - $ref: "#/components/schemas/ImageQualityResult" - - $ref: "#/components/schemas/DocumentPositionResult" - - $ref: "#/components/schemas/DocBarCodeInfo" - - $ref: "#/components/schemas/LicenseResult" - - $ref: "#/components/schemas/EncryptedRCLResult" - - $ref: "#/components/schemas/DocumentBinaryInfoResult" - - $ref: "#/components/schemas/ByteArrayResult" - - StatusResult: - $ref: "./rt-status.yml#/components/schemas/StatusResult" - - TextResult: - $ref: "./rt-text.yml#/components/schemas/TextResult" - - DocumentImageResult: - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" - - ImagesResult: - $ref: "./rt-images.yml#/components/schemas/ImagesResult" - - ChosenDocumentTypeResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" - - DocumentTypesCandidatesResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" - - TextDataResult: - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" - - GraphicsResult: - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" - - ByteArrayResult: - $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayResult" - - LexicalAnalysisResult: - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" - - AuthenticityResult: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" - - ImageQualityResult: - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" - - DocumentPositionResult: - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" - - DocBarCodeInfo: - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" - - LicenseResult: - $ref: "./rt-license.yml#/components/schemas/LicenseResult" - - EncryptedRCLResult: - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" - - DocumentBinaryInfoResult: - $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" + oneOf: + - $ref: "./rt-status.yml#/components/schemas/StatusResult" + - $ref: "./rt-text.yml#/components/schemas/TextResult" + - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" + - $ref: "./rt-images.yml#/components/schemas/ImagesResult" + - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" + - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" + - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" + - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" + - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" + - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" + - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" + - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" + - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" + - $ref: "./rt-license.yml#/components/schemas/LicenseResult" + - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + - $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" + - $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayResult" From eab0e2b9a50b32c0ebb914b82e3a18c2b6d4ef48 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 14 Feb 2025 16:49:40 +0300 Subject: [PATCH 033/106] SP-18211 - add discriminator --- rt.yml | 119 ++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 102 insertions(+), 17 deletions(-) diff --git a/rt.yml b/rt.yml index 78c3e07..0fce66e 100644 --- a/rt.yml +++ b/rt.yml @@ -146,20 +146,105 @@ components: type: array items: oneOf: - - $ref: "./rt-status.yml#/components/schemas/StatusResult" - - $ref: "./rt-text.yml#/components/schemas/TextResult" - - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" - - $ref: "./rt-images.yml#/components/schemas/ImagesResult" - - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" - - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" - - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" - - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" - - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" - - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" - - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" - - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" - - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" - - $ref: "./rt-license.yml#/components/schemas/LicenseResult" - - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" - - $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" - - $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayResult" + - $ref: "#/components/schemas/StatusResult" + - $ref: "#/components/schemas/TextResult" + - $ref: "#/components/schemas/DocumentImageResult" + - $ref: "#/components/schemas/ImagesResult" + - $ref: "#/components/schemas/ChosenDocumentTypeResult" + - $ref: "#/components/schemas/DocumentTypesCandidatesResult" + - $ref: "#/components/schemas/TextDataResult" + - $ref: "#/components/schemas/GraphicsResult" + - $ref: "#/components/schemas/LexicalAnalysisResult" + - $ref: "#/components/schemas/AuthenticityResult" + - $ref: "#/components/schemas/ImageQualityResult" + - $ref: "#/components/schemas/DocumentPositionResult" + - $ref: "#/components/schemas/DocBarCodeInfo" + - $ref: "#/components/schemas/LicenseResult" + - $ref: "#/components/schemas/EncryptedRCLResult" + - $ref: "#/components/schemas/DocumentBinaryInfoResult" + - $ref: "#/components/schemas/ByteArrayResult" + discriminator: + propertyName: result_type + mapping: + 1: "DocumentImageResult" + 3: "TextDataResult" + 5: "DocBarCodeInfo" + 6: "GraphicsResult" + 8: "DocumentTypesCandidatesResult" + 9: "ChosenDocumentTypeResult" + 15: "LexicalAnalysisResult" + 16: "DocumentImageResult" + 17: "TextDataResult" + 18: "TextDataResult" + 19: "GraphicsResult" + 20: "AuthenticityResult" + 26: "TextDataResult" + 30: "ImageQualityResult" + 32: "GraphicsResult" + 33: "StatusResult" + 34: "AuthenticityResult" + 35: "GraphicsResult" + 36: "TextResult" + 37: "ImagesResult" + 38: "GraphicsResult" + 39: "AuthenticityResult" + 49: "EncryptedRCLResult" + 50: "LicenseResult" + 61: "DocumentPositionResult" + 62: "DocumentPositionResult" + 85: "DocumentPositionResult" + 102: "TextDataResult" + 103: "GraphicsResult" + 104: "DocumentBinaryInfoResult" + 109: "ByteArrayResult" + + StatusResult: + $ref: "./rt-status.yml#/components/schemas/StatusResult" + + TextResult: + $ref: "./rt-text.yml#/components/schemas/TextResult" + + DocumentImageResult: + $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" + + ImagesResult: + $ref: "./rt-images.yml#/components/schemas/ImagesResult" + + ChosenDocumentTypeResult: + $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" + + DocumentTypesCandidatesResult: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" + + TextDataResult: + $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" + + GraphicsResult: + $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" + + ByteArrayResult: + $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayResult" + + LexicalAnalysisResult: + $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" + + AuthenticityResult: + $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" + + ImageQualityResult: + $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" + + DocumentPositionResult: + $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" + + DocBarCodeInfo: + $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" + + LicenseResult: + $ref: "./rt-license.yml#/components/schemas/LicenseResult" + + EncryptedRCLResult: + $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + + DocumentBinaryInfoResult: + $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" From 1d72ac3561cb00b47d9f4f86cba888b0dd501d5f Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 17 Feb 2025 10:36:03 +0300 Subject: [PATCH 034/106] SP-18211 - update types --- rt-text-data.yml | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/rt-text-data.yml b/rt-text-data.yml index 6cd065d..2570483 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -44,11 +44,13 @@ components: properties: RFID_OriginDG: $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" - RFID_OriginDGTag: {} + RFID_OriginDGTag: + type: integer RFID_OriginTagEntry: description: "Record index of the text field source in the data group" type: number - RFID_OriginEntryView: {} + RFID_OriginEntryView: + type: integer - $ref: "#/components/schemas/DocVisualExtendedField" DocVisualExtendedFieldRect: @@ -75,7 +77,8 @@ components: - Buf_Length - Buf_Text properties: - FieldType: {} + FieldType: + type: integer wFieldType: $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" FieldName: @@ -97,11 +100,12 @@ components: type: string description: "Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'" - FieldMask: {} - Validity: {} - InComparison: {} - Reserved2: {} - Reserved3: {} + FieldMask: + type: string + Validity: + type: integer + InComparison: + type: integer StringRecognitionResult: title: "StringRecognitionResult" @@ -114,7 +118,6 @@ components: SymbolsCount: description: "Number of StringResult array elements" type: number - Reserved: {} StringResult: type: array description: "Array of recognition results for individual characters of a string" @@ -148,7 +151,6 @@ components: (the first element has highest probability)" items: $ref: "#/components/schemas/SymbolCandidate" - Reserved: {} SymbolCandidate: title: "SymbolCandidate" @@ -166,4 +168,3 @@ components: description: "character recognition probability (0–100,%)" minimum: 0 maximum: 100 - Reserved: {} From 634171469f86bc5d294f0b0d3eb68967812c35ba Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 17 Feb 2025 12:50:17 +0300 Subject: [PATCH 035/106] SP-18211 - add AuthenticityCheckResult discriminator --- rt-authenticity.yml | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/rt-authenticity.yml b/rt-authenticity.yml index d9d0ab5..4c501fc 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -52,6 +52,46 @@ components: - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" + discriminator: + propertyName: Type + mapping: + 1: "SecurityFeatureResult" + 2: "SecurityFeatureResult" + 4: "IdentResult" + 8: "SecurityFeatureResult" + 16: "FiberResult" + 32: "IdentResult" + 64: "OCRSecurityTextResult" + 128: "PhotoIdentResult" + 256: "PhotoIdentResult" + 512: "SecurityFeatureResult" + 1024: "IdentResult" + 2048: "IdentResult" + 4096: "SecurityFeatureResult" + 8192: "SecurityFeatureResult" + 16384: "FiberResult" + 32768: "IdentResult" + 65536: "SecurityFeatureResult" + 131072: "IdentResult" + 262144: "IdentResult" + 524288: "IdentResult" + 1048576: "IdentResult" + 8388608: "SecurityFeatureResult" + + SecurityFeatureResult: + $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" + + IdentResult: + $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" + + FiberResult: + $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" + + OCRSecurityTextResult: + $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" + + PhotoIdentResult: + $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" AuthenticityType: title: "AuthenticityType" From e68fc5d69fa4ea20f55e4eaefeef7e6b1d11f423 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 17 Feb 2025 14:51:55 +0300 Subject: [PATCH 036/106] SP-18211 - remove boolean enum --- p-transaction.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/p-transaction.yml b/p-transaction.yml index eb2d5fd..e33eaed 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -74,9 +74,6 @@ paths: name: withImages schema: type: boolean - enum: - - true - - false description: With base64 images or url summary: Get Reprocess transaction result tags: From 16c746c69ecf30ee8d25599844779b24d8bd701e Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 21 Feb 2025 11:34:39 +0300 Subject: [PATCH 037/106] SP-18211 - add healthcheck metadata --- p-healthcheck.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index 617e8c5..3369803 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -67,6 +67,9 @@ components: description: Product version. type: string nullable: true + metadata: + type: object + additionalProperties: true documentsDatabase: description: Database information. type: object From e18c0bd23b0a6e66d4fa69be43f58d25c202653b Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 21 Feb 2025 13:30:43 +0300 Subject: [PATCH 038/106] SP-18211 - add CoreLibResultCode --- p-process.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/p-process.yml b/p-process.yml index 6cbba59..847569c 100644 --- a/p-process.yml +++ b/p-process.yml @@ -740,6 +740,8 @@ components: properties: ChipPage: $ref: "./common.yml#/components/schemas/RfidLocation" + CoreLibResultCode: + type: integer ProcessingFinished: $ref: "#/components/schemas/ProcessingStatus" ContainerList: From 9614c0bab56a5e73e3c5cd9972e59a255efa76fd Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 21 Feb 2025 14:21:49 +0300 Subject: [PATCH 039/106] SP-18211 - add FaceDetection result --- rt-face-detection.yml | 66 +++++++++++++++++++++++++++++++++++++++++++ rt.yml | 8 ++++++ 2 files changed, 74 insertions(+) create mode 100644 rt-face-detection.yml diff --git a/rt-face-detection.yml b/rt-face-detection.yml new file mode 100644 index 0000000..253e5fd --- /dev/null +++ b/rt-face-detection.yml @@ -0,0 +1,66 @@ +openapi: 3.1.1 +components: + schemas: + FaceDetectionResult: + title: "FaceDetectionResult" + allOf: + - type: object + required: + - FaceDetection + properties: + FaceDetection: + $ref: "#/components/schemas/FaceDetection" + - $ref: "./rt.yml#/components/schemas/ResultItem" + + FaceDetection: + title: "FaceDetection" + type: object + required: + - Count + - CountFalseDetection + - Res + properties: + Count: + type: integer + CountFalseDetection: + type: integer + Res: + type: array + items: + $ref: "#/components/schemas/FaceItem" + Reserved1: + type: integer + Reserved2: + type: integer + + FaceItem: + title: "FaceItem" + type: object + required: + - CoincidenceToPhotoArea + - FaceRect + - FieldRect + - GraphFieldNumber + - Landmarks + - LightType + - Orientation + - Probability + properties: + CoincidenceToPhotoArea: + type: integer + FaceRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + FieldRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + GraphFieldNumber: + type: integer + Landmarks: + type: array + items: + $ref: "./common.yml#/components/schemas/Point" + LightType: + $ref: "./common.yml#/components/schemas/Light" + Orientation: + type: integer + Probability: + type: integer diff --git a/rt.yml b/rt.yml index 0fce66e..fd3b32d 100644 --- a/rt.yml +++ b/rt.yml @@ -38,6 +38,7 @@ components: - 61 - 62 - 85 + - 97 - 101 - 102 - 103 @@ -72,6 +73,7 @@ components: - "Contains result of DocumentPosition" - "Contains result of DocumentPosition" - "Contains information about document position on the input image, its center, angle, etc" + - "Contains result of FaceDetection" - "Contains RFID raw data" - "Contains RFID text results" - "Contains RFID graphic results" @@ -106,6 +108,7 @@ components: - "MRZ_POSITION" - "BARCODE_POSITION" - "DOCUMENT_POSITION" + - "FACE_DETECTION" - "RFID_RAW_DATA" - "RFID_TEXT" - "RFID_GRAPHICS" @@ -163,6 +166,7 @@ components: - $ref: "#/components/schemas/EncryptedRCLResult" - $ref: "#/components/schemas/DocumentBinaryInfoResult" - $ref: "#/components/schemas/ByteArrayResult" + - $ref: "#/components/schemas/FaceDetectionResult" discriminator: propertyName: result_type mapping: @@ -193,6 +197,7 @@ components: 61: "DocumentPositionResult" 62: "DocumentPositionResult" 85: "DocumentPositionResult" + 97: "FaceDetectionResult" 102: "TextDataResult" 103: "GraphicsResult" 104: "DocumentBinaryInfoResult" @@ -248,3 +253,6 @@ components: DocumentBinaryInfoResult: $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" + + FaceDetectionResult: + $ref: "./rt-face-detection.yml#/components/schemas/FaceDetectionResult" From 99eef117b940867eb331c84741c4c25a3e9b2026 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 21 Feb 2025 16:25:02 +0300 Subject: [PATCH 040/106] SP-18211 - update models --- rt-document-position.yml | 10 ++++++++++ rt-images.yml | 3 --- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/rt-document-position.yml b/rt-document-position.yml index 6bcacca..bf5f79b 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -51,3 +51,13 @@ components: $ref: "./common.yml#/components/schemas/Point" Dpi: type: integer + Inverse: + type: integer + ObjArea: + type: integer + ObjIntAngleDev: + type: integer + PerspectiveTr: + type: integer + ResultStatus: + type: integer diff --git a/rt-images.yml b/rt-images.yml index 95403e5..844a784 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -16,8 +16,6 @@ components: title: "Images" type: object required: - - fieldCount - - availableSourceCount - availableSourceList - fieldList properties: @@ -55,7 +53,6 @@ components: - fieldName - fieldType - valueList - - valueCount properties: fieldName: $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldName" From 56b82dc3d27026bd710f88a1375a6c39aef390db Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 21 Feb 2025 17:04:27 +0300 Subject: [PATCH 041/106] SP-18211 - update models --- rt-status.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rt-status.yml b/rt-status.yml index 26ef696..e305368 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -69,6 +69,8 @@ components: $ref: "./common.yml#/components/schemas/CheckResult" text: # Status of text fields analysis $ref: "./common.yml#/components/schemas/CheckResult" + vds: + type: integer detailsRFID: title: "detailsRFID" From 93f8a29d721d5b827a2e486da040307b65ffe38b Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 24 Feb 2025 11:49:27 +0300 Subject: [PATCH 042/106] SP-18211 - update models --- rt-doc-type-old.yml | 4 +- rt-mrz-detector.yml | 63 +++++++++++ rt-mrz-position.yml | 62 +++++++++++ rt-mrz-test-quality.yml | 211 ++++++++++++++++++++++++++++++++++++ rt-ocr-lexical-analysis.yml | 4 + rt-text-data.yml | 19 ++++ rt-text.yml | 3 +- rt.yml | 22 +++- 8 files changed, 385 insertions(+), 3 deletions(-) create mode 100644 rt-mrz-detector.yml create mode 100644 rt-mrz-position.yml create mode 100644 rt-mrz-test-quality.yml diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index 52edebf..d3d8369 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -85,7 +85,7 @@ components: maximum: 1 Rotated180: description: "true if the document of the given type is rotated by 180 degrees" - type: boolean + type: integer RFID_Presence: description: # Indication of the presence of an RFID chip in the document (electronic document indicator) $ref: "./common.yml#/components/schemas/RfidLocation" @@ -108,6 +108,8 @@ components: OVIExp: description: "Camera exposure value necessary when obtaining document images of the given type for AXIAL lighting scheme" type: number + RotationAngle: + type: integer FDSIDList: title: "FDSIDList" diff --git a/rt-mrz-detector.yml b/rt-mrz-detector.yml new file mode 100644 index 0000000..11f7511 --- /dev/null +++ b/rt-mrz-detector.yml @@ -0,0 +1,63 @@ +openapi: 3.1.1 +components: + schemas: + MRZDetectorResult: + title: "MRZDetectorResult" + allOf: + - type: object + required: + - ResultMRZDetector + properties: + ResultMRZDetector: + $ref: "#/components/schemas/ResultMRZDetector" + - $ref: "./rt.yml#/components/schemas/ResultItem" + + ResultMRZDetector: + title: "ResultMRZDetector" + type: object + required: + - MRZFormat + - MRZRows + - MRZRowsNum + - boundingQuadrangle + properties: + MRZFormat: + type: integer + MRZRows: + type: array + items: + $ref: "#/components/schemas/MRZRowsItem" + MRZRowsNum: + type: integer + boundingQuadrangle: + type: array + items: + type: integer + + MRZRowsItem: + title: "MRZRowsItem" + type: object + required: + - length + - maxLength + - symbols + properties: + length: + type: integer + maxLength: + type: integer + symbols: + type: array + items: + $ref: "#/components/schemas/Symbol" + + Symbol: + title: "Symbol" + type: object + required: + - boundingRect + properties: + boundingRect: + type: array + items: + type: integer diff --git a/rt-mrz-position.yml b/rt-mrz-position.yml new file mode 100644 index 0000000..b8dfbd5 --- /dev/null +++ b/rt-mrz-position.yml @@ -0,0 +1,62 @@ +openapi: 3.1.1 +components: + schemas: + MRZPositionResult: + title: "MRZPositionResult" + allOf: + - type: object + required: + - MrzPosition + properties: + MrzPosition: + $ref: "#/components/schemas/MrzPosition" + - $ref: "./rt.yml#/components/schemas/ResultItem" + + MrzPosition: + title: "MrzPosition" + type: object + required: + - docFormat + - Angle + - Width + - Height + - Center + - LeftBottom + - LeftTop + - RightBottom + - RightTop + - Dpi + properties: + docFormat: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" + Angle: + description: "Document rotation angle" + type: number + Width: + description: "Document width" + type: integer + Height: + description: "Document height" + type: integer + Center: + $ref: "./common.yml#/components/schemas/Point" + LeftBottom: + $ref: "./common.yml#/components/schemas/Point" + LeftTop: + $ref: "./common.yml#/components/schemas/Point" + RightBottom: + $ref: "./common.yml#/components/schemas/Point" + RightTop: + $ref: "./common.yml#/components/schemas/Point" + Dpi: + type: integer + Inverse: + type: integer + ObjArea: + type: integer + ObjIntAngleDev: + type: integer + PerspectiveTr: + type: integer + ResultStatus: + type: integer diff --git a/rt-mrz-test-quality.yml b/rt-mrz-test-quality.yml new file mode 100644 index 0000000..fb0f7e0 --- /dev/null +++ b/rt-mrz-test-quality.yml @@ -0,0 +1,211 @@ +openapi: 3.1.1 +components: + schemas: + MRZTestQualityResult: + title: "MRZTestQualityResult" + allOf: + - type: object + required: + - MRZTestQuality + properties: + MRZTestQuality: + $ref: "#/components/schemas/MRZTestQuality" + - $ref: "./rt.yml#/components/schemas/ResultItem" + + MRZTestQuality: + title: "MRZTestQuality" + type: object + required: + - CHECK_SUMS + - CONTRAST_PRINT + - DOC_FORMAT + - MRZ_FORMAT + - PRINT_POSITION + - STAIN_MRZ + - SYMBOLS_PARAM + - StrCount + - Strings + - TEXTUAL_FILLING + properties: + CHECK_SUMS: + type: integer + CONTRAST_PRINT: + type: integer + DOC_FORMAT: + type: integer + MRZ_FORMAT: + type: integer + PRINT_POSITION: + type: integer + STAIN_MRZ: + type: integer + SYMBOLS_PARAM: + type: integer + StrCount: + type: integer + Strings: + type: array + items: + $ref: "#/components/schemas/StringItem" + TEXTUAL_FILLING: + type: integer + + StringItem: + title: "StringItem" + type: object + required: + - ALIGNMENT_SYMBOLS_IN_STRING + - CHECK_SUMS + - ErrorPOSITION + - FieldCount + - Fields + - STRINGS_DISTANCE + - STRINGS_INTERVAL + - STRING_FILLING + - STRING_POSITION + - SYMBOLS_PARAM + - SizeError_ALIGNMENT + - SizeError_DISTANCE + - SizeError_INTERVAL + - StringAngle + - StringBorders + - SymbolsCount + - SymbolsEstimations + properties: + ALIGNMENT_SYMBOLS_IN_STRING: + type: integer + CHECK_SUMS: + type: integer + ErrorPOSITION: + $ref: "#/components/schemas/ErrorCoordinates" + FieldCount: + type: integer + Fields: + type: array + items: + $ref: "#/components/schemas/FieldItem" + STRINGS_DISTANCE: + type: integer + STRINGS_INTERVAL: + type: integer + STRING_FILLING: + type: integer + STRING_POSITION: + type: integer + SYMBOLS_PARAM: + type: integer + SizeError_ALIGNMENT: + type: integer + SizeError_DISTANCE: + type: integer + SizeError_INTERVAL: + type: integer + StringAngle: + type: integer + StringBorders: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + SymbolsCount: + type: integer + SymbolsEstimations: + type: array + items: + $ref: "#/components/schemas/SymbolEstimationItem" + + SymbolEstimationItem: + title: "SymbolEstimationItem" + type: object + required: + - ALIGNMENT_NEAREST_SYMBOLS + - CONTRAST_PRINT + - CONTRAST_SYMBOL + - CharSymbol + - EDGE + - EMPTINESS + - STAIN + - SYMBOLS_INTERVAL + - SYMBOL_PARAM + - SYMBOL_SIZE + - SizeErrorAlignWithNext + - SizeErrorAlignWithPrev + - SizeErrorIntervWithNext + - SizeErrorIntervWithPrev + - SizeErrorSymbolHeight + - SizeErrorSymbolWidth + - SymbolBounds + properties: + ALIGNMENT_NEAREST_SYMBOLS: + type: integer + CONTRAST_PRINT: + type: integer + CONTRAST_SYMBOL: + type: integer + CharSymbol: + type: integer + EDGE: + type: integer + EMPTINESS: + type: integer + STAIN: + type: integer + SYMBOLS_INTERVAL: + type: integer + SYMBOL_PARAM: + type: integer + SYMBOL_SIZE: + type: integer + SizeErrorAlignWithNext: + type: integer + SizeErrorAlignWithPrev: + type: integer + SizeErrorIntervWithNext: + type: integer + SizeErrorIntervWithPrev: + type: integer + SizeErrorSymbolHeight: + type: integer + SizeErrorSymbolWidth: + type: integer + SymbolBounds: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + + FieldItem: + title: "FieldItem" + type: object + required: + - FieldLength + - FieldPos + - FieldType + - TEST_RESULT + - ValidCheckSum + - reserved + properties: + FieldLength: + type: integer + FieldPos: + type: integer + FieldType: + type: integer + TEST_RESULT: + type: integer + ValidCheckSum: + type: integer + reserved: + type: integer + + ErrorCoordinates: + title: "ErrorPosition" + type: object + required: + - left + - top + - right + - bottom + properties: + Left: + type: integer + Top: + type: integer + Right: + type: integer + Bottom: + type: integer diff --git a/rt-ocr-lexical-analysis.yml b/rt-ocr-lexical-analysis.yml index 0979e86..3a2d64c 100644 --- a/rt-ocr-lexical-analysis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -31,6 +31,8 @@ components: type: array items: $ref: "#/components/schemas/VerifiedFieldMap" + pDateFormat: + type: string VerifiedFieldMap: title: "VerifiedFieldMap" @@ -58,6 +60,8 @@ components: type: string Matrix: $ref: "#/components/schemas/ComparisonMatrix" + FieldType: + type: integer example: {FieldType: 185, Field_MRZ: "37", Field_Visual: "37", Matrix: [1,0,0,0,0,3,0,0,0,0]} diff --git a/rt-text-data.yml b/rt-text-data.yml index 2570483..ca8c47c 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -106,6 +106,13 @@ components: type: integer InComparison: type: integer + wLCID: + type: integer + Reserved2: + type: integer + Reserved3: + type: integer + StringRecognitionResult: title: "StringRecognitionResult" @@ -130,6 +137,8 @@ components: type: string description: "Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by '^'" + Reserved: + type: integer SymbolRecognitionResult: title: "SymbolRecognitionResult" @@ -151,6 +160,12 @@ components: (the first element has highest probability)" items: $ref: "#/components/schemas/SymbolCandidate" + BaseLineBottom: + type: integer + BaseLineTop: + type: integer + Reserved: + type: integer SymbolCandidate: title: "SymbolCandidate" @@ -168,3 +183,7 @@ components: description: "character recognition probability (0–100,%)" minimum: 0 maximum: 100 + Class: + type: integer + SubClass: + type: integer diff --git a/rt-text.yml b/rt-text.yml index 023f998..f7ab576 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -49,7 +49,6 @@ components: - fieldType - fieldName - lcid - - lcidName - status - validityStatus - comparisonStatus @@ -130,6 +129,8 @@ components: $ref: "./common.yml#/components/schemas/RectangleCoordinates" rfidOrigin: # Only for rfid images. Text location in rfid chip. $ref: "./common.yml#/components/schemas/RfidOrigin" + containerType: + $ref: "./rt.yml#/components/schemas/ContainerType" OriginalSymbol: title: "OriginalSymbol" diff --git a/rt.yml b/rt.yml index fd3b32d..f600796 100644 --- a/rt.yml +++ b/rt.yml @@ -15,6 +15,7 @@ components: - 3 - 5 - 6 + - 7 - 8 - 9 - 15 @@ -38,6 +39,7 @@ components: - 61 - 62 - 85 + - 87 - 97 - 101 - 102 @@ -50,6 +52,7 @@ components: - "Contains MRZ OCR results" - "Contains raw information about barcodes on the input image" - "Contains cropped graphic fields from Visual zone" + - "Contains result of MRZTestQuality" - "Contains list of document type candidates with their probabilities and descriptions" - "Contains description of determined document type, if any" - "Contains lexical data analysis results that allow you to compare MRZ OCR results, Visual zone OCR results, barcodes and RFID chip data for an additional assessment of the authenticity of the document (this is an old format, better use TEXT type)" @@ -73,6 +76,7 @@ components: - "Contains result of DocumentPosition" - "Contains result of DocumentPosition" - "Contains information about document position on the input image, its center, angle, etc" + - "Contains result of MRZDetectorResult" - "Contains result of FaceDetection" - "Contains RFID raw data" - "Contains RFID text results" @@ -85,6 +89,7 @@ components: - "MRZ_TEXT" - "BARCODES" - "VISUAL_GRAPHICS" + - "MRZ_TEST_QUALITY" - "DOCUMENT_TYPE_CANDIDATES" - "DOCUMENT_TYPE" - "LEXICAL_ANALYSIS" @@ -108,6 +113,7 @@ components: - "MRZ_POSITION" - "BARCODE_POSITION" - "DOCUMENT_POSITION" + - "MRZ_DETECTOR" - "FACE_DETECTION" - "RFID_RAW_DATA" - "RFID_TEXT" @@ -167,6 +173,9 @@ components: - $ref: "#/components/schemas/DocumentBinaryInfoResult" - $ref: "#/components/schemas/ByteArrayResult" - $ref: "#/components/schemas/FaceDetectionResult" + - $ref: "#/components/schemas/MRZDetectorResult" + - $ref: "#/components/schemas/MRZPositionResult" + - $ref: "#/components/schemas/MRZTestQualityResult" discriminator: propertyName: result_type mapping: @@ -174,6 +183,7 @@ components: 3: "TextDataResult" 5: "DocBarCodeInfo" 6: "GraphicsResult" + 7: "MRZTestQualityResult" 8: "DocumentTypesCandidatesResult" 9: "ChosenDocumentTypeResult" 15: "LexicalAnalysisResult" @@ -194,9 +204,10 @@ components: 39: "AuthenticityResult" 49: "EncryptedRCLResult" 50: "LicenseResult" - 61: "DocumentPositionResult" + 61: "MRZPositionResult" 62: "DocumentPositionResult" 85: "DocumentPositionResult" + 87: "MRZDetectorResult" 97: "FaceDetectionResult" 102: "TextDataResult" 103: "GraphicsResult" @@ -256,3 +267,12 @@ components: FaceDetectionResult: $ref: "./rt-face-detection.yml#/components/schemas/FaceDetectionResult" + + MRZDetectorResult: + $ref: "./rt-mrz-detector.yml#/components/schemas/MRZDetectorResult" + + MRZPositionResult: + $ref: "./rt-mrz-position.yml#/components/schemas/MRZPositionResult" + + MRZTestQualityResult: + $ref: "./rt-mrz-test-quality.yml#/components/schemas/MRZTestQualityResult" From c62ab3203cde4a3af1f86f4e87d319ab9e3fc714 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 24 Feb 2025 12:09:20 +0300 Subject: [PATCH 043/106] SP-18211 - update barcode type openapi version --- e-input-barcode-type.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/e-input-barcode-type.yml b/e-input-barcode-type.yml index f69448c..7b95bac 100644 --- a/e-input-barcode-type.yml +++ b/e-input-barcode-type.yml @@ -1,4 +1,4 @@ -openapi: 3.0.3 +openapi: 3.1.1 components: schemas: InputBarcodeType: From 07774d64b6ceb9a60a7eb0faea2fd71b87116420 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 4 Mar 2025 17:03:39 +0300 Subject: [PATCH 044/106] SP-18211 - update models --- authenticity/e-check-diagnose.yml | 3 ++ authenticity/e-critical.yml | 3 ++ authenticity/e-result-type.yml | 3 ++ authenticity/e-visibility.yml | 3 ++ authenticity/rt-fiber.yml | 3 ++ authenticity/rt-ident.yml | 3 ++ authenticity/rt-ocr-security-text.yml | 3 ++ authenticity/rt-photo-ident.yml | 3 ++ authenticity/rt-security-feature.yml | 3 ++ common.yml | 3 ++ e-barcode-type.yml | 3 ++ e-document-type.yml | 3 ++ e-graphic-field-type.yml | 3 ++ e-input-barcode-type.yml | 3 ++ e-lcid.yml | 3 ++ e-parsing-error-codes.yml | 3 ++ e-parsing-notification-codes.yml | 3 ++ e-rfid-data-file-type.yml | 3 ++ e-rfid-data-group-type-tag.yml | 3 ++ e-rfid-error-codes.yml | 3 ++ e-rfid-pkd-resourcetype.yml | 3 ++ e-security-feature-type.yml | 3 ++ e-text-field-type.yml | 3 ++ openapitools.json | 2 +- p-healthcheck.yml | 3 ++ rt-authenticity.yml | 53 +++++++++--------- rt-barcodes.yml | 3 ++ rt-byte-array-data.yml | 3 ++ rt-doc-type-old.yml | 3 ++ rt-document-position.yml | 3 ++ rt-encrypted-rcl.yml | 3 ++ rt-face-detection.yml | 3 ++ rt-image-data.yml | 3 ++ rt-image-quality.yml | 3 ++ rt-images.yml | 3 ++ rt-license.yml | 3 ++ rt-mrz-detector.yml | 3 ++ rt-mrz-position.yml | 3 ++ rt-mrz-test-quality.yml | 3 ++ rt-ocr-lexical-analysis.yml | 3 ++ rt-raw-image.yml | 3 ++ rt-rfid-binary-data.yml | 3 ++ rt-status.yml | 3 ++ rt-text-data.yml | 3 ++ rt-text.yml | 3 ++ rt.yml | 77 ++++++++++++++------------- 46 files changed, 198 insertions(+), 63 deletions(-) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 77cb380..dc8ff1c 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: CheckDiagnose: diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml index 1e401cf..e8f17c6 100644 --- a/authenticity/e-critical.yml +++ b/authenticity/e-critical.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: Critical: diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index 93a5c2c..59df3ad 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: AuthenticityResultType: diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml index bf9dfda..dd8197b 100644 --- a/authenticity/e-visibility.yml +++ b/authenticity/e-visibility.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: Visibility: diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index c56dce3..4e576ed 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: FiberResult: diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index b6c049a..7d4820f 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: IdentResult: diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index f396c06..07ba7dc 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: OCRSecurityTextResult: diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 2cee779..2722a85 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: PhotoIdentResult: diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index 814951d..eaa45f4 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: SecurityFeatureResult: diff --git a/common.yml b/common.yml index 021c56e..3fde0a3 100644 --- a/common.yml +++ b/common.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: parameters: x-request: diff --git a/e-barcode-type.yml b/e-barcode-type.yml index 2c541d7..1ec7dd9 100644 --- a/e-barcode-type.yml +++ b/e-barcode-type.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: BarcodeType: diff --git a/e-document-type.yml b/e-document-type.yml index b6e7c25..e2e0533 100644 --- a/e-document-type.yml +++ b/e-document-type.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: DocumentType: diff --git a/e-graphic-field-type.yml b/e-graphic-field-type.yml index 18ff324..1285819 100644 --- a/e-graphic-field-type.yml +++ b/e-graphic-field-type.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: GraphicFieldName: diff --git a/e-input-barcode-type.yml b/e-input-barcode-type.yml index 7b95bac..a3355c3 100644 --- a/e-input-barcode-type.yml +++ b/e-input-barcode-type.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: InputBarcodeType: diff --git a/e-lcid.yml b/e-lcid.yml index c67d29e..94f3a3a 100644 --- a/e-lcid.yml +++ b/e-lcid.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: LCID: diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 6c97e2d..939489d 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: ParsingErrorCodes: diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 0af2eef..4f30036 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: ParsingNotificationCodes: diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index 11e0806..d2d38c5 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: RfidDataFileType: diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml index a445861..22ff8a9 100644 --- a/e-rfid-data-group-type-tag.yml +++ b/e-rfid-data-group-type-tag.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: RfidDataGroupTypeTag: diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index ad12d25..56e974e 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: RFIDErrorCodes: diff --git a/e-rfid-pkd-resourcetype.yml b/e-rfid-pkd-resourcetype.yml index f0401a1..653252c 100644 --- a/e-rfid-pkd-resourcetype.yml +++ b/e-rfid-pkd-resourcetype.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: RFIDPKDResourceType: diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 0e7e893..2ca9ce8 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: SecurityFeatureType: diff --git a/e-text-field-type.yml b/e-text-field-type.yml index 4121932..4584a27 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: TextFieldType: diff --git a/openapitools.json b/openapitools.json index bfebfaa..b20af39 100644 --- a/openapitools.json +++ b/openapitools.json @@ -2,6 +2,6 @@ "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json", "spaces": 2, "generator-cli": { - "version": "5.0.0" + "version": "7.11.0" } } diff --git a/p-healthcheck.yml b/p-healthcheck.yml index 3369803..753181d 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API paths: /healthz: diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 4c501fc..ae836d5 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: AuthenticityResult: @@ -52,31 +55,6 @@ components: - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" - discriminator: - propertyName: Type - mapping: - 1: "SecurityFeatureResult" - 2: "SecurityFeatureResult" - 4: "IdentResult" - 8: "SecurityFeatureResult" - 16: "FiberResult" - 32: "IdentResult" - 64: "OCRSecurityTextResult" - 128: "PhotoIdentResult" - 256: "PhotoIdentResult" - 512: "SecurityFeatureResult" - 1024: "IdentResult" - 2048: "IdentResult" - 4096: "SecurityFeatureResult" - 8192: "SecurityFeatureResult" - 16384: "FiberResult" - 32768: "IdentResult" - 65536: "SecurityFeatureResult" - 131072: "IdentResult" - 262144: "IdentResult" - 524288: "IdentResult" - 1048576: "IdentResult" - 8388608: "SecurityFeatureResult" SecurityFeatureResult: $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" @@ -115,6 +93,31 @@ components: PercentValue: type: integer format: double + discriminator: + propertyName: Type + mapping: + 1: "SecurityFeatureResult" + 2: "SecurityFeatureResult" + 4: "IdentResult" + 8: "SecurityFeatureResult" + 16: "FiberResult" + 32: "IdentResult" + 64: "OCRSecurityTextResult" + 128: "PhotoIdentResult" + 256: "PhotoIdentResult" + 512: "SecurityFeatureResult" + 1024: "IdentResult" + 2048: "IdentResult" + 4096: "SecurityFeatureResult" + 8192: "SecurityFeatureResult" + 16384: "FiberResult" + 32768: "IdentResult" + 65536: "SecurityFeatureResult" + 131072: "IdentResult" + 262144: "IdentResult" + 524288: "IdentResult" + 1048576: "IdentResult" + 8388608: "SecurityFeatureResult" AreaContainer: title: "AreaContainer" diff --git a/rt-barcodes.yml b/rt-barcodes.yml index 605d761..d514a7a 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: DocBarCodeInfo: diff --git a/rt-byte-array-data.yml b/rt-byte-array-data.yml index ef6f4c6..11deeea 100644 --- a/rt-byte-array-data.yml +++ b/rt-byte-array-data.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: ByteArrayResult: diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index d3d8369..42238cb 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: ChosenDocumentTypeResult: diff --git a/rt-document-position.yml b/rt-document-position.yml index bf5f79b..e6015a0 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: DocumentPositionResult: diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml index ce1513f..c191dd1 100644 --- a/rt-encrypted-rcl.yml +++ b/rt-encrypted-rcl.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: EncryptedRCLResult: diff --git a/rt-face-detection.yml b/rt-face-detection.yml index 253e5fd..39473e8 100644 --- a/rt-face-detection.yml +++ b/rt-face-detection.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: FaceDetectionResult: diff --git a/rt-image-data.yml b/rt-image-data.yml index 00919a7..f00300d 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: GraphicsResult: diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 140f436..915bccf 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: ImageQualityResult: diff --git a/rt-images.yml b/rt-images.yml index 844a784..5f942c0 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: ImagesResult: diff --git a/rt-license.yml b/rt-license.yml index 736e8f1..00fed3c 100644 --- a/rt-license.yml +++ b/rt-license.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: LicenseResult: diff --git a/rt-mrz-detector.yml b/rt-mrz-detector.yml index 11f7511..e955441 100644 --- a/rt-mrz-detector.yml +++ b/rt-mrz-detector.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: MRZDetectorResult: diff --git a/rt-mrz-position.yml b/rt-mrz-position.yml index b8dfbd5..e154f0d 100644 --- a/rt-mrz-position.yml +++ b/rt-mrz-position.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: MRZPositionResult: diff --git a/rt-mrz-test-quality.yml b/rt-mrz-test-quality.yml index fb0f7e0..c20556d 100644 --- a/rt-mrz-test-quality.yml +++ b/rt-mrz-test-quality.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: MRZTestQualityResult: diff --git a/rt-ocr-lexical-analysis.yml b/rt-ocr-lexical-analysis.yml index 3a2d64c..689449d 100644 --- a/rt-ocr-lexical-analysis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: LexicalAnalysisResult: diff --git a/rt-raw-image.yml b/rt-raw-image.yml index a6e391e..03df0ab 100644 --- a/rt-raw-image.yml +++ b/rt-raw-image.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: DocumentImageResult: diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index ed4d87d..ee3cfe6 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: DocumentBinaryInfoResult: diff --git a/rt-status.yml b/rt-status.yml index e305368..fbfebe8 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: StatusResult: diff --git a/rt-text-data.yml b/rt-text-data.yml index ca8c47c..a92cf78 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: TextDataResult: diff --git a/rt-text.yml b/rt-text.yml index f7ab576..e218889 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: TextResult: diff --git a/rt.yml b/rt.yml index f600796..159f7b4 100644 --- a/rt.yml +++ b/rt.yml @@ -1,4 +1,7 @@ openapi: 3.1.1 +info: + version: 7.4.0 + title: Regula Document Reader Web API components: schemas: ContainerType: @@ -139,6 +142,43 @@ components: type: integer result_type: $ref: "#/components/schemas/ContainerType" + discriminator: + propertyName: result_type + mapping: + 1: "DocumentImageResult" + 3: "TextDataResult" + 5: "DocBarCodeInfo" + 6: "GraphicsResult" + 7: "MRZTestQualityResult" + 8: "DocumentTypesCandidatesResult" + 9: "ChosenDocumentTypeResult" + 15: "LexicalAnalysisResult" + 16: "DocumentImageResult" + 17: "TextDataResult" + 18: "TextDataResult" + 19: "GraphicsResult" + 20: "AuthenticityResult" + 26: "TextDataResult" + 30: "ImageQualityResult" + 32: "GraphicsResult" + 33: "StatusResult" + 34: "AuthenticityResult" + 35: "GraphicsResult" + 36: "TextResult" + 37: "ImagesResult" + 38: "GraphicsResult" + 39: "AuthenticityResult" + 49: "EncryptedRCLResult" + 50: "LicenseResult" + 61: "MRZPositionResult" + 62: "DocumentPositionResult" + 85: "DocumentPositionResult" + 87: "MRZDetectorResult" + 97: "FaceDetectionResult" + 102: "TextDataResult" + 103: "GraphicsResult" + 104: "DocumentBinaryInfoResult" + 109: "ByteArrayResult" ContainerList: title: "ContainerList" @@ -176,43 +216,6 @@ components: - $ref: "#/components/schemas/MRZDetectorResult" - $ref: "#/components/schemas/MRZPositionResult" - $ref: "#/components/schemas/MRZTestQualityResult" - discriminator: - propertyName: result_type - mapping: - 1: "DocumentImageResult" - 3: "TextDataResult" - 5: "DocBarCodeInfo" - 6: "GraphicsResult" - 7: "MRZTestQualityResult" - 8: "DocumentTypesCandidatesResult" - 9: "ChosenDocumentTypeResult" - 15: "LexicalAnalysisResult" - 16: "DocumentImageResult" - 17: "TextDataResult" - 18: "TextDataResult" - 19: "GraphicsResult" - 20: "AuthenticityResult" - 26: "TextDataResult" - 30: "ImageQualityResult" - 32: "GraphicsResult" - 33: "StatusResult" - 34: "AuthenticityResult" - 35: "GraphicsResult" - 36: "TextResult" - 37: "ImagesResult" - 38: "GraphicsResult" - 39: "AuthenticityResult" - 49: "EncryptedRCLResult" - 50: "LicenseResult" - 61: "MRZPositionResult" - 62: "DocumentPositionResult" - 85: "DocumentPositionResult" - 87: "MRZDetectorResult" - 97: "FaceDetectionResult" - 102: "TextDataResult" - 103: "GraphicsResult" - 104: "DocumentBinaryInfoResult" - 109: "ByteArrayResult" StatusResult: $ref: "./rt-status.yml#/components/schemas/StatusResult" From f626fd4e1bb739e68aa022525867bf504e2fa30a Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 5 Mar 2025 11:49:04 +0300 Subject: [PATCH 045/106] SP-18211 - refactor --- authenticity/e-check-diagnose.yml | 4 ---- authenticity/e-critical.yml | 4 ---- authenticity/e-result-type.yml | 4 ---- authenticity/e-visibility.yml | 4 ---- authenticity/rt-fiber.yml | 4 ---- authenticity/rt-ident.yml | 4 ---- authenticity/rt-ocr-security-text.yml | 4 ---- authenticity/rt-photo-ident.yml | 4 ---- authenticity/rt-security-feature.yml | 4 ---- common.yml | 4 ---- e-barcode-type.yml | 4 ---- e-document-type.yml | 4 ---- e-graphic-field-type.yml | 4 ---- e-input-barcode-type.yml | 4 ---- e-lcid.yml | 4 ---- e-parsing-error-codes.yml | 4 ---- e-parsing-notification-codes.yml | 4 ---- e-rfid-data-file-type.yml | 4 ---- e-rfid-data-group-type-tag.yml | 4 ---- e-rfid-error-codes.yml | 4 ---- e-rfid-pkd-resourcetype.yml | 4 ---- e-security-feature-type.yml | 4 ---- e-text-field-type.yml | 4 ---- index.yml | 2 +- p-healthcheck.yml | 5 ----- p-ping.yml | 5 ----- p-process.yml | 5 ----- p-transaction.yml | 5 ----- rt-authenticity.yml | 4 ---- rt-barcodes.yml | 4 ---- rt-byte-array-data.yml | 4 ---- rt-doc-type-old.yml | 4 ---- rt-document-position.yml | 4 ---- rt-encrypted-rcl.yml | 4 ---- rt-face-detection.yml | 4 ---- rt-image-data.yml | 4 ---- rt-image-quality.yml | 4 ---- rt-images.yml | 4 ---- rt-license.yml | 4 ---- rt-mrz-detector.yml | 4 ---- rt-mrz-position.yml | 4 ---- rt-mrz-test-quality.yml | 4 ---- rt-ocr-lexical-analysis.yml | 4 ---- rt-raw-image.yml | 4 ---- rt-rfid-binary-data.yml | 4 ---- rt-status.yml | 4 ---- rt-text-data.yml | 4 ---- rt-text.yml | 4 ---- rt.yml | 4 ---- 49 files changed, 1 insertion(+), 197 deletions(-) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index dc8ff1c..d131d4a 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: CheckDiagnose: diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml index e8f17c6..d9ecbfa 100644 --- a/authenticity/e-critical.yml +++ b/authenticity/e-critical.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: Critical: diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index 59df3ad..342fdba 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: AuthenticityResultType: diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml index dd8197b..6057481 100644 --- a/authenticity/e-visibility.yml +++ b/authenticity/e-visibility.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: Visibility: diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index 4e576ed..c03e144 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: FiberResult: diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index 7d4820f..5ccee56 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: IdentResult: diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index 07ba7dc..ed5c1ff 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: OCRSecurityTextResult: diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 2722a85..7c11d63 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: PhotoIdentResult: diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index eaa45f4..ddd8a66 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: SecurityFeatureResult: diff --git a/common.yml b/common.yml index 3fde0a3..dfc85b4 100644 --- a/common.yml +++ b/common.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: parameters: x-request: diff --git a/e-barcode-type.yml b/e-barcode-type.yml index 1ec7dd9..a544a55 100644 --- a/e-barcode-type.yml +++ b/e-barcode-type.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: BarcodeType: diff --git a/e-document-type.yml b/e-document-type.yml index e2e0533..a11d59c 100644 --- a/e-document-type.yml +++ b/e-document-type.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: DocumentType: diff --git a/e-graphic-field-type.yml b/e-graphic-field-type.yml index 1285819..9d3528a 100644 --- a/e-graphic-field-type.yml +++ b/e-graphic-field-type.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: GraphicFieldName: diff --git a/e-input-barcode-type.yml b/e-input-barcode-type.yml index a3355c3..f62c46b 100644 --- a/e-input-barcode-type.yml +++ b/e-input-barcode-type.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: InputBarcodeType: diff --git a/e-lcid.yml b/e-lcid.yml index 94f3a3a..6c71ecd 100644 --- a/e-lcid.yml +++ b/e-lcid.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: LCID: diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 939489d..2ae948f 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: ParsingErrorCodes: diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 4f30036..b488713 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: ParsingNotificationCodes: diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index d2d38c5..7323e24 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: RfidDataFileType: diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml index 22ff8a9..d401eea 100644 --- a/e-rfid-data-group-type-tag.yml +++ b/e-rfid-data-group-type-tag.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: RfidDataGroupTypeTag: diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index 56e974e..c1a9562 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: RFIDErrorCodes: diff --git a/e-rfid-pkd-resourcetype.yml b/e-rfid-pkd-resourcetype.yml index 653252c..c834cd0 100644 --- a/e-rfid-pkd-resourcetype.yml +++ b/e-rfid-pkd-resourcetype.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: RFIDPKDResourceType: diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 2ca9ce8..3e42714 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: SecurityFeatureType: diff --git a/e-text-field-type.yml b/e-text-field-type.yml index 4584a27..4215efd 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: TextFieldType: diff --git a/index.yml b/index.yml index 4eb0a13..4a1a0a0 100644 --- a/index.yml +++ b/index.yml @@ -1,4 +1,4 @@ -openapi: 3.1.1 +openapi: 3.0.4 info: version: 7.4.0 title: Regula Document Reader Web API diff --git a/p-healthcheck.yml b/p-healthcheck.yml index 753181d..5c355e2 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -1,8 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API - paths: /healthz: parameters: diff --git a/p-ping.yml b/p-ping.yml index aec0291..8ea302c 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -1,8 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API - paths: /ping: parameters: diff --git a/p-process.yml b/p-process.yml index 847569c..c0fb34a 100644 --- a/p-process.yml +++ b/p-process.yml @@ -1,8 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API - paths: /process: parameters: diff --git a/p-transaction.yml b/p-transaction.yml index e33eaed..b9e54a4 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -1,8 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API - paths: /transaction/{transactionId}/process: post: diff --git a/rt-authenticity.yml b/rt-authenticity.yml index ae836d5..059d8ff 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: AuthenticityResult: diff --git a/rt-barcodes.yml b/rt-barcodes.yml index d514a7a..fb887ff 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: DocBarCodeInfo: diff --git a/rt-byte-array-data.yml b/rt-byte-array-data.yml index 11deeea..ba50169 100644 --- a/rt-byte-array-data.yml +++ b/rt-byte-array-data.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: ByteArrayResult: diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index 42238cb..ff07c96 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: ChosenDocumentTypeResult: diff --git a/rt-document-position.yml b/rt-document-position.yml index e6015a0..2c60cfc 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: DocumentPositionResult: diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml index c191dd1..9fe82bd 100644 --- a/rt-encrypted-rcl.yml +++ b/rt-encrypted-rcl.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: EncryptedRCLResult: diff --git a/rt-face-detection.yml b/rt-face-detection.yml index 39473e8..c5e4213 100644 --- a/rt-face-detection.yml +++ b/rt-face-detection.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: FaceDetectionResult: diff --git a/rt-image-data.yml b/rt-image-data.yml index f00300d..a157d23 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: GraphicsResult: diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 915bccf..14bcc69 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: ImageQualityResult: diff --git a/rt-images.yml b/rt-images.yml index 5f942c0..66aeed9 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: ImagesResult: diff --git a/rt-license.yml b/rt-license.yml index 00fed3c..01ee491 100644 --- a/rt-license.yml +++ b/rt-license.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: LicenseResult: diff --git a/rt-mrz-detector.yml b/rt-mrz-detector.yml index e955441..a6000d7 100644 --- a/rt-mrz-detector.yml +++ b/rt-mrz-detector.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: MRZDetectorResult: diff --git a/rt-mrz-position.yml b/rt-mrz-position.yml index e154f0d..d7707df 100644 --- a/rt-mrz-position.yml +++ b/rt-mrz-position.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: MRZPositionResult: diff --git a/rt-mrz-test-quality.yml b/rt-mrz-test-quality.yml index c20556d..c0cf697 100644 --- a/rt-mrz-test-quality.yml +++ b/rt-mrz-test-quality.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: MRZTestQualityResult: diff --git a/rt-ocr-lexical-analysis.yml b/rt-ocr-lexical-analysis.yml index 689449d..b858229 100644 --- a/rt-ocr-lexical-analysis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: LexicalAnalysisResult: diff --git a/rt-raw-image.yml b/rt-raw-image.yml index 03df0ab..4731643 100644 --- a/rt-raw-image.yml +++ b/rt-raw-image.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: DocumentImageResult: diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index ee3cfe6..8974e2e 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: DocumentBinaryInfoResult: diff --git a/rt-status.yml b/rt-status.yml index fbfebe8..60799d1 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: StatusResult: diff --git a/rt-text-data.yml b/rt-text-data.yml index a92cf78..bbdb685 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: TextDataResult: diff --git a/rt-text.yml b/rt-text.yml index e218889..59516a3 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: TextResult: diff --git a/rt.yml b/rt.yml index 159f7b4..8caf426 100644 --- a/rt.yml +++ b/rt.yml @@ -1,7 +1,3 @@ -openapi: 3.1.1 -info: - version: 7.4.0 - title: Regula Document Reader Web API components: schemas: ContainerType: From 6deae570ff60fcc1d1a5294ce06c9f2c0bcc411c Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 5 Mar 2025 18:38:39 +0300 Subject: [PATCH 046/106] SP-18211 - refactor --- authenticity/e-check-diagnose.yml | 1 + authenticity/e-critical.yml | 1 + authenticity/e-result-type.yml | 1 + authenticity/e-visibility.yml | 1 + authenticity/rt-fiber.yml | 1 + authenticity/rt-ident.yml | 1 + authenticity/rt-ocr-security-text.yml | 1 + authenticity/rt-photo-ident.yml | 1 + authenticity/rt-security-feature.yml | 1 + common.yml | 1 + e-barcode-type.yml | 1 + e-document-type.yml | 1 + e-graphic-field-type.yml | 1 + e-input-barcode-type.yml | 1 + e-lcid.yml | 1 + e-parsing-error-codes.yml | 1 + e-parsing-notification-codes.yml | 1 + e-rfid-data-file-type.yml | 1 + e-rfid-data-group-type-tag.yml | 1 + e-rfid-error-codes.yml | 1 + e-rfid-pkd-resourcetype.yml | 1 + e-security-feature-type.yml | 1 + e-text-field-type.yml | 1 + p-healthcheck.yml | 1 + p-ping.yml | 1 + p-process.yml | 1 + p-transaction.yml | 1 + rt-authenticity.yml | 12 +- rt-barcodes.yml | 13 +- rt-byte-array-data.yml | 13 -- rt-doc-type-old.yml | 26 +-- rt-document-position.yml | 13 +- rt-encrypted-rcl.yml | 13 -- rt-face-detection.yml | 12 +- rt-image-data.yml | 14 +- rt-image-quality.yml | 12 +- rt-images.yml | 12 +- rt-license.yml | 13 -- rt-mrz-detector.yml | 12 +- rt-mrz-position.yml | 12 +- rt-mrz-test-quality.yml | 12 +- rt-ocr-lexical-analysis.yml | 17 +- rt-raw-image.yml | 13 -- rt-rfid-binary-data.yml | 14 +- rt-status.yml | 12 +- rt-text-data.yml | 14 +- rt-text.yml | 12 +- rt.yml | 231 +++++++++++++++++++++++--- 48 files changed, 253 insertions(+), 276 deletions(-) delete mode 100644 rt-byte-array-data.yml delete mode 100644 rt-encrypted-rcl.yml delete mode 100644 rt-license.yml delete mode 100644 rt-raw-image.yml diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index d131d4a..9461323 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: CheckDiagnose: diff --git a/authenticity/e-critical.yml b/authenticity/e-critical.yml index d9ecbfa..cb2e9a6 100644 --- a/authenticity/e-critical.yml +++ b/authenticity/e-critical.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: Critical: diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index 342fdba..48e7846 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: AuthenticityResultType: diff --git a/authenticity/e-visibility.yml b/authenticity/e-visibility.yml index 6057481..ce26dbe 100644 --- a/authenticity/e-visibility.yml +++ b/authenticity/e-visibility.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: Visibility: diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index c03e144..9508c32 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: FiberResult: diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index 5ccee56..76382c0 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: IdentResult: diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index ed5c1ff..5d6491c 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: OCRSecurityTextResult: diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 7c11d63..6642b53 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: PhotoIdentResult: diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index ddd8a66..3547d36 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: SecurityFeatureResult: diff --git a/common.yml b/common.yml index dfc85b4..909b2a1 100644 --- a/common.yml +++ b/common.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: parameters: x-request: diff --git a/e-barcode-type.yml b/e-barcode-type.yml index a544a55..30b346c 100644 --- a/e-barcode-type.yml +++ b/e-barcode-type.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: BarcodeType: diff --git a/e-document-type.yml b/e-document-type.yml index a11d59c..48fe305 100644 --- a/e-document-type.yml +++ b/e-document-type.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: DocumentType: diff --git a/e-graphic-field-type.yml b/e-graphic-field-type.yml index 9d3528a..fe943ae 100644 --- a/e-graphic-field-type.yml +++ b/e-graphic-field-type.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: GraphicFieldName: diff --git a/e-input-barcode-type.yml b/e-input-barcode-type.yml index f62c46b..c5268b2 100644 --- a/e-input-barcode-type.yml +++ b/e-input-barcode-type.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: InputBarcodeType: diff --git a/e-lcid.yml b/e-lcid.yml index 6c71ecd..bac0756 100644 --- a/e-lcid.yml +++ b/e-lcid.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: LCID: diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 2ae948f..5eb9fe2 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: ParsingErrorCodes: diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index b488713..07f248c 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: ParsingNotificationCodes: diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index 7323e24..50c2c1b 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: RfidDataFileType: diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml index d401eea..5ad2208 100644 --- a/e-rfid-data-group-type-tag.yml +++ b/e-rfid-data-group-type-tag.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: RfidDataGroupTypeTag: diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index c1a9562..6364ede 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: RFIDErrorCodes: diff --git a/e-rfid-pkd-resourcetype.yml b/e-rfid-pkd-resourcetype.yml index c834cd0..d8f2f79 100644 --- a/e-rfid-pkd-resourcetype.yml +++ b/e-rfid-pkd-resourcetype.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: RFIDPKDResourceType: diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 3e42714..839006c 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: SecurityFeatureType: diff --git a/e-text-field-type.yml b/e-text-field-type.yml index 4215efd..9e52cdb 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: TextFieldType: diff --git a/p-healthcheck.yml b/p-healthcheck.yml index 5c355e2..bea9da4 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 paths: /healthz: parameters: diff --git a/p-ping.yml b/p-ping.yml index 8ea302c..62371e4 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 paths: /ping: parameters: diff --git a/p-process.yml b/p-process.yml index c0fb34a..706bdc7 100644 --- a/p-process.yml +++ b/p-process.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 paths: /process: parameters: diff --git a/p-transaction.yml b/p-transaction.yml index b9e54a4..9a4e601 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 paths: /transaction/{transactionId}/process: post: diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 059d8ff..652b542 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - AuthenticityResult: - title: "AuthenticityResult" - allOf: - - type: object - required: - - AuthenticityCheckList - properties: - AuthenticityCheckList: - $ref: "#/components/schemas/AuthenticityCheckList" - - $ref: "./rt.yml#/components/schemas/ResultItem" - AuthenticityCheckList: title: "AuthenticityCheckList" type: object diff --git a/rt-barcodes.yml b/rt-barcodes.yml index fb887ff..7db3ef2 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -1,17 +1,6 @@ +openapi: 3.0.4 components: schemas: - DocBarCodeInfo: - title: "DocBarCodeInfo" - description: "Raw data from BarCodes" - allOf: - - type: object - required: - - DocBarCodeInfo - properties: - DocBarCodeInfo: - $ref: "#/components/schemas/DocBarCodeInfoFieldsList" - - $ref: "./rt.yml#/components/schemas/ResultItem" - DocBarCodeInfoFieldsList: title: "DocBarCodeInfoFieldsList" type: object diff --git a/rt-byte-array-data.yml b/rt-byte-array-data.yml deleted file mode 100644 index ba50169..0000000 --- a/rt-byte-array-data.yml +++ /dev/null @@ -1,13 +0,0 @@ -components: - schemas: - ByteArrayResult: - title: "ByteArrayResult" - allOf: - - type: object - required: - - ByteArray - properties: - ByteArray: - description: "Byte array in base64" - type: string - - $ref: "./rt.yml#/components/schemas/ResultItem" diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index ff07c96..e3cbd46 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -1,30 +1,6 @@ +openapi: 3.0.4 components: schemas: - ChosenDocumentTypeResult: - title: "ChosenDocumentTypeResult" - description: "Contains information about the type of document that was determined - based on the analysis of the provided image" - allOf: - - type: object - required: - - OneCandidate - properties: - OneCandidate: - $ref: "#/components/schemas/OneCandidate" - XML_buffer: - type: string - readOnly: true - - $ref: "./rt.yml#/components/schemas/ResultItem" - - DocumentTypesCandidatesResult: - title: "DocumentTypesCandidatesResult" - allOf: - - type: object - properties: - CandidatesList: - $ref: "#/components/schemas/DocumentTypesCandidatesList" - - $ref: "./rt.yml#/components/schemas/ResultItem" - DocumentTypesCandidatesList: title: "DocumentTypesCandidatesList" type: object diff --git a/rt-document-position.yml b/rt-document-position.yml index 2c60cfc..2f8bd5f 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -1,17 +1,6 @@ +openapi: 3.0.4 components: schemas: - DocumentPositionResult: - title: "DocumentPositionResult" - description: "Contains information about document position on the input image, its center, angle, etc" - allOf: - - type: object - required: - - DocumentPosition - properties: - DocumentPosition: - $ref: "#/components/schemas/DocumentPosition" - - $ref: "./rt.yml#/components/schemas/ResultItem" - DocumentPosition: title: "DocumentPosition" type: object diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml deleted file mode 100644 index 9fe82bd..0000000 --- a/rt-encrypted-rcl.yml +++ /dev/null @@ -1,13 +0,0 @@ -components: - schemas: - EncryptedRCLResult: - title: "EncryptedRCLResult" - allOf: - - type: object - description: "Contains encrypted result container list" - required: - - EncryptedRCL - properties: - EncryptedRCL: - $ref: "./common.yml#/components/schemas/EncryptedRCL" - - $ref: "./rt.yml#/components/schemas/ResultItem" diff --git a/rt-face-detection.yml b/rt-face-detection.yml index c5e4213..af555f7 100644 --- a/rt-face-detection.yml +++ b/rt-face-detection.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - FaceDetectionResult: - title: "FaceDetectionResult" - allOf: - - type: object - required: - - FaceDetection - properties: - FaceDetection: - $ref: "#/components/schemas/FaceDetection" - - $ref: "./rt.yml#/components/schemas/ResultItem" - FaceDetection: title: "FaceDetection" type: object diff --git a/rt-image-data.yml b/rt-image-data.yml index a157d23..2424f71 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -1,18 +1,6 @@ +openapi: 3.0.4 components: schemas: - GraphicsResult: - title: "GraphicsResult" - description: "Graphic fields extracted from one of the document sources. - Returns separate results for each provided page." - required: - - DocGraphicsInfo - allOf: - - type: object - properties: - DocGraphicsInfo: - $ref: "#/components/schemas/GraphicFieldsList" - - $ref: "./rt.yml#/components/schemas/ResultItem" - GraphicFieldsList: title: "GraphicFieldsList" type: object diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 14bcc69..db227ea 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - ImageQualityResult: - title: "ImageQualityResult" - allOf: - - type: object - required: - - ImageQualityCheckList - properties: - ImageQualityCheckList: - $ref: "#/components/schemas/ImageQualityCheckList" - - $ref: "./rt.yml#/components/schemas/ResultItem" - ImageQualityCheckList: title: "ImageQualityCheckList" type: object diff --git a/rt-images.yml b/rt-images.yml index 66aeed9..951425f 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - ImagesResult: - title: "ImagesResult" - allOf: - - type: object - required: - - Images - properties: - Images: - $ref: "#/components/schemas/Images" - - $ref: "./rt.yml#/components/schemas/ResultItem" - Images: title: "Images" type: object diff --git a/rt-license.yml b/rt-license.yml deleted file mode 100644 index 01ee491..0000000 --- a/rt-license.yml +++ /dev/null @@ -1,13 +0,0 @@ -components: - schemas: - LicenseResult: - title: "LicenseResult" - allOf: - - type: object - description: "Contains license" - required: - - License - properties: - License: - $ref: "./common.yml#/components/schemas/License" - - $ref: "./rt.yml#/components/schemas/ResultItem" diff --git a/rt-mrz-detector.yml b/rt-mrz-detector.yml index a6000d7..bc223c2 100644 --- a/rt-mrz-detector.yml +++ b/rt-mrz-detector.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - MRZDetectorResult: - title: "MRZDetectorResult" - allOf: - - type: object - required: - - ResultMRZDetector - properties: - ResultMRZDetector: - $ref: "#/components/schemas/ResultMRZDetector" - - $ref: "./rt.yml#/components/schemas/ResultItem" - ResultMRZDetector: title: "ResultMRZDetector" type: object diff --git a/rt-mrz-position.yml b/rt-mrz-position.yml index d7707df..cfd818a 100644 --- a/rt-mrz-position.yml +++ b/rt-mrz-position.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - MRZPositionResult: - title: "MRZPositionResult" - allOf: - - type: object - required: - - MrzPosition - properties: - MrzPosition: - $ref: "#/components/schemas/MrzPosition" - - $ref: "./rt.yml#/components/schemas/ResultItem" - MrzPosition: title: "MrzPosition" type: object diff --git a/rt-mrz-test-quality.yml b/rt-mrz-test-quality.yml index c0cf697..5c96c7e 100644 --- a/rt-mrz-test-quality.yml +++ b/rt-mrz-test-quality.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - MRZTestQualityResult: - title: "MRZTestQualityResult" - allOf: - - type: object - required: - - MRZTestQuality - properties: - MRZTestQuality: - $ref: "#/components/schemas/MRZTestQuality" - - $ref: "./rt.yml#/components/schemas/ResultItem" - MRZTestQuality: title: "MRZTestQuality" type: object diff --git a/rt-ocr-lexical-analysis.yml b/rt-ocr-lexical-analysis.yml index b858229..14f7299 100644 --- a/rt-ocr-lexical-analysis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -1,21 +1,6 @@ +openapi: 3.0.4 components: schemas: - LexicalAnalysisResult: - title: "LexicalAnalysisResult" - description: | - Lexical data analysis allows you to compare the results of reading the text data of the MRZ, - the document filling area, barcodes and data from the memory of the RFID chip for an additional - assessment of the authenticity of the document. Single result for all pages. - Consider using Result.TEXT type for more simplicity. - allOf: - - type: object - required: - - ListVerifiedFields - properties: - ListVerifiedFields: - $ref: "#/components/schemas/ListVerifiedFields" - - $ref: "./rt.yml#/components/schemas/ResultItem" - ListVerifiedFields: title: "ListVerifiedFields" type: object diff --git a/rt-raw-image.yml b/rt-raw-image.yml deleted file mode 100644 index 4731643..0000000 --- a/rt-raw-image.yml +++ /dev/null @@ -1,13 +0,0 @@ -components: - schemas: - DocumentImageResult: - title: "DocumentImageResult" - description: "Contains document image." - allOf: - - type: object - required: - - RawImageContainer - properties: - RawImageContainer: - $ref: "./common.yml#/components/schemas/ImageData" - - $ref: "./rt.yml#/components/schemas/ResultItem" diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 8974e2e..23021c2 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -1,18 +1,6 @@ +openapi: 3.0.4 components: schemas: - DocumentBinaryInfoResult: - title: "DocumentBinaryInfoResult" - allOf: - - type: object - description: "Structure is used to store the data reading results from the RFID-chip in - a form of a list of the logically separated data groups." - required: - - TDocBinaryInfo - properties: - TDocBinaryInfo: - $ref: "#/components/schemas/TDocBinaryInfo" - - $ref: "./rt.yml#/components/schemas/ResultItem" - TDocBinaryInfo: title: "TDocBinaryInfo" type: object diff --git a/rt-status.yml b/rt-status.yml index 60799d1..9e88234 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - StatusResult: - title: "StatusResult" - allOf: - - type: object - required: - - Status - properties: - Status: - $ref: "#/components/schemas/Status" - - $ref: "./rt.yml#/components/schemas/ResultItem" - Status: title: "Status" type: object diff --git a/rt-text-data.yml b/rt-text-data.yml index bbdb685..bb7c4b1 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -1,18 +1,6 @@ +openapi: 3.0.4 components: schemas: - TextDataResult: - title: "TextDataResult" - description: "Text fields extracted from one document source. - Contains results of specific source for each provided page." - allOf: - - type: object - required: - - DocVisualExtendedInfo - properties: - DocVisualExtendedInfo: - $ref: "#/components/schemas/DocVisualExtendedInfo" - - $ref: "./rt.yml#/components/schemas/ResultItem" - DocVisualExtendedInfo: title: "DocVisualExtendedInfo" type: object diff --git a/rt-text.yml b/rt-text.yml index 59516a3..e80ed26 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -1,16 +1,6 @@ +openapi: 3.0.4 components: schemas: - TextResult: - title: "TextResult" - allOf: - - type: object - required: - - Text - properties: - Text: - $ref: "#/components/schemas/Text" - - $ref: "./rt.yml#/components/schemas/ResultItem" - Text: title: "Text" type: object diff --git a/rt.yml b/rt.yml index 8caf426..ac92312 100644 --- a/rt.yml +++ b/rt.yml @@ -1,3 +1,4 @@ +openapi: 3.0.4 components: schemas: ContainerType: @@ -214,64 +215,252 @@ components: - $ref: "#/components/schemas/MRZTestQualityResult" StatusResult: - $ref: "./rt-status.yml#/components/schemas/StatusResult" + title: "StatusResult" + allOf: + - type: object + required: + - Status + properties: + Status: + $ref: "./rt-status.yml#/components/schemas/Status" + - $ref: "#/components/schemas/ResultItem" TextResult: - $ref: "./rt-text.yml#/components/schemas/TextResult" + title: "TextResult" + allOf: + - type: object + required: + - Text + properties: + Text: + $ref: "./rt-text.yml#/components/schemas/Text" + - $ref: "#/components/schemas/ResultItem" DocumentImageResult: - $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult" + title: "DocumentImageResult" + description: "Contains document image." + allOf: + - type: object + required: + - RawImageContainer + properties: + RawImageContainer: + $ref: "./common.yml#/components/schemas/ImageData" + - $ref: "#/components/schemas/ResultItem" ImagesResult: - $ref: "./rt-images.yml#/components/schemas/ImagesResult" + title: "ImagesResult" + allOf: + - type: object + required: + - Images + properties: + Images: + $ref: "./rt-images.yml#/components/schemas/Images" + - $ref: "#/components/schemas/ResultItem" ChosenDocumentTypeResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/ChosenDocumentTypeResult" + title: "ChosenDocumentTypeResult" + description: "Contains information about the type of document that was determined + based on the analysis of the provided image" + allOf: + - type: object + required: + - OneCandidate + properties: + OneCandidate: + $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" + XML_buffer: + type: string + readOnly: true + - $ref: "#/components/schemas/ResultItem" DocumentTypesCandidatesResult: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult" + title: "DocumentTypesCandidatesResult" + allOf: + - type: object + properties: + CandidatesList: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList" + - $ref: "#/components/schemas/ResultItem" TextDataResult: - $ref: "./rt-text-data.yml#/components/schemas/TextDataResult" + title: "TextDataResult" + description: "Text fields extracted from one document source. + Contains results of specific source for each provided page." + allOf: + - type: object + required: + - DocVisualExtendedInfo + properties: + DocVisualExtendedInfo: + $ref: "./rt-text-data.yml#/components/schemas/DocVisualExtendedInfo" + - $ref: "#/components/schemas/ResultItem" GraphicsResult: - $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult" + title: "GraphicsResult" + description: "Graphic fields extracted from one of the document sources. + Returns separate results for each provided page." + required: + - DocGraphicsInfo + allOf: + - type: object + properties: + DocGraphicsInfo: + $ref: "./rt-image-data.yml#/components/schemas/GraphicFieldsList" + - $ref: "#/components/schemas/ResultItem" ByteArrayResult: - $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayResult" + title: "ByteArrayResult" + allOf: + - type: object + required: + - ByteArray + properties: + ByteArray: + description: "Byte array in base64" + type: string + - $ref: "#/components/schemas/ResultItem" LexicalAnalysisResult: - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/LexicalAnalysisResult" + title: "LexicalAnalysisResult" + description: | + Lexical data analysis allows you to compare the results of reading the text data of the MRZ, + the document filling area, barcodes and data from the memory of the RFID chip for an additional + assessment of the authenticity of the document. Single result for all pages. + Consider using Result.TEXT type for more simplicity. + allOf: + - type: object + required: + - ListVerifiedFields + properties: + ListVerifiedFields: + $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/ListVerifiedFields" + - $ref: "#/components/schemas/ResultItem" AuthenticityResult: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityResult" + title: "AuthenticityResult" + allOf: + - type: object + required: + - AuthenticityCheckList + properties: + AuthenticityCheckList: + $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityCheckList" + - $ref: "#/components/schemas/ResultItem" ImageQualityResult: - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityResult" + title: "ImageQualityResult" + allOf: + - type: object + required: + - ImageQualityCheckList + properties: + ImageQualityCheckList: + $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityCheckList" + - $ref: "#/components/schemas/ResultItem" DocumentPositionResult: - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult" + title: "DocumentPositionResult" + description: "Contains information about document position on the input image, its center, angle, etc" + allOf: + - type: object + required: + - DocumentPosition + properties: + DocumentPosition: + $ref: "./rt-document-position.yml#/components/schemas/DocumentPosition" + - $ref: "#/components/schemas/ResultItem" DocBarCodeInfo: - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfo" + title: "DocBarCodeInfo" + description: "Raw data from BarCodes" + allOf: + - type: object + required: + - DocBarCodeInfo + properties: + DocBarCodeInfo: + $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfoFieldsList" + - $ref: "#/components/schemas/ResultItem" LicenseResult: - $ref: "./rt-license.yml#/components/schemas/LicenseResult" + title: "LicenseResult" + allOf: + - type: object + description: "Contains license" + required: + - License + properties: + License: + $ref: "./common.yml#/components/schemas/License" + - $ref: "#/components/schemas/ResultItem" EncryptedRCLResult: - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLResult" + title: "EncryptedRCLResult" + allOf: + - type: object + description: "Contains encrypted result container list" + required: + - EncryptedRCL + properties: + EncryptedRCL: + $ref: "./common.yml#/components/schemas/EncryptedRCL" + - $ref: "#/components/schemas/ResultItem" DocumentBinaryInfoResult: - $ref: "./rt-rfid-binary-data.yml#/components/schemas/DocumentBinaryInfoResult" + title: "DocumentBinaryInfoResult" + allOf: + - type: object + description: "Structure is used to store the data reading results from the RFID-chip in + a form of a list of the logically separated data groups." + required: + - TDocBinaryInfo + properties: + TDocBinaryInfo: + $ref: "./rt-rfid-binary-data.yml#/components/schemas/TDocBinaryInfo" + - $ref: "#/components/schemas/ResultItem" FaceDetectionResult: - $ref: "./rt-face-detection.yml#/components/schemas/FaceDetectionResult" + title: "FaceDetectionResult" + allOf: + - type: object + required: + - FaceDetection + properties: + FaceDetection: + $ref: "./rt-face-detection.yml#/components/schemas/FaceDetection" + - $ref: "#/components/schemas/ResultItem" MRZDetectorResult: - $ref: "./rt-mrz-detector.yml#/components/schemas/MRZDetectorResult" + title: "MRZDetectorResult" + allOf: + - type: object + required: + - ResultMRZDetector + properties: + ResultMRZDetector: + $ref: "./rt-mrz-detector.yml#/components/schemas/ResultMRZDetector" + - $ref: "#/components/schemas/ResultItem" MRZPositionResult: - $ref: "./rt-mrz-position.yml#/components/schemas/MRZPositionResult" + title: "MRZPositionResult" + allOf: + - type: object + required: + - MrzPosition + properties: + MrzPosition: + $ref: "./rt-mrz-position.yml#/components/schemas/MrzPosition" + - $ref: "#/components/schemas/ResultItem" MRZTestQualityResult: - $ref: "./rt-mrz-test-quality.yml#/components/schemas/MRZTestQualityResult" + title: "MRZTestQualityResult" + allOf: + - type: object + required: + - MRZTestQuality + properties: + MRZTestQuality: + $ref: "./rt-mrz-test-quality.yml#/components/schemas/MRZTestQuality" + - $ref: "#/components/schemas/ResultItem" From f8122958fa840c4d2b30817ff4ac99793147bbc0 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 7 Mar 2025 16:49:03 +0300 Subject: [PATCH 047/106] SP-18211 - Add new schemas --- rt-rfid-binary-data.yml | 79 +++++++++++++++++++++++++++------------ rt-rfid-graphics-info.yml | 52 ++++++++++++++++++++++++++ rt.yml | 14 +++++++ 3 files changed, 121 insertions(+), 24 deletions(-) create mode 100644 rt-rfid-graphics-info.yml diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 23021c2..acbda16 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -4,11 +4,13 @@ components: TDocBinaryInfo: title: "TDocBinaryInfo" type: object - required: - - RFID_BINARY_DATA properties: RFID_BINARY_DATA: $ref: "#/components/schemas/BinaryData" + RFID_RAW_DATA: + type: array + items: + $ref: "#/components/schemas/RfidRawData" BinaryData: title: "BinaryData" @@ -283,10 +285,6 @@ components: session with electronic document" type: object required: - - VirtualMode - - SDKVersion - - DriverVersion - - FirmwareVersion - Applications - AccessControls - CardProperties @@ -303,12 +301,16 @@ components: VirtualMode: description: "Sign of virtual session when working with loaded data from a previous communication session with the electronic document" + type: string SDKVersion: description: "Text SDKVersion value in format A.B (e.g. 3.1)" + type: string DriverVersion: description: "Text DriverVersion value in format A.B.C.D (e.g. 6.2.5.4)" + type: string FirmwareVersion: description: "Text FirmwareVersion value in format A.B (e.g. 5.19)" + type: string Applications: description: "List of containers to store information about the involved applications of electronic document" type: array @@ -348,6 +350,8 @@ components: type: array items: $ref: "#/components/schemas/RfidSecurityObject" + Status: + $ref: "./common.yml#/components/schemas/CheckResult" RfidSecurityObject: title: "RfidSecurityObject" @@ -582,21 +586,14 @@ components: data groups." type: object required: - - Type - - Status - - Format - Data properties: Type: - oneOf: - - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" - - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + type: integer Status: description: "Result of logical analysis of compliance of the contents of the field with the requirements of the specification" - oneOf: - - $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" - - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + type: integer Format: description: "Mask of format of text information (for example, «YYMMDD» for date of birth)" type: string @@ -687,12 +684,6 @@ components: required: - Type - ReadingStatus - - ReadingTime - - PA_Status - - Notifications - - DocFields_Text - - DocFields_Graphics - - DocFields_Originals properties: FileID: description: "File identifier. Each byte of FileID represented by its hexadecimal value. The individual bytes are separated by spaces (e.g. 01 1E)" @@ -728,6 +719,35 @@ components: type: array items: $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" + ParsedData: + $ref: "#/components/schemas/ParsedData" + SecurityObject_Certificates: + $ref: "#/components/schemas/SecurityObjectCertificates" + + SecurityObjectCertificates: + type: object + properties: + Certificate_Data: + $ref: "#/components/schemas/CertificateData" + + CertificateData: + type: object + required: + - Data + - Length + properties: + Data: + type: string + Length: + type: string + + ParsedData: + title: "ParsedData" + properties: + ParsingNotifications: + type: array + items: + type: integer TrfFtBytes: title: "TrfFtBytes" @@ -741,9 +761,7 @@ components: properties: Type: description: "Logical type of the field" - oneOf: - - $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" - - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + type: integer Status: description: "Result of logical analysis of compliance of the contents of the field with the requirements of the specification" @@ -754,6 +772,7 @@ components: Data: description: "Binary data array. Base64 encoded." type: string + nullable: true RfidAccessControlInfo: title: "RfidAccessControlInfo" @@ -1131,3 +1150,15 @@ components: - "DEV_LS" - "DEF_LS" - "BLS" + + RfidRawData: + title: "RfidRawData" + type: object + required: + - Data + - FieldType + properties: + Data: + type: string + FieldType: + type: integer diff --git a/rt-rfid-graphics-info.yml b/rt-rfid-graphics-info.yml new file mode 100644 index 0000000..403dc9f --- /dev/null +++ b/rt-rfid-graphics-info.yml @@ -0,0 +1,52 @@ +openapi: 3.0.4 +components: + schemas: + TOriginalRFIDGraphicsInfo: + title: "TOriginalRFIDGraphicsInfo" + type: object + required: + - RFID_ORIGINAL_GRAPH_DATA + properties: + RFID_ORIGINAL_GRAPH_DATA: + type: array + items: + $ref: "#/components/schemas/GraphData" + + GraphData: + title: "GraphData" + type: object + required: + - FieldType + - File_Image + - GraphicsType + - OriginDG + - OriginDGTag + - OriginEntryView + - OriginTagEntry + properties: + FieldType: + type: integer + File_Image: + $ref: "#/components/schemas/FileImage" + GraphicsType: + type: integer + OriginDG: + type: integer + OriginDGTag: + type: integer + OriginEntryView: + type: integer + OriginTagEntry: + type: integer + + FileImage: + title: "FileImage" + type: object + required: + - Data + - Length + properties: + Data: + type: string + Length: + type: integer diff --git a/rt.yml b/rt.yml index ac92312..47e1d26 100644 --- a/rt.yml +++ b/rt.yml @@ -172,9 +172,11 @@ components: 85: "DocumentPositionResult" 87: "MRZDetectorResult" 97: "FaceDetectionResult" + 101: "DocumentBinaryInfoResult" 102: "TextDataResult" 103: "GraphicsResult" 104: "DocumentBinaryInfoResult" + 105: "RFIDGraphicsInfoResult" 109: "ByteArrayResult" ContainerList: @@ -213,6 +215,7 @@ components: - $ref: "#/components/schemas/MRZDetectorResult" - $ref: "#/components/schemas/MRZPositionResult" - $ref: "#/components/schemas/MRZTestQualityResult" + - $ref: "#/components/schemas/RFIDGraphicsInfoResult" StatusResult: title: "StatusResult" @@ -464,3 +467,14 @@ components: MRZTestQuality: $ref: "./rt-mrz-test-quality.yml#/components/schemas/MRZTestQuality" - $ref: "#/components/schemas/ResultItem" + + RFIDGraphicsInfoResult: + title: "RFIDGraphicsInfoResult" + allOf: + - type: object + required: + - TOriginalRFIDGraphicsInfo + properties: + TOriginalRFIDGraphicsInfo: + $ref: "./rt-rfid-graphics-info.yml#/components/schemas/TOriginalRFIDGraphicsInfo" + - $ref: "#/components/schemas/ResultItem" From 78ab764fb3ab9326925ad4d74cd4672e12993f82 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 7 Mar 2025 17:59:23 +0300 Subject: [PATCH 048/106] SP-18211 - Update schemas --- rt-rfid-binary-data.yml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index acbda16..9134430 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -378,7 +378,7 @@ components: description: "List of remarks arisen during the analysis of SO data structure." type: array items: - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" SignerInfos: description: "List of containers to store information about digital signature objects contained in the SO" type: array @@ -438,7 +438,9 @@ components: description: "Binary data array used to calculate the hash value for digital signature verification. Base64 encoded." type: string Notifications: - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + type: array + items: + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" RfidCertificateEx: title: "RfidCertificateEx" @@ -490,7 +492,7 @@ components: structure and its validity verification." type: array items: - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" Origin: $ref: "#/components/schemas/RfidCertificateOrigin" Type: @@ -703,7 +705,7 @@ components: description: "List of remarks arisen when reading data from the memory of the chip and analysing their ASN.1-structure." type: array items: - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" DocFields_Text: description: "List of document text fields formed on the basis of the file contents" type: array @@ -748,6 +750,7 @@ components: type: array items: type: integer + format: int64 TrfFtBytes: title: "TrfFtBytes" @@ -795,7 +798,7 @@ components: description: "List of remarks arisen during the procedure." type: array items: - $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" + $ref: "./e-parsing-notification-codes.yml#/components/schemas/ParsingNotificationCodes" AccessControlOptions: description: "List of structures with are used to describe the variants of the authentication or secure data access procedure performance within the context of the communication session with electronic document" From 5e7089c8c548ba97dce34141cb9296d83b0a4d02 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 10 Mar 2025 13:17:40 +0300 Subject: [PATCH 049/106] SP-18211 - Update schemas --- rt-authenticity.yml | 9 ++ rt-barcodes.yml | 9 ++ rt-byte-array-data.yml | 12 +++ rt-doc-type-old.yml | 19 +++++ rt-document-position.yml | 9 ++ rt-encrypted-rcl.yml | 11 +++ rt-face-detection.yml | 9 ++ rt-image-data.yml | 9 ++ rt-image-quality.yml | 9 ++ rt-images.yml | 9 ++ rt-license.yml | 11 +++ rt-mrz-detector.yml | 9 ++ rt-mrz-position.yml | 9 ++ rt-mrz-test-quality.yml | 9 ++ rt-ocr-lexical-analysis.yml | 9 ++ rt-raw-image.yml | 11 +++ rt-rfid-binary-data.yml | 9 ++ rt-rfid-graphics-info.yml | 9 ++ rt-status.yml | 9 ++ rt-text-data.yml | 9 ++ rt-text.yml | 9 ++ rt.yml | 164 ++++++------------------------------ 22 files changed, 234 insertions(+), 138 deletions(-) create mode 100644 rt-byte-array-data.yml create mode 100644 rt-encrypted-rcl.yml create mode 100644 rt-license.yml create mode 100644 rt-raw-image.yml diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 652b542..9794764 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + AuthenticityCheckListItem: + title: "AuthenticityCheckListItem" + type: object + required: + - AuthenticityCheckList + properties: + AuthenticityCheckList: + $ref: "#/components/schemas/AuthenticityCheckList" + AuthenticityCheckList: title: "AuthenticityCheckList" type: object diff --git a/rt-barcodes.yml b/rt-barcodes.yml index 7db3ef2..bd25561 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + DocBarCodeInfoItem: + title: "DocBarCodeInfoItem" + type: object + required: + - DocBarCodeInfo + properties: + DocBarCodeInfo: + $ref: "#/components/schemas/DocBarCodeInfoFieldsList" + DocBarCodeInfoFieldsList: title: "DocBarCodeInfoFieldsList" type: object diff --git a/rt-byte-array-data.yml b/rt-byte-array-data.yml new file mode 100644 index 0000000..c74bd74 --- /dev/null +++ b/rt-byte-array-data.yml @@ -0,0 +1,12 @@ +openapi: 3.0.4 +components: + schemas: + ByteArrayItem: + title: "ByteArrayItem" + type: object + required: + - ByteArray + properties: + ByteArray: + description: "Byte array in base64" + type: string diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index e3cbd46..c347d18 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -1,6 +1,25 @@ openapi: 3.0.4 components: schemas: + CandidatesListItem: + title: "CandidatesListItem" + type: object + properties: + CandidatesList: + $ref: "#/components/schemas/DocumentTypesCandidatesList" + + OneCandidateItem: + title: "OneCandidateItem" + type: object + required: + - OneCandidate + properties: + OneCandidate: + $ref: "#/components/schemas/OneCandidate" + XML_buffer: + type: string + readOnly: true + DocumentTypesCandidatesList: title: "DocumentTypesCandidatesList" type: object diff --git a/rt-document-position.yml b/rt-document-position.yml index 2f8bd5f..8648d8b 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + DocumentPositionItem: + title: "DocumentPositionItem" + type: object + required: + - DocumentPosition + properties: + DocumentPosition: + $ref: "#/components/schemas/DocumentPosition" + DocumentPosition: title: "DocumentPosition" type: object diff --git a/rt-encrypted-rcl.yml b/rt-encrypted-rcl.yml new file mode 100644 index 0000000..592f61a --- /dev/null +++ b/rt-encrypted-rcl.yml @@ -0,0 +1,11 @@ +openapi: 3.0.4 +components: + schemas: + EncryptedRCLItem: + title: "EncryptedRCLItem" + type: object + required: + - EncryptedRCL + properties: + EncryptedRCL: + $ref: "./common.yml#/components/schemas/EncryptedRCL" diff --git a/rt-face-detection.yml b/rt-face-detection.yml index af555f7..44b29a8 100644 --- a/rt-face-detection.yml +++ b/rt-face-detection.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + FaceDetectionItem: + title: "FaceDetectionItem" + type: object + required: + - FaceDetection + properties: + FaceDetection: + $ref: "#/components/schemas/FaceDetection" + FaceDetection: title: "FaceDetection" type: object diff --git a/rt-image-data.yml b/rt-image-data.yml index 2424f71..0d9062c 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + DocGraphicsInfoItem: + title: "DocGraphicsInfoItem" + type: object + required: + - DocGraphicsInfo + properties: + DocGraphicsInfo: + $ref: "#/components/schemas/GraphicFieldsList" + GraphicFieldsList: title: "GraphicFieldsList" type: object diff --git a/rt-image-quality.yml b/rt-image-quality.yml index db227ea..eed0eaa 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + ImageQualityCheckListItem: + title: "ImageQualityCheckListItem" + type: object + required: + - ImageQualityCheckList + properties: + ImageQualityCheckList: + $ref: "#/components/schemas/ImageQualityCheckList" + ImageQualityCheckList: title: "ImageQualityCheckList" type: object diff --git a/rt-images.yml b/rt-images.yml index 951425f..8b8eb78 100644 --- a/rt-images.yml +++ b/rt-images.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + ImagesItem: + title: "ImagesItem" + type: object + required: + - Images + properties: + Images: + $ref: "#/components/schemas/Images" + Images: title: "Images" type: object diff --git a/rt-license.yml b/rt-license.yml new file mode 100644 index 0000000..2bb89be --- /dev/null +++ b/rt-license.yml @@ -0,0 +1,11 @@ +openapi: 3.0.4 +components: + schemas: + LicenseItem: + title: "LicenseItem" + type: object + required: + - License + properties: + License: + $ref: "./common.yml#/components/schemas/License" diff --git a/rt-mrz-detector.yml b/rt-mrz-detector.yml index bc223c2..31d56e3 100644 --- a/rt-mrz-detector.yml +++ b/rt-mrz-detector.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + ResultMRZDetectorItem: + title: "ResultMRZDetectorItem" + type: object + required: + - ResultMRZDetector + properties: + ResultMRZDetector: + $ref: "#/components/schemas/ResultMRZDetector" + ResultMRZDetector: title: "ResultMRZDetector" type: object diff --git a/rt-mrz-position.yml b/rt-mrz-position.yml index cfd818a..293102d 100644 --- a/rt-mrz-position.yml +++ b/rt-mrz-position.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + MrzPositionItem: + title: "MrzPositionItem" + type: object + required: + - MrzPosition + properties: + MrzPosition: + $ref: "#/components/schemas/MrzPosition" + MrzPosition: title: "MrzPosition" type: object diff --git a/rt-mrz-test-quality.yml b/rt-mrz-test-quality.yml index 5c96c7e..9838ffc 100644 --- a/rt-mrz-test-quality.yml +++ b/rt-mrz-test-quality.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + MRZTestQualityItem: + title: "MRZTestQualityItem" + type: object + required: + - MRZTestQuality + properties: + MRZTestQuality: + $ref: "#/components/schemas/MRZTestQuality" + MRZTestQuality: title: "MRZTestQuality" type: object diff --git a/rt-ocr-lexical-analysis.yml b/rt-ocr-lexical-analysis.yml index 14f7299..113eb18 100644 --- a/rt-ocr-lexical-analysis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + ListVerifiedFieldsItem: + title: "ListVerifiedFields" + type: object + required: + - ListVerifiedFields + properties: + ListVerifiedFields: + $ref: "#/components/schemas/ListVerifiedFields" + ListVerifiedFields: title: "ListVerifiedFields" type: object diff --git a/rt-raw-image.yml b/rt-raw-image.yml new file mode 100644 index 0000000..99c8f61 --- /dev/null +++ b/rt-raw-image.yml @@ -0,0 +1,11 @@ +openapi: 3.0.4 +components: + schemas: + RawImageContainerItem: + title: "RawImageContainerItem" + type: object + required: + - RawImageContainer + properties: + RawImageContainer: + $ref: "./common.yml#/components/schemas/ImageData" diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 9134430..1b74f8b 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + TDocBinaryInfoItem: + title: "TDocBinaryInfoItem" + type: object + required: + - TDocBinaryInfo + properties: + TDocBinaryInfo: + $ref: "#/components/schemas/TDocBinaryInfo" + TDocBinaryInfo: title: "TDocBinaryInfo" type: object diff --git a/rt-rfid-graphics-info.yml b/rt-rfid-graphics-info.yml index 403dc9f..c8a5527 100644 --- a/rt-rfid-graphics-info.yml +++ b/rt-rfid-graphics-info.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + TOriginalRFIDGraphicsInfoItem: + title: "TOriginalRFIDGraphicsInfoItem" + type: object + required: + - TOriginalRFIDGraphicsInfo + properties: + TOriginalRFIDGraphicsInfo: + $ref: "#/components/schemas/TOriginalRFIDGraphicsInfo" + TOriginalRFIDGraphicsInfo: title: "TOriginalRFIDGraphicsInfo" type: object diff --git a/rt-status.yml b/rt-status.yml index 9e88234..b0cd7ed 100644 --- a/rt-status.yml +++ b/rt-status.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + StatusItem: + title: "StatusItem" + type: object + required: + - Status + properties: + Status: + $ref: "#/components/schemas/Status" + Status: title: "Status" type: object diff --git a/rt-text-data.yml b/rt-text-data.yml index bb7c4b1..e229e7f 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + DocVisualExtendedInfoItem: + title: "DocVisualExtendedInfoItem" + type: object + required: + - DocVisualExtendedInfo + properties: + DocVisualExtendedInfo: + $ref: "#/components/schemas/DocVisualExtendedInfo" + DocVisualExtendedInfo: title: "DocVisualExtendedInfo" type: object diff --git a/rt-text.yml b/rt-text.yml index e80ed26..597fd0d 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -1,6 +1,15 @@ openapi: 3.0.4 components: schemas: + TextItem: + title: "TextItem" + type: object + required: + - Text + properties: + Text: + $ref: "#/components/schemas/Text" + Text: title: "Text" type: object diff --git a/rt.yml b/rt.yml index 47e1d26..b2bbe3f 100644 --- a/rt.yml +++ b/rt.yml @@ -220,110 +220,63 @@ components: StatusResult: title: "StatusResult" allOf: - - type: object - required: - - Status - properties: - Status: - $ref: "./rt-status.yml#/components/schemas/Status" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-status.yml#/components/schemas/StatusItem" TextResult: title: "TextResult" allOf: - - type: object - required: - - Text - properties: - Text: - $ref: "./rt-text.yml#/components/schemas/Text" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-text.yml#/components/schemas/TextItem" DocumentImageResult: title: "DocumentImageResult" description: "Contains document image." allOf: - - type: object - required: - - RawImageContainer - properties: - RawImageContainer: - $ref: "./common.yml#/components/schemas/ImageData" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-raw-image.yml#/components/schemas/RawImageContainerItem" ImagesResult: title: "ImagesResult" allOf: - - type: object - required: - - Images - properties: - Images: - $ref: "./rt-images.yml#/components/schemas/Images" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-images.yml#/components/schemas/ImagesItem" ChosenDocumentTypeResult: title: "ChosenDocumentTypeResult" description: "Contains information about the type of document that was determined based on the analysis of the provided image" allOf: - - type: object - required: - - OneCandidate - properties: - OneCandidate: - $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" - XML_buffer: - type: string - readOnly: true - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidateItem" DocumentTypesCandidatesResult: title: "DocumentTypesCandidatesResult" allOf: - - type: object - properties: - CandidatesList: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-doc-type-old.yml#/components/schemas/CandidatesListItem" TextDataResult: title: "TextDataResult" description: "Text fields extracted from one document source. Contains results of specific source for each provided page." allOf: - - type: object - required: - - DocVisualExtendedInfo - properties: - DocVisualExtendedInfo: - $ref: "./rt-text-data.yml#/components/schemas/DocVisualExtendedInfo" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-text-data.yml#/components/schemas/DocVisualExtendedInfoItem" GraphicsResult: title: "GraphicsResult" description: "Graphic fields extracted from one of the document sources. Returns separate results for each provided page." - required: - - DocGraphicsInfo allOf: - - type: object - properties: - DocGraphicsInfo: - $ref: "./rt-image-data.yml#/components/schemas/GraphicFieldsList" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-image-data.yml#/components/schemas/DocGraphicsInfoItem" ByteArrayResult: title: "ByteArrayResult" allOf: - - type: object - required: - - ByteArray - properties: - ByteArray: - description: "Byte array in base64" - type: string - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayItem" LexicalAnalysisResult: title: "LexicalAnalysisResult" @@ -333,148 +286,83 @@ components: assessment of the authenticity of the document. Single result for all pages. Consider using Result.TEXT type for more simplicity. allOf: - - type: object - required: - - ListVerifiedFields - properties: - ListVerifiedFields: - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/ListVerifiedFields" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-ocr-lexical-analysis.yml#/components/schemas/ListVerifiedFieldsItem" AuthenticityResult: title: "AuthenticityResult" allOf: - - type: object - required: - - AuthenticityCheckList - properties: - AuthenticityCheckList: - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityCheckList" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-authenticity.yml#/components/schemas/AuthenticityCheckListItem" ImageQualityResult: title: "ImageQualityResult" allOf: - - type: object - required: - - ImageQualityCheckList - properties: - ImageQualityCheckList: - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityCheckList" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-image-quality.yml#/components/schemas/ImageQualityCheckListItem" DocumentPositionResult: title: "DocumentPositionResult" description: "Contains information about document position on the input image, its center, angle, etc" allOf: - - type: object - required: - - DocumentPosition - properties: - DocumentPosition: - $ref: "./rt-document-position.yml#/components/schemas/DocumentPosition" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionItem" DocBarCodeInfo: title: "DocBarCodeInfo" description: "Raw data from BarCodes" allOf: - - type: object - required: - - DocBarCodeInfo - properties: - DocBarCodeInfo: - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfoFieldsList" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-barcodes.yml#/components/schemas/DocBarCodeInfoItem" LicenseResult: title: "LicenseResult" + description: "Contains license" allOf: - - type: object - description: "Contains license" - required: - - License - properties: - License: - $ref: "./common.yml#/components/schemas/License" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-license.yml#/components/schemas/LicenseItem" EncryptedRCLResult: title: "EncryptedRCLResult" + description: "Contains encrypted result container list" allOf: - - type: object - description: "Contains encrypted result container list" - required: - - EncryptedRCL - properties: - EncryptedRCL: - $ref: "./common.yml#/components/schemas/EncryptedRCL" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-encrypted-rcl.yml#/components/schemas/EncryptedRCLItem" DocumentBinaryInfoResult: title: "DocumentBinaryInfoResult" + description: "Structure is used to store the data reading results from the RFID-chip in + a form of a list of the logically separated data groups." allOf: - - type: object - description: "Structure is used to store the data reading results from the RFID-chip in - a form of a list of the logically separated data groups." - required: - - TDocBinaryInfo - properties: - TDocBinaryInfo: - $ref: "./rt-rfid-binary-data.yml#/components/schemas/TDocBinaryInfo" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-rfid-binary-data.yml#/components/schemas/TDocBinaryInfoItem" FaceDetectionResult: title: "FaceDetectionResult" allOf: - - type: object - required: - - FaceDetection - properties: - FaceDetection: - $ref: "./rt-face-detection.yml#/components/schemas/FaceDetection" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-face-detection.yml#/components/schemas/FaceDetectionItem" MRZDetectorResult: title: "MRZDetectorResult" allOf: - - type: object - required: - - ResultMRZDetector - properties: - ResultMRZDetector: - $ref: "./rt-mrz-detector.yml#/components/schemas/ResultMRZDetector" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-mrz-detector.yml#/components/schemas/ResultMRZDetectorItem" MRZPositionResult: title: "MRZPositionResult" allOf: - - type: object - required: - - MrzPosition - properties: - MrzPosition: - $ref: "./rt-mrz-position.yml#/components/schemas/MrzPosition" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-mrz-position.yml#/components/schemas/MrzPositionItem" MRZTestQualityResult: title: "MRZTestQualityResult" allOf: - - type: object - required: - - MRZTestQuality - properties: - MRZTestQuality: - $ref: "./rt-mrz-test-quality.yml#/components/schemas/MRZTestQuality" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-mrz-test-quality.yml#/components/schemas/MRZTestQualityItem" RFIDGraphicsInfoResult: title: "RFIDGraphicsInfoResult" allOf: - - type: object - required: - - TOriginalRFIDGraphicsInfo - properties: - TOriginalRFIDGraphicsInfo: - $ref: "./rt-rfid-graphics-info.yml#/components/schemas/TOriginalRFIDGraphicsInfo" - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-rfid-graphics-info.yml#/components/schemas/TOriginalRFIDGraphicsInfoItem" From 614151f7131f45b5ad8beb771a5f413b7494d58e Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 10 Mar 2025 14:00:46 +0300 Subject: [PATCH 050/106] SP-18211 - Update schemas --- authenticity/rt-fiber.yml | 100 +++++++++++++------------- authenticity/rt-ident.yml | 44 ++++++------ authenticity/rt-ocr-security-text.yml | 74 ++++++++++--------- authenticity/rt-photo-ident.yml | 68 +++++++++--------- authenticity/rt-security-feature.yml | 44 ++++++------ rt-authenticity.yml | 35 ++++++--- rt-image-data.yml | 50 +++++++------ rt-text-data.yml | 56 ++++++++------- 8 files changed, 245 insertions(+), 226 deletions(-) diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index 9508c32..875c8ba 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -1,54 +1,52 @@ openapi: 3.0.4 components: schemas: - FiberResult: - title: "FiberResult" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - required: - - RectCount - - ExpectedCount - - RectArray - - Width - - Length - - Area - - ColorValues - properties: - RectCount: - description: "For UV_Fibers authenticity result type" - type: integer - ExpectedCount: - description: "Expected fibers number. For UV_Fibers authentication result type" - type: integer - LightValue: # For UV_Background authentication result type - $ref: "../common.yml#/components/schemas/Light" - LightDisp: - description: "For UV_Background authentication result type" - type: integer - RectArray: - description: "Coordinates of located areas for defined fibers type" - type: array - items: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - Width: - description: "Fibers width value for located areas (in pixels)" - type: array - items: - type: integer - Length: - description: "Fibers length value for located areas (in pixels)" - type: array - items: - type: integer - Area: - description: "Fibers value for areas (in pixels)" - type: array - items: - type: integer - ColorValues: - description: "Fibers color value" - example: [BLUE, GREEN, RED] - type: array - items: - type: integer + FiberItem: + title: "FiberItem" + type: object + required: + - RectCount + - ExpectedCount + - RectArray + - Width + - Length + - Area + - ColorValues + properties: + RectCount: + description: "For UV_Fibers authenticity result type" + type: integer + ExpectedCount: + description: "Expected fibers number. For UV_Fibers authentication result type" + type: integer + LightValue: # For UV_Background authentication result type + $ref: "../common.yml#/components/schemas/Light" + LightDisp: + description: "For UV_Background authentication result type" + type: integer + RectArray: + description: "Coordinates of located areas for defined fibers type" + type: array + items: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + Width: + description: "Fibers width value for located areas (in pixels)" + type: array + items: + type: integer + Length: + description: "Fibers length value for located areas (in pixels)" + type: array + items: + type: integer + Area: + description: "Fibers value for areas (in pixels)" + type: array + items: + type: integer + ColorValues: + description: "Fibers color value" + example: [BLUE, GREEN, RED] + type: array + items: + type: integer diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index 76382c0..9f7a747 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -1,26 +1,24 @@ openapi: 3.0.4 components: schemas: - IdentResult: - title: "IdentResult" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - required: - - ElementType - - LightIndex - - Image - - EtalonImage - properties: - ElementType: - $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" - LightIndex: - $ref: "../common.yml#/components/schemas/Light" - Area: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - Image: # Original image - $ref: "../common.yml#/components/schemas/ImageData" - EtalonImage: # Reference image - $ref: "../common.yml#/components/schemas/ImageData" - AreaList: - $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" + IdentItem: + title: "IdentItem" + type: object + required: + - ElementType + - LightIndex + - Image + - EtalonImage + properties: + ElementType: + $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" + LightIndex: + $ref: "../common.yml#/components/schemas/Light" + Area: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + Image: # Original image + $ref: "../common.yml#/components/schemas/ImageData" + EtalonImage: # Reference image + $ref: "../common.yml#/components/schemas/ImageData" + AreaList: + $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index 5d6491c..d85daf2 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -1,41 +1,39 @@ openapi: 3.0.4 components: schemas: - OCRSecurityTextResult: - title: "OCRSecurityTextResult" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - required: - - CriticalFlag - - LightType - - FieldRect - - EtalonResultType - - EtalonFieldType - - EtalonLightType - - EtalonFieldRect - - SecurityTextResultOCR - - EtalonResultOCR - properties: - CriticalFlag: - $ref: "./e-critical.yml#/components/schemas/Critical" - LightType: - $ref: "../common.yml#/components/schemas/Light" - FieldRect: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - EtalonResultType: - type: integer - EtalonFieldType: - type: integer - EtalonLightType: - type: integer - EtalonFieldRect: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - SecurityTextResultOCR: - type: string - EtalonResultOCR: - type: string - Reserved1: - type: integer - Reserved2: - type: integer + OCRSecurityTextItem: + title: "OCRSecurityTextItem" + type: object + required: + - CriticalFlag + - LightType + - FieldRect + - EtalonResultType + - EtalonFieldType + - EtalonLightType + - EtalonFieldRect + - SecurityTextResultOCR + - EtalonResultOCR + properties: + CriticalFlag: + $ref: "./e-critical.yml#/components/schemas/Critical" + LightType: + $ref: "../common.yml#/components/schemas/Light" + FieldRect: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + EtalonResultType: + type: integer + EtalonFieldType: + type: integer + EtalonLightType: + type: integer + EtalonFieldRect: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + SecurityTextResultOCR: + type: string + EtalonResultOCR: + type: string + Reserved1: + type: integer + Reserved2: + type: integer diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 6642b53..929bf8f 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -1,41 +1,39 @@ openapi: 3.0.4 components: schemas: - PhotoIdentResult: - title: "PhotoIdentResult" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - required: - - LightIndex - - Area - - SourceImage - - ResultImages - properties: - LightIndex: - $ref: "../common.yml#/components/schemas/Light" - Area: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - SourceImage: - $ref: "../common.yml#/components/schemas/ImageData" - ResultImages: - $ref: "#/components/schemas/RawImageContainerList" - FieldTypesCount: - type: integer - FieldTypesList: - type: array - items: - type: integer - Step: - type: integer - Angle: - type: integer - Reserved1: - type: integer - Reserved2: - type: integer - Reserved3: - type: integer + PhotoIdentItem: + title: "PhotoIdentItem" + type: object + required: + - LightIndex + - Area + - SourceImage + - ResultImages + properties: + LightIndex: + $ref: "../common.yml#/components/schemas/Light" + Area: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + SourceImage: + $ref: "../common.yml#/components/schemas/ImageData" + ResultImages: + $ref: "#/components/schemas/RawImageContainerList" + FieldTypesCount: + type: integer + FieldTypesList: + type: array + items: + type: integer + Step: + type: integer + Angle: + type: integer + Reserved1: + type: integer + Reserved2: + type: integer + Reserved3: + type: integer RawImageContainerList: title: "RawImageContainerList" diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index 3547d36..0693bf6 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -1,26 +1,24 @@ openapi: 3.0.4 components: schemas: - SecurityFeatureResult: - title: "SecurityFeatureResult" - allOf: - - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem" - - type: object - required: - - ElementType - - ElementRect - - Visibility - - CriticalFlag - properties: - ElementType: - $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" - ElementRect: - $ref: "../common.yml#/components/schemas/RectangleCoordinates" - Visibility: - $ref: "./e-visibility.yml#/components/schemas/Visibility" - CriticalFlag: - $ref: "./e-critical.yml#/components/schemas/Critical" - AreaList: - $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" - Reserved2: - type: integer + SecurityFeatureItem: + title: "SecurityFeatureItem" + type: object + required: + - ElementType + - ElementRect + - Visibility + - CriticalFlag + properties: + ElementType: + $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType" + ElementRect: + $ref: "../common.yml#/components/schemas/RectangleCoordinates" + Visibility: + $ref: "./e-visibility.yml#/components/schemas/Visibility" + CriticalFlag: + $ref: "./e-critical.yml#/components/schemas/Critical" + AreaList: + $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" + Reserved2: + type: integer diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 9794764..4f8a9a8 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -45,26 +45,41 @@ components: type: array items: oneOf: - - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" - - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" - - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" - - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" - - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" + - $ref: "#/components/schemas/SecurityFeatureResult" + - $ref: "#/components/schemas/IdentResult" + - $ref: "#/components/schemas/FiberResult" + - $ref: "#/components/schemas/OCRSecurityTextResult" + - $ref: "#/components/schemas/PhotoIdentResult" SecurityFeatureResult: - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureResult" + title: "SecurityFeatureResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-security-feature.yml#/components/schemas/SecurityFeatureItem" IdentResult: - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentResult" + title: "IdentResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-ident.yml#/components/schemas/IdentItem" FiberResult: - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberResult" + title: "FiberResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-fiber.yml#/components/schemas/FiberItem" OCRSecurityTextResult: - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextResult" + title: "OCRSecurityTextResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-ocr-security-text.yml#/components/schemas/OCRSecurityTextItem" PhotoIdentResult: - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentResult" + title: "PhotoIdentResult" + allOf: + - $ref: "#/components/schemas/AuthenticityCheckResultItem" + - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentItem" AuthenticityType: title: "AuthenticityType" diff --git a/rt-image-data.yml b/rt-image-data.yml index 0d9062c..49ce02f 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -30,38 +30,46 @@ components: GraphicFieldRect: title: "GraphicFieldRect" description: "Information about one graphic field, which is a rectangle" - required: - - FieldRect allOf: - - type: object - properties: - FieldRect: - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - $ref: "#/components/schemas/GraphicField" + - $ref: "#/components/schemas/GraphicFieldRectItem" GraphicFieldRfid: title: "GraphicFieldRfid" description: "Information about one graphic field, which is a RFID" + allOf: + - $ref: "#/components/schemas/GraphicField" + - $ref: "#/components/schemas/GraphicFieldRfidItem" + + GraphicFieldRectItem: + title: "GraphicFieldRectItem" + type: object + required: + - FieldRect + properties: + FieldRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + + GraphicFieldRfidItem: + title: "GraphicFieldRfidItem" + type: object required: - RFID_OriginDG - RFID_OriginDGTag - RFID_OriginTagEntry - RFID_OriginEntryView - allOf: - - type: object - properties: - RFID_OriginDG: - $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" - RFID_OriginDGTag: - description: "Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result." - type: integer - RFID_OriginTagEntry: - type: integer - description: "Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result." - RFID_OriginEntryView: - type: integer - description: "Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result." - - $ref: "#/components/schemas/GraphicField" + properties: + RFID_OriginDG: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + RFID_OriginDGTag: + description: "Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result." + type: integer + RFID_OriginTagEntry: + type: integer + description: "Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result." + RFID_OriginEntryView: + type: integer + description: "Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result." GraphicField: title: "GraphicField" diff --git a/rt-text-data.yml b/rt-text-data.yml index e229e7f..7ae6a2a 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -28,38 +28,45 @@ components: - $ref: "#/components/schemas/DocVisualExtendedFieldRect" - $ref: "#/components/schemas/DocVisualExtendedFieldRfid" - DocVisualExtendedFieldRfid: - title: "DocVisualExtendedFieldRfid" + DocVisualExtendedFieldRect: + title: "DocVisualExtendedFieldRect" description: "Structure and serves for storing information from one text data field. - Variant with field logical type and RFID data." + Variant with field logical type and field rectangular area coordinates on the image." allOf: - - type: object - required: - - RFID_OriginDG - - RFID_OriginTagEntry - properties: - RFID_OriginDG: - $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" - RFID_OriginDGTag: - type: integer - RFID_OriginTagEntry: - description: "Record index of the text field source in the data group" - type: number - RFID_OriginEntryView: - type: integer - $ref: "#/components/schemas/DocVisualExtendedField" + - $ref: "#/components/schemas/DocVisualExtendedFieldRectItem" - DocVisualExtendedFieldRect: - title: "DocVisualExtendedFieldRect" + DocVisualExtendedFieldRfid: + title: "DocVisualExtendedFieldRfid" description: "Structure and serves for storing information from one text data field. - Variant with field logical type and field rectangular area coordinates on the image." + Variant with field logical type and RFID data." allOf: - - type: object - properties: - FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - $ref: "#/components/schemas/DocVisualExtendedField" + - $ref: "#/components/schemas/DocVisualExtendedFieldRfidItem" + DocVisualExtendedFieldRectItem: + title: "DocVisualExtendedFieldRectItem" + type: object + properties: + FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. + $ref: "./common.yml#/components/schemas/RectangleCoordinates" + + DocVisualExtendedFieldRfidItem: + title: "DocVisualExtendedFieldRfidItem" + type: object + required: + - RFID_OriginDG + - RFID_OriginTagEntry + properties: + RFID_OriginDG: + $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" + RFID_OriginDGTag: + type: integer + RFID_OriginTagEntry: + description: "Record index of the text field source in the data group" + type: number + RFID_OriginEntryView: + type: integer DocVisualExtendedField: title: "DocVisualExtendedField" @@ -109,7 +116,6 @@ components: Reserved3: type: integer - StringRecognitionResult: title: "StringRecognitionResult" type: object From feb1daea4115410c9a8979592eff681a2a2f3dd0 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 11 Mar 2025 17:54:27 +0300 Subject: [PATCH 051/106] SP-18211 - Update enum --- e-rfid-data-group-type-tag.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml index 5ad2208..75f6507 100644 --- a/e-rfid-data-group-type-tag.yml +++ b/e-rfid-data-group-type-tag.yml @@ -174,4 +174,5 @@ components: - "EDL_DG9" - "EDL_DG11" - "EDL_DG12" + - "EDL_DG13" - "EDL_DG14" From eab48ebcf5562e1f2d4145f1113645ebec71b2b7 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 12 Mar 2025 18:05:30 +0300 Subject: [PATCH 052/106] SP-18211 - Update schemas --- rt-mrz-detector.yml | 2 +- rt-mrz-test-quality.yml | 28 ++++++++++++++-------------- rt.yml | 1 - 3 files changed, 15 insertions(+), 16 deletions(-) diff --git a/rt-mrz-detector.yml b/rt-mrz-detector.yml index 31d56e3..9c0241a 100644 --- a/rt-mrz-detector.yml +++ b/rt-mrz-detector.yml @@ -30,7 +30,7 @@ components: boundingQuadrangle: type: array items: - type: integer + type: number MRZRowsItem: title: "MRZRowsItem" diff --git a/rt-mrz-test-quality.yml b/rt-mrz-test-quality.yml index 9838ffc..c311dcd 100644 --- a/rt-mrz-test-quality.yml +++ b/rt-mrz-test-quality.yml @@ -93,13 +93,13 @@ components: SYMBOLS_PARAM: type: integer SizeError_ALIGNMENT: - type: integer + type: number SizeError_DISTANCE: - type: integer + type: number SizeError_INTERVAL: - type: integer + type: number StringAngle: - type: integer + type: number StringBorders: $ref: "./common.yml#/components/schemas/RectangleCoordinates" SymbolsCount: @@ -152,17 +152,17 @@ components: SYMBOL_SIZE: type: integer SizeErrorAlignWithNext: - type: integer + type: number SizeErrorAlignWithPrev: - type: integer + type: number SizeErrorIntervWithNext: - type: integer + type: number SizeErrorIntervWithPrev: - type: integer + type: number SizeErrorSymbolHeight: - type: integer + type: number SizeErrorSymbolWidth: - type: integer + type: number SymbolBounds: $ref: "./common.yml#/components/schemas/RectangleCoordinates" @@ -200,10 +200,10 @@ components: - bottom properties: Left: - type: integer + type: number Top: - type: integer + type: number Right: - type: integer + type: number Bottom: - type: integer + type: number diff --git a/rt.yml b/rt.yml index b2bbe3f..508e80e 100644 --- a/rt.yml +++ b/rt.yml @@ -184,7 +184,6 @@ components: type: object description: "List with various objects, containing processing results" required: - - Count - List properties: Count: From f3c0b1390c368136ed4dd0eeecff9f00311f35a7 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 14 Mar 2025 17:24:56 +0300 Subject: [PATCH 053/106] SP-18211 - Update models --- common.yml | 122 ++++++++++++++++++++++++++++++ p-transaction.yml | 2 +- rt-image-data.yml | 51 +------------ rt-rfid-text-data.yml | 47 ++++++++++++ rt-text-data.yml | 168 ++---------------------------------------- rt.yml | 9 ++- 6 files changed, 190 insertions(+), 209 deletions(-) create mode 100644 rt-rfid-text-data.yml diff --git a/common.yml b/common.yml index 909b2a1..33e5d94 100644 --- a/common.yml +++ b/common.yml @@ -424,3 +424,125 @@ components: type: integer example: 5 description: "Estimated duration of validity for a child's passport, years. Default: 5." + + DocVisualExtendedFieldItem: + title: "DocVisualExtendedFieldItem" + type: object + required: + - FieldType + - wFieldType + - FieldName + - StringsCount + - StringsResult + - Buf_Length + - Buf_Text + properties: + FieldType: + type: integer + wFieldType: + $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" + FieldName: + description: "Field symbolic name (null-terminated string)" + type: string + StringsCount: + description: "Number of StringsResult array elements" + type: number + StringsResult: + type: array + description: "Array of recognizing probabilities for a each line of text field. + Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." + items: + $ref: "#/components/schemas/StringRecognitionResult" + Buf_Length: + description: "Buf_Text text string length" + type: number + Buf_Text: + type: string + description: "Text field data in UTF8 format. + Results of reading different lines of a multi-line field are separated by '^'" + FieldMask: + type: string + Validity: + type: integer + InComparison: + type: integer + wLCID: + type: integer + Reserved2: + type: integer + Reserved3: + type: integer + + StringRecognitionResult: + title: "StringRecognitionResult" + type: object + description: "Describes single row recognition results in multi-line text field of a document" + required: + - SymbolsCount + - StringResult + properties: + SymbolsCount: + description: "Number of StringResult array elements" + type: number + StringResult: + type: array + description: "Array of recognition results for individual characters of a string" + items: + $ref: "#/components/schemas/SymbolRecognitionResult" + Buf_Length: + description: "Buf_Text text string length" + type: number + Buf_Text: + type: string + description: "Text field data in UTF8 format. + Results of reading different lines of a multi-line field are separated by '^'" + Reserved: + type: integer + + SymbolRecognitionResult: + title: "SymbolRecognitionResult" + type: object + description: "Describes a single character recognition results in the text field line" + required: + - SymbolRect + - CandidatesCount + - ListOfCandidates + properties: + SymbolRect: # Coordinates of the symbol in the normalized image of the document + $ref: "#/components/schemas/RectangleCoordinates" + CandidatesCount: + description: "Number of significant elements of ListOfCandidates array" + type: number + ListOfCandidates: + type: array + description: "Array of candidate characters. Sorted in descending order of recognition probabilities + (the first element has highest probability)" + items: + $ref: "#/components/schemas/SymbolCandidate" + BaseLineBottom: + type: integer + BaseLineTop: + type: integer + Reserved: + type: integer + + SymbolCandidate: + title: "SymbolCandidate" + required: + - SymbolCode + - SymbolProbability + type: object + description: "Describes an individual character recognition candidate" + properties: + SymbolCode: + type: integer + description: "Unicode symbol code" + SymbolProbability: + type: integer + description: "character recognition probability (0–100,%)" + minimum: 0 + maximum: 100 + Class: + type: integer + SubClass: + type: integer diff --git a/p-transaction.yml b/p-transaction.yml index 9a4e601..fde0df5 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -211,13 +211,13 @@ components: TransactionProcessResponse: title: "TransactionProcessResponse" allOf: + - $ref: "./p-process.yml#/components/schemas/ProcessResponse" - type: object required: - CoreLibResultCode properties: CoreLibResultCode: type: integer - - $ref: "./p-process.yml#/components/schemas/ProcessResponse" TransactionProcessGetResponse: title: "TransactionProcessGetResponse" diff --git a/rt-image-data.yml b/rt-image-data.yml index 49ce02f..81b8088 100644 --- a/rt-image-data.yml +++ b/rt-image-data.yml @@ -20,66 +20,23 @@ components: pArrayFields: type: array items: - oneOf: - - $ref: "#/components/schemas/GraphicFieldRect" - - $ref: "#/components/schemas/GraphicFieldRfid" + $ref: "#/components/schemas/GraphicField" nFields: description: "Number of pArrayFields array elements" type: number - GraphicFieldRect: - title: "GraphicFieldRect" - description: "Information about one graphic field, which is a rectangle" - allOf: - - $ref: "#/components/schemas/GraphicField" - - $ref: "#/components/schemas/GraphicFieldRectItem" - - GraphicFieldRfid: - title: "GraphicFieldRfid" - description: "Information about one graphic field, which is a RFID" - allOf: - - $ref: "#/components/schemas/GraphicField" - - $ref: "#/components/schemas/GraphicFieldRfidItem" - - GraphicFieldRectItem: - title: "GraphicFieldRectItem" - type: object - required: - - FieldRect - properties: - FieldRect: - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - - GraphicFieldRfidItem: - title: "GraphicFieldRfidItem" - type: object - required: - - RFID_OriginDG - - RFID_OriginDGTag - - RFID_OriginTagEntry - - RFID_OriginEntryView - properties: - RFID_OriginDG: - $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" - RFID_OriginDGTag: - description: "Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result." - type: integer - RFID_OriginTagEntry: - type: integer - description: "Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result." - RFID_OriginEntryView: - type: integer - description: "Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result." - GraphicField: title: "GraphicField" description: "Information about one graphic field - abstract class" type: object required: + - FieldRect - FieldType - FieldName - image properties: + FieldRect: + $ref: "./common.yml#/components/schemas/RectangleCoordinates" FieldType: $ref: "./e-graphic-field-type.yml#/components/schemas/GraphicFieldType" FieldName: diff --git a/rt-rfid-text-data.yml b/rt-rfid-text-data.yml new file mode 100644 index 0000000..ef01448 --- /dev/null +++ b/rt-rfid-text-data.yml @@ -0,0 +1,47 @@ +openapi: 3.0.4 +components: + schemas: + RFIDDocVisualExtendedInfoItem: + title: "RFIDDocVisualExtendedInfoItem" + type: object + required: + - DocVisualExtendedInfo + properties: + DocVisualExtendedInfo: + $ref: "#/components/schemas/RFIDDocVisualExtendedInfo" + + RFIDDocVisualExtendedInfo: + title: "RFIDDocVisualExtendedInfo" + type: object + description: "Container for extracted text fields. Fields are identified by type and language" + required: + - nFields + - pArrayFields + properties: + nFields: + description: "Number of pArrayFields array elements" + type: number + pArrayFields: + type: array + items: + $ref: "#/components/schemas/RFIDDocVisualExtendedField" + + RFIDDocVisualExtendedField: + title: "RFIDDocVisualExtendedField" + type: object + required: + - OriginDG + - OriginTagEntry + allOf: + - $ref: "./common.yml#/components/schemas/DocVisualExtendedFieldItem" + - type: object + properties: + OriginDG: + type: integer + OriginDGTag: + type: integer + OriginTagEntry: + description: "Record index of the text field source in the data group" + type: number + OriginEntryView: + type: integer diff --git a/rt-text-data.yml b/rt-text-data.yml index 7ae6a2a..f7c929e 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -24,168 +24,16 @@ components: pArrayFields: type: array items: - oneOf: - - $ref: "#/components/schemas/DocVisualExtendedFieldRect" - - $ref: "#/components/schemas/DocVisualExtendedFieldRfid" - - DocVisualExtendedFieldRect: - title: "DocVisualExtendedFieldRect" - description: "Structure and serves for storing information from one text data field. - Variant with field logical type and field rectangular area coordinates on the image." - allOf: - - $ref: "#/components/schemas/DocVisualExtendedField" - - $ref: "#/components/schemas/DocVisualExtendedFieldRectItem" - - DocVisualExtendedFieldRfid: - title: "DocVisualExtendedFieldRfid" - description: "Structure and serves for storing information from one text data field. - Variant with field logical type and RFID data." - allOf: - - $ref: "#/components/schemas/DocVisualExtendedField" - - $ref: "#/components/schemas/DocVisualExtendedFieldRfidItem" - - DocVisualExtendedFieldRectItem: - title: "DocVisualExtendedFieldRectItem" - type: object - properties: - FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - - DocVisualExtendedFieldRfidItem: - title: "DocVisualExtendedFieldRfidItem" - type: object - required: - - RFID_OriginDG - - RFID_OriginTagEntry - properties: - RFID_OriginDG: - $ref: "./e-rfid-data-group-type-tag.yml#/components/schemas/RfidDataGroupTypeTag" - RFID_OriginDGTag: - type: integer - RFID_OriginTagEntry: - description: "Record index of the text field source in the data group" - type: number - RFID_OriginEntryView: - type: integer + $ref: "#/components/schemas/DocVisualExtendedField" DocVisualExtendedField: title: "DocVisualExtendedField" type: object required: - - FieldType - - wFieldType - - FieldName - - StringsCount - - StringsResult - - Buf_Length - - Buf_Text - properties: - FieldType: - type: integer - wFieldType: - $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" - FieldName: - description: "Field symbolic name (null-terminated string)" - type: string - StringsCount: - description: "Number of StringsResult array elements" - type: number - StringsResult: - type: array - description: "Array of recognizing probabilities for a each line of text field. - Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results." - items: - $ref: "#/components/schemas/StringRecognitionResult" - Buf_Length: - description: "Buf_Text text string length" - type: number - Buf_Text: - type: string - description: "Text field data in UTF8 format. - Results of reading different lines of a multi-line field are separated by '^'" - FieldMask: - type: string - Validity: - type: integer - InComparison: - type: integer - wLCID: - type: integer - Reserved2: - type: integer - Reserved3: - type: integer - - StringRecognitionResult: - title: "StringRecognitionResult" - type: object - description: "Describes single row recognition results in multi-line text field of a document" - required: - - SymbolsCount - - StringResult - properties: - SymbolsCount: - description: "Number of StringResult array elements" - type: number - StringResult: - type: array - description: "Array of recognition results for individual characters of a string" - items: - $ref: "#/components/schemas/SymbolRecognitionResult" - Buf_Length: - description: "Buf_Text text string length" - type: number - Buf_Text: - type: string - description: "Text field data in UTF8 format. - Results of reading different lines of a multi-line field are separated by '^'" - Reserved: - type: integer - - SymbolRecognitionResult: - title: "SymbolRecognitionResult" - type: object - description: "Describes a single character recognition results in the text field line" - required: - - SymbolRect - - CandidatesCount - - ListOfCandidates - properties: - SymbolRect: # Coordinates of the symbol in the normalized image of the document - $ref: "./common.yml#/components/schemas/RectangleCoordinates" - CandidatesCount: - description: "Number of significant elements of ListOfCandidates array" - type: number - ListOfCandidates: - type: array - description: "Array of candidate characters. Sorted in descending order of recognition probabilities - (the first element has highest probability)" - items: - $ref: "#/components/schemas/SymbolCandidate" - BaseLineBottom: - type: integer - BaseLineTop: - type: integer - Reserved: - type: integer - - SymbolCandidate: - title: "SymbolCandidate" - required: - - SymbolCode - - SymbolProbability - type: object - description: "Describes an individual character recognition candidate" - properties: - SymbolCode: - type: integer - description: "Unicode symbol code" - SymbolProbability: - type: integer - description: "character recognition probability (0–100,%)" - minimum: 0 - maximum: 100 - Class: - type: integer - SubClass: - type: integer + - FieldRect + allOf: + - $ref: "./common.yml#/components/schemas/DocVisualExtendedFieldItem" + - type: object + properties: + FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. + $ref: "./common.yml#/components/schemas/RectangleCoordinates" diff --git a/rt.yml b/rt.yml index 508e80e..1fc49ef 100644 --- a/rt.yml +++ b/rt.yml @@ -173,7 +173,7 @@ components: 87: "MRZDetectorResult" 97: "FaceDetectionResult" 101: "DocumentBinaryInfoResult" - 102: "TextDataResult" + 102: "RFIDTextDataResult" 103: "GraphicsResult" 104: "DocumentBinaryInfoResult" 105: "RFIDGraphicsInfoResult" @@ -215,6 +215,7 @@ components: - $ref: "#/components/schemas/MRZPositionResult" - $ref: "#/components/schemas/MRZTestQualityResult" - $ref: "#/components/schemas/RFIDGraphicsInfoResult" + - $ref: "#/components/schemas/RFIDTextDataResult" StatusResult: title: "StatusResult" @@ -365,3 +366,9 @@ components: allOf: - $ref: "#/components/schemas/ResultItem" - $ref: "./rt-rfid-graphics-info.yml#/components/schemas/TOriginalRFIDGraphicsInfoItem" + + RFIDTextDataResult: + title: "RFIDTextDataResult" + allOf: + - $ref: "#/components/schemas/ResultItem" + - $ref: "./rt-rfid-text-data.yml#/components/schemas/RFIDDocVisualExtendedInfoItem" From 5c86e3dd2520a4ab04c50541bc57023961738869 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 14 Mar 2025 17:51:14 +0300 Subject: [PATCH 054/106] SP-18211 - Update models --- common.yml | 4 ++-- p-transaction.yml | 16 ++++++++++------ rt-rfid-text-data.yml | 29 ++++++++++++++++------------- rt-text-data.yml | 16 +++++++++++----- 4 files changed, 39 insertions(+), 26 deletions(-) diff --git a/common.yml b/common.yml index 33e5d94..ecb3760 100644 --- a/common.yml +++ b/common.yml @@ -425,8 +425,8 @@ components: example: 5 description: "Estimated duration of validity for a child's passport, years. Default: 5." - DocVisualExtendedFieldItem: - title: "DocVisualExtendedFieldItem" + VisualExtendedFieldItem: + title: "VisualExtendedFieldItem" type: object required: - FieldType diff --git a/p-transaction.yml b/p-transaction.yml index fde0df5..923ea61 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -212,12 +212,16 @@ components: title: "TransactionProcessResponse" allOf: - $ref: "./p-process.yml#/components/schemas/ProcessResponse" - - type: object - required: - - CoreLibResultCode - properties: - CoreLibResultCode: - type: integer + - $ref: "#/components/schemas/TransactionProcessResponseItem" + + TransactionProcessResponseItem: + title: "TransactionProcessResponseItem" + type: object + required: + - CoreLibResultCode + properties: + CoreLibResultCode: + type: integer TransactionProcessGetResponse: title: "TransactionProcessGetResponse" diff --git a/rt-rfid-text-data.yml b/rt-rfid-text-data.yml index ef01448..10551d0 100644 --- a/rt-rfid-text-data.yml +++ b/rt-rfid-text-data.yml @@ -28,20 +28,23 @@ components: RFIDDocVisualExtendedField: title: "RFIDDocVisualExtendedField" + allOf: + - $ref: "./common.yml#/components/schemas/VisualExtendedFieldItem" + - $ref: "#/components/schemas/RFIDDocVisualExtendedFieldItem" + + RFIDDocVisualExtendedFieldItem: + title: "RFIDDocVisualExtendedFieldItem" type: object required: - OriginDG - OriginTagEntry - allOf: - - $ref: "./common.yml#/components/schemas/DocVisualExtendedFieldItem" - - type: object - properties: - OriginDG: - type: integer - OriginDGTag: - type: integer - OriginTagEntry: - description: "Record index of the text field source in the data group" - type: number - OriginEntryView: - type: integer + properties: + OriginDG: + type: integer + OriginDGTag: + type: integer + OriginTagEntry: + description: "Record index of the text field source in the data group" + type: number + OriginEntryView: + type: integer diff --git a/rt-text-data.yml b/rt-text-data.yml index f7c929e..d221246 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -32,8 +32,14 @@ components: required: - FieldRect allOf: - - $ref: "./common.yml#/components/schemas/DocVisualExtendedFieldItem" - - type: object - properties: - FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. - $ref: "./common.yml#/components/schemas/RectangleCoordinates" + - $ref: "./common.yml#/components/schemas/VisualExtendedFieldItem" + - $ref: "#/components/schemas/DocVisualExtendedFieldItem" + + DocVisualExtendedFieldItem: + title: "DocVisualExtendedFieldItem" + type: object + required: + -FieldRect + properties: + FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. + $ref: "./common.yml#/components/schemas/RectangleCoordinates" From 28ddb8f0131d068bd3eb0a96c90b66e93df6fff7 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 17 Mar 2025 14:31:53 +0300 Subject: [PATCH 055/106] SP-18211 - Update models --- rt-text-data.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/rt-text-data.yml b/rt-text-data.yml index d221246..f3fb5ce 100644 --- a/rt-text-data.yml +++ b/rt-text-data.yml @@ -29,8 +29,6 @@ components: DocVisualExtendedField: title: "DocVisualExtendedField" type: object - required: - - FieldRect allOf: - $ref: "./common.yml#/components/schemas/VisualExtendedFieldItem" - $ref: "#/components/schemas/DocVisualExtendedFieldItem" @@ -39,7 +37,7 @@ components: title: "DocVisualExtendedFieldItem" type: object required: - -FieldRect + - FieldRect properties: FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results. $ref: "./common.yml#/components/schemas/RectangleCoordinates" From 3c9d0180e1a9ab7a99a53c25382d5e4a9604421f Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> Date: Mon, 17 Mar 2025 17:41:44 +0300 Subject: [PATCH 056/106] Added chd_DocLiveness_DocumentNotLive diagnose (#238) --- authenticity/e-check-diagnose.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 355689b..96d1d74 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -119,6 +119,7 @@ components: - 221 - 222 - 230 + - 238 - 239 - 240 - 241 @@ -244,6 +245,7 @@ components: - "OCR_QUALITY_INVALID_FONT" - "OCR_QUALITY_INVALID_BACKGROUND" - "LASINK_INVALID_LINES_FREQUENCY" + - "DOC_LIVENESS_DOCUMENT_NOT_LIVE" - "DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED" - "DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED" - "DOC_LIVENESS_INVALID_BARCODE_BACKGROUND" From 070f535d821a2e6f58055a134a0da67909decf7b Mon Sep 17 00:00:00 2001 From: Artem Tsybulko <60066359+inspector-code@users.noreply.github.com> Date: Mon, 17 Mar 2025 18:19:13 +0300 Subject: [PATCH 057/106] SP-20987 - add checkSecurityText, checkBlackAndWhiteCopy (#235) * SP-20987 - add checkSecurityText, checkBlackAndWhiteCopy * SP-20987 - update github actions * Update p-process.yml --------- Co-authored-by: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> --- p-process.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/p-process.yml b/p-process.yml index 279972b..f09fbcf 100644 --- a/p-process.yml +++ b/p-process.yml @@ -586,6 +586,10 @@ components: type: boolean description: "This parameter is used to enable LetterScreen check" # default: false + checkSecurityText: + type: boolean + description: "This parameter is used to enable Security text check" + # default: true LivenessParams: @@ -607,6 +611,10 @@ components: type: boolean description: "This parameter is used to enable Electronic device detection" # default: true + checkBlackAndWhiteCopy: + type: boolean + description: "This parameter is used to enable Black and white copy check" + # default: true MeasureSystem: type: integer From 8878cbe8b670731943f6fda712af7c02c385a148 Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> Date: Tue, 18 Mar 2025 11:20:38 +0300 Subject: [PATCH 058/106] 35052: Updated childAgeThreshold description based on the upcoming changes (#239) * Updated childAgeThreshold description based on the upcoming changes * Update common.yml * Update common.yml --- common.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common.yml b/common.yml index be95a87..cdc1627 100644 --- a/common.yml +++ b/common.yml @@ -282,7 +282,7 @@ components: childAgeThreshold: type: integer example: 13 - description: "Minimum age of a child, at which portrait comparison result will be effective. Default: 13." + description: "The age threshold for the portrait comparison. Default: 13." childDocValidityYears: type: integer example: 5 From a88af7b5de15d1fbe0951b8f2bb2161d6dd5bcfa Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> Date: Tue, 18 Mar 2025 11:21:06 +0300 Subject: [PATCH 059/106] SP-21690: Added checkDynaprint (#240) * Added checkDynaprint * Update p-process.yml --- p-process.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/p-process.yml b/p-process.yml index f09fbcf..8edc211 100644 --- a/p-process.yml +++ b/p-process.yml @@ -615,6 +615,10 @@ components: type: boolean description: "This parameter is used to enable Black and white copy check" # default: true + checkDynaprint: + type: boolean + description: "This parameter is used to enable Dynaprint check" + # default: true MeasureSystem: type: integer From 658d07da81cfaa8209b041f22eee3e39be09f04d Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> Date: Wed, 19 Mar 2025 12:28:23 +0300 Subject: [PATCH 060/106] Added ft_Short_Flight_Number and ft_Airline_Code (#241) --- e-text-field-type.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/e-text-field-type.yml b/e-text-field-type.yml index fea1aed..82642c5 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -646,6 +646,8 @@ components: - 690 - 691 - 692 + - 693 + - 694 x-enum-descriptions: - "Document class code" - "Issuing state code" @@ -1289,6 +1291,8 @@ components: - "Digital Travel Authorization Number" - "Date of First Positive Test Result" - "EF.CardAccess" + - "Short flight number" + - "Airline code" x-enum-varnames: - "DOCUMENT_CLASS_CODE" - "ISSUING_STATE_CODE" @@ -1932,3 +1936,5 @@ components: - "FT_DIGITAL_TRAVEL_AUTHORIZATION_NUMBER" - "FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT" - "EF_CARD_ACCESS" + - "SHORT_FLIGHT_NUMBER" + - "AIRLINE_CODE" From 588e6962a72796fb7d0c03ea5554c88700518681 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 19 Mar 2025 18:09:53 +0300 Subject: [PATCH 061/106] SP-18211 - Update models --- p-healthcheck.yml | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/p-healthcheck.yml b/p-healthcheck.yml index bea9da4..ad2d868 100644 --- a/p-healthcheck.yml +++ b/p-healthcheck.yml @@ -34,7 +34,14 @@ components: Healthcheck: title: "Healthcheck" type: object - required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version] + required: + - app + - licenseId + - licenseType + - licenseSerial + - licenseValidUntil + - scenarios + - version properties: app: description: Application name. @@ -72,7 +79,11 @@ components: documentsDatabase: description: Database information. type: object - required: [id, version, exportDate, description] + required: + - id + - version + - exportDate + - description properties: id: description: Database identifier. @@ -85,7 +96,6 @@ components: exportDate: description: Date of database creation. type: string - format: date nullable: true description: description: Description of the database contents, such as the list of supported countries and documents. From 95e4183f2f52a78b6653ac0aa7416fa7fc0ef11d Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 20 Mar 2025 17:55:06 +0300 Subject: [PATCH 062/106] SP-18211 - Update models --- p-transaction.yml | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/p-transaction.yml b/p-transaction.yml index 923ea61..6c51088 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -80,7 +80,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TransactionProcessResponse' + $ref: "./p-process.yml#/components/schemas/ProcessResponse" "400": description: "Bad request. Check your input data." "403": @@ -208,21 +208,6 @@ components: type: string format: uuid - TransactionProcessResponse: - title: "TransactionProcessResponse" - allOf: - - $ref: "./p-process.yml#/components/schemas/ProcessResponse" - - $ref: "#/components/schemas/TransactionProcessResponseItem" - - TransactionProcessResponseItem: - title: "TransactionProcessResponseItem" - type: object - required: - - CoreLibResultCode - properties: - CoreLibResultCode: - type: integer - TransactionProcessGetResponse: title: "TransactionProcessGetResponse" type: object From 824184cc5c7a07e1fda5efc4ea1be28a3c7560c1 Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> Date: Mon, 24 Mar 2025 11:11:22 +0300 Subject: [PATCH 063/106] 35955: Added occlusion check (#242) --- rt-image-quality.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 7c6418f..89155c6 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -40,6 +40,7 @@ components: - 5 - 7 - 9 + - 10 x-enum-varnames: - "ImageGlares" - "ImageFocus" @@ -49,6 +50,7 @@ components: - "Bounds" - "Portrait" - "Brightness" + - "Occlusion" x-enum-descriptions: - "Signals glare presence on the image" - "Signals whether image is in focus" @@ -58,6 +60,7 @@ components: - "Signals if document is not fully present in the image" - "Signals if the portrait is present" - "Signals if the document image is bright enough" + - "Signals if the document image has occlusion" InputImageQualityChecks: type: string @@ -71,6 +74,7 @@ components: - "documentPosition" - "portraitCheck" - "brightnessCheck" + - "occlusionCheck" x-enum-varnames: - "Glares" - "Focus" @@ -80,6 +84,7 @@ components: - "Bounds" - "Portrait" - "Brightness" + - "Occlusion" x-enum-descriptions: - "Signals glare presence on the image" - "Signals whether image is in focus" @@ -89,6 +94,7 @@ components: - "Signals if document is not fully present in the image" - "Signals if the portrait is present" - "Signals if the document image is bright enough" + - "Signals if the document image has occlusion" AreaArray: From f6879e0a7a0c16a5b051f6a6828e63a4a4e13187 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 25 Mar 2025 10:29:57 +0300 Subject: [PATCH 064/106] SP-18211 - Update version --- index.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yml b/index.yml index 4a1a0a0..19e273d 100644 --- a/index.yml +++ b/index.yml @@ -1,6 +1,6 @@ openapi: 3.0.4 info: - version: 7.4.0 + version: 7.6.0 title: Regula Document Reader Web API x-logo: url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg" From 80c0aa535de3afa1a5bc4bf7c62ec380c72029c3 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 25 Mar 2025 16:44:58 +0300 Subject: [PATCH 065/106] SP-18211 - Code refactor --- p-process.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/p-process.yml b/p-process.yml index a977efd..7e28ed6 100644 --- a/p-process.yml +++ b/p-process.yml @@ -142,11 +142,6 @@ components: required: - processParam properties: - lcidFilter: - type: array - description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." - items: - $ref: "./e-lcid.yml#/components/schemas/LCID" processParam: $ref: "#/components/schemas/ProcessParams" List: @@ -189,6 +184,11 @@ components: description: "URLs to the document images for processing." items: type: string + lcidFilter: + type: array + description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." + items: + $ref: "./e-lcid.yml#/components/schemas/LCID" ProcessParams: title: "ProcessParams" From 3d5fab44fd0382bd6e142185f989aeb6222cfbe9 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 26 Mar 2025 18:13:08 +0300 Subject: [PATCH 066/106] SP-18211 - Update models --- p-process.yml | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/p-process.yml b/p-process.yml index 7e28ed6..db5a497 100644 --- a/p-process.yml +++ b/p-process.yml @@ -396,12 +396,8 @@ components: type: array items: $ref: "./e-document-type.yml#/components/schemas/DocumentType" - processAuth: - description: "Authenticity checks that should be performed regardless of the document type. - The available checks are listed in the eRPRM_Authenticity enum. - Note that only supported by your license checks can be added. " - type: integer - format: int64 + processAuth: # Authenticity checks that should be performed regardless of the document type. The available checks are listed in the eRPRM_Authenticity enum. Note that only supported by your license checks can be added. + $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" deviceId: description: "This parameter is used to specify the document reader device type from which input images were captured. Default 0." type: integer From 137145c544a76a5315ecebe0d1ef5d338619e4da Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 27 Mar 2025 14:40:04 +0300 Subject: [PATCH 067/106] SP-18211 - Update models --- rt-authenticity.yml | 8 +------- rt.yml | 2 +- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 4f8a9a8..70a8ade 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -81,12 +81,6 @@ components: - $ref: "#/components/schemas/AuthenticityCheckResultItem" - $ref: "./authenticity/rt-photo-ident.yml#/components/schemas/PhotoIdentItem" - AuthenticityType: - title: "AuthenticityType" - type: integer - description: "Same as authenticity result type, but used for safe parsing of not-described values: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/" - default: 0 - AuthenticityCheckResultItem: title: "AuthenticityCheckResultItem" description: "Common fields for all authenticity result objects" @@ -95,7 +89,7 @@ components: - Type properties: Type: - $ref: "#/components/schemas/AuthenticityType" + $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" ElementResult: $ref: "./common.yml#/components/schemas/CheckResult" ElementDiagnose: diff --git a/rt.yml b/rt.yml index 1fc49ef..c0ac520 100644 --- a/rt.yml +++ b/rt.yml @@ -138,7 +138,7 @@ components: page_idx: type: integer result_type: - $ref: "#/components/schemas/ContainerType" + $ref: "#/components/schemas/Result" discriminator: propertyName: result_type mapping: From 5c5bb0e2553e3c6d0c22b258f0423c0ed3355508 Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> Date: Fri, 28 Mar 2025 10:42:58 +0300 Subject: [PATCH 068/106] 35091: Added strictDLCategoryExpiry property (#243) --- p-process.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/p-process.yml b/p-process.yml index 8edc211..8e2f380 100644 --- a/p-process.yml +++ b/p-process.yml @@ -454,6 +454,10 @@ components: type: array items: $ref: "./e-input-barcode-type.yml#/components/schemas/InputBarcodeType" + strictDLCategoryExpiry: + description: "Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases." + type: boolean +# default: false required: - scenario From 23f67ca15a2ab3bea765b2088edfea8a72130109 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 31 Mar 2025 10:28:50 +0300 Subject: [PATCH 069/106] SP-18211 - Update docs --- README.md | 26 ++++++++++---------------- e-input-barcode-type.yml | 1 + openapitools.json | 2 +- p-process.yml | 1 + rt-rfid-binary-data.yml | 2 ++ 5 files changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 0ede455..af50ffd 100644 --- a/README.md +++ b/README.md @@ -23,37 +23,31 @@ * **rt - \*.yml** - files describing results types * **p - \*.yml** - files describing endpoints - ## Updating clients according to the current spec -To update clients, use `update clients` GitHub action. Specify title PR and press run. For each client **PR** with changes will be created. - -:warning: NOTE: Static typed clients, such as Java or C#, require adding all new **enums** to `update-models.sh` ENUM_MAPPINGS section. +When changes are added, the `update clients` action is automatically triggered. For each client **PR** with changes will be created. -:warning: NOTE: For some clients generator produces not-valid client code. See `update-models.sh` for ad-hocks fixing generator issues. +:warning: NOTE: Before working with a client, read `dev.md` which is available in each client repository. -:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc in ext folder. +:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc. in ext folder. -:bulb: All clients have RawResultItem container that is used for deserialization for undescribed types. This container is a simple map/dict. +:bulb: All clients have RawResultItem and AuthenticityCheckResultItem containers that are used for deserialization oneOf schemas. These containers are a simple map/dict. ## Spec validation -``` -docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml + +```bash +docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml ``` ## Building Redoc single page html documentation -Edit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node - -Edit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator** - -Then run next command: -``` +```bash npx @redocly/cli build-docs index.yml -o=document-reader-static-doc.html ``` ## Bundle scheme to single .json file + ```bash -npx openapi-generator-cli generate -i index.yml -g openapi --skip-validate-spec +npx @openapitools/openapi-generator-cli generate -i index.yml -g openapi --skip-validate-spec ``` diff --git a/e-input-barcode-type.yml b/e-input-barcode-type.yml index c5268b2..b812111 100644 --- a/e-input-barcode-type.yml +++ b/e-input-barcode-type.yml @@ -2,6 +2,7 @@ openapi: 3.0.4 components: schemas: InputBarcodeType: + title: "InputBarcodeType" type: string description: "Enumeration contains the types of barcodes that can be processed" enum: diff --git a/openapitools.json b/openapitools.json index b20af39..0e01b85 100644 --- a/openapitools.json +++ b/openapitools.json @@ -2,6 +2,6 @@ "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json", "spaces": 2, "generator-cli": { - "version": "7.11.0" + "version": "7.12.0" } } diff --git a/p-process.yml b/p-process.yml index 1fa9eba..ec5a28e 100644 --- a/p-process.yml +++ b/p-process.yml @@ -822,6 +822,7 @@ components: "UserName": "user" DocumentsDatabase: + title: "DocumentsDatabase" type: object description: "Document database information" properties: diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 1b74f8b..c0ec236 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -736,12 +736,14 @@ components: $ref: "#/components/schemas/SecurityObjectCertificates" SecurityObjectCertificates: + title: "SecurityObjectCertificates" type: object properties: Certificate_Data: $ref: "#/components/schemas/CertificateData" CertificateData: + title: "CertificateData" type: object required: - Data From b50b2d8f875bc80a62a84510e7a853b7558ad2cb Mon Sep 17 00:00:00 2001 From: Artem Tsybulko <60066359+inspector-code@users.noreply.github.com> Date: Wed, 2 Apr 2025 14:34:06 +0300 Subject: [PATCH 070/106] Develop -> Stable (#244) --- authenticity/e-check-diagnose.yml | 2 ++ common.yml | 2 +- e-text-field-type.yml | 6 ++++++ p-process.yml | 16 ++++++++++++++++ rt-image-quality.yml | 6 ++++++ 5 files changed, 31 insertions(+), 1 deletion(-) diff --git a/authenticity/e-check-diagnose.yml b/authenticity/e-check-diagnose.yml index 355689b..96d1d74 100644 --- a/authenticity/e-check-diagnose.yml +++ b/authenticity/e-check-diagnose.yml @@ -119,6 +119,7 @@ components: - 221 - 222 - 230 + - 238 - 239 - 240 - 241 @@ -244,6 +245,7 @@ components: - "OCR_QUALITY_INVALID_FONT" - "OCR_QUALITY_INVALID_BACKGROUND" - "LASINK_INVALID_LINES_FREQUENCY" + - "DOC_LIVENESS_DOCUMENT_NOT_LIVE" - "DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED" - "DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED" - "DOC_LIVENESS_INVALID_BARCODE_BACKGROUND" diff --git a/common.yml b/common.yml index be95a87..cdc1627 100644 --- a/common.yml +++ b/common.yml @@ -282,7 +282,7 @@ components: childAgeThreshold: type: integer example: 13 - description: "Minimum age of a child, at which portrait comparison result will be effective. Default: 13." + description: "The age threshold for the portrait comparison. Default: 13." childDocValidityYears: type: integer example: 5 diff --git a/e-text-field-type.yml b/e-text-field-type.yml index fea1aed..82642c5 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -646,6 +646,8 @@ components: - 690 - 691 - 692 + - 693 + - 694 x-enum-descriptions: - "Document class code" - "Issuing state code" @@ -1289,6 +1291,8 @@ components: - "Digital Travel Authorization Number" - "Date of First Positive Test Result" - "EF.CardAccess" + - "Short flight number" + - "Airline code" x-enum-varnames: - "DOCUMENT_CLASS_CODE" - "ISSUING_STATE_CODE" @@ -1932,3 +1936,5 @@ components: - "FT_DIGITAL_TRAVEL_AUTHORIZATION_NUMBER" - "FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT" - "EF_CARD_ACCESS" + - "SHORT_FLIGHT_NUMBER" + - "AIRLINE_CODE" diff --git a/p-process.yml b/p-process.yml index 279972b..8e2f380 100644 --- a/p-process.yml +++ b/p-process.yml @@ -454,6 +454,10 @@ components: type: array items: $ref: "./e-input-barcode-type.yml#/components/schemas/InputBarcodeType" + strictDLCategoryExpiry: + description: "Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases." + type: boolean +# default: false required: - scenario @@ -586,6 +590,10 @@ components: type: boolean description: "This parameter is used to enable LetterScreen check" # default: false + checkSecurityText: + type: boolean + description: "This parameter is used to enable Security text check" + # default: true LivenessParams: @@ -607,6 +615,14 @@ components: type: boolean description: "This parameter is used to enable Electronic device detection" # default: true + checkBlackAndWhiteCopy: + type: boolean + description: "This parameter is used to enable Black and white copy check" + # default: true + checkDynaprint: + type: boolean + description: "This parameter is used to enable Dynaprint check" + # default: true MeasureSystem: type: integer diff --git a/rt-image-quality.yml b/rt-image-quality.yml index 7c6418f..89155c6 100644 --- a/rt-image-quality.yml +++ b/rt-image-quality.yml @@ -40,6 +40,7 @@ components: - 5 - 7 - 9 + - 10 x-enum-varnames: - "ImageGlares" - "ImageFocus" @@ -49,6 +50,7 @@ components: - "Bounds" - "Portrait" - "Brightness" + - "Occlusion" x-enum-descriptions: - "Signals glare presence on the image" - "Signals whether image is in focus" @@ -58,6 +60,7 @@ components: - "Signals if document is not fully present in the image" - "Signals if the portrait is present" - "Signals if the document image is bright enough" + - "Signals if the document image has occlusion" InputImageQualityChecks: type: string @@ -71,6 +74,7 @@ components: - "documentPosition" - "portraitCheck" - "brightnessCheck" + - "occlusionCheck" x-enum-varnames: - "Glares" - "Focus" @@ -80,6 +84,7 @@ components: - "Bounds" - "Portrait" - "Brightness" + - "Occlusion" x-enum-descriptions: - "Signals glare presence on the image" - "Signals whether image is in focus" @@ -89,6 +94,7 @@ components: - "Signals if document is not fully present in the image" - "Signals if the portrait is present" - "Signals if the document image is bright enough" + - "Signals if the document image has occlusion" AreaArray: From 12a9c8486524f95eb4de04ff16edc94c19c132a2 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 7 Apr 2025 12:15:42 +0300 Subject: [PATCH 071/106] SP-18211 - Update SymbolCode --- common.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/common.yml b/common.yml index 36373ba..2754e4d 100644 --- a/common.yml +++ b/common.yml @@ -536,6 +536,7 @@ components: properties: SymbolCode: type: integer + format: int64 description: "Unicode symbol code" SymbolProbability: type: integer From 6bab46abab3e61725ee98c4e105798c2e60f9295 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 8 Apr 2025 10:38:03 +0300 Subject: [PATCH 072/106] SP-18211 - Update AuthenticityCheckResultItem discriminator --- rt-authenticity.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/rt-authenticity.yml b/rt-authenticity.yml index 70a8ade..a676ad4 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -121,7 +121,11 @@ components: 262144: "IdentResult" 524288: "IdentResult" 1048576: "IdentResult" + 2097152: "IdentResult" + 4194304: "SecurityFeatureResult" 8388608: "SecurityFeatureResult" + 16777216: "OCRSecurityTextResult" + 2147483648: "SecurityFeatureResult" AreaContainer: title: "AreaContainer" From e4f6b00ff8cba5674cc9fc932ee926d0ccb9028f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 8 Apr 2025 12:58:46 +0300 Subject: [PATCH 073/106] Develop -> Stable (#244) (#246) (#247) Co-authored-by: Artem Tsybulko <60066359+inspector-code@users.noreply.github.com> From 8a32f234d898dff297ebedeb3fb2e7c6d34c1865 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 8 Apr 2025 14:31:02 +0300 Subject: [PATCH 074/106] SP-18211 - Update authenticity result type enum, authenticity discriminator --- authenticity/e-result-type.yml | 10 ---------- rt-authenticity.yml | 4 ---- 2 files changed, 14 deletions(-) diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index 48e7846..fe72b3f 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -7,7 +7,6 @@ components: format: int64 description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/." enum: - - 0 - 1 - 2 - 4 @@ -16,13 +15,10 @@ components: - 32 - 64 - 128 - - 256 - 512 - 1024 - - 2048 - 4096 - 8192 - - 16384 - 32768 - 65536 - 131072 @@ -33,7 +29,6 @@ components: - 4194304 - 8388608 - 16777216 - - 2147483648 x-enum-descriptions: - "No authenticity control procedure" - "Document luminescence check in UV light" @@ -63,7 +58,6 @@ components: - "Encrypted IPI" - "Flag for status-only authenticity" x-enum-varnames: - - "NONE" - "UV_LUMINESCENCE" - "IR_B900" - "IMAGE_PATTERN" @@ -72,13 +66,10 @@ components: - "IR_VISIBILITY" - "OCR_SECURITY_TEXT" - "IPI" - - "IR_PHOTO" - "PHOTO_EMBED_TYPE" - "OVI" - - "IR_LUMINESCENCE" - "HOLOGRAMS" - "PHOTO_AREA" - - "UV_BACKGROUND" - "PORTRAIT_COMPARISON" - "BARCODE_FORMAT_CHECK" - "KINEGRAM" @@ -89,4 +80,3 @@ components: - "EXTENDED_OCR_CHECK" - "EXTENDED_MRZ_CHECK" - "ENCRYPTED_IPI" - - "STATUS_ONLY" diff --git a/rt-authenticity.yml b/rt-authenticity.yml index a676ad4..c1c25ae 100644 --- a/rt-authenticity.yml +++ b/rt-authenticity.yml @@ -108,13 +108,10 @@ components: 32: "IdentResult" 64: "OCRSecurityTextResult" 128: "PhotoIdentResult" - 256: "PhotoIdentResult" 512: "SecurityFeatureResult" 1024: "IdentResult" - 2048: "IdentResult" 4096: "SecurityFeatureResult" 8192: "SecurityFeatureResult" - 16384: "FiberResult" 32768: "IdentResult" 65536: "SecurityFeatureResult" 131072: "IdentResult" @@ -125,7 +122,6 @@ components: 4194304: "SecurityFeatureResult" 8388608: "SecurityFeatureResult" 16777216: "OCRSecurityTextResult" - 2147483648: "SecurityFeatureResult" AreaContainer: title: "AreaContainer" From fcea92eaf491ebfa1fa3803f034f2dc2f1780486 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 9 Apr 2025 10:48:19 +0300 Subject: [PATCH 075/106] SP-18211 - Update enums --- common.yml | 84 +++--- e-parsing-error-codes.yml | 252 +++++++++--------- e-parsing-notification-codes.yml | 444 +++++++++++++++---------------- e-rfid-data-group-type-tag.yml | 110 ++++---- e-rfid-error-codes.yml | 228 ++++++++-------- index.yml | 2 + rt-rfid-binary-data.yml | 10 +- 7 files changed, 566 insertions(+), 564 deletions(-) diff --git a/common.yml b/common.yml index 2754e4d..8202e43 100644 --- a/common.yml +++ b/common.yml @@ -213,48 +213,48 @@ components: format: int64 description: "Image light index" enum: - - 0x00000000 - - 0x00000001 - - 0x00000002 - - 0x00000004 - - 0x00800000 - - 0x00000006 - - 0x00000008 - - 0x00000010 - - 0x01000000 - - 0x00000018 - - 0x02000000 - - 0x00000080 - - 0x04000000 - - 0x08000000 - - 0x10000000 - - 0x00000100 - - 0x00000400 - - 0x00000800 - - 0x00000200 - - 0x00001000 - - 0x00002000 - - 0x00000C00 - - 0x80000000 - - 0x90000000 - - 0xA0000000 - - 0xB0000000 - - 0xC0000000 - - 0x00000020 - - 0x00000040 - - 0x00010000 - - 0x00004000 - - 0x00040000 - - 0x00020000 - - 0x00008000 - - 0x01000000 - - 0x04000000 - - 0x00000040 - - 0x00000020 - - 0x00080000 - - 0x00100000 - - 0x00200000 - - 0x00400000 + - 0 + - 1 + - 2 + - 4 + - 8388608 + - 6 + - 8 + - 16 + - 16777216 + - 24 + - 33554432 + - 128 + - 67108864 + - 134217728 + - 268435456 + - 256 + - 1024 + - 2048 + - 512 + - 4096 + - 8192 + - 3072 + - 2147483648 + - 2415919104 + - 2684354560 + - 2952790016 + - 3221225472 + - 32 + - 64 + - 65536 + - 16384 + - 262144 + - 131072 + - 32768 + - 16777216 + - 67108864 + - 64 + - 32 + - 524288 + - 1048576 + - 2097152 + - 4194304 x-enum-descriptions: - "Lighting schemes are off" - "OVI scheme" diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index 5eb9fe2..e2e581e 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -7,132 +7,132 @@ components: format: int64 description: "The enumeration contains error codes that can return during the RFID chip processing." enum: - - 0x00000001 - - 0x80000001 - - 0x80000002 - - 0x80000003 - - 0x80000008 - - 0x80000009 - - 0x8000000A - - 0x80000011 - - 0x80000013 - - 0x80000014 - - 0x80000015 - - 0x80000016 - - 0x80000012 - - 0x80000017 - - 0x80000018 - - 0x80000019 - - 0x8000001A - - 0x8000001B - - 0x8000001C - - 0x8000001D - - 0x8000001E - - 0x8000001F - - 0x80000020 - - 0x80000021 - - 0x80000022 - - 0x80000023 - - 0x80000024 - - 0x80000025 - - 0x80000026 - - 0x80000027 - - 0x80000030 - - 0x80000031 - - 0x80000032 - - 0x80000033 - - 0x80000034 - - 0x80000036 - - 0x80000035 - - 0x80000050 - - 0x80000051 - - 0x80000052 - - 0x80000053 - - 0x80000054 - - 0x80000055 - - 0x80000056 - - 0x80000057 - - 0x80000058 - - 0x80000059 - - 0x8000005A - - 0x80000070 - - 0x80000071 - - 0x81000011 - - 0x81000020 - - 0x81000021 - - 0x81000022 - - 0x81000023 - - 0x81000024 - - 0x81000025 - - 0x81000026 - - 0x81000027 - - 0x81000028 - - 0x81000029 - - 0x8100002A - - 0x8100002B - - 0x8100002C - - 0x8100002D - - 0x8100002E - - 0x8100002F - - 0x81000030 - - 0x81000031 - - 0x81000032 - - 0x81000033 - - 0x81000034 - - 0x81000035 - - 0x81000036 - - 0x81000037 - - 0x81000038 - - 0x81000040 - - 0x81000041 - - 0x81000042 - - 0x81000043 - - 0x81000044 - - 0x81000045 - - 0x81000050 - - 0x81000051 - - 0x81000052 - - 0x81000053 - - 0x81000054 - - 0x81000055 - - 0x81000056 - - 0x81000057 - - 0x81000070 - - 0x81000071 - - 0x81000072 - - 0x81000060 - - 0x81000062 - - 0x81000063 - - 0x81000064 - - 0x81000065 - - 0x81000160 - - 0x81000161 - - 0x81000162 - - 0x81000163 - - 0x81000164 - - 0x81000165 - - 0x81000166 - - 0x81000167 - - 0x81000168 - - 0x81000169 - - 0x8100016A - - 0x81000200 - - 0x81000201 - - 0x81000202 - - 0x81000203 - - 0x81000204 - - 0x81000205 - - 0x81000300 - - 0x81000301 - - 0x81000302 - - 0x81000303 - - 0x81000304 - - 0x81000305 - - 0x81000306 - - 0x81000307 - - 0x81000308 - - 0x81000309 - - 0x8100030A + - 1 + - 2147483649 + - 2147483650 + - 2147483651 + - 2147483656 + - 2147483657 + - 2147483658 + - 2147483665 + - 2147483667 + - 2147483668 + - 2147483669 + - 2147483670 + - 2147483666 + - 2147483671 + - 2147483672 + - 2147483673 + - 2147483674 + - 2147483675 + - 2147483676 + - 2147483677 + - 2147483678 + - 2147483679 + - 2147483680 + - 2147483681 + - 2147483682 + - 2147483683 + - 2147483684 + - 2147483685 + - 2147483686 + - 2147483687 + - 2147483696 + - 2147483697 + - 2147483698 + - 2147483699 + - 2147483700 + - 2147483702 + - 2147483701 + - 2147483728 + - 2147483729 + - 2147483730 + - 2147483731 + - 2147483732 + - 2147483733 + - 2147483734 + - 2147483735 + - 2147483736 + - 2147483737 + - 2147483738 + - 2147483760 + - 2147483761 + - 2164260881 + - 2164260896 + - 2164260897 + - 2164260898 + - 2164260899 + - 2164260900 + - 2164260901 + - 2164260902 + - 2164260903 + - 2164260904 + - 2164260905 + - 2164260906 + - 2164260907 + - 2164260908 + - 2164260909 + - 2164260910 + - 2164260911 + - 2164260912 + - 2164260913 + - 2164260914 + - 2164260915 + - 2164260916 + - 2164260917 + - 2164260918 + - 2164260919 + - 2164260920 + - 2164260928 + - 2164260929 + - 2164260930 + - 2164260931 + - 2164260932 + - 2164260933 + - 2164260944 + - 2164260945 + - 2164260946 + - 2164260947 + - 2164260948 + - 2164260949 + - 2164260950 + - 2164260951 + - 2164260976 + - 2164260977 + - 2164260978 + - 2164260960 + - 2164260962 + - 2164260963 + - 2164260964 + - 2164260965 + - 2164261216 + - 2164261217 + - 2164261218 + - 2164261219 + - 2164261220 + - 2164261221 + - 2164261222 + - 2164261223 + - 2164261224 + - 2164261225 + - 2164261226 + - 2164261376 + - 2164261377 + - 2164261378 + - 2164261379 + - 2164261380 + - 2164261381 + - 2164261632 + - 2164261633 + - 2164261634 + - 2164261635 + - 2164261636 + - 2164261637 + - 2164261638 + - 2164261639 + - 2164261640 + - 2164261641 + - 2164261642 x-enum-descriptions: - "OK" - "ASN: Incorrect data" diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 07f248c..b41ff57 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -7,228 +7,228 @@ components: format: int64 description: "The enumeration contains possible values of notification codes returned during the RFID chip processing." enum: - - 0x90000001 - - 0x90000002 - - 0x90000003 - - 0x90000004 - - 0x90000005 - - 0x90000006 - - 0x90000008 - - 0x9000000E - - 0x9000000F - - 0x90000010 - - 0x90000017 - - 0x90000200 - - 0x90000201 - - 0x90000202 - - 0x90000203 - - 0x90000204 - - 0x90000205 - - 0x90000206 - - 0x90000207 - - 0x90000208 - - 0x90000209 - - 0x9000020A - - 0x9000020B - - 0x9000020C - - 0x9000020D - - 0x9000020E - - 0x9000020F - - 0x90000210 - - 0x90000211 - - 0x90000212 - - 0x90000213 - - 0x90000214 - - 0x90000215 - - 0x90000216 - - 0x90000217 - - 0x90000218 - - 0x90000219 - - 0x9000021A - - 0x9000021B - - 0x9000021C - - 0x9000021D - - 0x9000021E - - 0x9000021F - - 0x90000220 - - 0x90000221 - - 0x90000222 - - 0x90000223 - - 0x90000224 - - 0x90000225 - - 0x90000226 - - 0x90000228 - - 0x90000229 - - 0x9000022A - - 0x9000022B - - 0x9000022C - - 0x9000022D - - 0x9000022E - - 0x9000022F - - 0x90000231 - - 0x90000232 - - 0x90000233 - - 0x90000234 - - 0x90000235 - - 0x90000236 - - 0x90000237 - - 0x90000238 - - 0x90000239 - - 0x9000023A - - 0x9000023B - - 0x9000023C - - 0x9000023D - - 0x9000023E - - 0x9000023F - - 0x90000240 - - 0x90000241 - - 0x90000242 - - 0x90000243 - - 0x90000244 - - 0x90000245 - - 0x90000246 - - 0x90000247 - - 0x90000248 - - 0x90000249 - - 0x9000024A - - 0x9000024B - - 0x9000024C - - 0x9000024D - - 0x9000024E - - 0x9000024F - - 0x90000020 - - 0x90000021 - - 0x90000022 - - 0x90000023 - - 0x90000024 - - 0x90000025 - - 0x90000026 - - 0x90000030 - - 0x90000031 - - 0x90000032 - - 0x90000033 - - 0x90000100 - - 0x900001A0 - - 0x900001A1 - - 0x90000101 - - 0x90000102 - - 0x90000103 - - 0x90000109 - - 0x900001B0 - - 0x900001B1 - - 0x900001B2 - - 0x90000104 - - 0x90000105 - - 0x90000106 - - 0x90000107 - - 0x90000108 - - 0x900001C0 - - 0x900001C8 - - 0x900001D0 - - 0x900001D8 - - 0x9000010A - - 0x9000010B - - 0x9000010C - - 0x9000010D - - 0x9000010E - - 0x9000010F - - 0x90000110 - - 0x90000111 - - 0x90000112 - - 0x9000011B - - 0x9000011C - - 0x9000011D - - 0x9000011E - - 0x9000011F - - 0x90000115 - - 0x90000116 - - 0x90000117 - - 0x90000118 - - 0x90000119 - - 0x9000011A - - 0x00022008 - - 0x00022009 - - 0x0002200A - - 0x0002200D - - 0x0002200E - - 0x0002200F - - 0x00022010 - - 0x00022011 - - 0x00022012 - - 0x00022013 - - 0x00022014 - - 0x00022015 - - 0x00022016 - - 0x00022017 - - 0x00022018 - - 0x90010000 - - 0x90020000 - - 0x90030000 - - 0x90040000 - - 0x90050000 - - 0x90060000 - - 0x90070000 - - 0x90080000 - - 0x90090000 - - 0x900A0000 - - 0x900B0000 - - 0x90100000 - - 0x90110000 - - 0x90120000 - - 0x90130000 - - 0x90140000 - - 0x90150000 - - 0x90160000 - - 0x90170000 - - 0x90180000 - - 0x90190000 - - 0x901A0000 - - 0x91000000 - - 0x91000001 - - 0x91000002 - - 0x91000003 - - 0x91000004 - - 0x91000005 - - 0x91000006 - - 0x91000007 - - 0x91000008 - - 0x91000009 - - 0x9100000A - - 0x9100000B - - 0x9100000C - - 0x9100000D - - 0x9100000E - - 0x91000100 - - 0x91000101 - - 0x91000102 - - 0x91000103 - - 0x91000104 - - 0x91000105 - - 0x91000106 - - 0x91000107 - - 0x91000108 - - 0x91000109 - - 0x9100010A - - 0x9100010B - - 0x9100010C - - 0x9100010D - - 0x9100010E - - 0x9100010F - - 0x91000110 - - 0x91000201 - - 0x91000202 - - 0x91000203 - - 0x91000204 - - 0x91000300 - - 0x92000115 - - 0x92000116 - - 0x92000117 - - 0x92000118 - - 0x92000119 - - 0x90000250 - - 0x90000251 - - 0x00022019 - - 0x90000252 + - 2415919105 + - 2415919106 + - 2415919107 + - 2415919108 + - 2415919109 + - 2415919110 + - 2415919112 + - 2415919118 + - 2415919119 + - 2415919120 + - 2415919127 + - 2415919616 + - 2415919617 + - 2415919618 + - 2415919619 + - 2415919620 + - 2415919621 + - 2415919622 + - 2415919623 + - 2415919624 + - 2415919625 + - 2415919626 + - 2415919627 + - 2415919628 + - 2415919629 + - 2415919630 + - 2415919631 + - 2415919632 + - 2415919633 + - 2415919634 + - 2415919635 + - 2415919636 + - 2415919637 + - 2415919638 + - 2415919639 + - 2415919640 + - 2415919641 + - 2415919642 + - 2415919643 + - 2415919644 + - 2415919645 + - 2415919646 + - 2415919647 + - 2415919648 + - 2415919649 + - 2415919650 + - 2415919651 + - 2415919652 + - 2415919653 + - 2415919654 + - 2415919656 + - 2415919657 + - 2415919658 + - 2415919659 + - 2415919660 + - 2415919661 + - 2415919662 + - 2415919663 + - 2415919665 + - 2415919666 + - 2415919667 + - 2415919668 + - 2415919669 + - 2415919670 + - 2415919671 + - 2415919672 + - 2415919673 + - 2415919674 + - 2415919675 + - 2415919676 + - 2415919677 + - 2415919678 + - 2415919679 + - 2415919680 + - 2415919681 + - 2415919682 + - 2415919683 + - 2415919684 + - 2415919685 + - 2415919686 + - 2415919687 + - 2415919688 + - 2415919689 + - 2415919690 + - 2415919691 + - 2415919692 + - 2415919693 + - 2415919694 + - 2415919695 + - 2415919136 + - 2415919137 + - 2415919138 + - 2415919139 + - 2415919140 + - 2415919141 + - 2415919142 + - 2415919152 + - 2415919153 + - 2415919154 + - 2415919155 + - 2415919360 + - 2415919520 + - 2415919521 + - 2415919361 + - 2415919362 + - 2415919363 + - 2415919369 + - 2415919536 + - 2415919537 + - 2415919538 + - 2415919364 + - 2415919365 + - 2415919366 + - 2415919367 + - 2415919368 + - 2415919552 + - 2415919560 + - 2415919568 + - 2415919576 + - 2415919370 + - 2415919371 + - 2415919372 + - 2415919373 + - 2415919374 + - 2415919375 + - 2415919376 + - 2415919377 + - 2415919378 + - 2415919387 + - 2415919388 + - 2415919389 + - 2415919390 + - 2415919391 + - 2415919381 + - 2415919382 + - 2415919383 + - 2415919384 + - 2415919385 + - 2415919386 + - 139272 + - 139273 + - 139274 + - 139277 + - 139278 + - 139279 + - 139280 + - 139281 + - 139282 + - 139283 + - 139284 + - 139285 + - 139286 + - 139287 + - 139288 + - 2415984640 + - 2416050176 + - 2416115712 + - 2416181248 + - 2416246784 + - 2416312320 + - 2416377856 + - 2416443392 + - 2416508928 + - 2416574464 + - 2416640000 + - 2416967680 + - 2417033216 + - 2417098752 + - 2417164288 + - 2417229824 + - 2417295360 + - 2417360896 + - 2417426432 + - 2417491968 + - 2417557504 + - 2417623040 + - 2432696320 + - 2432696321 + - 2432696322 + - 2432696323 + - 2432696324 + - 2432696325 + - 2432696326 + - 2432696327 + - 2432696328 + - 2432696329 + - 2432696330 + - 2432696331 + - 2432696332 + - 2432696333 + - 2432696334 + - 2432696576 + - 2432696577 + - 2432696578 + - 2432696579 + - 2432696580 + - 2432696581 + - 2432696582 + - 2432696583 + - 2432696584 + - 2432696585 + - 2432696586 + - 2432696587 + - 2432696588 + - 2432696589 + - 2432696590 + - 2432696591 + - 2432696592 + - 2432696833 + - 2432696834 + - 2432696835 + - 2432696836 + - 2432697088 + - 2449473813 + - 2449473814 + - 2449473815 + - 2449473816 + - 2449473817 + - 2415919696 + - 2415919697 + - 139289 + - 2415919698 x-enum-descriptions: - "ASN certificate: Incorrect version" - "ASN certificate: Non-matching signature algorithm" diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml index 75f6507..4efbf28 100644 --- a/e-rfid-data-group-type-tag.yml +++ b/e-rfid-data-group-type-tag.yml @@ -9,61 +9,61 @@ components: application, with prefix EID_ – those of eID application, with prefix EDL_ – eDL application" enum: - - 0x60 - - 0x61 - - 0x75 - - 0x63 - - 0x76 - - 0x65 - - 0x66 - - 0x67 - - 0x68 - - 0x69 - - 0x6A - - 0x6B - - 0x6C - - 0x6D - - 0x6E - - 0x6F - - 0x70 - - 0x77 - - 0x61 - - 0x62 - - 0x63 - - 0x64 - - 0x65 - - 0x66 - - 0x67 - - 0x68 - - 0x69 - - 0x6A - - 0x6B - - 0x6C - - 0x6D - - 0x6E - - 0x6F - - 0x70 - - 0x71 - - 0x72 - - 0x73 - - 0x74 - - 0x75 - - 0x60 - - 0x77 - - 0x77 - - 0x61 - - 0x6B - - 0x6C - - 0x65 - - 0x67 - - 0x75 - - 0x63 - - 0x76 - - 0x70 - - 0x6D - - 0x71 - - 0x6F - - 0x6E + - 96 + - 97 + - 117 + - 99 + - 118 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 119 + - 97 + - 98 + - 99 + - 100 + - 101 + - 102 + - 103 + - 104 + - 105 + - 106 + - 107 + - 108 + - 109 + - 110 + - 111 + - 112 + - 113 + - 114 + - 115 + - 116 + - 117 + - 96 + - 119 + - 119 + - 97 + - 107 + - 108 + - 101 + - 103 + - 117 + - 99 + - 118 + - 112 + - 109 + - 113 + - 111 + - 110 x-enum-descriptions: - "Common Data Group Type" - "Data Group 1" diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index 6364ede..c798668 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -7,120 +7,120 @@ components: format: int64 description: "Enumeration contains a set of error codes returned by SDK" enum: - - 0x80006282 - - 0x80006283 - - 0x800063C0 - - 0x800063C1 - - 0x80006983 - - 0x80006984 - - 0x80006985 - - 0x80006A80 - - 0x80006A82 - - 0x80006A88 - - 0x80006B00 - - 0x80010001 - - 0x80010002 - - 0x80010004 - - 0x80010005 - - 0x80010006 - - 0x80010008 - - 0x80010009 - - 0x8001000A - - 0x8001000B - - 0x8001000C - - 0x80020000 - - 0x80020001 - - 0x80020002 - - 0x80020003 - - 0x80020004 - - 0x80020005 - - 0x80020006 - - 0x80020010 - - 0x801063C0 - - 0x83000000 - - 0x83000001 - - 0x83000002 - - 0x83000010 - - 0x83000011 - - 0x83000012 - - 0x83000013 - - 0x83000014 - - 0x83000015 - - 0x83000016 - - 0x83000017 - - 0x83000018 - - 0x83000019 - - 0x8300001A - - 0x8300001B - - 0x8300001C - - 0x83000020 - - 0x83000021 - - 0x83000022 - - 0x83000023 - - 0x83000024 - - 0x83000025 - - 0x83000026 - - 0x83000027 - - 0x83000028 - - 0x83000029 - - 0x8300002A - - 0x83000030 - - 0x83000031 - - 0x83000040 - - 0x83000041 - - 0x83000042 - - 0x83000050 - - 0x83000051 - - 0x83000052 - - 0x83000060 - - 0x83010000 - - 0x83020000 - - 0x83030000 - - 0x83040000 - - 0x83050000 - - 0x83060000 - - 0x83070000 - - 0x83080000 - - 0x84000000 - - 0x84010000 - - 0x84020000 - - 0x84030000 - - 0x84040000 - - 0x84050000 - - 0x84060000 - - 0x84070000 - - 0x84080000 - - 0x84090000 - - 0x840A0000 - - 0x840B0000 - - 0x840C0000 - - 0x840D0000 - - 0x840E0000 - - 0x840F0000 - - 0x86000000 - - 0x86000001 - - 0x86000100 - - 0x86000101 - - 0x86000102 - - 0x86000103 - - 0x86000200 - - 0x86000201 - - 0x86000202 - - 0x86000203 - - 0x86000204 - - 0x86000300 - - 0x86000301 - - 0x86000302 - - 0x86000303 - - 0x86000304 - - 0x86000305 - - 0x86000306 - - 0x86000307 - - 0x86000308 - - 0x86000309 - - 0xFFFFFFFF - - 0x00000001 - - 0x00000002 + - 2147508866 + - 2147508867 + - 2147509184 + - 2147509185 + - 2147510659 + - 2147510660 + - 2147510661 + - 2147510912 + - 2147510914 + - 2147510920 + - 2147511040 + - 2147549185 + - 2147549186 + - 2147549188 + - 2147549189 + - 2147549190 + - 2147549192 + - 2147549193 + - 2147549194 + - 2147549195 + - 2147549196 + - 2147614720 + - 2147614721 + - 2147614722 + - 2147614723 + - 2147614724 + - 2147614725 + - 2147614726 + - 2147614736 + - 2148557760 + - 2197815296 + - 2197815297 + - 2197815298 + - 2197815312 + - 2197815313 + - 2197815314 + - 2197815315 + - 2197815316 + - 2197815317 + - 2197815318 + - 2197815319 + - 2197815320 + - 2197815321 + - 2197815322 + - 2197815323 + - 2197815324 + - 2197815328 + - 2197815329 + - 2197815330 + - 2197815331 + - 2197815332 + - 2197815333 + - 2197815334 + - 2197815335 + - 2197815336 + - 2197815337 + - 2197815338 + - 2197815344 + - 2197815345 + - 2197815360 + - 2197815361 + - 2197815362 + - 2197815376 + - 2197815377 + - 2197815378 + - 2197815392 + - 2197880832 + - 2197946368 + - 2198011904 + - 2198077440 + - 2198142976 + - 2198208512 + - 2198274048 + - 2198339584 + - 2214592512 + - 2214658048 + - 2214723584 + - 2214789120 + - 2214854656 + - 2214920192 + - 2214985728 + - 2215051264 + - 2215116800 + - 2215182336 + - 2215247872 + - 2215313408 + - 2215378944 + - 2215444480 + - 2215510016 + - 2215575552 + - 2248146944 + - 2248146945 + - 2248147200 + - 2248147201 + - 2248147202 + - 2248147203 + - 2248147456 + - 2248147457 + - 2248147458 + - 2248147459 + - 2248147460 + - 2248147712 + - 2248147713 + - 2248147714 + - 2248147715 + - 2248147716 + - 2248147717 + - 2248147718 + - 2248147719 + - 2248147720 + - 2248147721 + - 4294967295 + - 1 + - 2 x-enum-descriptions: - "LAYER6: Reading beyond EOF / Unexpected EOF" - "LAYER6: PWD deactivated" diff --git a/index.yml b/index.yml index 19e273d..7e521dc 100644 --- a/index.yml +++ b/index.yml @@ -100,3 +100,5 @@ components: $ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate" RFIDPKDResourceType: $ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType" + ParsingErrorCodes: + $ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes" diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index c0ec236..9467885 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -960,11 +960,11 @@ components: type: integer description: "Enumeration contains a set of constants specifying the rate of data exchange between the reader and the RFID-chip" enum: - - 0x00 - - 0x01 - - 0x02 - - 0x04 - - 0x08 + - 0 + - 1 + - 2 + - 4 + - 8 x-enum-descriptions: - "Unknown" - "106 bits/s" From 1693e5d5d9c41a2659677a1e9845f66a778ffeb3 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 9 Apr 2025 11:48:01 +0300 Subject: [PATCH 076/106] SP-18211 - Add tag, tenant, env to transaction process request --- p-transaction.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/p-transaction.yml b/p-transaction.yml index 6c51088..611684f 100644 --- a/p-transaction.yml +++ b/p-transaction.yml @@ -266,6 +266,15 @@ components: type: array items: $ref: "./p-process.yml#/components/schemas/ProcessRequestImage" + tag: + type: string + description: "Session ID" + tenant: + type: string + description: "Customer name" + env: + type: string + description: "Environment type" livePortrait: type: string format: base64 From 9243da5bce332997f7262e65379b7baa1535256e Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 9 Apr 2025 14:41:47 +0300 Subject: [PATCH 077/106] SP-18211 - Remove unused descriptions --- authenticity/e-result-type.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/authenticity/e-result-type.yml b/authenticity/e-result-type.yml index fe72b3f..ff31722 100644 --- a/authenticity/e-result-type.yml +++ b/authenticity/e-result-type.yml @@ -30,7 +30,6 @@ components: - 8388608 - 16777216 x-enum-descriptions: - - "No authenticity control procedure" - "Document luminescence check in UV light" - "B900 ink MRZ contrast check in IR light" - "Image patterns presence/absence check (position, shape, color)" @@ -39,13 +38,10 @@ components: - "Document elements visibility check in IR light" - "OCR for the text field in UV light comparison with other text sources check" - "Invisible Personal Information (IPI) visualization" - - "Document photo check in IR light" - "Owner's photo embedding check (is photo printed or sticked)" - "OVI check. Deprecated, use Document liveness check instead" - - "IR luminescence check" - "Hologram presence check. Deprecated" - "Owner's photo area advanced check (photo shape, size, position, etc.)" - - "UV background check" - "Portrait comparison check (document printed vs chip vs live)" - "Barcode format check (code metadata, data format, contents format, etc.)" - "Kinegram check" @@ -56,7 +52,6 @@ components: - "Extended OCR Check" - "Extended MRZ check" - "Encrypted IPI" - - "Flag for status-only authenticity" x-enum-varnames: - "UV_LUMINESCENCE" - "IR_B900" From 265516666380e2bf093ee41808c4dc4859a1186c Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 10 Apr 2025 13:01:04 +0300 Subject: [PATCH 078/106] SP-18211 - Update barcode type enum --- e-barcode-type.yml | 41 +++++++++++++++++++---------------------- rt-text.yml | 1 - 2 files changed, 19 insertions(+), 23 deletions(-) diff --git a/e-barcode-type.yml b/e-barcode-type.yml index 30b346c..b345aca 100644 --- a/e-barcode-type.yml +++ b/e-barcode-type.yml @@ -26,7 +26,6 @@ components: - 17 - 18 - 19 - - 20 x-enum-varnames: - "UNKNOWN" - "CODE128" @@ -48,26 +47,24 @@ components: - "ALL_1D" - "CODE11" - "JABCODE" - - "END" x-enum-descriptions: - - "Unknown type" - - "One-dimensional bar-code, ISO 15417 (ANSI/AIM BC4-1999 Code 128)" - - "One-dimensional bar-code, ISO 16388 (ANSI/AIM BC1-1995 Code 39)" - - "One-dimensional bar-code, EAN8, ISO 15418" - - "One-dimensional bar-code, Interleaved 2 of 5, ISO 16390 (ANSI/AIM BC2-1995 Interleaved 2 of 5)" - - "Two-dimensional bar-code, ISO 15438 (AIM USS PDF417)" - - "One-dimensional bar-code, Standard 2 of 5 (Industrial)" - - "One-dimensional bar-code, Matrix 2 of 5" - - "One-dimensional bar-code, IATA 2 of 5 (Airline)" - - "One-dimensional bar-code, (ANSI/AIM BC3-1995, USS - Codabar)" - - "One-dimensional bar-code, UPC-A" - - "One-dimensional bar-code, (ANSI/AIM BC5-1995, USS - Code 93)" - - "One-dimensional bar-code, UPC-E" - - "One-dimensional bar-code, EAN13, ISO 15418" - - "Two-dimensional QRCODE bar-code" - - "Two-dimensional AZTEC bar-code" - - "Two-dimensional DATAMATRIX bar-code" - - "Type for internal use, representing all 1D bar-codes" - - "One-dimensional bar-code CODE11" + - "Unknown" + - "Code 128" + - "Code 39" + - "EAN-8" + - "ITF" + - "PDF417" + - "STF" + - "MTF" + - "IATA" + - "Codabar" + - "UPC-A" + - "Code 93" + - "UPC-E" + - "EAN-13" + - "QR code" + - "Aztec code" + - "Datamatrix" + - "All 1D barcodes" + - "Code 11" - "JAB code" - - "For internal use" diff --git a/rt-text.yml b/rt-text.yml index 597fd0d..5752f6e 100644 --- a/rt-text.yml +++ b/rt-text.yml @@ -91,7 +91,6 @@ components: items: $ref: "#/components/schemas/CrossSourceValueComparison" - # todo originalValidity очень путает, может в validityList сделать validityList = originalValidity && validityList TextFieldValue: title: "TextFieldValue" type: object From c39c3157de3d90df41f8c72ff7bf80a156522629 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 11 Apr 2025 10:01:43 +0300 Subject: [PATCH 079/106] SP-18211 - Update Image data schema --- common.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/common.yml b/common.yml index 8202e43..1a81022 100644 --- a/common.yml +++ b/common.yml @@ -125,8 +125,6 @@ components: ImageData: title: "ImageData" type: object - required: - - image properties: image: $ref: "#/components/schemas/ImageBase64" From ae70d57c3c35e11e36ea4ceb3021dc867b776869 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 11 Apr 2025 13:49:45 +0300 Subject: [PATCH 080/106] SP-18211 - Update authenticity schemas --- authenticity/rt-fiber.yml | 2 ++ authenticity/rt-ident.yml | 4 ++++ authenticity/rt-ocr-security-text.yml | 2 ++ authenticity/rt-photo-ident.yml | 4 +--- authenticity/rt-security-feature.yml | 2 ++ 5 files changed, 11 insertions(+), 3 deletions(-) diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index 875c8ba..aef9b6b 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -50,3 +50,5 @@ components: type: array items: type: integer + ErrorCode: + type: integer diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index 9f7a747..b0a227a 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -22,3 +22,7 @@ components: $ref: "../common.yml#/components/schemas/ImageData" AreaList: $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" + ElementID: + type: integer + Result: + type: integer diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index d85daf2..39454d9 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -33,6 +33,8 @@ components: type: string EtalonResultOCR: type: string + ResultCode: + type: integer Reserved1: type: integer Reserved2: diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 929bf8f..7e2dc3c 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -28,9 +28,7 @@ components: type: integer Angle: type: integer - Reserved1: - type: integer - Reserved2: + Result: type: integer Reserved3: type: integer diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index 0693bf6..803490e 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -20,5 +20,7 @@ components: $ref: "./e-critical.yml#/components/schemas/Critical" AreaList: $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" + Result: + type: integer Reserved2: type: integer From 4ce02a0f69c48c5137dae40ada4e1d8334c68c5c Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 14 Apr 2025 17:30:33 +0300 Subject: [PATCH 081/106] SP-18211 - Update SecurityFeatureType enum --- e-security-feature-type.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 839006c..5abe38e 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -59,6 +59,7 @@ components: - 51 - 52 - 53 + - 54 x-enum-descriptions: - "Blank element" - "Personalization element" @@ -113,6 +114,7 @@ components: - "Contact chip check" - "Head position check" - "Black and white copy check" + - "Liveness dynaprint" x-enum-varnames: - "BLANK" - "FILL" @@ -167,3 +169,4 @@ components: - "CONTACT_CHIP_CLASSIFICATION" - "HEAD_POSITION_CHECK" - "LIVENESS_BLACK_AND_WHITE_COPY_CHECK" + - "LIVENESS_DYNAPRINT" From 3d590b98298c40b9d90d014abc3f7c28e0a0e5fb Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Apr 2025 10:41:47 +0300 Subject: [PATCH 082/106] SP-18211 - Add Liveness geometry check --- e-security-feature-type.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/e-security-feature-type.yml b/e-security-feature-type.yml index 5abe38e..6867496 100644 --- a/e-security-feature-type.yml +++ b/e-security-feature-type.yml @@ -60,6 +60,7 @@ components: - 52 - 53 - 54 + - 55 x-enum-descriptions: - "Blank element" - "Personalization element" @@ -115,6 +116,7 @@ components: - "Head position check" - "Black and white copy check" - "Liveness dynaprint" + - "Liveness geometry check" x-enum-varnames: - "BLANK" - "FILL" @@ -170,3 +172,4 @@ components: - "HEAD_POSITION_CHECK" - "LIVENESS_BLACK_AND_WHITE_COPY_CHECK" - "LIVENESS_DYNAPRINT" + - "LIVENESS_GEOMETRY_CHECK" From 80bed30c58469f3bf625d002c9d175924db861fc Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 21 Apr 2025 11:13:04 +0300 Subject: [PATCH 083/106] SP-18211 - Add checkGeometry --- p-process.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/p-process.yml b/p-process.yml index ec5a28e..002f966 100644 --- a/p-process.yml +++ b/p-process.yml @@ -610,6 +610,10 @@ components: type: boolean description: "This parameter is used to enable Dynaprint check" # default: true + checkGeometry: + type: boolean + description: "This parameter is used to enable Geometry check" + # default: true MeasureSystem: title: "MeasureSystem" From 120dc240888c14c2146424c1b78966aa75cdffad Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 22 Apr 2025 10:27:58 +0300 Subject: [PATCH 084/106] SP-18211 - Update lights enum --- common.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/common.yml b/common.yml index 1a81022..c26b065 100644 --- a/common.yml +++ b/common.yml @@ -253,6 +253,12 @@ components: - 1048576 - 2097152 - 4194304 + - 134 + - 67108870 + - 1073741824 + - 1073741830 + - 1073741952 + - 1073741848 x-enum-descriptions: - "Lighting schemes are off" - "OVI scheme" @@ -296,6 +302,12 @@ components: - "UVB 313 (mod. 88X0)" - "White oblique light" - "For internal use" + - "White UV" + - "White full hologram" + - "HR light" + - "HR white" + - "HR UV" + - "HR IR" x-enum-varnames: - "OFF" - "OVI" @@ -339,6 +351,12 @@ components: - "UVB" - "WHITE_OBL" - "WHITE_SPECIAL" + - "WHITE_UV" + - "WHITE_FULL_HOLO" + - "HR_LIGHT" + - "HR_WHITE" + - "HR_UV" + - "HR_IR" Point: title: "Point" From d9a6418f53e49d4e5b6ebc43256f157ad1bea430 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 23 Apr 2025 14:35:41 +0300 Subject: [PATCH 085/106] Update version --- index.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yml b/index.yml index 7e521dc..fd2b5de 100644 --- a/index.yml +++ b/index.yml @@ -1,6 +1,6 @@ openapi: 3.0.4 info: - version: 7.6.0 + version: 7.7.0 title: Regula Document Reader Web API x-logo: url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg" From 2324a05838d2eaa44898aae52a407679a5c26800 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 23 Apr 2025 14:37:14 +0300 Subject: [PATCH 086/106] Update version --- index.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yml b/index.yml index fd2b5de..c759abc 100644 --- a/index.yml +++ b/index.yml @@ -1,6 +1,6 @@ openapi: 3.0.4 info: - version: 7.7.0 + version: 8.1.0 title: Regula Document Reader Web API x-logo: url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg" From bdfd094b83640398683ef8ab542d7913753aa86c Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 24 Apr 2025 15:03:46 +0300 Subject: [PATCH 087/106] Add RFID scenario --- common.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/common.yml b/common.yml index c26b065..c1c1832 100644 --- a/common.yml +++ b/common.yml @@ -81,6 +81,7 @@ components: - "CreditCard" - "Capture" - "DTC" + - "RFID" x-enum-varnames: - "MRZ" - "BARCODE" @@ -101,6 +102,7 @@ components: - "CREDIT_CARD" - "CAPTURE" - "DTC" + - "RFID" x-enum-descriptions: - "Processing scenario for obtaining MRZ data" - "Processing scenario for obtaining barcode data" @@ -121,6 +123,7 @@ components: - "Processing scenario for obtaining bank card data" - "Scenario for obtaining an original image without any processing" - "Processing scenario for Digital Travel Credentials (DTC-VC) data processing" + - "Processing scenario for RFID chip processing" ImageData: title: "ImageData" From ffd576e2a38d3ded423bfa7d32e25adaffe2cbb1 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 24 Apr 2025 15:08:44 +0300 Subject: [PATCH 088/106] Add generateAlpha2Codes --- p-process.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/p-process.yml b/p-process.yml index 002f966..c184af6 100644 --- a/p-process.yml +++ b/p-process.yml @@ -457,6 +457,9 @@ components: description: "Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases." type: boolean # default: false + generateAlpha2Codes: + description: "Set to generate Alpha-2 codes for nationality and issuing state fields." + type: boolean MRZFormat: title: "MRZFormat" From 9e06e06759f45e9265b12483760bf97963472c29 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 25 Apr 2025 11:25:32 +0300 Subject: [PATCH 089/106] Remove SymbolRect from required --- common.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/common.yml b/common.yml index c1c1832..2c4a6a2 100644 --- a/common.yml +++ b/common.yml @@ -523,7 +523,6 @@ components: type: object description: "Describes a single character recognition results in the text field line" required: - - SymbolRect - CandidatesCount - ListOfCandidates properties: From 8ef9fe0f9e9ea62f2df3bc2abfdd16b8160d325c Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Wed, 30 Apr 2025 10:47:22 +0300 Subject: [PATCH 090/106] Optional FaceDetection --- rt-face-detection.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/rt-face-detection.yml b/rt-face-detection.yml index 44b29a8..6b7d79b 100644 --- a/rt-face-detection.yml +++ b/rt-face-detection.yml @@ -4,8 +4,6 @@ components: FaceDetectionItem: title: "FaceDetectionItem" type: object - required: - - FaceDetection properties: FaceDetection: $ref: "#/components/schemas/FaceDetection" From 7efee9ea16aabee957fc3789483dc4538e06472b Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 2 May 2025 11:56:56 +0300 Subject: [PATCH 091/106] Update text field type enum --- e-text-field-type.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/e-text-field-type.yml b/e-text-field-type.yml index cf30f67..10361fe 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -649,6 +649,9 @@ components: - 692 - 693 - 694 + - 695 + - 696 + - 697 x-enum-descriptions: - "Document class code" - "Issuing state code" @@ -1294,6 +1297,9 @@ components: - "EF.CardAccess" - "Short flight number" - "Airline code" + - "MVC Agency" + - "Issuing state code alpha" + - "Nationality code alpha" x-enum-varnames: - "DOCUMENT_CLASS_CODE" - "ISSUING_STATE_CODE" @@ -1939,3 +1945,6 @@ components: - "EF_CARD_ACCESS" - "SHORT_FLIGHT_NUMBER" - "AIRLINE_CODE" + - "FT_MVC_AGENCY" + - "FT_ISSUING_STATE_CODE_ALPHA2" + - "FT_NATIONALITY_CODE_ALPHA2" From c03297d151ea91259a37eebfee1cb7aa63436bca Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 5 May 2025 14:13:50 +0300 Subject: [PATCH 092/106] Add pdfPagesLimit --- p-process.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/p-process.yml b/p-process.yml index c184af6..fed3b4c 100644 --- a/p-process.yml +++ b/p-process.yml @@ -460,6 +460,9 @@ components: generateAlpha2Codes: description: "Set to generate Alpha-2 codes for nationality and issuing state fields." type: boolean + pdfPagesLimit: + description: "Limits the number of pages to be processed from a PDF file." + type: integer MRZFormat: title: "MRZFormat" From e3d715bf00e0a260cc1ba13c3a6c0a47566ac83e Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> Date: Mon, 12 May 2025 10:23:29 +0300 Subject: [PATCH 093/106] Update e-text-field-type.yml --- e-text-field-type.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/e-text-field-type.yml b/e-text-field-type.yml index 10361fe..e93d74a 100644 --- a/e-text-field-type.yml +++ b/e-text-field-type.yml @@ -1298,8 +1298,8 @@ components: - "Short flight number" - "Airline code" - "MVC Agency" - - "Issuing state code alpha" - - "Nationality code alpha" + - "Issuing state code (Alpha-2)" + - "Nationality code (Alpha-2)" x-enum-varnames: - "DOCUMENT_CLASS_CODE" - "ISSUING_STATE_CODE" From 5df06304f8ad1bc28b3ffd99ff75569e508382bb Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 12 May 2025 12:00:31 +0300 Subject: [PATCH 094/106] Update schemas --- rt-doc-type-old.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index c347d18..df50b42 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -53,12 +53,10 @@ components: type: object description: "Contains information about one document type candidate" required: - - DocumentName - ID - P - Rotated180 - RFID_Presence - - FDSIDList - NecessaryLights - CheckAuthenticity - UVExp From 36e092002af0ee5a1f4b470951dfe036f9234b30 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 22 May 2025 10:33:52 +0300 Subject: [PATCH 095/106] Update eLDS_ParsingNotificationCodes --- e-parsing-notification-codes.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index b41ff57..2c6a365 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -229,6 +229,8 @@ components: - 2415919697 - 139289 - 2415919698 + - 2415919699 + - 2415919700 x-enum-descriptions: - "ASN certificate: Incorrect version" - "ASN certificate: Non-matching signature algorithm" @@ -452,6 +454,8 @@ components: - "Country Codes from certificate and visual MRZ don't match" - "Incorrect MRZ, country code doesn't match codes from Visual MRZ" - "Country Codes from certificate and DG1 MRZ don't match" + - "ICAO certificate: Issuer country non upper case" + - "ICAO certificate: Subject country non upper case" x-enum-varnames: - "ntfLDS_ASN_Certificate_IncorrectVersion" - "ntfLDS_ASN_Certificate_NonMatchingSignatureAlgorithm" @@ -675,3 +679,5 @@ components: - "ntfLDS_ICAO_Certificate_VisualMrz_Country_NonMatching" - "ntfLDS_MRZ_CountryCode_VisualMrz_NonMatching" - "ntfLDS_ICAO_Certificate_MRZ_Country_NonMatching" + - "ntfLDS_ICAO_Certificate_Issuer_CountryNonUpperCase" + - "ntfLDS_ICAO_Certificate_Subject_CountryNonUpperCase" From 2f6db8957649b7f86b02d9958f50ebc6adf5ee66 Mon Sep 17 00:00:00 2001 From: Vladislav Yakimchik <31860804+vyakimchik@users.noreply.github.com> Date: Mon, 26 May 2025 11:49:27 +0300 Subject: [PATCH 096/106] Renamed paSensitiveCodesDisable to paIgnoreNotificationCodes --- p-process.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/p-process.yml b/p-process.yml index fed3b4c..19e2db1 100644 --- a/p-process.yml +++ b/p-process.yml @@ -423,7 +423,7 @@ components: type: object description: "Params for the RFID chip data reprocessing" properties: - paSensitiveCodesDisable: + paIgnoreNotificationCodes: description: "A list of notification codes that should be ignored during passive authentication (PA)" type: array items: From e0bcc27a54aff67b3e07734cd103aef7acc60f47 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 3 Jun 2025 16:01:39 +0300 Subject: [PATCH 097/106] Update DeviceInfo --- p-ping.yml | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/p-ping.yml b/p-ping.yml index 62371e4..2796051 100644 --- a/p-ping.yml +++ b/p-ping.yml @@ -24,19 +24,58 @@ components: type: object properties: app-name: + description: Application name. type: string version: + description: Product version. type: string license-id: + description: Unique license identifier. type: string license-serial: + description: License serial number. + type: string + license-type: type: string valid-until: + description: License validity date. type: string format: date-time server-time: type: string - format: date-time + supported-scenarios: + description: List of supported scenarios. + type: array + items: + type: string + metadata: + type: object + additionalProperties: true + documents-database: + description: Database information. + type: object + required: + - id + - version + - export-date + - description + properties: + id: + description: Database identifier. + type: string + nullable: true + version: + description: Database version. + type: string + nullable: true + export-date: + description: Date of database creation. + type: string + nullable: true + description: + description: Description of the database contents, such as the list of supported countries and documents. + type: string + nullable: true example: app-name: "Regula Process Manager Service" version: "5.3.104980.123" From 430a9113d83268b482397333446e529ea0f28e27 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko <60066359+inspector-code@users.noreply.github.com> Date: Wed, 4 Jun 2025 20:23:33 +0300 Subject: [PATCH 098/106] Update e-rfid-data-group-type-tag.yml --- e-rfid-data-group-type-tag.yml | 78 +++++++++++++++++----------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml index 4efbf28..acf8e2c 100644 --- a/e-rfid-data-group-type-tag.yml +++ b/e-rfid-data-group-type-tag.yml @@ -65,7 +65,7 @@ components: - 111 - 110 x-enum-descriptions: - - "Common Data Group Type" + - "Common Data Element" - "Data Group 1" - "Data Group 2" - "Data Group 3" @@ -82,44 +82,44 @@ components: - "Data Group 14" - "Data Group 15" - "Data Group 16" - - "Start of Data" - - "Extended Interoperable Data, Data Group 1" - - "Extended Interoperable Data, Data Group 2" - - "Extended Interoperable Data, Data Group 3" - - "Extended Interoperable Data, Data Group 4" - - "Extended Interoperable Data, Data Group 5" - - "Extended Interoperable Data, Data Group 6" - - "Extended Interoperable Data, Data Group 7" - - "Extended Interoperable Data, Data Group 8" - - "Extended Interoperable Data, Data Group 9" - - "Extended Interoperable Data, Data Group 10" - - "Extended Interoperable Data, Data Group 11" - - "Extended Interoperable Data, Data Group 12" - - "Extended Interoperable Data, Data Group 13" - - "Extended Interoperable Data, Data Group 14" - - "Extended Interoperable Data, Data Group 15" - - "Extended Interoperable Data, Data Group 16" - - "Extended Interoperable Data, Data Group 17" - - "Extended Interoperable Data, Data Group 18" - - "Extended Interoperable Data, Data Group 19" - - "Extended Interoperable Data, Data Group 20" - - "Extended Interoperable Data, Data Group 21" - - "Extended Length Data, Common Data Group Type" - - "Extended Length Data, Start of Data" - - "Extended Length Data, Certificate Holder Authorization" - - "Extended Length Data, Data Group 1" - - "Extended Length Data, Data Group 2" - - "Extended Length Data, Data Group 3" - - "Extended Length Data, Data Group 4" - - "Extended Length Data, Data Group 5" - - "Extended Length Data, Data Group 6" - - "Extended Length Data, Data Group 7" - - "Extended Length Data, Data Group 8" - - "Extended Length Data, Data Group 9" - - "Extended Length Data, Data Group 11" - - "Extended Length Data, Data Group 12" - - "Extended Length Data, Data Group 13" - - "Extended Length Data, Data Group 14" + - "Security Object Document" + - "eID, Data Group 1" + - "eID, Data Group 2" + - "eID, Data Group 3" + - "eID, Data Group 4" + - "eID, Data Group 5" + - "eID, Data Group 6" + - "eID, Data Group 7" + - "eID, Data Group 8" + - "eID, Data Group 9" + - "eID, Data Group 10" + - "eID, Data Group 11" + - "eID, Data Group 12" + - "eID, Data Group 13" + - "eID, Data Group 14" + - "eID, Data Group 15" + - "eID, Data Group 16" + - "eID, Data Group 17" + - "eID, Data Group 18" + - "eID, Data Group 19" + - "eID, Data Group 20" + - "eID, Data Group 21" + - "eDL, Common Data Element" + - "eDL, Security Object Document" + - "eDL, Card Entitlement" + - "eDL, Data Group 1" + - "eDL, Data Group 2" + - "eDL, Data Group 3" + - "eDL, Data Group 4" + - "eDL, Data Group 5" + - "eDL, Data Group 6" + - "eDL, Data Group 7" + - "eDL, Data Group 8" + - "eDL, Data Group 9" + - "eDL, Data Group 11" + - "eDL, Data Group 12" + - "eDL, Data Group 13" + - "eDL, Data Group 14" x-enum-varnames: - "COM" - "DG1" From 6d84c47f51f1e60077fe85241b842da019e510f4 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 5 Jun 2025 09:51:49 +0300 Subject: [PATCH 099/106] Update Rotated180 description --- .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE}/config.yml | 0 rt-doc-type-old.yml | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE}/config.yml (100%) diff --git a/.github/ISSUE_TEMPLATE /config.yml b/.github/ISSUE_TEMPLATE/config.yml similarity index 100% rename from .github/ISSUE_TEMPLATE /config.yml rename to .github/ISSUE_TEMPLATE/config.yml diff --git a/rt-doc-type-old.yml b/rt-doc-type-old.yml index df50b42..34389c0 100644 --- a/rt-doc-type-old.yml +++ b/rt-doc-type-old.yml @@ -76,7 +76,7 @@ components: minimum: 0 maximum: 1 Rotated180: - description: "true if the document of the given type is rotated by 180 degrees" + description: "Indicates if the document of the given type is rotated by 180 degrees" type: integer RFID_Presence: description: # Indication of the presence of an RFID chip in the document (electronic document indicator) From 77722e67e870ceddf5bf06e4ce908e3297632b6a Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 5 Jun 2025 15:36:41 +0300 Subject: [PATCH 100/106] Update gh actions --- .github/workflows/validate-spec.yml | 8 ++++---- .github/workflows/verify-clients.yml | 5 +++-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/workflows/validate-spec.yml b/.github/workflows/validate-spec.yml index b2b245c..b343645 100644 --- a/.github/workflows/validate-spec.yml +++ b/.github/workflows/validate-spec.yml @@ -17,16 +17,16 @@ jobs: - name: Setup Node uses: actions/setup-node@v4 with: - node-version: 14 + node-version: 20 registry-url: https://registry.npmjs.org/ - name: Install redoc run: | - npm install -g redoc-cli - redoc-cli bundle index.yml + npm install -g @redocly/cli + redocly build-docs index.yml - name: Revert changes if: ${{ false }} run: | npm install -g @openapitools/openapi-generator-cli - openapi-generator-cli validate -i index.yml + openapi-generator-cli validate --recommend -i index.yml diff --git a/.github/workflows/verify-clients.yml b/.github/workflows/verify-clients.yml index e5f5a5b..ef7ee94 100644 --- a/.github/workflows/verify-clients.yml +++ b/.github/workflows/verify-clients.yml @@ -26,6 +26,7 @@ jobs: working-directory: python-client run: | ./update-models.sh + ./setup.sh verify-csharp: runs-on: ubuntu-latest @@ -45,6 +46,7 @@ jobs: working-directory: csharp-client run: | ./update-models.sh + ./setup.sh verify-js: runs-on: ubuntu-latest @@ -63,9 +65,8 @@ jobs: - name: Verify update JS client working-directory: js-client run: | - npm install ./update-models.sh - npm run check-types + ./setup.sh verify-java: runs-on: ubuntu-latest From 0aefabbdb88feff58eaf99add34a47c2dfecba8b Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Thu, 5 Jun 2025 17:28:35 +0300 Subject: [PATCH 101/106] Update light enum --- common.yml | 139 ++--------------------------------------------------- 1 file changed, 4 insertions(+), 135 deletions(-) diff --git a/common.yml b/common.yml index 2c4a6a2..ca8b493 100644 --- a/common.yml +++ b/common.yml @@ -209,157 +209,26 @@ components: type: integer Light: - title: "Light" type: integer - format: int64 description: "Image light index" enum: - 0 - - 1 - - 2 - - 4 - - 8388608 - 6 - - 8 - - 16 - - 16777216 - 24 - - 33554432 - 128 - - 67108864 - - 134217728 - - 268435456 - - 256 - - 1024 - - 2048 - - 512 - - 4096 - - 8192 - 3072 - - 2147483648 - - 2415919104 - - 2684354560 - - 2952790016 - - 3221225472 - - 32 - - 64 - - 65536 - - 16384 - - 262144 - - 131072 - - 32768 - - 16777216 - - 67108864 - - 64 - - 32 - - 524288 - - 1048576 - - 2097152 - - 4194304 - - 134 - - 67108870 - - 1073741824 - - 1073741830 - - 1073741952 - - 1073741848 x-enum-descriptions: - - "Lighting schemes are off" - - "OVI scheme" - - "Upper/lower lighters of white light scheme" - - "Side lighters of white light scheme" - - "General white light without separate control of side and upper/lower lighters scheme" - - "Upper/lower and side lighters of white light scheme" - - "Upper/lower lighters of IR light scheme" - - "Side lighters of IR light scheme" - - "General IR light without separate control of side and upper/lower lighters scheme" - - "Upper/lower and side lighters of IR light scheme" - - "general white image converted to grayscale" - - "General UV light scheme" - - "OVD light for hologram visualization" - - "Video detection light for internal use only" - - "Light IR 870 oblique" - - "IR luminescence" - - "Left lighter of white coaxial light scheme" - - "Right lighter of white coaxial light scheme" - - "Coaxial white light without separate control of left and right lighters scheme" - - "IR720" - - "IR940" + - "No Light" + - "White" + - "Infrared" + - "Ultraviolet" - "Right and left lighters of white coaxial light scheme" - - "For internal use" - - "For internal use" - - "For internal use" - - "For internal use" - - "For internal use" - - "Transmitted" - - "Transmitted IR" - - "Transmitted AntiStokes" - - "Transmitted IR940" - - "OVD right" - - "OVD left" - - "IR 700" - - "Front IR870 (mod. 8803)" - - "OVD light (hologram visualization) (mod. 8850)" - - "For internal use" - - "For internal use" - - "UVС 254 (mod. 88X0)" - - "UVB 313 (mod. 88X0)" - - "White oblique light" - - "For internal use" - - "White UV" - - "White full hologram" - - "HR light" - - "HR white" - - "HR UV" - - "HR IR" x-enum-varnames: - "OFF" - - "OVI" - - "WHITE_TOP" - - "WHITE_SIDE" - - "WHITE_FRONT" - "WHITE" - - "IR_TOP" - - "IR_SIDE" - - "IR_FRONT" - "IR" - - "WHITE_GRAY" - "UV" - - "OVD" - - "VIDEODETECTION" - - "IR_870_OBL" - - "IR_LUMINESCENCE" - - "AXIAL_WHITE_LEFT" - - "AXIAL_WHITE_RIGHT" - - "AXIAL_WHITE_FRONT" - - "IR_720" - - "IR_940" - "AXIAL_WHITE_FULL" - - "RAW_DATA" - - "RAW_DATA_GRBG" - - "RAW_DATA_GBGR" - - "RAW_DATA_RGGB" - - "RAW_DATA_BGGR" - - "TRANSMITTED" - - "TRANSMITTED_IR" - - "ANTI_STOKES" - - "TRANSMITTED_IR940" - - "OVD_RIGHT" - - "OVD_LEFT" - - "IR_700" - - "IR_870" - - "HOLO" - - "IR_BOTTOM" - - "WHITE_BOTTOM" - - "UVC" - - "UVB" - - "WHITE_OBL" - - "WHITE_SPECIAL" - - "WHITE_UV" - - "WHITE_FULL_HOLO" - - "HR_LIGHT" - - "HR_WHITE" - - "HR_UV" - - "HR_IR" Point: title: "Point" From aaad332877767fd3d297f75c72970aa3f35f17d3 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 6 Jun 2025 11:50:10 +0300 Subject: [PATCH 102/106] Update schemas --- authenticity/rt-ocr-security-text.yml | 6 +++--- p-process.yml | 8 ++------ rt-barcodes.yml | 2 +- rt.yml | 4 ++-- 4 files changed, 8 insertions(+), 12 deletions(-) diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index 39454d9..c821f53 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -22,11 +22,11 @@ components: FieldRect: $ref: "../common.yml#/components/schemas/RectangleCoordinates" EtalonResultType: - type: integer + $ref: "../rt.yml#/components/schemas/ContainerType" EtalonFieldType: - type: integer + $ref: "../e-text-field-type.yml#/components/schemas/TextFieldType" EtalonLightType: - type: integer + $ref: "../common.yml#/components/schemas/Light" EtalonFieldRect: $ref: "../common.yml#/components/schemas/RectangleCoordinates" SecurityTextResultOCR: diff --git a/p-process.yml b/p-process.yml index 19e2db1..f2e692f 100644 --- a/p-process.yml +++ b/p-process.yml @@ -184,11 +184,6 @@ components: description: "URLs to the document images for processing." items: type: string - lcidFilter: - type: array - description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default." - items: - $ref: "./e-lcid.yml#/components/schemas/LCID" ProcessParams: title: "ProcessParams" @@ -397,7 +392,8 @@ components: items: $ref: "./e-document-type.yml#/components/schemas/DocumentType" processAuth: # Authenticity checks that should be performed regardless of the document type. The available checks are listed in the eRPRM_Authenticity enum. Note that only supported by your license checks can be added. - $ref: "./authenticity/e-result-type.yml#/components/schemas/AuthenticityResultType" + type: integer + format: int64 deviceId: description: "This parameter is used to specify the document reader device type from which input images were captured. Default 0." type: integer diff --git a/rt-barcodes.yml b/rt-barcodes.yml index bd25561..739e637 100644 --- a/rt-barcodes.yml +++ b/rt-barcodes.yml @@ -56,7 +56,7 @@ components: bcTextDecoderTypes: type: integer bcTextFieldType: - type: integer + $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" bcType_DECODE: $ref: "./e-barcode-type.yml#/components/schemas/BarcodeType" bcType_DETECT: diff --git a/rt.yml b/rt.yml index c0ac520..7ab2509 100644 --- a/rt.yml +++ b/rt.yml @@ -73,8 +73,8 @@ components: - "Contains result of fingerprints comparison" - "Contains encrypted ResultContainerList" - "Contains license" - - "Contains result of DocumentPosition" - - "Contains result of DocumentPosition" + - "Contains result of MRZ position" + - "Contains result of barcode position" - "Contains information about document position on the input image, its center, angle, etc" - "Contains result of MRZDetectorResult" - "Contains result of FaceDetection" From 9ec28462f7218233661d1e0629ecb3bd1f703d0e Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 6 Jun 2025 13:28:11 +0300 Subject: [PATCH 103/106] Update schemas --- authenticity/rt-security-feature.yml | 2 -- e-rfid-error-codes.yml | 2 +- rt-ocr-lexical-analysis.yml | 2 -- 3 files changed, 1 insertion(+), 5 deletions(-) diff --git a/authenticity/rt-security-feature.yml b/authenticity/rt-security-feature.yml index 803490e..0693bf6 100644 --- a/authenticity/rt-security-feature.yml +++ b/authenticity/rt-security-feature.yml @@ -20,7 +20,5 @@ components: $ref: "./e-critical.yml#/components/schemas/Critical" AreaList: $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" - Result: - type: integer Reserved2: type: integer diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index c798668..d07a7aa 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -118,7 +118,7 @@ components: - 2248147719 - 2248147720 - 2248147721 - - 4294967295 + - -1 - 1 - 2 x-enum-descriptions: diff --git a/rt-ocr-lexical-analysis.yml b/rt-ocr-lexical-analysis.yml index 113eb18..0647b1f 100644 --- a/rt-ocr-lexical-analysis.yml +++ b/rt-ocr-lexical-analysis.yml @@ -53,8 +53,6 @@ components: type: string Matrix: $ref: "#/components/schemas/ComparisonMatrix" - FieldType: - type: integer example: {FieldType: 185, Field_MRZ: "37", Field_Visual: "37", Matrix: [1,0,0,0,0,3,0,0,0,0]} From bd717918a7edeeeb0816f40ef85867d596742c25 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Mon, 9 Jun 2025 18:01:15 +0300 Subject: [PATCH 104/106] Update schemas, enums --- authenticity/rt-fiber.yml | 2 -- authenticity/rt-ident.yml | 2 -- authenticity/rt-ocr-security-text.yml | 2 -- authenticity/rt-photo-ident.yml | 2 -- common.yml | 15 +++++++------- e-parsing-error-codes.yml | 24 ++++++++++++++++++++++ e-rfid-data-file-type.yml | 16 +++++++++++++++ e-rfid-data-group-type-tag.yml | 17 +++++++++++++++- e-rfid-error-codes.yml | 8 +++++++- p-process.yml | 3 ++- rt-rfid-binary-data.yml | 29 ++++++++++++++++++++++++++- 11 files changed, 101 insertions(+), 19 deletions(-) diff --git a/authenticity/rt-fiber.yml b/authenticity/rt-fiber.yml index aef9b6b..875c8ba 100644 --- a/authenticity/rt-fiber.yml +++ b/authenticity/rt-fiber.yml @@ -50,5 +50,3 @@ components: type: array items: type: integer - ErrorCode: - type: integer diff --git a/authenticity/rt-ident.yml b/authenticity/rt-ident.yml index b0a227a..61fb20d 100644 --- a/authenticity/rt-ident.yml +++ b/authenticity/rt-ident.yml @@ -24,5 +24,3 @@ components: $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer" ElementID: type: integer - Result: - type: integer diff --git a/authenticity/rt-ocr-security-text.yml b/authenticity/rt-ocr-security-text.yml index c821f53..493de67 100644 --- a/authenticity/rt-ocr-security-text.yml +++ b/authenticity/rt-ocr-security-text.yml @@ -33,8 +33,6 @@ components: type: string EtalonResultOCR: type: string - ResultCode: - type: integer Reserved1: type: integer Reserved2: diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index 7e2dc3c..a583302 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -28,8 +28,6 @@ components: type: integer Angle: type: integer - Result: - type: integer Reserved3: type: integer diff --git a/common.yml b/common.yml index ca8b493..f997bc6 100644 --- a/common.yml +++ b/common.yml @@ -213,22 +213,28 @@ components: description: "Image light index" enum: - 0 + - 2 + - 4 - 6 - 24 - 128 - 3072 x-enum-descriptions: - "No Light" + - "Upper/lower lighters of white light scheme" + - "Side lighters of white light scheme" - "White" - "Infrared" - "Ultraviolet" - - "Right and left lighters of white coaxial light scheme" + - "White coaxial" x-enum-varnames: - "OFF" + - "WHITE_TOP" + - "WHITE_SIDE" - "WHITE" - "IR" - "UV" - - "AXIAL_WHITE_FULL" + - "AXIAL_WHITE" Point: title: "Point" @@ -317,7 +323,6 @@ components: title: "VisualExtendedFieldItem" type: object required: - - FieldType - wFieldType - FieldName - StringsCount @@ -325,8 +330,6 @@ components: - Buf_Length - Buf_Text properties: - FieldType: - type: integer wFieldType: $ref: "./e-text-field-type.yml#/components/schemas/TextFieldType" FieldName: @@ -410,8 +413,6 @@ components: type: integer BaseLineTop: type: integer - Reserved: - type: integer SymbolCandidate: title: "SymbolCandidate" diff --git a/e-parsing-error-codes.yml b/e-parsing-error-codes.yml index e2e581e..fef8cd0 100644 --- a/e-parsing-error-codes.yml +++ b/e-parsing-error-codes.yml @@ -37,6 +37,14 @@ components: - 2147483685 - 2147483686 - 2147483687 + - 2147483712 + - 2147483713 + - 2147483714 + - 2147483715 + - 2147483716 + - 2147483717 + - 2147483718 + - 2147483719 - 2147483696 - 2147483697 - 2147483698 @@ -164,6 +172,14 @@ components: - "ASN Signer info: Sign algorithms incorrect data" - "ASN Signer info: Signature incorrect data" - "ASN Signer info: Unsigned attributes incorrect data" + - "ASN DTC Signer info: Incorrect data" + - "ASN DTC Signer info: Certificate incorrect data" + - "ASN DTC Signer info: Digest algorithms incorrect data" + - "ASN DTC Signer info: Signed attributes incorrect data" + - "ASN DTC Signer info: Sign algorithms incorrect data" + - "ASN DTC Signer info: Signature incorrect data" + - "ASN DTC Security info: Incorrect data" + - "ASN DTC Content info: Incorrect data" - "ICAO LDS object: Unsupported digest algorithm" - "ICAO Signed data: Signer info empty" - "ICAO Signer info: Unsupported digest algorithm" @@ -291,6 +307,14 @@ components: - "errLDS_ASN_SignerInfo_SignAlg_IncorrectData" - "errLDS_ASN_SignerInfo_Signature_IncorrectData" - "errLDS_ASN_SignerInfo_UnsignedAttrs_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_Certificate_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_DigestAlg_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_SignedAttrs_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_SignAlg_IncorrectData" + - "errLDS_ASN_DTC_SignerInfo_Signature_IncorrectData" + - "errLDS_ASN_DTC_SecurityInfo_IncorrectData" + - "errLDS_ASN_DTC_ContentInfo_IncorrectData" - "errLDS_ICAO_LDSObject_UnsupportedDigestAlgorithm" - "errLDS_ICAO_SignedData_SignerInfos_Empty" - "errLDS_ICAO_SignerInfo_UnsupportedDigestAlgorithm" diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index 50c2c1b..a1580ed 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -82,22 +82,30 @@ components: - 301 - 302 - 400 + - 401 - 500 - 501 - 600 - 601 - 602 - 603 + - 604 - 700 - 701 - 702 - 703 + - 704 - 710 - 711 - 712 - 713 - 714 - 715 + - 800 + - 832 + - 900 + - 901 + - 902 - 1000 x-enum-varnames: - "UNSPECIFIED" @@ -175,20 +183,28 @@ components: - "MIFARE_VALIDITY" - "AUTHENTICITY_V2" - "ATR" + - "DIR" - "_E_SIGN_PK" - "_E_SIGN_SIGNED_DATA" - "CERTIFICATE" - "MASTER_LIST" - "DEFECT_LIST" + - "DEVIATION_LIST" - "BLACK_LIST" - "APP_DIRECTORY" - "SESSION" - "LOG_DATA" - "CHIP_PROPERTIES" + - "DTC_INFO" - "POST_CA_RESPONSE" - "POST_CA_PUBLIC_KEY" - "POST_CA_INFO" - "POST_CA_D_PARAMS" - "POST_CA_CHECK_PK" - "POST_CA_CHECK_SK" + - "SAM_DATA" + - "SAM_DATA_MAX" + - "VDS" + - "VDS_NC" + - "DS" - "USER_DEFINED" diff --git a/e-rfid-data-group-type-tag.yml b/e-rfid-data-group-type-tag.yml index acf8e2c..3af858d 100644 --- a/e-rfid-data-group-type-tag.yml +++ b/e-rfid-data-group-type-tag.yml @@ -27,6 +27,11 @@ components: - 111 - 112 - 119 + - 113 + - 114 + - 115 + - 116 + - 98 - 97 - 98 - 99 @@ -50,7 +55,7 @@ components: - 117 - 96 - 119 - - 119 + - 83 - 97 - 107 - 108 @@ -83,6 +88,11 @@ components: - "Data Group 15" - "Data Group 16" - "Security Object Document" + - "Data Group 17" + - "Data Group 18" + - "Data Group 22" + - "Data Group 23" + - "Data Group 24" - "eID, Data Group 1" - "eID, Data Group 2" - "eID, Data Group 3" @@ -139,6 +149,11 @@ components: - "DG15" - "DG16" - "SOD" + - "DG17" + - "DG18" + - "DG22" + - "DG23" + - "DG24" - "EID_DG1" - "EID_DG2" - "EID_DG3" diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index d07a7aa..e930f69 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -118,9 +118,11 @@ components: - 2248147719 - 2248147720 - 2248147721 - - -1 + - 4294967295 - 1 - 2 + - 2147549191 + - 2147510016 x-enum-descriptions: - "LAYER6: Reading beyond EOF / Unexpected EOF" - "LAYER6: PWD deactivated" @@ -236,6 +238,8 @@ components: - "RFID: Failed" - "RFID: No error" - "RFID: The requested operation is already performed" + - "RFID: Not enough data" + - "RFID: Layer 6 - Wrong data length" x-enum-varnames: - "RFID_ERROR_LAYER6_FILE_EOF1" - "RFID_ERROR_LAYER6_PWD_DEACTIVATED" @@ -351,3 +355,5 @@ components: - "RFID_ERROR_FAILED" - "RFID_ERROR_NO_ERROR" - "RFID_ERROR_ALREADY_DONE" + - "RFID_ERROR_NOT_ENOUGH_DATA" + - "RFID_LAYER6_WRONG_LENGTH" diff --git a/p-process.yml b/p-process.yml index f2e692f..32150f0 100644 --- a/p-process.yml +++ b/p-process.yml @@ -391,7 +391,8 @@ components: type: array items: $ref: "./e-document-type.yml#/components/schemas/DocumentType" - processAuth: # Authenticity checks that should be performed regardless of the document type. The available checks are listed in the eRPRM_Authenticity enum. Note that only supported by your license checks can be added. + processAuth: + description: "Authenticity checks that should be performed regardless of the document type. The available checks are listed in the eRPRM_Authenticity enum. Note that only supported by your license checks can be added." type: integer format: int64 deviceId: diff --git a/rt-rfid-binary-data.yml b/rt-rfid-binary-data.yml index 9467885..65a2222 100644 --- a/rt-rfid-binary-data.yml +++ b/rt-rfid-binary-data.yml @@ -752,7 +752,7 @@ components: Data: type: string Length: - type: string + type: integer ParsedData: title: "ParsedData" @@ -830,6 +830,7 @@ components: - 5 - 6 - 10 + - 11 x-enum-descriptions: - "Type is not defined" - "BAC/BAP" @@ -839,6 +840,7 @@ components: - "AA" - "RI" - "Card info" + - "DTC info" x-enum-varnames: - "UNDEFINED" - "BAC" @@ -848,6 +850,7 @@ components: - "AA" - "RI" - "CARD_INFO" + - "DTC_INFO" RfidCardPropertiesExt: title: "RfidCardPropertiesExt" @@ -965,18 +968,27 @@ components: - 2 - 4 - 8 + - 16 + - 32 + - 64 x-enum-descriptions: - "Unknown" - "106 bits/s" - "212 bits/s" - "424 bits/s" - "848 bits/s" + - "1695 bits/s" + - "3390 bits/s" + - "6780 bits/s" x-enum-varnames: - "UNKNOWN" - "RFBR_106" - "RFBR_212" - "RFBR_424" - "RFBR_848" + - "RFBR_1695" + - "RFBR_3390" + - "RFBR_6780" RfidAccessKey: title: "RfidAccessKey" @@ -1013,6 +1025,7 @@ components: - 4 - 5 - 6 + - 7 x-enum-descriptions: - "Unknown type" - "MRZ" @@ -1021,6 +1034,7 @@ components: - "PUK" - "eSign-PIN" - "Scanning Area Identifier (for eDL application)" + - "MRZ hash" x-enum-varnames: - "UNKNOWN" - "MRZ" @@ -1029,6 +1043,7 @@ components: - "PUK" - "PIN_E_SIGN" - "SAI" + - "MRZ_HASH" RfidTerminal: title: "RfidTerminal" @@ -1146,6 +1161,10 @@ components: - 5 - 6 - 7 + - 8 + - 9 + - 10 + - 11 x-enum-descriptions: - "Type is not defined" - "CSCA" @@ -1155,6 +1174,10 @@ components: - "Deviaton List signer" - "Defect List signer" - "Black List signer" + - "LDS 2" + - "Barcode signer (VDS)" + - "Barcode signer (VDS for non-constrained environment)" + - "DTC signer" x-enum-varnames: - "UNDEFINED" - "CSCA" @@ -1164,6 +1187,10 @@ components: - "DEV_LS" - "DEF_LS" - "BLS" + - "LDS2" + - "BCS" + - "BCS_NC" + - "DTCS" RfidRawData: title: "RfidRawData" From bdc978619fd1e7ffe0e1515b9d25f1760f0eae48 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Tue, 10 Jun 2025 16:22:40 +0300 Subject: [PATCH 105/106] Update enums --- e-parsing-notification-codes.yml | 433 +++++++++++++++++++++---- e-rfid-error-codes.yml | 528 +++++++++++++++---------------- 2 files changed, 629 insertions(+), 332 deletions(-) diff --git a/e-parsing-notification-codes.yml b/e-parsing-notification-codes.yml index 2c6a365..f539439 100644 --- a/e-parsing-notification-codes.yml +++ b/e-parsing-notification-codes.yml @@ -96,6 +96,11 @@ components: - 2415919693 - 2415919694 - 2415919695 + - 2415919696 + - 2415919697 + - 2415919698 + - 2415919699 + - 2415919700 - 2415919136 - 2415919137 - 2415919138 @@ -161,6 +166,7 @@ components: - 139286 - 139287 - 139288 + - 139289 - 2415984640 - 2416050176 - 2416115712 @@ -172,6 +178,7 @@ components: - 2416508928 - 2416574464 - 2416640000 + - 2416705536 - 2416967680 - 2417033216 - 2417098752 @@ -183,6 +190,104 @@ components: - 2417491968 - 2417557504 - 2417623040 + - 2449539072 + - 2449604608 + - 2449670144 + - 2449735680 + - 2449801232 + - 2449801248 + - 2449801264 + - 2449801265 + - 2449801266 + - 2449801280 + - 2449801281 + - 2449801282 + - 2449801283 + - 2449801284 + - 2449801285 + - 2449801286 + - 2449801287 + - 2449801288 + - 2449801289 + - 2449801290 + - 2449801291 + - 2449801292 + - 2449801293 + - 2449801294 + - 2449801295 + - 2449801296 + - 2449801297 + - 2449801298 + - 2449801312 + - 2449801313 + - 2449801314 + - 2449801315 + - 2449801316 + - 2449801328 + - 2449801329 + - 2449801330 + - 2449801331 + - 2449801344 + - 2449801345 + - 2449801346 + - 2449801347 + - 2449801348 + - 2449801349 + - 2449801350 + - 2449801351 + - 2449801360 + - 2449801361 + - 2449801362 + - 2449801363 + - 2449801364 + - 2449801365 + - 2449801366 + - 2449801367 + - 2449801368 + - 2449801369 + - 2449801370 + - 2449801371 + - 2449801372 + - 2449801373 + - 2449801374 + - 2449801375 + - 2449801376 + - 2449801377 + - 2449801378 + - 2449801379 + - 2449801380 + - 2449801381 + - 2449801382 + - 2449801392 + - 2449801408 + - 2449801424 + - 2449801425 + - 2449801426 + - 2449801427 + - 2449801440 + - 2449801441 + - 2449801442 + - 2449801443 + - 2449801444 + - 2449801445 + - 2449801446 + - 2449801447 + - 2449801448 + - 2449801449 + - 2449801450 + - 2449801451 + - 2449801452 + - 2449801453 + - 2449801454 + - 2449801456 + - 2449801457 + - 2449801458 + - 2449801459 + - 2449801460 + - 2449801461 + - 2449801462 + - 2449801463 + - 2415919872 - 2432696320 - 2432696321 - 2432696322 @@ -225,12 +330,6 @@ components: - 2449473815 - 2449473816 - 2449473817 - - 2415919696 - - 2415919697 - - 139289 - - 2415919698 - - 2415919699 - - 2415919700 x-enum-descriptions: - "ASN certificate: Incorrect version" - "ASN certificate: Non-matching signature algorithm" @@ -240,7 +339,7 @@ components: - "ASN certificate: Empty subject" - "ASN certificate: Unsupported critical extension" - "ASN certificate: Forced default CSCA role" - - "ASN certificate: Forced Default DS role" + - "ASN certificate: Forced default DS role" - "ASN certificate: Incorrect issuer subject DS" - "ASN certificate: Duplicating extensions" - "ICAO certificate: Version missed" @@ -271,8 +370,8 @@ components: - "ICAO certificate extension: Ext key usage incorrect usage" - "ICAO certificate extension: Ext key usage incorrect data" - "ICAO certificate extension Auth key: ID missed" - - "ICAO certificate extension Auth key: Incorrect data" - - "ICAO certificate extension Auth key: Key ID missed" + - "ICAO certificate extension Auth key: ID incorrect data" + - "ICAO certificate extension Auth key: ID key ID missed" - "ICAO certificate extension: Subject key ID missed" - "ICAO certificate extension: Subject key ID incorrect data" - "ICAO certificate extension: Private key UP missed" @@ -299,7 +398,7 @@ components: - "ICAO certificate extension Doc type list: Version" - "ICAO certificate extension Doc type list: Doc types" - "ICAO certificate extension Doc type list: Doc types empty" - - "ICAO certificate extension: Dert policies incorrect data" + - "ICAO certificate extension: Cert policies incorrect data" - "ICAO certificate extension: Cert policies empty" - "ICAO certificate extension: Cert policies policy ID missed" - "ICAO certificate extension: CRL dist point missed" @@ -316,11 +415,16 @@ components: - "ICAO certificate extension: Name change incorrect data" - "ICAO certificate extension: Name change non-compliant" - "ICAO certificate extension: Name change critical" - - "ICAO certificate extension Doc type list: non-compliant" + - "ICAO certificate extension Doc type list: Non-compliant" - "ICAO certificate extension Doc type list: Critical" - "ICAO certificate extension: Optional critical" - "ICAO certificate: Subject non-compliant" - "ICAO certificate: Subject common name non-compliant" + - "ICAO certificate: Chain country non-matching" + - "ICAO certificate: Visual MRZ country non-matching" + - "ICAO certificate: MRZ country non-matching" + - "ICAO certificate: Issuer country non-uppercase" + - "ICAO certificate: Subject country non-uppercase" - "ICAO COM: LDS version incorrect" - "ICAO COM: LDS version missing" - "ICAO COM: Unicode version incorrect" @@ -348,8 +452,8 @@ components: - "ICAO LDS object: DG hash extra" - "ICAO LDS object: Version incorrect" - "ICAO master list: Version incorrect" - - "ICAO Deviation list: Version incorrect" - - "BSI: Defect list version incorrect" + - "ICAO deviation list: Version incorrect" + - "BSI: Defect list version incorrect" - "BSI: Black list version incorrect" - "ASN signer info: Version incorrect" - "ASN signer info: SID incorrect choice" @@ -386,6 +490,7 @@ components: - "MRZ: Optional data incorrect checksum" - "MRZ: Incorrect checksum" - "MRZ: Incorrect" + - "MRZ: Country code visual MRZ non-matching" - "Biometrics: Format owner missing" - "Biometrics: Format owner incorrect" - "Biometrics: Format type missing" @@ -397,65 +502,158 @@ components: - "Biometrics: BDB format ID incorrect" - "Biometrics: BDB version incorrect" - "Biometrics: BDB data length incorrect" - - "Biometrics: BDB Data Gender" - - "Biometrics: BDB Data Eye Color" - - "Biometrics: BDB Data Hair Color" - - "Biometrics: BDB Data Pose Angle Yaw" - - "Biometrics: BDB Data Pose Angle Pitch" - - "Biometrics: BDB Data Pose Angle Roll" - - "Biometrics: BDB Data Pose Angle U Yaw" - - "Biometrics: BDB Data Pose Angle U Pitch" - - "Biometrics: BDB Data Pose Angle U Roll" - - "Biometrics: BDB Data Face Image Type" - - "Biometrics: BDB Data Image Data Type" - - "SI: PACE Info Unsupported Std Parameters" - - "SI: PACE Info Deprecated Version" - - "SI: PACE Domain Params Using Std Ref" - - "SI: PACE Domain Params Unsupported Algorithm" - - "SI: CA Info Incorrect Version" - - "SI: CA PublicKey Unsupported Algorithm" - - "SI: CA Domain Params Unsupported Algorithm" - - "SI: TA Info Incorrect Version" - - "SI: TA Info File ID For Version 2" - - "SI: eID Security Unsupported Digest Algorithm" + - "Biometrics: BDB data incorrect" + - "Biometrics: BDB data gender" + - "Biometrics: BDB data eye color" + - "Biometrics: BDB data hair color" + - "Biometrics: BDB data pose angle yaw" + - "Biometrics: BDB data pose angle pitch" + - "Biometrics: BDB data pose angle roll" + - "Biometrics: BDB data pose angle U yaw" + - "Biometrics: BDB data pose angle U pitch" + - "Biometrics: BDB data pose angle U roll" + - "Biometrics: BDB data face image type" + - "Biometrics: BDB data image data type" + - "Biometrics: RB data incorrect" + - "Biometrics: RB item incorrect" + - "Biometrics: RB item missing" + - "Biometrics: RB item unexpected" + - "Biometrics: RB RID incorrect" + - "Biometrics: RB image R incorrect" + - "Biometrics: RB image item incorrect" + - "Biometrics: RB image item missing" + - "Biometrics: RB image item unexpected" + - "Biometrics: RB image info item incorrect" + - "Biometrics: RB image info item missing" + - "Biometrics: RB image info item unexpected" + - "Biometrics: RB image info format incorrect" + - "Biometrics: RB image info format unsupported" + - "Biometrics: RB image info kind incorrect" + - "Biometrics: RB image info kind unsupported" + - "Biometrics: RB image info post APB incorrect" + - "Biometrics: RB image info lossy TA incorrect" + - "Biometrics: RB image info lossy TA unsupported" + - "Biometrics: RB image info cam 2 subj unsupported" + - "Biometrics: RB image info sens diag unsupported" + - "Biometrics: RB image info lens F unsupported" + - "Biometrics: RB image info im size incorrect" + - "Biometrics: RB image info im size unsupported" + - "Biometrics: RB image info im meas incorrect" + - "Biometrics: RB image info color incorrect" + - "Biometrics: RB image info color unsupported" + - "Biometrics: RB image info color map incorrect" + - "Biometrics: RB image capt item incorrect" + - "Biometrics: RB image capt item unexpected" + - "Biometrics: RB image capt spectral unsupported" + - "Biometrics: RB image capt tech code incorrect" + - "Biometrics: RB image capt tech code unsupported" + - "Biometrics: RB date item incorrect" + - "Biometrics: RB date item missing" + - "Biometrics: RB date item unexpected" + - "Biometrics: RB date incorrect" + - "Biometrics: RB quality item incorrect" + - "Biometrics: RB quality item missing" + - "Biometrics: RB quality item unexpected" + - "Biometrics: RB quality alg ID item incorrect" + - "Biometrics: RB quality SoE item incorrect" + - "Biometrics: RB quality score item incorrect" + - "Biometrics: RB quality error item incorrect" + - "Biometrics: RB quality error item unsupported" + - "Biometrics: RB PAD item incorrect" + - "Biometrics: RB PAD item unexpected" + - "Biometrics: RB PAD decision item incorrect" + - "Biometrics: RB PAD decision item unsupported" + - "Biometrics: RB PAD score item incorrect" + - "Biometrics: RB PAD score reg ID item incorrect" + - "Biometrics: RB PAD SoE item incorrect" + - "Biometrics: RB PAD SoE score item incorrect" + - "Biometrics: RB PAD SoE error item incorrect" + - "Biometrics: RB PAD SoE error item unsupported" + - "Biometrics: RB PAD external data item incorrect" + - "Biometrics: RB PAD external data type item incorrect" + - "Biometrics: RB PAD context item incorrect" + - "Biometrics: RB PAD context item unsupported" + - "Biometrics: RB PAD S level item incorrect" + - "Biometrics: RB PAD S level item unsupported" + - "Biometrics: RB PAD risk level item incorrect" + - "Biometrics: RB PAD criteria item incorrect" + - "Biometrics: RB PAD criteria item unsupported" + - "Biometrics: RB PAD date item incorrect" + - "Biometrics: RB PAD date item missing" + - "Biometrics: RB PAD date item unexpected" + - "Biometrics: RB PAD date incorrect" + - "Biometrics: RB session ID incorrect" + - "Biometrics: RB derived incorrect" + - "Biometrics: RB device incorrect" + - "Biometrics: RB device item unexpected" + - "Biometrics: RB device model ID item incorrect" + - "Biometrics: RB device cert ID item incorrect" + - "Biometrics: RB metadata item incorrect" + - "Biometrics: RB metadata item unexpected" + - "Biometrics: RB metadata gender item incorrect" + - "Biometrics: RB metadata gender item unsupported" + - "Biometrics: RB metadata eye item incorrect" + - "Biometrics: RB metadata eye item unsupported" + - "Biometrics: RB metadata hair item incorrect" + - "Biometrics: RB metadata hair item unsupported" + - "Biometrics: RB metadata height item incorrect" + - "Biometrics: RB metadata props item incorrect" + - "Biometrics: RB metadata props item unexpected" + - "Biometrics: RB metadata express item incorrect" + - "Biometrics: RB metadata express item unexpected" + - "Biometrics: RB metadata pose item incorrect" + - "Biometrics: RB metadata pose item unexpected" + - "Biometrics: RB landmark item incorrect" + - "Biometrics: RB landmark item missing" + - "Biometrics: RB landmark item unexpected" + - "Biometrics: RB landmark kind item incorrect" + - "Biometrics: RB landmark mpeg4 item incorrect" + - "Biometrics: RB landmark mpeg4 item unsupported" + - "Biometrics: RB landmark antr L item incorrect" + - "Biometrics: RB landmark coordinate item incorrect" + - "DTC content info: Version incorrect" + - "SI: PACE info unsupported std parameters" + - "SI: PACE info deprecated version" + - "SI: PACE domain params using std ref" + - "SI: PACE domain params unsupported algorithm" + - "SI: CA info incorrect version" + - "SI: CA public key unsupported algorithm" + - "SI: CA domain params unsupported algorithm" + - "SI: TA info incorrect version" + - "SI: TA info file ID for version 2" + - "SI: eID security unsupported digest algorithm" - "SI: RI info incorrect version" - "SI: RI domain params unsupported algorithm" - "SI: AA info incorrect version" - "SI: AA info unsupported algorithm" - "SI: AA info inconsistent algorithm reference" - - "SI: PACE Info Not Available" - - "SI: PACE Info No Std Parameters" - - "SI: PACE Info No Matching Domain Params" - - "SI: CA Info Not Available" - - "SI: CA Domain Params No Required Option" - - "SI: CA Domain Params Not Available" - - "SI: CA Anonymous Infos" - - "SI: CA Info No Matching Domain Params" - - "SI: CA Info No Matching Public Key" - - "SI: CA Incorrect Infos Quantity" - - "SI: TA Info Not Available" - - "SI: Card Info Locator Multiple Entries" - - "SI: eID Security Info Multiple Entries" - - "SI: Privileged TI Multiple Entries" - - "SI: Privileged TI Incorrect Usage" - - "SI: RI domain params multiple entries" - - "SI: Storage PACE Info Non Consistant" - - "CV Certificate: Profile incorrect version" - - "CV Certificate: Validity" - - "CV Certificate: Non CVCA domain parameters" - - "CV Certificate: Private key incorrect version" + - "SI: storage PACE info not available" + - "SI: storage PACE info no std parameters" + - "SI: storage PACE info no matching domain params" + - "SI: storage CA info not available" + - "SI: storage CA domain params no required option" + - "SI: storage CA domain params not available" + - "SI: storage CA anonymous infos" + - "SI: storage CA info no matching domain params" + - "SI: storage CA info no matching public key" + - "SI: storage CA incorrect infos quantity" + - "SI: storage TA info not available" + - "SI: storage card info locator multiple entries" + - "SI: storage eID security info multiple entries" + - "SI: storage privileged TI multiple entries" + - "SI: storage privileged TI incorrect usage" + - "SI: storage RI domain params multiple entries" + - "SI: storage PACE infos non consistent" + - "CV certificate: Profile incorrect version" + - "CV certificate: Validity" + - "CV certificate: non CVCA domain parameters" + - "CV certificate: private key incorrect version" - "TA: PACE static binding used" - "Auth ML signer info: Certificate validity" - "Auth ML signer info: Certificate root is not trusted" - - "Auth ML signer info: Certificate cannot find CSCA" + - "Auth ML signer info: Certificate can't find CSCA" - "Auth ML signer info: Certificate revoked" - "Auth ML signer info: Certificate signature invalid" - - "Country Codes from certificate chain don't match" - - "Country Codes from certificate and visual MRZ don't match" - - "Incorrect MRZ, country code doesn't match codes from Visual MRZ" - - "Country Codes from certificate and DG1 MRZ don't match" - - "ICAO certificate: Issuer country non upper case" - - "ICAO certificate: Subject country non upper case" x-enum-varnames: - "ntfLDS_ASN_Certificate_IncorrectVersion" - "ntfLDS_ASN_Certificate_NonMatchingSignatureAlgorithm" @@ -546,6 +744,11 @@ components: - "ntfLDS_ICAO_Certificate_Ext_Optional_Critical" - "ntfLDS_ICAO_Certificate_Subject_NonCompliant" - "ntfLDS_ICAO_Certificate_Subject_CommonNameNonCompliant" + - "ntfLDS_ICAO_Certificate_Chain_Country_NonMatching" + - "ntfLDS_ICAO_Certificate_VisualMrz_Country_NonMatching" + - "ntfLDS_ICAO_Certificate_MRZ_Country_NonMatching" + - "ntfLDS_ICAO_Certificate_Issuer_CountryNonUpperCase" + - "ntfLDS_ICAO_Certificate_Subject_CountryNonUpperCase" - "ntfLDS_ICAO_COM_LDS_Version_Incorrect" - "ntfLDS_ICAO_COM_LDS_Version_Missing" - "ntfLDS_ICAO_COM_Unicode_Version_Incorrect" @@ -611,6 +814,7 @@ components: - "ntfLDS_MRZ_OptionalData_IncorrectChecksum" - "ntfLDS_MRZ_IncorrectChecksum" - "ntfLDS_MRZ_Incorrect" + - "ntfLDS_MRZ_CountryCode_VisualMrz_NonMatching" - "ntfLDS_Biometrics_FormatOwner_Missing" - "ntfLDS_Biometrics_FormatOwner_Incorrect" - "ntfLDS_Biometrics_FormatType_Missing" @@ -622,6 +826,7 @@ components: - "ntfLDS_Biometrics_BDB_FormatID_Incorrect" - "ntfLDS_Biometrics_BDB_Version_Incorrect" - "ntfLDS_Biometrics_BDB_DataLength_Incorrect" + - "ntfLDS_Biometrics_BDB_Data_Incorrect" - "ntfLDS_Biometrics_BDB_Data_Gender" - "ntfLDS_Biometrics_BDB_Data_EyeColor" - "ntfLDS_Biometrics_BDB_Data_HairColor" @@ -633,6 +838,104 @@ components: - "ntfLDS_Biometrics_BDB_Data_PoseAngleU_Roll" - "ntfLDS_Biometrics_BDB_Data_FaceImageType" - "ntfLDS_Biometrics_BDB_Data_ImageDataType" + - "ntfLDS_Biometrics_RB_Data_Incorrect" + - "ntfLDS_Biometrics_RB_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Item_Missing" + - "ntfLDS_Biometrics_RB_Item_Unexpected" + - "ntfLDS_Biometrics_RB_RID_Incorrect" + - "ntfLDS_Biometrics_RB_ImageR_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Item_Missing" + - "ntfLDS_Biometrics_RB_Image_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Image_Info_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Item_Missing" + - "ntfLDS_Biometrics_RB_Image_Info_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Image_Info_Format_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Format_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_Kind_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Kind_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_PostAPB_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_LossyTA_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_LossyTA_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_Cam2Subj_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_SensDiag_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_LensF_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_ImSize_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_ImSize_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_ImMeas_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Color_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Info_Color_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Info_ColorMap_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Capt_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Capt_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Image_Capt_Spectral_Unsupported" + - "ntfLDS_Biometrics_RB_Image_Capt_TechCode_Incorrect" + - "ntfLDS_Biometrics_RB_Image_Capt_TechCode_Unsupported" + - "ntfLDS_Biometrics_RB_Date_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Date_Item_Missing" + - "ntfLDS_Biometrics_RB_Date_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Date_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Item_Missing" + - "ntfLDS_Biometrics_RB_Quality_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Quality_AlgID_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_SoE_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Score_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Error_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Quality_Error_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Item_Unexpected" + - "ntfLDS_Biometrics_RB_PAD_Decision_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Decision_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_Score_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Score_RegID_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SoE_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SoE_Score_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SoE_Error_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SoE_Error_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_ExtData_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_ExtData_Type_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Context_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Context_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_SLevel_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_SLevel_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_RiskLevel_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Criteria_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Criteria_Item_Unsupported" + - "ntfLDS_Biometrics_RB_PAD_Date_Item_Incorrect" + - "ntfLDS_Biometrics_RB_PAD_Date_Item_Missing" + - "ntfLDS_Biometrics_RB_PAD_Date_Item_Unexpected" + - "ntfLDS_Biometrics_RB_PAD_Date_Incorrect" + - "ntfLDS_Biometrics_RB_SessionID_Incorrect" + - "ntfLDS_Biometrics_RB_Derived_Incorrect" + - "ntfLDS_Biometrics_RB_Device_Incorrect" + - "ntfLDS_Biometrics_RB_Device_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Device_ModelID_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Device_CertID_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Metadata_Gender_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Gender_Item_Unsupported" + - "ntfLDS_Biometrics_RB_Metadata_Eye_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Eye_Item_Unsupported" + - "ntfLDS_Biometrics_RB_Metadata_Hair_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Hair_Item_Unsupported" + - "ntfLDS_Biometrics_RB_Metadata_Height_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Props_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Props_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Metadata_Express_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Express_Item_Unexpected" + - "ntfLDS_Biometrics_RB_Metadata_Pose_Item_Incorrect" + - "ntfLDS_Biometrics_RB_Metadata_Pose_Item_Unexpected" + - "ntfLDS_Biometrics_RB_LandMark_Item_Incorrect" + - "ntfLDS_Biometrics_RB_LandMark_Item_Missing" + - "ntfLDS_Biometrics_RB_LandMark_Item_Unexpected" + - "ntfLDS_Biometrics_RB_LandMark_Kind_Item_Incorrect" + - "ntfLDS_Biometrics_RB_LandMark_Mpeg4_Item_Incorrect" + - "ntfLDS_Biometrics_RB_LandMark_Mpeg4_Item_Unsupported" + - "ntfLDS_Biometrics_RB_LandMark_AntrL_Item_Incorrect" + - "ntfLDS_Biometrics_RB_LandMark_Coord_Item_Incorrect" + - "ntfLDS_DTC_ContentInfo_Version_Incorrect" - "ntfLDS_SI_PACE_Info_UnsupportedStdParameters" - "ntfLDS_SI_PACE_Info_DeprecatedVersion" - "ntfLDS_SI_PACE_DomainParams_UsingStdRef" @@ -675,9 +978,3 @@ components: - "ntfLDS_Auth_MLSignerInfo_Certificate_CantFindCSCA" - "ntfLDS_Auth_MLSignerInfo_Certificate_Revoked" - "ntfLDS_Auth_MLSignerInfo_Certificate_SignatureInvalid" - - "ntfLDS_ICAO_Certificate_Chain_Country_NonMatching" - - "ntfLDS_ICAO_Certificate_VisualMrz_Country_NonMatching" - - "ntfLDS_MRZ_CountryCode_VisualMrz_NonMatching" - - "ntfLDS_ICAO_Certificate_MRZ_Country_NonMatching" - - "ntfLDS_ICAO_Certificate_Issuer_CountryNonUpperCase" - - "ntfLDS_ICAO_Certificate_Subject_CountryNonUpperCase" diff --git a/e-rfid-error-codes.yml b/e-rfid-error-codes.yml index e930f69..e0ec272 100644 --- a/e-rfid-error-codes.yml +++ b/e-rfid-error-codes.yml @@ -7,22 +7,15 @@ components: format: int64 description: "Enumeration contains a set of error codes returned by SDK" enum: - - 2147508866 - - 2147508867 - - 2147509184 - - 2147509185 - - 2147510659 - - 2147510660 - - 2147510661 - - 2147510912 - - 2147510914 - - 2147510920 - - 2147511040 + - 1 + - 2 + - 4294967295 - 2147549185 - 2147549186 - 2147549188 - 2147549189 - 2147549190 + - 2147549191 - 2147549192 - 2147549193 - 2147549194 @@ -36,6 +29,39 @@ components: - 2147614725 - 2147614726 - 2147614736 + - 2248146944 + - 2248146945 + - 2248147200 + - 2248147201 + - 2248147202 + - 2248147203 + - 2248147456 + - 2248147457 + - 2248147458 + - 2248147459 + - 2248147460 + - 2248147712 + - 2248147713 + - 2248147714 + - 2248147715 + - 2248147716 + - 2248147717 + - 2248147718 + - 2248147719 + - 2248147720 + - 2248147721 + - 2147510914 + - 2147508866 + - 2147511040 + - 2147510016 + - 2147510912 + - 2147510920 + - 2147509185 + - 2147509184 + - 2147508867 + - 2147510659 + - 2147510660 + - 2147510661 - 2148557760 - 2197815296 - 2197815297 @@ -97,263 +123,237 @@ components: - 2215444480 - 2215510016 - 2215575552 - - 2248146944 - - 2248146945 - - 2248147200 - - 2248147201 - - 2248147202 - - 2248147203 - - 2248147456 - - 2248147457 - - 2248147458 - - 2248147459 - - 2248147460 - - 2248147712 - - 2248147713 - - 2248147714 - - 2248147715 - - 2248147716 - - 2248147717 - - 2248147718 - - 2248147719 - - 2248147720 - - 2248147721 - - 4294967295 - - 1 - - 2 - - 2147549191 - - 2147510016 x-enum-descriptions: - - "LAYER6: Reading beyond EOF / Unexpected EOF" - - "LAYER6: PWD deactivated" - - "LAYER6: PWD blocked" - - "LAYER6: PWD suspended" - - "LAYER6: PWD blocked 2" - - "LAYER6: PWD deactivated 2" - - "LAYER6: PWD suspended 2" - - "LAYER6: Incorrect params" - - "LAYER6: File selection failure / file not found" - - "LAYER6: No reference data" - - "LAYER6: Reading beyond EOF / Unexpected EOF" - - "RFID: No chip is detected" - - "RFID: Unavailable" - - "RFID: Invalid parameter in ExecuteCommand() call found" - - "RFID: Device is uninitialized" - - "RFID: Out of memory" + - "RFID: No error" + - "RFID: Already done" + - "RFID: Failed" + - "RFID: No chip detected" + - "RFID: Not available" + - "RFID: Invalid parameter" + - "RFID: Not initialized" + - "RFID: Not enough memory" + - "RFID: Not enough data" - "RFID: Invalid directory" - "RFID: Unknown command" - - "RFID File: IO Error" - - "RFID: RFID is busy" - - "RFID: The firmware needs to be updated to a newer version" + - "RFID: File IO error" + - "RFID: Busy" + - "RFID: Old firmware" - "PCSC: Failed" - - "PCSC: The reader is unavailable" - - "PCSC: The card cannot be connected" - - "PCSC: The card is not connected" - - "PCSC: Operation is cancelled" - - "PCSC: The card is busy" - - "PCSC: Failed Smart Card" - - "PCSC: ExtLe Failed" - - "LAYER6: PWD failed" - - "RFID: Not performed" + - "PCSC: Reader not available" + - "PCSC: Can't connect card" + - "PCSC: Card is not connected" + - "PCSC: Operation cancelled" + - "PCSC: Card is busy" + - "PCSC: Failed smart card" + - "PCSC: ExtLe failed" + - "Layer 6: Security manager" + - "Layer 6: App selection failure" + - "Layer 6: Mutual auth MAC fail" + - "Layer 6: Mutual auth ENC fail" + - "Layer 6: Mutual auth failure" + - "Layer 6: Mutual auth failure data" + - "Layer 6: SM DO8E missing" + - "Layer 6: SM DO87 missing" + - "Layer 6: SM DO99 missing" + - "Layer 6: SM MAC incorrect" + - "Layer 6: SM DO87 incorrect" + - "Layer 6: NON TLV response data" + - "Layer 6: Wrong RND ICC length" + - "Layer 6: Int auth failure" + - "Layer 6: MSE set KAT failure" + - "Layer 6: MSE set DST failure" + - "Layer 6: PSO certificate failure" + - "Layer 6: MSE set at failure" + - "Layer 6: Get challenge failure" + - "Layer 6: EXT auth failure" + - "Layer 6: GENERAL auth failure" + - "Layer 6: File not found" + - "Layer 6: File EOF1" + - "Layer 6: File EOF2" + - "Layer 6: Wrong length" + - "Layer 6: Incorrect params" + - "Layer 6: No reference data" + - "Layer 6: PWD suspended" + - "Layer 6: PWD blocked" + - "Layer 6: PWD deactivated" + - "Layer 6: PWD blocked 2" + - "Layer 6: PWD deactivated 2" + - "Layer 6: PWD suspended 2" + - "Layer 6: PWD failed" + - "RFID: NotPerformed" - "RFID: Session is closed" - - "RFID: Unsupported terminal operation" - - "RFID: Terminal type unknown" - - "RFID: Terminal type bad certificate" - - "RFID: Terminal type not set" - - "RFID: Unknown procedure type" - - "RFID: Unsupported procedure type" - - "RFID: Procedure type not set" - - "RFID: Access key unknown type" - - "RFID: Access key unsupported SM type" - - "RFID: Access key incorrect SM type" - - "RFID: Access key restricted" - - "RFID: Access key incorrect data" - - "RFID: Access key not set" - - "RFID: PWD management not authorized" - - "RFID: Access control unknown type" - - "RFID: SM required" - - "RFID: PACE required" - - "RFID: CA keys required" - - "RFID: TA required" - - "RFID: CA required" - - "RFID: Incorrect option CA" - - "RFID: CA failed" - - "RFID: TA failed" - - "RFID: AA failed" - - "RFID: RI failed" - - "RFID: SO signature check failed" - - "RFID: Hash check failed" - - "RFID: Invalid aux data - date of expiry" - - "RFID: Invalid aux data - date of birth" - - "RFID: Invalid aux data - community ID" - - "RFID: eSign requires app selection" - - "RFID: eSign PIN not set" - - "RFID: eSign PIN not verified" - - "RFID: Incorrect data" - - "RFID file: Insufficient data" - - "RFID file: Incorrect data" - - "RFID file: Unexpected data" - - "RFID file: Contains unexpected data" - - "RFID file: Wrong tag" - - "RFID file: Cannot use data" - - "RFID file: Cannot read data" - - "RFID file: Access denied" - - "RFID: Layer 34 - No error" - - "RFID: Layer 34 - Timeout" - - "RFID: Layer 34 - Collision" - - "RFID: Layer 34 - CRC" - - "RFID: Layer 34 - Data integrity" - - "RFID: Layer 34 - Data length" - - "RFID: Layer 34 - RFU" - - "RFID: Layer 34 - Too many collision" - - "RFID: Layer 34 - Protocol B" - - "RFID: Layer 34 - Data contents" - - "RFID: Layer 34 - Protocol" - - "RFID: Layer 34 - Globa timeout" - - "RFID: Layer 34 - MIFARE auth" - - "RFID: Layer 34 - SAM error" - - "RFID: Layer 34 - SAM collision" - - "RFID: Layer 34 - SAM acknowledge" - - "LAYER6: Secure Messaging was not activated" - - "LAYER6: ISO7816_A_03 Application selection failure" - - "LAYER6: ISO7816_B_01 Mutual authentication MAC failure" - - "LAYER6: ISO7816_B_02 Mutual authentication encryption failure" - - "LAYER6: ISO7816_B_03 Mutual authentication failure" - - "LAYER6: ISO7816_B_03 Mutual authentication failure data" - - "LAYER6: SM failure – MAC missing" - - "LAYER6: SM failure – cryptogram missing" - - "LAYER6: SM failure – secured status bytes missing" - - "LAYER6: SM failure – incorrect MAC" - - "LAYER6: SM failure – incorrect cryptogram" - - "LAYER6: Not TLV response data" - - "LAYER6: Wrong data length (APDU_INS_GET_CHALLENGE)" - - "LAYER6: APDU_INS_INTERNAL_AUTHENTICATE failure" - - "LAYER6: MSE:Set KAT failure" - - "LAYER6: MSE:Set DST failure" - - "LAYER6: PSO CERTIFICATE failure" - - "LAYER6: MSE:Set AT failure" - - "LAYER6: GET CHALLENGE failure" - - "LAYER6: APDU_INS_EXTERNAL_AUTHENTICATE (external authentication) failure" - - "LAYER6: General Authenticity Failure" - - "RFID: Failed" - - "RFID: No error" - - "RFID: The requested operation is already performed" - - "RFID: Not enough data" - - "RFID: Layer 6 - Wrong data length" + - "Session terminal: Unsupported operation" + - "Session terminal type: Unknown" + - "Session terminal type: Bad certificate" + - "Session terminal type: Not set" + - "Session procedure type: Unknown" + - "Session procedure type: Unsupported" + - "Session procedure type: Not set" + - "Session access key: Unknown type" + - "Session access key: Unsupported SM type" + - "Session access key: Incorrect SM type" + - "Session access key: Restricted" + - "Session access key: Incorrect data" + - "Session access key: Not set" + - "Session pwd management: Not authorized" + - "Session access control: Unknown type" + - "Session access control: Requires SM" + - "Session access control: Requires PACE" + - "Session access control: Requires CA keys" + - "Session access control: Requires TA" + - "Session access control: Requires CA" + - "Session access control: Incorrect option CA" + - "Session access control: CA Failed" + - "Session access control: TA Failed" + - "Session access control: AA Failed" + - "Session access control: RI Failed" + - "Session PA: Signature check failed" + - "Session PA: Hash check failed" + - "Session invalid aux data: Date of expiry" + - "Session invalid aux data: Date of birth" + - "Session invalid aux data: Community ID" + - "Session eSign: Requires app selection" + - "Session eSign: PIN not set" + - "Session eSign: PIN not verified" + - "Session: Incorrect data" + - "Session file: Not enough data" + - "Session file: Incorrect data" + - "Session file: Unexpected data" + - "Session file: Contents unexpected data" + - "Session file: Wrong tag" + - "Session file: Cant use data" + - "Session file: Cant read data" + - "Session file: Access denied" + - "Layer 34: No error" + - "Layer 34: Time out" + - "Layer 34: Collision" + - "Layer 34: CRC" + - "Layer 34: Data integrity" + - "Layer 34: Data length" + - "Layer 34: RFU" + - "Layer 34: Collision too many" + - "Layer 34: Protocol B" + - "Layer 34: Data contents" + - "Layer 34: Protocol" + - "Layer 34: Global timeOut" + - "Layer 34: MIFARE auth" + - "Layer 34: SAM error" + - "Layer 34: SAM collision" + - "Layer 34: SAM acknowledge" x-enum-varnames: - - "RFID_ERROR_LAYER6_FILE_EOF1" - - "RFID_ERROR_LAYER6_PWD_DEACTIVATED" - - "RFID_ERROR_LAYER6_PWD_BLOCKED" - - "RFID_ERROR_LAYER6_PWD_SUSPEND" - - "RFID_ERROR_LAYER6_PWD_BLOCKED2" - - "RFID_ERROR_LAYER6_PWD_DEACTIVATED2" - - "RFID_ERROR_LAYER6_PWD_SUSPEND2" - - "RFID_ERROR_LAYER6_INCORRECT_PARAMS" - - "RFID_ERROR_LAYER6_FILE_NOT_FOUND" - - "RFID_ERROR_LAYER6_NO_REFERENCE_DATA" - - "RFID_ERROR_LAYER6_FILE_EOF2" - - "RFID_ERROR_NO_CHIP_DETECTED" - - "RFID_ERROR_NOT_AVAILABLE" - - "RFID_ERROR_INVALID_PARAMETER" - - "RFID_ERROR_NOT_INITIALIZED" - - "RFID_ERROR_NOT_ENOUGH_MEMORY" - - "RFID_ERROR_INVALID_DIRECTORY" - - "RFID_ERROR_UNKNOWN_COMMAND" - - "RFID_ERROR_FILE_IO_ERROR" - - "RFID_ERROR_BUSY" - - "RFID_ERROR_OLD_FIRMWARE" - - "RFID_ERROR_PCSC_FAILED" - - "RFID_ERROR_PCSC_READER_NOT_AVAILABLE" - - "RFID_ERROR_PCSC_CANT_CONNECT_CARD" - - "RFID_ERROR_PCSC_CARD_IS_NOT_CONNECTED" - - "RFID_ERROR_PCSC_OPERATION_CANCELLED" - - "RFID_ERROR_PCSC_CARD_IS_BUSY" - - "RFID_ERROR_PCSC_FAILED_SCARD" - - "RFID_ERROR_PCSC_EXT_LE_FAILED" - - "RFID_ERROR_LAYER6_PWD_FAILED" - - "RFID_ERROR_NOT_PERFORMED" - - "RFID_ERROR_SESSION_IS_CLOSED" - - "RFID_ERROR_SESSION_TERMINAL_UNSUPPORTED_OPERATION" - - "RFID_ERROR_SESSION_TERMINAL_TYPE_UNKNOWN" - - "RFID_ERROR_SESSION_TERMINAL_TYPE_BAD_CERTIFICATE" - - "RFID_ERROR_SESSION_TERMINAL_TYPE_NOT_SET" - - "RFID_ERROR_SESSION_PROCEDURE_TYPE_UNKNOWN" - - "RFID_ERROR_Session_Procedure_Type_Unsupported" - - "RFID_ERROR_SESSION_PROCEDURE_TYPE_NOT_SET" - - "RFID_ERROR_SESSION_ACCESS_KEY_UNKNOWN_TYPE" - - "RFID_ERROR_SESSION_ACCESS_KEY_UNSUPPORTED_SM_TYPE" - - "RFID_ERROR_SESSION_ACCESS_KEY_INCORRECT_SM_TYPE" - - "RFID_ERROR_SESSION_ACCESS_KEY_RESTRICTED" - - "RFID_ERROR_SESSION_ACCESS_KEY_INCORRECT_DATA" - - "RFID_ERROR_SESSION_ACCESS_KEY_NOT_SET" - - "RFID_ERROR_SESSION_PWD_MANAGEMENT_NOT_AUTHORIZED" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_UNKNOWN_TYPE" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_SM" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_PACE" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_CA_KEYS" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_TA" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_REQUIRES_CA" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_INCORRECT_OPTION_CA" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_CA_FAILED" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_TA_FAILED" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_AA_FAILED" - - "RFID_ERROR_SESSION_ACCESS_CONTROL_RI_FAILED" - - "RFID_ERROR_SESSION_PA_SIGNATURE_CHECK_FAILED" - - "RFID_ERROR_SESSION_PA_HASH_CHECK_FAILED" - - "RFID_ERROR_SESSION_INVALID_AUX_DATA_DATE_OF_EXPIRY" - - "RFID_ERROR_SESSION_INVALID_AUX_DATA_DATE_OF_BIRTH" - - "RFID_ERROR_SESSION_INVALID_AUX_DATA_COMMUNITY_ID" - - "RFID_ERROR_SESSION_E_SIGN_REQUIRES_APP_SELECTION" - - "RFID_ERROR_SESSION_E_SIGN_PIN_NOT_SET" - - "RFID_ERROR_SESSION_E_SIGN_PIN_NOT_VERIFIED" - - "RFID_ERROR_SESSION_INCORRECT_DATA" - - "RFID_ERROR_SESSION_FILE_NOT_ENOUGH_DATA" - - "RFID_ERROR_SESSION_FILE_INCORRECT_DATA" - - "RFID_ERROR_SESSION_FILE_UNEXPECTED_DATA" - - "RFID_ERROR_SESSION_FILE_CONTENTS_UNEXPECTED_DATA" - - "RFID_ERROR_SESSION_FILE_WRONG_TAG" - - "RFID_ERROR_SESSION_FILE_CANT_USE_DATA" - - "RFID_ERROR_SESSION_FILE_CANT_READ_DATA" - - "RFID_ERROR_SESSION_FILE_ACCESS_DENIED" - - "RFID_ERROR_LAYER34_NO_ERROR" - - "RFID_ERROR_LAYER34_TIME_OUT" - - "RFID_ERROR_LAYER34_COLLISION" - - "RFID_ERROR_LAYER34_CRC" - - "RFID_ERROR_LAYER34_DATA_INTEGRITY" - - "RFID_ERROR_LAYER34_DATA_LENGTH" - - "RFID_ERROR_Layer34_RFU" - - "RFID_ERROR_LAYER34_COLLISION_TOO_MANY" - - "RFID_ERROR_LAYER34_PROTOCOL_B" - - "RFID_ERROR_LAYER34_DATA_CONTENTS" - - "RFID_ERROR_LAYER34_PROTOCOL" - - "RFID_ERROR_LAYER34_GLOBAL_TIME_OUT" - - "RFID_ERROR_LAYER34_MIFARE_AUTH" - - "RFID_ERROR_LAYER34_SAM_ERROR" - - "RFID_ERROR_LAYER34_SAM_COLLISION" - - "RFID_ERROR_LAYER34_SAM_ACKNOWLEDGE" - - "RFID_ERROR_LAYER6_SECURITY_MANAGER" - - "RFID_ERROR_LAYER6_APP_SELECTION_FAILURE" - - "RFID_ERROR_LAYER6_MUTUAL_AUTH_MAC_FAIL" - - "RFID_ERROR_LAYER6_MUTUAL_AUTH_ENC_FAIL" - - "RFID_ERROR_LAYER6_MUTUAL_AUTH_FAILURE" - - "RFID_ERROR_LAYER6_MUTUAL_AUTH_FAILURE_DATA" - - "RFID_ERROR_LAYER6_SM_DO_8E_MISSING" - - "RFID_ERROR_LAYER6_SM_DO_87_MISSING" - - "RFID_ERROR_LAYER6_SM_DO_99_MISSING" - - "RFID_ERROR_LAYER6_SM_MAC_INCORRECT" - - "RFID_ERROR_LAYER6_SM_DO_87_INCORRECT" - - "RFID_ERROR_LAYER6_NON_TLV_RESPONSE_DATA" - - "RFID_ERROR_LAYER6_WRONG_RND_ICC_LENGTH" - - "RFID_ERROR_LAYER6_INT_AUTH_FAILURE" - - "RFID_ERROR_LAYER6_MSE_SET_KAT_FAILURE" - - "RFID_ERROR_LAYER6_MSE_SET_DST_FAILURE" - - "RFID_ERROR_LAYER6_PSO_CERTIFICATE_FAILURE" - - "RFID_ERROR_LAYER6_MSE_SET_AT_FAILURE" - - "RFID_ERROR_LAYER6_GET_CHALLENGE_FAILURE" - - "RFID_ERROR_LAYER6_EXT_AUTH_FAILURE" - - "RFID_ERROR_LAYER6_GENERAL_AUTH_FAILURE" - - "RFID_ERROR_FAILED" - - "RFID_ERROR_NO_ERROR" - - "RFID_ERROR_ALREADY_DONE" - - "RFID_ERROR_NOT_ENOUGH_DATA" + - "RFID_Error_NoError" + - "RFID_Error_AlreadyDone" + - "RFID_Error_Failed" + - "RFID_Error_NoChipDetected" + - "RFID_Error_NotAvailable" + - "RFID_Error_InvalidParameter" + - "RFID_Error_NotInitialized" + - "RFID_Error_NotEnoughMemory" + - "RFID_Error_NotEnoughData" + - "RFID_Error_InvalidDirectory" + - "RFID_Error_UnknownCommand" + - "RFID_Error_FileIOError" + - "RFID_Error_Busy" + - "RFID_Error_OldFirmware" + - "RFID_Error_PCSC_Failed" + - "RFID_Error_PCSC_ReaderNotAvailable" + - "RFID_Error_PCSC_CantConnectCard" + - "RFID_Error_PCSC_CardIsNotConnected" + - "RFID_Error_PCSC_OperationCancelled" + - "RFID_Error_PCSC_CardIsBusy" + - "RFID_Error_PCSC_FailedSCard" + - "RFID_Error_PCSC_ExtLe_Failed" + - "RFID_LAYER6_SECURITY_MANAGER" + - "RFID_LAYER6_APP_SELECTION_FAILURE" + - "RFID_LAYER6_MUTUAL_AUTH_MAC_FAIL" + - "RFID_LAYER6_MUTUAL_AUTH_ENC_FAIL" + - "RFID_LAYER6_MUTUAL_AUTH_FAILURE" + - "RFID_LAYER6_MUTUAL_AUTH_FAILURE_DATA" + - "RFID_LAYER6_SM_DO8E_MISSING" + - "RFID_LAYER6_SM_DO87_MISSING" + - "RFID_LAYER6_SM_DO99_MISSING" + - "RFID_LAYER6_SM_MAC_INCORRECT" + - "RFID_LAYER6_SM_DO87_INCORRECT" + - "RFID_LAYER6_NON_TLV_RESPONSE_DATA" + - "RFID_LAYER6_WRONG_RND_ICC_LENGTH" + - "RFID_LAYER6_INT_AUTH_FAILURE" + - "RFID_LAYER6_MSE_SET_KAT_FAILURE" + - "RFID_LAYER6_MSE_SET_DST_FAILURE" + - "RFID_LAYER6_PSO_CERTIFICATE_FAILURE" + - "RFID_LAYER6_MSE_SET_AT_FAILURE" + - "RFID_LAYER6_GET_CHALLENGE_FAILURE" + - "RFID_LAYER6_EXT_AUTH_FAILURE" + - "RFID_LAYER6_GENERAL_AUTH_FAILURE" + - "RFID_LAYER6_FILE_NOT_FOUND" + - "RFID_LAYER6_FILE_EOF1" + - "RFID_LAYER6_FILE_EOF2" - "RFID_LAYER6_WRONG_LENGTH" + - "RFID_LAYER6_INCORRECT_PARAMS" + - "RFID_LAYER6_NO_REFERENCE_DATA" + - "RFID_LAYER6_PWD_SUSPENDED" + - "RFID_LAYER6_PWD_BLOCKED" + - "RFID_LAYER6_PWD_DEACTIVATED" + - "RFID_LAYER6_PWD_BLOCKED_2" + - "RFID_LAYER6_PWD_DEACTIVATED_2" + - "RFID_LAYER6_PWD_SUSPENDED_2" + - "RFID_LAYER6_PWD_FAILED" + - "RFID_Error_NotPerformed" + - "RFID_Error_Session_IsClosed" + - "RFID_Error_Session_Terminal_UnsupportedOperation" + - "RFID_Error_Session_TerminalType_Unknown" + - "RFID_Error_Session_TerminalType_BadCertificate" + - "RFID_Error_Session_TerminalType_NotSet" + - "RFID_Error_Session_ProcedureType_Unknown" + - "RFID_Error_Session_ProcedureType_Unsupported" + - "RFID_Error_Session_ProcedureType_NotSet" + - "RFID_Error_Session_AccessKey_UnknownType" + - "RFID_Error_Session_AccessKey_UnsupportedSMType" + - "RFID_Error_Session_AccessKey_IncorrectSMType" + - "RFID_Error_Session_AccessKey_Restricted" + - "RFID_Error_Session_AccessKey_IncorrectData" + - "RFID_Error_Session_AccessKey_NotSet" + - "RFID_Error_Session_PwdManagement_NotAuthorized" + - "RFID_Error_Session_AccessControl_UnknownType" + - "RFID_Error_Session_AccessControl_RequiresSM" + - "RFID_Error_Session_AccessControl_RequiresPACE" + - "RFID_Error_Session_AccessControl_RequiresCAKeys" + - "RFID_Error_Session_AccessControl_RequiresTA" + - "RFID_Error_Session_AccessControl_RequiresCA" + - "RFID_Error_Session_AccessControl_IncorrectOptionCA" + - "RFID_Error_Session_AccessControl_CA_Failed" + - "RFID_Error_Session_AccessControl_TA_Failed" + - "RFID_Error_Session_AccessControl_AA_Failed" + - "RFID_Error_Session_AccessControl_RI_Failed" + - "RFID_Error_Session_PA_SignatureCheckFailed" + - "RFID_Error_Session_PA_HashCheckFailed" + - "RFID_Error_Session_InvalidAuxData_DateOfExpiry" + - "RFID_Error_Session_InvalidAuxData_DateOfBirth" + - "RFID_Error_Session_InvalidAuxData_CommunityID" + - "RFID_Error_Session_eSign_RequiresAppSelection" + - "RFID_Error_Session_eSign_PIN_NotSet" + - "RFID_Error_Session_eSign_PIN_NotVerified" + - "RFID_Error_Session_IncorrectData" + - "RFID_Error_Session_File_NotEnoughData" + - "RFID_Error_Session_File_IncorrectData" + - "RFID_Error_Session_File_UnexpectedData" + - "RFID_Error_Session_File_Contents_UnexpectedData" + - "RFID_Error_Session_File_WrongTag" + - "RFID_Error_Session_File_CantUseData" + - "RFID_Error_Session_File_CantReadData" + - "RFID_Error_Session_File_AccessDenied" + - "RFID_Error_Layer34_NoError" + - "RFID_Error_Layer34_TimeOut" + - "RFID_Error_Layer34_Collision" + - "RFID_Error_Layer34_CRC" + - "RFID_Error_Layer34_DataIntegrity" + - "RFID_Error_Layer34_DataLength" + - "RFID_Error_Layer34_RFU" + - "RFID_Error_Layer34_Collision_TooMany" + - "RFID_Error_Layer34_ProtocolB" + - "RFID_Error_Layer34_DataContents" + - "RFID_Error_Layer34_Protocol" + - "RFID_Error_Layer34_GlobalTimeOut" + - "RFID_Error_Layer34_MIFARE_Auth" + - "RFID_Error_Layer34_SAM_Error" + - "RFID_Error_Layer34_SAM_Collision" + - "RFID_Error_Layer34_SAM_Acknowledge" From 89793bd396eeca18368ece43345fa06f75627e66 Mon Sep 17 00:00:00 2001 From: Artem Tsybulko Date: Fri, 13 Jun 2025 13:07:50 +0300 Subject: [PATCH 106/106] Update schemas --- authenticity/rt-photo-ident.yml | 16 +------- common.yml | 71 +++++++++++++++++++++++++++++++-- e-rfid-data-file-type.yml | 4 +- rt-document-position.yml | 51 +---------------------- rt-mrz-position.yml | 51 +---------------------- rt-mrz-test-quality.yml | 28 ++++++------- 6 files changed, 86 insertions(+), 135 deletions(-) diff --git a/authenticity/rt-photo-ident.yml b/authenticity/rt-photo-ident.yml index a583302..3e20ef9 100644 --- a/authenticity/rt-photo-ident.yml +++ b/authenticity/rt-photo-ident.yml @@ -17,7 +17,7 @@ components: SourceImage: $ref: "../common.yml#/components/schemas/ImageData" ResultImages: - $ref: "#/components/schemas/RawImageContainerList" + $ref: "../common.yml#/components/schemas/RawImageContainerList" FieldTypesCount: type: integer FieldTypesList: @@ -30,17 +30,3 @@ components: type: integer Reserved3: type: integer - - RawImageContainerList: - title: "RawImageContainerList" - type: object - required: - - Count - - Images - properties: - Count: - type: integer - Images: - type: array - items: - $ref: "../common.yml#/components/schemas/ImageData" diff --git a/common.yml b/common.yml index f997bc6..3243dff 100644 --- a/common.yml +++ b/common.yml @@ -221,12 +221,12 @@ components: - 3072 x-enum-descriptions: - "No Light" - - "Upper/lower lighters of white light scheme" - - "Side lighters of white light scheme" + - "Upper/lower white" + - "Side white" - "White" - "Infrared" - "Ultraviolet" - - "White coaxial" + - "Axial white" x-enum-varnames: - "OFF" - "WHITE_TOP" @@ -358,7 +358,7 @@ components: InComparison: type: integer wLCID: - type: integer + $ref: "./e-lcid.yml#/components/schemas/LCID" Reserved2: type: integer Reserved3: @@ -435,3 +435,66 @@ components: type: integer SubClass: type: integer + + RawImageContainerList: + title: "RawImageContainerList" + type: object + required: + - Count + - Images + properties: + Count: + type: integer + Images: + type: array + items: + $ref: "#/components/schemas/ImageData" + + DocumentPosition: + title: "DocumentPosition" + type: object + required: + - docFormat + - Angle + - Width + - Height + - Center + - LeftBottom + - LeftTop + - RightBottom + - RightTop + - Dpi + properties: + docFormat: + $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" + Angle: + description: "Document rotation angle" + type: number + Width: + description: "Document width" + type: integer + Height: + description: "Document height" + type: integer + Center: + $ref: "./common.yml#/components/schemas/Point" + LeftBottom: + $ref: "./common.yml#/components/schemas/Point" + LeftTop: + $ref: "./common.yml#/components/schemas/Point" + RightBottom: + $ref: "./common.yml#/components/schemas/Point" + RightTop: + $ref: "./common.yml#/components/schemas/Point" + Dpi: + type: integer + Inverse: + type: integer + ObjArea: + type: integer + ObjIntAngleDev: + type: integer + PerspectiveTr: + type: integer + ResultStatus: + type: integer diff --git a/e-rfid-data-file-type.yml b/e-rfid-data-file-type.yml index a1580ed..c9c19d8 100644 --- a/e-rfid-data-file-type.yml +++ b/e-rfid-data-file-type.yml @@ -184,8 +184,8 @@ components: - "AUTHENTICITY_V2" - "ATR" - "DIR" - - "_E_SIGN_PK" - - "_E_SIGN_SIGNED_DATA" + - "E_SIGN_PK" + - "E_SIGN_SIGNED_DATA" - "CERTIFICATE" - "MASTER_LIST" - "DEFECT_LIST" diff --git a/rt-document-position.yml b/rt-document-position.yml index 8648d8b..25c0043 100644 --- a/rt-document-position.yml +++ b/rt-document-position.yml @@ -8,53 +8,4 @@ components: - DocumentPosition properties: DocumentPosition: - $ref: "#/components/schemas/DocumentPosition" - - DocumentPosition: - title: "DocumentPosition" - type: object - required: - - docFormat - - Angle - - Width - - Height - - Center - - LeftBottom - - LeftTop - - RightBottom - - RightTop - - Dpi - properties: - docFormat: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" - Angle: - description: "Document rotation angle" - type: number - Width: - description: "Document width" - type: integer - Height: - description: "Document height" - type: integer - Center: - $ref: "./common.yml#/components/schemas/Point" - LeftBottom: - $ref: "./common.yml#/components/schemas/Point" - LeftTop: - $ref: "./common.yml#/components/schemas/Point" - RightBottom: - $ref: "./common.yml#/components/schemas/Point" - RightTop: - $ref: "./common.yml#/components/schemas/Point" - Dpi: - type: integer - Inverse: - type: integer - ObjArea: - type: integer - ObjIntAngleDev: - type: integer - PerspectiveTr: - type: integer - ResultStatus: - type: integer + $ref: "./common.yml#/components/schemas/DocumentPosition" diff --git a/rt-mrz-position.yml b/rt-mrz-position.yml index 293102d..a477095 100644 --- a/rt-mrz-position.yml +++ b/rt-mrz-position.yml @@ -8,53 +8,4 @@ components: - MrzPosition properties: MrzPosition: - $ref: "#/components/schemas/MrzPosition" - - MrzPosition: - title: "MrzPosition" - type: object - required: - - docFormat - - Angle - - Width - - Height - - Center - - LeftBottom - - LeftTop - - RightBottom - - RightTop - - Dpi - properties: - docFormat: - $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentFormat" - Angle: - description: "Document rotation angle" - type: number - Width: - description: "Document width" - type: integer - Height: - description: "Document height" - type: integer - Center: - $ref: "./common.yml#/components/schemas/Point" - LeftBottom: - $ref: "./common.yml#/components/schemas/Point" - LeftTop: - $ref: "./common.yml#/components/schemas/Point" - RightBottom: - $ref: "./common.yml#/components/schemas/Point" - RightTop: - $ref: "./common.yml#/components/schemas/Point" - Dpi: - type: integer - Inverse: - type: integer - ObjArea: - type: integer - ObjIntAngleDev: - type: integer - PerspectiveTr: - type: integer - ResultStatus: - type: integer + $ref: "./common.yml#/components/schemas/DocumentPosition" diff --git a/rt-mrz-test-quality.yml b/rt-mrz-test-quality.yml index c311dcd..21c0f82 100644 --- a/rt-mrz-test-quality.yml +++ b/rt-mrz-test-quality.yml @@ -26,19 +26,19 @@ components: - TEXTUAL_FILLING properties: CHECK_SUMS: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" CONTRAST_PRINT: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" DOC_FORMAT: type: integer MRZ_FORMAT: type: integer PRINT_POSITION: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" STAIN_MRZ: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" SYMBOLS_PARAM: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" StrCount: type: integer Strings: @@ -46,7 +46,7 @@ components: items: $ref: "#/components/schemas/StringItem" TEXTUAL_FILLING: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" StringItem: title: "StringItem" @@ -71,9 +71,9 @@ components: - SymbolsEstimations properties: ALIGNMENT_SYMBOLS_IN_STRING: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" CHECK_SUMS: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" ErrorPOSITION: $ref: "#/components/schemas/ErrorCoordinates" FieldCount: @@ -83,15 +83,15 @@ components: items: $ref: "#/components/schemas/FieldItem" STRINGS_DISTANCE: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" STRINGS_INTERVAL: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" STRING_FILLING: - type: integer - STRING_POSITION: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" + STRINGS_POSITION: + $ref: "./common.yml#/components/schemas/CheckResult" SYMBOLS_PARAM: - type: integer + $ref: "./common.yml#/components/schemas/CheckResult" SizeError_ALIGNMENT: type: number SizeError_DISTANCE: