Native API: Get InstallationName
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
Overview of the Feature Request
Extend the api/info/server endpoint to return the Dataverse Installation name
What kind of user is the feature intended for?
All users roles
What inspired the request?
In the Dataverse plugin for OJS, it is necessary to inform the user which Dataverse installation is configured in the application.
As discussed in the dataverse-community Google Group, the InstallationName is set to the root collection by default, so it's possible to get using the /api/dataverses/:root endpoint in most cases.
However, if the :InstallationName setting to change the default is set, there isn’t currently an API way to get that value except for the restricted admin api: /api/admin/settings/:InstallationName
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the implementation of the GET /api/info/server endpoint and reviewing how the configured InstallationName is exposed elsewhere. Add the installation name to that endpoint's response, then verify that the endpoint returns the configured value rather than only the default root-collection value.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100