IQSS / IQSS/dataverse

OAI_ORE exporter media type should be application/ld+json

Open Beginner friendly
#11,580 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Metadata good first issue Mentor: pdurbin
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

From https://dataverse.harvard.edu/api/info/exportFormats it's hard to tell which formats are based on JSON-LD. Only one of three (schema.org) is clearly application/ld+json:

{
  "status": "OK",
  "data": {
    "OAI_ORE": {
      "displayName": "OAI_ORE",
      "mediaType": "application/json",
      "isHarvestable": false,
      "isVisibleInUserInterface": true
    },
...
    "schema.org": {
      "displayName": "Schema.org JSON-LD",
      "mediaType": "application/ld+json",
      "isHarvestable": false,
      "isVisibleInUserInterface": true
    },
...
    "croissant": {
      "displayName": "Croissant",
      "mediaType": "application/json",
      "isHarvestable": false,
      "isVisibleInUserInterface": true
    },
...
}

For croissant I opened this pull request (it also adds a profile, like this: application/ld+json; profile="http://mlcommons.org/croissant/1.0"):

Should we make a similar change for OAI_ORE? The spec at https://www.openarchives.org/ore/0.9/jsonld seems to prefer application/ld+json:

Image

As a side note, it might be interesting to show which formats are based on Schema.org.

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 at the /api/info/exportFormats entry point and trace the OAI_ORE format definition. Confirm the OAI ORE specification's preferred media type, update the reported value to application/ld+json, and verify that the endpoint output identifies OAI_ORE accordingly.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.