Feature Request: Need documentation on `forceReplace` parameter in the Native API
Open
Nobody has claimed this yet.
Type: Feature
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
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.
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
Start with the Native API documentation at the linked “replacing files” section and review how it currently describes the forceReplace parameter. Update the documentation to explain its purpose for adding files and state whether it has any practical use; done means both questions are answered accurately.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100