Interface RestParamDocumentation

Documentation of a path parameter of a typed route, see RestRouteDocumentation.

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

Index

Properties

description schema?

Properties

description

description: string

Description of the parameter.

`Optional`schema

schema?: IJSONSchema

JSON Schema of the parameter. Defaults to { "type": "string" }.