IQSS / IQSS/dataverse

Feature Request/Idea: Include dataverse ID and name in dataset JSON

Open
#9,479 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: API Type: Suggestion User Role: API User
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

Currently, when accessing the JSON representation of the dataset using its PID we get a JSON, which doesn't include any reference to the dataaverse the dataset is a part of:

https://dataverse.harvard.edu/api/datasets/:persistentId/?persistentId=doi:10.7910/DVN/TJCLKP

On the other hand, when using the Search API we get in the search result the identifier_of_dataverse and name_of_dataverse fields.

https://dataverse.harvard.edu/api/search?q=dsPersistentId:%22doi:10.7910/DVN/TJCLKP%22

What kind of user is the feature intended for?

API User

What inspired the request?

It seems logical to include a reference to the dataverse of the dataset when accessing the dataset JSON.

What existing behavior do you want changed?

I would like to have identifier_of_dataverse and name_of_dataverse fields included in the result of https://guides.dataverse.org/en/latest/api/native-api.html#get-json-representation-of-a-dataset similar to the search API results.

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 with the native API documentation and the dataset JSON endpoint shown in the issue, then compare its response with the Search API result. Add and verify the identifier_of_dataverse and name_of_dataverse fields in the dataset JSON response, using requests to both endpoints to confirm the expected output.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.