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

newtype URISchemaMap schema

Keys are URIs (without URI fragments).

Constructors

URISchemaMap

Fields

• _unURISchemaMap :: HashMap Text schema

Instances

Eq schema => Eq (URISchemaMap schema)

Methods

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

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

Show schema => Show (URISchemaMap schema)

Methods

showsPrec :: Int -> URISchemaMap schema -> ShowS

show :: URISchemaMap schema -> String

showList :: [URISchemaMap schema] -> ShowS

Semigroup (URISchemaMap schema)

Methods

(<>) :: URISchemaMap schema -> URISchemaMap schema -> URISchemaMap schema

sconcat :: NonEmpty (URISchemaMap schema) -> URISchemaMap schema

stimes :: Integral b => b -> URISchemaMap schema -> URISchemaMap schema

Monoid (URISchemaMap schema)

Methods

mempty :: URISchemaMap schema

mappend :: URISchemaMap schema -> URISchemaMap schema -> URISchemaMap schema

mconcat :: [URISchemaMap schema] -> URISchemaMap schema

data SchemaWithURI schema

A top-level schema along with its location.

Constructors

SchemaWithURI

Fields

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

  This is the URI from which the document was originally fetched. 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 :: URISchemaMap schema -> 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 IOException

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.