Merged
Conversation
ISSUE-37: Remove sword
There was a problem hiding this comment.
Pull request overview
This PR updates the Dataverse Java client to version v2.0.0 by removing the legacy SWORD-based upload path and standardizing on Dataverse’s native file upload API, along with related dependency/import cleanups and migration documentation.
Changes:
- Remove SWORD upload support (deleted
FileUploader, removeduploadFile()API surface, updated package diagram/docs). - Update code/tests to use native upload (
uploadNativeFile(...)) and switch Apache Commons imports tocommons-lang3. - Bump project version to
v2.0.0, update dependencies, and add a V1→V2 migration guide + changelog entry.
Reviewed changes
Copilot reviewed 15 out of 17 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/test/java/com/researchspace/dataverse/entities/facade/DatasetBuilderTest.java | Whitespace-only cleanup in test output line. |
| src/main/java/com/researchspace/dataverse/sword/FileUploader.java | Removed SWORD uploader implementation. |
| src/main/java/com/researchspace/dataverse/spring/config/PackageOrganization.java | Updated package diagram to remove SWORD-related components. |
| src/main/java/com/researchspace/dataverse/http/SearchURLBuilder.java | Switch StringUtils.isEmpty import to commons-lang3. |
| src/main/java/com/researchspace/dataverse/http/DataverseOperationsImplV1.java | Remove SWORD upload methods; tidy imports; keep native upload methods. |
| src/main/java/com/researchspace/dataverse/http/AbstractOpsImplV1.java | Switch StringUtils import to commons-lang3. |
| src/main/java/com/researchspace/dataverse/entities/facade/DatasetBuilder.java | Switch StringUtils.isEmpty import to commons-lang3. |
| src/main/java/com/researchspace/dataverse/entities/Dataset.java | Javadoc tweak related to persistent identifier wording. |
| src/main/java/com/researchspace/dataverse/api/v1/DatasetOperations.java | Remove SWORD uploadFile() APIs; clarify native upload docs. |
| src/integration-test/java/com/researchspace/dataverse/http/InfoOperationsTest.java | Switch StringUtils import to commons-lang3. |
| src/integration-test/java/com/researchspace/dataverse/http/DataverseOperationsTest.java | Switch RandomStringUtils import to commons-lang3. |
| src/integration-test/java/com/researchspace/dataverse/http/DatasetOperationsTest.java | Update integration test to use native upload and adjust imports/deps. |
| build.gradle | Version bump to v2.0.0, dependency updates, remove SWORD deps, add commons-io test dep. |
| Readme.md | Document v2.0.0 SWORD removal and update Maven dependency version. |
| Migration_Guide_V1_to_V2.md | New migration guide describing breaking changes and replacement APIs. |
| Contributors.md | Add contributor entry. |
| CHANGELOG.md | Add 2.0.0 release notes including breaking change and dependency updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR from forked repo: rspace-os#1
Removes SWORD dependency and non-native upload methods, as raised in #37.
Bumps version number to 2.0.0, as this will be a breaking change for unsuspecting users.