Expose Collection guestbookRoot setting through API by stevenwinship · Pull Request #12611 · IQSS/dataverse

stevenwinship · 2026-08-13T18:45:48Z

What this PR does / why we need it: SPA needs the ability to view and modify the "guestbookRoot" setting of a Collection

Which issue(s) this PR closes:#12459

Closes Expose Collection guestbookRoot setting through API #12459

Special notes for your reviewer:

Suggestions on how to test this:See DatasetsIT. Make call to create/update dataverse and verify the setting.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:included

Additional documentation:

https://dataverse-guide--12611.org.readthedocs.build/en/12611/api/native-api.html#create-a-dataverse-collection

coveralls · 2026-08-13T18:56:50Z

Coverage is 25.291% — 12450-expose-collection-guestbook-root-setting into develop. No base build found for develop.

github-actions · 2026-08-13T19:35:42Z

Test Results

405 tests +1 390 ✅ +1 25m 24s ⏱️ - 8m 9s
55 suites ±0 15 💤 ±0
55 files ±0 0 ❌ ±0

Results for commit a01ccfa. ± Comparison against base commit 2a71d2d.

♻️ This comment has been updated with latest results.

rtreacy · 2026-08-24T18:14:33Z

Review follow-up summary

Reviewed this PR and worked through the follow-ups for @stevenwinship — everything's now resolved:

Create-path test coverage (was missing): added testCreateDataverseWithGuestbookRoot in DataversesIT covering POST /api/dataverses both with guestbookRoot omitted (defaults false) and explicitly set to true — e0ba0d4c0b.
Duplicate mutation path (non-blocking note): flagged that guestbookRoot can now be set via both the existing UpdateDataverseGuestbookRootCommand (JSF guestbook page) and the new generic UpdateDataverseCommand DTO path (API). Not a bug — both just require EditDataverse and do a plain save — but worth keeping in mind if either path grows extra validation later.
SonarCloud quality gate (was failing at 68.8% new-code coverage, required ≥80%): added unit-test coverage for the new guestbookRoot branches in JsonParser (both the create-path parseDataverse and the DTO parseDataverseDTO, including the previously-untested "key absent" branch), JsonPrinter, and a new UpdateDataverseCommandTest covering both branches of updateDataverseFromDTO's guestbookRoot handling — 035065be4b, 190639ddbf.

All CI checks are now green, including the SonarCloud quality gate, and both review threads are marked resolved.

The only thing outstanding for merge is an approving review — this PR currently has no approvals (my review was comment-only) and no reviewers requested.

pdurbin · 2026-08-24T18:43:28Z

+  "datasetFileCountLimit": 10,
+  "guestbookRoot": false


These should be documented in doc/sphinx-guides/source/api/native-api.rst

added documentation

https://dataverse-guide--12611.org.readthedocs.build/en/12611/api/native-api.html#create-a-dataverse-collection looks much better. Thanks!

rtreacy

Documentation added

Covers POST /api/dataverses defaulting guestbookRoot to false when omitted, and setting it to true when included in the request body. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Covers the new guestbookRoot branches in JsonParser.parseDataverse, JsonParser.parseDataverseDTO, and JsonPrinter.json(Dataverse) with unit-test assertions, to close the SonarCloud new-code coverage gap left by the IT-only test. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

- JsonParserTest: cover the containsKey("guestbookRoot") false branch in parseDataverseDTO, which was previously only exercised with the key present. - UpdateDataverseCommandTest: new unit test covering both branches of updateDataverseFromDTO's guestbookRoot handling (set vs. left unchanged), previously only covered indirectly by an IT test. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

sonarqubecloud · 2026-09-01T13:10:15Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2026-09-01T13:26:51Z

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:12450-expose-collection-guestbook-root-setting

ghcr.io/gdcc/configbaker:12450-expose-collection-guestbook-root-setting

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

Docs fixed in https://dataverse-guide--12611.org.readthedocs.build/en/12611/api/native-api.html#create-a-dataverse-collection

stevenwinship self-assigned this Aug 13, 2026

github-actions Bot added Feature: Guestbook FY27 Sprint 4 FY27 Sprint 4 (2026-08-12 - 2026-08-26) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA labels Aug 13, 2026

