Copyright	(c) 2024 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.Types.Blueprint.Schema

Description

Synopsis

data Schema
data PairSchema = MkPairSchema {
- psLeft ∷ Schema
- psRight ∷ Schema
}
data ConstructorSchema = MkConstructorSchema {
- csIndex ∷ Natural
- csFields ∷ [Schema]
}
data MapSchema = MkMapSchema {
- msKeys ∷ Schema
- msValues ∷ Schema
- msMinItems ∷ Maybe Natural
- msMaxItems ∷ Maybe Natural
}
data ListSchema = MkListSchema {
- lsItems ∷ ListItemSchema
- lsMinItems ∷ Maybe Natural
- lsMaxItems ∷ Maybe Natural
- lsUniqueItems ∷ Maybe Bool
}
data ListItemSchema
- = ListItemSchemaSchema Schema
- | ListItemSchemaSchemas [Schema]
data BytesSchema = MkBytesSchema {
- bsEnum ∷ [ByteString]
- bsMinLength ∷ Maybe Natural
- bsMaxLength ∷ Maybe Natural
}
emptyBytesSchema ∷ BytesSchema
data IntegerSchema = MkIntegerSchema {
- isMultipleOf ∷ Maybe Integer
- isMinimum ∷ Maybe Integer
- isMaximum ∷ Maybe Integer
- isExclusiveMinimum ∷ Maybe Integer
- isExclusiveMaximum ∷ Maybe Integer
}
emptyIntegerSchema ∷ IntegerSchema
data SchemaInfo = MkSchemaInfo {
- title ∷ Maybe Text
- description ∷ Maybe Text
- comment ∷ Maybe Text
}
emptySchemaInfo ∷ SchemaInfo

Documentation

data Schema #

Blueprint schema definition, as defined by the CIP-0057.

Instances

Instances details

FromJSON Schema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods parseJSON ∷ Value → Parser Schema # parseJSONList ∷ Value → Parser [Schema] # omittedField ∷ Maybe Schema #
ToJSON Schema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods toJSON ∷ Schema → Value # toEncoding ∷ Schema → Encoding # toJSONList ∷ [Schema] → Value # toEncodingList ∷ [Schema] → Encoding # omitField ∷ Schema → Bool #
Show Schema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → Schema → ShowS # show ∷ Schema → String # showList ∷ [Schema] → ShowS #
Eq Schema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ Schema → Schema → Bool # (/=) ∷ Schema → Schema → Bool #
Ord Schema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ Schema → Schema → Ordering # (<) ∷ Schema → Schema → Bool # (<=) ∷ Schema → Schema → Bool # (>) ∷ Schema → Schema → Bool # (>=) ∷ Schema → Schema → Bool # max ∷ Schema → Schema → Schema # min ∷ Schema → Schema → Schema #

data PairSchema #

Constructors

MkPairSchema
Fields psLeft ∷ Schema Schema of the first element. psRight ∷ Schema Schema of the second element.

Instances

Instances details

