JSONSchema.Validator.Draft4.Any

$ref

newtype Ref

Constructors

Ref

Fields

• _unRef :: Text

Instances

Eq Ref

Methods

(==) :: Ref -> Ref -> Bool

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

Show Ref

Methods

showsPrec :: Int -> Ref -> ShowS

show :: Ref -> String

showList :: [Ref] -> ShowS

FromJSON Ref

Methods

parseJSON :: Value -> Parser Ref

parseJSONList :: Value -> Parser [Ref]

data RefInvalid err

Constructors

RefResolution Text

Indicates a reference that failed to resolve.

NOTE: The language agnostic test suite doesn't specify if this should cause a validation error or should allow data to pass. We choose to return a validation error.

Also note that ideally we would enforce in the type system that any failing references be dealt with before valididation. Then this could be removed entirely.

RefPointerResolution JSONPointerError

RefLoop Text VisitedSchemas URIAndFragment

RefInvalid Text Value (NonEmpty err)

Text is the URI and Value is the linked schema.

Instances

Eq err => Eq (RefInvalid err)

Methods

(==) :: RefInvalid err -> RefInvalid err -> Bool

(/=) :: RefInvalid err -> RefInvalid err -> Bool

Show err => Show (RefInvalid err)

Methods

showsPrec :: Int -> RefInvalid err -> ShowS

show :: RefInvalid err -> String

showList :: [RefInvalid err] -> ShowS

newtype VisitedSchemas

Constructors

VisitedSchemas

Fields

• _unVisited :: [URIAndFragment]

Instances

Eq VisitedSchemas

Methods

(==) :: VisitedSchemas -> VisitedSchemas -> Bool

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

Show VisitedSchemas

Methods

showsPrec :: Int -> VisitedSchemas -> ShowS

show :: VisitedSchemas -> String

showList :: [VisitedSchemas] -> ShowS

Semigroup VisitedSchemas

Methods

(<>) :: VisitedSchemas -> VisitedSchemas -> VisitedSchemas

sconcat :: NonEmpty VisitedSchemas -> VisitedSchemas

stimes :: Integral b => b -> VisitedSchemas -> VisitedSchemas

Monoid VisitedSchemas

Methods

mempty :: VisitedSchemas

mappend :: VisitedSchemas -> VisitedSchemas -> VisitedSchemas

mconcat :: [VisitedSchemas] -> VisitedSchemas

refVal

Arguments

:: (FromJSON schema, ToJSON schema)

=> (Text -> Maybe schema)

Look up a schema.

-> (BaseURI -> schema -> BaseURI)

Update scope (needed after moving deeper into nested schemas).

-> (VisitedSchemas -> Scope schema -> schema -> Value -> [err])

Validate data.

-> VisitedSchemas

-> Scope schema

-> Ref

-> Value

-> Maybe (RefInvalid err)

getDocument

Arguments

:: (Text -> Maybe schema)

-> (BaseURI -> schema -> BaseURI)

-> Scope schema

-> Maybe Text

-> Text

-> Either Text (Scope schema, schema)

Left is the URI of the document we failed to resolve.

data JSONPointerError

Constructors

URLDecodingError UnicodeException

Aspirationally internal.

FormatError FormatError

ResolutionError ResolutionError

SubschemaDecodingError Text

Aspirationally internal.

Instances

Eq JSONPointerError

Methods

(==) :: JSONPointerError -> JSONPointerError -> Bool

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

Show JSONPointerError

Methods

showsPrec :: Int -> JSONPointerError -> ShowS

show :: JSONPointerError -> String

showList :: [JSONPointerError] -> ShowS

resolveFragment :: forall schema. (FromJSON schema, ToJSON schema) => (BaseURI -> schema -> BaseURI) -> Scope schema -> Text -> Either JSONPointerError (Scope schema, schema)

enum

newtype EnumValidator

From the spec: http://json-schema.org/latest/json-schema-validation.html#anchor76

The value of this keyword MUST be an array.
This array MUST have at least one element.
Elements in the array MUST be unique.

NOTE: We don't enforce the uniqueness constraint in the haskell code, but we do in the FromJSON instance.