stevenwinship added this to IQSS Dataverse Project Aug 13, 2026

stevenwinship moved this to In Progress 💻 in IQSS Dataverse Project Aug 13, 2026

stevenwinship added this to the 6.12 milestone Aug 13, 2026

This comment has been minimized.

Sign in to view

stevenwinship moved this from In Progress 💻 to Ready for Review ⏩ in IQSS Dataverse Project Aug 13, 2026

stevenwinship removed their assignment Aug 13, 2026

stevenwinship force-pushed the 12450-expose-collection-guestbook-root-setting branch from 92713c8 to b707c45 Compare August 14, 2026 19:13

This comment has been minimized.

Sign in to view

rtreacy self-assigned this Aug 24, 2026

rtreacy moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Aug 24, 2026

rtreacy reviewed Aug 24, 2026

View reviewed changes

Comment thread src/main/java/edu/harvard/iq/dataverse/util/json/JsonParser.java

Comment thread src/main/java/edu/harvard/iq/dataverse/engine/command/impl/UpdateDataverseCommand.java

This comment has been minimized.

Sign in to view

pdurbin previously requested changes Aug 24, 2026

View reviewed changes

rtreacy removed their assignment Aug 24, 2026

rtreacy moved this from In Review 🔎 to Ready for Review ⏩ in IQSS Dataverse Project Aug 24, 2026

cmbz added the FY27 Sprint 5 FY27 Sprint 5 (2026-08-26 - 2026-09-09) label Aug 26, 2026

stevenwinship force-pushed the 12450-expose-collection-guestbook-root-setting branch from 190639d to d1e87c6 Compare August 31, 2026 13:03

rtreacy self-assigned this Aug 31, 2026

rtreacy approved these changes Aug 31, 2026

View reviewed changes

rtreacy moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Aug 31, 2026

This comment has been minimized.

Sign in to view

rtreacy moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Aug 31, 2026

rtreacy removed their assignment Aug 31, 2026

rtreacy moved this from Ready for QA ⏩ to In Review 🔎 in IQSS Dataverse Project Aug 31, 2026

This comment has been minimized.

Sign in to view

rtreacy moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Aug 31, 2026

rtreacy removed this from IQSS Dataverse Project Aug 31, 2026

stevenwinship and others added 8 commits September 1, 2026 08:59

Expose Collection guestbookRoot setting through API

bd0d7c6

remove logger line

e733122

fix style

9f68829

add unit test for code coverage

93174bd

Add IT test for guestbookRoot on the dataverse create path

25606e6

Covers POST /api/dataverses defaulting guestbookRoot to false when omitted, and setting it to true when included in the request body. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

update docs

a01ccfa

stevenwinship force-pushed the 12450-expose-collection-guestbook-root-setting branch from 75ff1f9 to a01ccfa Compare September 1, 2026 12:59

stevenwinship added this to IQSS Dataverse Project Sep 1, 2026

stevenwinship moved this to Ready for QA ⏩ in IQSS Dataverse Project Sep 1, 2026

jp-tosca self-assigned this Sep 1, 2026

pdurbin moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Sep 1, 2026

Uh oh!

Conversation

stevenwinship commented Aug 13, 2026 • edited by pdurbin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Aug 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

github-actions Bot commented Aug 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rtreacy commented Aug 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review follow-up summary

Uh oh!

pdurbin Aug 24, 2026

Choose a reason for hiding this comment

Uh oh!

stevenwinship Aug 31, 2026

Choose a reason for hiding this comment

Uh oh!

pdurbin Sep 1, 2026

Choose a reason for hiding this comment

Uh oh!

rtreacy left a comment

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

sonarqubecloud Bot commented Sep 1, 2026

Quality Gate passed

Uh oh!

github-actions Bot commented Sep 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

stevenwinship commented Aug 13, 2026 •

edited by pdurbin

Loading

coveralls commented Aug 13, 2026 •

edited

Loading

github-actions Bot commented Aug 13, 2026 •

edited

Loading

rtreacy commented Aug 24, 2026 •

edited

Loading