Interface OperationOptions<In, Out>

Operation definition accepted by operation and definePlugin.

interface OperationOptions<In, Out> {
    id: string;
    method?: string;
    title?: string;
    description?: string;
    allowedRoles?: string[];
    tags?: string[];
    readOnly?: boolean;
    visible?: boolean;
    input?: Schema<In>;
    output?: Schema<Out>;
    handler: (input: In, request: Request) => MaybePromise<Out | Response<Out>>;
}

Type Parameters

In
Out

Hierarchy (View Summary)

OperationOptions
- OperationDefinition

Index

Properties

id method? title? description? allowedRoles? tags? readOnly? visible? input? output? handler

Properties

id

id: string

`Optional`method

method?: string

`Optional`title

title?: string

`Optional`description

description?: string

`Optional`allowedRoles

allowedRoles?: string[]

`Optional`tags

tags?: string[]

`Optional`readOnly

readOnly?: boolean

`Optional`visible

visible?: boolean

`Optional`input

input?: Schema<In>

`Optional`output

output?: Schema<Out>

handler

handler: (input: In, request: Request) => MaybePromise<Out | Response<Out>>