Skip to content

Commit 0aa2a36

Browse files
committed
run make generate again
1 parent 974c058 commit 0aa2a36

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+3646
-458
lines changed

docs/API/alerting/contactPoint.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ PARAMETERS:
2828
* **value** (`boolean`)
2929
- default value: `true`
3030

31-
EmbeddedContactPoint is the contact point type that is used
32-
by grafanas embedded alertmanager implementation.
31+
3332
### fn withName
3433

3534
```jsonnet
@@ -40,8 +39,8 @@ PARAMETERS:
4039

4140
* **value** (`string`)
4241

43-
EmbeddedContactPoint is the contact point type that is used
44-
by grafanas embedded alertmanager implementation.
42+
Name is used as grouping key in the UI. Contact points with the
43+
same name will be grouped in the UI.
4544
### fn withProvenance
4645

4746
```jsonnet
@@ -52,8 +51,7 @@ PARAMETERS:
5251

5352
* **value** (`string`)
5453

55-
EmbeddedContactPoint is the contact point type that is used
56-
by grafanas embedded alertmanager implementation.
54+
5755
### fn withSettings
5856

5957
```jsonnet
@@ -64,8 +62,7 @@ PARAMETERS:
6462

6563
* **value** (`object`)
6664

67-
EmbeddedContactPoint is the contact point type that is used
68-
by grafanas embedded alertmanager implementation.
65+
6966
### fn withSettingsMixin
7067

7168
```jsonnet
@@ -76,8 +73,7 @@ PARAMETERS:
7673

7774
* **value** (`object`)
7875

79-
EmbeddedContactPoint is the contact point type that is used
80-
by grafanas embedded alertmanager implementation.
76+
8177
### fn withType
8278

8379
```jsonnet
@@ -89,8 +85,7 @@ PARAMETERS:
8985
* **value** (`string`)
9086
- valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"`
9187

92-
EmbeddedContactPoint is the contact point type that is used
93-
by grafanas embedded alertmanager implementation.
88+
9489
### fn withUid
9590

9691
```jsonnet
@@ -101,5 +96,5 @@ PARAMETERS:
10196

10297
* **value** (`string`)
10398

104-
EmbeddedContactPoint is the contact point type that is used
105-
by grafanas embedded alertmanager implementation.
99+
UID is the unique identifier of the contact point. The UID can be
100+
set by the user.

docs/API/alerting/notificationPolicy/index.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ PARAMETERS:
3434

3535
* **value** (`string`)
3636

37-
A Route is a node that contains definitions of how to handle alerts. This is modified
38-
from the upstream alertmanager in that it adds the ObjectMatchers property.
37+
3938
### fn withContinue
4039

4140
```jsonnet
@@ -47,8 +46,7 @@ PARAMETERS:
4746
* **value** (`boolean`)
4847
- default value: `true`
4948

50-
A Route is a node that contains definitions of how to handle alerts. This is modified
51-
from the upstream alertmanager in that it adds the ObjectMatchers property.
49+
5250
### fn withGroupBy
5351

5452
```jsonnet
@@ -59,8 +57,7 @@ PARAMETERS:
5957

6058
* **value** (`array`)
6159

62-
A Route is a node that contains definitions of how to handle alerts. This is modified
63-
from the upstream alertmanager in that it adds the ObjectMatchers property.
60+
6461
### fn withGroupByMixin
6562

6663
```jsonnet
@@ -71,8 +68,7 @@ PARAMETERS:
7168

7269
* **value** (`array`)
7370

74-
A Route is a node that contains definitions of how to handle alerts. This is modified
75-
from the upstream alertmanager in that it adds the ObjectMatchers property.
71+
7672
### fn withGroupInterval
7773

7874
```jsonnet
@@ -83,8 +79,7 @@ PARAMETERS:
8379

8480
* **value** (`string`)
8581

86-
A Route is a node that contains definitions of how to handle alerts. This is modified
87-
from the upstream alertmanager in that it adds the ObjectMatchers property.
82+
8883
### fn withGroupWait
8984

9085
```jsonnet
@@ -95,8 +90,7 @@ PARAMETERS:
9590