FromJSON PairSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods parseJSON ∷ Value → Parser PairSchema # parseJSONList ∷ Value → Parser [PairSchema] # omittedField ∷ Maybe PairSchema #
Generic PairSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Associated Types type Rep PairSchema ∷ Type → Type # Methods from ∷ PairSchema → Rep PairSchema x # to ∷ Rep PairSchema x → PairSchema #
Show PairSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → PairSchema → ShowS # show ∷ PairSchema → String # showList ∷ [PairSchema] → ShowS #
Eq PairSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ PairSchema → PairSchema → Bool # (/=) ∷ PairSchema → PairSchema → Bool #
Ord PairSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ PairSchema → PairSchema → Ordering # (<) ∷ PairSchema → PairSchema → Bool # (<=) ∷ PairSchema → PairSchema → Bool # (>) ∷ PairSchema → PairSchema → Bool # (>=) ∷ PairSchema → PairSchema → Bool # max ∷ PairSchema → PairSchema → PairSchema # min ∷ PairSchema → PairSchema → PairSchema #
type Rep PairSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema type Rep PairSchema = D1 ('MetaData "PairSchema" "GeniusYield.Types.Blueprint.Schema" "atlas-cardano-0.6.2-inplace" 'False) (C1 ('MetaCons "MkPairSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "psLeft") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Schema) :*: S1 ('MetaSel ('Just "psRight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Schema)))

data ConstructorSchema #

Constructors

MkConstructorSchema
Fields csIndex ∷ Natural Constructor index. csFields ∷ [Schema] Field schemas.

Instances

Instances details

FromJSON ConstructorSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods parseJSON ∷ Value → Parser ConstructorSchema # parseJSONList ∷ Value → Parser [ConstructorSchema] # omittedField ∷ Maybe ConstructorSchema #
Generic ConstructorSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Associated Types type Rep ConstructorSchema ∷ Type → Type # Methods from ∷ ConstructorSchema → Rep ConstructorSchema x # to ∷ Rep ConstructorSchema x → ConstructorSchema #
Show ConstructorSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → ConstructorSchema → ShowS # show ∷ ConstructorSchema → String # showList ∷ [ConstructorSchema] → ShowS #
Eq ConstructorSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ ConstructorSchema → ConstructorSchema → Bool # (/=) ∷ ConstructorSchema → ConstructorSchema → Bool #
Ord ConstructorSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ ConstructorSchema → ConstructorSchema → Ordering # (<) ∷ ConstructorSchema → ConstructorSchema → Bool # (<=) ∷ ConstructorSchema → ConstructorSchema → Bool # (>) ∷ ConstructorSchema → ConstructorSchema → Bool # (>=) ∷ ConstructorSchema → ConstructorSchema → Bool # max ∷ ConstructorSchema → ConstructorSchema → ConstructorSchema # min ∷ ConstructorSchema → ConstructorSchema → ConstructorSchema #
type Rep ConstructorSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema type Rep ConstructorSchema = D1 ('MetaData "ConstructorSchema" "GeniusYield.Types.Blueprint.Schema" "atlas-cardano-0.6.2-inplace" 'False) (C1 ('MetaCons "MkConstructorSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "csIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "csFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Schema])))

data MapSchema #

Constructors

MkMapSchema
Fields msKeys ∷ Schema Key schema. msValues ∷ Schema Value schema. msMinItems ∷ Maybe Natural A map instance is valid if its size is greater than, or equal to, this value. msMaxItems ∷ Maybe Natural A map instance is valid if its size is less than, or equal to, this value.

Instances

Instances details

FromJSON MapSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods parseJSON ∷ Value → Parser MapSchema # parseJSONList ∷ Value → Parser [MapSchema] # omittedField ∷ Maybe MapSchema #
Generic MapSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Associated Types type Rep MapSchema ∷ Type → Type # Methods from ∷ MapSchema → Rep MapSchema x # to ∷ Rep MapSchema x → MapSchema #
Show MapSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → MapSchema → ShowS # show ∷ MapSchema → String # showList ∷ [MapSchema] → ShowS #
Eq MapSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ MapSchema → MapSchema → Bool # (/=) ∷ MapSchema → MapSchema → Bool #
Ord MapSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ MapSchema → MapSchema → Ordering # (<) ∷ MapSchema → MapSchema → Bool # (<=) ∷ MapSchema → MapSchema → Bool # (>) ∷ MapSchema → MapSchema → Bool # (>=) ∷ MapSchema → MapSchema → Bool # max ∷ MapSchema → MapSchema → MapSchema # min ∷ MapSchema → MapSchema → MapSchema #
type Rep MapSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema type Rep MapSchema = D1 ('MetaData "MapSchema" "GeniusYield.Types.Blueprint.Schema" "atlas-cardano-0.6.2-inplace" 'False) (C1 ('MetaCons "MkMapSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "msKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Schema) :: S1 ('MetaSel ('Just "msValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Schema)) :: (S1 ('MetaSel ('Just "msMinItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "msMaxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))))

data ListSchema #

Constructors

MkListSchema

Fields

lsItems ∷ ListItemSchema
Element schema.
lsMinItems ∷ Maybe Natural
An array instance is valid if its size is greater than, or equal to, this value.
lsMaxItems ∷ Maybe Natural
An array instance is valid if its size is less than, or equal to, this value.
lsUniqueItems ∷ Maybe Bool
If this value is false, the instance validates successfully. If it is set to True, the instance validates successfully if all of its elements are unique.

Instances

Instances details

FromJSON ListSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods parseJSON ∷ Value → Parser ListSchema # parseJSONList ∷ Value → Parser [ListSchema] # omittedField ∷ Maybe ListSchema #
Show ListSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → ListSchema → ShowS # show ∷ ListSchema → String # showList ∷ [ListSchema] → ShowS #
Eq ListSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ ListSchema → ListSchema → Bool # (/=) ∷ ListSchema → ListSchema → Bool #
Ord ListSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ ListSchema → ListSchema → Ordering # (<) ∷ ListSchema → ListSchema → Bool # (<=) ∷ ListSchema → ListSchema → Bool # (>) ∷ ListSchema → ListSchema → Bool # (>=) ∷ ListSchema → ListSchema → Bool # max ∷ ListSchema → ListSchema → ListSchema # min ∷ ListSchema → ListSchema → ListSchema #

data ListItemSchema #

Constructors

ListItemSchemaSchema Schema
ListItemSchemaSchemas [Schema]

Instances

Instances details

Show ListItemSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → ListItemSchema → ShowS # show ∷ ListItemSchema → String # showList ∷ [ListItemSchema] → ShowS #
Eq ListItemSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ ListItemSchema → ListItemSchema → Bool # (/=) ∷ ListItemSchema → ListItemSchema → Bool #
Ord ListItemSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ ListItemSchema → ListItemSchema → Ordering # (<) ∷ ListItemSchema → ListItemSchema → Bool # (<=) ∷ ListItemSchema → ListItemSchema → Bool # (>) ∷ ListItemSchema → ListItemSchema → Bool # (>=) ∷ ListItemSchema → ListItemSchema → Bool # max ∷ ListItemSchema → ListItemSchema → ListItemSchema # min ∷ ListItemSchema → ListItemSchema → ListItemSchema #

data BytesSchema #

Constructors

MkBytesSchema
Fields bsEnum ∷ [ByteString] An instance validates successfully if once hex-encoded, its value matches one of the specified values. bsMinLength ∷ Maybe Natural An instance is valid if its length is greater than, or equal to, this value. bsMaxLength ∷ Maybe Natural An instance is valid if its length is less than, or equal to, this value.

Instances

Instances details

FromJSON BytesSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods parseJSON ∷ Value → Parser BytesSchema # parseJSONList ∷ Value → Parser [BytesSchema] # omittedField ∷ Maybe BytesSchema #
Show BytesSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → BytesSchema → ShowS # show ∷ BytesSchema → String # showList ∷ [BytesSchema] → ShowS #
Eq BytesSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ BytesSchema → BytesSchema → Bool # (/=) ∷ BytesSchema → BytesSchema → Bool #
Ord BytesSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ BytesSchema → BytesSchema → Ordering # (<) ∷ BytesSchema → BytesSchema → Bool # (<=) ∷ BytesSchema → BytesSchema → Bool # (>) ∷ BytesSchema → BytesSchema → Bool # (>=) ∷ BytesSchema → BytesSchema → Bool # max ∷ BytesSchema → BytesSchema → BytesSchema # min ∷ BytesSchema → BytesSchema → BytesSchema #

emptyBytesSchema ∷ BytesSchema #

data IntegerSchema #

Constructors

MkIntegerSchema

Fields

isMultipleOf ∷ Maybe Integer
An instance is valid if division by this value results in an integer.
isMinimum ∷ Maybe Integer
An instance is valid only if it is greater than or exactly equal to "minimum".
isMaximum ∷ Maybe Integer
An instance is valid only if it is less than or exactly equal to "maximum".
isExclusiveMinimum ∷ Maybe Integer
An instance is valid only if it is strictly greater than "exclusiveMinimum".
isExclusiveMaximum ∷ Maybe Integer
An instance is valid only if it is strictly less than "exclusiveMaximum".

Instances

Instances details

FromJSON IntegerSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods parseJSON ∷ Value → Parser IntegerSchema # parseJSONList ∷ Value → Parser [IntegerSchema] # omittedField ∷ Maybe IntegerSchema #
Generic IntegerSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Associated Types type Rep IntegerSchema ∷ Type → Type # Methods from ∷ IntegerSchema → Rep IntegerSchema x # to ∷ Rep IntegerSchema x → IntegerSchema #
Show IntegerSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → IntegerSchema → ShowS # show ∷ IntegerSchema → String # showList ∷ [IntegerSchema] → ShowS #
Eq IntegerSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ IntegerSchema → IntegerSchema → Bool # (/=) ∷ IntegerSchema → IntegerSchema → Bool #
Ord IntegerSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ IntegerSchema → IntegerSchema → Ordering # (<) ∷ IntegerSchema → IntegerSchema → Bool # (<=) ∷ IntegerSchema → IntegerSchema → Bool # (>) ∷ IntegerSchema → IntegerSchema → Bool # (>=) ∷ IntegerSchema → IntegerSchema → Bool # max ∷ IntegerSchema → IntegerSchema → IntegerSchema # min ∷ IntegerSchema → IntegerSchema → IntegerSchema #
type Rep IntegerSchema #
Instance details Defined in GeniusYield.Types.Blueprint.Schema type Rep IntegerSchema = D1 ('MetaData "IntegerSchema" "GeniusYield.Types.Blueprint.Schema" "atlas-cardano-0.6.2-inplace" 'False) (C1 ('MetaCons "MkIntegerSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isMultipleOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "isMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "isMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "isExclusiveMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "isExclusiveMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))))))

emptyIntegerSchema ∷ IntegerSchema #

data SchemaInfo #

Additional information optionally attached to any datatype schema definition.

Constructors

MkSchemaInfo
Fields title ∷ Maybe Text description ∷ Maybe Text comment ∷ Maybe Text

Instances

Instances details

Show SchemaInfo #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods showsPrec ∷ Int → SchemaInfo → ShowS # show ∷ SchemaInfo → String # showList ∷ [SchemaInfo] → ShowS #
Eq SchemaInfo #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods (==) ∷ SchemaInfo → SchemaInfo → Bool # (/=) ∷ SchemaInfo → SchemaInfo → Bool #
Ord SchemaInfo #
Instance details Defined in GeniusYield.Types.Blueprint.Schema Methods compare ∷ SchemaInfo → SchemaInfo → Ordering # (<) ∷ SchemaInfo → SchemaInfo → Bool # (<=) ∷ SchemaInfo → SchemaInfo → Bool # (>) ∷ SchemaInfo → SchemaInfo → Bool # (>=) ∷ SchemaInfo → SchemaInfo → Bool # max ∷ SchemaInfo → SchemaInfo → SchemaInfo # min ∷ SchemaInfo → SchemaInfo → SchemaInfo #

emptySchemaInfo ∷ SchemaInfo #

SchemaInteger SchemaInfo IntegerSchema
SchemaBytes SchemaInfo BytesSchema
SchemaList SchemaInfo ListSchema
SchemaMap SchemaInfo MapSchema
SchemaConstructor SchemaInfo ConstructorSchema
SchemaBuiltInData SchemaInfo
SchemaBuiltInUnit SchemaInfo
SchemaBuiltInBoolean SchemaInfo
SchemaBuiltInInteger SchemaInfo
SchemaBuiltInBytes SchemaInfo
SchemaBuiltInString SchemaInfo
SchemaBuiltInPair SchemaInfo PairSchema
SchemaBuiltInList SchemaInfo Schema
SchemaOneOf (NonEmpty Schema)
SchemaAnyOf (NonEmpty Schema)
SchemaAllOf (NonEmpty Schema)
SchemaNot Schema
SchemaDefinitionRef DefinitionId