docs

Jan 21, 2022

Changes in this version

type LintContext

+ RejectDeprecated bool

Sep 8, 2021

Changes in this version

type LintContext

+ BloblangEnv *bloblang.Environment

Jul 26, 2021

Changes in this version

type FieldSpec

+ Bloblang bool

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

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

+ func (f FieldSpec) GetLintFunc() LintFunc

+ func (f FieldSpec) IsBloblang() FieldSpec

type LintContext

+ BloblangContext parser.Context

Jul 19, 2021

Changes in this version

+ func GetYAMLPath(root *yaml.Node, path ...string) (*yaml.Node, error)

type FieldSpec

+ func (f FieldSpec) SetYAMLPath(docsProvider Provider, root, value *yaml.Node, path ...string) error

+ func (f FieldSpec) YAMLLabelsToPaths(docsProvider Provider, node *yaml.Node, labelsToPaths map[string][]string, ...)

type FieldSpecs

+ func (f FieldSpecs) SetYAMLPath(docsProvider Provider, root, value *yaml.Node, path ...string) error

+ func (f FieldSpecs) YAMLLabelsToPaths(docsProvider Provider, node *yaml.Node, labelsToPaths map[string][]string, ...)

type LintContext

+ LabelsToLine map[string]int

Jul 12, 2021

Changes in this version

type FieldSpec

+ func (f FieldSpec) JSONSchema() interface{}

type FieldSpecs

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

type LintContext

+ DocsProvider Provider

+ type MappedDocsProvider struct

+ func NewMappedDocsProvider() *MappedDocsProvider

+ func (m *MappedDocsProvider) GetDocs(name string, ctype Type) (ComponentSpec, bool)

+ func (m *MappedDocsProvider) RegisterDocs(spec ComponentSpec)

+ type Provider interface

+ GetDocs func(name string, ctype Type) (ComponentSpec, bool)

type SanitiseConfig

+ DocsProvider Provider

+ func (c SanitiseConfig) GetDocs(name string, ctype Type) (ComponentSpec, bool)

Jun 25, 2021

Changes in this version

+ func ComponentFieldsFromConf(conf interface{}) (inferred map[string]FieldSpecs)

+ func FieldsTemplate(lintableExamples bool) string

+ func GetPluginConfigYAML(name string, node *yaml.Node) (yaml.Node, error)

+ func SanitiseYAML(cType Type, node *yaml.Node, conf SanitiseConfig) error

type ComponentSpec

+ func GetInferenceCandidateFromYAML(t Type, defaultType string, node *yaml.Node) (string, ComponentSpec, error)

+ type FieldKind string

+ var Kind2DArray FieldKind = "2darray"

+ var KindArray FieldKind = "array"

+ var KindMap FieldKind = "map"

+ var KindScalar FieldKind = "scalar"

type FieldSpec

+ IsAdvanced bool

+ IsDeprecated bool

+ IsOptional bool

+ Kind FieldKind

+ func FieldFromYAML(name string, node *yaml.Node) FieldSpec

+ func (f FieldSpec) ArrayOfArrays() FieldSpec

+ func (f FieldSpec) ChildDefaultAndTypesFromStruct(conf interface{}) FieldSpec

+ func (f FieldSpec) DefaultAndTypeFrom(from FieldSpec) FieldSpec

+ func (f FieldSpec) LintYAML(ctx LintContext, node *yaml.Node) []Lint

+ func (f FieldSpec) Optional() FieldSpec

+ func (f FieldSpec) SanitiseYAML(node *yaml.Node, conf SanitiseConfig) error

+ func (f FieldSpec) Scalar() FieldSpec

+ func (f FieldSpec) ToYAML(recurse bool) (*yaml.Node, error)

+ func (f FieldSpec) YAMLToValue(node *yaml.Node, conf ToValueConfig) (interface{}, error)

+ type FieldSpecCtx struct

+ DefaultMarshalled string

+ ExamplesMarshalled []string

+ FullName string

+ Spec FieldSpec

type FieldSpecs

+ func FieldsFromConf(conf interface{}) FieldSpecs

+ func FieldsFromYAML(node *yaml.Node) FieldSpecs

+ func (f FieldSpecs) DefaultAndTypeFrom(from FieldSpecs) FieldSpecs

