-
Notifications
You must be signed in to change notification settings - Fork 57
/
schema.go
190 lines (166 loc) · 4.74 KB
/
schema.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
package schemabuilder
import (
"encoding/json"
"fmt"
sdkapi "github.com/grafana/grafana-plugin-sdk-go/experimental/apis/data/v0alpha1"
"k8s.io/kube-openapi/pkg/validation/spec"
)
// The k8s compatible jsonschema version
const draft04 = "https://json-schema.org/draft-04/schema#"
// Supported expression types
// +enum
type SchemaType string
const (
// Single query target saved in a dashboard/panel/alert JSON
SchemaTypeSaveModel SchemaType = "save"
// Single query payload included in a query request
SchemaTypeQueryPayload SchemaType = "payload"
// Pseudo panel model including multiple targets (not mixed)
SchemaTypePanelModel SchemaType = "panel"
// Query request against a single data source (not mixed)
SchemaTypeQueryRequest SchemaType = "request"
)
type QuerySchemaOptions struct {
PluginID []string
QueryTypes []sdkapi.QueryTypeDefinition
Mode SchemaType
}
// Given definitions for a plugin, return a valid spec
func GetQuerySchema(opts QuerySchemaOptions) (*spec.Schema, error) {
isRequest := opts.Mode == SchemaTypeQueryPayload || opts.Mode == SchemaTypeQueryRequest
generic, err := sdkapi.DataQuerySchema()
if err != nil {
return nil, err
}
ignoreForSave := map[string]bool{"maxDataPoints": true, "intervalMs": true}
common := make(map[string]spec.Schema)
for key, val := range generic.Properties {
if !isRequest && ignoreForSave[key] {
continue //
}
if key == "datasource" {
pattern := ""
for _, pid := range opts.PluginID {
if pattern != "" {
pattern += "|"
}
pattern += `^` + pid + `$`
}
if pattern == "" {
if opts.Mode == SchemaTypePanelModel {
return nil, fmt.Errorf("panel model requires pluginId")
}
} else {
t := val.Properties["type"]
t.Pattern = pattern
val.Properties["type"] = t
}
}
common[key] = val
}
// The types for each query type
queryTypes := []*spec.Schema{}
for _, qt := range opts.QueryTypes {
node := qt.Spec.Schema.DeepCopy().Spec
if node == nil {
return nil, fmt.Errorf("missing schema for: %s", qt.ObjectMeta.Name)
}
// Match all discriminators
for _, d := range qt.Spec.Discriminators {
ds, ok := node.Properties[d.Field]
if !ok {
ds = *spec.StringProperty()
}
ds.Pattern = `^` + d.Value + `$`
node.Properties[d.Field] = ds
node.Required = append(node.Required, d.Field)
}
queryTypes = append(queryTypes, node)
}
s := &spec.Schema{
SchemaProps: spec.SchemaProps{
Type: []string{"object"},
Schema: draft04,
Properties: make(map[string]spec.Schema),
},
}
// Single node -- just union the global and local properties
if len(queryTypes) == 1 {
s = queryTypes[0]
s.Schema = draft04
for key, val := range generic.Properties {
_, found := s.Properties[key]
if found {
continue
}
s.Properties[key] = val
}
} else {
for _, qt := range queryTypes {
qt.Required = append(qt.Required, "refId")
for k, v := range common {
_, found := qt.Properties[k]
if found {
continue
}
qt.Properties[k] = v
}
s.OneOf = append(s.OneOf, *qt)
}
}
switch opts.Mode {
case SchemaTypeQueryRequest:
return addRequestWrapper(s), nil
case SchemaTypePanelModel:
return addPanelWrapper(s), nil
}
return s, nil
}
// moves the schema the the query slot in a request
func addRequestWrapper(s *spec.Schema) *spec.Schema {
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Schema: draft04,
Type: []string{"object"},
Required: []string{"queries"},
AdditionalProperties: &spec.SchemaOrBool{Allows: false},
Properties: map[string]spec.Schema{
"from": *spec.StringProperty().WithDescription(
"From Start time in epoch timestamps in milliseconds or relative using Grafana time units."),
"to": *spec.StringProperty().WithDescription(
"To end time in epoch timestamps in milliseconds or relative using Grafana time units."),
"queries": *spec.ArrayProperty(s),
"debug": *spec.BoolProperty(),
"$schema": *spec.StringProperty().WithDescription("helper"),
},
},
}
}
// Pretends to be a panel object
func addPanelWrapper(s *spec.Schema) *spec.Schema {
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Schema: draft04,
Type: []string{"object"},
Required: []string{"targets", "type"},
AdditionalProperties: &spec.SchemaOrBool{Allows: true},
Properties: map[string]spec.Schema{
"type": *spec.StringProperty().WithDescription("the panel type"),
"targets": *spec.ArrayProperty(s),
},
},
}
}
func asJSONSchema(v any) (*spec.Schema, error) {
s, ok := v.(*spec.Schema)
if ok {
return s, nil
}
b, err := json.Marshal(v)
if err != nil {
return nil, err
}
s = &spec.Schema{}
err = json.Unmarshal(b, s)
return s, err
}