org.openapitools.codegen.validations.oas

Class OpenApiEvaluator

java.lang.Object

org.openapitools.codegen.validations.oas.OpenApiEvaluator

All Implemented Interfaces:

Validator<io.swagger.v3.oas.models.OpenAPI>

public class OpenApiEvaluator
extends Object
implements Validator<io.swagger.v3.oas.models.OpenAPI>

A validator which evaluates an OpenAPI 3.x specification document

Constructor Summary

Constructors

Constructor and Description
OpenApiEvaluator(RuleConfiguration ruleConfiguration) Constructs a new instance of OpenApiEvaluator with applied rules.

Method Summary

Modifier and Type	Method and Description
ValidationResult	validate(io.swagger.v3.oas.models.OpenAPI specification) Validates input, resulting in a instance of ValidationResult which provides details on all validations performed (success, error, warning).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenApiEvaluator

public OpenApiEvaluator(RuleConfiguration ruleConfiguration)

Constructs a new instance of OpenApiEvaluator with applied rules.

Parameters:

ruleConfiguration - The set of rules to be applied to evaluation.

Method Detail

validate

public ValidationResult validate(io.swagger.v3.oas.models.OpenAPI specification)

Validates input, resulting in a instance of ValidationResult which provides details on all validations performed (success, error, warning).

Specified by:

validate in interface Validator<io.swagger.v3.oas.models.OpenAPI>

Parameters:

specification - The OpenAPI object instance to be validated.

Returns:

A ValidationResult which details the success, error, and warning validation results.