Data.JsonSchema.Fetch

Types

data FetchInfo schema

This is all the fetching functions need to know about a particular JSON Schema draft, e.g. JSON Schema Draft 4.

Constructors

FetchInfo

Fields

• _fiEmbedded :: schema -> ([schema], [schema])
• _fiId :: schema -> Maybe Text
• _fiRef :: schema -> Maybe Text

data ReferencedSchemas schema

Constructors

ReferencedSchemas

Fields

• _rsStarting :: !schema

  Used to resolve relative references when we don't know what the scope of the current schema is. This only happens with starting schemas because if we're using a remote schema we had to know its URI in order to fetch it.

  Tracking the starting schema (instead of just resolving the reference to the current schema being used for validation) is necessary for cases where schemas are embedded inside one another. For instance in this case not distinguishing the starting and "foo" schemas sends the code into an infinite loop:

  { "additionalProperties": false, "properties": { "foo": { "$ref": "#" } } }

• _rsSchemaMap :: !(URISchemaMap schema)

Instances

Eq schema => Eq (ReferencedSchemas schema)

Methods

(==) :: ReferencedSchemas schema -> ReferencedSchemas schema -> Bool

(/=) :: ReferencedSchemas schema -> ReferencedSchemas schema -> Bool

Show schema => Show (ReferencedSchemas schema)

Methods

showsPrec :: Int -> ReferencedSchemas schema -> ShowS

show :: ReferencedSchemas schema -> String

showList :: [ReferencedSchemas schema] -> ShowS

type URISchemaMap schema = HashMap Text schema

Keys are URIs (without URI fragments).

data SchemaWithURI schema

Constructors

SchemaWithURI

Fields

• _swSchema :: !schema
• _swURI :: !(Maybe Text)

  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)

Methods

(==) :: SchemaWithURI schema -> SchemaWithURI schema -> Bool

(/=) :: SchemaWithURI schema -> SchemaWithURI schema -> Bool

Show schema => Show (SchemaWithURI schema)

Methods

showsPrec :: Int -> SchemaWithURI schema -> ShowS

show :: SchemaWithURI schema -> String

showList :: [SchemaWithURI schema] -> ShowS

getReference :: ReferencedSchemas schema -> Maybe Text -> Maybe schema

Fetch via HTTP

data HTTPFailure

Constructors

HTTPParseFailure Text

HTTPRequestFailure HttpException

Instances

Show HTTPFailure

Methods

showsPrec :: Int -> HTTPFailure -> ShowS

show :: HTTPFailure -> String

showList :: [HTTPFailure] -> ShowS

referencesViaHTTP' :: forall schema. FromJSON schema => FetchInfo schema -> SchemaWithURI schema -> IO (Either HTTPFailure (URISchemaMap 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

Eq FilesystemFailure

Methods

(==) :: FilesystemFailure -> FilesystemFailure -> Bool

(/=) :: FilesystemFailure -> FilesystemFailure -> Bool

Show FilesystemFailure

Methods

showsPrec :: Int -> FilesystemFailure -> ShowS

show :: FilesystemFailure -> String

showList :: [FilesystemFailure] -> ShowS

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

Method Agnostic Fetching Tools

referencesMethodAgnostic :: forall schema. FromJSON schema => (Text -> IO ByteString) -> FetchInfo schema -> SchemaWithURI schema -> IO (Either Text (URISchemaMap 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.

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

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

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