grafana/apps/dashboard/kinds/dashboard.cue

package kinds

import (
	"github.com/grafana/grafana/sdkkinds/dashboard/v0alpha1"
	"github.com/grafana/grafana/sdkkinds/dashboard/v1alpha1"
	"github.com/grafana/grafana/sdkkinds/dashboard/v2alpha1"
)

// Status is the shared status of all dashboard versions.
DashboardStatus: {
	// Optional conversion status.
	conversion?: ConversionStatus
}

// ConversionStatus is the status of the conversion of the dashboard.
ConversionStatus: {
	// Whether from another version has failed.
	// If true, means that the dashboard is not valid,
	// and the caller should instead fetch the stored version.
	failed: bool

	// The version which was stored when the dashboard was created / updated.
	// Fetching this version should always succeed.
	storedVersion: string

	// The error message from the conversion.
	// Empty if the conversion has not failed.
	error: string
}

dashboard: {
	kind:       "Dashboard"
	pluralName: "Dashboards"
	current:    "v0alpha1"

	codegen: {
		ts: {
			enabled: true
			config: {
				enumsAsUnionTypes: true
			}
		}
		go: {
			enabled: true
		}
	}

	versions: {
		"v0alpha1": {
			schema: {
				spec:   v0alpha1.DashboardSpec
				status: DashboardStatus
			}
		}
		"v1alpha1": {
			schema: {
				spec:   v1alpha1.DashboardSpec
				status: DashboardStatus
			}
		}
		"v2alpha1": {
			schema: {
				spec:   v2alpha1.DashboardSpec
				status: DashboardStatus
			}
		}
	}
}