builder

Documentation

Index

• func LoadCRDs(dirpath string) ([]*apiextensions.CustomResourceDefinition, error)
• type FieldModel
• type GroupModel
• type KindModel
• type Model
  • func LoadModel(file string) (*Model, error)
• type ModelBuilder
  • func NewModelBuilder(model *Model, strict bool, templatesDirOrFile string, outputFilepath string, ...) *ModelBuilder
  • func (b *ModelBuilder) Add(crd *apiextensions.CustomResourceDefinition) error
  • func (b *ModelBuilder) Output() error
• type PageMetadata
• type TypeModel

Functions

func LoadCRDs

func LoadCRDs(dirpath string) ([]*apiextensions.CustomResourceDefinition, error)

LoadCRDs loads all CustomResourceDefinition resources from a directory (glob)

Types

type FieldModel

type FieldModel struct {
	Name        string
	Type        string
	TypeKey     *string
	Description string
	Required    bool
	Schema      apiextensions.JSONSchemaProps
}

type GroupModel

type GroupModel struct {
	// Metadata PageMetadata `yaml:"metadata"`
	Group   string       `yaml:"group"`
	Version string       `yaml:"version"`
	Kinds   []*KindModel `yaml:"kinds"`
}

type KindModel

type KindModel struct {
	// Metadata PageMetadata `yaml:"metadata"`
	Name string `yaml:"name"`

	Types []*TypeModel
}

type Model

type Model struct {
	Metadata PageMetadata  `yaml:"metadata"`
	Groups   []*GroupModel `yaml:"groups"`
}

func LoadModel

func LoadModel(file string) (*Model, error)

LoadModel loads a Model from a TOC yaml

type ModelBuilder

type ModelBuilder struct {
	Model              *Model
	Strict             bool
	TemplatesDirOrFile string
	OutputFilepath     string
	// contains filtered or unexported fields
}

ModelBuilder is the entry point for docs generation

func NewModelBuilder

func NewModelBuilder(model *Model, strict bool, templatesDirOrFile string, outputFilepath string, builtinTemplates embed.FS) *ModelBuilder

func (*ModelBuilder) Add

func (b *ModelBuilder) Add(crd *apiextensions.CustomResourceDefinition) error

Add adds a CustomResourceDefinition to the model

func (*ModelBuilder) Output

func (b *ModelBuilder) Output() error

Output writes markdown to the output direcory

type PageMetadata

type PageMetadata struct {
	Title       string `yaml:"title"`
	Weight      int    `yaml:"weight"`
	Description string `yaml:"description"`
}

type TypeModel

type TypeModel struct {
	Name        string
	Key         string
	ParentKey   *string
	Description string
	IsTopLevel  bool
	Fields      []*FieldModel
}