RedactManager API Specs for BASF - removed some DocuMine stuff

This commit is contained in:
Kresnadi Budisantoso 2024-04-29 17:48:18 +02:00
parent 0002f39707
commit 5a202904fd

View File

@ -1260,20 +1260,6 @@ components:
overwriting a file:
- `true`: The system keeps the manual changes on re-uploading (overwriting) the file.
- `false` (default): Manual changes get discarded on re-uploading the file.
includeComponentDetails:
name: includeDetails
in: query
required: false
schema:
default: false
type: boolean
style: form
explode: true
description: |
A toggle to decide whether to include detailed component information in the response:
- `true`: The component object's field `componentDetails` stores detailed information about the *source* of its
respective value(s).
- `false` (default): The component object does not contain a field `componentDetails`.
downloadId:
name: downloadId
in: path
@ -1326,81 +1312,6 @@ components:
entityRuleId: ABC.0.0
type: entity_type
page: 123
Component:
type: object
description: Represents a component with its associated values.
properties:
name:
type: string
description: The name of the component.
componentValues:
type: array
description: A list of value objects associated with the component.
items:
$ref: '#/components/schemas/ComponentValue'
example:
name: the component name
componentValues:
- value: my overwritten component value
originalValue: the original value
componentRuleId: COM.0.0
valueDescription: My value description
entityReferences:
- id: bcd22239-cedf-442f-a5a1-1664cba94dc6
entityRuleId: ABC.0.0
type: entity_type
page: 123
- id: bcd22239-c3df-442f-a5a1-1664cba94dc6_2
entityRuleId: ABC.0.0
type: entity_type
page: 124
- id: b748b89a-5679-4254-9286-1dd652d9970b
entityRuleId: DEF.13.37
type: another_entity_type
page: 456
- value: yet another component value
originalValue: yet another component value
componentRuleId: COM.0.1
valueDescription: Another value description
entityReferences:
- id: 70496456-a016-4679-81b1-6c8856dded6e
entityRuleId: XYZ.0.0
type: yet_another_entity_type
page: 123
ComponentValue:
type: object
description: Describes a value associated with a component, including its origin and related entities found in the document.
properties:
value:
type: string
description: The current value of the component.
originalValue:
type: string
description: The original value before any modifications.
componentRuleId:
type: string
description: Identifier for the rule associated with this component value.
valueDescription:
type: string
description: A brief description of the value.
entityReferences:
items:
$ref: '#/components/schemas/EntityReference'
type: array
example:
value: my overwritten component value
originalValue: the original value
componentRuleId: COM.0.0
valueDescription: My value description
entityReferences:
- id: bcd22239-cedf-442f-a5a1-1664cba94dc6
entityRuleId: ABC.0.0
type: entity_type
page: 123
- id: b748b89a-5679-4254-9286-1dd652d9970b
entityRuleId: DEF.13.37
type: another_entity_type
page: 456
DossierAttributeDefinition:
type: object
description: |