autodocodec-schema-0.2.0.1: Autodocodec interpreters for JSON Schema
Safe HaskellSafe-Inferred
LanguageHaskell2010

Autodocodec.Schema

Synopsis

Documentation

jsonSchemaViaCodec :: forall a. HasCodec a => JSONSchema Source #

jsonSchemaVia :: ValueCodec input output -> JSONSchema Source #

jsonObjectSchemaViaCodec :: forall a. HasObjectCodec a => ObjectSchema Source #

jsonObjectSchemaVia :: ObjectCodec input output -> ObjectSchema Source #

data JSONSchema Source #

A JSON Schema

http://json-schema.org/understanding-json-schema/reference/index.html

Contrary to a Codec, values of this type should be finite.

NOTE: This schema roundtrips to JSON, but it cannot expres everything that a fully-featured json-schema may be able to express.

Constructors

AnySchema 
NullSchema 
BoolSchema 
StringSchema 
IntegerSchema !(Bounds Integer) 
NumberSchema !(Bounds Scientific) 
ArraySchema !JSONSchema 
MapSchema !JSONSchema 
ObjectSchema !ObjectSchema

This needs to be a list because keys should stay in their original ordering.

ValueSchema !Value 
AnyOfSchema !(NonEmpty JSONSchema) 
OneOfSchema !(NonEmpty JSONSchema) 
CommentSchema !Text !JSONSchema 
RefSchema !Text 
WithDefSchema !(Map Text JSONSchema) !JSONSchema 

Instances

Instances details
FromJSON JSONSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

parseJSON :: Value -> Parser JSONSchema #

parseJSONList :: Value -> Parser [JSONSchema] #

omittedField :: Maybe JSONSchema #

ToJSON JSONSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

toJSON :: JSONSchema -> Value #

toEncoding :: JSONSchema -> Encoding #

toJSONList :: [JSONSchema] -> Value #

toEncodingList :: [JSONSchema] -> Encoding #

omitField :: JSONSchema -> Bool #

Generic JSONSchema Source # 
Instance details

Defined in Autodocodec.Schema

Associated Types

type Rep JSONSchema :: Type -> Type #

Methods

from :: JSONSchema -> Rep JSONSchema x #

to :: Rep JSONSchema x -> JSONSchema #

Show JSONSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

showsPrec :: Int -> JSONSchema -> ShowS #

show :: JSONSchema -> String #

showList :: [JSONSchema] -> ShowS #

Eq JSONSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

(==) :: JSONSchema -> JSONSchema -> Bool #

(/=) :: JSONSchema -> JSONSchema -> Bool #

Ord JSONSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

compare :: JSONSchema -> JSONSchema -> Ordering #

(<) :: JSONSchema -> JSONSchema -> Bool #

(<=) :: JSONSchema -> JSONSchema -> Bool #

(>) :: JSONSchema -> JSONSchema -> Bool #

(>=) :: JSONSchema -> JSONSchema -> Bool #

max :: JSONSchema -> JSONSchema -> JSONSchema #

min :: JSONSchema -> JSONSchema -> JSONSchema #

Validity JSONSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

validate :: JSONSchema -> Validation #

type Rep JSONSchema Source # 
Instance details

Defined in Autodocodec.Schema

