The success status a RouteHandler answers with when it returns a
plain value, branded onto the handler so a documentation generator can
describe the route without importing the plugin that produced it.
This is a description, not a mechanism: the handler still sets the status
on ctx.response, and removing the metadata changes no runtime behaviour.
It carries the STATUS only. A response header is deliberately not
represented: an OpenAPI response-header entry needs a schema and a
description that a @ResponseHeader('X-Total', '42') declaration does not
carry, so deriving one would put an under-specified headers object into
every document that used the decorator.
The success status a
RouteHandleranswers with when it returns a plain value, branded onto the handler so a documentation generator can describe the route without importing the plugin that produced it.This is a description, not a mechanism: the handler still sets the status on
ctx.response, and removing the metadata changes no runtime behaviour.It carries the STATUS only. A response header is deliberately not represented: an OpenAPI response-header entry needs a schema and a description that a
@ResponseHeader('X-Total', '42')declaration does not carry, so deriving one would put an under-specifiedheadersobject into every document that used the decorator.Since
0.7.0