IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Dashboard schema: Review and mature fiscalYearStartMonth property (#62105)

Browse Source
This commit is contained in:
Alexa V 2023-01-25 13:28:13 +00:00 committed by GitHub
parent bd4e3f0d16
commit 85bf098fdb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/developers/kinds/core/dashboard/schema-reference.md
View File

@ -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.<br/>TODO must isolate or remove identifiers local to a Grafana instance...? |
| `links` | [DashboardLink](#dashboardlink)[] | No | TODO docs |

4
kinds/dashboard/dashboard_kind.cue
View File

@ -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

3
packages/grafana-schema/src/raw/dashboard/x/dashboard_types.gen.ts
View File

@ -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<Dashboard> = {
editable: true,
fiscalYearStartMonth: 0,
graphTooltip: DashboardCursorSync.Off,
links: [],
panels: [],

2
pkg/kinds/dashboard/dashboard_types_gen.go
View File

@ -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"`

2
pkg/kindsys/report.json
View File

@ -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",