openapi-generators / openapi-generators/openapi-python-client

parameter from the `components/parameters` section makes openapi-python-client crash

Offen
#1,194 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Describe the bug
While generating a client for my openapi.json file, the script crashes with internal errors.

The problem seems to be related to a parameter defined in my component/parameters section. When i comment out this part of my openapi spec. The client can be generated without errors.

"components": {
    "parameters": {
        "macAddress": {
            "name": "macAddress",
            "in": "path",
            "required": true,
            "schema": {
                "$ref": "#/components/schemas/MacAddress"
            },
            "description": "The MAC address of the dongle.\n"
        }
    }
}

OpenAPI Spec File.

openapi.json

Desktop (please complete the following information):

  • OS: Ubuntu 24.04.1 LTS
  • Python Version: 3.12.3
  • openapi-python-client version: 0.22.0

Additional context

The full output of the crash output.log.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, den Absturz mit der angehängten openapi.json zu reproduzieren, und prüfe output.log zusammen mit der Definition des Komponentenparameters. Verfolge den Pfad des Generators zur Verarbeitung referenzierter Parameter und bestätige anschließend, dass dieselbe Spezifikation einen Client ohne interne Fehler generiert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi, python
Bereich
tooling
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

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