Package io.openapiparser

Class OpenApiResult31

java.lang.Object

io.openapiparser.OpenApiResult31

All Implemented Interfaces:

OpenApiResult

public class OpenApiResult31
extends java.lang.Object
implements OpenApiResult

Nested Class Summary

Nested classes/interfaces inherited from interface io.openapiparser.OpenApiResult

OpenApiResult.Version

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	OPENAPI_SCHEMA	Deprecated.

Constructor Summary

Constructors

Constructor	Description
OpenApiResult31(Context context, io.openapiprocessor.jsonschema.schema.Bucket root)	Deprecated.
OpenApiResult31(Context context, io.openapiprocessor.jsonschema.schema.Bucket root, io.openapiprocessor.jsonschema.schema.DocumentStore documents)

Method Summary

Modifier and Type	Method	Description
<T> T	getModel(java.lang.Class<T> api)	get the OpenAPI model.
java.util.Collection<ValidationError>	getValidationErrors()	validation errors.
OpenApiResult.Version	getVersion()	get the OpenAPI OpenApiResult.Version of the OpenAPI description.
boolean	validate(io.openapiprocessor.jsonschema.validator.Validator validator, io.openapiprocessor.jsonschema.schema.SchemaStore schemaStore)	run schema validation.

Methods inherited from class java.lang.Object

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

Field Detail

OPENAPI_SCHEMA

@Deprecated
public static final java.lang.String OPENAPI_SCHEMA

Deprecated.

See Also:

Constant Field Values

Constructor Detail

OpenApiResult31

@Deprecated
public OpenApiResult31(Context context,
                       io.openapiprocessor.jsonschema.schema.Bucket root)

Deprecated.

OpenApiResult31

public OpenApiResult31(Context context,
                       io.openapiprocessor.jsonschema.schema.Bucket root,
                       io.openapiprocessor.jsonschema.schema.DocumentStore documents)

Method Detail

getVersion

public OpenApiResult.Version getVersion()

Description copied from interface: OpenApiResult

get the OpenAPI OpenApiResult.Version of the OpenAPI description.

Specified by:

getVersion in interface OpenApiResult

Returns:

the OpenApiResult.Version

getModel

public <T> T getModel(java.lang.Class<T> api)

Description copied from interface: OpenApiResult

get the OpenAPI model. T must be

• OpenApi if the version is V30
• OpenApi if the version is V31

otherwise, it will throw an IllegalArgumentException

Specified by:

getModel in interface OpenApiResult

Type Parameters:

T - OpenAPI model type

Parameters:

api - class of the OpenAPI model

Returns:

OpenAPI model

validate

public boolean validate(io.openapiprocessor.jsonschema.validator.Validator validator,
                        io.openapiprocessor.jsonschema.schema.SchemaStore schemaStore)

Description copied from interface: OpenApiResult

run schema validation. Retrieve the collection of validation messages from OpenApiResult.getValidationErrors().

Specified by:

validate in interface OpenApiResult

Parameters:

validator - json schema validator

schemaStore - json schema store

Returns:

true if valid, else false

getValidationErrors

public java.util.Collection<ValidationError> getValidationErrors()

Description copied from interface: OpenApiResult

validation errors.

Specified by:

getValidationErrors in interface OpenApiResult

Returns:

the validation errors.