IQSS / IQSS/dataverse

Native API: ability to filter dataverse collection contents by type

Open
#10,747 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Overview of the Feature Request
Add a type parameter to the /api/dataverses/$ID/contents command (see https://guides.dataverse.org/en/latest/api/native-api.html#show-contents-of-a-dataverse-collection)

What kind of user is the feature intended for?
API User

What inspired the request?
Need to retrieve a list of the sub-collections of a dataverse collection (would spare the users from doing the filtering themselves after retrieval of the contents)

Any brand new behavior do you want to add to Dataverse?
Add a parameter to the dataverse collection endpoint (Native API)

parameter type description
type string Can be either “dataverse”, “dataset”, or “file”. Multiple “type” parameters can be used to include multiple types (i.e. type=dataset&type=file). If omitted, all types will be returned. For example, https://demo.dataverse.org/api/dataverse/root/contents?type=dataset.

Any open or closed issues related to this feature request?

Other issue on contents :

  • #7648

Are you thinking about creating a pull request for this feature?
Possibly, but not before the last trimester of 2024

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 for the /api/dataverses/$ID/contents endpoint and review related issue #7648. Trace the endpoint implementation and its tests, then support omitted, single, and repeated type parameters for dataverses, datasets, and files. Done means the endpoint returns only the requested content types while preserving all types when the parameter is omitted.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.