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

RedactManager API Specs for BASF - minor description fixes

Browse Source
This commit is contained in:
Kresnadi Budisantoso 2024-04-29 17:37:58 +02:00
parent a2daa60e79
commit 0002f39707
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,7 @@
openapi: 3.0.2
info:
title: RedactManager API - DRAFT
version: "4.1.0"
title: RedactManager API
version: "4.1.0-draft"
description: |
The RedactManager API provides a comprehensive solution for managing resources such as dossiers and their associated files.
Users can also retrieve the results package for files that have been processed by the system and reviewed by the users.
@ -338,7 +338,7 @@ paths:
operationId: setDossierAttributes
tags:
- 2. Dossiers
summary: (DRAFT) Update or set attributes for a specific dossier.
summary: Update or set attributes for a specific dossier.
description: |
This endpoint facilitates the updating or setting of specific dossier attributes for a given dossier.
Ensure you provide the necessary dossier attributes within the request body.
@ -374,7 +374,7 @@ paths:
operationId: prepareDossierDownload
tags:
- 2. Dossiers
summary: (DRAFT) Trigger the creation of a download package for all files of a dossier.
summary: Initiate the creation of a download package for all files of a dossier.
description: |
To download the results of a redaction, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for all
@ -581,7 +581,7 @@ paths:
operationId: prepareFileDownload
tags:
- 3. Files
summary: (DRAFT) Trigger the creation of a download package for a single file of a dossier.
summary: Initiate the creation of a download package for a single file of a dossier.
description: |
To download the results of a redaction, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for the
@ -665,7 +665,7 @@ paths:
operationId: prepareBulkDownload
tags:
- 3. Files
summary: (DRAFT) Trigger the creation of a download package for specific files within a dossier.
summary: Initiate the creation of a download package for specific files within a dossier.
description: |
To download the results of a redaction, a download package needs to be prepared. This endpoint
facilitates to define the content of the download package and to start the creation of it for
@ -866,7 +866,7 @@ paths:
tags:
- 5. Users
- tenant-user-management
summary: TODO
summary: Get a list of users
description: |
This endpoint facilitates to retrieve a list of known users.
@ -1633,7 +1633,7 @@ components:
- fb3463a0-7d6e-54a3-bcd8-1b93388c648d
DossierAttributes:
type: object
description: (DRAFT) Additional dossier attributes that can be set
description: Additional dossier attributes that can be set
properties:
attributeIdToValue:
additionalProperties: