Feature Request: Extend getMyDataCollectionItems search capabilities
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 66/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- typescript
- 领域
- api
调研方向
Start at getMyDataCollectionItems and compare its existing parameters with the related getCollectionItems request and feature request #489. Add the specified collection, metadata, filter, sort, and order options without changing existing behavior; done means /mydata/retrieve receives the corresponding parameters and dataset results expose associated CollectionSummary[] values when requested.
由索引模型根据 Issue 内容生成。
描述
We'd like to propose extending getMyDataCollectionItems with the same search capabilities of getCollectionItems (see related feature request: #489). The existing behavior and parameters should remain unchanged.
Collection information
Add a showCollections option. When enabled, the /mydata/retrieve request should include show_collections=true and dataset results should expose their associated collections as CollectionSummary[].
(Same as proposed for getCollectionItems)
Metadata fields
Add support for:
metadataFields, accepting multiple values in the metadataBlockName:fieldName formatkeepRawFields, controlling whether metadata values are preserved or transformed to Markdown
(Same as proposed for getCollectionItems)
Filter queries
Add support for the /mydata/retrieve fq parameter using:
filterQueries?: string | string[]
(Same as proposed for getCollectionItems)
Sorting
Add standalone sort and order options corresponding to the existing SortType and OrderType values. These should be passed through as the /mydata/retrieve sort and order query parameters.
Design consideration
I considered reusing CollectionSearchCriteria to implement the fq, sort and order support, but it also contains searchText and itemTypes, which getMyDataCollectionItems already accepts as separate parameters (searchText and collectionItemTypes), so reusing it would create duplicate/conflicting inputs, creating a confusing use case interface. So I think standalone filterQueries, sort, and order parameters make more sense.
If CollectionSearchCriteria is to be reused, the searchText and collectionItemTypes params should be removed, but that would be a backwards-incompatible change.
- 主要语言
- TypeScript
- 星标
- 20
- 派生
- 11
- 平均合并
- 2 天 5 小时
- 30 天内合并 PR
- 1
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
IQSS/dataverse-client-javascript 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
IQSS/dataverse-client-javascript#477 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 68/100
IQSS/dataverse-client-javascript#476 · 4 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 76/100
IQSS/dataverse-client-javascript#465 · 1 条评论 · 2 个 reaction ·
-
GREI Re-arch
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 4/5 3-5 天 新手友好度 48/100
查看 IQSS/dataverse-client-javascript 的全部 Issue
相似的 Issue
-
refactor
难度 2/5 半天 新手友好度 84/100
维护者通常 5 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
OHDSI/Data2Evidence#3450 ·
维护者通常 2 天内回复
-
e2e-failure ready-to-code
难度 2/5 1-3 小时 新手友好度 90/100
redhat-developer/rhdh-plugin-export-overlays#4011 · 1 条评论 ·
维护者通常 1 天内回复
-
automation missing-model model-sync provider:ofox
难度 2/5 1-3 小时 新手友好度 72/100
anomalyco/models.dev#8421 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复