Interface IValidateWithSwaggerOptions

Options for 'validateWithSwagger()' function.

interface IValidateWithSwaggerOptions {
    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[];
    };
    onValidationFailed?: Nilable<JsonSchemaValidationFailedHandler>;
}

Properties

documentation onValidationFailed?

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 documentation to use as schema for the validation.

Type declaration

Optional onValidationFailed

onValidationFailed?: Nilable<JsonSchemaValidationFailedHandler>

The custom error handler.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc