update

formkiq · Jun 11, 2024 · b754e0b · b754e0b
1 parent e4855f2
commit b754e0b
Show file tree

Hide file tree

Showing 12 changed files with 174 additions and 147 deletions.
diff --git a/docs/openapi/openapi-iam.yaml b/docs/openapi/openapi-iam.yaml
@@ -1923,7 +1923,7 @@
                 | -------- | ------- | ------- | ------- |
                 | OCR  | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES |
                 | OCR | ocrEngine     | Ocr Engine to use | tesseract or textract |
-                | OCR | ocrExportToCsv     | Convert OCR result to CSV (textract table only) | true |
+                | OCR | ocrOutputType     | Convert OCR result to an Output format (textract table only) | true |
                 | OCR | ocrNumberOfPages  | Number of pages to OCR (from start) | -1 |
                 | OCR    | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
                 | FULLTEXT    | characterMax    | Maximum number of characters to add to Fulltext destination | -1 |
@@ -8737,6 +8737,11 @@
               enum:
               - TESSERACT
               - TEXTRACT
+            OcrOutputType:
+              type: string
+              description: OCR Engine output format (textract table only)
+              enum:
+              - CSV
             AddActionParameters:
               type: object
               properties:
@@ -8745,9 +8750,8 @@
                   description: 'OCR: Parse types - TEXT, FORMS, TABLES'
                 ocrEngine:
                   $ref: '#/components/schemas/OcrEngine'
-                ocrExportToCsv:
-                  type: string
-                  description: Convert OCR result to CSV (textract table only)
+                ocrOutputType:
+                  $ref: '#/components/schemas/OcrOutputType'
                 ocrNumberOfPages:
                   type: string
                   description: Number of pages to OCR (from start) (-1 all)
@@ -8812,9 +8816,8 @@
                 ocrNumberOfPages:
                   type: string
                   description: Number of pages to OCR (from start) (-1 all)
-                ocrExportToCsv:
-                  type: boolean
-                  description: Whether to Export to CSV
+                ocrOutputType:
+                  $ref: '#/components/schemas/OcrOutputType'
             SetDocumentOcrRequest:
               required:
               - content

diff --git a/docs/openapi/openapi-jwt.yaml b/docs/openapi/openapi-jwt.yaml
@@ -1923,7 +1923,7 @@
                 | -------- | ------- | ------- | ------- |
                 | OCR  | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES |
                 | OCR | ocrEngine     | Ocr Engine to use | tesseract or textract |
-                | OCR | ocrExportToCsv     | Convert OCR result to CSV (textract table only) | true |
+                | OCR | ocrOutputType     | Convert OCR result to an Output format (textract table only) | true |
                 | OCR | ocrNumberOfPages  | Number of pages to OCR (from start) | -1 |
                 | OCR    | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
                 | FULLTEXT    | characterMax    | Maximum number of characters to add to Fulltext destination | -1 |
@@ -8737,6 +8737,11 @@
               enum:
               - TESSERACT
               - TEXTRACT
+            OcrOutputType:
+              type: string
+              description: OCR Engine output format (textract table only)
+              enum:
+              - CSV
             AddActionParameters:
               type: object
               properties:
@@ -8745,9 +8750,8 @@
                   description: 'OCR: Parse types - TEXT, FORMS, TABLES'
                 ocrEngine:
                   $ref: '#/components/schemas/OcrEngine'
-                ocrExportToCsv:
-                  type: string
-                  description: Convert OCR result to CSV (textract table only)
+                ocrOutputType:
+                  $ref: '#/components/schemas/OcrOutputType'
                 ocrNumberOfPages:
                   type: string
                   description: Number of pages to OCR (from start) (-1 all)
@@ -8812,9 +8816,8 @@
                 ocrNumberOfPages:
                   type: string
                   description: Number of pages to OCR (from start) (-1 all)
-                ocrExportToCsv:
-                  type: boolean
-                  description: Whether to Export to CSV
+                ocrOutputType:
+                  $ref: '#/components/schemas/OcrOutputType'
             SetDocumentOcrRequest:
               required:
               - content

diff --git a/docs/openapi/openapi-key.yaml b/docs/openapi/openapi-key.yaml
@@ -1923,7 +1923,7 @@
                 | -------- | ------- | ------- | ------- |
                 | OCR  | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES |
                 | OCR | ocrEngine     | Ocr Engine to use | tesseract or textract |
-                | OCR | ocrExportToCsv     | Convert OCR result to CSV (textract table only) | true |
+                | OCR | ocrOutputType     | Convert OCR result to an Output format (textract table only) | true |
                 | OCR | ocrNumberOfPages  | Number of pages to OCR (from start) | -1 |
                 | OCR    | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
                 | FULLTEXT    | characterMax    | Maximum number of characters to add to Fulltext destination | -1 |
