Inject http Body
Inject value from body
used to show a method as deprecated on swagger documentation
Inject uploaded files
Inject value from Http header
can be used to entirely hide an method from documentation
Mark parameter as manually injected, which will not be generated
Can be used to indicate that a method requires no security.
Inject value from Path
Inject value from query string
Inject http request
Inject a library-agnostic responder function that can be used to construct type-checked (usually error-) responses.
The type of the responder function should be annotated TsoaResponse<Status, Data, Headers>
in order to support OpenAPI documentation.
Inject uploaded file
Inject uploaded files
This function does exhaustiveness checking to ensure that you have discriminated a union so that no type remains. Use this to get the typescript compiler to help discover cases that were not considered.
For Swagger, additionalProperties is implicitly allowed. So use this function to clarify that undefined should be associated with allowing additional properties
if this is undefined then you should interpret it as a "yes"
Generated using TypeDoc
these options will be removed in a future version since we would prefer consumers to explicitly state their preference that the tsoa validation throws or removes additional properties