`File.file_name` marked as `Optional` but is required when used in `multipart/form-data`

Offen

#993 erstellt am 08.3.2024 1 Kommentar 6 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: 35/100

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

Rechercherichtung

Beginne bei der verlinkten Definition in templates/types.py.jinja und verfolge, wie multipart/form-data-Dateifelder in generierten Clients dargestellt werden. Reproduziere die bereitgestellte UploadRequest-Spezifikation und überprüfe anschließend, dass eine erforderliche Multipart-Datei im generierten Typ auch file_name erfordert und den gemeldeten Backend-Fehler vermeidet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Describe the bug

In types.py:

https://github.com/openapi-generators/openapi-python-client/blob/0399271be4eb012f83ac3023939ff48e364634e9/openapi_python_client/templates/types.py.jinja#L24

file_name is marked Optional, so it seems like the user could omit it. But if they do to a multipart/form endpoint, backends such as DjangoRestFramework will return:

Status Code: 400 (Bad Request)
Content    : {"file":["The submitted data was not a file. Check the encoding type on the form."]}

This means that users will not get a type checking error if they forget to include a file_name in this scenario.

It seems like perhaps a MultipartFile type is needed to be used to correctly model this?

@define
class MultipartFile:
    """Contains information for multipart file uploads"""

    payload: BinaryIO
    file_name: str
    mime_type: Optional[str] = None

    ...

OpenAPI Spec File

  /upload/:
    post:
      operationId: upload
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadRequest'
        required: true

components:
  schemas:
    UploadRequest:
      type: object
      properties:
        file:
          type: string
          format: binary
      required:
      - file

Desktop (please complete the following information):

OS: macOS 13.6.4
Python Version: 3.12.0
openapi-python-client version: 0.16.1

Additional context

The generated Swagger UI page for this endpoint looks like:

Backend versions:

Django 4.2.11
djangorestframework 3.14.0
drf-spectacular 0.27.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