From b84beb4616ec85e12823add285b5eebbed7fbd74 Mon Sep 17 00:00:00 2001 From: Kresnadi Budisantoso Date: Fri, 2 Aug 2024 14:26:24 +0200 Subject: [PATCH] RED-9782 Updated DocuMine OpenAPI spec and renamed query parameter for spec of RedeactManager --- .../src/main/resources/api/documine.yaml | 14 ++++++++++++++ .../src/main/resources/api/redactmanager.yaml | 6 +++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml b/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml index c8f397a26..3232ec7ac 100644 --- a/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml +++ b/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml @@ -1195,6 +1195,7 @@ paths: - $ref: '#/components/parameters/dossierTemplateId' - $ref: '#/components/parameters/dossierId' - $ref: '#/components/parameters/keepManualChanges' + - $ref: '#/components/parameters/disableAutomaticAnalysis' requestBody: content: multipart/form-data: @@ -2234,6 +2235,19 @@ components: overwriting a file: - `true`: The system keeps the manual changes on re-uploading (overwriting) the file. - `false` (default): Manual changes get discarded on re-uploading the file. + disableAutomaticAnalysis: + name: disableAutomaticAnalysis + in: query + required: false + schema: + default: false + type: boolean + style: form + explode: true + description: | + A toggle to disable automatic analysis, i.e., to just upload and process the file without applying any automatic annotations: + - `true`: The system does not apply any automatic text annotations on the file. Images are detected and annotated anyway. + - `false` (default): The system applies automatic annotations on the file. includeComponentDetails: name: includeDetails in: query diff --git a/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/redactmanager.yaml b/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/redactmanager.yaml index 442d7ce7a..f812f2001 100644 --- a/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/redactmanager.yaml +++ b/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/redactmanager.yaml @@ -1360,8 +1360,8 @@ components: overwriting a file: - `true`: The system keeps the manual changes on re-uploading (overwriting) the file. - `false` (default): Manual changes get discarded on re-uploading the file. - disableAutomaticRedaction: - name: disableAutomaticRedaction + disableAutomaticAnalysis: + name: disableAutomaticAnalysis in: query required: false schema: @@ -1370,7 +1370,7 @@ components: style: form explode: true description: | - A toggle to disable automatic redactions, i.e., to just upload and process the file without applying any automatic redactions: + A toggle to disable automatic analysis, i.e., to just upload and process the file without applying any automatic redactions: - `true`: The system does not apply any automatic redactions on the file. However, if the file contains redaction annotations, they are still imported. - `false` (default): The system applies automatic redactions on the file. downloadId: