librarypanel_kind.cue

package kind

import (
	"strings"
	"time"
)

name:        "LibraryPanel"
maturity:    "experimental"
description: "A standalone panel"

lineage: schemas: [{
	version: [0, 0]
	schema: {
		spec: {
			// Folder UID
			folderUid?: string @grafanamaturity(ToMetadata="sys")

			// Library element UID
			uid: string

			// Panel name (also saved in the model)
			name: string & strings.MinRunes(1)

			// Panel description
			description?: string

			// The panel type (from inside the model)
			type: string & strings.MinRunes(1)

			// Dashboard version when this was saved (zero if unknown)
			schemaVersion?: uint16

			// panel version, incremented each time the dashboard is updated.
			version: int64 @grafanamaturity(NeedsExpertReview)

			// TODO: should be the same panel schema defined in dashboard
			// Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
			model: {...}

			// Object storage metadata
			meta?: #LibraryElementDTOMeta @grafanamaturity(ToMetadata="sys")
		} @cuetsy(kind="interface") @grafana(TSVeneer="type")

		#LibraryElementDTOMetaUser: {
			id:        int64
			name:      string
			avatarUrl: string
		} @cuetsy(kind="interface") @grafanamaturity(NeedsExpertReview)

		#LibraryElementDTOMeta: {
			folderName:          string
			folderUid:           string @grafanamaturity(ToMetadata="sys")
			connectedDashboards: int64

			created: string & time.Time
			updated: string & time.Time

			createdBy: #LibraryElementDTOMetaUser @grafanamaturity(ToMetadata="sys")
			updatedBy: #LibraryElementDTOMetaUser @grafanamaturity(ToMetadata="sys")
		} @cuetsy(kind="interface") @grafanamaturity(NeedsExpertReview)
	}
}]