#227 - Modify "Only available with Pro/Enterprise" text in /documents…

…/{id}/ocr endpoints
formkiq · May 29, 2024 · c47da0d · c47da0d
1 parent 2c40d59
commit c47da0d
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 24 deletions.
diff --git a/docs/openapi/openapi-iam.yaml b/docs/openapi/openapi-iam.yaml
@@ -2004,7 +2004,7 @@
             get:
               operationId: GetDocumentOcr
               summary: Get document ocr content
-              description: Get a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: "Get a document's optical character recognition (OCR) result, if exists; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2034,7 +2034,7 @@
             post:
               operationId: AddDocumentOcr
               summary: Perform document ocr
-              description: Document optical character recognition (OCR) request; extract text and data from a document; ONLY available with FormKiQ Pro and Enterprise
+              description: "Document optical character recognition (OCR) request; extract text and data from a document; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2067,7 +2067,7 @@
             put:
               operationId: SetDocumentOcr
               summary: Set document ocr result
-              description: Set a document's optical character recognition (OCR) result for a document; ONLY available with FormKiQ Pro and Enterprise
+              description: "Set a document's optical character recognition (OCR) result for a document; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2100,7 +2100,7 @@
             delete:
               operationId: DeleteDocumentOcr
               summary: Delete document ocr
-              description: Delete a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: "Delete a document's optical character recognition (OCR) result, if exists; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:

diff --git a/docs/openapi/openapi-jwt.yaml b/docs/openapi/openapi-jwt.yaml
@@ -2004,7 +2004,7 @@
             get:
               operationId: GetDocumentOcr
               summary: Get document ocr content
-              description: Get a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: "Get a document's optical character recognition (OCR) result, if exists; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2034,7 +2034,7 @@
             post:
               operationId: AddDocumentOcr
               summary: Perform document ocr
-              description: Document optical character recognition (OCR) request; extract text and data from a document; ONLY available with FormKiQ Pro and Enterprise
+              description: "Document optical character recognition (OCR) request; extract text and data from a document; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2067,7 +2067,7 @@
             put:
               operationId: SetDocumentOcr
               summary: Set document ocr result
-              description: Set a document's optical character recognition (OCR) result for a document; ONLY available with FormKiQ Pro and Enterprise
+              description: "Set a document's optical character recognition (OCR) result for a document; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2100,7 +2100,7 @@
             delete:
               operationId: DeleteDocumentOcr
               summary: Delete document ocr
-              description: Delete a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: "Delete a document's optical character recognition (OCR) result, if exists; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:

diff --git a/docs/openapi/openapi-key.yaml b/docs/openapi/openapi-key.yaml
@@ -2004,7 +2004,7 @@
             get:
               operationId: GetDocumentOcr
               summary: Get document ocr content
-              description: Get a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: "Get a document's optical character recognition (OCR) result, if exists; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2034,7 +2034,7 @@
             post:
               operationId: AddDocumentOcr
               summary: Perform document ocr
-              description: Document optical character recognition (OCR) request; extract text and data from a document; ONLY available with FormKiQ Pro and Enterprise
+              description: "Document optical character recognition (OCR) request; extract text and data from a document; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2067,7 +2067,7 @@
             put:
               operationId: SetDocumentOcr
               summary: Set document ocr result
-              description: Set a document's optical character recognition (OCR) result for a document; ONLY available with FormKiQ Pro and Enterprise
+              description: "Set a document's optical character recognition (OCR) result for a document; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:
@@ -2100,7 +2100,7 @@
             delete:
               operationId: DeleteDocumentOcr
               summary: Delete document ocr
-              description: Delete a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: "Delete a document's optical character recognition (OCR) result, if exists; \n\nTesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise"
               tags:
               - Document OCR
               parameters:

diff --git a/lambda-api-graalvm/src/main/resources/cloudformation/openapi-iam.yaml b/lambda-api-graalvm/src/main/resources/cloudformation/openapi-iam.yaml
@@ -2020,7 +2020,10 @@ Resources:
             get:
               operationId: GetDocumentOcr
               summary: Get document ocr content
-              description: Get a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Get a document's optical character recognition (OCR) result, if exists; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2050,7 +2053,10 @@ Resources:
             post:
               operationId: AddDocumentOcr
               summary: Perform document ocr
-              description: Document optical character recognition (OCR) request; extract text and data from a document; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Document optical character recognition (OCR) request; extract text and data from a document; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2083,7 +2089,10 @@ Resources:
             put:
               operationId: SetDocumentOcr
               summary: Set document ocr result
-              description: Set a document's optical character recognition (OCR) result for a document; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Set a document's optical character recognition (OCR) result for a document; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2116,7 +2125,10 @@ Resources:
             delete:
               operationId: DeleteDocumentOcr
               summary: Delete document ocr
-              description: Delete a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Delete a document's optical character recognition (OCR) result, if exists; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:

diff --git a/lambda-api-graalvm/src/main/resources/cloudformation/openapi-jwt.yaml b/lambda-api-graalvm/src/main/resources/cloudformation/openapi-jwt.yaml
@@ -2020,7 +2020,10 @@ Resources:
             get:
               operationId: GetDocumentOcr
               summary: Get document ocr content
-              description: Get a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Get a document's optical character recognition (OCR) result, if exists; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2050,7 +2053,10 @@ Resources:
             post:
               operationId: AddDocumentOcr
               summary: Perform document ocr
-              description: Document optical character recognition (OCR) request; extract text and data from a document; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Document optical character recognition (OCR) request; extract text and data from a document; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2083,7 +2089,10 @@ Resources:
             put:
               operationId: SetDocumentOcr
               summary: Set document ocr result
-              description: Set a document's optical character recognition (OCR) result for a document; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Set a document's optical character recognition (OCR) result for a document; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2116,7 +2125,10 @@ Resources:
             delete:
               operationId: DeleteDocumentOcr
               summary: Delete document ocr
-              description: Delete a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Delete a document's optical character recognition (OCR) result, if exists; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:

diff --git a/lambda-api-graalvm/src/main/resources/cloudformation/openapi-key.yaml b/lambda-api-graalvm/src/main/resources/cloudformation/openapi-key.yaml
@@ -2020,7 +2020,10 @@ Resources:
             get:
               operationId: GetDocumentOcr
               summary: Get document ocr content
-              description: Get a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Get a document's optical character recognition (OCR) result, if exists; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2050,7 +2053,10 @@ Resources:
             post:
               operationId: AddDocumentOcr
               summary: Perform document ocr
-              description: Document optical character recognition (OCR) request; extract text and data from a document; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Document optical character recognition (OCR) request; extract text and data from a document; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2083,7 +2089,10 @@ Resources:
             put:
               operationId: SetDocumentOcr
               summary: Set document ocr result
-              description: Set a document's optical character recognition (OCR) result for a document; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Set a document's optical character recognition (OCR) result for a document; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters:
@@ -2116,7 +2125,10 @@ Resources:
             delete:
               operationId: DeleteDocumentOcr
               summary: Delete document ocr
-              description: Delete a document's optical character recognition (OCR) result, if exists; ONLY available with FormKiQ Pro and Enterprise
+              description: |-
+                Delete a document's optical character recognition (OCR) result, if exists; 
+
+                Tesseract available for all editions, but Textract engine and tables and forms options ONLY available with FormKiQ Pro and Enterprise
               tags:
               - Document OCR
               parameters: