pkg

Documentation

Index

• func GenMarkdownDocs(cmd *cobra.Command, searchPath string) error
• type CompResourceData
• type CompResourceDefinitionData
• type GenericOutputData
• type OutputOpts
• type XRDSpecData
• type XRDVersion

Functions

func GenMarkdownDocs

func GenMarkdownDocs(cmd *cobra.Command, searchPath string) error

GenMarkdownDocs driver function for markdown sub-command

Types

type CompResourceData

type CompResourceData struct {
	Name       string
	Kind       string
	APIVersion string
}

type CompResourceDefinitionData

type CompResourceDefinitionData struct {
	Name                  string
	CompositeResourceKind string
	ClaimNameKind         string
	Versions              []XRDVersion
}

CompResourceDefinitionData defines the XRD data and its XR, XRC details if any

type GenericOutputData

type GenericOutputData struct {
	CompositionName string
	XRAPIVersion    string
	XRKind          string
	Resources       []CompResourceData
	LinkedXRD       CompResourceDefinitionData
}

GenericOutputData output data struct used by markdown generator

type OutputOpts

type OutputOpts struct {
	OutputFileName string
	OutputTemplate string
	PrintXRDOnly   bool
}

type XRDSpecData

type XRDSpecData struct {
	FieldName   string
	Path        string
	Type        string
	Description string
	Default     string
	Required    bool
}

XRDSpecData struct for API specs in the output

type XRDVersion

type XRDVersion struct {
	Version       string
	XRDInputSpec  []XRDSpecData
	XRDOutputSpec []XRDSpecData
}

XRDVersion used for representing individual API versions