IQSS / IQSS/dataverse

Feature Request: API endpoint to extract ZIP files

Open
#10,723 0 comments 1 reaction 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

UC Berkeley would like an endpoint that would superusers to process uploaded ZIP files that were not extracted on their initial upload.

What kind of user is the feature intended for?

Superuser, Sysadmin

What inspired the request?

  • At Berkeley, we're still using file-backed storage and the Native API to upload files using DVUploader.
    • For some large files, we need to use a workaround to send a temporary "placeholder" ZIP file which is then replaced by moving a the correct file in the storage location and updating the corresponding row in the database.
  • ZIP files added to Dataverse in this way won't be extracted. This is also true for ZIP files uploaded using the Direct Upload method (see Zulip thread).
  • However, some other file types, e.g. tabular data, can be reprocessed/reingested by calling an API endpoint.

What existing behavior do you want changed?

n/a

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

Any open or closed issues related to this feature request?

#10148

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

Not at this point.

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 comparing the existing Reingest a File, Redetect File Type, and Extract NcML Native API endpoints described in the API guide, then review related issue #10148. Done means a documented endpoint lets an authorized superuser or sysadmin start extraction for an uploaded ZIP file that was not extracted initially.

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
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.