Support for responses with no body (like 204)

[andytson-inviqa]

Currently the generated api.ts HttpClient class doesn't support responses that return 204.

It would be good for it to support that when a openapi spec response has no body defined.

path:
  /customers/:customerId
    delete:
      parameters:
        - name: customerId
          in: path
          required: true
          schema:
            type: integer
          description: Customer ID
      responses:
        '204':
          description: Customer removed

This means also if there's no body,

• the current data or error HttpResponse needs to handle success cases where data is not returned, such as by returning the Response.ok field, for use for the functions.ts method
• to not call response[responseFormat]()
• to handle typescript generics in a way that allows nullable response types

[m-Bilal]

Hi @andytson-inviqa , thanks for raising this. I'm wondering, what would this no-response look like in a GraphQL API? What do you expect it to be like?

Also, the OpenAPI Connector generates Typescript files, that you are allowed (and encouraged) to edit to your liking. You can go ahead and customize the API Client in api.ts file that is generated for you, and have it behave the way you want. Please make sure to add an @save annotation to your edited components, so that the codegen does not overwrite them during introspection. You can read more about saving the changes you make here. If that clears your problem, please go ahead and close this issue. Thanks!

[andytson-inviqa]

We would customise the functions.ts.

Personally I like to have api.ts auto-generated and I customise functions.ts. Any openapi spec changes sync the types of the internal calls to api.ts, and I can see in functions.ts any incompatibilities.

As for save, its a bit annoying as we can't @save class methods, only the top level classes Api and HttpClient, so have to spot and restore every change or have no code generation at all.