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

Feature Request: Extend getCollectionItems dataset search functionality

Offen
  • Stimmt etwas nicht?
#489 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
48/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
typescript
Bereich
api, backend

Rechercherichtung

Start at the getCollectionItems use case and trace how it builds the /api/search request and transforms dataset results. Read the existing CollectionSummary and dataset metadata transformer behavior before mapping the proposed options. Done means preserving existing behavior while supporting collection results, metadata field parameters and raw-field handling, and unchanged complex filter expressions.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

We'd like to propose enhancing the getCollectionItems use case to expose more of the /api/search API’s dataset search functionality while preserving the existing API behavior.

What do you think of the suggested points below? We're open to providing a PR for these changes.

Collection information

Add a showCollections option to the use case. When enabled, the /search request should include show_collections=true. Dataset results should then expose their associated collections, transformed into the existing CollectionSummary type.

Metadata fields

Add support for a metadataFields option accepting multiple field specifications in the format:

metadataBlockName:fieldName

(as defined in the Dataverse Search API documentation)

Each value should be sent as a separate metadata_fields query parameter. When metadata fields are returned, transform the metadataBlocks payload using the existing dataset metadata transformer.

Also add a keepRawFields option so callers can choose whether metadata values remain unchanged or are transformed to Markdown.

Complex filter queries

Remove the restriction that filter queries must follow a simple key:value format. Filter queries should also accept arbitrary strings, including:

  • Parentheses
  • Mixed AND and OR operators
  • Wildcards, such as abc:* or subtreePath:*/42
  • Numerical or date ranges, such as abc:[0 TO 100]
  • Already-quoted values, such as abc:"xyz"

Complex expressions should be forwarded unchanged. Simple filters can continue using the existing normalization behavior, provided query strings like the ones listed above are not incorrectly wrapped in quotes.

Since Solr syntax is broad and allows more special operators (e.g., boosting, fuzziness, regex) than what I listed above, implementing a detection function that determines whether to transform the filter query or not may be quite complex and brittle.

I think it might be cleaner to just allow the user to specify if the filter query should be passed through without transformation, either via boolean flag param or by changing the type from string[] to string | string[], allowing users to pass an already complete and "finished" query string instead of a string array of individual filters.

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.