type Rep JSONSchema = D1 ('MetaData "JSONSchema" "Autodocodec.Schema" "autodocodec-schema-0.2.0.1-2wc9dbNt7phGqXYr08Vr3t" 'False) (((C1 ('MetaCons "AnySchema" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NullSchema" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BoolSchema" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "StringSchema" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IntegerSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Bounds Integer)))) :+: (C1 ('MetaCons "NumberSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Bounds Scientific))) :+: C1 ('MetaCons "ArraySchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 JSONSchema))))) :+: (((C1 ('MetaCons "MapSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 JSONSchema)) :+: C1 ('MetaCons "ObjectSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ObjectSchema))) :+: (C1 ('MetaCons "ValueSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Value)) :+: C1 ('MetaCons "AnyOfSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty JSONSchema))))) :+: ((C1 ('MetaCons "OneOfSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty JSONSchema))) :+: C1 ('MetaCons "CommentSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 JSONSchema))) :+: (C1 ('MetaCons "RefSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "WithDefSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map Text JSONSchema)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 JSONSchema))))))

data ObjectSchema Source #

Constructors

ObjectKeySchema !Text !KeyRequirement !JSONSchema !(Maybe Text) 
ObjectAnySchema 
ObjectAnyOfSchema !(NonEmpty ObjectSchema) 
ObjectOneOfSchema !(NonEmpty ObjectSchema) 
ObjectAllOfSchema !(NonEmpty ObjectSchema) 

Instances

Instances details
FromJSON ObjectSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

parseJSON :: Value -> Parser ObjectSchema #

parseJSONList :: Value -> Parser [ObjectSchema] #

omittedField :: Maybe ObjectSchema #

ToJSON ObjectSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

toJSON :: ObjectSchema -> Value #

toEncoding :: ObjectSchema -> Encoding #

toJSONList :: [ObjectSchema] -> Value #

toEncodingList :: [ObjectSchema] -> Encoding #

omitField :: ObjectSchema -> Bool #

Generic ObjectSchema Source # 
Instance details

Defined in Autodocodec.Schema

Associated Types

type Rep ObjectSchema :: Type -> Type #

Methods

from :: ObjectSchema -> Rep ObjectSchema x #

to :: Rep ObjectSchema x -> ObjectSchema #

Show ObjectSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

showsPrec :: Int -> ObjectSchema -> ShowS #

show :: ObjectSchema -> String #

showList :: [ObjectSchema] -> ShowS #

Eq ObjectSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

(==) :: ObjectSchema -> ObjectSchema -> Bool #

(/=) :: ObjectSchema -> ObjectSchema -> Bool #

Ord ObjectSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

compare :: ObjectSchema -> ObjectSchema -> Ordering #

(<) :: ObjectSchema -> ObjectSchema -> Bool #

(<=) :: ObjectSchema -> ObjectSchema -> Bool #

(>) :: ObjectSchema -> ObjectSchema -> Bool #

(>=) :: ObjectSchema -> ObjectSchema -> Bool #

max :: ObjectSchema -> ObjectSchema -> ObjectSchema #

min :: ObjectSchema -> ObjectSchema -> ObjectSchema #

Validity ObjectSchema Source # 
Instance details

Defined in Autodocodec.Schema

Methods

validate :: ObjectSchema -> Validation #

type Rep ObjectSchema Source # 
Instance details

Defined in Autodocodec.Schema

type Rep ObjectSchema = D1 ('MetaData "ObjectSchema" "Autodocodec.Schema" "autodocodec-schema-0.2.0.1-2wc9dbNt7phGqXYr08Vr3t" 'False) ((C1 ('MetaCons "ObjectKeySchema" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KeyRequirement)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 JSONSchema) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)))) :+: C1 ('MetaCons "ObjectAnySchema" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ObjectAnyOfSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty ObjectSchema))) :+: (C1 ('MetaCons "ObjectOneOfSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty ObjectSchema))) :+: C1 ('MetaCons "ObjectAllOfSchema" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty ObjectSchema))))))

data KeyRequirement Source #

Constructors

Required 
Optional !(Maybe Value) 

Instances

Instances details
Generic KeyRequirement Source # 
Instance details

Defined in Autodocodec.Schema

Associated Types

type Rep KeyRequirement :: Type -> Type #

Methods

from :: KeyRequirement -> Rep KeyRequirement x #

to :: Rep KeyRequirement x -> KeyRequirement #

Show KeyRequirement Source # 
Instance details

Defined in Autodocodec.Schema

Methods

showsPrec :: Int -> KeyRequirement -> ShowS #

show :: KeyRequirement -> String #

showList :: [KeyRequirement] -> ShowS #

Eq KeyRequirement Source # 
Instance details

Defined in Autodocodec.Schema

Methods

(==) :: KeyRequirement -> KeyRequirement -> Bool #

(/=) :: KeyRequirement -> KeyRequirement -> Bool #

Ord KeyRequirement Source # 
Instance details

Defined in Autodocodec.Schema

Methods

compare :: KeyRequirement -> KeyRequirement -> Ordering #

(<) :: KeyRequirement -> KeyRequirement -> Bool #

(<=) :: KeyRequirement -> KeyRequirement -> Bool #

(>) :: KeyRequirement -> KeyRequirement -> Bool #

(>=) :: KeyRequirement -> KeyRequirement -> Bool #

max :: KeyRequirement -> KeyRequirement -> KeyRequirement #

min :: KeyRequirement -> KeyRequirement -> KeyRequirement #

Validity KeyRequirement Source # 
Instance details

Defined in Autodocodec.Schema

Methods

validate :: KeyRequirement -> Validation #

type Rep KeyRequirement Source # 
Instance details

Defined in Autodocodec.Schema

type Rep KeyRequirement = D1 ('MetaData "KeyRequirement" "Autodocodec.Schema" "autodocodec-schema-0.2.0.1-2wc9dbNt7phGqXYr08Vr3t" 'False) (C1 ('MetaCons "Required" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Optional" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Value))))

validateAccordingTo :: Value -> JSONSchema -> Bool Source #

validateObjectAccordingTo :: Value -> JSONSchema -> Bool Source #