asteasolutions / zod-to-openapi

A library that generates OpenAPI (Swagger) docs from Zod schemas
MIT License
997 stars 61 forks source link

docs: update to include information about strict usage on an object #250

Closed Jafferwaffer closed 3 months ago

Jafferwaffer commented 3 months ago

Since https://github.com/asteasolutions/zod-to-openapi/pull/71 it has been possible to support strict mode on Zod objects, however, I couldn't find this easily in the docs.

Adding this to make it clear that by default additionalProperties will be set to true, as this may catch others out.

Happy to reword, move docs about as required.

AGalabov commented 3 months ago

Thank you @Jafferwaffer