feat: Add descriptions for zod

[TheJokersThief]

Status

READY

Fix #1715

Description

Adds parameter descriptions to generated zod definitions, using the zod.describe("<string>") function.

Example output:

export const addListQueryLimitRegExp = new RegExp('^\\+\\d{10, 15}');


export const addListQueryParams = zod.object({
  "limit": zod.string().regex(addListQueryLimitRegExp).optional().describe('How many items to return at one time (max 100)'),
  "birthdate": zod.string().date().optional().describe('birth date')
})

Reference docs: https://zod.dev/?id=describe

Todos

• Tests
• Documentation
• Changelog Entry (unreleased)

Related Issues

Found this before doing the work:

• Add description property to Zod generated schema #1715