9691
* **value** (`string`)
9792

98-
A Route is a node that contains definitions of how to handle alerts. This is modified
99-
from the upstream alertmanager in that it adds the ObjectMatchers property.
93+
10094
### fn withMatchers
10195

10296
```jsonnet
@@ -133,8 +127,7 @@ PARAMETERS:
133127

134128
* **value** (`array`)
135129

136-
A Route is a node that contains definitions of how to handle alerts. This is modified
137-
from the upstream alertmanager in that it adds the ObjectMatchers property.
130+
138131
### fn withMuteTimeIntervalsMixin
139132

140133
```jsonnet
@@ -145,8 +138,7 @@ PARAMETERS:
145138

146139
* **value** (`array`)
147140

148-
A Route is a node that contains definitions of how to handle alerts. This is modified
149-
from the upstream alertmanager in that it adds the ObjectMatchers property.
141+
150142
### fn withPolicy
151143

152144
```jsonnet
@@ -157,8 +149,7 @@ PARAMETERS:
157149

158150
* **value** (`array`)
159151

160-
A Route is a node that contains definitions of how to handle alerts. This is modified
161-
from the upstream alertmanager in that it adds the ObjectMatchers property.
152+
162153
### fn withPolicyMixin
163154

164155
```jsonnet
@@ -169,8 +160,7 @@ PARAMETERS:
169160

170161
* **value** (`array`)
171162

172-
A Route is a node that contains definitions of how to handle alerts. This is modified
173-
from the upstream alertmanager in that it adds the ObjectMatchers property.
163+
174164
### fn withRepeatInterval
175165

176166
```jsonnet
@@ -181,5 +171,3 @@ PARAMETERS:
181171

182172
* **value** (`string`)
183173

184-
A Route is a node that contains definitions of how to handle alerts. This is modified
185-
from the upstream alertmanager in that it adds the ObjectMatchers property.

docs/API/alerting/ruleGroup/rule/data.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ PARAMETERS:
2727

2828
* **value** (`string`)
2929

30-
30+
Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation.
3131
### fn withModel
3232

3333
```jsonnet
@@ -38,7 +38,7 @@ PARAMETERS:
3838

3939
* **value** (`object`)
4040

41-
41+
JSON is the raw JSON query and includes the above properties as well as custom properties.
4242
### fn withModelMixin
4343

4444
```jsonnet
@@ -49,7 +49,7 @@ PARAMETERS:
4949

5050
* **value** (`object`)
5151

52-
52+
JSON is the raw JSON query and includes the above properties as well as custom properties.
5353
### fn withQueryType
5454

5555
```jsonnet
@@ -60,7 +60,8 @@ PARAMETERS:
6060

6161
* **value** (`string`)
6262

63-
63+
QueryType is an optional identifier for the type of query.
64+
It can be used to distinguish different types of queries.
6465
### fn withRefId
6566

6667
```jsonnet
@@ -71,7 +72,7 @@ PARAMETERS:
7172

7273
* **value** (`string`)
7374

74-
75+
RefID is the unique identifier of the query, set by the frontend call.
7576
### fn withRelativeTimeRange
7677

7778
```jsonnet

docs/API/librarypanel/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ grafonnet.librarypanel
44

55
## Subpackages
66

7+
* [model.fieldConfig.defaults.links](model/fieldConfig/defaults/links.md)
78
* [model.fieldConfig.defaults.thresholds.steps](model/fieldConfig/defaults/thresholds/steps.md)
89
* [model.fieldConfig.overrides](model/fieldConfig/overrides/index.md)
910
* [model.links](model/links.md)
@@ -208,8 +209,7 @@ PARAMETERS:
208209

209210
* **value** (`object`)
210211

211-
TODO: should be the same panel schema defined in dashboard
212-
Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
212+
Dashboard panels are the basic visualization building blocks.
213213
### fn withModelMixin
214214

