IQSS / IQSS/dataverse-client-javascript

Extend Dataset and File use cases: add privateUrlToken

Aperta
#470 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

@ChengShi-1 ci sta già lavorando.

Dal 3/8/2026.

  • #473 di @ChengShi-1 — aperta
FY26 Sprint 3 FY27 Sprint 3 GREI Re-arch Size: 20 SPA
Lingua principale
TypeScript
Stelle
20
Fork
11
Merge medio
2g 5h
PR unite (30g)
1

Descrizione

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}

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando i casi d’uso di Dataset e File e tracciando il modo in cui i parametri di query vengono passati agli endpoint access e v1 dataset elencati. Controlla come privateUrlToken è rappresentato altrove nel client, quindi verifica che le pagine Dataset e File supportino gli URL privati tramite ciascun endpoint elencato nell’issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.