Interface Method

interface Method {
    consumes?: string;
    deprecated?: boolean;
    description?: string;
    extensions: Tsoa.Extension[];
    isHidden: boolean;
    method: "get" | "options" | "post" | "put" | "delete" | "patch" | "head";
    name: string;
    operationId?: string;
    parameters: Tsoa.Parameter[];
    path: string;
    produces?: string[];
    responses: Tsoa.Response[];
    security: Tsoa.Security[];
    successStatus?: number;
    summary?: string;
    tags?: string[];
    type: Tsoa.Type;
}

Index

Properties

consumes? deprecated? description? extensions isHidden method name operationId? parameters path produces? responses security successStatus? summary? tags? type

Properties

`Optional` consumes

consumes?: string

`Optional` deprecated

deprecated?: boolean

`Optional` description

description?: string

extensions

extensions: Tsoa.Extension[]

isHidden

isHidden: boolean

method

method: "get" | "options" | "post" | "put" | "delete" | "patch" | "head"

name

name: string

`Optional` operationId

operationId?: string

parameters

parameters: Tsoa.Parameter[]

path

path: string

`Optional` produces

produces?: string[]

responses

responses: Tsoa.Response[]

security

security: Tsoa.Security[]

`Optional` successStatus

successStatus?: number

`Optional` summary

summary?: string

`Optional` tags

tags?: string[]

type

type: Tsoa.Type

Generated using TypeDoc