IQSS / IQSS/dataverse

Feature Request/Idea: Extend external tools reserved words by 'fileName'

Open
#9,530 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: External Tool Type: Feature 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

In the building process of external tools such as previewers, several reserved words can be passed along the URL (siteURL, fileID, ..) yet information of the file name itself is missing. Thus, this issue is requesting to extend the external tools APIs reserved words by a fileName parameter that is passed, which contains the name of the file.

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

Sysadmin, API User

What inspired the request?

The implementation of an external tool to view HDF5 files and chats with @pdurbin and @atrisovic on the matter of NetCDF.

What existing behavior do you want changed?

Add fileName to external tools API's reserved words.

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 locating the external tools API code that defines and expands reserved words such as siteURL and fileID. Trace how the selected file's metadata reaches previewer URLs, then determine where fileName should be added. Done means external tools receive the file name consistently, with coverage for the updated reserved-word behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.