Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenAPI.Generate.Log

Synopsis

data LogSeverity
- = TraceSeverity
- | InfoSeverity
- | WarningSeverity
- | ErrorSeverity
data LogEntry = LogEntry {
- logEntryPath :: [Text]
- logEntrySeverity :: LogSeverity
- logEntryMessage :: Text
}
type LogEntries = [LogEntry]
filterAndTransformLogs :: LogSeverity -> LogEntries -> [Text]
filterLogs :: LogSeverity -> LogEntries -> LogEntries
transformLogs :: LogEntries -> [Text]
transformPath :: [Text] -> Text

Documentation

data LogSeverity Source #

Data type representing the log severities

Constructors

TraceSeverity
InfoSeverity
WarningSeverity
ErrorSeverity

Instances

Instances details

HasCodec LogSeverity Source #
Instance details Defined in OpenAPI.Generate.Log Methods codec :: JSONCodec LogSeverity # listCodecForStringCompatibility :: JSONCodec [LogSeverity] #
Bounded LogSeverity Source #
Instance details Defined in OpenAPI.Generate.Log Methods minBound :: LogSeverity # maxBound :: LogSeverity #
Enum LogSeverity Source #
Instance details Defined in OpenAPI.Generate.Log Methods succ :: LogSeverity -> LogSeverity # pred :: LogSeverity -> LogSeverity # toEnum :: Int -> LogSeverity # fromEnum :: LogSeverity -> Int # enumFrom :: LogSeverity -> [LogSeverity] # enumFromThen :: LogSeverity -> LogSeverity -> [LogSeverity] # enumFromTo :: LogSeverity -> LogSeverity -> [LogSeverity] # enumFromThenTo :: LogSeverity -> LogSeverity -> LogSeverity -> [LogSeverity] #
Read LogSeverity Source #
Instance details Defined in OpenAPI.Generate.Log Methods readsPrec :: Int -> ReadS LogSeverity # readList :: ReadS [LogSeverity] # readPrec :: ReadPrec LogSeverity # readListPrec :: ReadPrec [LogSeverity] #
Show LogSeverity Source #
Instance details Defined in OpenAPI.Generate.Log Methods showsPrec :: Int -> LogSeverity -> ShowS # show :: LogSeverity -> String # showList :: [LogSeverity] -> ShowS #
Eq LogSeverity Source #
Instance details Defined in OpenAPI.Generate.Log Methods (==) :: LogSeverity -> LogSeverity -> Bool # (/=) :: LogSeverity -> LogSeverity -> Bool #
Ord LogSeverity Source #
Instance details Defined in OpenAPI.Generate.Log Methods compare :: LogSeverity -> LogSeverity -> Ordering # (<) :: LogSeverity -> LogSeverity -> Bool # (<=) :: LogSeverity -> LogSeverity -> Bool # (>) :: LogSeverity -> LogSeverity -> Bool # (>=) :: LogSeverity -> LogSeverity -> Bool # max :: LogSeverity -> LogSeverity -> LogSeverity # min :: LogSeverity -> LogSeverity -> LogSeverity #

data LogEntry Source #

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

Constructors

LogEntry
Fields logEntryPath :: [Text] logEntrySeverity :: LogSeverity logEntryMessage :: Text

Instances

Instances details

Show LogEntry Source #
Instance details Defined in OpenAPI.Generate.Log Methods showsPrec :: Int -> LogEntry -> ShowS # show :: LogEntry -> String # showList :: [LogEntry] -> ShowS #
Eq LogEntry Source #
Instance details Defined in OpenAPI.Generate.Log Methods (==) :: LogEntry -> LogEntry -> Bool # (/=) :: LogEntry -> LogEntry -> Bool #
MonadWriter LogEntries Generator Source #
Instance details Defined in OpenAPI.Generate.Monad Methods writer :: (a, LogEntries) -> Generator a # tell :: LogEntries -> Generator () # listen :: Generator a -> Generator (a, LogEntries) # pass :: Generator (a, LogEntries -> LogEntries) -> Generator a #

type LogEntries = [LogEntry] Source #

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

filterAndTransformLogs :: LogSeverity -> LogEntries -> [Text] Source #

Filters and transforms log entries for printing

filterLogs :: LogSeverity -> LogEntries -> LogEntries Source #

Filters log entries which have a lower log level than provided

transformLogs :: LogEntries -> [Text] Source #

Transforms LogEntries to a list of Text values for easier printing.

transformPath :: [Text] -> Text Source #

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