11914 set template default #11989

jp-tosca · 2025-11-18T17:26:34Z

What this PR does / why we need it:

Which issue(s) this PR closes:

Closes Add a new API to set a template as default #11914

Special notes for your reviewer:

Suggestions on how to test this:

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?:

Additional documentation:

…-default

Copilot

Pull Request Overview

This PR implements API endpoints to set and remove the default template for a dataverse collection, addressing issue #11914.

Key Changes:

Added POST /api/dataverses/{id}/templates/default/{templateId} endpoint to set a default template
Added DELETE /api/dataverses/{id}/templates/default endpoint to remove the default template
Added test coverage for the set default template endpoint with permission checks

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.

File	Description
`src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java`	Implements two new endpoints for setting and removing default templates
`src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java`	Adds helper methods `setDefaultTemplate()` and `removeDefaultTemplate()` for testing
`src/test/java/edu/harvard/iq/dataverse/api/DataversesIT.java`	Updates `testCreateAndGetTemplates()` to test setting default template with authorization checks
`doc/release-notes/11914-set-template-default-api.md`	Documents the new endpoints and their functionality

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

doc/release-notes/11914-set-template-default-api.md

src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java

doc/release-notes/11914-set-template-default-api.md

src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java

doc/release-notes/11914-set-template-default-api.md

src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java

…Command

…or removing default template

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-21T17:54:58Z

doc/release-notes/11914-set-template-default-api.md

+
+### Functionality
+- Sets the default template of the given dataverse collection.
+- You must have edit dataset permission in the collection in order to use this endpoint.


The permission requirement is incorrectly stated as "edit dataset permission" but should be "edit dataverse permission" or "edit collection permission". The command uses @RequiredPermissions(Permission.EditDataverse), not edit dataset permission.

src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java

Copilot · 2025-11-21T17:54:59Z

doc/release-notes/11914-set-template-default-api.md

+
+### Functionality
+- Removes the default template of the given dataverse collection.
+- You must have edit dataset permission in the collection in order to use this endpoint.


The permission requirement is incorrectly stated as "edit dataset permission" but should be "edit dataverse permission" or "edit collection permission". The command uses @RequiredPermissions(Permission.EditDataverse), not edit dataset permission.

src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java

Copilot · 2025-11-21T17:55:00Z

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/SetDefaultTemplateCommand.java

