Safe Haskell	None
Language	Haskell2010

Schemas.OpenApi2

Description

This module defines a TypedSchema for the Schema datatype, inspired in the OpenApi 2.0 specification, which may be useful to render Schema values in OpeApi 2.0 format

Synopsis

data OpenApi2Document = OpenApi2Document {
- definitions :: HashMap Text OpenApi2Schema
- failures :: HashMap Text Reason
}
data OpenApi2Schema = OpenApi2Schema {
- _type :: OpenApi2Type
- additionalProperties :: Maybe OpenApi2Schema
- discriminator :: Maybe Text
- enum :: Maybe [Text]
- format :: Maybe Text
- items :: Maybe OpenApi2Schema
- properties :: Maybe (HashMap Text OpenApi2Schema)
- required :: Maybe [Text]
}
defOpenApi2Schema :: OpenApi2Type -> OpenApi2Schema
data OpenApi2Type
- = OpenApi2Object
- | OpenApi2Array
- | OpenApi2Boolean
- | OpenApi2Integer
- | OpenApi2Number
- | OpenApi2String
data OpenApi2Options = OpenApi2Options {
- primMapping :: Text -> Maybe OpenApi2Schema
}
defaultOptions :: OpenApi2Options
toOpenApi2Document :: OpenApi2Options -> HashMap Text Schema -> OpenApi2Document
encodeAsOpenApi2Document :: OpenApi2Options -> Text -> Schema -> Value

Documentation

data OpenApi2Document Source #

A catalog of definitions

Constructors

OpenApi2Document
Fields definitions :: HashMap Text OpenApi2Schema failures :: HashMap Text Reason

Instances

Show OpenApi2Document Source #
Instance details Defined in Schemas.OpenApi2 Methods showsPrec :: Int -> OpenApi2Document -> ShowS # show :: OpenApi2Document -> String # showList :: [OpenApi2Document] -> ShowS #
Semigroup OpenApi2Document Source #
Instance details Defined in Schemas.OpenApi2 Methods (<>) :: OpenApi2Document -> OpenApi2Document -> OpenApi2Document # sconcat :: NonEmpty OpenApi2Document -> OpenApi2Document # stimes :: Integral b => b -> OpenApi2Document -> OpenApi2Document #
Monoid OpenApi2Document Source #
Instance details Defined in Schemas.OpenApi2 Methods mempty :: OpenApi2Document # mappend :: OpenApi2Document -> OpenApi2Document -> OpenApi2Document # mconcat :: [OpenApi2Document] -> OpenApi2Document #
HasSchema OpenApi2Document Source #
Instance details Defined in Schemas.OpenApi2 Methods schema :: TypedSchema OpenApi2Document Source #

data OpenApi2Schema Source #

The representation of an OpenApi 2.0 schema

Constructors

OpenApi2Schema
Fields _type :: OpenApi2Type additionalProperties :: Maybe OpenApi2Schema discriminator :: Maybe Text enum :: Maybe [Text] format :: Maybe Text items :: Maybe OpenApi2Schema properties :: Maybe (HashMap Text OpenApi2Schema) required :: Maybe [Text]

Instances

