Data.JsonSchema.Fetch

Types

data Spec schema

Constructors

Spec

Fields

_ssEmbedded :: schema -> [schema]

_ssGetId :: schema -> Maybe Text

_ssGetRef :: schema -> Maybe Text

data SchemaWithURI schema

Constructors

SchemaWithURI

Fields

_swSchema :: !schema

_swURI :: !(Maybe Text)

Must not include a URI fragment, e.g. use "http://example.com/foo" not "http://example.com/foo#bar".

This is the URI identifying the document containing the schema. It's different than the schema's "id" field, which controls scope when resolving references contained in the schema.

Instances

Eq schema => Eq (SchemaWithURI schema)

Show schema => Show (SchemaWithURI schema)

type URISchemaMap schema = HashMap Text schema

Keys are URIs (without URI fragments).

data ReferencedSchemas schema

Constructors

ReferencedSchemas

Fields

_rsStarting :: !schema

Used to resolve relative references.

_rsSchemaMap :: !(URISchemaMap schema)

Instances

Eq schema => Eq (ReferencedSchemas schema)

Show schema => Show (ReferencedSchemas schema)

Fetch via HTTP

data HTTPFailure

Constructors

HTTPParseFailure Text

HTTPRequestFailure HttpException

Instances

Show HTTPFailure

referencesViaHTTP' :: forall schema. FromJSON schema => Spec schema -> SchemaWithURI schema -> IO (Either HTTPFailure (ReferencedSchemas schema))

Take a schema. Retrieve every document either it or its subschemas include via the "$ref" keyword.

Fetch via Filesystem

data FilesystemFailure

Constructors

FSParseFailure Text

FSReadFailure IOError

Instances

Show FilesystemFailure

referencesViaFilesystem' :: forall schema. FromJSON schema => Spec schema -> SchemaWithURI schema -> IO (Either FilesystemFailure (ReferencedSchemas schema))

Method Agnostic Fetching Tools

referencesMethodAgnostic :: forall schema. FromJSON schema => (Text -> IO ByteString) -> Spec schema -> SchemaWithURI schema -> IO (Either Text (ReferencedSchemas schema))

A version of fetchReferencedSchemas where the function to fetch schemas is provided by the user. This allows restrictions to be added, e.g. rejecting non-local URIs.

foldFunction :: forall schema. FromJSON schema => (Text -> IO ByteString) -> Spec schema -> URISchemaMap schema -> SchemaWithURI schema -> IO (Either Text (URISchemaMap schema))

includeSubschemas :: forall schema. Spec schema -> SchemaWithURI schema -> [SchemaWithURI schema]

Return the schema passed in as an argument, as well as every subschema contained within it.