Data.JSON.Schema.Validate

Documentation

isValid :: Schema -> Value -> Bool

Predicate version of validate.

validate :: Schema -> Value -> Vector ValidationError

Validates a value against a schema returning errors.

data ValidationError

Constructors

ValidationError

Fields

• path :: Vector Text

  The Path to the property where the error occured, empty if the error is on the top level.

• errorType :: ErrorType

Instances

Eq ValidationError

Defined in Data.JSON.Schema.Validate

Methods

(==) :: ValidationError -> ValidationError -> Bool

(/=) :: ValidationError -> ValidationError -> Bool

Show ValidationError

Defined in Data.JSON.Schema.Validate

Methods

showsPrec :: Int -> ValidationError -> ShowS

show :: ValidationError -> String

showList :: [ValidationError] -> ShowS

data ErrorType

Constructors

Mismatch Schema Value

General type error.

BoundError Bound Scientific

Number out of bounds.

LengthBoundError LengthBound Int

String or Array out of bounds.

TupleLength Int Int

Expected and actual tuple length.

MissingRequiredField Text

A required field is missing.

ChoiceError (Vector (Vector ValidationError)) Value

All choices failed, contains the error of each branch.

NonUniqueArray (HashMap Value Int)

The elements in the array that are duplicated with the number of occurences (at least 2).

Instances

Eq ErrorType

Defined in Data.JSON.Schema.Validate

Methods

(==) :: ErrorType -> ErrorType -> Bool

(/=) :: ErrorType -> ErrorType -> Bool

Show ErrorType

Defined in Data.JSON.Schema.Validate

Methods

showsPrec :: Int -> ErrorType -> ShowS

show :: ErrorType -> String

showList :: [ErrorType] -> ShowS