Incorrect curl Example in Documentation Causes UI Fields to Disappear #11228
Labels
Type: Bug
a defect
Comments
|
Looks like it is a bug that the license info disappears if there are no entries for any of the listed summary fields. I also noticed an inconvenience that the setting doesn't handle spaces after commas. Overall though, I think if you consider description and subject to be vital, you should add them to your list. The docs do say what the default is. I'll go ahead with a fix for the bug that removes the License field and support commas. If anyone thinks we should enforce a minimum set of fields beyond that, we can consider options. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Issue Summary:
On the guide CustomDatasetSummaryFields, the provided curl command example leads to unintended behavior. When executed, critical dataset fields such as Description, Subject, and License Agreement disappear from the UI on the dataset page.
Steps to Reproduce:
Navigate to the guide section: CustomDatasetSummaryFields. https://guides.dataverse.org/en/6.5/installation/config.html#customdatasetsummaryfields
Follow the provided curl command example:
curl http://localhost:8080/api/admin/settings/:CustomDatasetSummaryFields -X PUT -d 'producer,subtitle,alternativeTitle'
Refresh the dataset page.
Observe that fields like Description, Subject, and License Agreement are no longer visible on the UI.
Expected Behavior:
The curl command should only modify the fields displayed above the files table without removing critical dataset metadata (e.g., Description, Subject, License Agreement).
Actual Behavior:
Running the command results in the disappearance of essential dataset fields from the UI.
The text was updated successfully, but these errors were encountered: