Marmelator/persistence-service
1
0
Fork 0
Code Issues Pull Requests 17 Actions Packages Projects Releases 1.1k Wiki Activity

RED-10081: Update RM API specs after adding new download file type

Browse Source
This commit is contained in:
maverickstuder 2024-09-20 09:35:28 +02:00
parent c6110a6d65
commit 68937f298b
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/redactmanager.yaml
View File

@ -2171,7 +2171,7 @@ components:
Specifies the types of files that will part of the created download package. The defaults can be defined in the dossier template Specifies the types of files that will part of the created download package. The defaults can be defined in the dossier template
and can be overwritten individually on each download. and can be overwritten individually on each download.
RedactManager supports `ORIGINAL`, `PREVIEW`, `DELTA_PREVIEW`, and `REDACTED`: RedactManager supports `ORIGINAL`, `PREVIEW`, `OPTIMIZED_PREVIEW`, `DELTA_PREVIEW`, and `REDACTED`:
- `ORIGINAL` Contrary to intuition, this is not the uploaded file, but the pre-processed, - `ORIGINAL` Contrary to intuition, this is not the uploaded file, but the pre-processed,
optimized PDF, which may also contain the OCR results. optimized PDF, which may also contain the OCR results.
@ -2180,6 +2180,8 @@ components:
system. Note that the content to redact is actually still present and readable. system. Note that the content to redact is actually still present and readable.
The redaction information is embedded so you can restore the redactions when uploading the The redaction information is embedded so you can restore the redactions when uploading the
`PREVIEW` PDF into RedactManager. `PREVIEW` PDF into RedactManager.
- `OPTIMIZED_PREVIEW` The optimization process removes bookmarks and links in the document.
Other than that, this is the same as the Preview PDF.
- `DELTA_PREVIEW` Shows changes if redactions were imported (e.g., by uploading a Preview PDF - `DELTA_PREVIEW` Shows changes if redactions were imported (e.g., by uploading a Preview PDF
with redaction annotations): with redaction annotations):
Unchanged imported redactions are highlighted in green, removed imported redactions are Unchanged imported redactions are highlighted in green, removed imported redactions are
@ -2190,6 +2192,7 @@ components:
enum: enum:
- ORIGINAL - ORIGINAL
- PREVIEW - PREVIEW
- OPTIMIZED_PREVIEW
- DELTA_PREVIEW - DELTA_PREVIEW
- REDACTED - REDACTED
type: string type: string