Interface RestResponseDocumentation

Documentation of a response of a typed route, see RestRouteDocumentation.

interface RestResponseDocumentation {
description: string;
schema?: IJSONSchema;
}

Index

Properties

description schema?

Properties

description

description: string

Description of the response.

`Optional`schema

schema?: IJSONSchema

JSON Schema of the JSON response body, if the response carries one.