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 - Fixed missing property, fields and examples

Browse Source 
* 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
This commit is contained in:
Kresnadi Budisantoso 2024-05-28 18:08:08 +02:00
parent 00a1cadb83
commit f3758fb003
2 changed files with 108 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml
View File

@ -1816,6 +1816,16 @@ components:
style: simple style: simple
explode: false explode: false
description: The identifier for the file to download. 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: username:
name: username name: username
in: query in: query
@ -2167,6 +2177,13 @@ components:
- Yellow is `#ffda05` - Yellow is `#ffda05`
- Green is `#5eb160` - Green is `#5eb160`
example: "#5eb160" example: "#5eb160"
dossierCount:
format: int32
type: integer
description: |
The number of dossiers in this status.
default: 0
example: 42
required: required:
- name - name
- rank - rank
@ -2194,6 +2211,7 @@ components:
- TEXT - TEXT
- NUMBER - NUMBER
- DATE - DATE
- IMAGE
description: | description: |
Determines the type of the dossier attribute's value. Please note that currently the system 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 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. - `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. - `NUMBER`: The value is a string expressing a number, with or without decimals.
- `DATE`: The value is a string expressing a date information. - `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: reportingPlaceholder:
type: string type: string
description: | description: |
@ -2317,11 +2336,13 @@ components:
description: "Dossiers with this status are currently being processed by the users." description: "Dossiers with this status are currently being processed by the users."
rank: 0 rank: 0
color: "#ffda05" color: "#ffda05"
dossierCount: 3
- id: "23e45378-e90b-12d3-a456-765114174321" - id: "23e45378-e90b-12d3-a456-765114174321"
name: "Done" name: "Done"
description: "Dossiers with this status should only contain approved files and indicate that the users have completed the component extraction." description: "Dossiers with this status should only contain approved files and indicate that the users have completed the component extraction."
rank: 1 rank: 1
color: "#5eb160" color: "#5eb160"
dossierCount: 42
DossierAttributeDefinitionList: DossierAttributeDefinitionList:
type: object type: object
description: A list of dossier attribute definitions. description: A list of dossier attribute definitions.
@ -2565,6 +2586,12 @@ components:
dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548 dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
watermarkId: null watermarkId: null
previewWatermarkId: 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: downloadFileTypes:
- ORIGINAL - ORIGINAL
- PREVIEW - PREVIEW
@ -2602,6 +2629,12 @@ components:
dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548 dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
watermarkId: null watermarkId: null
previewWatermarkId: 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: downloadFileTypes:
- ORIGINAL - ORIGINAL
- PREVIEW - PREVIEW
@ -2627,6 +2660,12 @@ components:
dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548 dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
watermarkId: null watermarkId: null
previewWatermarkId: 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: downloadFileTypes:
- ORIGINAL - ORIGINAL
- PREVIEW - PREVIEW
@ -3309,9 +3348,11 @@ components:
numberOfAnalyses: 6 numberOfAnalyses: 6
filename: filename filename: filename
fileAttributes: fileAttributes:
myFileAttribute: This is a file attribute value attributeIdToValue:
yetAnotherFileAttribute: This is yet another file attribute value "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
numericValuesNeedToBeStrings: "1234" "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 lastOCRTime: 2000-01-23T04:56:07.000+00:00
legalBasisVersion: 7 legalBasisVersion: 7
excludedPages: excludedPages:
@ -3381,9 +3422,11 @@ components:
numberOfAnalyses: 6 numberOfAnalyses: 6
filename: filename filename: filename
fileAttributes: fileAttributes:
myFileAttribute: This is a file attribute value attributeIdToValue:
yetAnotherFileAttribute: This is yet another file attribute value "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
numericValuesNeedToBeStrings: "1234" "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 lastOCRTime: 2000-01-23T04:56:07.000+00:00
legalBasisVersion: 7 legalBasisVersion: 7
excludedPages: excludedPages:
@ -3443,9 +3486,11 @@ components:
numberOfAnalyses: 6 numberOfAnalyses: 6
filename: filename filename: filename
fileAttributes: fileAttributes:
myFileAttribute: This is a file attribute value attributeIdToValue:
yetAnotherFileAttribute: This is yet another file attribute value "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
numericValuesNeedToBeStrings: "1234" "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 lastOCRTime: 2000-01-23T04:56:07.000+00:00
legalBasisVersion: 7 legalBasisVersion: 7
excludedPages: excludedPages:

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

@ -1302,6 +1302,16 @@ components:
style: simple style: simple
explode: false explode: false
description: The identifier for the file to download. 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: username:
name: username name: username
in: query in: query
@ -1386,6 +1396,13 @@ components:
- Yellow is `#ffda05` - Yellow is `#ffda05`
- Green is `#5eb160` - Green is `#5eb160`
example: "#5eb160" example: "#5eb160"
dossierCount:
format: int32
type: integer
description: |
The number of dossiers in this status.
default: 0
example: 42
required: required:
- name - name
- rank - rank
@ -1413,6 +1430,7 @@ components:
- TEXT - TEXT
- NUMBER - NUMBER
- DATE - DATE
- IMAGE
description: | description: |
Determines the type of the dossier attribute's value. Please note that currently the system 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 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. - `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. - `NUMBER`: The value is a string expressing a number, with or without decimals.
- `DATE`: The value is a string expressing a date information. - `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: reportingPlaceholder:
type: string type: string
description: | description: |
@ -1536,11 +1555,13 @@ components:
description: "Dossiers with this status are currently being processed by the users." description: "Dossiers with this status are currently being processed by the users."
rank: 0 rank: 0
color: "#ffda05" color: "#ffda05"
dossierCount: 3
- id: "23e45378-e90b-12d3-a456-765114174321" - id: "23e45378-e90b-12d3-a456-765114174321"
name: "Done" name: "Done"
description: "Dossiers with this status should only contain approved files and indicate that the users have completed the redactions." description: "Dossiers with this status should only contain approved files and indicate that the users have completed the redactions."
rank: 1 rank: 1
color: "#5eb160" color: "#5eb160"
dossierCount: 42
DossierAttributeDefinitionList: DossierAttributeDefinitionList:
type: object type: object
description: A list of dossier attribute definitions. description: A list of dossier attribute definitions.
@ -1781,6 +1802,12 @@ components:
dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548 dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
watermarkId: null watermarkId: null
previewWatermarkId: 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: downloadFileTypes:
- ORIGINAL - ORIGINAL
- PREVIEW - PREVIEW
@ -1818,6 +1845,12 @@ components:
dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548 dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
watermarkId: null watermarkId: null
previewWatermarkId: 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: downloadFileTypes:
- ORIGINAL - ORIGINAL
- PREVIEW - PREVIEW
@ -1843,6 +1876,12 @@ components:
dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548 dossierStatusId: b8280985-f558-43c0-852a-a3fa86803548
watermarkId: null watermarkId: null
previewWatermarkId: 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: downloadFileTypes:
- ORIGINAL - ORIGINAL
- PREVIEW - PREVIEW
@ -2442,9 +2481,11 @@ components:
numberOfAnalyses: 6 numberOfAnalyses: 6
filename: filename filename: filename
fileAttributes: fileAttributes:
myFileAttribute: This is a file attribute value attributeIdToValue:
yetAnotherFileAttribute: This is yet another file attribute value "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
numericValuesNeedToBeStrings: "1234" "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 lastOCRTime: 2000-01-23T04:56:07.000+00:00
legalBasisVersion: 7 legalBasisVersion: 7
excludedPages: excludedPages:
@ -2514,9 +2555,11 @@ components:
numberOfAnalyses: 6 numberOfAnalyses: 6
filename: filename filename: filename
fileAttributes: fileAttributes:
myFileAttribute: This is a file attribute value attributeIdToValue:
yetAnotherFileAttribute: This is yet another file attribute value "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
numericValuesNeedToBeStrings: "1234" "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 lastOCRTime: 2000-01-23T04:56:07.000+00:00
legalBasisVersion: 7 legalBasisVersion: 7
excludedPages: excludedPages:
@ -2576,9 +2619,11 @@ components:
numberOfAnalyses: 6 numberOfAnalyses: 6
filename: filename filename: filename
fileAttributes: fileAttributes:
myFileAttribute: This is a file attribute value attributeIdToValue:
yetAnotherFileAttribute: This is yet another file attribute value "9049a73c-8013-45d6-8217-0845a4ff1c61": This is a file attribute value
numericValuesNeedToBeStrings: "1234" "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 lastOCRTime: 2000-01-23T04:56:07.000+00:00
legalBasisVersion: 7 legalBasisVersion: 7
excludedPages: excludedPages: