docs

Jan 27, 2020

Changes in this version

type ComponentSpec

+ Footnotes string

+ Summary string

+ type FieldInterpolation int

+ const FieldInterpolationBatchWide

+ const FieldInterpolationIndividual

+ const FieldInterpolationNone

type FieldSpec

+ Children FieldSpecs

+ Interpolation FieldInterpolation

+ Name string

+ Options []string

+ Type string

+ func (f FieldSpec) HasOptions(options ...string) FieldSpec

+ func (f FieldSpec) HasType(typeStr string) FieldSpec

+ func (f FieldSpec) SupportsInterpolation(batchWide bool) FieldSpec

+ func (f FieldSpec) WithChildren(children ...FieldSpec) FieldSpec

type FieldSpecs

+ func (f FieldSpecs) Add(specs ...FieldSpec) FieldSpecs

+ func (f FieldSpecs) Merge(specs FieldSpecs) FieldSpecs

Jan 16, 2020

Changes in this version

+ type ComponentSpec struct

+ Description string

+ Fields FieldSpecs

+ Name string

+ Type string

+ func (c *ComponentSpec) AsMarkdown(fullConfigExample interface{}) ([]byte, error)

+ type FieldSpec struct

+ Advanced bool

+ Deprecated bool

+ Description string

+ Examples []interface{}

+ func FieldAdvanced(description string, examples ...interface{}) FieldSpec

+ func FieldCommon(description string, examples ...interface{}) FieldSpec

+ func FieldDeprecated() FieldSpec

+ type FieldSpecs map[string]FieldSpec

+ func (f FieldSpecs) ConfigAdvanced(config map[string]interface{}) map[string]interface{}

+ func (f FieldSpecs) ConfigCommon(config map[string]interface{}) map[string]interface{}