Rename rt1 from 'raw image' to 'document image'

Author: hleb-albau

rt-ocr-lexical-analisis.yml

@@ -9,7 +9,7 @@ components:
         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.
-        Deprecated since 5.2. Instead consider to use text(36) type.
+        Deprecated since 5.2. Instead consider to use Result.TEXT type.
       allOf:
         - $ref: './rt.yml#/components/schemas/ResultItem'
         - type: object

rt-raw-image.yml

@@ -2,12 +2,13 @@ openapi: 3.0.3
 components:
   schemas:
 
-    RawImageResult:
+    DocumentImageResult:
       allOf:
         - $ref: './rt.yml#/components/schemas/ResultItem'
         - type: object
-          description: "Returns cropped and rotated image of document.
-          Most of coordinates in other types defined on that image"
+          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

@@ -25,7 +25,9 @@ components:
         - 8
         - 9
       x-enum-descriptions:
-        - 'Contains cropped and rotated image of document. Most of coordinates in other types defined on that image'
+        - '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 check statuses with details, grouped by source'
         - '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)'
@@ -42,7 +44,7 @@ components:
         - 'Contains list of document type candidates with their probabilities and descriptions'
         - 'Contains description of determined document type, if any'
       x-enum-varnames:
-        - RAW_IMAGE
+        - DOCUMENT_IMAGE
         - STATUS
         - TEXT
         - IMAGES
@@ -76,7 +78,7 @@ components:
       discriminator:
         propertyName: result_type
         mapping:
-          1: "RawImageResult"
+          1: "DocumentImageResult"
           3: "TextDataResult"
           6: "GraphicsResult"
           8: "DocumentTypesCandidatesResult"
@@ -101,7 +103,7 @@ components:
           type: array
           items:
             anyOf:
-              - $ref: "#/components/schemas/RawImageResult"
+              - $ref: "#/components/schemas/DocumentImageResult"
               - $ref: "#/components/schemas/TextResult"
               - $ref: "#/components/schemas/StatusResult"
               - $ref: "#/components/schemas/TextDataResult"
@@ -111,8 +113,8 @@ components:
               - $ref: "#/components/schemas/DocumentTypesCandidatesResult"
               - $ref: "#/components/schemas/ImagesResult"
 
-    RawImageResult:
-      $ref: "./rt-raw-image.yml#/components/schemas/RawImageResult"
+    DocumentImageResult:
+      $ref: "./rt-raw-image.yml#/components/schemas/DocumentImageResult"
 
     StatusResult:
       $ref: "./rt-status.yml#/components/schemas/StatusResult"