Safe Haskell	None
Language	Haskell2010

Data.Validator.Draft4.Object

Contents

maxProperties
minProperties
required
dependencies
properties
patternProperties
additionalProperties

Synopsis

maxProperties

maxProperties :: Int -> HashMap Text Value -> Maybe (Fail ()) Source #

The spec requires "maxProperties" to be non-negative.

minProperties

minProperties :: Int -> HashMap Text Value -> Maybe (Fail ()) Source #

The spec requires "minProperties" to be non-negative.

required

newtype Required Source #

From the spec:

The value of this keyword MUST be an array.
This array MUST have at least one element.
Elements of this array MUST be strings, and MUST be unique.

We don't enfore that Required has at least one element in the haskell code, but we do in the FromJSON instance.

Constructors

Required
Fields _unRequired :: Set Text

Instances

Eq Required Source #
Methods (==) :: Required -> Required -> Bool # (/=) :: Required -> Required -> Bool #
Show Required Source #
Methods showsPrec :: Int -> Required -> ShowS # show :: Required -> String # showList :: [Required] -> ShowS #
Arbitrary Required Source #
Methods arbitrary :: Gen Required # shrink :: Required -> [Required] #
FromJSON Required Source #
Methods parseJSON :: Value -> Parser Required # parseJSONList :: Value -> Parser [Required] #
ToJSON Required Source #
Methods toJSON :: Required -> Value # toEncoding :: Required -> Encoding # toJSONList :: [Required] -> Value # toEncodingList :: [Required] -> Encoding #

required :: Required -> HashMap Text Value -> Maybe (Fail ()) Source #

dependencies

data Dependency schema Source #

Constructors

SchemaDependency schema
PropertyDependency (Set Text)

Instances

Eq schema => Eq (Dependency schema) Source #
Methods (==) :: Dependency schema -> Dependency schema -> Bool # (/=) :: Dependency schema -> Dependency schema -> Bool #
Show schema => Show (Dependency schema) Source #
Methods showsPrec :: Int -> Dependency schema -> ShowS # show :: Dependency schema -> String # showList :: [Dependency schema] -> ShowS #
Arbitrary schema => Arbitrary (Dependency schema) Source #
Methods arbitrary :: Gen (Dependency schema) # shrink :: Dependency schema -> [Dependency schema] #
FromJSON schema => FromJSON (Dependency schema) Source #
Methods parseJSON :: Value -> Parser (Dependency schema) # parseJSONList :: Value -> Parser [Dependency schema] #
ToJSON schema => ToJSON (Dependency schema) Source #
Methods toJSON :: Dependency schema -> Value # toEncoding :: Dependency schema -> Encoding # toJSONList :: [Dependency schema] -> Value # toEncodingList :: [Dependency schema] -> Encoding #

data DependencyInvalid err Source #

Constructors

SchemaDependencyInvalid err
PropertyDependencyInvalid

Instances

Eq err => Eq (DependencyInvalid err) Source #
Methods (==) :: DependencyInvalid err -> DependencyInvalid err -> Bool # (/=) :: DependencyInvalid err -> DependencyInvalid err -> Bool #
Show err => Show (DependencyInvalid err) Source #
Methods showsPrec :: Int -> DependencyInvalid err -> ShowS # show :: DependencyInvalid err -> String # showList :: [DependencyInvalid err] -> ShowS #

dependencies :: forall err schema. (schema -> Value -> [Fail err]) -> HashMap Text (Dependency schema) -> HashMap Text Value -> [Fail (DependencyInvalid err)] Source #

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

This keyword's value MUST be an object.
Each value of this object MUST be either an object or an array.

If the value is an object, it MUST be a valid JSON Schema.
This is called a schema dependency.

If the value is an array, it MUST have at least one element.
Each element MUST be a string, and elements in the array MUST be unique.
This is called a property dependency.

newtype Remaining Source #

For internal use.

Constructors

Remaining
Fields _unRemaining :: HashMap Text Value

properties

data PropertiesInvalid err Source #

Constructors

PropertiesInvalid err
PropPatternInvalid err
PropAdditionalInvalid (AdditionalPropertiesInvalid err)

Instances

