JSONSchema.Draft4.SchemaGenerationConfig

A single JSON document can be interpreted multiple ways and with differing degrees of strictness when it is converted into a JSON Schema. These options allow the way in which a JSON document is converted into a schema to be customized.

Documentation

data SchemaGenerationConfig

Allows options to be specified for turning an individual JSON document into a JSON schema.

Constructors

SchemaGenerationConfig

Fields

• typeArraysAsTuples :: Bool

  If set to True, each array will be considered a tuple of type (a, b, c...) and the schema will be generated so that each member of the array-tuple will have its own type. If set to False, each array will be considered to have a single type Array a and the schemas will be unified accordingly.

  In terms of JSON Schema validation, setting this to True will create an items schema that is an array. Setting it to False will create an items schema that is an object.

• sealObjectProperties :: Bool

  If set to True, then each JSON object that the schema converter encounters will only be allowed to have all the keys present and no more. If set to False, then JSON objects that the schema converter encounters

  In terms of JSON Schema validation, setting sealObjectProperties to True sets additionalProperties: false on each schema object.

Instances

Show SchemaGenerationConfig

Methods

showsPrec :: Int -> SchemaGenerationConfig -> ShowS

show :: SchemaGenerationConfig -> String

showList :: [SchemaGenerationConfig] -> ShowS

Arbitrary SchemaGenerationConfig

Methods

arbitrary :: Gen SchemaGenerationConfig

shrink :: SchemaGenerationConfig -> [SchemaGenerationConfig]

defaultSchemaGenerationConfig :: SchemaGenerationConfig

A configuration that can be used as a sane set of defaults when converting a JSON Schema into an object. It is used by default in jsonToSchema and jsonsToSchema.