Constructors

EnumValidator

Fields

• _unEnumValidator :: NonEmpty Value

Instances

Eq EnumValidator

Methods

(==) :: EnumValidator -> EnumValidator -> Bool

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

Show EnumValidator

Methods

showsPrec :: Int -> EnumValidator -> ShowS

show :: EnumValidator -> String

showList :: [EnumValidator] -> ShowS

Arbitrary EnumValidator

Methods

arbitrary :: Gen EnumValidator

shrink :: EnumValidator -> [EnumValidator]

FromJSON EnumValidator

Methods

parseJSON :: Value -> Parser EnumValidator

parseJSONList :: Value -> Parser [EnumValidator]

data EnumInvalid

Constructors

EnumInvalid EnumValidator Value

Instances

Eq EnumInvalid

Methods

(==) :: EnumInvalid -> EnumInvalid -> Bool

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

Show EnumInvalid

Methods

showsPrec :: Int -> EnumInvalid -> ShowS

show :: EnumInvalid -> String

showList :: [EnumInvalid] -> ShowS

enumVal :: EnumValidator -> Value -> Maybe EnumInvalid

type

newtype TypeContext

This is separate from TypeValidator so that TypeValidator can be used to write Schema without messing up the FromJSON instance of that data type.

Constructors

TypeContext

Fields

• _unTypeContext :: TypeValidator

Instances

Eq TypeContext

Methods

(==) :: TypeContext -> TypeContext -> Bool

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

Show TypeContext

Methods

showsPrec :: Int -> TypeContext -> ShowS

show :: TypeContext -> String

showList :: [TypeContext] -> ShowS

FromJSON TypeContext

Methods

parseJSON :: Value -> Parser TypeContext

parseJSONList :: Value -> Parser [TypeContext]

data TypeValidator

Constructors

TypeValidatorString SchemaType

TypeValidatorArray (Set SchemaType)

Instances

Eq TypeValidator

Methods

(==) :: TypeValidator -> TypeValidator -> Bool

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

Show TypeValidator

Methods

showsPrec :: Int -> TypeValidator -> ShowS

show :: TypeValidator -> String

showList :: [TypeValidator] -> ShowS

Semigroup TypeValidator

Methods

(<>) :: TypeValidator -> TypeValidator -> TypeValidator

sconcat :: NonEmpty TypeValidator -> TypeValidator

stimes :: Integral b => b -> TypeValidator -> TypeValidator

Arbitrary TypeValidator

Methods

arbitrary :: Gen TypeValidator

shrink :: TypeValidator -> [TypeValidator]

ToJSON TypeValidator

Methods

toJSON :: TypeValidator -> Value

toEncoding :: TypeValidator -> Encoding

toJSONList :: [TypeValidator] -> Value

toEncodingList :: [TypeValidator] -> Encoding

FromJSON TypeValidator

Methods

parseJSON :: Value -> Parser TypeValidator

parseJSONList :: Value -> Parser [TypeValidator]

data SchemaType

Constructors

SchemaObject

SchemaArray

SchemaString

SchemaNumber

SchemaInteger

SchemaBoolean

SchemaNull

Instances

Bounded SchemaType

Methods

minBound :: SchemaType

maxBound :: SchemaType

Enum SchemaType

Methods

succ :: SchemaType -> SchemaType

pred :: SchemaType -> SchemaType

toEnum :: Int -> SchemaType

fromEnum :: SchemaType -> Int

enumFrom :: SchemaType -> [SchemaType]

enumFromThen :: SchemaType -> SchemaType -> [SchemaType]

enumFromTo :: SchemaType -> SchemaType -> [SchemaType]

enumFromThenTo :: SchemaType -> SchemaType -> SchemaType -> [SchemaType]

Eq SchemaType

Methods

(==) :: SchemaType -> SchemaType -> Bool

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

Ord SchemaType

Methods

compare :: SchemaType -> SchemaType -> Ordering

(<) :: SchemaType -> SchemaType -> Bool

(<=) :: SchemaType -> SchemaType -> Bool

(>) :: SchemaType -> SchemaType -> Bool

