Header generation for PDF download ?

[mrlubos]

Discussed in https://github.com/orgs/hey-api/discussions/1185

^{Originally posted by jeromeduprazdange October 23, 2024}
Hello !

I have a put endpoint that returns a PDF, here is the openapi spec:

"/v1/pdf/preview": {
      "put": {
        "tags": ["pdf-controller"],
        "operationId": "convertHtmlToPdf",
        "parameters": [
          { "name": "accept", "in": "header", "schema": { "type": "string", "enum": ["application/pdf"] } }
        ],
        "requestBody": {
          "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPdfCommand" } } },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default response",
            "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }
          }
        }
      }
    },

But when I generate my client, I have this:

export class PdfControllerService {
  public static convertHtmlToPdf<ThrowOnError extends boolean = false>(
    options: Options<ConvertHtmlToPdfData, ThrowOnError>,
  ) {
    return (options?.client ?? client).put<ConvertHtmlToPdfResponse, ConvertHtmlToPdfError, ThrowOnError>({
      ...options,
      url: '/v1/pdf/preview',
    });
  }
}

And I don't have a working PDF if I don't manually add these to the request:

responseType: 'blob',
headers: {
  Accept: 'application/pdf',
}

I don't understand why it's not added to my convertHtmlToPdf automatically and if I'm doing something bad.
Also, I use '@hey-api/client-axios' with the 'asClass' option to true.

Thanks!

[mrlubos]

@jeromeduprazdange I'm pretty certain this is on me, nothing wrong on your end. Your workaround works, you can always override/set the headers manually if they're incorrect.

As for this issue, mind sharing which OpenAPI version you're on? I'm working on a new parser and will aim to address this as part of that release. You could try it out when it's ready?

[jeromeduprazdange]

@mrlubos Thanks for the reply. My openapi version is 3.0.1.

Yes no problem for testing the new release :)