Data.Validator.Draft4

Turn the validation functions into actual Validators.

From this point on they know how to parse themselves from JSON and also know how to extract subschemas embedded within themselves.

Documentation

run :: FromJSON b => (a -> b -> [c]) -> Maybe a -> Value -> [c]

For internal use.

noEmbedded :: a -> ([b], [b])

For internal use.

Numbers

newtype MultipleOf

Constructors

MultipleOf

Fields

• _unMultipleOf :: Scientific

Instances

Eq MultipleOf

Methods

(==) :: MultipleOf -> MultipleOf -> Bool

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

Show MultipleOf

Methods

showsPrec :: Int -> MultipleOf -> ShowS

show :: MultipleOf -> String

showList :: [MultipleOf] -> ShowS

FromJSON MultipleOf

Methods

parseJSON :: Value -> Parser MultipleOf

multipleOf :: Validator a (Maybe MultipleOf) ()

data MaximumContext

Constructors

MaximumContext Bool Scientific

Instances

Eq MaximumContext

Methods

(==) :: MaximumContext -> MaximumContext -> Bool

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

Show MaximumContext

Methods

showsPrec :: Int -> MaximumContext -> ShowS

show :: MaximumContext -> String

showList :: [MaximumContext] -> ShowS

FromJSON MaximumContext

Methods

parseJSON :: Value -> Parser MaximumContext

maximumVal :: Validator a (Maybe MaximumContext) MaximumInvalid

data MinimumContext

Constructors

MinimumContext Bool Scientific

Instances

Eq MinimumContext

Methods

(==) :: MinimumContext -> MinimumContext -> Bool

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

Show MinimumContext

Methods

showsPrec :: Int -> MinimumContext -> ShowS

show :: MinimumContext -> String

showList :: [MinimumContext] -> ShowS

FromJSON MinimumContext

Methods

parseJSON :: Value -> Parser MinimumContext

minimumVal :: Validator a (Maybe MinimumContext) MinimumInvalid

Strings

newtype MaxLength

Constructors

MaxLength

Fields

• _unMaxLength :: Int

Instances

Eq MaxLength

Methods

(==) :: MaxLength -> MaxLength -> Bool

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

Show MaxLength

Methods

showsPrec :: Int -> MaxLength -> ShowS

show :: MaxLength -> String

showList :: [MaxLength] -> ShowS

FromJSON MaxLength

Methods

parseJSON :: Value -> Parser MaxLength

maxLength :: Validator a (Maybe MaxLength) ()

newtype MinLength

Constructors

MinLength

Fields

• _unMinLength :: Int

Instances

Eq MinLength

Methods

(==) :: MinLength -> MinLength -> Bool

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

Show MinLength

Methods

showsPrec :: Int -> MinLength -> ShowS

show :: MinLength -> String

showList :: [MinLength] -> ShowS

FromJSON MinLength

Methods

parseJSON :: Value -> Parser MinLength

minLength :: Validator a (Maybe MinLength) ()

newtype PatternVal

Constructors

PatternVal

Fields

• _unPatternVal :: Text

Instances

Eq PatternVal

Methods

(==) :: PatternVal -> PatternVal -> Bool

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

Show PatternVal

Methods

showsPrec :: Int -> PatternVal -> ShowS

show :: PatternVal -> String

showList :: [PatternVal] -> ShowS

FromJSON PatternVal

Methods

parseJSON :: Value -> Parser PatternVal

patternVal :: Validator a (Maybe PatternVal) ()

Arrays

newtype MaxItems

Constructors

MaxItems

Fields

• _unMaxItems :: Int

Instances

Eq MaxItems

Methods

(==) :: MaxItems -> MaxItems -> Bool

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

Show MaxItems

Methods

showsPrec :: Int -> MaxItems -> ShowS

show :: MaxItems -> String

showList :: [MaxItems] -> ShowS

FromJSON MaxItems

Methods

parseJSON :: Value -> Parser MaxItems

maxItems :: Validator a (Maybe MaxItems) ()

newtype MinItems

Constructors

MinItems

Fields

• _unMinItems :: Int

Instances

Eq MinItems

Methods

(==) :: MinItems -> MinItems -> Bool

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

Show MinItems

Methods

showsPrec :: Int -> MinItems -> ShowS

show :: MinItems -> String

showList :: [MinItems] -> ShowS

FromJSON MinItems

Methods

parseJSON :: Value -> Parser MinItems

minItems :: Validator a (Maybe MinItems) ()

newtype UniqueItems

Constructors

UniqueItems

Fields

• _unUniqueItems :: Bool

Instances

Eq UniqueItems

Methods

(==) :: UniqueItems -> UniqueItems -> Bool

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

Show UniqueItems

Methods

