Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Feature Request: Extend getMyDataCollectionItems search capabilities

Offen
  • Stimmt etwas nicht?
#491 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
66/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
typescript
Bereich
api

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
TypeScript
Sterne
20
Forks
11
Ø Merge
2 T. 5 Std.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus IQSS/dataverse-client-javascript

Alle Issues in IQSS/dataverse-client-javascript

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.