formatters

Mar 30, 2026

Changes in this version

+ func HtmlTemplateFuncs() template.FuncMap

+ func MarkupTemplateFuncs() template.FuncMap

+ type ChangeGroup struct

+ Operation string

+ Path string

+ Section string

+ type ChangesByGroup map[ChangeGroup]*Changes

+ type GroupEntry struct

+ Changes *Changes

+ Group ChangeGroup

type TemplateData

+ GroupedChanges ChangesByGroup

Mar 17, 2026

Changes in this version

type Change

+ Fingerprint string

Mar 14, 2026

Changes in this version

type Change

+ BaseSource *checker.Source

+ RevisionSource *checker.Source

type Check

+ Action string

+ Direction string

+ Location string

+ Mitigation string

Feb 5, 2026

Changes in this version

type Checks

+ func (checks Checks) SortFunc(a, b Check) int

Aug 3, 2025

Changes in this version

+ func GetSupportedTemplateFormats() []string

type Formatter

+ SupportsTemplate func() bool

type GitHubActionsFormatter

+ func (f GitHubActionsFormatter) SupportsTemplate() bool

type HTMLFormatter

+ func (f HTMLFormatter) SupportsTemplate() bool

type JSONFormatter

+ func (f JSONFormatter) SupportsTemplate() bool

type JUnitFormatter

+ func (f JUnitFormatter) SupportsTemplate() bool

type MarkupFormatter

+ func (f MarkupFormatter) SupportsTemplate() bool

type RenderOpts

+ TemplatePath string

type SingleLineFormatter

+ func (f SingleLineFormatter) SupportsTemplate() bool

type TEXTFormatter

+ func (f TEXTFormatter) SupportsTemplate() bool

type YAMLFormatter

+ func (f YAMLFormatter) SupportsTemplate() bool

May 1, 2025

Changes in this version

type TemplateData

+ func (t TemplateData) GetVersionTitle() string

Apr 16, 2025

Changes in this version

type RenderOpts

+ WrapInObject bool

Mar 10, 2025

Changes in this version

+ func ExecuteHtmlTemplate(tmpl *template.Template, changes ChangesByEndpoint, ...) ([]byte, error)

+ func ExecuteTextTemplate(tmpl *template.Template, changes ChangesByEndpoint, ...) ([]byte, error)

+ func GetSupportedFormats() []string

+ func SupportedFormatsByContentType(output Output) []string

+ type Change struct

+ Attributes map[string]any

+ Comment string

+ Id string

+ IsBreaking bool

+ Level checker.Level

+ Operation string

+ OperationId string

+ Path string

+ Section string

+ Source string

+ Text string

+ type Changes []Change

+ func NewChanges(originalChanges checker.Changes, l checker.Localizer) Changes

+ type ChangesByEndpoint map[Endpoint]*Changes

+ func GroupChanges(changes checker.Changes, l checker.Localizer) ChangesByEndpoint

+ type Check struct

+ Description string

+ Id string

+ Level string

+ type Checks []Check

+ func (checks Checks) Len() int

+ func (checks Checks) Less(i, j int) bool

+ func (checks Checks) Swap(i, j int)

+ type Endpoint struct

+ Operation string

+ Path string

+ type Format string

+ const FormatGithubActions

+ const FormatHTML

+ const FormatJSON

+ const FormatJUnit

+ const FormatMarkdown

+ const FormatMarkup

+ const FormatSarif

+ const FormatSingleLine

+ const FormatText

+ const FormatYAML

+ type Formatter interface

