Merge branch 'RED-9782-apispec-fp' into 'master'

RED-9782 Updated DocuMine and RedactManager OpenAPI spec (forward port from release/2.465.x)

See merge request redactmanager/persistence-service!645
This commit is contained in:
Kresnadi Budisantoso 2024-09-10 17:55:53 +02:00
commit 979e6a6650
2 changed files with 28 additions and 0 deletions

View File

@ -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

View File

@ -565,6 +565,7 @@ paths:
- $ref: '#/components/parameters/dossierTemplateId'
- $ref: '#/components/parameters/dossierId'
- $ref: '#/components/parameters/keepManualChanges'
- $ref: '#/components/parameters/disableAutomaticAnalysis'
requestBody:
content:
multipart/form-data:
@ -1359,6 +1360,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 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:
name: downloadId
in: path