IQSS / dataverse

Open source research data repository software
http://dataverse.org
Other
876 stars 484 forks source link

Feature Request: Need documentation on `forceReplace` parameter in the Native API #10783

Open kuhlaid opened 3 weeks ago

kuhlaid commented 3 weeks ago

Please outline in the documentation what the purpose of the forceReplace parameter is for adding files to a dataset (https://guides.dataverse.org/en/6.3/api/native-api.html#replacing-files), and whether it serves any purpose.

qqmyers commented 3 weeks ago

Sounds like a good thing to add. If I recall, you can't replace a file with one that has a different Mimetype unless you use the forceReplace=true. (That should be confirmed before someone just updates the guides :-) ) FWIW - I see it is documented in https://guides.dataverse.org/en/6.3/developers/s3-direct-upload-api.html#replacing-an-existing-file-in-the-dataset.

kuhlaid commented 3 weeks ago

One of the problems with the API documentation is a lack of parameter definitions for each endpoint. If the forceReplace parameter for the S3 endpoint is the same as that for the Native API endpoints then that should be specified in the documentation. I don't even know if the Mimetype is a valid parameter for adding a file to a dataset.