Show OpenApi2Schema Source #
Instance details Defined in Schemas.OpenApi2 Methods showsPrec :: Int -> OpenApi2Schema -> ShowS # show :: OpenApi2Schema -> String # showList :: [OpenApi2Schema] -> ShowS #
Generic OpenApi2Schema Source #
Instance details Defined in Schemas.OpenApi2 Associated Types type Rep OpenApi2Schema :: Type -> Type # Methods from :: OpenApi2Schema -> Rep OpenApi2Schema x # to :: Rep OpenApi2Schema x -> OpenApi2Schema #
Generic OpenApi2Schema Source #
Instance details Defined in Schemas.OpenApi2 Associated Types type Code OpenApi2Schema :: [[Type]] # Methods from :: OpenApi2Schema -> Rep OpenApi2Schema # to :: Rep OpenApi2Schema -> OpenApi2Schema #
HasDatatypeInfo OpenApi2Schema Source #
Instance details Defined in Schemas.OpenApi2 Associated Types type DatatypeInfoOf OpenApi2Schema :: DatatypeInfo # Methods datatypeInfo :: proxy OpenApi2Schema -> DatatypeInfo (Code OpenApi2Schema) #
HasSchema OpenApi2Schema Source #
Instance details Defined in Schemas.OpenApi2 Methods schema :: TypedSchema OpenApi2Schema Source #
type Rep OpenApi2Schema Source #
Instance details Defined in Schemas.OpenApi2 type Rep OpenApi2Schema = D1 (MetaData "OpenApi2Schema" "Schemas.OpenApi2" "schemas-0.3.0-JAYuDPycTib4oO1qL86IJR" False) (C1 (MetaCons "OpenApi2Schema" PrefixI True) (((S1 (MetaSel (Just "_type") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OpenApi2Type) :: S1 (MetaSel (Just "additionalProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OpenApi2Schema))) :: (S1 (MetaSel (Just "discriminator") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "enum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Text])))) :: ((S1 (MetaSel (Just "format") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "items") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OpenApi2Schema))) :: (S1 (MetaSel (Just "properties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (HashMap Text OpenApi2Schema))) :*: S1 (MetaSel (Just "required") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Text]))))))
type Code OpenApi2Schema Source #
Instance details Defined in Schemas.OpenApi2 type Code OpenApi2Schema = GCode OpenApi2Schema
type DatatypeInfoOf OpenApi2Schema Source #
Instance details Defined in Schemas.OpenApi2 type DatatypeInfoOf OpenApi2Schema = GDatatypeInfoOf OpenApi2Schema

defOpenApi2Schema :: OpenApi2Type -> OpenApi2Schema Source #

data OpenApi2Type Source #

Constructors

OpenApi2Object
OpenApi2Array
OpenApi2Boolean
OpenApi2Integer
OpenApi2Number
OpenApi2String

Instances

Bounded OpenApi2Type Source #
Instance details Defined in Schemas.OpenApi2 Methods minBound :: OpenApi2Type # maxBound :: OpenApi2Type #
Enum OpenApi2Type Source #
Instance details Defined in Schemas.OpenApi2 Methods succ :: OpenApi2Type -> OpenApi2Type # pred :: OpenApi2Type -> OpenApi2Type # toEnum :: Int -> OpenApi2Type # fromEnum :: OpenApi2Type -> Int # enumFrom :: OpenApi2Type -> [OpenApi2Type] # enumFromThen :: OpenApi2Type -> OpenApi2Type -> [OpenApi2Type] # enumFromTo :: OpenApi2Type -> OpenApi2Type -> [OpenApi2Type] # enumFromThenTo :: OpenApi2Type -> OpenApi2Type -> OpenApi2Type -> [OpenApi2Type] #
Eq OpenApi2Type Source #
Instance details Defined in Schemas.OpenApi2 Methods (==) :: OpenApi2Type -> OpenApi2Type -> Bool # (/=) :: OpenApi2Type -> OpenApi2Type -> Bool #
Show OpenApi2Type Source #
Instance details Defined in Schemas.OpenApi2 Methods showsPrec :: Int -> OpenApi2Type -> ShowS # show :: OpenApi2Type -> String # showList :: [OpenApi2Type] -> ShowS #
HasSchema OpenApi2Type Source #
Instance details Defined in Schemas.OpenApi2 Methods schema :: TypedSchema OpenApi2Type Source #

data OpenApi2Options Source #

Constructors

OpenApi2Options
Fields primMapping :: Text -> Maybe OpenApi2Schema Please tell me what to do with Prims

defaultOptions :: OpenApi2Options Source #

toOpenApi2Document :: OpenApi2Options -> HashMap Text Schema -> OpenApi2Document Source #

encodeAsOpenApi2Document :: OpenApi2Options -> Text -> Schema -> Value Source #

Given a schema free of undiscriminated unions encodeAsOpenApi2Document name schema produces an encoding of an OpenApi2 document that models the given schema. Failures are omitted, use toOpenApi2Document if you care.