Discuss impact of 'compactArrays' in JsonLD

International-Data-Spaces-Association / ids-specification

The Dataspace Protocol is a set of specifications designed to facilitate interoperable data sharing between entities governed by usage control and based on Web technologies. These specifications define the schemas and protocols required for entities to publish data, negotiate Agreements, and access data in a data space

https://docs.internationaldataspaces.org/dataspace-protocol/

Apache License 2.0

26 stars 14 forks source link

Discuss impact of 'compactArrays' in JsonLD #125

Closed matgnt closed 10 months ago

matgnt commented 1 year ago

I learned arrays with only 1 element can automatically be processed by the jsonld libs into single objects. jsonld: https://www.w3.org/TR/json-ld-api/#the-jsonldoptions-type

Also discussed in EDC here: https://github.com/eclipse-edc/Connector/issues/3232 and answered there: https://github.com/eclipse-edc/Connector/issues/3137#issuecomment-1572028156

This is also relevant for what we discussed here already regarding policy property: https://github.com/International-Data-Spaces-Association/ids-specification/issues/76

Questions are:

is this desired behavior?
what is the effect on provided schemas?

-- Matthias Binzer

matgnt commented 1 year ago

Decision in the meeting today:

jsonld serialization in compact form, with compactArrays=False (meaning, arrays are arrays also with only a single element) https://www.w3.org/TR/json-ld-api/#the-jsonldoptions-type
required profiling jsonld, needs to be a separate section
also move other profile things (odrl target, etc) into this new profile section (which is in catalog right now)

Also note:

a property that has not a value it is not included in the message (MUST). empty array means no value, means not included.

sebbader-sap commented 1 year ago

(Comment moved to https://github.com/International-Data-Spaces-Association/ids-specification/issues/132)

matgnt commented 12 months ago

Just because I did some tests with the timestamps, I also tested compactArray with main python library pyld (2.0.3). Unfortunately it seems there is a 5 years old bug in it - not a good indication regarding quality of the library, but anyway, seems there is a problem. It can be worked around, but just to collect library compatibility issues here with profiling ideas. Reference: https://github.com/digitalbazaar/pyld/issues/61