(>=) :: SchemaType -> SchemaType -> Bool

max :: SchemaType -> SchemaType -> SchemaType

min :: SchemaType -> SchemaType -> SchemaType

Show SchemaType

Methods

showsPrec :: Int -> SchemaType -> ShowS

show :: SchemaType -> String

showList :: [SchemaType] -> ShowS

Generic SchemaType

Associated Types

type Rep SchemaType :: * -> *

Methods

from :: SchemaType -> Rep SchemaType x

to :: Rep SchemaType x -> SchemaType

Arbitrary SchemaType

Methods

arbitrary :: Gen SchemaType

shrink :: SchemaType -> [SchemaType]

ToJSON SchemaType

Methods

toJSON :: SchemaType -> Value

toEncoding :: SchemaType -> Encoding

toJSONList :: [SchemaType] -> Value

toEncodingList :: [SchemaType] -> Encoding

FromJSON SchemaType

Methods

parseJSON :: Value -> Parser SchemaType

parseJSONList :: Value -> Parser [SchemaType]

type Rep SchemaType

type Rep SchemaType = D1 (MetaData "SchemaType" "JSONSchema.Validator.Draft4.Any" "hjsonschema-1.6.1-ILl9gxDrDbb26xDwF9VrZ1" False) ((:+:) ((:+:) (C1 (MetaCons "SchemaObject" PrefixI False) U1) ((:+:) (C1 (MetaCons "SchemaArray" PrefixI False) U1) (C1 (MetaCons "SchemaString" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "SchemaNumber" PrefixI False) U1) (C1 (MetaCons "SchemaInteger" PrefixI False) U1)) ((:+:) (C1 (MetaCons "SchemaBoolean" PrefixI False) U1) (C1 (MetaCons "SchemaNull" PrefixI False) U1))))

data TypeValidatorInvalid

Constructors

TypeValidatorInvalid TypeValidator Value

Instances

Eq TypeValidatorInvalid

Methods

(==) :: TypeValidatorInvalid -> TypeValidatorInvalid -> Bool

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

Show TypeValidatorInvalid

Methods

showsPrec :: Int -> TypeValidatorInvalid -> ShowS

show :: TypeValidatorInvalid -> String

showList :: [TypeValidatorInvalid] -> ShowS

typeVal :: TypeContext -> Value -> Maybe TypeValidatorInvalid

setFromTypeValidator :: TypeValidator -> Set SchemaType

Internal.

allOf

newtype AllOf schema

Constructors

AllOf

Fields

• _unAllOf :: NonEmpty schema

Instances

Eq schema => Eq (AllOf schema)

Methods

(==) :: AllOf schema -> AllOf schema -> Bool

(/=) :: AllOf schema -> AllOf schema -> Bool

Show schema => Show (AllOf schema)

Methods

showsPrec :: Int -> AllOf schema -> ShowS

show :: AllOf schema -> String

showList :: [AllOf schema] -> ShowS

FromJSON schema => FromJSON (AllOf schema)

Methods

parseJSON :: Value -> Parser (AllOf schema)

parseJSONList :: Value -> Parser [AllOf schema]

newtype AllOfInvalid err

Constructors

AllOfInvalid (NonEmpty (Index, NonEmpty err))

Instances

Eq err => Eq (AllOfInvalid err)

Methods

(==) :: AllOfInvalid err -> AllOfInvalid err -> Bool

(/=) :: AllOfInvalid err -> AllOfInvalid err -> Bool

Show err => Show (AllOfInvalid err)

Methods

showsPrec :: Int -> AllOfInvalid err -> ShowS

show :: AllOfInvalid err -> String

showList :: [AllOfInvalid err] -> ShowS

allOfVal :: forall err schema. (schema -> Value -> [err]) -> AllOf schema -> Value -> Maybe (AllOfInvalid err)

anyOf

newtype AnyOf schema

Constructors

AnyOf

Fields

• _unAnyOf :: NonEmpty schema

Instances

Eq schema => Eq (AnyOf schema)

Methods

(==) :: AnyOf schema -> AnyOf schema -> Bool

(/=) :: AnyOf schema -> AnyOf schema -> Bool

