Skip to content

feat: expose collection guestbook inheritance setting - #508

Draft
ChengShi-1 wants to merge 1 commit into
developfrom
505-collection-guestbook-root
Draft

ChengShi-1 wants to merge 1 commit into
developfrom
505-collection-guestbook-root

Conversation

@ChengShi-1

@ChengShi-1 ChengShi-1 commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:

Expose optional guestbookRoot through the existing getCollection, createCollection, and updateCollection use cases so consumers can read and persist the collection's guestbook inheritance setting. A partial update containing only { guestbookRoot: false } includes parent guestbooks; true stops inheritance. Omitted values remain omitted for older-server compatibility and leave the setting unchanged during updates.

Which issue(s) this PR closes:

Related Dataverse PRs:

Special notes for your reviewer:

This extends the collection model and DTO rather than adding separate endpoints or use cases. guestbookRoot is the inverse of the UI's "include guestbooks from parent collections" checkbox. The branch is based on develop and contains only this feature and its tests/documentation.

Suggestions on how to test this:

run:

npm run test:unit -- --runInBand test/unit/collections
npm run test:integration -- --runInBand test/integration/collections/CollectionsRepository.test.ts -t guestbookRoot
npm run test:functional -- --runInBand test/functional/collections/UpdateCollection.test.ts -t 'guestbook inheritance'

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

Added an entry under CHANGELOG.md

Additional documentation:

Updated docs/useCases.md for collection reads, creation, and partial updates, including the boolean semantics and required backend version.

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.

Use cases to get and set a collection's guestbookRoot (include guestbooks from parent)

1 participant