Merge pull request #70 from regulaforensics/BE-429-barcodes

[BE-429] ResultType 5 | Barcodes

Author: AlexSatsukevich

openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "5.0.1"
+    "version": "5.0.0"
   }
 }

rt-barcodes.yml

@@ -0,0 +1,87 @@
+openapi: 3.0.3
+components:
+  schemas:
+
+    DocBarCodeInfo:
+      title: "Document BarCode Info"
+      description: "Raw data from BarCodes"
+      allOf:
+        - type: object
+          properties:
+            nFields:
+              type: integer
+              description: "Count of array fields"
+            pArrayFields:
+              type: array
+              description: "Data from barcode"
+              items:
+                $ref: '#/components/schemas/pArrayField'
+        - $ref: './rt.yml#/components/schemas/ResultItem'
+
+    pArrayField:
+      type: object
+      properties:
+        bcAngle_DETECT:
+          type: float
+        bcCodeResult:
+          type: integer
+        bcCountModule:
+          type: integer
+        bcDataModule:
+          type: array
+          items:
+            $ref: '#/components/schemas/DataModule'
+        bcPDF417INFO:
+          $ref: '#/components/schemas/bcPDF417INFO'
+        bcROI_DETECT:
+          $ref: '#/components/schemas/bcROI_DETECT'
+        bcTextDecoderTypes:
+          type: integer
+        bcTextFieldType:
+          type: integer
+        bcType_DECODE:
+          type: integer
+        bcType_DETECT:
+          type: integer
+
+    bcPDF417INFO:
+      type: object
+      properties:
+        Angle:
+          type: float
+        bcColumn:
+          type: integer
+        bcErrorLevel:
+          type: integer
+        bcRow:
+          type: integer
+        minX:
+          type: float
+        minY:
+          type: float
+
+    bcROI_DETECT:
+      type: object
+      properties:
+        bottom:
+          type: integer
+        left:
+          type: integer
+        right:
+          type: integer
+        top:
+          type: integer
+
+    DataModule:
+      type: object
+      properties:
+        mData:
+          type: string
+        mLength:
+          type: integer
+        mReserved1:
+          type: integer
+        mReserver2:
+          type: integer
+        mType:
+          type: integer

rt.yml

@@ -28,6 +28,7 @@ components:
         - 9
         - 20
         - 85
+        - 5
         - 50
         - 49
       x-enum-descriptions:
@@ -52,6 +53,7 @@ components:
         - 'Contains description of determined document type, if any'
         - 'Contains result of document authenticity checks'
         - 'Contains information about document position on the input image, its center, angle, etc'
+        - 'Contains raw information about barcodes on the input image'
         - 'Contains license'
         - 'Contains encrypted ResultContainerList'
       x-enum-varnames:
@@ -72,6 +74,7 @@ components:
         - DOCUMENT_TYPE
         - AUTHENTICITY
         - DOCUMENT_POSITION
+        - BARCODES
         - LICENSE
         - ENCRYPTED_RCL
 
@@ -97,6 +100,7 @@ components:
         mapping:
           1: "DocumentImageResult"
           3: "TextDataResult"
+          5: "DocBarCodeInfo"
           6: "GraphicsResult"
           8: "DocumentTypesCandidatesResult"
           9: "ChosenDocumentTypeResult"
@@ -140,6 +144,7 @@ components:
               - $ref: "#/components/schemas/AuthenticityResult"
               - $ref: "#/components/schemas/ImageQualityResult"
               - $ref: "#/components/schemas/DocumentPositionResult"
+              - $ref: "#/components/schemas/DocBarCodeInfo"
               - $ref: "#/components/schemas/LicenseResult"
               - $ref: "#/components/schemas/EncryptedRCLResult"
 
@@ -178,6 +183,9 @@ components:
     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"