License	BSD-3-Clause
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.Doc.Schema.Refined

Contents

Basic
Refined
Utilities

Description

Refined JSON schema after converting all JSON Value types to their specific sum types

Synopsis

schemaJsonOptions :: Options
data SchemaRaw = SchemaRaw {
- _description :: Maybe Text
- _default :: Maybe Value
- _title :: Maybe Text
- _type :: Maybe (SingleOrList Text)
- _name :: Maybe Text
- _properties :: Maybe (Map Text SwarmSchema)
- _items :: Maybe (ItemDescription SwarmSchema)
- _examples :: Maybe [Value]
- _Sref :: Maybe Text
- _oneOf :: Maybe [SchemaRaw]
- _footers :: Maybe [FilePath]
- _additionalProperties :: Maybe Bool
}
extractSchemaType :: SchemaRaw -> Maybe SchemaType
data ItemDescription a
- = ItemList [a]
- | ItemType a
getSchemaReferences :: SchemaType -> [SchemaIdReference]
data SwarmSchema = SwarmSchema {
- schemaType :: SchemaType
- defaultValue :: Maybe Value
- objectDescription :: Maybe Pandoc
- properties :: Maybe (Map Text SwarmSchema)
- itemsDescription :: Maybe (ItemDescription SwarmSchema)
- examples :: [Value]
}
getMarkdown :: MonadFail m => Text -> m Pandoc
toSwarmSchema :: MonadFail m => SchemaRaw -> m SwarmSchema
extractReferences :: SwarmSchema -> Set SchemaIdReference

Basic

schemaJsonOptions :: Options Source #

data SchemaRaw Source #

A single record that encompasses all possible objects in a JSON schema. All fields are optional.

Constructors

SchemaRaw
Fields _description :: Maybe Text _default :: Maybe Value _title :: Maybe Text _type :: Maybe (SingleOrList Text) _name :: Maybe Text _properties :: Maybe (Map Text SwarmSchema) _items :: Maybe (ItemDescription SwarmSchema) _examples :: Maybe [Value] _Sref :: Maybe Text _oneOf :: Maybe [SchemaRaw] _footers :: Maybe [FilePath] _additionalProperties :: Maybe Bool

Instances

Instances details

FromJSON SchemaRaw Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods parseJSON :: Value -> Parser SchemaRaw # parseJSONList :: Value -> Parser [SchemaRaw] #
Generic SchemaRaw Source #
Instance details Defined in Swarm.Doc.Schema.Refined Associated Types type Rep SchemaRaw :: Type -> Type # Methods from :: SchemaRaw -> Rep SchemaRaw x # to :: Rep SchemaRaw x -> SchemaRaw #
Show SchemaRaw Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods showsPrec :: Int -> SchemaRaw -> ShowS # show :: SchemaRaw -> String # showList :: [SchemaRaw] -> ShowS #
Eq SchemaRaw Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods (==) :: SchemaRaw -> SchemaRaw -> Bool # (/=) :: SchemaRaw -> SchemaRaw -> Bool #
Ord SchemaRaw Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods compare :: SchemaRaw -> SchemaRaw -> Ordering # (<) :: SchemaRaw -> SchemaRaw -> Bool # (<=) :: SchemaRaw -> SchemaRaw -> Bool # (>) :: SchemaRaw -> SchemaRaw -> Bool # (>=) :: SchemaRaw -> SchemaRaw -> Bool # max :: SchemaRaw -> SchemaRaw -> SchemaRaw # min :: SchemaRaw -> SchemaRaw -> SchemaRaw #
type Rep SchemaRaw Source #
Instance details Defined in Swarm.Doc.Schema.Refined type Rep SchemaRaw = D1 ('MetaData "SchemaRaw" "Swarm.Doc.Schema.Refined" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "SchemaRaw" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "_default") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Value)) :: S1 ('MetaSel ('Just "_title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (SingleOrList Text))) :: (S1 ('MetaSel ('Just "_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "_properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Map Text SwarmSchema)))))) :: ((S1 ('MetaSel ('Just "_items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (ItemDescription SwarmSchema))) :: (S1 ('MetaSel ('Just "_examples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Value])) :: S1 ('MetaSel ('Just "_Sref") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "_oneOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SchemaRaw])) :: (S1 ('MetaSel ('Just "_footers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FilePath])) :*: S1 ('MetaSel ('Just "_additionalProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

extractSchemaType :: SchemaRaw -> Maybe SchemaType Source #

Refined

data ItemDescription a Source #

Constructors

ItemList [a]
ItemType a

Instances

Instances details

FromJSON a => FromJSON (ItemDescription a) Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods parseJSON :: Value -> Parser (ItemDescription a) # parseJSONList :: Value -> Parser [ItemDescription a] #
Show a => Show (ItemDescription a) Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods showsPrec :: Int -> ItemDescription a -> ShowS # show :: ItemDescription a -> String # showList :: [ItemDescription a] -> ShowS #
Eq a => Eq (ItemDescription a) Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods (==) :: ItemDescription a -> ItemDescription a -> Bool # (/=) :: ItemDescription a -> ItemDescription a -> Bool #
Ord a => Ord (ItemDescription a) Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods compare :: ItemDescription a -> ItemDescription a -> Ordering # (<) :: ItemDescription a -> ItemDescription a -> Bool # (<=) :: ItemDescription a -> ItemDescription a -> Bool # (>) :: ItemDescription a -> ItemDescription a -> Bool # (>=) :: ItemDescription a -> ItemDescription a -> Bool # max :: ItemDescription a -> ItemDescription a -> ItemDescription a # min :: ItemDescription a -> ItemDescription a -> ItemDescription a #

getSchemaReferences :: SchemaType -> [SchemaIdReference] Source #

data SwarmSchema Source #

A subset of all JSON schemas, conforming to internal Swarm conventions.

Conveniently, this extra representation layer is able to enforce (via toSwarmSchema) that all "object" definitions in the schema contain the "additionalProperties": true attribute.

Constructors

SwarmSchema
Fields schemaType :: SchemaType defaultValue :: Maybe Value objectDescription :: Maybe Pandoc properties :: Maybe (Map Text SwarmSchema) itemsDescription :: Maybe (ItemDescription SwarmSchema) examples :: [Value]

Instances

Instances details

FromJSON SwarmSchema Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods parseJSON :: Value -> Parser SwarmSchema # parseJSONList :: Value -> Parser [SwarmSchema] #
Show SwarmSchema Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods showsPrec :: Int -> SwarmSchema -> ShowS # show :: SwarmSchema -> String # showList :: [SwarmSchema] -> ShowS #
Eq SwarmSchema Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods (==) :: SwarmSchema -> SwarmSchema -> Bool # (/=) :: SwarmSchema -> SwarmSchema -> Bool #
Ord SwarmSchema Source #
Instance details Defined in Swarm.Doc.Schema.Refined Methods compare :: SwarmSchema -> SwarmSchema -> Ordering # (<) :: SwarmSchema -> SwarmSchema -> Bool # (<=) :: SwarmSchema -> SwarmSchema -> Bool # (>) :: SwarmSchema -> SwarmSchema -> Bool # (>=) :: SwarmSchema -> SwarmSchema -> Bool # max :: SwarmSchema -> SwarmSchema -> SwarmSchema # min :: SwarmSchema -> SwarmSchema -> SwarmSchema #

getMarkdown :: MonadFail m => Text -> m Pandoc Source #

toSwarmSchema :: MonadFail m => SchemaRaw -> m SwarmSchema Source #

Utilities

extractReferences :: SwarmSchema -> Set SchemaIdReference Source #

Recursively extract references to other schemas