Fetch request is always sent with Accept: application/json header

[iansan5653]

Describe the bug
I have an API that has some JSON endpoints and some file endpoints (media type application/octet-stream). The generated code works for the JSON endpoints, but for the file endpoints the server returns 406 because the code always sends the request with header Accept: application/json.

If there is no 200 response described with media type application/json, the generated code should use the first media type described or it should be a method parameter.

I'm using the Fetch API with version 0.7.0.

[iansan5653]

I was able to work around this by setting the HEADERS config to {Accept: ""}.

[ferdikoomen]

@iansan5653 good point, will fix this in the next mayor release

[scipper]

@iansan5653 this work around is a bit risky, because the HEADERS are changed for every request, until you reset it. So if you have multiple requests running in parallel, this work around will cause errors!

@ferdikoomen so please consider a better solution (like an optional headers parameter to every generated service or something).

[iansan5653]

@scipper I have not noticed any issues with this workaround - I just update the HEADERS property one single time at app startup and it works.

Although now I am using a different workaround - a custom request method using the undocumented --request parameter as described here #465 (comment). I copied over the default request method and modified it for my purposes.

[scipper]

@iansan5653 because an empty Accept header, as you configured it, will most likely be treated as Accept: */*. I did not think about that. So, as a work around, valid.

Thanks for the hint with the --request parameter. I am not sure if this helps me for the moment, but I will give it a try.

[ferdikoomen]

@scipper There is a new version that allows to create client instances to each client can have its own bearer token. You can specify the --name argument while generating the client. More info:
https://github.com/ferdikoomen/openapi-typescript-codegen#generate-client-instance-with---name-option

[paladdins]

Hi! Thank you for the great tool!

I have the following schema for the endpoint that responses with application/octet-stream.

  /pdf:
    get:
      produces:
        - application/octet-stream
      operationId: getPDF
      responses:
        200:
              schema:
                  type: string
                  format: binary
                headers:
                  Content-Disposition:
                    type: string
                    default: "attachment; filename=file.pdf"
        403:
          $ref: '#/responses/GeneralError'
        404:
          $ref: '#/responses/GeneralError'
        default:
          $ref: '#/responses/GeneralError'

And since functions in DefaultService are not extendable with custom headers - I would like it to have additional Accept: application/octet-stream header. wdyt about it?

This is what I get in DefaultService

public getPDF(): CancelablePromise<Blob | ErrorDetail> {
        return this.httpRequest.request({
            method: 'GET',
            url: '/pdf',
            errors: {
                403: `General Error`,
                404: `General Error`,
            },
        });
    }

Right now the only viable option is to create new instance of APIClient specifically for the request that I want to send with Accept: application/octet-stream request that is not very convenient.

Is there any other way I could set Accept header?
is it probably better to have an option to extend request like this?

public getPDF(customParams: ApiRequestOptions): CancelablePromise<Blob | ErrorDetail> {
        return this.httpRequest.request(merge({
            method: 'GET',
            url: '/pdf',
            errors: {
                403: `General Error`,
                404: `General Error`,
            },
        }, customParams));
    }

[ikilinc]

Hallo, I have the same problem. at last the possibility to add additional headers while using the function would do it.