IQSS / IQSS/dataverse

Feature Request: show hierarchy of collections via API

Open
#12,533 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: API FY27: Collection Enhancements Size: 20 SPA Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

https://dataverse.harvard.edu/dataverse/airqualregs has a hierarchy of collections underneath it that looks something like this:

Image

However, you'd never discover this tree-like structure from looking by looking at the Dataverse UI. You see that there are 12 collections. That's it.

Image

The Dataverse API doesn't expose the hierarchy of collections either. It could be interesting to create an API for this. A UI can come later, in the new SPA.

I'll size this as a 20 for now.

p.s. The dataviz above comes from https://github.com/IQSS/dataverse/issues/5603#issuecomment-470993028 and https://github.com/IQSS/dataverse/issues/2155#issuecomment-1269189972

Some other conversations along there lines:

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 the existing collection API and the linked discussions about collection hierarchy and folder structure. Before implementation, define the API endpoint, response representation, and expected behavior for nested collections; done means the hierarchy can be retrieved programmatically without requiring a UI.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.