Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Feature Request: Extend getMyDataCollectionItems search capabilities

Aperta
  • Qualcosa non va?
#491 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
66/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
api

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
20
Fork
11
Merge medio
2g 5h
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di IQSS/dataverse-client-javascript

Tutte le issue di IQSS/dataverse-client-javascript

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.