Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "profile" parameter to JSON-LD exporters #11151

Open
pdurbin opened this issue Jan 13, 2025 · 2 comments
Open

Add "profile" parameter to JSON-LD exporters #11151

pdurbin opened this issue Jan 13, 2025 · 2 comments
Labels
Size: 3 A percentage of a sprint. 2.1 hours.

Comments

@pdurbin
Copy link
Member

pdurbin commented Jan 13, 2025

As we worked on #11045 we learned that we can disambiguate JSON-LD exporters by adding a "profile" parameter.

I've already created these pull requests to update external exporters:

For this issue I'm suggesting that we update the internal JSON-LD exporters...

  • OAI_ORE FIXME: put "profile" URL(s) here
  • schema.org (Schema.org JSON-LD) FIXME: put "profile" URL(s) here

... assuming there is an appropriate "profile" we can add (see FIXMEs above). As this is a backward-incompatible change, it should be documented in a future version of https://guides.dataverse.org/en/6.5/api/changelog.html.

In addition, we should update a future version of https://guides.dataverse.org/en/6.5/developers/metadataexport.html to provide some guidance on how the getMediaType() method can be used to assert the "profile" of JSON-LD exporters.

@pdurbin pdurbin added the Size: 3 A percentage of a sprint. 2.1 hours. label Jan 13, 2025
@pdurbin
Copy link
Member Author

pdurbin commented Jan 13, 2025

OAI_ORE FIXME: put "profile" URL(s) here

@stain hi! I was just looking at https://www.openarchives.org/ore/0.9/jsonld (you're listed first as one of the spec editors!) via https://www.openarchives.org/ore/ hoping to quickly find what JSON-LD "profile" parameter we should add to the media type for our OAI-ORE exporter. Is it http://www.openarchives.org/ore/terms/ perhaps? Help! 😅

The goal, as we talked about last week, when you presented Signposting to the Croissant working group, is to use the "profile" parameter to allow client to differentiate between various JSON-LD formats. Thanks!

@pdurbin
Copy link
Member Author

pdurbin commented Jan 16, 2025

schema.org (Schema.org JSON-LD) FIXME: put "profile" URL(s) here

@benjelloun hi! In the Croissant meeting the other day we said the "profile" we should use for Croissant is http://mlcommons.org/croissant/1.0 . What about for the original Schema.org JSON-LD format we've been using for Google Dataset Search? (The format we used until Croissant came along, I mean.) Do you know what the "profile" should be? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: 3 A percentage of a sprint. 2.1 hours.
Projects
None yet
Development

No branches or pull requests

1 participant