Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit Metadata API endpoint - support empty values #11273

Draft
wants to merge 31 commits into
base: develop
Choose a base branch
from

Conversation

GPortas
Copy link
Contributor

@GPortas GPortas commented Feb 19, 2025

What this PR does / why we need it:

Extended the Edit Metadata API endpoint:

  • This endpoint now allows removing fields (by sending empty values), as long as they are not required by the dataset.
  • New sourceInternalVersionNumber optional 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

This comment has been minimized.

This comment has been minimized.

1 similar comment

This comment has been minimized.

@GPortas GPortas force-pushed the 11243-editmetadata-api-empty-values branch from 86da8d6 to 77f94d0 Compare February 19, 2025 14:04

This comment has been minimized.

…d dataset field types in DatasetFieldValidator

This comment has been minimized.

@coveralls
Copy link

coveralls commented Feb 21, 2025

Coverage Status

coverage: 22.868% (+0.1%) from 22.727%
when pulling 96d84c8 on 11243-editmetadata-api-empty-values
into 9e01018 on develop.

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.

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.

2 similar comments

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.

1 similar comment
Copy link

github-actions bot commented Mar 2, 2025

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11243-editmetadata-api-empty-values
ghcr.io/gdcc/configbaker:11243-editmetadata-api-empty-values

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Edit Metadata API endpoint - not allowing empty values
2 participants