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

Generation for multiple content types for a single endpoint fails when content types expect identical models

Offen
#1,276 1 Kommentar 1 Reaktion 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
Support for multiple content types for a single endpoint was added in #453 / #822. However, the implemented fix generates non-functional code if the content types expect the same model. For instance, take this Api Spec snippet:

paths./api/dns/add/...
requestBody:
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/DnsCreate'
    application/x-www-form-urlencoded:
      schema:
        $ref: '#/components/schemas/DnsCreate'
    multipart/form-data:
      schema:
        $ref: '#/components/schemas/DnsCreate'
  required: true

...
components.schemas...:

DnsCreate:
  type: object
  properties:
    name:
      type: string
    dns_type:
      oneOf:
      - $ref: '#/components/schemas/DnsTypeEnum'
      - $ref: '#/components/schemas/BlankEnum'
    content:
      type: string
    ttl:
      type: integer
      maximum: 2147483647
      minimum: -2147483648
      nullable: true
  required:
  - content
  - dns_type
  - name

All 3 content types expect the same content type: DnsCreate. However, this generates this Python code:

def _get_kwargs(
    *,
    body: Union[
        DnsCreate,
        DnsCreate,
        DnsCreate,
    ],
) -> dict[str, Any]:
    headers: dict[str, Any] = {}

    _kwargs: dict[str, Any] = {
        "method": "post",
        "url": "/api/dns/add/",
    }

    if isinstance(body, DnsCreate):
        _kwargs["json"] = body.to_dict()

        headers["Content-Type"] = "application/json"
    if isinstance(body, DnsCreate):
        _kwargs["data"] = body.to_dict()

        headers["Content-Type"] = "application/x-www-form-urlencoded"
    if isinstance(body, DnsCreate):
        _kwargs["files"] = body.to_multipart()

        headers["Content-Type"] = "multipart/form-data"

    _kwargs["headers"] = headers
    return _kwargs

This results in all requests made to this endpoint being treated as multipart form data, and it is impossible to make a JSON or form-urlencoded request.

Desktop (please complete the following information):

  • Python Version: 3.12.3
  • openapi-python-client version: 0.25.0

Additional context
While it may seem odd to support 3 different content types for the same endpoint, this specification has the advantage of making Django Rest Framework's interactive API support form uploads (instead of requiring you to manually edit JSON). While I'm sure this is a more niche problem, I think we can all agree that this is problematic code generation. While I haven't contributed to this repo, perhaps supporting an additional content type parameter is the solution (rather than relying on isinstance calls).

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, die Generierung mit dem OpenAPI-Snippet aus dem Issue zu reproduzieren, und untersuche die generierte Endpoint-Funktion _get_kwargs. Verfolge, wie identische Modelle jedem Request-Content-Type zugeordnet werden; abgeschlossen, wenn JSON-, form-urlencoded- und multipart-Requests auswählbar bleiben, statt vom letzten Branch überschrieben zu werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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