Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Feature Request: Extend getMyDataCollectionItems search capabilities

Aberta
  • Algo errado?
#491 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
66/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
typescript
Domínio
api

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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 format
  • keepRawFields, 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.

Linguagem predominante
TypeScript
Estrelas
20
Forks
11
Merge médio
2d 5h
PRs com merge (30d)
1

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de IQSS/dataverse-client-javascript

Todas as issues de IQSS/dataverse-client-javascript

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.