Kind: Type
Source: atloria-monorepo/libs/parser-core/src/openapi/response-shape.ts
What an endpoint returns when it does not return JSON.
56 of our 634 operations published no response at all, and chasing them as "unresolved schemas"
was the wrong frame — most of them do not have a JSON body to resolve. They delete a row and
return nothing, they redirect an OAuth callback, they stream a CSV or a PDF, or they take
@Res() and write to the socket themselves, at which point the return type describes the
framework object rather than the response.
A JSON schema forced onto any of those would be a lie. Silence is also wrong: "204 No Content" and "we could not determine this" are different facts, and a reader deserves to be told which one they are looking at. So this classifies the honest cases and leaves the genuinely unknown explicitly unknown.
Definition
ts| 'empty'
/** Sends a redirect; the body is irrelevant and the Location header is the answer. */
| 'redirect'
/** A non-JSON payload whose media type we could read. */
| 'binary'
/** Takes `@Res()` and writes the response itself — the signature cannot describe it. */
| 'manual'
Was this page helpful?