IQSS / IQSS/dataverse

Add "profile" parameter to JSON-LD exporters

Open
#11,151 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Size: 3
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

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...

... 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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing issue #11045 and the linked external exporter pull requests, then locate the internal OAI_ORE and Schema.org JSON-LD exporters. Determine appropriate profile URLs for both exporters and how getMediaType() should expose them. Done means the exporters, a future API changelog, and metadata export guidance document the backward-incompatible profile parameter.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.