diff --git a/docs/sources/developers/kinds/core/dashboard/schema-reference.md b/docs/sources/developers/kinds/core/dashboard/schema-reference.md index 695d39fcc96..772f595b369 100644 --- a/docs/sources/developers/kinds/core/dashboard/schema-reference.md +++ b/docs/sources/developers/kinds/core/dashboard/schema-reference.md @@ -22,7 +22,7 @@ title: Dashboard kind | `style` | string | **Yes** | Theme of dashboard. Possible values are: `dark`, `light`. Default: `dark`. | | `annotations` | [object](#annotations) | No | TODO docs | | `description` | string | No | Description of dashboard. | -| `fiscalYearStartMonth` | integer | No | TODO docs | +| `fiscalYearStartMonth` | integer | No | The month that the fiscal year starts on. 0 = January, 11 = December Default: `0`. | | `gnetId` | string | No | | | `id` | integer | No | Unique numeric identifier for the dashboard.
TODO must isolate or remove identifiers local to a Grafana instance...? | | `links` | [DashboardLink](#dashboardlink)[] | No | TODO docs | diff --git a/kinds/dashboard/dashboard_kind.cue b/kinds/dashboard/dashboard_kind.cue index 3af116c52e6..e27e1364109 100644 --- a/kinds/dashboard/dashboard_kind.cue +++ b/kinds/dashboard/dashboard_kind.cue @@ -56,8 +56,8 @@ lineage: seqs: [ // TODO docs time_options: [...string] | *["5m", "15m", "1h", "6h", "12h", "24h", "2d", "7d", "30d"] } @grafanamaturity(NeedsExpertReview) - // TODO docs - fiscalYearStartMonth?: uint8 & <13 @grafanamaturity(NeedsExpertReview) + // The month that the fiscal year starts on. 0 = January, 11 = December + fiscalYearStartMonth?: uint8 & <12 | *0 // TODO docs liveNow?: bool @grafanamaturity(NeedsExpertReview) // TODO docs diff --git a/packages/grafana-schema/src/raw/dashboard/x/dashboard_types.gen.ts b/packages/grafana-schema/src/raw/dashboard/x/dashboard_types.gen.ts index 4bf93c84df6..d09b8ab7c0e 100644 --- a/packages/grafana-schema/src/raw/dashboard/x/dashboard_types.gen.ts +++ b/packages/grafana-schema/src/raw/dashboard/x/dashboard_types.gen.ts @@ -647,7 +647,7 @@ export interface Dashboard { */ editable: boolean; /** - * TODO docs + * The month that the fiscal year starts on. 0 = January, 11 = December */ fiscalYearStartMonth?: number; gnetId?: string; @@ -800,6 +800,7 @@ export interface Dashboard { export const defaultDashboard: Partial = { editable: true, + fiscalYearStartMonth: 0, graphTooltip: DashboardCursorSync.Off, links: [], panels: [], diff --git a/pkg/kinds/dashboard/dashboard_types_gen.go b/pkg/kinds/dashboard/dashboard_types_gen.go index c14456ce35a..2e65c507032 100644 --- a/pkg/kinds/dashboard/dashboard_types_gen.go +++ b/pkg/kinds/dashboard/dashboard_types_gen.go @@ -684,7 +684,7 @@ type Dashboard struct { // Whether a dashboard is editable or not. Editable bool `json:"editable"` - // TODO docs + // The month that the fiscal year starts on. 0 = January, 11 = December FiscalYearStartMonth *int `json:"fiscalYearStartMonth,omitempty"` GnetId *string `json:"gnetId,omitempty"` diff --git a/pkg/kindsys/report.json b/pkg/kindsys/report.json index 3b3aaddec33..7ed9ccdc6b4 100644 --- a/pkg/kindsys/report.json +++ b/pkg/kindsys/report.json @@ -283,7 +283,7 @@ 0, 0 ], - "grafanaMaturityCount": 142, + "grafanaMaturityCount": 141, "lineageIsGroup": false, "links": { "docs": "https://grafana.com/docs/grafana/next/developers/kinds/core/dashboard/schema-reference",