RobinTail / express-zod-api / 33197439052

100%

push

github

fix: resolve root meta refs on input schemas (#3659) (#3663)

## Resolves #3659

Root `.meta({ id })` on an input schema reduced the whole request
depiction to a bare `$ref` (`#/components/schemas/UserInput`). Because
`flattenIO` only walks `type: "object"` depictions, path parameters then
appeared missing and `Documentation` threw `The input schema is missing
the path parameter "id"` even though the field existed. The same `$ref`
opacity also made `excludeParamsFromDepiction` skip stripping path
fields from the body (family of #3601).

### Change
- Added `Documentation.#resolveRequest`, which resolves a top-level
component reference back to the depicted object (O(1) lookup in
`rootDoc.components.schemas`).
- `flattenIO` and `excludeParamsFromDepiction` now operate on the
resolved subject, so path parameters are discovered (emitted as `in:
"path"`) and stripped from the request body.
- When nothing is stripped (no path params) the original shared `$ref`
is reused for the body, preserving the #3570 component-reuse behavior.
When params are stripped, `depictBody` emits a fresh per-route body
component (per #3601 semantics), so it no longer collides with the
shared component.
- Works for both `composition: "components"` and `"inline"`.

### Tests
- `Issue #3659` describe block in `tests/documentation.spec.ts`:
components and inline composition both document `id` as `in: "path"` and
leave only `name` in the body; a no-path-param route still `$ref`s the
shared `UserInput` component.

### Docs
- Patch-level `v29.3.5` CHANGELOG entry crediting the reporter.

Routing is unaffected (document generation only). Full main-package
suite (1701 tests), `tsc`, `oxlint`, and `oxfmt` all pass.

<!-- PULLFROG_DIVIDER_DO_NOT_REMOVE_PLZ -->
<sup><a href="https://pullfrog.com"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://pullfrog.com/logos/frog-white-full-18px.png"><img
src="https://pullfrog.com/logos/frog-green-full-18px.png" width="9px"
height="9... (continued)

1095 of 1145 branches covered (95.63%)

12 of 12 new or added lines in 1 file covered. (100.0%)

1589 of 1590 relevant lines covered (99.94%)

593.13 hits per line