fields

Documentation

Index

• Constants
• func Flatten(schemaJSON []byte, opts Options) (string, error)
• func FlattenMap(root map[string]any, opts Options) (string, error)
• type Options

Constants

const (
	// ScopeNamespaced identifies a namespaced Kubernetes kind.
	ScopeNamespaced = "Namespaced"
	// ScopeCluster identifies a cluster-scoped Kubernetes kind.
	ScopeCluster = "Cluster"
)

Functions

func Flatten

func Flatten(schemaJSON []byte, opts Options) (string, error)

Flatten decodes schemaJSON and returns its greppable field index.

func FlattenMap

func FlattenMap(root map[string]any, opts Options) (string, error)

FlattenMap returns the greppable field index for root without mutating it.

Types

type Options

type Options struct {
	GVK                schema.GroupVersionKind
	Scope              string
	Source             string
	Deprecated         bool
	DeprecationWarning string
}

Options controls field index generation for a single Kubernetes kind.