215215
```jsonnet
@@ -220,8 +220,7 @@ PARAMETERS:
220220

221221
* **value** (`object`)
222222

223-
TODO: should be the same panel schema defined in dashboard
224-
Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
223+
Dashboard panels are the basic visualization building blocks.
225224
### fn withName
226225

227226
```jsonnet
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# links
2+
3+
4+
5+
## Index
6+
7+
* [`fn withAsDropdown(value=true)`](#fn-withasdropdown)
8+
* [`fn withIcon(value)`](#fn-withicon)
9+
* [`fn withIncludeVars(value=true)`](#fn-withincludevars)
10+
* [`fn withKeepTime(value=true)`](#fn-withkeeptime)
11+
* [`fn withTags(value)`](#fn-withtags)
12+
* [`fn withTagsMixin(value)`](#fn-withtagsmixin)
13+
* [`fn withTargetBlank(value=true)`](#fn-withtargetblank)
14+
* [`fn withTitle(value)`](#fn-withtitle)
15+
* [`fn withTooltip(value)`](#fn-withtooltip)
16+
* [`fn withType(value)`](#fn-withtype)
17+
* [`fn withUrl(value)`](#fn-withurl)
18+
19+
## Fields
20+
21+
### fn withAsDropdown
22+
23+
```jsonnet
24+
withAsDropdown(value=true)
25+
```
26+
27+
PARAMETERS:
28+
29+
* **value** (`boolean`)
30+
- default value: `true`
31+
32+
If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards
33+
### fn withIcon
34+
35+
```jsonnet
36+
withIcon(value)
37+
```
38+
39+
PARAMETERS:
40+
41+
* **value** (`string`)
42+
43+
Icon name to be displayed with the link
44+
### fn withIncludeVars
45+
46+
```jsonnet
47+
withIncludeVars(value=true)
48+
```
49+
50+
PARAMETERS:
51+
52+
* **value** (`boolean`)
53+
- default value: `true`
54+
55+
If true, includes current template variables values in the link as query params
56+
### fn withKeepTime
57+
58+
```jsonnet
59+
withKeepTime(value=true)
60+
```
61+
62+
PARAMETERS:
63+
64+
* **value** (`boolean`)
65+
- default value: `true`
66+
67+
If true, includes current time range in the link as query params
68+
### fn withTags
69+
70+
```jsonnet
71+
withTags(value)
72+
```
73+
74+
PARAMETERS:
75+
76+
* **value** (`array`)
77+
78+
List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards
79+
### fn withTagsMixin
80+
81+
```jsonnet
82+
withTagsMixin(value)
83+
```
84+
85+
PARAMETERS:
86+
87+
* **value** (`array`)
88+
89+
List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards
90+
### fn withTargetBlank
91+
92+
```jsonnet
93+
withTargetBlank(value=true)
94+
```
95+
96+
PARAMETERS:
97+
98+
* **value** (`boolean`)
99+
- default value: `true`
100+
101+
If true, the link will be opened in a new tab
102+
### fn withTitle
103+
104+
```jsonnet
105+
withTitle(value)
106+
```
107+
108+
PARAMETERS:
109+
110+
* **value** (`string`)
111+
112+
Title to display with the link
113+
### fn withTooltip
114+
115+
```jsonnet
116+
withTooltip(value)
117+
```
118+
119+
PARAMETERS:
120+
121+
* **value** (`string`)
122+
123+
Tooltip to display when the user hovers their mouse over it
124+
### fn withType
125+
126+
```jsonnet
127+
withType(value)
128+
```
129+
130+
PARAMETERS:
131+
132+
* **value** (`string`)
133+
- valid values: `"link"`, `"dashboards"`
134+
135+
Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)
136+
### fn withUrl
137+
138+
```jsonnet
139+
withUrl(value)
140+
```
141+
142+
PARAMETERS:
143+
144+
* **value** (`string`)
145+
146+
Link URL. Only required/valid if the type is link

0 commit comments

Comments
 (0)