Eq err => Eq (PropertiesInvalid err) Source #
Methods (==) :: PropertiesInvalid err -> PropertiesInvalid err -> Bool # (/=) :: PropertiesInvalid err -> PropertiesInvalid err -> Bool #
Show err => Show (PropertiesInvalid err) Source #
Methods showsPrec :: Int -> PropertiesInvalid err -> ShowS # show :: PropertiesInvalid err -> String # showList :: [PropertiesInvalid err] -> ShowS #

properties :: forall err schema. (schema -> Value -> [Fail err]) -> Maybe (HashMap Text schema) -> Maybe (AdditionalProperties schema) -> HashMap Text schema -> HashMap Text Value -> [Fail (PropertiesInvalid err)] Source #

In order of what's tried: "properties", "patternProperties", "additionalProperties".

patternProperties

data PatternPropertiesInvalid err Source #

Constructors

PPInvalid err
PPAdditionalPropertiesInvalid (AdditionalPropertiesInvalid err)

Instances

Eq err => Eq (PatternPropertiesInvalid err) Source #
Methods (==) :: PatternPropertiesInvalid err -> PatternPropertiesInvalid err -> Bool # (/=) :: PatternPropertiesInvalid err -> PatternPropertiesInvalid err -> Bool #
Show err => Show (PatternPropertiesInvalid err) Source #
Methods showsPrec :: Int -> PatternPropertiesInvalid err -> ShowS # show :: PatternPropertiesInvalid err -> String # showList :: [PatternPropertiesInvalid err] -> ShowS #

patternProperties :: forall err schema. (schema -> Value -> [Fail err]) -> Bool -> Maybe (AdditionalProperties schema) -> HashMap Text schema -> HashMap Text Value -> [Fail (PatternPropertiesInvalid err)] Source #

patternAndUnmatched :: forall err schema. (schema -> Value -> [Fail err]) -> HashMap Text schema -> HashMap Text Value -> ([Fail err], Remaining) Source #

additionalProperties

data AdditionalProperties schema Source #

Constructors

AdditionalPropertiesBool Bool
AdditionalPropertiesObject schema

Instances

Eq schema => Eq (AdditionalProperties schema) Source #
Methods (==) :: AdditionalProperties schema -> AdditionalProperties schema -> Bool # (/=) :: AdditionalProperties schema -> AdditionalProperties schema -> Bool #
Show schema => Show (AdditionalProperties schema) Source #
Methods showsPrec :: Int -> AdditionalProperties schema -> ShowS # show :: AdditionalProperties schema -> String # showList :: [AdditionalProperties schema] -> ShowS #
Arbitrary schema => Arbitrary (AdditionalProperties schema) Source #
Methods arbitrary :: Gen (AdditionalProperties schema) # shrink :: AdditionalProperties schema -> [AdditionalProperties schema] #
FromJSON schema => FromJSON (AdditionalProperties schema) Source #
Methods parseJSON :: Value -> Parser (AdditionalProperties schema) # parseJSONList :: Value -> Parser [AdditionalProperties schema] #
ToJSON schema => ToJSON (AdditionalProperties schema) Source #
Methods toJSON :: AdditionalProperties schema -> Value # toEncoding :: AdditionalProperties schema -> Encoding # toJSONList :: [AdditionalProperties schema] -> Value # toEncodingList :: [AdditionalProperties schema] -> Encoding #

data AdditionalPropertiesInvalid err Source #

Constructors

APBoolInvalid
APObjectInvalid err

Instances

Eq err => Eq (AdditionalPropertiesInvalid err) Source #
Methods (==) :: AdditionalPropertiesInvalid err -> AdditionalPropertiesInvalid err -> Bool # (/=) :: AdditionalPropertiesInvalid err -> AdditionalPropertiesInvalid err -> Bool #
Show err => Show (AdditionalPropertiesInvalid err) Source #
Methods showsPrec :: Int -> AdditionalPropertiesInvalid err -> ShowS # show :: AdditionalPropertiesInvalid err -> String # showList :: [AdditionalPropertiesInvalid err] -> ShowS #

additionalProperties :: forall err schema. (schema -> Value -> [Fail err]) -> Bool -> AdditionalProperties schema -> HashMap Text Value -> [Fail (AdditionalPropertiesInvalid err)] Source #

additionalPropertiesBool :: Bool -> HashMap Text Value -> [Fail ()] Source #

additionalPropertiesObject :: forall err schema. (schema -> Value -> [Fail err]) -> schema -> HashMap Text Value -> [Fail err] Source #