+ func (f FieldSpecs) LintYAML(ctx LintContext, node *yaml.Node) []Lint

+ func (f FieldSpecs) SanitiseYAML(node *yaml.Node, conf SanitiseConfig) error

+ func (f FieldSpecs) ToYAML() (*yaml.Node, error)

+ func (f FieldSpecs) YAMLToMap(node *yaml.Node, conf ToValueConfig) (map[string]interface{}, error)

type FieldType

+ var FieldTypeBool FieldType = "bool"

+ var FieldTypeBuffer FieldType = "buffer"

+ var FieldTypeCache FieldType = "cache"

+ var FieldTypeCondition FieldType = "condition"

+ var FieldTypeFloat FieldType = "float"

+ var FieldTypeInput FieldType = "input"

+ var FieldTypeInt FieldType = "int"

+ var FieldTypeMetrics FieldType = "metrics"

+ var FieldTypeObject FieldType = "object"

+ var FieldTypeOutput FieldType = "output"

+ var FieldTypeProcessor FieldType = "processor"

+ var FieldTypeRateLimit FieldType = "rate_limit"

+ var FieldTypeString FieldType = "string"

+ var FieldTypeTracer FieldType = "tracer"

+ var FieldTypeUnknown FieldType = "unknown"

type Lint

+ func LintYAML(ctx LintContext, cType Type, node *yaml.Node) []Lint

+ type ToValueConfig struct

+ FallbackToInterface bool

+ Passive bool

Jun 16, 2021

Changes in this version

+ func GetPluginConfigNode(name string, value *yaml.Node) (yaml.Node, error)

type ComponentSpec

+ Plugin bool

type FieldSpec

+ ExamplesMarshalled []string

+ func (f FieldSpec) FlattenChildrenForDocs() FieldSpecs

+ func (f FieldSpec) LintOptions() FieldSpec

+ func (f FieldSpec) NodeToValue(node *yaml.Node) (interface{}, error)

+ func (f FieldSpec) ToNode(recurse bool) (*yaml.Node, error)

type FieldSpecs

+ func FieldsFromNode(node *yaml.Node) FieldSpecs

+ func (f FieldSpecs) NodeToMap(node *yaml.Node) (map[string]interface{}, error)

+ func (f FieldSpecs) ToNode() (*yaml.Node, error)

type FieldType

+ var FieldFloat FieldType = "float"

+ var FieldInt FieldType = "int"

type SanitiseConfig

+ ForExample bool

Mar 31, 2021

Changes in this version

+ var ErrBadLabel = fmt.Errorf(...)

+ func RegisterDocs(spec ComponentSpec)

+ func SanitiseComponentConfig(componentType Type, raw interface{}, filter FieldFilter) error

+ func SanitiseNode(cType Type, node *yaml.Node, conf SanitiseConfig) error

+ func ValidateLabel(label string) error

type ComponentSpec

+ Config FieldSpec

+ func GetDocs(name string, ctype Type) (ComponentSpec, bool)

+ func GetInferenceCandidate(t Type, defaultType string, raw interface{}) (string, ComponentSpec, error)

+ func GetInferenceCandidateFromNode(t Type, defaultType string, node *yaml.Node) (string, ComponentSpec, error)

+ type FieldFilter func(spec FieldSpec) bool

+ func ShouldDropDeprecated(b bool) FieldFilter

type FieldSpec

+ Interpolated bool

+ IsArray bool

+ IsMap bool

+ func FieldComponent() FieldSpec

+ func (f FieldSpec) Array() FieldSpec

+ func (f FieldSpec) IsInterpolated() FieldSpec

+ func (f FieldSpec) Linter(fn LintFunc) FieldSpec

+ func (f FieldSpec) Map() FieldSpec

+ func (f FieldSpec) OmitWhen(fn func(field, parent interface{}) (string, bool)) FieldSpec

+ func (f FieldSpec) SanitiseNode(node *yaml.Node, conf SanitiseConfig) error

+ func (f FieldSpec) Unlinted() FieldSpec

type FieldSpecs

+ func (f FieldSpecs) LintNode(ctx LintContext, node *yaml.Node) []Lint

+ func (f FieldSpecs) SanitiseNode(node *yaml.Node, conf SanitiseConfig) error

type FieldType

+ var FieldBuffer FieldType = "buffer"

