IQSS / IQSS/dataverse-client-javascript
Extend Dataset and File use cases: add privateUrlToken
- Ngôn ngữ chính
- TypeScript
- Star
- 20
- Fork
- 11
- Merge trung bình
- 2 ngày 5 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
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}
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách xác định các use case của Dataset và File, đồng thời theo dõi cách các tham số truy vấn được truyền đến các endpoint access và v1 dataset được liệt kê. Kiểm tra cách privateUrlToken được biểu diễn ở nơi khác trong client, sau đó xác minh rằng các trang Dataset và File hỗ trợ private URL trên từng endpoint được liệt kê trong issue.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- typescript
- Lĩnh vực
- api
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 55/100