@@ -8737,6 +8737,11 @@
               enum:
               - TESSERACT
               - TEXTRACT
+            OcrOutputType:
+              type: string
+              description: OCR Engine output format (textract table only)
+              enum:
+              - CSV
             AddActionParameters:
               type: object
               properties:
@@ -8745,9 +8750,8 @@
                   description: 'OCR: Parse types - TEXT, FORMS, TABLES'
                 ocrEngine:
                   $ref: '#/components/schemas/OcrEngine'
-                ocrExportToCsv:
-                  type: string
-                  description: Convert OCR result to CSV (textract table only)
+                ocrOutputType:
+                  $ref: '#/components/schemas/OcrOutputType'
                 ocrNumberOfPages:
                   type: string
                   description: Number of pages to OCR (from start) (-1 all)
@@ -8812,9 +8816,8 @@
                 ocrNumberOfPages:
                   type: string
                   description: Number of pages to OCR (from start) (-1 all)
-                ocrExportToCsv:
-                  type: boolean
-                  description: Whether to Export to CSV
+                ocrOutputType:
+                  $ref: '#/components/schemas/OcrOutputType'
             SetDocumentOcrRequest:
               required:
               - content

diff --git a/lambda-api-graalvm/src/main/resources/cloudformation/openapi-iam.yaml b/lambda-api-graalvm/src/main/resources/cloudformation/openapi-iam.yaml
@@ -1938,7 +1938,7 @@ Resources:
                 | -------- | ------- | ------- | ------- |
                 | OCR  | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES |
                 | OCR | ocrEngine     | Ocr Engine to use | tesseract or textract |
-                | OCR | ocrExportToCsv     | Convert OCR result to CSV (textract table only) | true |
+                | OCR | ocrOutputType     | Convert OCR result to an Output format (textract table only) | true |
                 | OCR | ocrNumberOfPages  | Number of pages to OCR (from start) | -1 |
                 | OCR    | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
                 | FULLTEXT    | characterMax    | Maximum number of characters to add to Fulltext destination | -1 |
@@ -8821,6 +8821,11 @@ Resources:
               enum:
                 - TESSERACT
                 - TEXTRACT
+            OcrOutputType:
+              type: string
+              description: OCR Engine output format (textract table only)
+              enum:
+                - CSV
             AddActionParameters:
               type: "object"
               properties:
@@ -8829,9 +8834,8 @@ Resources:
                   description: "OCR: Parse types - TEXT, FORMS, TABLES"
                 ocrEngine:
                   $ref: "#/components/schemas/OcrEngine"
-                ocrExportToCsv:
-                  type: string
-                  description: "Convert OCR result to CSV (textract table only)"
+                ocrOutputType:
+                  $ref: "#/components/schemas/OcrOutputType"
                 ocrNumberOfPages:
                   type: "string"
                   description: "Number of pages to OCR (from start) (-1 all)"
@@ -8896,9 +8900,8 @@ Resources:
                 ocrNumberOfPages:
                   type: "string"
                   description: "Number of pages to OCR (from start) (-1 all)"
-                ocrExportToCsv:
-                  type: boolean
-                  description: Whether to Export to CSV
+                ocrOutputType:
+                  $ref: "#/components/schemas/OcrOutputType"
             SetDocumentOcrRequest:
               required:
               - "content"

diff --git a/lambda-api-graalvm/src/main/resources/cloudformation/openapi-jwt.yaml b/lambda-api-graalvm/src/main/resources/cloudformation/openapi-jwt.yaml
@@ -1938,7 +1938,7 @@ Resources:
                 | -------- | ------- | ------- | ------- |
                 | OCR  | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES |
                 | OCR | ocrEngine     | Ocr Engine to use | tesseract or textract |
-                | OCR | ocrExportToCsv     | Convert OCR result to CSV (textract table only) | true |
+                | OCR | ocrOutputType     | Convert OCR result to an Output format (textract table only) | true |
                 | OCR | ocrNumberOfPages  | Number of pages to OCR (from start) | -1 |
                 | OCR    | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
                 | FULLTEXT    | characterMax    | Maximum number of characters to add to Fulltext destination | -1 |
@@ -8821,6 +8821,11 @@ Resources:
               enum:
                 - TESSERACT
                 - TEXTRACT
+            OcrOutputType:
+              type: string
+              description: OCR Engine output format (textract table only)
+              enum:
+                - CSV
             AddActionParameters:
               type: "object"
               properties:
@@ -8829,9 +8834,8 @@ Resources:
                   description: "OCR: Parse types - TEXT, FORMS, TABLES"
                 ocrEngine:
                   $ref: "#/components/schemas/OcrEngine"
