grafana/kinds/preferences/preferences_kind.cue
Julien Duchesne 637cfa89be
Swagger: Rename Spec to Preferences (#78226)
The definition for preferences is globally named `Spec` because that's the type that cue outputs
This adds a swagger annotation to rename the definition in the swagger schema to `Preferences`
This will be easier to use in generated clients
2023-12-04 09:51:09 -05:00

49 lines
1.0 KiB
CUE

package kind
name: "Preferences"
pluralName: "Preferences"
maturity: "merged"
description: "The user or team frontend preferences"
lineage: schemas: [{
version: [0, 0]
schema: {
// Spec defines user, team or org Grafana preferences
// swagger:model Preferences
spec: {
// UID for the home dashboard
homeDashboardUID?: string
// The timezone selection
// TODO: this should use the timezone defined in common
timezone?: string
// day of the week (sunday, monday, etc)
weekStart?: string
// light, dark, empty is default
theme?: string
// Selected language (beta)
language?: string
// Explore query history preferences
queryHistory?: #QueryHistoryPreference
// Cookie preferences
cookiePreferences?: #CookiePreferences
} @cuetsy(kind="interface")
#QueryHistoryPreference: {
// one of: '' | 'query' | 'starred';
homeTab?: string
} @cuetsy(kind="interface")
#CookiePreferences: {
analytics?: {}
performance?: {}
functional?: {}
} @cuetsy(kind="interface")
}
}]