+
+    @Override
+    public Template execute(CommandContext ctxt) throws CommandException {
+        dataverse.setDefaultTemplate(template);


The command modifies the dataverse but doesn't persist the changes to the database. After calling dataverse.setDefaultTemplate(template), you should merge the dataverse entity using ctxt.em().merge(dataverse) to ensure the changes are persisted. See similar commands like CreateTemplateCommand (line 55) for reference.

Suggested change

dataverse.setDefaultTemplate(template);

dataverse.setDefaultTemplate(template);

ctxt.em().merge(dataverse);

Copilot · 2025-11-21T17:55:00Z

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/RemoveDefaultDatasetCommand.java

+    @Override
+    public Dataverse execute(CommandContext ctxt) throws CommandException {
+        dataverse.setDefaultTemplate(null);
+        return dataverse;


The command modifies the dataverse but doesn't persist the changes to the database. After calling dataverse.setDefaultTemplate(null), you should merge the dataverse entity using ctxt.em().merge(dataverse) to ensure the changes are persisted. See similar commands like CreateTemplateCommand (line 55) for reference.

Suggested change

return dataverse;

Dataverse mergedDataverse = ctxt.em().merge(dataverse);

return mergedDataverse;

Copilot · 2025-11-21T17:55:00Z

doc/release-notes/11914-set-template-default-api.md

+- Sets the default template of the given dataverse collection.
+- You must have edit dataset permission in the collection in order to use this endpoint.
+
+## New Endpoint: DELETE `/dataverses/{id}/template/default`


The endpoint path in the documentation uses /template/default (singular "template"), but based on the actual implementation in Dataverses.java the path is /templates/default (plural "templates"). Update the documentation to use the correct plural form: /dataverses/{id}/templates/default.

… for setting and removing default templates

coveralls · 2025-11-24T19:03:02Z

coverage: 24.029% (-0.008%) from 24.037%
when pulling 924da37 on 11914-set-template-default
into b8f5c1e on develop.

github-actions · 2025-11-24T19:09:12Z

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11914-set-template-default

ghcr.io/gdcc/configbaker:11914-set-template-default

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

sekmiller · 2025-12-01T14:52:54Z

src/main/java/edu/harvard/iq/dataverse/api/AbstractApiBean.java

+
+    protected Template findTemplateOrDie(Long templateId, Dataverse dataverse) throws WrappedResponse {
+
+        Template template = dataverse.getTemplates().stream()


I think we need to take into account whether the dataverse is inheriting templates from its parents.

sekmiller

@jp-tosca looks good generally - can you take a look at the handling of inherited templates in the find template or die method? thanks!

jp-tosca added 6 commits November 5, 2025 20:27

placeholder

7ebb100

Endpoints work but need polish.

4c9044a

Merge remote-tracking branch 'origin/develop' into 11914-set-template…

9460189

…-default

pr notes

097e972

Merge remote-tracking branch 'origin/develop' into 11914-set-template…

5d7379e

…-default

Initial test

d5aab83

This comment has been minimized.

Sign in to view

jp-tosca requested a review from Copilot November 18, 2025 17:56

jp-tosca added this to IQSS Dataverse Project Nov 18, 2025

jp-tosca moved this to In Progress 💻 in IQSS Dataverse Project Nov 18, 2025

jp-tosca self-assigned this Nov 18, 2025

Copilot started reviewing on behalf of jp-tosca November 18, 2025 17:57 View session

Copilot finished reviewing on behalf of jp-tosca November 18, 2025 17:59

Copilot AI reviewed Nov 18, 2025

View reviewed changes

jp-tosca added 6 commits November 20, 2025 12:27

Changes to show the ID of the created template

31a2078

Changes to the set default endpoint

76ff3e0

Flush entity manager after setting default template in CreateTemplate…

8e72fea

…Command

Update success messages for removing default dataset template

17bb055

Implement RemoveDefaultDatasetCommand and update endpoint to use it f…

04fcb16

…or removing default template

Add tests for setting and removing default template in DataversesIT

72237fb

jp-tosca requested a review from Copilot November 21, 2025 17:46

Copilot started reviewing on behalf of jp-tosca November 21, 2025 17:46 View session

Copilot finished reviewing on behalf of jp-tosca November 21, 2025 17:48

Copilot AI reviewed Nov 21, 2025

View reviewed changes

cmbz added the FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) label Nov 22, 2025

Fix permission description in API documentation and method signatures…

a86a9ab

… for setting and removing default templates

jp-tosca moved this from In Progress 💻 to Ready for Review ⏩ in IQSS Dataverse Project Nov 24, 2025

jp-tosca removed their assignment Nov 24, 2025

Merge branch 'develop' into 11914-set-template-default

924da37

jp-tosca marked this pull request as ready for review November 24, 2025 18:46

sekmiller self-assigned this Nov 25, 2025

sekmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Nov 25, 2025

sekmiller reviewed Dec 1, 2025

View reviewed changes

sekmiller requested changes Dec 1, 2025

View reviewed changes

sekmiller assigned jp-tosca Dec 1, 2025

cmbz added the FY26 Sprint 12 FY26 Sprint 12 (2025-12-03 - 2025-12-17) label Dec 3, 2025

	dataverse.setDefaultTemplate(template);
	dataverse.setDefaultTemplate(template);
	ctxt.em().merge(dataverse);

	return dataverse;
	Dataverse mergedDataverse = ctxt.em().merge(dataverse);
	return mergedDataverse;


		protected Template findTemplateOrDie(Long templateId, Dataverse dataverse) throws WrappedResponse {

		Template template = dataverse.getTemplates().stream()

11914 set template default #11989

Are you sure you want to change the base?

11914 set template default #11989

Conversation

jp-tosca commented Nov 18, 2025

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

coveralls commented Nov 24, 2025

Uh oh!

github-actions bot commented Nov 24, 2025

Uh oh!

sekmiller Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

sekmiller left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants