RobinTail / express-zod-api / 13144382216

100%

push

github

feat: Pull examples from object schema properties (#2324)

When describing examples of the IO schemas only top level calls of
`.example()` method used to be taken into account in the generated
`Documentation`

```ts
factory.build({
  input: z
    .object({
      key: z.string().nonempty(),
    })
    .example({
      key: "1234-5678-90",
    }),
})
```

This feature enabled pulling examples up from the shape of object schema
properties, so the syntax can be simplified:

```ts
factory.build({
  input: z.object({
    key: z.string().nonempty().example("1234-5678-90"),
  }),
})
```

1240 of 1261 branches covered (98.33%)

56 of 56 new or added lines in 3 files covered. (100.0%)

4198 of 4198 relevant lines covered (100.0%)

277.53 hits per line