schema

Documentation

Index

• type Full
  • func New(version, date string) Full
  • func (f *Full) Flattened() map[string][]string
  • func (f *Full) Scrub()

Types

type Full

type Full struct {
	Version    string               `json:"version"`
	Date       string               `json:"date"`
	Config     docs.FieldSpecs      `json:"config,omitempty"`
	Buffers    []docs.ComponentSpec `json:"buffers,omitempty"`
	Caches     []docs.ComponentSpec `json:"caches,omitempty"`
	Inputs     []docs.ComponentSpec `json:"inputs,omitempty"`
	Outputs    []docs.ComponentSpec `json:"outputs,omitempty"`
	Processors []docs.ComponentSpec `json:"processors,omitempty"`
	RateLimits []docs.ComponentSpec `json:"rate-limits,omitempty"`
	Metrics    []docs.ComponentSpec `json:"metrics,omitempty"`
	Tracers    []docs.ComponentSpec `json:"tracers,omitempty"`

	BloblangFunctions []query.FunctionSpec `json:"bloblang-functions,omitempty"`
	BloblangMethods   []query.MethodSpec   `json:"bloblang-methods,omitempty"`
	// contains filtered or unexported fields
}

Full represents the entirety of the Benthos instances configuration spec and all plugins.

func New

func New(version, date string) Full

New walks all registered Benthos components and creates a full schema definition of it.

func (*Full) Flattened

func (f *Full) Flattened() map[string][]string

Flattened returns a flattened representation of all registered plugin types and names.

func (*Full) Scrub

func (f *Full) Scrub()

Scrub walks the schema and removes all descriptions and other long-form documentation, reducing the overall size.