IQSS / IQSS/dataverse

Analyze how to expose Dataset templates through the API for the SPA to consume them

Open
#11,423 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

FY25 Sprint 22 GREI Re-arch Original size: 10 Size: 10 SPA SPA.Q2 Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

For better understanding the scope and the required implementation.

There is already an endpoint for exposing templates, but it is under /admin base path: https://guides.dataverse.org/en/latest/api/native-api.html#list-dataset-templates

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)

What inspired the request?

What existing behavior do you want changed?

Any brand new behavior do you want to add to Dataverse?

Any open or closed issues related to this feature request?

Are you thinking about creating a pull request for this feature?
Help is always welcome, is this feature something you or your organization plan to implement?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the native API documentation for listing dataset templates and compare the existing endpoint under the /admin base path with the SPA's needs. Define the API exposure approach and scope for SPA consumption; the work is done when the required behavior and implementation plan are agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.