Show schema => Show (AnyOf schema)

Methods

showsPrec :: Int -> AnyOf schema -> ShowS

show :: AnyOf schema -> String

showList :: [AnyOf schema] -> ShowS

FromJSON schema => FromJSON (AnyOf schema)

Methods

parseJSON :: Value -> Parser (AnyOf schema)

parseJSONList :: Value -> Parser [AnyOf schema]

newtype AnyOfInvalid err

Constructors

AnyOfInvalid (NonEmpty (Index, NonEmpty err))

Instances

Eq err => Eq (AnyOfInvalid err)

Methods

(==) :: AnyOfInvalid err -> AnyOfInvalid err -> Bool

(/=) :: AnyOfInvalid err -> AnyOfInvalid err -> Bool

Show err => Show (AnyOfInvalid err)

Methods

showsPrec :: Int -> AnyOfInvalid err -> ShowS

show :: AnyOfInvalid err -> String

showList :: [AnyOfInvalid err] -> ShowS

anyOfVal :: forall err schema. (schema -> Value -> [err]) -> AnyOf schema -> Value -> Maybe (AnyOfInvalid err)

oneOf

newtype OneOf schema

Constructors

OneOf

Fields

• _unOneOf :: NonEmpty schema

Instances

Eq schema => Eq (OneOf schema)

Methods

(==) :: OneOf schema -> OneOf schema -> Bool

(/=) :: OneOf schema -> OneOf schema -> Bool

Show schema => Show (OneOf schema)

Methods

showsPrec :: Int -> OneOf schema -> ShowS

show :: OneOf schema -> String

showList :: [OneOf schema] -> ShowS

FromJSON schema => FromJSON (OneOf schema)

Methods

parseJSON :: Value -> Parser (OneOf schema)

parseJSONList :: Value -> Parser [OneOf schema]

data OneOfInvalid err

Constructors

TooManySuccesses (NonEmpty (Index, Value)) Value

The NonEmpty lists contains tuples whose contents are the index of a schema that validated the data and the contents of that schema.

NoSuccesses (NonEmpty (Index, NonEmpty err)) Value

The NonEmpty lists contains tuples whose contents are the index of a schema that failed to validate the data and the failures it produced.

Instances

Eq err => Eq (OneOfInvalid err)

Methods

(==) :: OneOfInvalid err -> OneOfInvalid err -> Bool

(/=) :: OneOfInvalid err -> OneOfInvalid err -> Bool

Show err => Show (OneOfInvalid err)

Methods

showsPrec :: Int -> OneOfInvalid err -> ShowS

show :: OneOfInvalid err -> String

showList :: [OneOfInvalid err] -> ShowS

oneOfVal :: forall err schema. ToJSON schema => (schema -> Value -> [err]) -> OneOf schema -> Value -> Maybe (OneOfInvalid err)

not

newtype NotValidator schema

Constructors

NotValidator

Fields

• _unNotValidator :: schema

Instances

Eq schema => Eq (NotValidator schema)

Methods

(==) :: NotValidator schema -> NotValidator schema -> Bool

(/=) :: NotValidator schema -> NotValidator schema -> Bool

Show schema => Show (NotValidator schema)

Methods

showsPrec :: Int -> NotValidator schema -> ShowS

show :: NotValidator schema -> String

showList :: [NotValidator schema] -> ShowS

FromJSON schema => FromJSON (NotValidator schema)

Methods

parseJSON :: Value -> Parser (NotValidator schema)

parseJSONList :: Value -> Parser [NotValidator schema]

data NotValidatorInvalid

Constructors

NotValidatorInvalid Value Value

Instances

Eq NotValidatorInvalid

Methods

(==) :: NotValidatorInvalid -> NotValidatorInvalid -> Bool

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

Show NotValidatorInvalid

Methods

showsPrec :: Int -> NotValidatorInvalid -> ShowS

show :: NotValidatorInvalid -> String

showList :: [NotValidatorInvalid] -> ShowS

notVal :: ToJSON schema => (schema -> Value -> [err]) -> NotValidator schema -> Value -> Maybe NotValidatorInvalid