IQSS / IQSS/dataverse

[Spike - API] Create an endpoint to retrieve dataset thumbnails

Open
#10,046 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

pm.GREI-d-2.7.1 pm.GREI-d-2.7.2 Size: 30 User Role: API User
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

The SPA needs to obtain the thumbnail for a particular dataset to display it on the page.

Thumbnails come from different sources, such as an uploaded file or a specific image uploaded by the user, and their accessibility depends on the user permissions.

The origin of the thumbnail, or the permissions, should not be an issue for the SPA, since the new endpoint should return the thumbnail regardless of the origin and considering the calling user's permissions. Potentially the endpoint will function similarly to the access endpoint for downloading file thumbnails.

What kind of user is the feature intended for?

API User

What inspired the request?

SPA needs

What existing behavior do you want changed?

None

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

New API endpoint for retrieving dataset thumbnails

Any open or closed issues related to this feature request?

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 by reviewing the existing access endpoint for downloading file thumbnails and the related dataverse-frontend pull request 202. Trace the API entry points and determine how thumbnail origins and calling-user permissions are handled. Done means a documented endpoint returns the appropriate dataset thumbnail regardless of its source, subject to permissions.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.