Import API example in the guide needs improvement
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
I am experimenting with the import API and I use the provided example json.
http://guides.dataverse.org/en/latest/api/native-api.html#import-a-dataset-into-a-dataverse
First of all I need to use a 'resolvable' DOI otherwise import fails with
"Provided PID does not exist. Status code for GET 'https://doi.org/ZZ7/MOSEISLEYDB94' is 404."}
If I change the DOI to one that does resolve the import works, but I cannot add files to it:
"File upload via HTTP disabled since this dataset already contains a package file."
or on the UI
"HTTP upload is disabled for this dataset because you have already uploaded files via rsync. If you would like to switch to HTTP upload, please contact DataverseNL support."
This 'package file' use in the import example complicates things or at least needs some more explanation or references.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the native API guide section “Import a dataset into a Dataverse” and inspect the provided JSON example. Verify the DOI and package-file behavior described in the issue, then update the example’s explanation with the needed prerequisites or references. Done means a reader can understand why the example behaves this way and how to proceed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100