annotations

package

v0.11.4 Latest Latest Go to latest Published: Apr 23, 2025 License: Apache-2.0 Imports: 13 Imported by: 1

Details

View Source

const CRD_DOCS_GENERATOR = "CRD_DOCS_GENERATOR"

This section is empty.

This section is empty.

type Annotation struct {
	Documentation string
	Support       []AnnotationSupportRelease
}

type AnnotationSupportRelease struct {
	Release    string
	APIVersion string
	CRD        string
}

type CRDAnnotationSupport struct {
	Annotation    string
	CRDName       string
	CRDVersion    string
	Release       string
	Documentation string
}

CRDAnnotationSupport is a flattened combination of annotation details and the CRD they are applicable to.

func Collect(startPath string) ([]CRDAnnotationSupport, error)

Collect finds all annotations in a folder and returns them.

func FilterForCRD(annotations []CRDAnnotationSupport, crdName string, version string) []CRDAnnotationSupport

func Sort(annotations []CRDAnnotationSupport) []CRDAnnotationSupport