-                ocrExportToCsv:
-                  type: string
-                  description: "Convert OCR result to CSV (textract table only)"
+                ocrOutputType:
+                  $ref: "#/components/schemas/OcrOutputType"
                 ocrNumberOfPages:
                   type: "string"
                   description: "Number of pages to OCR (from start) (-1 all)"
@@ -8896,9 +8900,8 @@ Resources:
                 ocrNumberOfPages:
                   type: "string"
                   description: "Number of pages to OCR (from start) (-1 all)"
-                ocrExportToCsv:
-                  type: boolean
-                  description: Whether to Export to CSV
+                ocrOutputType:
+                  $ref: "#/components/schemas/OcrOutputType"
             SetDocumentOcrRequest:
               required:
               - "content"

diff --git a/lambda-api-graalvm/src/main/resources/cloudformation/openapi-key.yaml b/lambda-api-graalvm/src/main/resources/cloudformation/openapi-key.yaml
@@ -1938,7 +1938,7 @@ Resources:
                 | -------- | ------- | ------- | ------- |
                 | OCR  | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES |
                 | OCR | ocrEngine     | Ocr Engine to use | tesseract or textract |
-                | OCR | ocrExportToCsv     | Convert OCR result to CSV (textract table only) | true |
+                | OCR | ocrOutputType     | Convert OCR result to an Output format (textract table only) | true |
                 | OCR | ocrNumberOfPages  | Number of pages to OCR (from start) | -1 |
                 | OCR    | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
                 | FULLTEXT    | characterMax    | Maximum number of characters to add to Fulltext destination | -1 |
@@ -8821,6 +8821,11 @@ Resources:
               enum:
                 - TESSERACT
                 - TEXTRACT
+            OcrOutputType:
+              type: string
+              description: OCR Engine output format (textract table only)
+              enum:
+                - CSV
             AddActionParameters:
               type: "object"
               properties:
@@ -8829,9 +8834,8 @@ Resources:
                   description: "OCR: Parse types - TEXT, FORMS, TABLES"
                 ocrEngine:
                   $ref: "#/components/schemas/OcrEngine"
-                ocrExportToCsv:
-                  type: string
-                  description: "Convert OCR result to CSV (textract table only)"
+                ocrOutputType:
+                  $ref: "#/components/schemas/OcrOutputType"
                 ocrNumberOfPages:
                   type: "string"
                   description: "Number of pages to OCR (from start) (-1 all)"
@@ -8896,9 +8900,8 @@ Resources:
                 ocrNumberOfPages:
                   type: "string"
                   description: "Number of pages to OCR (from start) (-1 all)"
-                ocrExportToCsv:
-                  type: boolean
-                  description: Whether to Export to CSV
+                ocrOutputType:
+                  $ref: "#/components/schemas/OcrOutputType"
             SetDocumentOcrRequest:
               required:
               - "content"

diff --git a/lambda-api/src/test/java/com/formkiq/stacks/api/handler/DocumentsActionsRequestTest.java b/lambda-api/src/test/java/com/formkiq/stacks/api/handler/DocumentsActionsRequestTest.java
@@ -46,6 +46,7 @@
 import com.formkiq.client.model.MappingAttribute;
 import com.formkiq.client.model.MappingAttributeLabelMatchingType;
 import com.formkiq.client.model.MappingAttributeSourceType;
+import com.formkiq.client.model.OcrOutputType;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import com.formkiq.aws.dynamodb.DynamicObject;
@@ -180,7 +181,7 @@ public void testHandlePostDocumentActions01() throws Exception {
       AddDocumentActionsRequest req = new AddDocumentActionsRequest().actions(Arrays.asList(
           new AddAction().type(DocumentActionType.OCR)
               .parameters(new AddActionParameters().addPdfDetectedCharactersAsText("true")
-                  .ocrExportToCsv("true").ocrParseTypes("text")),
+                  .ocrOutputType(OcrOutputType.CSV).ocrParseTypes("text")),
           new AddAction().type(DocumentActionType.WEBHOOK)
               .parameters(new AddActionParameters().url("https://localhost"))));
 
@@ -200,7 +201,7 @@ public void testHandlePostDocumentActions01() throws Exception {
 
       assertEquals(ActionType.OCR, actions.get(i).type());
       assertEquals(ActionStatus.PENDING, actions.get(i).status());
-      assertEquals("{ocrParseTypes=text, ocrExportToCsv=true, addPdfDetectedCharactersAsText=true}",
+      assertEquals("{ocrParseTypes=text, ocrOutputType=CSV, addPdfDetectedCharactersAsText=true}",
           actions.get(i++).parameters().toString());
 
       assertEquals(ActionType.WEBHOOK, actions.get(i).type());