IQSS / IQSS/dataverse

Feature Request: Range header for (partial) dataset download

Open
#10,934 1 comment 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

The Data Access API supports a range header to request specific parts of a file to download, which is useful for many applications. Having this type of feature for both downloading entire and custom bundles of a dataset would be a great. According to @pdurbin this is currently not available (see Zulip chat).

What kind of user is the feature intended for?

API User

What inspired the request?

Development of a resume function for data file downloads in rust-dataverse.

Any brand new behavior do you want to add to Dataverse?

Expand range header support for entire and partial dataset downloads.

Are you thinking about creating a pull request for this feature?

I could try, but I am novice when it comes to Java yet open to learn more about the DV source 🙌

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 Data Access API documentation linked in the issue and inspect the existing range-header handling for file downloads. Trace the endpoints for entire and custom-bundle dataset downloads, then determine how support should extend to both; done means API users can request partial dataset downloads for both forms, including the resume-download use case.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.