isBlob is derived from content type only and disregards `format: binary`

[jmorel]

Description

The isBlob property of a response is derived from its content type only. It disregards the format: binary that could be declared on the response schema.

This means that Orval has to maintain a list of ALL content types that are binary. I'd argue that a shortlist of well known binary content types (such as zip, octet-stream, pdf etc.) does help with openapi specs that may not be perfectly formed, but we should also check for {"type": "string", "format": "binary"} in the response schema to decide whether to enable the isBlob property.

I ran into this issue while trying to serve a .docx export of a document (see the response object below)

If you agree, I'd be happy to make a PR.

Output client

axios

Configuration (orval.config)

"responses": {
  "200": {
    "description": "Successful Response",
    "content": {
      "application/vnd.openxmlformats-officedocument.wordprocessingml.document": {
        "schema": {
          "type": "string",
          "format": "binary"
        }
      }
    }
  }
}

[jmorel]

My bad, it looks like it's been fixed in 0ef60b4

[melloware]

Yep should be in 8.11.0

[mauriceackel]

@jmorel, @melloware: It seems like this change only landed for the response side but not for the request side. In particular, the generated fetch command still generates a JSON.stringify(), even if the format is binary.

I'm referring to:

orval/packages/fetch/src/index.ts

Line 523 in 992a525

const fetchBodyOption = requestBodyParams

const fetchBodyOption = requestBodyParams
    ? (isFormData && body.formData) ||
      (isFormUrlEncoded && body.formUrlEncoded) ||
      isRawRequestBodyContentType(body.contentType)
      ? `body: ${requestBodyParams}`
      : `body: JSON.stringify(${requestBodyParams})`
    : '';