Interface IDocumentationUpdaterContext

Context of a method, that updates the documentation of a route / controller method.

interface IDocumentationUpdaterContext {
    documentation: {
        callbacks?: {
            [callback: string]: ReferenceObject | CallbackObject;
        };
        deprecated?: boolean;
        description?: string;
        externalDocs?: ExternalDocumentationObject;
        operationId?: string;
        parameters?: (ReferenceObject | ParameterObject)[];
        requestBody?: ReferenceObject | RequestBodyObject;
        responses: ResponsesObject;
        security?: SecurityRequirementObject[];
        servers?: ServerObject[];
        summary?: string;
        tags?: string[];
    };
    doesValidate: boolean;
    doesValidateQuery: boolean;
    hasAuthorize: boolean;
    method: "POST" | "PUT" | "PATCH" | "CONNECT" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "TRACE";
    middlewares: HttpMiddleware[];
    path: HttpRequestPath;
}

Properties

documentation doesValidate doesValidateQuery hasAuthorize method middlewares path

Properties

documentation

documentation: {
    callbacks?: {
        [callback: string]: ReferenceObject | CallbackObject;
    };
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    operationId?: string;
    parameters?: (ReferenceObject | ParameterObject)[];
    requestBody?: ReferenceObject | RequestBodyObject;
    responses: ResponsesObject;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: string[];
}

The underlying documentation.

Type declaration

doesValidate

doesValidate: boolean

Indicates if endpoint does validate data with a schema or not.

doesValidateQuery

doesValidateQuery: boolean

Indicates if endpoint does validate query data with a schema or not.

hasAuthorize

hasAuthorize: boolean

Indicates if underlying method is marked with 'Authorize()' decorator or not.

method

method: "POST" | "PUT" | "PATCH" | "CONNECT" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "TRACE"

The HTTP method.

middlewares

middlewares: HttpMiddleware[]

The middlewares, which are defined for that route.

path

path: HttpRequestPath

The path of the route.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc