Interface RestRouteRegistration

A typed route registered on an ExternalApiRouter, recorded for the OpenAPI document builder.

interface RestRouteRegistration {
    bodySchema?: IJSONSchema;
    documentation?: RestRouteDocumentation;
    method: RestMethod;
    path: string;
}

Index

Properties

bodySchema? documentation? method path

Properties

`Optional`bodySchema

bodySchema?: IJSONSchema

JSON Schema of the request body, when declared.

`Optional`documentation

documentation?: RestRouteDocumentation

The route's documentation, when given.

method

method: RestMethod

path

path: string

Contribution-relative express path, e.g. /:id/prompt.