Skip to content

[Port to dtq-dev] Issue dspace-customers#903: make REST root version prefix configurable #1405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jr-rk wants to merge 2 commits into
base: dtq-dev
Choose a base branch
from
+20 −1
Open

[Port to dtq-dev] Issue dspace-customers#903: make REST root version prefix configurable #1405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad0e941
fix(rest): make REST root version prefix configurable (default "DSpace")
jr-rk Aug 11, 2026
6fe6678
fix(rest): fall back to default when dspace.version.prefix is blank
jr-rk Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RootConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ public RootRest convert(HttpServletRequest request) {
} else {
rootRest.setDspaceServer(dspaceUrl);
}
rootRest.setDspaceVersion("DSpace " + getSourceVersion());
String versionPrefix = StringUtils.defaultIfBlank(
configurationService.getProperty("dspace.version.prefix", "DSpace"), "DSpace");
rootRest.setDspaceVersion(versionPrefix + " " + getSourceVersion());
rootRest.setBuildVersion(getBuildVersion());
return rootRest;
}
Expand Down
12 changes: 12 additions & 0 deletions dspace-server-webapp/src/test/java/org/dspace/app/rest/converter/RootConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public void setUp() throws Exception {
when(configurationService.getProperty("dspace.name")).thenReturn("dspacename");
when(configurationService.getProperty("dspace.server.url")).thenReturn(serverURL);
when(configurationService.getProperty("dspace.server.ssr.url", serverURL)).thenReturn(serverSSRURL);
when(configurationService.getProperty("dspace.version.prefix", "DSpace")).thenReturn("DSpace");

}

Expand Down Expand Up @@ -85,4 +86,15 @@ public void testCorrectInternalUrlSetFromConfigurationService() throws Exception
assertEquals(serverSSRURL, rootRest.getDspaceServer());
assertEquals("DSpace " + Util.getSourceVersion(), rootRest.getDspaceVersion());
}

@Test
public void testConfigurableVersionPrefix() throws Exception {
when(configurationService.getProperty("dspace.version.prefix", "DSpace")).thenReturn("CLARIN-DSpace");
request.setScheme("https");
request.setServerName("dspace-rest");
request.setServerPort(443);
request.setRequestURI("/server/api");
RootRest rootRest = rootConverter.convert(request);
assertEquals("CLARIN-DSpace " + Util.getSourceVersion(), rootRest.getDspaceVersion());
}
}
5 changes: 5 additions & 0 deletions dspace/config/dspace.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ dspace.ui.url = http://localhost:4000
dspace.name = DSpace at My University
dspace.shortname = DSpace

# Prefix for the version string exposed at the REST root (/server/api), rendered by the UI as
# the HTML <meta name="Generator"> value. Defaults to "DSpace" when unset; CLARIN/customer
# deployments may set e.g. "CLARIN-DSpace".
# dspace.version.prefix = DSpace

@milanmajchrak milanmajchrak Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change it to "CLARIN-DSpace" as it is here: https://github.com/dataquest-dev/DSpace/pull/985/changes#diff-755dfa87d0fb57ba5cca52d0544119a7425a1669150dee2bcf60f7ccebd0c032R39


# Assetstore configurations have moved to config/modules/assetstore.cfg
# and config/spring/api/bitstore.xml.
# Additional storage options (e.g. Amazon S3) are available in `assetstore.cfg`
Expand Down
Loading