$ref in path parameters doesn't seem to work

Offen

#605 erstellt am 30.4.2022 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 48/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: openapi, python
Bereich: api

Rechercherichtung

Beginne mit der verknüpften test-schema.yaml im reproduzierbaren openapi-ref-issue-Repository und führe den Generator mit der gemeldeten openapi-python-client-Version aus. Vergleiche den generierten synchronen Einstiegspunkt mit dem noref-Beispiel und konzentriere dich auf die Auflösung des Parameters $ref. Erledigt ist die Aufgabe, wenn die generierte API auch im Fall des referenzierten Parameters das optionale page kwarg enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

🐞bug

Describe the bug
If a get path has a parameter using $ref to point to #/components/parameters, the generated API lacks the corresponding kwarg. If one "hoists" the indirect parameter up into the path's parameters, it works as expected.

To Reproduce
See this repo for a reproducible example.
And see this repo for the same schema without the $ref, working as expected.

Expected behavior
I expect to see the optional page kwarg in both generated APIs.

I see this in the $ref example:

def sync(
    *,
    client: Client,
) -> Optional[List[str]]:

and this in the noref example:

def sync(
    *,
    client: Client,
    page: Union[Unset, None, GetTestPage] = UNSET,
) -> Optional[List[str]]:

OpenAPI Spec File
A link to your openapi.json which produces this issue.

Desktop (please complete the following information):

OS: Microsoft Windows 10 Pro 10.0.19044 Build 19044
Python Version: 3.9.12
openapi-python-client version 0.11.1

Vorherrschende Sprache: Python
Sterne: 2k
Forks: 293
Ø Merge: 34 Min.
Gemergte PRs (30 T.): 1

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

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

Mehr aus openapi-generators/openapi-python-client

typing_extensions should be declared as dependency Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

openapi-generators/openapi-python-client#1481 · Erstellt am 20.8.2026
Skip setting 'Content-Type' on file upload, when multiple bodies are supported Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

openapi-generators/openapi-python-client#947 · Erstellt am 23.1.2024
Multi-body endpoints with required requestBody emit `| Unset` without importing `Unset` Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100

openapi-generators/openapi-python-client#1451 · 1 Kommentar · Erstellt am 18.6.2026
_build_response crashes with ValueError on non-IANA HTTP status codes (520, 561, etc.) Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 52/100

openapi-generators/openapi-python-client#1442 · Erstellt am 29.5.2026
Generator fails on type: array without items even though it's valid in JSON Schema 2020-12 / OpenAPI 3.1 Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 64/100

openapi-generators/openapi-python-client#1435 · 1 Kommentar · Erstellt am 15.5.2026

Alle Issues in openapi-generators/openapi-python-client