showsPrec :: Int -> UniqueItems -> ShowS

show :: UniqueItems -> String

showList :: [UniqueItems] -> ShowS

FromJSON UniqueItems

Methods

parseJSON :: Value -> Parser UniqueItems

uniqueItems :: Validator a (Maybe UniqueItems) ()

data ItemsContext schema

Constructors

ItemsContext (Maybe (AdditionalItems schema)) (Items schema)

Instances

Eq schema => Eq (ItemsContext schema)

Methods

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

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

Show schema => Show (ItemsContext schema)

Methods

showsPrec :: Int -> ItemsContext schema -> ShowS

show :: ItemsContext schema -> String

showList :: [ItemsContext schema] -> ShowS

FromJSON schema => FromJSON (ItemsContext schema)

Methods

parseJSON :: Value -> Parser (ItemsContext schema)

items :: (schema -> Value -> [Fail err]) -> Validator schema (Maybe (ItemsContext schema)) (ItemsInvalid err)

newtype AdditionalItemsContext schema

Constructors

AdditionalItemsContext

Fields

• _unAdditionalItemsContext :: AdditionalItems schema

Instances

Eq schema => Eq (AdditionalItemsContext schema)

Methods

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

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

Show schema => Show (AdditionalItemsContext schema)

Methods

showsPrec :: Int -> AdditionalItemsContext schema -> ShowS

show :: AdditionalItemsContext schema -> String

showList :: [AdditionalItemsContext schema] -> ShowS

FromJSON schema => FromJSON (AdditionalItemsContext schema)

Methods

parseJSON :: Value -> Parser (AdditionalItemsContext schema)

additionalItemsEmbedded :: Validator schema (Maybe (AdditionalItemsContext schema)) err

Since items will always take care of validating additionalItems as well, the actual validation side of additionalItemsEmbedded is disabled.

newtype Definitions schema

Constructors

Definitions

Fields

• _unDefinitions :: HashMap Text schema

Instances

Eq schema => Eq (Definitions schema)

Methods

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

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

Show schema => Show (Definitions schema)

Methods

showsPrec :: Int -> Definitions schema -> ShowS

show :: Definitions schema -> String

showList :: [Definitions schema] -> ShowS

FromJSON schema => FromJSON (Definitions schema)

Methods

parseJSON :: Value -> Parser (Definitions schema)

definitionsEmbedded :: Validator schema (Maybe (Definitions schema)) err

Placing this here since it's similar to "additionalItems". in that its validator doesn't run.

TODO: Add tests to the language agnostic test suite for both "additionalItems" and this.

Objects

newtype MaxProperties

Constructors

MaxProperties

Fields

• _unMaxProperties :: Int

Instances

Eq MaxProperties

Methods

(==) :: MaxProperties -> MaxProperties -> Bool

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

Show MaxProperties

Methods

showsPrec :: Int -> MaxProperties -> ShowS

show :: MaxProperties -> String

showList :: [MaxProperties] -> ShowS

FromJSON MaxProperties

Methods

parseJSON :: Value -> Parser MaxProperties

maxProperties :: Validator a (Maybe MaxProperties) ()

newtype MinProperties

Constructors

MinProperties

Fields

• _unMinProperties :: Int

Instances

Eq MinProperties

Methods

(==) :: MinProperties -> MinProperties -> Bool

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

Show MinProperties

Methods

showsPrec :: Int -> MinProperties -> ShowS

show :: MinProperties -> String

showList :: [MinProperties] -> ShowS

FromJSON MinProperties

Methods

parseJSON :: Value -> Parser MinProperties

minProperties :: Validator a (Maybe MinProperties) ()

newtype RequiredContext

Constructors

RequiredContext

Fields

• _unRequiredContext :: Required

Instances

Eq RequiredContext

Methods

(==) :: RequiredContext -> RequiredContext -> Bool

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

Show RequiredContext

Methods

showsPrec :: Int -> RequiredContext -> ShowS

show :: RequiredContext -> String

showList :: [RequiredContext] -> ShowS

FromJSON RequiredContext

Methods

parseJSON :: Value -> Parser RequiredContext

required :: Validator a (Maybe RequiredContext) ()

newtype DependenciesContext schema

Constructors

DependenciesContext

Fields

• _unDependenciesContext :: HashMap Text (Dependency schema)

Instances

Eq schema => Eq (DependenciesContext schema)

Methods

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

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

Show schema => Show (DependenciesContext schema)

Methods

showsPrec :: Int -> DependenciesContext schema -> ShowS

show :: DependenciesContext schema -> String

showList :: [DependenciesContext schema] -> ShowS

FromJSON schema => FromJSON (DependenciesContext schema)

Methods

parseJSON :: Value -> Parser (DependenciesContext schema)

