Swarm.Doc.Schema.Parse

Description

There are no modern, comprehensive JSON Schema parsing libraries in Haskell, as explained in post https://dev.to/sshine/a-review-of-json-schema-libraries-for-haskell-321.

Therefore, a bespoke parser for a small subset of JSON Schema is implemented here, simply for rendering Markdown documentation from Swarm's schema.

Synopsis

Documentation

Includes everything needed to render the schema to markdown

Constructors

SchemaData
Fields schemaPath :: FilePath schemaContent :: ToplevelSchema markdownFooters :: [Pandoc]

Constructors

ObjectProperties (Map Text SwarmSchema)
ListMembers (ItemDescription SwarmSchema)
EnumMembers (NonEmpty Text)

Instances details

Show Members Source #
Instance details Defined in Swarm.Doc.Schema.Parse Methods showsPrec :: Int -> Members -> ShowS # show :: Members -> String # showList :: [Members] -> ShowS #
Eq Members Source #
Instance details Defined in Swarm.Doc.Schema.Parse Methods (==) :: Members -> Members -> Bool # (/=) :: Members -> Members -> Bool #
Ord Members Source #
Instance details Defined in Swarm.Doc.Schema.Parse Methods compare :: Members -> Members -> Ordering # (<) :: Members -> Members -> Bool # (<=) :: Members -> Members -> Bool # (>) :: Members -> Members -> Bool # (>=) :: Members -> Members -> Bool # max :: Members -> Members -> Members # min :: Members -> Members -> Members #

Constructors

ToplevelSchema
Fields title :: Text description :: Maybe Pandoc content :: SwarmSchema members :: Maybe Members footerPaths :: [FilePath]

Instances details

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