Extend Dataset and File use cases: add privateUrlToken

Open
#470 0 comments 0 reactions 0 assignees View on GitHub

@ChengShi-1 is already working on this.

Since Aug 3, 2026.

  • #473 by @ChengShi-1 — open

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
api

Research direction

Start by locating the Dataset and File use cases and tracing how query parameters are passed to the listed access and v1 dataset endpoints. Check how privateUrlToken is represented elsewhere in the client, then verify that Dataset and File pages support private URLs across each endpoint listed in the issue.

Written by the indexing model from the issue text.

Description

FY26 Sprint 3 FY27 Sprint 3 GREI Re-arch Size: 20 SPA

There are several api endpoints that take a query parameter for the privateUrlToken. We need to update them to update the Dataset and File page to support privateUrls.
For example:
GET /api/access/datafile/{fileId}?key={privateUrlToken}
GET /api/access/datafile/{fileId}?imageThumb=true&key={privateUrlToken}
GET /api/access/datafile/{fileId}?format=original&key={privateUrlToken}
GET /api/access/datafiles/{fileIds}?key={privateUrlToken}
GET /api/access/dataset/{datasetId}/versions/:draft?key={privateUrlToken}

GET /api/v1/datasets/{id}?key={privateUrlToken}
GET /api/v1/datasets/{id}/versions/:draft?key={privateUrlToken}
GET /api/v1/datasets/{id}/versions/:draft/files?key={privateUrlToken}
GET /api/v1/datasets/{id}/versions/:draft/files/counts?key={privateUrlToken}
GET /api/v1/datasets/{id}/versions/:draft/downloadsize?key={privateUrlToken}
GET /api/v1/datasets/{id}/versions/:draft/metadata?key={privateUrlToken}

Dominant language
TypeScript
Stars
20
Forks
11
Avg merge
2d 5h
Merged PRs (30d)
1

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.

More from IQSS/dataverse-client-javascript

All issues in IQSS/dataverse-client-javascript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.