Merge branch 'develop' into SP-19592/Add_DTC

common.yml

@@ -125,6 +125,9 @@ components:
       properties:
         image:
           $ref: "#/components/schemas/ImageBase64"
+        format:
+          description: "Image format"
+          type: string
 
     ImageTransactionData:
       type: object

p-healthcheck.yml

@@ -5,7 +5,7 @@ paths:
     parameters:
       - $ref: "./common.yml#/components/parameters/x-request"
     get:
-      summary: "Server healthcheck"
+      summary: "Server health check"
       operationId: healthz
       tags:
         - healthcheck
@@ -15,12 +15,12 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/DeviceInfo"
+                $ref: "#/components/schemas/Healthcheck"
   /readyz:
     parameters:
       - $ref: "./common.yml#/components/parameters/x-request"
     get:
-      summary: "License healthcheck"
+      summary: "License health check"
       operationId: readyz
       tags:
         - healthcheck
@@ -32,7 +32,8 @@ paths:
 
 components:
   schemas:
-    DeviceInfo:
+    Healthcheck:
+      title: "Health check"
       type: object
       required: [app, licenseId, licenseType, licenseSerial, licenseValidUntil, scenarios, version]
       properties:

p-ping.yml

@@ -21,6 +21,7 @@ paths:
 components:
   schemas:
     DeviceInfo:
+      title: "DeviceInfo"
       type: object
       properties:
         app-name:

p-process.yml

@@ -177,12 +177,22 @@ 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
+        dtc:
+          type: string
+        ImageUrls:
+          type: array
+          description: "URLs to the document images for processing."
+          items:
+            type: string
       required:
         - processParam
 
     ProcessParams:
       type: object
       properties:
+        generateDTCVC:
+          type: boolean
+          description: "This parameter is used to generate separate DTC-VC data container from RFID session data."
         lcidFilter:
           description: "The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default."
           type: array
@@ -309,9 +319,14 @@ components:
           # default: false
         imageQa:
           $ref: "#/components/schemas/ImageQA"
+        strictImageQuality:
+          description: "When enabled, the image quality check status affects the document optical and overall status. Disabled by default."
+          type: boolean
+          # default: false
         respectImageQuality:
-          description: "When enabled, image quality checks status affects document optical and overall status. Disabled by default."
+          description: "Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default."
           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."
@@ -424,6 +439,10 @@ components:
         generateNumericCodes:
           type: boolean
           description: "This parameter is used to generate numeric representation for issuing state and nationality codes"
+#          default: false
+        strictBarcodeDigitalSignatureCheck:
+          type: boolean
+          description: "This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed."
 #          default: false
       required:
         - scenario

p-transaction.yml

@@ -10,7 +10,7 @@ paths:
         - in: path
           name: transactionId
           schema:
-            type: integer
+            type: string
             format: uuid
           required: true
           description: Transaction id
@@ -51,7 +51,7 @@ paths:
         - in: path
           name: transactionId
           schema:
-            type: integer
+            type: string
             format: uuid
           required: true
           description: Transaction id
@@ -76,7 +76,7 @@ paths:
         - in: path
           name: transactionId
           schema:
-            type: integer
+            type: string
             format: uuid
           required: true
           description: Transaction id
@@ -132,7 +132,7 @@ paths:
         - in: path
           name: transactionId
           schema:
-            type: integer
+            type: string
             format: uuid
           required: true
           description: Transaction id
@@ -161,7 +161,7 @@ paths:
         - in: path
           name: tagId
           schema:
-            type: integer
+            type: string
             format: uuid
           required: true
           description: Tag id
@@ -218,7 +218,7 @@ components:
       type: object
       properties:
         id:
-          type: integer
+          type: string
           format: uuid
           description: "Transaction id"
         state:
@@ -232,7 +232,7 @@ components:
       type: object
       properties:
         transactionId:
-          type: integer
+          type: string
           format: uuid
         tag:
           type: string

rt-byte-array-data.yml

@@ -0,0 +1,14 @@
+openapi: 3.0.3
+components:
+  schemas:
+    ByteArrayResult:
+      title: "ByteArray"
+      allOf:
+        - type: object
+          required:
+            - ByteArray
+          properties:
+            ByteArray:
+              description: "Byte array in base64"
+              type: string
+        - $ref: "./rt.yml#/components/schemas/ResultItem"

rt-image-data.yml

@@ -15,7 +15,6 @@ components:
               $ref: "#/components/schemas/GraphicFieldsList"
         - $ref: "./rt.yml#/components/schemas/ResultItem"
 
-
     GraphicFieldsList:
       type: object
       required:

rt-raw-image.yml

@@ -4,11 +4,9 @@ components:
 
     DocumentImageResult:
       title: "Document Image"
+      description: "Contains document 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:

rt.yml

@@ -36,6 +36,7 @@ components:
         - 103
         - 104
         - 105
+        - 109
       x-enum-descriptions:
         - "Contains cropped and rotated with perspective compensation image of document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most of coordinates in other types defined on that image"
         - "Contains MRZ OCR results"
@@ -63,6 +64,7 @@ components:
         - "Contains RFID graphic results"
         - "Contains RFID binary data"
         - "Contains RFID original graphics data"
+        - "Digital Travel Credential data"
       x-enum-varnames:
         - "DOCUMENT_IMAGE"
         - "MRZ_TEXT"
@@ -90,6 +92,7 @@ components:
         - "RFID_GRAPHICS"
         - "RFID_BINARY_DATA"
         - "RFID_ORIGINAL_GRAPHICS"
+        - "DTC_VC"
 
     ResultItem:
       type: object
@@ -117,6 +120,7 @@ components:
           8: "DocumentTypesCandidatesResult"
           9: "ChosenDocumentTypeResult"
           15: "LexicalAnalysisResult"
+          16: "DocumentImageResult"
           17: "TextDataResult"
           18: "TextDataResult"
           19: "GraphicsResult"
@@ -132,6 +136,7 @@ components:
           85: "DocumentPositionResult"
           102: "TextDataResult"
           103: "GraphicsResult"
+          109: "ByteArrayResult"
 
     ContainerList:
       type: object
@@ -161,6 +166,7 @@ components:
               - $ref: "#/components/schemas/DocBarCodeInfo"
               - $ref: "#/components/schemas/LicenseResult"
               - $ref: "#/components/schemas/EncryptedRCLResult"
+              - $ref: "#/components/schemas/ByteArrayResult"
 
     DocumentPositionResult:
       $ref: "./rt-document-position.yml#/components/schemas/DocumentPositionResult"
@@ -186,6 +192,9 @@ components:
     GraphicsResult:
       $ref: "./rt-image-data.yml#/components/schemas/GraphicsResult"
 
+    ByteArrayResult:
+      $ref: "./rt-byte-array-data.yml#/components/schemas/ByteArrayResult"
+
     DocumentTypesCandidatesResult:
       $ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesResult"