RedactManager API Specs for BASF - Fixed missing property, fields and examples

* Added missing userId property definition * Added dossierCount to DossierStatusDefinition schema * Added IMAGE value to type enum of DossierAttributeDefinition schema * Added missing dossierAttributes to examples of the Dossier and DossierList schemas * Fixed examples of fileAttributes in FileStatus and FileStatusList schemas
2024-05-28 18:08:08 +02:00 · 2024-05-28 18:08:08 +02:00 · f3758fb003
commit f3758fb003
parent 00a1cadb83
2 changed files with 108 additions and 18 deletions
--- 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
@ -1816,6 +1816,16 @@ components:
      style: simple
      explode: false
      description: The identifier for the file to download.
+    userId:
+      name: userId
+      in: path
+      required: true
+      schema:
+        type: string
+        format: uuid
+      style: simple
+      explode: false
+      description: The identifier of a user
    username:
      name: username
      in: query
@ -2167,6 +2177,13 @@ components:
            - Yellow is `#ffda05`
            - Green is `#5eb160`
          example: "#5eb160"
+        dossierCount:
+          format: int32
+          type: integer
+          description: |
+            The number of dossiers in this status.
+          default: 0
+          example: 42
      required:
        - name
        - rank
@ -2194,6 +2211,7 @@ components:
            - TEXT
            - NUMBER
            - DATE
+            - IMAGE
          description: |
            Determines the type of the dossier attribute's value. Please note that currently the system
            does not validate the values against this definition. This is just a hint for a user interface
@ -2201,6 +2219,7 @@ components:
            - `TEXT`: The value is just a string, i.e., any sequence of characters.
            - `NUMBER`: The value is a string expressing a number, with or without decimals.
            - `DATE`: The value is a string expressing a date information.
+            - `IMAGE`: The value is a string representation of binary image, e.g. a BASE64 encoded image.
        reportingPlaceholder:
          type: string
          description: |
@ -2317,11 +2336,13 @@ components:
            description: "Dossiers with this status are currently being processed by the users."
            rank: 0
            color: "#ffda05"
+            dossierCount: 3
          - id: "23e45378-e90b-12d3-a456-765114174321"
            name: "Done"
            description: "Dossiers with this status should only contain approved files and indicate that the users have completed the component extraction."
            rank: 1
            color: "#5eb160"
+            dossierCount: 42
    DossierAttributeDefinitionList:
      type: object
      description: A list of dossier attribute definitions.
@ -2565,6 +2586,12 @@ components:
        dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
        watermarkId: null
        previewWatermarkId: null
+        dossierAttributes:
+          attributeIdToValue:
+            "1049a73c-8013-45d6-8217-0845a4ff1c61": This is a dossier attribute value
+            "79d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another dossier attribute value
+            "1d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+            "b337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
        downloadFileTypes:
          - ORIGINAL
          - PREVIEW
@ -2602,6 +2629,12 @@ components:
            dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
            watermarkId: null
            previewWatermarkId: null
+            dossierAttributes:
+              attributeIdToValue:
+                "1049a73c-8013-45d6-8217-0845a4ff1c61": This is a dossier attribute value
+                "79d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another dossier attribute value
+                "1d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+                "b337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
            downloadFileTypes:
              - ORIGINAL
              - PREVIEW
@ -2627,6 +2660,12 @@ components:
            dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
            watermarkId: null
            previewWatermarkId: null
+            dossierAttributes:
+              attributeIdToValue:
+                "1049a73c-8013-45d6-8217-0845a4ff1c61": This is a dossier attribute value
+                "79d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another dossier attribute value
+                "1d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+                "b337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
            downloadFileTypes:
              - ORIGINAL
              - PREVIEW
@ -3309,9 +3348,11 @@ components:
        numberOfAnalyses: 6
        filename: filename
        fileAttributes:
-          myFileAttribute: This is a file attribute value
-          yetAnotherFileAttribute: This is yet another file attribute value
-          numericValuesNeedToBeStrings: "1234"
+          attributeIdToValue:
+            "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
+            "59d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another file attribute value
+            "9d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+            "a337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
        lastOCRTime: 2000-01-23T04:56:07.000+00:00
        legalBasisVersion: 7
        excludedPages:
@ -3381,9 +3422,11 @@ components:
            numberOfAnalyses: 6
            filename: filename
            fileAttributes:
-              myFileAttribute: This is a file attribute value
-              yetAnotherFileAttribute: This is yet another file attribute value
-              numericValuesNeedToBeStrings: "1234"
+              attributeIdToValue:
+                "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
+                "59d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another file attribute value
+                "9d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+                "a337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
            lastOCRTime: 2000-01-23T04:56:07.000+00:00
            legalBasisVersion: 7
            excludedPages:
@ -3443,9 +3486,11 @@ components:
            numberOfAnalyses: 6
            filename: filename
            fileAttributes:
-              myFileAttribute: This is a file attribute value
-              yetAnotherFileAttribute: This is yet another file attribute value
-              numericValuesNeedToBeStrings: "1234"
+              attributeIdToValue:
+                "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
+                "59d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another file attribute value
+                "9d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+                "a337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
            lastOCRTime: 2000-01-23T04:56:07.000+00:00
            legalBasisVersion: 7
            excludedPages:
