RedactManager API Specs for BASF - added some descriptions for download creation

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

@@ -106,7 +106,7 @@ paths:
         "500":
           $ref: '#/components/responses/500'
   /api/dossier-templates/{dossierTemplateId}/dossier-attribute-definitions:
-    get:
+    get: # TODO: review endpoint to get dossier attribute definitions
       summary: Returns the list of all existing dossier attribute definitions
       tags:
         - 1. Dossier Templates
@@ -125,9 +125,20 @@ paths:
                 $ref: '#/components/schemas/DossierAttributeDefinitionList'
           description: |
             Successfully returned the dossier attribute definitions for the specified dossier template.
-        # TODO: missing responses
+        "400":
+          $ref: '#/components/responses/400'
+        "401":
+          $ref: '#/components/responses/401'
+        "403":
+          $ref: '#/components/responses/403'
+        "404":
+          $ref: '#/components/responses/404-dossier-template'
+        "429":
+          $ref: '#/components/responses/429'
+        "500":
+          $ref: '#/components/responses/500'
   /api/dossier-templates/{dossierTemplateId}/file-attribute-definitions:
-    get:
+    get: # TODO: review endpoint to get file attribute definitions
       summary: Returns the list of all existing file attribute definitions
       tags:
         - 1. Dossier Templates
@@ -146,7 +157,18 @@ paths:
                 $ref: '#/components/schemas/FileAttributeDefinitionList'
           description: |
             Successfully returned the file attribute definitions for the specified dossier template.
-        # TODO: missing responses
+        "400":
+          $ref: '#/components/responses/400'
+        "401":
+          $ref: '#/components/responses/401'
+        "403":
+          $ref: '#/components/responses/403'
+        "404":
+          $ref: '#/components/responses/404-dossier-template'
+        "429":
+          $ref: '#/components/responses/429'
+        "500":
+          $ref: '#/components/responses/500'
   /api/dossier-templates/{dossierTemplateId}/dossiers:
     get:
       operationId: getDossiers
@@ -348,7 +370,13 @@ paths:
         - 3. Dossiers
       summary: (DRAFT) Trigger the creation of a download package for all files of a dossier.
       description: |
-      # TODO: add description for endpoint to prepare a download for all files of a dossier
+        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
+        files of the dossier. The response of this endpoint contains an identifier for the download that
+        is needed to query the status until the download package is prepared for download, and
+        finally to actually download the file once it is available.
+        
+        Note: The redacted file will be created for `APPROVED` files only.
       parameters:
         - $ref: '#/components/parameters/dossierTemplateId'
         - $ref: '#/components/parameters/dossierId'
@@ -549,7 +577,13 @@ paths:
         - 3. Files
       summary: (DRAFT) Trigger the creation of a download package for a single file of a dossier.
       description: |
-      # TODO: add description for endpoint to prepare a download of a single file
+        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
+        file. The response of this endpoint contains an identifier for the download that is needed to
+        query the status until the download package is prepared for download, and finally to actually 
+        download the file once it is available.
+        
+        Note: The redacted PDF will be created for `APPROVED` files only.
       parameters:
         - $ref: '#/components/parameters/dossierTemplateId'
         - $ref: '#/components/parameters/dossierId'
@@ -626,7 +660,13 @@ paths:
         - 3. Files
       summary: (DRAFT) Trigger the creation of a download package for specific files within a dossier.
       description: |
-      # TODO: add description for endpoint to prepare a bulk download of multiple files
+        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
+        multiple files of a dossier. The response of this endpoint contains an identifier for the download
+        that is needed to query the status until the download package is prepared for download, and finally
+        to actually download the file once it is available.
+        
+        Note: The redacted PDF will be created for `APPROVED` files only.
       parameters:
         - $ref: '#/components/parameters/dossierTemplateId'
         - $ref: '#/components/parameters/dossierId'