Dashboard schema: Review and mature graphTooltip property (#62082)

* Review and mature graphTooltip property of Dashboard kind

* Review
This commit is contained in:
Dominik Prokop 2023-01-25 03:40:53 -08:00 committed by GitHub
parent a6f0b69d6f
commit 5f6616ff3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 4 deletions

View File

@ -33,8 +33,9 @@ lineage: seqs: [
// Timezone of dashboard, // Timezone of dashboard,
timezone?: *"browser" | "utc" | "" @grafanamaturity(NeedsExpertReview) timezone?: *"browser" | "utc" | "" @grafanamaturity(NeedsExpertReview)
// Whether a dashboard is editable or not. // Whether a dashboard is editable or not.
editable: bool | *true editable: bool | *true
graphTooltip: #DashboardCursorSync @grafanamaturity(NeedsExpertReview) // Configuration of dashboard cursor sync behavior.
graphTooltip: #DashboardCursorSync
// Time range for dashboard, e.g. last 6 hours, last 7 days, etc // Time range for dashboard, e.g. last 6 hours, last 7 days, etc
time?: { time?: {
from: string | *"now-6h" from: string | *"now-6h"
@ -291,7 +292,7 @@ lineage: seqs: [
// 0 for no shared crosshair or tooltip (default). // 0 for no shared crosshair or tooltip (default).
// 1 for shared crosshair. // 1 for shared crosshair.
// 2 for shared crosshair AND shared tooltip. // 2 for shared crosshair AND shared tooltip.
#DashboardCursorSync: *0 | 1 | 2 @cuetsy(kind="enum",memberNames="Off|Crosshair|Tooltip") @grafanamaturity(NeedsExpertReview) #DashboardCursorSync: *0 | 1 | 2 @cuetsy(kind="enum",memberNames="Off|Crosshair|Tooltip")
// Schema for panel targets is specified by datasource // Schema for panel targets is specified by datasource
// plugins. We use a placeholder definition, which the Go // plugins. We use a placeholder definition, which the Go

View File

@ -651,6 +651,9 @@ export interface Dashboard {
*/ */
fiscalYearStartMonth?: number; fiscalYearStartMonth?: number;
gnetId?: string; gnetId?: string;
/**
* Configuration of dashboard cursor sync behavior.
*/
graphTooltip: DashboardCursorSync; graphTooltip: DashboardCursorSync;
/** /**
* Unique numeric identifier for the dashboard. * Unique numeric identifier for the dashboard.

View File

@ -283,7 +283,7 @@
0, 0,
0 0
], ],
"grafanaMaturityCount": 144, "grafanaMaturityCount": 142,
"lineageIsGroup": false, "lineageIsGroup": false,
"links": { "links": {
"docs": "https://grafana.com/docs/grafana/next/developers/kinds/core/dashboard/schema-reference", "docs": "https://grafana.com/docs/grafana/next/developers/kinds/core/dashboard/schema-reference",