+ var FieldCache FieldType = "cache"

+ var FieldCondition FieldType = "condition"

+ var FieldInput FieldType = "input"

+ var FieldMetrics FieldType = "metrics"

+ var FieldOutput FieldType = "output"

+ var FieldProcessor FieldType = "processor"

+ var FieldRateLimit FieldType = "rate_limit"

+ var FieldTracer FieldType = "tracer"

+ func (t FieldType) IsCoreComponent() (Type, bool)

+ type Lint struct

+ Column int

+ Level LintLevel

+ Line int

+ What string

+ func LintBloblangField(ctx LintContext, line, col int, v interface{}) []Lint

+ func LintBloblangMapping(ctx LintContext, line, col int, v interface{}) []Lint

+ func LintNode(ctx LintContext, cType Type, node *yaml.Node) []Lint

+ func NewLintError(line int, msg string) Lint

+ func NewLintWarning(line int, msg string) Lint

+ type LintContext struct

+ Labels map[string]int

+ func NewLintContext() LintContext

+ type LintFunc func(ctx LintContext, line, col int, value interface{}) []Lint

+ type LintLevel int

+ const LintError

+ const LintWarning

+ type SanitiseConfig struct

+ Filter FieldFilter

+ RemoveDeprecated bool

+ RemoveTypeField bool

type Status

+ var StatusPlugin Status = "plugin"

+ type Type string

+ var TypeBuffer Type = "buffer"

+ var TypeCache Type = "cache"

+ var TypeInput Type = "input"

+ var TypeMetrics Type = "metrics"

+ var TypeOutput Type = "output"

+ var TypeProcessor Type = "processor"

+ var TypeRateLimit Type = "rate_limit"

+ var TypeTracer Type = "tracer"

+ func Types() []Type

Nov 20, 2020

Changes in this version

type ComponentSpec

+ Version string

type FieldSpec

+ Version string

+ func (f FieldSpec) AtVersion(v string) FieldSpec

Nov 16, 2020

Changes in this version

type FieldSpec

+ AnnotatedOptions [][2]string

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

type FieldSpecs

+ func (f FieldSpecs) RemoveDeprecated(s config.Sanitised)

Oct 29, 2020

Changes in this version

type ComponentSpec

+ Status Status

+ type Status string

+ var StatusBeta Status = "beta"

+ var StatusDeprecated Status = "deprecated"

+ var StatusExperimental Status = "experimental"

+ var StatusStable Status = "stable"

Sep 14, 2020

Changes in this version

type FieldSpec

+ Default interface{}

+ func (f FieldSpec) HasDefault(v interface{}) FieldSpec

+ type FieldType string

+ var FieldArray FieldType = "array"

+ var FieldBool FieldType = "bool"

+ var FieldNumber FieldType = "number"

+ var FieldObject FieldType = "object"

+ var FieldString FieldType = "string"

+ var FieldUnknown FieldType = "unknown"

+ func GetFieldType(v interface{}) FieldType

Aug 30, 2020

Changes in this version

+ func BloblangFunctionsMarkdown() ([]byte, error)

+ func BloblangMethodsMarkdown() ([]byte, error)

type ComponentSpec

+ Categories []string

Aug 16, 2020

Changes in this version

+ type AnnotatedExample struct

+ Config string

+ Summary string

+ Title string

type ComponentSpec

+ Examples []AnnotatedExample

Aug 2, 2020

Changes in this version

+ type ComponentSpec struct

+ Beta bool

+ Deprecated bool

+ Description string

+ Fields FieldSpecs

+ Footnotes string

+ Name string

+ Summary string

+ Type string

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

+ type FieldInterpolation int

+ const FieldInterpolationBatchWide

+ const FieldInterpolationIndividual

+ const FieldInterpolationNone

+ type FieldSpec struct

+ Advanced bool

+ Children FieldSpecs

+ Deprecated bool

+ Description string

+ Examples []interface{}

+ Interpolation FieldInterpolation

+ Name string

+ Options []string

+ Type string

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

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

+ func FieldDeprecated(name string) FieldSpec

+ 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 []FieldSpec

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

+ func (f FieldSpecs) ConfigAdvanced(config interface{}) (interface{}, error)

+ func (f FieldSpecs) ConfigCommon(config interface{}) (interface{}, error)

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