11912 edit template api by sekmiller · Pull Request #12159 · IQSS/dataverse

sekmiller · 2026-02-12T21:49:26Z

What this PR does / why we need it: Allows user to update the metadata, instructions, license, terms of use or terms of access of a given template

Which issue(s) this PR closes:

Closes Add a new API to edit templates metadata and Terms of Use/Access #11912

Special notes for your reviewer:

Suggestions on how to test this: There are several new api endpoints one of which is used to either update the license or the custom terms of access for a given template (see release notes and updated documentation)

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

coveralls · 2026-02-13T16:40:55Z

coverage: 24.406% (+0.08%) from 24.329%
when pulling 68e82e6 on 11912-edit-template-api
into cf960f2 on develop.

qqmyers

Looks good overall. I made a few suggestions for some clean up.

qqmyers · 2026-02-20T15:20:37Z

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

+    }

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


maybe findTemplateInDataverseOrDie or similar? - it doesn't return all templates, just one.

qqmyers · 2026-02-20T15:23:49Z

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

+            */
+
+            String templateName = json.getString("name");
+            if (!templateName.isEmpty() && !templateName.isBlank()){


isBlank is true if the String isEmpty, so don't need both. (Could it be null?)

qqmyers · 2026-02-20T15:33:24Z

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

+
+            return created("/dataverses/template/" + updated.getId(), jsonTemplate(updated));
+                } catch (JsonParseException ex) {
+            logger.log(Level.SEVERE, "Semantic error parsing dataset update Json: " + ex.getMessage(), ex);


a nit: a json parsing error is syntactic not semantic - maybe just "Error parsing..."

qqmyers · 2026-02-20T15:34:05Z

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

+            Template template = findTemplateOrDie(templateId);
+            Dataverse dataverse = template.getDataverse();
+
+            if (requestBody.getName() != null && !requestBody.getName().isEmpty()) {


isBlank() instead of isEmpty()?

qqmyers · 2026-02-20T15:40:00Z

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

+
+            if (requestBody.getName() != null && !requestBody.getName().isEmpty()) {
+                String licenseName = requestBody.getName();
+                License license = licenseSvc.getByNameOrUri(licenseName);


Probably out of scope - this method is supposed to allow using a name or URI (which is actually meant as an identifier) but using LicenseUpdateRequest limits this to a name. It's the same for the Datasets method so this PR isn't introducing anything new, but supporting URIs would be a useful addition at some point.

qqmyers · 2026-02-20T15:56:02Z

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

+            datasetVersionField.setControlledVocabularyValues(new ArrayList<>());
+            datasetVersionField.setDatasetFieldCompoundValues(new ArrayList<>());
+        } else {
+            datasetVersionField.setSingleValue("");


I see setSingleValue(null) in the Dataset deleteMetadata call - but this is what's done in the UpdateDatasetFieldsCommand - any reason for the difference? I guess it makes sense to leave it unless you can justify null.

qqmyers · 2026-02-20T15:56:22Z

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

+/*
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template
+ */


qqmyers · 2026-02-20T15:57:16Z

...in/java/edu/harvard/iq/dataverse/engine/command/impl/UpdateTemplateTermsOfAccessCommand.java

+/*
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template
+ */


qqmyers · 2026-02-20T15:59:41Z

src/test/java/edu/harvard/iq/dataverse/engine/command/impl/UpdateTemplateFieldsCommandTest.java

+/*
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template
+ */


qqmyers · 2026-02-20T16:02:12Z

...ava/edu/harvard/iq/dataverse/engine/command/impl/UpdateTemplateTermsOfAccessCommandTest.java

@@ -0,0 +1,86 @@
+/*
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license
+ * Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template


github-actions · 2026-02-25T16:54:44Z

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11912-edit-template-api

ghcr.io/gdcc/configbaker:11912-edit-template-api

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

sekmiller added 22 commits January 29, 2026 11:06

#11912 WIP

6bc880d

Merge branch 'develop' into 11912-edit-template-api

c2124bc

#11912 add commands, etc.

9cd0905

#11912 fix endpoints

a314c7b

Merge branch 'develop' into 11912-edit-template-api

f7c0424

#11912 update instructions, etc.

cefb654

Merge branch 'develop' into 11912-edit-template-api

a905b7c

#11912 update tests

84c50cc

#11912 update name

2fb6083

#11912 more tests

ede1c84

#11912 fix command/tests

9bdcae5

Merge branch 'develop' into 11912-edit-template-api

1afe95b

#11912 update terms test

d8b484f

#11912 simplify endpoint

f40d44d

#11912 add command for update access

2840982

Merge branch 'develop' into 11912-edit-template-api

23f08a9

#11912 fix update and tests

8ce04ec

#11912 add unit tests

38fba3c

#11912 release notes and cleanup

9776524

#11912 typo

0b7f7e5

#11912 sample json for update template

61d0594

Update native-api.rst

92463aa

github-actions bot added SPA.Q3.2025.12 Dataset Templates Type: Feature a feature request labels Feb 12, 2026

sekmiller added this to IQSS Dataverse Project Feb 12, 2026

sekmiller moved this to Ready for Review ⏩ in IQSS Dataverse Project Feb 12, 2026

sekmiller self-assigned this Feb 12, 2026

#11912 return test clean up

2c2e6a8

This comment has been minimized.

Sign in to view

Merge branch 'develop' into 11912-edit-template-api

deb8f28

This comment has been minimized.

Sign in to view

sekmiller removed their assignment Feb 13, 2026

Merge branch 'develop' into 11912-edit-template-api

c8fb718

ChengShi-1 mentioned this pull request Feb 13, 2026

Edit Template Use Case IQSS/dataverse-client-javascript#427

Open

This comment has been minimized.

Sign in to view

Merge branch 'develop' into 11912-edit-template-api

68e82e6

This comment has been minimized.

Sign in to view

qqmyers requested changes Feb 20, 2026

View reviewed changes

qqmyers moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Feb 20, 2026

qqmyers assigned sekmiller Feb 20, 2026

qqmyers self-requested a review February 20, 2026 16:04

qqmyers self-assigned this Feb 20, 2026

Merge branch 'develop' into 11912-edit-template-api

8f93821

This comment has been minimized.

Sign in to view

ekraffmiller mentioned this pull request Feb 23, 2026

add use cases for editing template to TemplatesRepository.ts IQSS/dataverse-client-javascript#430

Draft

sekmiller added 3 commits February 24, 2026 09:46

Merge branch 'develop' into 11912-edit-template-api

49f60c8

#11912 remove license with custom terms

3052ce5

Merge branch 'develop' into 11912-edit-template-api

0eba7d0

ChengShi-1 mentioned this pull request Feb 25, 2026

Add a new API to manage the templates' terms #11913

Closed

Conversation

sekmiller commented Feb 12, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

coveralls commented Feb 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.

This comment has been minimized.

qqmyers left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

github-actions bot commented Feb 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coveralls commented Feb 13, 2026 •

edited

Loading