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

`MultiSearchResponse` type does not account for union search response shape

Offen Anfängerfreundlich
#128 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

@tharropoulos arbeitet bereits daran.

Seit 04.5.2026.

  • #130 von @tharropoulos — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
78/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Ruhig
Tech-Stack
python
Bereich
api

Rechercherichtung

Beginne in src/typesense/types/multi_search.py und verfolge den Rückgabetyp von multi_search.perform(). Vergleiche die im Issue beschriebene föderierte Antwort mit der Form von union=True in der verlinkten API-Dokumentation. Das Ziel ist erreicht, wenn die Typisierung von MultiSearchResponse beide Antwortformen korrekt repräsentiert, ohne Aufrufer irrezuführen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

The MultiSearchResponse type in src/typesense/types/multi_search.py only models the federated (default) multi-search response shape:

class MultiSearchResponse(typing.TypedDict):
    results: typing.List[SearchResponse[typing.Any]]

However, the /multi_search endpoint has two distinct response shapes depending on whether union is set in the request:

  • Federated search (union absent or False): returns { "results": [ ...one SearchResponse per query... ] }
  • Union search (union: True): returns with no results wrapper doc

The current type is incorrect for the union case and gives users a misleading return type annotation when they call multi_search.perform() with union=True.

Vorherrschende Sprache
Python
Sterne
247
Forks
66
Ø Merge
1 T. 1 Std.
Gemergte PRs (30 T.)
7

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

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 typesense/typesense-python

Alle Issues in typesense/typesense-python

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

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