Defaults are baked in during API generation

[crummy]

I'm setting up the openAPI generator, and swagger hosting (really nice, thanks!) I've noticed one problem, however.

Given a zod field like this:

endDate: z
  .string()
  .datetime()
  .default(() => DateTime.utc().toISO())
  .describe(
    "An ISO8601 UTC string indicating the latest date before which you want to limit results.",
  ),

I get documentation like this:

This looks fine except that the time does not change. So, if I generate the docs now, and wait a few days, the default is actually wrong.

I tried this:

endDate: withMeta(z
  .string()
  .datetime()
  .default(() => DateTime.utc().toISO())
  .describe(
    "An ISO8601 UTC string indicating the latest date before which you want to limit results.",
  )).default("Today"),

... but that just overrode the actual default.

Any other solutions to this?

[RobinTail]

Hello @crummy ,

after generating OpenAPI specification it becomes a static data.
The default property of the SchemaObject inherits from JSON Schema and it's a static value as well, not an expression.
So it can not be calculated at the moment when you open the generated documentation.

This is a known limitation, see: OAI/OpenAPI-Specification#554

There are suggestions to involve some custom properties, but their actual rendering should be supported by an external tool or plugin that I'm not aware of. Consider asking OAS and Swagger community.

In case you'll find out more about it, I'd be glad to adopt such solution into the generator.

[RobinTail]

Dear @crummy ,

here is the feature PR: #1709
And I released the version 18.4.0-beta1 for you.
Could you please install it, test it and let me know if it works as expected?

[crummy]

Yes, that works great!

[RobinTail]

I'm glad to read it, @crummy . Thank you for letting me know.
I will probably make a couple adjustments before release.
Still considering a better naming having less confusion.
I will inform you.

[RobinTail]

Dear @crummy ,

version 18.4.0 released 🚀
The method you need is called .label() now.