Custom Asset JSON-LD is a trap right now

[richardtreier]

Feature

Description

Our UiAsset has the properties additionalProperties, additionalJsonProperties, privateProperties and privateJsonProperties.

These properties are called "Json" but are JsonLd and affected by compaction and contraction, e.g. all propreties that aren't URLs disappear, strings become arrays, etc.

Any API consumer that wants to do anything "custom" such as a use case will stumble upon this

Acceptance Criteria

Proposed Solution

• Property String customJson
  • Will be put in the JSON-LD as `sovity:customJson: "{{JSON STRINGIFIED}}"
  • So it won't be affected by compaction / extraction / JSON-LD validation, etc.
  • This would be used by technical users who want to largely diverge from our UI's way of defining assets, and also don't care about JSON-LD as they are owning the data space they use.
• Property Map<String, String> customProperties
  • Simply easier access to all fields of "customJson" that are strings.
  • The above needs to be documented.
  • This is sort of easy access to custom data when you don't want to deal with JSON serialization / deserialization
  • Will be merged with customJson on persisting
  • Only string propreties get put in this map on reading sovity:customJson.
  • As above it is an easy entry for people to add custom fields and data to assets, e.g. realizing a use case within a data space.
• Property String customJsonLd
  • Should contain the remainder of the unhandled JSON-LD of the Asset JSON-LD (as the customJson above is just one field that we control)
  • Will be rocked by compaction / expansion
  • Is documented as JSON-LD so everybody who uses it has JSON-LD semantic parsing utilities ready
  • Useful for people who want to adhere to some JSON-LD standard that forces them to adhere to some ontology. However, support for this would be experimental.
  • More than anything this is a place to find out if something weird was set into the asset

Possible Implementation and Work Breakdown

Tasks

Beta Give feedback

1. Implement changes in UiAsset and UiAssetMapper
2. Adapt both the Connector UI and Broker UI #852
   component/edc-ui +1
   

[richardtreier]

Maybe related: sovity/edc-ui#545

[AbdullahMuk]

@richardtreier please fill in the acceptance criteria section. Also, feel free to hand over this action to Christophe.

[AbdullahMuk]

blocked by #852.

once #852 is resolved, we can close this issue.