--- 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
@ -1302,6 +1302,16 @@ components:
      style: simple
      explode: false
      description: The identifier for the file to download.
+    userId:
+      name: userId
+      in: path
+      required: true
+      schema:
+        type: string
+        format: uuid
+      style: simple
+      explode: false
+      description: The identifier of a user
    username:
      name: username
      in: query
@ -1386,6 +1396,13 @@ components:
            - Yellow is `#ffda05`
            - Green is `#5eb160`
          example: "#5eb160"
+        dossierCount:
+          format: int32
+          type: integer
+          description: |
+            The number of dossiers in this status.
+          default: 0
+          example: 42
      required:
        - name
        - rank
@ -1413,6 +1430,7 @@ components:
            - TEXT
            - NUMBER
            - DATE
+            - IMAGE
          description: |
            Determines the type of the dossier attribute's value. Please note that currently the system
            does not validate the values against this definition. This is just a hint for a user interface
@ -1420,6 +1438,7 @@ components:
            - `TEXT`: The value is just a string, i.e., any sequence of characters.
            - `NUMBER`: The value is a string expressing a number, with or without decimals.
            - `DATE`: The value is a string expressing a date information.
+            - `IMAGE`: The value is a string representation of binary image, e.g. a BASE64 encoded image.
        reportingPlaceholder:
          type: string
          description: |
@ -1536,11 +1555,13 @@ components:
            description: "Dossiers with this status are currently being processed by the users."
            rank: 0
            color: "#ffda05"
+            dossierCount: 3
          - id: "23e45378-e90b-12d3-a456-765114174321"
            name: "Done"
            description: "Dossiers with this status should only contain approved files and indicate that the users have completed the redactions."
            rank: 1
            color: "#5eb160"
+            dossierCount: 42
    DossierAttributeDefinitionList:
      type: object
      description: A list of dossier attribute definitions.
@ -1781,6 +1802,12 @@ components:
        dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
        watermarkId: null
        previewWatermarkId: null
+        dossierAttributes:
+          attributeIdToValue:
+            "1049a73c-8013-45d6-8217-0845a4ff1c61": This is a dossier attribute value
+            "79d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another dossier attribute value
+            "1d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+            "b337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
        downloadFileTypes:
          - ORIGINAL
          - PREVIEW
@ -1818,6 +1845,12 @@ components:
            dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
            watermarkId: null
            previewWatermarkId: null
+            dossierAttributes:
+              attributeIdToValue:
+                "1049a73c-8013-45d6-8217-0845a4ff1c61": This is a dossier attribute value
+                "79d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another dossier attribute value
+                "1d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+                "b337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
            downloadFileTypes:
              - ORIGINAL
              - PREVIEW
@ -1843,6 +1876,12 @@ components:
            dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
            watermarkId: null
            previewWatermarkId: null
+            dossierAttributes:
+              attributeIdToValue:
+                "1049a73c-8013-45d6-8217-0845a4ff1c61": This is a dossier attribute value
+                "79d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another dossier attribute value
+                "1d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+                "b337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
            downloadFileTypes:
              - ORIGINAL
              - PREVIEW
@ -2442,9 +2481,11 @@ components:
        numberOfAnalyses: 6
        filename: filename
        fileAttributes:
-          myFileAttribute: This is a file attribute value
-          yetAnotherFileAttribute: This is yet another file attribute value
-          numericValuesNeedToBeStrings: "1234"
+          attributeIdToValue:
+            "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
+            "59d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another file attribute value
+            "9d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+            "a337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
        lastOCRTime: 2000-01-23T04:56:07.000+00:00
        legalBasisVersion: 7
        excludedPages:
@ -2514,9 +2555,11 @@ components:
            numberOfAnalyses: 6
            filename: filename
            fileAttributes:
-              myFileAttribute: This is a file attribute value
-              yetAnotherFileAttribute: This is yet another file attribute value
-              numericValuesNeedToBeStrings: "1234"
+              attributeIdToValue:
+                "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
+                "59d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another file attribute value
+                "9d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+                "a337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
            lastOCRTime: 2000-01-23T04:56:07.000+00:00
            legalBasisVersion: 7
            excludedPages:
@ -2576,9 +2619,11 @@ components:
            numberOfAnalyses: 6
            filename: filename
            fileAttributes:
-              myFileAttribute: This is a file attribute value
-              yetAnotherFileAttribute: This is yet another file attribute value
-              numericValuesNeedToBeStrings: "1234"
+              attributeIdToValue:
+                "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
+                "59d5a138-d30a-4014-ad7f-43ffba1f4d04": This is yet another file attribute value
+                "9d30d9e8-4a6c-4ef0-96a0-7bef62e138db": "1234"
+                "a337b65a-0481-48d9-92e6-79e34760ef01": "1. January 1337"
            lastOCRTime: 2000-01-23T04:56:07.000+00:00
            legalBasisVersion: 7
            excludedPages: