package v2

import "k8s.io/kubectl/pkg/explain/v2"

Index ¶

• func PrintModelDescription( fieldsPath []string, w io.Writer, client openapi.Client, gvr schema.GroupVersionResource, recursive bool, outputFormat string, ) error
• func WithBuiltinTemplateFuncs(tmpl *template.Template) *template.Template
• type Generator
• func NewGenerator() Generator
• type TemplateContext

Functions ¶

func PrintModelDescription ¶

func PrintModelDescription(
	fieldsPath []string,
	w io.Writer,
	client openapi.Client,
	gvr schema.GroupVersionResource,
	recursive bool,
	outputFormat string,
) error

PrintModelDescription prints the description of a specific model or dot path. If recursive, all components nested within the fields of the schema will be printed.

func WithBuiltinTemplateFuncs ¶

func WithBuiltinTemplateFuncs(tmpl *template.Template) *template.Template

Types ¶

type Generator ¶

type Generator interface {
	AddTemplate(name string, contents string) error

	Render(

		templateName string,

		document map[string]interface{},

		gvr schema.GroupVersionResource,

		fieldSelector []string,

		recursive bool,

		writer io.Writer,
	) error
}

func NewGenerator ¶

func NewGenerator() Generator

type TemplateContext ¶

type TemplateContext struct {
	GVR       schema.GroupVersionResource
	Document  map[string]interface{}
	Recursive bool
	FieldPath []string
}

Source Files ¶

explain.go funcs.go generator.go template.go

Directories ¶