renderer

Documentation

Index

• Variables
• func RenderDocumentation(r Renderer, objects map[string]jsonschema.Schema, ...) (string, error)
• type AsciiDocRenderer
  • func (a *AsciiDocRenderer) Header(title string, level int) string
  • func (a *AsciiDocRenderer) PropertyHeader(title string, level int) string
  • func (a *AsciiDocRenderer) PropertyRow(parent, name string, schema jsonschema.Schema, maxDepth bool) string
  • func (AsciiDocRenderer) TableFooter() string
  • func (AsciiDocRenderer) TableHeader() string
  • func (a *AsciiDocRenderer) TextParagraph(text string) string
• type MarkdownRenderer
  • func (m *MarkdownRenderer) Header(title string, level int) string
  • func (m *MarkdownRenderer) PropertyHeader(title string, level int) string
  • func (m *MarkdownRenderer) PropertyRow(parent, name string, schema jsonschema.Schema, maxDepth bool) string
  • func (MarkdownRenderer) TableFooter() string
  • func (MarkdownRenderer) TableHeader() string
  • func (MarkdownRenderer) TextParagraph(text string) string
• type Renderer
  • func NewAsciidocRenderer(flatOutput string) Renderer
  • func NewMarkdownRenderer(flatOutput string) Renderer

Variables

var HeaderOffset int

Functions

func RenderDocumentation

func RenderDocumentation(r Renderer, objects map[string]jsonschema.Schema, requiredObjectNames map[string]bool, requiredOnly bool, depth int, flatObjects []string) (string, error)

Types

type AsciiDocRenderer

type AsciiDocRenderer struct {
	// contains filtered or unexported fields
}

func (*AsciiDocRenderer) Header

func (a *AsciiDocRenderer) Header(title string, level int) string

func (*AsciiDocRenderer) PropertyHeader

func (a *AsciiDocRenderer) PropertyHeader(title string, level int) string

func (*AsciiDocRenderer) PropertyRow

func (a *AsciiDocRenderer) PropertyRow(parent, name string, schema jsonschema.Schema, maxDepth bool) string

func (AsciiDocRenderer) TableFooter

func (AsciiDocRenderer) TableFooter() string

func (AsciiDocRenderer) TableHeader

func (AsciiDocRenderer) TableHeader() string

func (*AsciiDocRenderer) TextParagraph

func (a *AsciiDocRenderer) TextParagraph(text string) string

type MarkdownRenderer

type MarkdownRenderer struct {
	// contains filtered or unexported fields
}

func (*MarkdownRenderer) Header

func (m *MarkdownRenderer) Header(title string, level int) string

func (*MarkdownRenderer) PropertyHeader

func (m *MarkdownRenderer) PropertyHeader(title string, level int) string

func (*MarkdownRenderer) PropertyRow

func (m *MarkdownRenderer) PropertyRow(parent, name string, schema jsonschema.Schema, maxDepth bool) string

func (MarkdownRenderer) TableFooter

func (MarkdownRenderer) TableFooter() string

func (MarkdownRenderer) TableHeader

func (MarkdownRenderer) TableHeader() string

func (MarkdownRenderer) TextParagraph

func (MarkdownRenderer) TextParagraph(text string) string

type Renderer

type Renderer interface {
	Header(string, int) string
	PropertyHeader(string, int) string
	TableHeader() string
	TableFooter() string
	PropertyRow(string, string, jsonschema.Schema, bool) string
	TextParagraph(string) string
}

func NewAsciidocRenderer

func NewAsciidocRenderer(flatOutput string) Renderer

func NewMarkdownRenderer

func NewMarkdownRenderer(flatOutput string) Renderer