OpenAPI.Generate.Monad

This module contains the Generator monad and functions which deal with this monad. In addition this module contains the means for logging and resolving references since they are closely linked to the Generator monad.

Documentation

data GeneratorEnvironment

The reader environment of the Generator monad

The currentPath is updated using the nested function to track the current position within the specification. This is used to produce tracable log messages. The references map is a lookup table for references within the OpenAPI specification.

Constructors

GeneratorEnvironment

Fields

• currentPath :: [Text]
• references :: ReferenceMap
• flags :: Flags

Instances

Eq GeneratorEnvironment

Defined in OpenAPI.Generate.Monad

Methods

(==) :: GeneratorEnvironment -> GeneratorEnvironment -> Bool

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

Show GeneratorEnvironment

Defined in OpenAPI.Generate.Monad

Methods

showsPrec :: Int -> GeneratorEnvironment -> ShowS

show :: GeneratorEnvironment -> String

showList :: [GeneratorEnvironment] -> ShowS

MonadReader GeneratorEnvironment Generator

Defined in OpenAPI.Generate.Monad

Methods

ask :: Generator GeneratorEnvironment

local :: (GeneratorEnvironment -> GeneratorEnvironment) -> Generator a -> Generator a

reader :: (GeneratorEnvironment -> a) -> Generator a

data GeneratorLogSeverity

Data type representing the log severities

Constructors

ErrorSeverity

WarningSeverity

InfoSeverity

Instances

Eq GeneratorLogSeverity

Defined in OpenAPI.Generate.Monad

Methods

(==) :: GeneratorLogSeverity -> GeneratorLogSeverity -> Bool

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

Show GeneratorLogSeverity

Defined in OpenAPI.Generate.Monad

Methods

showsPrec :: Int -> GeneratorLogSeverity -> ShowS

show :: GeneratorLogSeverity -> String

showList :: [GeneratorLogSeverity] -> ShowS

data GeneratorLogEntry

A log entry containing the location within the OpenAPI specification where the message was produced, a severity and the actual message.

Constructors

GeneratorLogEntry

Fields

• path :: [Text]
• severity :: GeneratorLogSeverity
• message :: Text

Instances

Eq GeneratorLogEntry

Defined in OpenAPI.Generate.Monad

Methods

(==) :: GeneratorLogEntry -> GeneratorLogEntry -> Bool

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

Show GeneratorLogEntry

Defined in OpenAPI.Generate.Monad

Methods

showsPrec :: Int -> GeneratorLogEntry -> ShowS

show :: GeneratorLogEntry -> String

showList :: [GeneratorLogEntry] -> ShowS

MonadWriter GeneratorLogs Generator

Defined in OpenAPI.Generate.Monad

Methods

writer :: (a, GeneratorLogs) -> Generator a

tell :: GeneratorLogs -> Generator ()

listen :: Generator a -> Generator (a, GeneratorLogs)

pass :: Generator (a, GeneratorLogs -> GeneratorLogs) -> Generator a

type GeneratorLogs = [GeneratorLogEntry]

The type contained in the writer of the Generator used to collect log entries

newtype Generator a

The Generator monad is used to pass a Reader environment to functions in need of resolving references and collects log messages.

Constructors

Generator

Fields

• unGenerator :: WriterT GeneratorLogs (Reader GeneratorEnvironment) a

Instances

Monad Generator

Defined in OpenAPI.Generate.Monad

Methods

(>>=) :: Generator a -> (a -> Generator b) -> Generator b

(>>) :: Generator a -> Generator b -> Generator b

return :: a -> Generator a

fail :: String -> Generator a

Functor Generator

Defined in OpenAPI.Generate.Monad

Methods

fmap :: (a -> b) -> Generator a -> Generator b

(<$) :: a -> Generator b -> Generator a

Applicative Generator

Defined in OpenAPI.Generate.Monad

Methods

pure :: a -> Generator a

(<*>) :: Generator (a -> b) -> Generator a -> Generator b

liftA2 :: (a -> b -> c) -> Generator a -> Generator b -> Generator c

(*>) :: Generator a -> Generator b -> Generator b

(<*) :: Generator a -> Generator b -> Generator a

MonadWriter GeneratorLogs Generator

Defined in OpenAPI.Generate.Monad

Methods

writer :: (a, GeneratorLogs) -> Generator a

tell :: GeneratorLogs -> Generator ()

listen :: Generator a -> Generator (a, GeneratorLogs)

pass :: Generator (a, GeneratorLogs -> GeneratorLogs) -> Generator a

MonadReader GeneratorEnvironment Generator

Defined in OpenAPI.Generate.Monad

Methods

ask :: Generator GeneratorEnvironment

local :: (GeneratorEnvironment -> GeneratorEnvironment) -> Generator a -> Generator a

reader :: (GeneratorEnvironment -> a) -> Generator a

runGenerator :: GeneratorEnvironment -> Generator a -> (a, GeneratorLogs)

Runs the generator monad within a provided environment.

createEnvironment :: Flags -> ReferenceMap -> GeneratorEnvironment

Create an environment based on a ReferenceMap and Flags

logMessage :: GeneratorLogSeverity -> Text -> Generator ()

Writes a log message to a Generator monad

logError :: Text -> Generator ()

Writes an error to a Generator monad

logWarning :: Text -> Generator ()

Writes a warning to a Generator monad

logInfo :: Text -> Generator ()

Writes an info to a Generator monad

transformGeneratorLogs :: GeneratorLogs -> [Text]

Transforms a log returned from runGenerator to a list of Text values for easier printing.

transformSeverity :: GeneratorLogSeverity -> Text

Transforms the severity to a Text representation

transformPath :: [Text] -> Text

Transforms the path to a Text representation (parts are seperated with a dot)

nested :: Text -> Generator a -> Generator a

This function can be used to tell the Generator monad where in the OpenAPI specification the generator currently is

createReferenceLookupM :: (Text -> ReferenceMap -> Maybe a) -> Text -> Generator (Maybe a)

Helper function to create a lookup function for a specific type

getSchemaReferenceM :: Text -> Generator (Maybe SchemaObject)

Resolve a SchemaObject reference from within the Generator monad

getResponseReferenceM :: Text -> Generator (Maybe ResponseObject)

Resolve a ResponseObject reference from within the Generator monad

getParameterReferenceM :: Text -> Generator (Maybe ParameterObject)

Resolve a ParameterObject reference from within the Generator monad

getExampleReferenceM :: Text -> Generator (Maybe ExampleObject)

Resolve a ExampleObject reference from within the Generator monad

getRequestBodyReferenceM :: Text -> Generator (Maybe RequestBodyObject)

Resolve a RequestBodyObject reference from within the Generator monad

getHeaderReferenceM :: Text -> Generator (Maybe HeaderObject)

Resolve a HeaderObject reference from within the Generator monad

getSecuritySchemeReferenceM :: Text -> Generator (Maybe SecuritySchemeObject)

Resolve a SecuritySchemeObject reference from within the Generator monad

getFlags :: Generator Flags

Get all flags passed to the program

getFlag :: (Flags -> a) -> Generator a

Get a specific flag selected by f