Edit Metadata API endpoint - support empty values#11273
Merged
ofahimIQSS merged 37 commits intodevelopfrom Mar 20, 2025
Merged
Conversation
This comment has been minimized.
This comment has been minimized.
…dator and updated error messages using Bundle.properties strings
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
86da8d6 to
77f94d0
Compare
This comment has been minimized.
This comment has been minimized.
…d dataset field types in DatasetFieldValidator
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Contributor
Author
|
@stevenwinship Thanks for the review. I just updated the JSON strings. |
This comment has been minimized.
This comment has been minimized.
1 similar comment
|
📦 Pushed preview images as 🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
stevenwinship
approved these changes
Mar 19, 2025
Contributor
|
tests passing in local - merging PR |
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.
What this PR does / why we need it:
Extended the Edit Metadata API endpoint:
sourceInternalVersionNumberoptional query parameter, which prevents inconsistencies by managing updates that may occur from other users while a dataset is being edited.A significant part of the changes involve refactoring the previous logic and addressing missing test coverage (Coveralls reports a +0.1% increase in coverage with these changes). Since I needed to modify the metadata validation logic and its update process, I first had to ensure that the underlying logic was both testable and extensible.
Which issue(s) this PR closes:
Special notes for your reviewer:
I have identified some areas for improvement in the field validation. For example, as mentioned in my original message on Slack:
It looks like the API currently allows editing multiple fields in a dataset's metadata by setting empty values (e.g. ["", ""]) (https://github.com/IQSS/dataverse/blob/develop/src/main/java/edu/harvard/iq/dataverse/api/Datasets.java#L1188), since the only check performed is that the list is not empty ([]). However, in the case of single fields, it ensures that the string is not empty (https://github.com/IQSS/dataverse/blob/develop/src/main/java/edu/harvard/iq/dataverse/api/Datasets.java#L1191).
Is this intended behavior? Or should the API also check that the values in the list are not empty? This will change in the context of #11243, but I’d like to clarify the current expected behavior.
Finally, I have decided not to implement any changes to the validation logic aside from those necessary for field removal, in order to avoid overextending the scope of this PR and further delaying it. I am willing to create separate issues to apply the enhancements in the future if necessary.
Suggestions on how to test this:
Follow the updated docs for Edit Metadata API endpoint.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No
Is there a release notes update needed for this change?:
Yes, attached.
Additional documentation:
None