❓ Set schema name using withMeta

[arlyon]

Hello

The default schema naming is verbose, and I would like to be able to tune the results. I looked at potentially overriding some method on Documentation however no such luck. An alternative would be to be able to tune the naming with a withMeta call with the added benefit that we can deduplicate identical schemas used across multiple resources using reference equality.

withMeta(z.object({ data: z.number() })).example("The data").name("MyCoolRequestData");

Thanks for this great lib! (and happy holidays, if you celebrate)

Alex

[RobinTail]

Hello @arlyon .

I'd rather consider reusing operationId property defined within .build(), concatenated by something like "RequestSchema" and "ResponseSchema"

express-zod-api/src/endpoints-factory.ts

Line 38 in 30a69d9

operationId?: string | ((method: Method) => string);

[RobinTail]

@arlyon ,

I'm going to improve the configuration of the descriptions in the next major release (v16).
See #1416 for details.

Those descriptions do also affect the component naming in the generated documentation (when the composition option is set to components).

As described above, for each of your endpoint you can specify its operationId.
The same operationId you can reuse for shaping the component descriptions:

new Documentation({
  composition: "components", 
  descriptions: {
    requestBody: () => "the body of request",
    requestParameter: ({ method, path }) => `parameter of ${method} ${path}`,
    negativeResponse: ({ operationId }) => `very negative response of ${operationId}`, // <——— this one
    positiveResponse: ({ path }) => `Super positive response of ${path}`,
  },
})

So the component name will be the clean id shaped from the description you can make out of its properties and additional alphanumeric assets of your choice.

I believe it provides enough flexibility for your needs.

[RobinTail]

You can try it in the dev preview version 16.0.0-beta6

[arlyon]

Nice, thanks!