[Documentation] Document the existence of JSON-LD and what it means

[richardtreier]

Enhancement

Description

Document the existence of JSON-LD and its implications.

We want to warn users from underestimating JSON-LD:

• Compaction / Expansion
• Default @context within EDC APIs is a trap: All fields must be URLs
• Required semantic parsing and handling of the nested structures.
• We want to provide some stable way of interacting with things

Sources for information on JSON-LD:

• "Deep Dive API Wrapper.pptx"
• Create New Asset - Additional Properties Attribute edc-ui#545 (comment)
• https://github.com/sovity/PMO-Software/issues/368

Related to

• Custom Asset JSON-LD is a trap right now #679

Solution Proposal and Work Breakdown

Tasks

Beta Give feedback

1. [API Wrapper] Add introduction text to documentation #994
   3 of 3
   component/api-wrapper task/documentation +2
   
2. Add a generic "JSON-LD in the Eclipse EDC Management API documentation"
3. Check if numbers / floats / booleans even work. I believe they did not. Check if this is a bug or part of the JSON-LD Spec.

[AbdullahMuk]

Regarding the task Check if numbers / floats / booleans even work. I believe they did not. Check if this is a bug or part of the JSON-LD Spec. make it a separate task from this issue as this is not documentation anymore.