dependencies :: (schema -> Value -> [Fail err]) -> Validator schema (Maybe (DependenciesContext schema)) (DependencyInvalid err)

data PropertiesContext schema

Constructors

PropertiesContext (Maybe (HashMap Text schema)) (Maybe (AdditionalProperties schema)) (HashMap Text schema)

Instances

Eq schema => Eq (PropertiesContext schema)

Methods

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

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

Show schema => Show (PropertiesContext schema)

Methods

showsPrec :: Int -> PropertiesContext schema -> ShowS

show :: PropertiesContext schema -> String

showList :: [PropertiesContext schema] -> ShowS

FromJSON schema => FromJSON (PropertiesContext schema)

Methods

parseJSON :: Value -> Parser (PropertiesContext schema)

properties :: (schema -> Value -> [Fail err]) -> Validator schema (Maybe (PropertiesContext schema)) (PropertiesInvalid err)

data PatternPropertiesContext schema

The first argument is whether the validator should be run. If "properties" exists it will be parsed to False.

Constructors

PatternPropertiesContext Bool (Maybe (AdditionalProperties schema)) (HashMap Text schema)

Instances

Eq schema => Eq (PatternPropertiesContext schema)

Methods

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

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

Show schema => Show (PatternPropertiesContext schema)

Methods

showsPrec :: Int -> PatternPropertiesContext schema -> ShowS

show :: PatternPropertiesContext schema -> String

showList :: [PatternPropertiesContext schema] -> ShowS

FromJSON schema => FromJSON (PatternPropertiesContext schema)

Methods

parseJSON :: Value -> Parser (PatternPropertiesContext schema)

patternProperties :: (schema -> Value -> [Fail err]) -> Validator schema (Maybe (PatternPropertiesContext schema)) (PatternPropertiesInvalid err)

data AdditionalPropertiesContext schema

The first argument is whether the validator should be run. If "properties" or "patternProperties" exist it will be parsed to False.

Constructors

AdditionalPropertiesContext Bool (AdditionalProperties schema)

Instances

Eq schema => Eq (AdditionalPropertiesContext schema)

Methods

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

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

Show schema => Show (AdditionalPropertiesContext schema)

Methods

showsPrec :: Int -> AdditionalPropertiesContext schema -> ShowS

show :: AdditionalPropertiesContext schema -> String

showList :: [AdditionalPropertiesContext schema] -> ShowS

FromJSON schema => FromJSON (AdditionalPropertiesContext schema)

Methods

parseJSON :: Value -> Parser (AdditionalPropertiesContext schema)

additionalProperties :: (schema -> Value -> [Fail err]) -> Validator schema (Maybe (AdditionalPropertiesContext schema)) (AdditionalPropertiesInvalid err)

Any

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

ref :: (FromJSON schema, ToJSON schema) => VisitedSchemas -> Maybe Text -> (Maybe Text -> Maybe schema) -> (VisitedSchemas -> Maybe Text -> schema -> Value -> [Fail err]) -> Validator a (Maybe Ref) (RefInvalid err)

newtype EnumContext

Constructors

EnumContext

Fields

• _unEnumContext :: EnumVal

Instances

Eq EnumContext

Methods

(==) :: EnumContext -> EnumContext -> Bool

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

Show EnumContext

Methods

showsPrec :: Int -> EnumContext -> ShowS

show :: EnumContext -> String

showList :: [EnumContext] -> ShowS

FromJSON EnumContext

Methods

parseJSON :: Value -> Parser EnumContext

enumVal :: Validator a (Maybe EnumContext) ()

newtype TypeContext

Constructors

TypeContext

Fields

• _unTypeContext :: TypeVal

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

typeVal :: Validator a (Maybe TypeContext) ()

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)

allOf :: (schema -> Value -> [Fail err]) -> Validator schema (Maybe (AllOf schema)) err

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)

anyOf :: ToJSON schema => (schema -> Value -> [Fail err]) -> Validator schema (Maybe (AnyOf schema)) ()

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)

oneOf :: ToJSON schema => (schema -> Value -> [Fail err]) -> Validator schema (Maybe (OneOf schema)) ()

newtype NotVal schema

Constructors

NotVal

Fields

• _unNotVal :: schema

Instances

Eq schema => Eq (NotVal schema)

Methods

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

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

Show schema => Show (NotVal schema)

Methods

showsPrec :: Int -> NotVal schema -> ShowS

show :: NotVal schema -> String

showList :: [NotVal schema] -> ShowS

FromJSON schema => FromJSON (NotVal schema)

Methods

parseJSON :: Value -> Parser (NotVal schema)

notVal :: ToJSON schema => (schema -> Value -> [Fail err]) -> Validator schema (Maybe (NotVal schema)) ()