May all responses fields should be marked as `required`?

[sneko]

Hi @emnbdx ,

I'm generating a client for TypeScript from https://raw.githubusercontent.com/HelloAsso/helloasso-open-api/refs/heads/main/helloasso.json but all the nested fields are marked as optional (undefined). So for example for a nullable string it's string | null | undefined, and for a string string | undefined.

I saw for model HelloAsso.Api.V5.Models.OrganizationLegalInformations.UpdateOrganizationLegalInformationConfigurationBody you put the required OpenAPI property to avoid this.

I'm wondering if required should be on all models (even those for wrapping the responses because they get data/pagination optionals too).

Thank you,

EDIT: in case you want to debug this, here a simple TS script to generate all fields and then to try importing for example getOrganizationsByOrganizationSlugOrders:

import { createClient } from '@hey-api/openapi-ts';

createClient({
  input: 'https://raw.githubusercontent.com/HelloAsso/helloasso-open-api/refs/heads/main/helloasso.json',
  output: 'helloasso',
  plugins: ['@hey-api/client-fetch'],
});

[emnbdx]

Hi @sneko,

Let me check with the API team real quick and I’ll update you here.

[emnbdx]

Hi @sneko

The API team doesn’t have capacity to handle this at the moment.
It should be fixed in approximately one month.

[sneko]

@emnbdx also, note there are 3 getters having no return type at all, making them as unkown when using types. It makes harder to use a generated client.

https://github.com/HelloAsso/helloasso-open-api/blob/main/helloasso.json#L887-L894

https://github.com/HelloAsso/helloasso-open-api/blob/main/helloasso.json#L1058-L1065

https://github.com/HelloAsso/helloasso-open-api/blob/main/helloasso.json#L2475-L2482