IQSS / IQSS/dataverse-client-javascript

Extend Dataset and File use cases: add privateUrlToken

未关闭
#470 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

@ChengShi-1 已经在做这个了。

开始于 2026年8月3日。

  • #473 来自 @ChengShi-1 —— 未关闭
FY26 Sprint 3 FY27 Sprint 3 GREI Re-arch Size: 20 SPA
主要语言
TypeScript
星标
20
派生
11
平均合并
2 天 5 小时
30 天内合并 PR
1

描述

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}

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先定位 Dataset 和 File 的用例,并追踪查询参数如何传递给列出的 access 和 v1 dataset 端点。检查 privateUrlToken 在客户端其他位置的表示方式,然后验证 Dataset 和 File 页面是否在 issue 中列出的每个端点上支持私有 URL。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
api
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
55/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。