Safe Haskell	None
Language	Haskell2010

Data.OpenApi.Compare.Report

Documentation

generateReport :: ReportConfig -> ReportInput -> (Blocks, ReportStatus) Source #

data CheckerOutput Source #

Constructors

CheckerOutput
Fields forwardChanges :: Changes backwardChanges :: Changes

Instances

Instances details

Generic CheckerOutput Source #
Instance details Defined in Data.OpenApi.Compare.Report Associated Types type Rep CheckerOutput :: Type -> Type # Methods from :: CheckerOutput -> Rep CheckerOutput x # to :: Rep CheckerOutput x -> CheckerOutput #
Semigroup CheckerOutput Source #
Instance details Defined in Data.OpenApi.Compare.Report Methods (<>) :: CheckerOutput -> CheckerOutput -> CheckerOutput # sconcat :: NonEmpty CheckerOutput -> CheckerOutput # stimes :: Integral b => b -> CheckerOutput -> CheckerOutput #
Monoid CheckerOutput Source #
Instance details Defined in Data.OpenApi.Compare.Report Methods mempty :: CheckerOutput # mappend :: CheckerOutput -> CheckerOutput -> CheckerOutput # mconcat :: [CheckerOutput] -> CheckerOutput #
ToJSON CheckerOutput Source #
Instance details Defined in Data.OpenApi.Compare.Report Methods toJSON :: CheckerOutput -> Value # toEncoding :: CheckerOutput -> Encoding # toJSONList :: [CheckerOutput] -> Value # toEncodingList :: [CheckerOutput] -> Encoding #
type Rep CheckerOutput Source #
Instance details Defined in Data.OpenApi.Compare.Report type Rep CheckerOutput

data ReportInput Source #

Constructors

ReportInput

Fields

breakingChanges :: Changes
forward CertainIssue, ProbablyIssue and Comment
nonBreakingChanges :: Changes
backward CertainIssue, ProbablyIssue and Comment, except those shadowed by relatedIssues
unsupportedChanges :: Changes
forward and backward Unsupported (assumed to be the same anyway)
schemaIssues :: Changes
forward and backward SchemaInvalid (assumed to be the same anyway)

Instances

Instances details

Generic ReportInput Source #
Instance details Defined in Data.OpenApi.Compare.Report Associated Types type Rep ReportInput :: Type -> Type # Methods from :: ReportInput -> Rep ReportInput x # to :: Rep ReportInput x -> ReportInput #
Semigroup ReportInput Source #
Instance details Defined in Data.OpenApi.Compare.Report Methods (<>) :: ReportInput -> ReportInput -> ReportInput # sconcat :: NonEmpty ReportInput -> ReportInput # stimes :: Integral b => b -> ReportInput -> ReportInput #
Monoid ReportInput Source #
Instance details Defined in Data.OpenApi.Compare.Report Methods mempty :: ReportInput # mappend :: ReportInput -> ReportInput -> ReportInput # mconcat :: [ReportInput] -> ReportInput #
ToJSON ReportInput Source #
Instance details Defined in Data.OpenApi.Compare.Report Methods toJSON :: ReportInput -> Value # toEncoding :: ReportInput -> Encoding # toJSONList :: [ReportInput] -> Value # toEncodingList :: [ReportInput] -> Encoding #
type Rep ReportInput Source #
Instance details Defined in Data.OpenApi.Compare.Report type Rep ReportInput

segregateIssues :: CheckerOutput -> ReportInput Source #

data ReportStatus Source #

Constructors

BreakingChanges
NoBreakingChanges
OnlyUnsupportedChanges	All changes that could be breaking are unsupported – we don't know if there actually are any breaking changes.

data Pandoc #

Instances

Instances details

