Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Feature Request: Extend getMyDataCollectionItems search capabilities

Abierto
  • ¿Algo no está bien?
#491 0 comentarios 0 reacciones 0 asignados Ver en GitHub

@vera ya está trabajando en esto.

Desde el 30/9/2026.

  • #492 de @vera — abierto

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
66/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
typescript
Área
api

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
20
Forks
11
Merge medio
6 d 13 h
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de IQSS/dataverse-client-javascript

Todos los issues de IQSS/dataverse-client-javascript

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.