Hierarchy

  • RequestControllerMethodObject

Properties

mappings: readonly RequestMappingObject[]
modelAttributes: readonly string[]

If any defined, this method is a model attribute builder for these model names

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

OpenAPI v3 operation annotations

params: readonly RequestParamObject[]
requestBodyRequired?: boolean

Generated using TypeDoc