+ RenderChangelog func(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ RenderChecks func(checks Checks, opts RenderOpts) ([]byte, error)

+ RenderDiff func(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ RenderFlatten func(spec *openapi3.T, opts RenderOpts) ([]byte, error)

+ RenderSummary func(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ SupportedOutputs func() []Output

+ func Lookup(format string, opts FormatterOpts) (Formatter, error)

+ type FormatterOpts struct

+ Language string

+ func DefaultFormatterOpts() FormatterOpts

+ type GitHubActionsFormatter struct

+ Localizer checker.Localizer

+ func (f GitHubActionsFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ func (f GitHubActionsFormatter) RenderChecks(Checks, RenderOpts) ([]byte, error)

+ func (f GitHubActionsFormatter) RenderDiff(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f GitHubActionsFormatter) RenderFlatten(*openapi3.T, RenderOpts) ([]byte, error)

+ func (f GitHubActionsFormatter) RenderSummary(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f GitHubActionsFormatter) SupportedOutputs() []Output

+ type HTMLFormatter struct

+ Localizer checker.Localizer

+ func (f HTMLFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ func (f HTMLFormatter) RenderChecks(Checks, RenderOpts) ([]byte, error)

+ func (f HTMLFormatter) RenderDiff(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ func (f HTMLFormatter) RenderFlatten(*openapi3.T, RenderOpts) ([]byte, error)

+ func (f HTMLFormatter) RenderSummary(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f HTMLFormatter) SupportedOutputs() []Output

+ type JSONFormatter struct

+ Localizer checker.Localizer

+ func (f JSONFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ func (f JSONFormatter) RenderChecks(checks Checks, opts RenderOpts) ([]byte, error)

+ func (f JSONFormatter) RenderDiff(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ func (f JSONFormatter) RenderFlatten(spec *openapi3.T, opts RenderOpts) ([]byte, error)

+ func (f JSONFormatter) RenderSummary(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ func (f JSONFormatter) SupportedOutputs() []Output

+ type JUnitFailure struct

+ CDATA string

+ Message string

+ type JUnitFormatter struct

+ Localizer checker.Localizer

+ func (f JUnitFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ func (f JUnitFormatter) RenderChecks(Checks, RenderOpts) ([]byte, error)

+ func (f JUnitFormatter) RenderDiff(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f JUnitFormatter) RenderFlatten(*openapi3.T, RenderOpts) ([]byte, error)

+ func (f JUnitFormatter) RenderSummary(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f JUnitFormatter) SupportedOutputs() []Output

+ type JUnitTestCase struct

+ Classname string

+ Failure *JUnitFailure

+ Name string

+ Time string

+ type JUnitTestSuite struct

+ Errors int

+ Failures int

+ Name string

+ Package string

+ TestCases []JUnitTestCase

+ Tests int

+ Time string

+ XMLName xml.Name

+ type JUnitTestSuites struct

+ TestSuites []JUnitTestSuite

+ XMLName xml.Name

+ type MarkupFormatter struct

+ Localizer checker.Localizer

+ func (f MarkupFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ func (f MarkupFormatter) RenderChecks(Checks, RenderOpts) ([]byte, error)

+ func (f MarkupFormatter) RenderDiff(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ func (f MarkupFormatter) RenderFlatten(*openapi3.T, RenderOpts) ([]byte, error)

+ func (f MarkupFormatter) RenderSummary(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f MarkupFormatter) SupportedOutputs() []Output

+ type Output int

+ const OutputChangelog

+ const OutputChecks

+ const OutputDiff

+ const OutputFlatten

+ const OutputSummary

+ type RenderOpts struct

+ ColorMode checker.ColorMode

+ func NewRenderOpts() RenderOpts

+ type SingleLineFormatter struct

+ Localizer checker.Localizer

+ func (f SingleLineFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ func (f SingleLineFormatter) RenderChecks(Checks, RenderOpts) ([]byte, error)

+ func (f SingleLineFormatter) RenderDiff(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f SingleLineFormatter) RenderFlatten(*openapi3.T, RenderOpts) ([]byte, error)

+ func (f SingleLineFormatter) RenderSummary(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f SingleLineFormatter) SupportedOutputs() []Output

+ type TEXTFormatter struct

+ Localizer checker.Localizer

+ func (f TEXTFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ func (f TEXTFormatter) RenderChecks(checks Checks, opts RenderOpts) ([]byte, error)

+ func (f TEXTFormatter) RenderDiff(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ func (f TEXTFormatter) RenderFlatten(*openapi3.T, RenderOpts) ([]byte, error)

+ func (f TEXTFormatter) RenderSummary(*diff.Diff, RenderOpts) ([]byte, error)

+ func (f TEXTFormatter) SupportedOutputs() []Output

+ type TemplateData struct

+ APIChanges ChangesByEndpoint

+ BaseVersion string

+ RevisionVersion string

+ type YAMLFormatter struct

+ Localizer checker.Localizer

+ func (f YAMLFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error)

+ func (f YAMLFormatter) RenderChecks(checks Checks, opts RenderOpts) ([]byte, error)

+ func (f YAMLFormatter) RenderDiff(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ func (f YAMLFormatter) RenderFlatten(spec *openapi3.T, opts RenderOpts) ([]byte, error)

+ func (f YAMLFormatter) RenderSummary(diff *diff.Diff, opts RenderOpts) ([]byte, error)

+ func (f YAMLFormatter) SupportedOutputs() []Output