IQSS / IQSS/dataverse-client-javascript
Extend Dataset and File use cases: add privateUrlToken
- Langage dominant
- TypeScript
- Étoiles
- 20
- Forks
- 11
- Merge moyen
- 2 j 5 h
- PR mergées (30 j)
- 1
Description
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}
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par localiser les cas d’utilisation de Dataset et File et retracer la manière dont les paramètres de requête sont transmis aux endpoints access et v1 dataset indiqués. Vérifiez comment privateUrlToken est représenté ailleurs dans le client, puis vérifiez que les pages Dataset et File prennent en charge les URLs privées via chacun des endpoints indiqués dans l’issue.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- api
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 55/100