v1

type ResourceList struct {
	// apiVersion of ResourceList
	APIVersion string `json:"apiVersion"`

	// kind of ResourceList i.e. `ResourceList`
	Kind string `json:"kind"`

	// [input/output]
	// Items is a list of Kubernetes objects:
	// https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#types-kinds).
	//
	// A function will read this field in the input ResourceList and populate
	// this field in the output ResourceList.
	Items []*unstructured.Unstructured `json:"items"`

	// [input]
	// FunctionConfig is an optional Kubernetes object for passing arguments to a
	// function invocation.
	// +optional
	FunctionConfig *unstructured.Unstructured `json:"functionConfig,omitempty"`

	// [output]
	// Results is an optional list that can be used by function to emit results
	// for observability and debugging purposes.
	// +optional
	Results []*Result `json:"results,omitempty"`
}

type Result struct {
	// Message is a human readable message.
	Message string `json:"message"`

	// file
	// +optional
	File *ResultFile `json:"file,omitempty"`

	// resource ref
	// +optional
	ResourceRef *ResultResourceRef `json:"resourceRef,omitempty"`

	// Severity is the severity of a result:
	//
	// "error": indicates an error result.
	// "warning": indicates a warning result.
	// "info": indicates an informational result.
	//
	// Enum: [error warning info]
	// +optional
	Severity string `json:"severity,omitempty"`

	// Tags is an unstructured key value map stored with a result that may be set
	// by external tools to store and retrieve arbitrary metadata.
	// +optional
	Tags map[string]string `json:"tags,omitempty"`
}

type ResultFile struct {
	// Path is the OS agnostic, slash-delimited, relative path.
	// e.g. `some-dir/some-file.yaml`.
	Path string `json:"path"`

	// Index of the object in a multi-object YAML file.
	// +optional
	Index float64 `json:"index,omitempty"`
}

type ResultResourceRef struct {

	// APIVersion refers to the `apiVersion` field of the object manifest.
	APIVersion string `json:"apiVersion"`

	// Kind refers to the `kind` field of the object.
	Kind string `json:"kind"`

	// Name refers to the `metadata.name` field of the object manifest.
	Name string `json:"name"`

	// Namespace refers to the `metadata.namespace` field of the object manifest.
	// +optional
	Namespace string `json:"namespace,omitempty"`
}