Eq Pandoc
Instance details Defined in Text.Pandoc.Definition Methods (==) :: Pandoc -> Pandoc -> Bool # (/=) :: Pandoc -> Pandoc -> Bool #
Data Pandoc
Instance details Defined in Text.Pandoc.Definition Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Pandoc -> c Pandoc # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Pandoc # toConstr :: Pandoc -> Constr # dataTypeOf :: Pandoc -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Pandoc) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Pandoc) # gmapT :: (forall b. Data b => b -> b) -> Pandoc -> Pandoc # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Pandoc -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Pandoc -> r # gmapQ :: (forall d. Data d => d -> u) -> Pandoc -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Pandoc -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Pandoc -> m Pandoc # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Pandoc -> m Pandoc # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Pandoc -> m Pandoc #
Ord Pandoc
Instance details Defined in Text.Pandoc.Definition Methods compare :: Pandoc -> Pandoc -> Ordering # (<) :: Pandoc -> Pandoc -> Bool # (<=) :: Pandoc -> Pandoc -> Bool # (>) :: Pandoc -> Pandoc -> Bool # (>=) :: Pandoc -> Pandoc -> Bool # max :: Pandoc -> Pandoc -> Pandoc # min :: Pandoc -> Pandoc -> Pandoc #
Read Pandoc
Instance details Defined in Text.Pandoc.Definition Methods readsPrec :: Int -> ReadS Pandoc # readList :: ReadS [Pandoc] # readPrec :: ReadPrec Pandoc # readListPrec :: ReadPrec [Pandoc] #
Show Pandoc
Instance details Defined in Text.Pandoc.Definition Methods showsPrec :: Int -> Pandoc -> ShowS # show :: Pandoc -> String # showList :: [Pandoc] -> ShowS #
Generic Pandoc
Instance details Defined in Text.Pandoc.Definition Associated Types type Rep Pandoc :: Type -> Type # Methods from :: Pandoc -> Rep Pandoc x # to :: Rep Pandoc x -> Pandoc #
Semigroup Pandoc
Instance details Defined in Text.Pandoc.Definition Methods (<>) :: Pandoc -> Pandoc -> Pandoc # sconcat :: NonEmpty Pandoc -> Pandoc # stimes :: Integral b => b -> Pandoc -> Pandoc #
Monoid Pandoc
Instance details Defined in Text.Pandoc.Definition Methods mempty :: Pandoc # mappend :: Pandoc -> Pandoc -> Pandoc # mconcat :: [Pandoc] -> Pandoc #
NFData Pandoc
Instance details Defined in Text.Pandoc.Definition Methods rnf :: Pandoc -> () #
ToJSON Pandoc
Instance details Defined in Text.Pandoc.Definition Methods toJSON :: Pandoc -> Value # toEncoding :: Pandoc -> Encoding # toJSONList :: [Pandoc] -> Value # toEncodingList :: [Pandoc] -> Encoding #
FromJSON Pandoc
Instance details Defined in Text.Pandoc.Definition Methods parseJSON :: Value -> Parser Pandoc # parseJSONList :: Value -> Parser [Pandoc] #
HasMeta Pandoc
Instance details Defined in Text.Pandoc.Builder Methods setMeta :: ToMetaValue b => Text -> b -> Pandoc -> Pandoc # deleteMeta :: Text -> Pandoc -> Pandoc #
type Rep Pandoc
Instance details Defined in Text.Pandoc.Definition type Rep Pandoc = D1 ('MetaData "Pandoc" "Text.Pandoc.Definition" "pandoc-types-1.22.1-EbcKbgjut7s2wZi6fSiAH8" 'False) (C1 ('MetaCons "Pandoc" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Meta) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Block])))

data ReportConfig Source #

Constructors

ReportConfig
Fields treeStyle :: ReportTreeStyle reportMode :: ReportMode

Instances

Instances details

Default ReportConfig Source #
Instance details Defined in Data.OpenApi.Compare.Report Methods def :: ReportConfig #

data ReportTreeStyle Source #

Constructors

HeadersTreeStyle
FoldingBlockquotesTreeStyle

data ReportMode Source #

Constructors

OnlyErrors
All

Instances

Instances details

Eq ReportMode Source #
Instance details Defined in Data.OpenApi.Compare.Report Methods (==) :: ReportMode -> ReportMode -> Bool # (/=) :: ReportMode -> ReportMode -> Bool #