Add json-ld serialization examples #355
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
goneall
approved these changes
May 26, 2023
There was a problem hiding this comment.
Agree with having these examples - it would help with the discussions.
Thanks @armintaenzertng
|
I added an explanation of the general way json-ld (and in extension maybe even json) works to alleviate some fears of getting in contact with it. |
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
armintaenzertng
force-pushed
the
add_jsonld_examples
branch
from
3aaba19
to
6c0f4fa
Compare
kestewart
approved these changes
May 31, 2023
sbarnum
reviewed
May 31, 2023
| "name": "documentName", | ||
| "comment": "documentComment", | ||
| "elements": [ | ||
| "https://some.namespace#SPDXRef-DOCUMENT", |
There was a problem hiding this comment.
This line is self-referential and does not really make sense.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As there seems to be some confusion around how json-ld would actually look like, this is an attempt to provide a place for examples on which further discussions can be based.
I'm not sure where the most interest lies, so please tell me which use cases you would like to see further examples on! :)
Validation of json-ld would be performed against a separate SHACL file generated from the specification. This will be automatically added and kept up-to-date once #344 is merged.
Work is also underway to generate a json-schema that will validate json-ld output.
There is still the hope that the json-ld serialization works fine for everyone so that we don't have to invent a separate json (non-json-ld) serialization. If you have any concerns about this, please speak up!
(For clarification: A "json serialization" will not be json-ld in its expanded form, i.e. with the
@contextused to expand all values to their full URIs).Current drawbacks:
context.jsonneeds some touch-up, therefore the@contexturl is currently unreachable. This will be fixed soon.