@grafana/openapi 13.2.4 → 13.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/openapi3.json +358 -247
- package/dist/apis/collections.grafana.app-v1alpha1.json +3 -14
- package/dist/apis/correlations.grafana.app-v0alpha1.json +411 -0
- package/dist/apis/dashboard.grafana.app-v0alpha1.json +865 -105
- package/dist/apis/dashboard.grafana.app-v1beta1.json +733 -6
- package/dist/apis/dashboard.grafana.app-v2.json +821 -194
- package/dist/apis/dashboard.grafana.app-v2alpha1.json +803 -208
- package/dist/apis/dashboard.grafana.app-v2beta1.json +985 -374
- package/dist/apis/folder.grafana.app-v1.json +644 -20
- package/dist/apis/folder.grafana.app-v1beta1.json +644 -20
- package/dist/apis/grafana-testdata-datasource.datasource.grafana.app-v0alpha1.json +3 -21
- package/dist/apis/historian.alerting.grafana.app-v0alpha1.json +411 -0
- package/dist/apis/iam.grafana.app-v0alpha1.json +2397 -748
- package/dist/apis/logsdrilldown.grafana.app-v1beta1.json +448 -0
- package/dist/apis/notifications.alerting.grafana.app-v0alpha1.json +596 -0
- package/dist/apis/notifications.alerting.grafana.app-v1beta1.json +596 -0
- package/dist/apis/playlist.grafana.app-v0alpha1.json +415 -0
- package/dist/apis/playlist.grafana.app-v1.json +415 -0
- package/dist/apis/preferences.grafana.app-v1.json +3 -9
- package/dist/apis/preferences.grafana.app-v1alpha1.json +3 -9
- package/dist/apis/provisioning.grafana.app-v0alpha1.json +636 -151
- package/dist/apis/provisioning.grafana.app-v1beta1.json +621 -100
- package/dist/apis/query.grafana.app-v0alpha1.json +14 -11
- package/dist/apis/quotas.grafana.app-v0alpha1.json +1 -2
- package/dist/apis/rules.alerting.grafana.app-v0alpha1.json +3027 -767
- package/dist/apis/rules.alerting.grafana.app-v1beta1.json +4541 -0
- package/dist/apis/search.grafana.app-v0alpha1.json +693 -0
- package/dist/apis/shorturl.grafana.app-v1beta1.json +411 -0
- package/package.json +3 -3
|
@@ -242,6 +242,117 @@
|
|
|
242
242
|
}
|
|
243
243
|
]
|
|
244
244
|
},
|
|
245
|
+
"/dashboards/search": {
|
|
246
|
+
"post": {
|
|
247
|
+
"tags": ["Search"],
|
|
248
|
+
"description": "Search Dashboard resources in a namespace.",
|
|
249
|
+
"operationId": "listDashboardSearchV2alpha1",
|
|
250
|
+
"parameters": [],
|
|
251
|
+
"requestBody": {
|
|
252
|
+
"description": "A SearchQuery describing what to match, sort and return.",
|
|
253
|
+
"content": {
|
|
254
|
+
"application/json": {
|
|
255
|
+
"schema": {
|
|
256
|
+
"$ref": "#/components/schemas/SearchQuery"
|
|
257
|
+
},
|
|
258
|
+
"example": {
|
|
259
|
+
"kind": "SearchQuery",
|
|
260
|
+
"apiVersion": "search.grafana.app/v0alpha1",
|
|
261
|
+
"facetLimit": 0,
|
|
262
|
+
"limit": 10
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
},
|
|
266
|
+
"required": true
|
|
267
|
+
},
|
|
268
|
+
"responses": {
|
|
269
|
+
"200": {
|
|
270
|
+
"description": "A SearchResults envelope.",
|
|
271
|
+
"content": {
|
|
272
|
+
"application/json": {
|
|
273
|
+
"schema": {
|
|
274
|
+
"$ref": "#/components/schemas/SearchResults"
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
},
|
|
282
|
+
"/dashboards/search/hybrid": {
|
|
283
|
+
"post": {
|
|
284
|
+
"tags": ["Search"],
|
|
285
|
+
"description": "Hybrid lexical and semantic search for Dashboard resources in a namespace. Returns top-k results with opaque scores meaningful only for ordering within this response. No pagination, totals, sorting or facets.",
|
|
286
|
+
"operationId": "listDashboardHybridSearchV2alpha1",
|
|
287
|
+
"parameters": [],
|
|
288
|
+
"requestBody": {
|
|
289
|
+
"description": "A HybridSearchQuery describing what to match and return.",
|
|
290
|
+
"content": {
|
|
291
|
+
"application/json": {
|
|
292
|
+
"schema": {
|
|
293
|
+
"$ref": "#/components/schemas/HybridSearchQuery"
|
|
294
|
+
},
|
|
295
|
+
"example": {
|
|
296
|
+
"kind": "HybridSearchQuery",
|
|
297
|
+
"apiVersion": "search.grafana.app/v0alpha1",
|
|
298
|
+
"query": "production",
|
|
299
|
+
"limit": 10,
|
|
300
|
+
"skipRerank": false
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
},
|
|
304
|
+
"required": true
|
|
305
|
+
},
|
|
306
|
+
"responses": {
|
|
307
|
+
"200": {
|
|
308
|
+
"description": "A HybridSearchResults envelope.",
|
|
309
|
+
"content": {
|
|
310
|
+
"application/json": {
|
|
311
|
+
"schema": {
|
|
312
|
+
"$ref": "#/components/schemas/HybridSearchResults"
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
},
|
|
320
|
+
"/dashboards/trash": {
|
|
321
|
+
"post": {
|
|
322
|
+
"tags": ["Search"],
|
|
323
|
+
"description": "List deleted Dashboard resources in a namespace.",
|
|
324
|
+
"operationId": "listDashboardTrashV2alpha1",
|
|
325
|
+
"parameters": [],
|
|
326
|
+
"requestBody": {
|
|
327
|
+
"description": "A TrashQuery describing what to match, sort and return.",
|
|
328
|
+
"content": {
|
|
329
|
+
"application/json": {
|
|
330
|
+
"schema": {
|
|
331
|
+
"$ref": "#/components/schemas/TrashQuery"
|
|
332
|
+
},
|
|
333
|
+
"example": {
|
|
334
|
+
"kind": "TrashQuery",
|
|
335
|
+
"apiVersion": "search.grafana.app/v0alpha1",
|
|
336
|
+
"limit": 10
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
},
|
|
340
|
+
"required": true
|
|
341
|
+
},
|
|
342
|
+
"responses": {
|
|
343
|
+
"200": {
|
|
344
|
+
"description": "A TrashResults envelope.",
|
|
345
|
+
"content": {
|
|
346
|
+
"application/json": {
|
|
347
|
+
"schema": {
|
|
348
|
+
"$ref": "#/components/schemas/TrashResults"
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
},
|
|
245
356
|
"/dashboards/{name}": {
|
|
246
357
|
"get": {
|
|
247
358
|
"tags": ["Dashboard"],
|
|
@@ -765,12 +876,7 @@
|
|
|
765
876
|
"variables": {
|
|
766
877
|
"type": "array",
|
|
767
878
|
"items": {
|
|
768
|
-
"
|
|
769
|
-
"allOf": [
|
|
770
|
-
{
|
|
771
|
-
"$ref": "#/components/schemas/DashboardActionVariable"
|
|
772
|
-
}
|
|
773
|
-
]
|
|
879
|
+
"$ref": "#/components/schemas/DashboardActionVariable"
|
|
774
880
|
}
|
|
775
881
|
}
|
|
776
882
|
}
|
|
@@ -826,15 +932,13 @@
|
|
|
826
932
|
"valueLabels": {
|
|
827
933
|
"type": "array",
|
|
828
934
|
"items": {
|
|
829
|
-
"type": "string"
|
|
830
|
-
"default": ""
|
|
935
|
+
"type": "string"
|
|
831
936
|
}
|
|
832
937
|
},
|
|
833
938
|
"values": {
|
|
834
939
|
"type": "array",
|
|
835
940
|
"items": {
|
|
836
|
-
"type": "string"
|
|
837
|
-
"default": ""
|
|
941
|
+
"type": "string"
|
|
838
942
|
}
|
|
839
943
|
}
|
|
840
944
|
}
|
|
@@ -870,12 +974,7 @@
|
|
|
870
974
|
"baseFilters": {
|
|
871
975
|
"type": "array",
|
|
872
976
|
"items": {
|
|
873
|
-
"
|
|
874
|
-
"allOf": [
|
|
875
|
-
{
|
|
876
|
-
"$ref": "#/components/schemas/DashboardAdHocFilterWithLabels"
|
|
877
|
-
}
|
|
878
|
-
]
|
|
977
|
+
"$ref": "#/components/schemas/DashboardAdHocFilterWithLabels"
|
|
879
978
|
}
|
|
880
979
|
},
|
|
881
980
|
"datasource": {
|
|
@@ -884,12 +983,7 @@
|
|
|
884
983
|
"defaultKeys": {
|
|
885
984
|
"type": "array",
|
|
886
985
|
"items": {
|
|
887
|
-
"
|
|
888
|
-
"allOf": [
|
|
889
|
-
{
|
|
890
|
-
"$ref": "#/components/schemas/DashboardMetricFindValue"
|
|
891
|
-
}
|
|
892
|
-
]
|
|
986
|
+
"$ref": "#/components/schemas/DashboardMetricFindValue"
|
|
893
987
|
}
|
|
894
988
|
},
|
|
895
989
|
"description": {
|
|
@@ -902,12 +996,7 @@
|
|
|
902
996
|
"filters": {
|
|
903
997
|
"type": "array",
|
|
904
998
|
"items": {
|
|
905
|
-
"
|
|
906
|
-
"allOf": [
|
|
907
|
-
{
|
|
908
|
-
"$ref": "#/components/schemas/DashboardAdHocFilterWithLabels"
|
|
909
|
-
}
|
|
910
|
-
]
|
|
999
|
+
"$ref": "#/components/schemas/DashboardAdHocFilterWithLabels"
|
|
911
1000
|
}
|
|
912
1001
|
},
|
|
913
1002
|
"hide": {
|
|
@@ -958,8 +1047,7 @@
|
|
|
958
1047
|
"type": "array",
|
|
959
1048
|
"items": {
|
|
960
1049
|
"type": "number",
|
|
961
|
-
"format": "double"
|
|
962
|
-
"default": 0
|
|
1050
|
+
"format": "double"
|
|
963
1051
|
}
|
|
964
1052
|
}
|
|
965
1053
|
}
|
|
@@ -1018,12 +1106,7 @@
|
|
|
1018
1106
|
"description": "Mappings define how to convert data frame fields to annotation event fields.",
|
|
1019
1107
|
"type": "object",
|
|
1020
1108
|
"additionalProperties": {
|
|
1021
|
-
"
|
|
1022
|
-
"allOf": [
|
|
1023
|
-
{
|
|
1024
|
-
"$ref": "#/components/schemas/DashboardAnnotationEventFieldMapping"
|
|
1025
|
-
}
|
|
1026
|
-
]
|
|
1109
|
+
"$ref": "#/components/schemas/DashboardAnnotationEventFieldMapping"
|
|
1027
1110
|
}
|
|
1028
1111
|
},
|
|
1029
1112
|
"name": {
|
|
@@ -1109,12 +1192,7 @@
|
|
|
1109
1192
|
"items": {
|
|
1110
1193
|
"type": "array",
|
|
1111
1194
|
"items": {
|
|
1112
|
-
"
|
|
1113
|
-
"allOf": [
|
|
1114
|
-
{
|
|
1115
|
-
"$ref": "#/components/schemas/DashboardAutoGridLayoutItemKind"
|
|
1116
|
-
}
|
|
1117
|
-
]
|
|
1195
|
+
"$ref": "#/components/schemas/DashboardAutoGridLayoutItemKind"
|
|
1118
1196
|
}
|
|
1119
1197
|
},
|
|
1120
1198
|
"maxColumnCount": {
|
|
@@ -1443,12 +1521,7 @@
|
|
|
1443
1521
|
"options": {
|
|
1444
1522
|
"type": "array",
|
|
1445
1523
|
"items": {
|
|
1446
|
-
"
|
|
1447
|
-
"allOf": [
|
|
1448
|
-
{
|
|
1449
|
-
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
1450
|
-
}
|
|
1451
|
-
]
|
|
1524
|
+
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
1452
1525
|
}
|
|
1453
1526
|
},
|
|
1454
1527
|
"query": {
|
|
@@ -1507,8 +1580,7 @@
|
|
|
1507
1580
|
"description": "List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards",
|
|
1508
1581
|
"type": "array",
|
|
1509
1582
|
"items": {
|
|
1510
|
-
"type": "string"
|
|
1511
|
-
"default": ""
|
|
1583
|
+
"type": "string"
|
|
1512
1584
|
}
|
|
1513
1585
|
},
|
|
1514
1586
|
"targetBlank": {
|
|
@@ -1610,6 +1682,10 @@
|
|
|
1610
1682
|
"description": "Options to be passed to the transformer Valid options depend on the transformer id",
|
|
1611
1683
|
"type": "object"
|
|
1612
1684
|
},
|
|
1685
|
+
"refId": {
|
|
1686
|
+
"description": "Unique identifier of the instance of the transformer",
|
|
1687
|
+
"type": "string"
|
|
1688
|
+
},
|
|
1613
1689
|
"topic": {
|
|
1614
1690
|
"description": "Where to pull DataFrames from as input to transformation",
|
|
1615
1691
|
"type": "string"
|
|
@@ -1692,12 +1768,7 @@
|
|
|
1692
1768
|
"options": {
|
|
1693
1769
|
"type": "array",
|
|
1694
1770
|
"items": {
|
|
1695
|
-
"
|
|
1696
|
-
"allOf": [
|
|
1697
|
-
{
|
|
1698
|
-
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
1699
|
-
}
|
|
1700
|
-
]
|
|
1771
|
+
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
1701
1772
|
}
|
|
1702
1773
|
},
|
|
1703
1774
|
"pluginId": {
|
|
@@ -1757,8 +1828,7 @@
|
|
|
1757
1828
|
"items": {
|
|
1758
1829
|
"type": "array",
|
|
1759
1830
|
"items": {
|
|
1760
|
-
"type": "string"
|
|
1761
|
-
"default": ""
|
|
1831
|
+
"type": "string"
|
|
1762
1832
|
}
|
|
1763
1833
|
}
|
|
1764
1834
|
},
|
|
@@ -1772,8 +1842,7 @@
|
|
|
1772
1842
|
"items": {
|
|
1773
1843
|
"type": "array",
|
|
1774
1844
|
"items": {
|
|
1775
|
-
"type": "string"
|
|
1776
|
-
"default": ""
|
|
1845
|
+
"type": "string"
|
|
1777
1846
|
}
|
|
1778
1847
|
}
|
|
1779
1848
|
},
|
|
@@ -1815,12 +1884,7 @@
|
|
|
1815
1884
|
"description": "Define interactive HTTP requests that can be triggered from data visualizations.",
|
|
1816
1885
|
"type": "array",
|
|
1817
1886
|
"items": {
|
|
1818
|
-
"
|
|
1819
|
-
"allOf": [
|
|
1820
|
-
{
|
|
1821
|
-
"$ref": "#/components/schemas/DashboardAction"
|
|
1822
|
-
}
|
|
1823
|
-
]
|
|
1887
|
+
"$ref": "#/components/schemas/DashboardAction"
|
|
1824
1888
|
}
|
|
1825
1889
|
},
|
|
1826
1890
|
"color": {
|
|
@@ -1935,12 +1999,7 @@
|
|
|
1935
1999
|
"description": "Overrides are the options applied to specific fields overriding the defaults.",
|
|
1936
2000
|
"type": "array",
|
|
1937
2001
|
"items": {
|
|
1938
|
-
"
|
|
1939
|
-
"allOf": [
|
|
1940
|
-
{
|
|
1941
|
-
"$ref": "#/components/schemas/DashboardV2alpha1FieldConfigSourceOverrides"
|
|
1942
|
-
}
|
|
1943
|
-
]
|
|
2002
|
+
"$ref": "#/components/schemas/DashboardV2alpha1FieldConfigSourceOverrides"
|
|
1944
2003
|
}
|
|
1945
2004
|
}
|
|
1946
2005
|
}
|
|
@@ -2060,12 +2119,7 @@
|
|
|
2060
2119
|
"items": {
|
|
2061
2120
|
"type": "array",
|
|
2062
2121
|
"items": {
|
|
2063
|
-
"
|
|
2064
|
-
"allOf": [
|
|
2065
|
-
{
|
|
2066
|
-
"$ref": "#/components/schemas/DashboardGridLayoutItemKind"
|
|
2067
|
-
}
|
|
2068
|
-
]
|
|
2122
|
+
"$ref": "#/components/schemas/DashboardGridLayoutItemKind"
|
|
2069
2123
|
}
|
|
2070
2124
|
}
|
|
2071
2125
|
}
|
|
@@ -2129,12 +2183,7 @@
|
|
|
2129
2183
|
"options": {
|
|
2130
2184
|
"type": "array",
|
|
2131
2185
|
"items": {
|
|
2132
|
-
"
|
|
2133
|
-
"allOf": [
|
|
2134
|
-
{
|
|
2135
|
-
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
2136
|
-
}
|
|
2137
|
-
]
|
|
2186
|
+
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
2138
2187
|
}
|
|
2139
2188
|
},
|
|
2140
2189
|
"skipUrlSync": {
|
|
@@ -2159,8 +2208,7 @@
|
|
|
2159
2208
|
"items": {
|
|
2160
2209
|
"type": "array",
|
|
2161
2210
|
"items": {
|
|
2162
|
-
"type": "string"
|
|
2163
|
-
"default": ""
|
|
2211
|
+
"type": "string"
|
|
2164
2212
|
}
|
|
2165
2213
|
}
|
|
2166
2214
|
},
|
|
@@ -2174,8 +2222,7 @@
|
|
|
2174
2222
|
"items": {
|
|
2175
2223
|
"type": "array",
|
|
2176
2224
|
"items": {
|
|
2177
|
-
"type": "string"
|
|
2178
|
-
"default": ""
|
|
2225
|
+
"type": "string"
|
|
2179
2226
|
}
|
|
2180
2227
|
}
|
|
2181
2228
|
},
|
|
@@ -2258,12 +2305,7 @@
|
|
|
2258
2305
|
"options": {
|
|
2259
2306
|
"type": "array",
|
|
2260
2307
|
"items": {
|
|
2261
|
-
"
|
|
2262
|
-
"allOf": [
|
|
2263
|
-
{
|
|
2264
|
-
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
2265
|
-
}
|
|
2266
|
-
]
|
|
2308
|
+
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
2267
2309
|
}
|
|
2268
2310
|
},
|
|
2269
2311
|
"query": {
|
|
@@ -2351,12 +2393,7 @@
|
|
|
2351
2393
|
"items": {
|
|
2352
2394
|
"type": "array",
|
|
2353
2395
|
"items": {
|
|
2354
|
-
"
|
|
2355
|
-
"allOf": [
|
|
2356
|
-
{
|
|
2357
|
-
"$ref": "#/components/schemas/Dashboard"
|
|
2358
|
-
}
|
|
2359
|
-
]
|
|
2396
|
+
"$ref": "#/components/schemas/Dashboard"
|
|
2360
2397
|
}
|
|
2361
2398
|
},
|
|
2362
2399
|
"kind": {
|
|
@@ -2439,6 +2476,7 @@
|
|
|
2439
2476
|
}
|
|
2440
2477
|
},
|
|
2441
2478
|
"DashboardPanelKindOrLibraryPanelKind": {
|
|
2479
|
+
"description": "Supported dashboard elements |* more element types in the future",
|
|
2442
2480
|
"type": "object",
|
|
2443
2481
|
"properties": {
|
|
2444
2482
|
"LibraryPanelKind": {
|
|
@@ -2516,12 +2554,7 @@
|
|
|
2516
2554
|
"links": {
|
|
2517
2555
|
"type": "array",
|
|
2518
2556
|
"items": {
|
|
2519
|
-
"
|
|
2520
|
-
"allOf": [
|
|
2521
|
-
{
|
|
2522
|
-
"$ref": "#/components/schemas/DashboardDataLink"
|
|
2523
|
-
}
|
|
2524
|
-
]
|
|
2557
|
+
"$ref": "#/components/schemas/DashboardDataLink"
|
|
2525
2558
|
}
|
|
2526
2559
|
},
|
|
2527
2560
|
"subtitle": {
|
|
@@ -2570,12 +2603,7 @@
|
|
|
2570
2603
|
"queries": {
|
|
2571
2604
|
"type": "array",
|
|
2572
2605
|
"items": {
|
|
2573
|
-
"
|
|
2574
|
-
"allOf": [
|
|
2575
|
-
{
|
|
2576
|
-
"$ref": "#/components/schemas/DashboardPanelQueryKind"
|
|
2577
|
-
}
|
|
2578
|
-
]
|
|
2606
|
+
"$ref": "#/components/schemas/DashboardPanelQueryKind"
|
|
2579
2607
|
}
|
|
2580
2608
|
},
|
|
2581
2609
|
"queryOptions": {
|
|
@@ -2589,12 +2617,7 @@
|
|
|
2589
2617
|
"transformations": {
|
|
2590
2618
|
"type": "array",
|
|
2591
2619
|
"items": {
|
|
2592
|
-
"
|
|
2593
|
-
"allOf": [
|
|
2594
|
-
{
|
|
2595
|
-
"$ref": "#/components/schemas/DashboardTransformationKind"
|
|
2596
|
-
}
|
|
2597
|
-
]
|
|
2620
|
+
"$ref": "#/components/schemas/DashboardTransformationKind"
|
|
2598
2621
|
}
|
|
2599
2622
|
}
|
|
2600
2623
|
}
|
|
@@ -2745,12 +2768,7 @@
|
|
|
2745
2768
|
"options": {
|
|
2746
2769
|
"type": "array",
|
|
2747
2770
|
"items": {
|
|
2748
|
-
"
|
|
2749
|
-
"allOf": [
|
|
2750
|
-
{
|
|
2751
|
-
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
2752
|
-
}
|
|
2753
|
-
]
|
|
2771
|
+
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
2754
2772
|
}
|
|
2755
2773
|
},
|
|
2756
2774
|
"placeholder": {
|
|
@@ -2786,12 +2804,7 @@
|
|
|
2786
2804
|
"staticOptions": {
|
|
2787
2805
|
"type": "array",
|
|
2788
2806
|
"items": {
|
|
2789
|
-
"
|
|
2790
|
-
"allOf": [
|
|
2791
|
-
{
|
|
2792
|
-
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
2793
|
-
}
|
|
2794
|
-
]
|
|
2807
|
+
"$ref": "#/components/schemas/DashboardVariableOption"
|
|
2795
2808
|
}
|
|
2796
2809
|
},
|
|
2797
2810
|
"staticOptionsOrder": {
|
|
@@ -2944,12 +2957,7 @@
|
|
|
2944
2957
|
"rows": {
|
|
2945
2958
|
"type": "array",
|
|
2946
2959
|
"items": {
|
|
2947
|
-
"
|
|
2948
|
-
"allOf": [
|
|
2949
|
-
{
|
|
2950
|
-
"$ref": "#/components/schemas/DashboardRowsLayoutRowKind"
|
|
2951
|
-
}
|
|
2952
|
-
]
|
|
2960
|
+
"$ref": "#/components/schemas/DashboardRowsLayoutRowKind"
|
|
2953
2961
|
}
|
|
2954
2962
|
}
|
|
2955
2963
|
}
|
|
@@ -2972,12 +2980,7 @@
|
|
|
2972
2980
|
"annotations": {
|
|
2973
2981
|
"type": "array",
|
|
2974
2982
|
"items": {
|
|
2975
|
-
"
|
|
2976
|
-
"allOf": [
|
|
2977
|
-
{
|
|
2978
|
-
"$ref": "#/components/schemas/DashboardAnnotationQueryKind"
|
|
2979
|
-
}
|
|
2980
|
-
]
|
|
2983
|
+
"$ref": "#/components/schemas/DashboardAnnotationQueryKind"
|
|
2981
2984
|
}
|
|
2982
2985
|
},
|
|
2983
2986
|
"cursorSync": {
|
|
@@ -3006,12 +3009,7 @@
|
|
|
3006
3009
|
"description": "Links with references to other dashboards or external websites.",
|
|
3007
3010
|
"type": "array",
|
|
3008
3011
|
"items": {
|
|
3009
|
-
"
|
|
3010
|
-
"allOf": [
|
|
3011
|
-
{
|
|
3012
|
-
"$ref": "#/components/schemas/DashboardDashboardLink"
|
|
3013
|
-
}
|
|
3014
|
-
]
|
|
3012
|
+
"$ref": "#/components/schemas/DashboardDashboardLink"
|
|
3015
3013
|
}
|
|
3016
3014
|
},
|
|
3017
3015
|
"liveNow": {
|
|
@@ -3032,8 +3030,7 @@
|
|
|
3032
3030
|
"description": "Tags associated with dashboard.",
|
|
3033
3031
|
"type": "array",
|
|
3034
3032
|
"items": {
|
|
3035
|
-
"type": "string"
|
|
3036
|
-
"default": ""
|
|
3033
|
+
"type": "string"
|
|
3037
3034
|
}
|
|
3038
3035
|
},
|
|
3039
3036
|
"timeSettings": {
|
|
@@ -3096,8 +3093,7 @@
|
|
|
3096
3093
|
"ArrayOfString": {
|
|
3097
3094
|
"type": "array",
|
|
3098
3095
|
"items": {
|
|
3099
|
-
"type": "string"
|
|
3100
|
-
"default": ""
|
|
3096
|
+
"type": "string"
|
|
3101
3097
|
}
|
|
3102
3098
|
},
|
|
3103
3099
|
"String": {
|
|
@@ -3211,12 +3207,7 @@
|
|
|
3211
3207
|
"tabs": {
|
|
3212
3208
|
"type": "array",
|
|
3213
3209
|
"items": {
|
|
3214
|
-
"
|
|
3215
|
-
"allOf": [
|
|
3216
|
-
{
|
|
3217
|
-
"$ref": "#/components/schemas/DashboardTabsLayoutTabKind"
|
|
3218
|
-
}
|
|
3219
|
-
]
|
|
3210
|
+
"$ref": "#/components/schemas/DashboardTabsLayoutTabKind"
|
|
3220
3211
|
}
|
|
3221
3212
|
}
|
|
3222
3213
|
}
|
|
@@ -3343,12 +3334,7 @@
|
|
|
3343
3334
|
"steps": {
|
|
3344
3335
|
"type": "array",
|
|
3345
3336
|
"items": {
|
|
3346
|
-
"
|
|
3347
|
-
"allOf": [
|
|
3348
|
-
{
|
|
3349
|
-
"$ref": "#/components/schemas/DashboardThreshold"
|
|
3350
|
-
}
|
|
3351
|
-
]
|
|
3337
|
+
"$ref": "#/components/schemas/DashboardThreshold"
|
|
3352
3338
|
}
|
|
3353
3339
|
}
|
|
3354
3340
|
}
|
|
@@ -3385,8 +3371,7 @@
|
|
|
3385
3371
|
"description": "Interval options available in the refresh picker dropdown. v1: timepicker.refresh_intervals",
|
|
3386
3372
|
"type": "array",
|
|
3387
3373
|
"items": {
|
|
3388
|
-
"type": "string"
|
|
3389
|
-
"default": ""
|
|
3374
|
+
"type": "string"
|
|
3390
3375
|
}
|
|
3391
3376
|
},
|
|
3392
3377
|
"fiscalYearStartMonth": {
|
|
@@ -3413,12 +3398,7 @@
|
|
|
3413
3398
|
"description": "Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. v1: timepicker.quick_ranges , not exposed in the UI",
|
|
3414
3399
|
"type": "array",
|
|
3415
3400
|
"items": {
|
|
3416
|
-
"
|
|
3417
|
-
"allOf": [
|
|
3418
|
-
{
|
|
3419
|
-
"$ref": "#/components/schemas/DashboardTimeRangeOption"
|
|
3420
|
-
}
|
|
3421
|
-
]
|
|
3401
|
+
"$ref": "#/components/schemas/DashboardTimeRangeOption"
|
|
3422
3402
|
}
|
|
3423
3403
|
},
|
|
3424
3404
|
"timezone": {
|
|
@@ -3482,12 +3462,7 @@
|
|
|
3482
3462
|
"properties": {
|
|
3483
3463
|
"type": "array",
|
|
3484
3464
|
"items": {
|
|
3485
|
-
"
|
|
3486
|
-
"allOf": [
|
|
3487
|
-
{
|
|
3488
|
-
"$ref": "#/components/schemas/DashboardDynamicConfigValue"
|
|
3489
|
-
}
|
|
3490
|
-
]
|
|
3465
|
+
"$ref": "#/components/schemas/DashboardDynamicConfigValue"
|
|
3491
3466
|
}
|
|
3492
3467
|
}
|
|
3493
3468
|
}
|
|
@@ -3566,12 +3541,7 @@
|
|
|
3566
3541
|
"description": "Map with <value_to_match>: ValueMappingResult. For example: { \"10\": { text: \"Perfection!\", color: \"green\" } }",
|
|
3567
3542
|
"type": "object",
|
|
3568
3543
|
"additionalProperties": {
|
|
3569
|
-
"
|
|
3570
|
-
"allOf": [
|
|
3571
|
-
{
|
|
3572
|
-
"$ref": "#/components/schemas/DashboardValueMappingResult"
|
|
3573
|
-
}
|
|
3574
|
-
]
|
|
3544
|
+
"$ref": "#/components/schemas/DashboardValueMappingResult"
|
|
3575
3545
|
}
|
|
3576
3546
|
},
|
|
3577
3547
|
"type": {
|
|
@@ -3629,8 +3599,7 @@
|
|
|
3629
3599
|
"description": "Additional properties for multi-props variables",
|
|
3630
3600
|
"type": "object",
|
|
3631
3601
|
"additionalProperties": {
|
|
3632
|
-
"type": "string"
|
|
3633
|
-
"default": ""
|
|
3602
|
+
"type": "string"
|
|
3634
3603
|
}
|
|
3635
3604
|
},
|
|
3636
3605
|
"selected": {
|
|
@@ -3754,35 +3723,614 @@
|
|
|
3754
3723
|
}
|
|
3755
3724
|
]
|
|
3756
3725
|
},
|
|
3757
|
-
"
|
|
3758
|
-
"description": "APIResource specifies the name of a resource and whether it is namespaced.",
|
|
3726
|
+
"Unstructured": {
|
|
3759
3727
|
"type": "object",
|
|
3760
|
-
"
|
|
3728
|
+
"additionalProperties": true,
|
|
3729
|
+
"x-kubernetes-preserve-unknown-fields": true
|
|
3730
|
+
},
|
|
3731
|
+
"ExistsPredicate": {
|
|
3732
|
+
"description": "ExistsPredicate is a future field-existence predicate. Modelled for schema stability; always rejected in v1.",
|
|
3733
|
+
"type": "object",
|
|
3734
|
+
"required": ["field"],
|
|
3761
3735
|
"properties": {
|
|
3762
|
-
"
|
|
3763
|
-
"description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
|
|
3764
|
-
"type": "array",
|
|
3765
|
-
"items": {
|
|
3766
|
-
"type": "string",
|
|
3767
|
-
"default": ""
|
|
3768
|
-
},
|
|
3769
|
-
"x-kubernetes-list-type": "atomic"
|
|
3770
|
-
},
|
|
3771
|
-
"group": {
|
|
3772
|
-
"description": "group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\".",
|
|
3773
|
-
"type": "string"
|
|
3774
|
-
},
|
|
3775
|
-
"kind": {
|
|
3776
|
-
"description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
|
|
3736
|
+
"field": {
|
|
3777
3737
|
"type": "string",
|
|
3778
3738
|
"default": ""
|
|
3739
|
+
}
|
|
3740
|
+
}
|
|
3741
|
+
},
|
|
3742
|
+
"FacetTerm": {
|
|
3743
|
+
"description": "FacetTerm is a single facet term and its count.",
|
|
3744
|
+
"type": "object",
|
|
3745
|
+
"required": ["value", "count"],
|
|
3746
|
+
"properties": {
|
|
3747
|
+
"count": {
|
|
3748
|
+
"type": "integer",
|
|
3749
|
+
"format": "int64",
|
|
3750
|
+
"default": 0
|
|
3779
3751
|
},
|
|
3780
|
-
"
|
|
3781
|
-
"description": "name is the plural name of the resource.",
|
|
3752
|
+
"value": {
|
|
3782
3753
|
"type": "string",
|
|
3783
3754
|
"default": ""
|
|
3784
|
-
}
|
|
3785
|
-
|
|
3755
|
+
}
|
|
3756
|
+
}
|
|
3757
|
+
},
|
|
3758
|
+
"FilterPredicate": {
|
|
3759
|
+
"description": "FilterPredicate is an exact / set-based predicate against a single field. Values are strings whatever the field's declared type, so a boolean field takes \"true\" or \"false\" and a numeric field takes the number written out.\n\nNumbers are held as float64, so only integers up to 2^53 are compared exactly. Past that, values a whole number apart share one representation, and a filter can both match a neighbour and miss the value asked for.",
|
|
3760
|
+
"type": "object",
|
|
3761
|
+
"required": ["field", "operator", "values"],
|
|
3762
|
+
"properties": {
|
|
3763
|
+
"field": {
|
|
3764
|
+
"type": "string",
|
|
3765
|
+
"default": ""
|
|
3766
|
+
},
|
|
3767
|
+
"operator": {
|
|
3768
|
+
"description": "Operator is \"In\", \"NotIn\" or \"All\" in v1. \"In\" matches any of the values, \"NotIn\" excludes all of them, and \"All\" requires the field to hold every value, which only a field holding a list of values can do.",
|
|
3769
|
+
"type": "string",
|
|
3770
|
+
"default": ""
|
|
3771
|
+
},
|
|
3772
|
+
"values": {
|
|
3773
|
+
"type": "array",
|
|
3774
|
+
"items": {
|
|
3775
|
+
"type": "string"
|
|
3776
|
+
}
|
|
3777
|
+
}
|
|
3778
|
+
}
|
|
3779
|
+
},
|
|
3780
|
+
"HybridSearchChunk": {
|
|
3781
|
+
"description": "HybridSearchChunk is matching text from an embedded resource or subresource.",
|
|
3782
|
+
"type": "object",
|
|
3783
|
+
"required": ["subresource", "content"],
|
|
3784
|
+
"properties": {
|
|
3785
|
+
"content": {
|
|
3786
|
+
"type": "string",
|
|
3787
|
+
"default": ""
|
|
3788
|
+
},
|
|
3789
|
+
"subresource": {
|
|
3790
|
+
"description": "Subresource identifies a chunk, for example panel/5. Empty means the whole resource, or a synthesized chunk for a lexical-only hit.",
|
|
3791
|
+
"type": "string",
|
|
3792
|
+
"default": ""
|
|
3793
|
+
}
|
|
3794
|
+
}
|
|
3795
|
+
},
|
|
3796
|
+
"HybridSearchFilter": {
|
|
3797
|
+
"description": "HybridSearchFilter matches any of Values against Field (IN semantics). Unlike lexical search filters, no other operators are supported.",
|
|
3798
|
+
"type": "object",
|
|
3799
|
+
"required": ["field", "values"],
|
|
3800
|
+
"properties": {
|
|
3801
|
+
"field": {
|
|
3802
|
+
"description": "Field is uid or folder for all resources. A single dashboard resource type additionally supports datasource_uid and language (promql, logql, traceql or sql). Searches across multiple types support only uid and folder.",
|
|
3803
|
+
"type": "string",
|
|
3804
|
+
"default": ""
|
|
3805
|
+
},
|
|
3806
|
+
"values": {
|
|
3807
|
+
"description": "Values must contain at least one value. Values containing '*' are rejected. An empty folder value matches resources in the root folder.",
|
|
3808
|
+
"type": "array",
|
|
3809
|
+
"items": {
|
|
3810
|
+
"type": "string"
|
|
3811
|
+
},
|
|
3812
|
+
"x-kubernetes-list-type": "atomic"
|
|
3813
|
+
}
|
|
3814
|
+
}
|
|
3815
|
+
},
|
|
3816
|
+
"HybridSearchManagedBy": {
|
|
3817
|
+
"description": "HybridSearchManagedBy identifies the manager of a returned resource.",
|
|
3818
|
+
"type": "object",
|
|
3819
|
+
"required": ["kind", "id"],
|
|
3820
|
+
"properties": {
|
|
3821
|
+
"id": {
|
|
3822
|
+
"type": "string",
|
|
3823
|
+
"default": ""
|
|
3824
|
+
},
|
|
3825
|
+
"kind": {
|
|
3826
|
+
"type": "string",
|
|
3827
|
+
"default": ""
|
|
3828
|
+
}
|
|
3829
|
+
}
|
|
3830
|
+
},
|
|
3831
|
+
"HybridSearchQuery": {
|
|
3832
|
+
"description": "HybridSearchQuery is the request body for POST .../{resource}/search/hybrid and POST .../global/search/hybrid. It returns the top matching resources, with no pagination, sorting or facets.",
|
|
3833
|
+
"type": "object",
|
|
3834
|
+
"required": ["query"],
|
|
3835
|
+
"properties": {
|
|
3836
|
+
"apiVersion": {
|
|
3837
|
+
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
3838
|
+
"type": "string"
|
|
3839
|
+
},
|
|
3840
|
+
"filters": {
|
|
3841
|
+
"description": "Filters are ANDed together. Each field may appear once, with at most 1000 values across all filters. Embedding fields supply text only and do not make additional fields available for filtering.",
|
|
3842
|
+
"type": "array",
|
|
3843
|
+
"items": {
|
|
3844
|
+
"$ref": "#/components/schemas/HybridSearchFilter"
|
|
3845
|
+
},
|
|
3846
|
+
"x-kubernetes-list-type": "atomic"
|
|
3847
|
+
},
|
|
3848
|
+
"kind": {
|
|
3849
|
+
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
3850
|
+
"type": "string"
|
|
3851
|
+
},
|
|
3852
|
+
"limit": {
|
|
3853
|
+
"description": "Limit is the maximum number of results across all requested resource types. Zero uses the default of 50, values above 200 are clamped, and negative values are rejected.",
|
|
3854
|
+
"type": "integer",
|
|
3855
|
+
"format": "int64"
|
|
3856
|
+
},
|
|
3857
|
+
"minRelevance": {
|
|
3858
|
+
"description": "MinRelevance is lowest, low, medium, high or highest. Empty keeps every result. Filtering is best-effort: no results are dropped when reranking is unavailable or fails. It cannot be combined with SkipRerank.",
|
|
3859
|
+
"type": "string"
|
|
3860
|
+
},
|
|
3861
|
+
"query": {
|
|
3862
|
+
"description": "Query supplies the lexical query and, unless SemanticQuery is set, the text embedded for semantic search. Required, with a maximum of 1000 bytes.",
|
|
3863
|
+
"type": "string",
|
|
3864
|
+
"default": ""
|
|
3865
|
+
},
|
|
3866
|
+
"resources": {
|
|
3867
|
+
"description": "Resources is required for global hybrid search and rejected by per-resource routes. It must be nonempty and contain unique group/resource pairs.",
|
|
3868
|
+
"type": "array",
|
|
3869
|
+
"items": {
|
|
3870
|
+
"$ref": "#/components/schemas/HybridSearchResource"
|
|
3871
|
+
},
|
|
3872
|
+
"x-kubernetes-list-type": "atomic"
|
|
3873
|
+
},
|
|
3874
|
+
"semanticQuery": {
|
|
3875
|
+
"description": "SemanticQuery supplies optional richer phrasing for semantic search. When provided, it must not be whitespace and must fit within 1000 bytes.",
|
|
3876
|
+
"type": "string"
|
|
3877
|
+
},
|
|
3878
|
+
"skipRerank": {
|
|
3879
|
+
"description": "SkipRerank skips reranking even when a reranker is configured. Multiple resource types are interleaved in request order, preserving each type's ranking.",
|
|
3880
|
+
"type": "boolean"
|
|
3881
|
+
}
|
|
3882
|
+
}
|
|
3883
|
+
},
|
|
3884
|
+
"HybridSearchResource": {
|
|
3885
|
+
"description": "HybridSearchResource identifies a resource type for global hybrid search.",
|
|
3886
|
+
"type": "object",
|
|
3887
|
+
"required": ["group", "resource"],
|
|
3888
|
+
"properties": {
|
|
3889
|
+
"group": {
|
|
3890
|
+
"type": "string",
|
|
3891
|
+
"default": ""
|
|
3892
|
+
},
|
|
3893
|
+
"resource": {
|
|
3894
|
+
"type": "string",
|
|
3895
|
+
"default": ""
|
|
3896
|
+
}
|
|
3897
|
+
}
|
|
3898
|
+
},
|
|
3899
|
+
"HybridSearchResultItem": {
|
|
3900
|
+
"description": "HybridSearchResultItem is one matching resource, with its matching chunks.",
|
|
3901
|
+
"type": "object",
|
|
3902
|
+
"required": ["resource", "score", "title", "folder", "chunks"],
|
|
3903
|
+
"properties": {
|
|
3904
|
+
"chunks": {
|
|
3905
|
+
"description": "Chunks contains matching text, best first. A lexical-only hit has a synthesized chunk containing the resource's title.",
|
|
3906
|
+
"type": "array",
|
|
3907
|
+
"items": {
|
|
3908
|
+
"$ref": "#/components/schemas/HybridSearchChunk"
|
|
3909
|
+
},
|
|
3910
|
+
"x-kubernetes-list-type": "atomic"
|
|
3911
|
+
},
|
|
3912
|
+
"folder": {
|
|
3913
|
+
"description": "Folder is the containing folder's UID. Empty and \"general\" denote the root folder.",
|
|
3914
|
+
"type": "string",
|
|
3915
|
+
"default": ""
|
|
3916
|
+
},
|
|
3917
|
+
"folderTitle": {
|
|
3918
|
+
"description": "FolderTitle is best-effort display data and can be absent.",
|
|
3919
|
+
"type": "string"
|
|
3920
|
+
},
|
|
3921
|
+
"managedBy": {
|
|
3922
|
+
"description": "ManagedBy is absent for unmanaged resources or when lookup fails.",
|
|
3923
|
+
"$ref": "#/components/schemas/HybridSearchManagedBy"
|
|
3924
|
+
},
|
|
3925
|
+
"resource": {
|
|
3926
|
+
"default": {},
|
|
3927
|
+
"$ref": "#/components/schemas/ResourceRef"
|
|
3928
|
+
},
|
|
3929
|
+
"score": {
|
|
3930
|
+
"description": "Score is opaque: higher scores rank first, but scores are meaningful only for ordering within this response. Do not compare scores across queries or treat them as probabilities or distances.",
|
|
3931
|
+
"type": "number",
|
|
3932
|
+
"format": "double",
|
|
3933
|
+
"default": 0
|
|
3934
|
+
},
|
|
3935
|
+
"tags": {
|
|
3936
|
+
"description": "Tags from the lexical index. Omitted when unavailable.",
|
|
3937
|
+
"type": "array",
|
|
3938
|
+
"items": {
|
|
3939
|
+
"type": "string"
|
|
3940
|
+
},
|
|
3941
|
+
"x-kubernetes-list-type": "atomic"
|
|
3942
|
+
},
|
|
3943
|
+
"title": {
|
|
3944
|
+
"type": "string",
|
|
3945
|
+
"default": ""
|
|
3946
|
+
}
|
|
3947
|
+
}
|
|
3948
|
+
},
|
|
3949
|
+
"HybridSearchResults": {
|
|
3950
|
+
"description": "HybridSearchResults is the response body for per-resource and global hybrid search. Items are ordered by relevance. They are a bounded top-k result set, not an exhaustive list, so the response carries no total count or pagination token.",
|
|
3951
|
+
"type": "object",
|
|
3952
|
+
"required": ["items"],
|
|
3953
|
+
"properties": {
|
|
3954
|
+
"apiVersion": {
|
|
3955
|
+
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
3956
|
+
"type": "string"
|
|
3957
|
+
},
|
|
3958
|
+
"items": {
|
|
3959
|
+
"type": "array",
|
|
3960
|
+
"items": {
|
|
3961
|
+
"$ref": "#/components/schemas/HybridSearchResultItem"
|
|
3962
|
+
},
|
|
3963
|
+
"x-kubernetes-list-type": "atomic"
|
|
3964
|
+
},
|
|
3965
|
+
"kind": {
|
|
3966
|
+
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
3967
|
+
"type": "string"
|
|
3968
|
+
}
|
|
3969
|
+
}
|
|
3970
|
+
},
|
|
3971
|
+
"RangePredicate": {
|
|
3972
|
+
"description": "RangePredicate compares a numeric field against one or two bounds. At least one bound is required, gt cannot be combined with gte, and lt cannot be combined with lte. Boolean and string fields are rejected: only numbers have the order a range asks about. On an integer field a bound must be whole.\n\nBounds are held as float64, so only integers up to 2^53 are compared exactly. Past that, values a whole number apart share one representation, and a bound can both admit a neighbour and exclude the value asked for.",
|
|
3973
|
+
"type": "object",
|
|
3974
|
+
"required": ["field"],
|
|
3975
|
+
"properties": {
|
|
3976
|
+
"field": {
|
|
3977
|
+
"type": "string",
|
|
3978
|
+
"default": ""
|
|
3979
|
+
},
|
|
3980
|
+
"gt": {
|
|
3981
|
+
"type": "number",
|
|
3982
|
+
"format": "double"
|
|
3983
|
+
},
|
|
3984
|
+
"gte": {
|
|
3985
|
+
"type": "number",
|
|
3986
|
+
"format": "double"
|
|
3987
|
+
},
|
|
3988
|
+
"lt": {
|
|
3989
|
+
"type": "number",
|
|
3990
|
+
"format": "double"
|
|
3991
|
+
},
|
|
3992
|
+
"lte": {
|
|
3993
|
+
"type": "number",
|
|
3994
|
+
"format": "double"
|
|
3995
|
+
}
|
|
3996
|
+
}
|
|
3997
|
+
},
|
|
3998
|
+
"RegexPredicate": {
|
|
3999
|
+
"description": "RegexPredicate matches a single field against a regular expression, one pattern per leaf the way a single Prometheus matcher works. Negate turns the leaf from =~ into !~.\n\nMatching is against the whole indexed term and is case-sensitive, so it is restricted to filterable keyword string fields that keep their original case. The pattern is a portable RE2 subset: literals, character classes, grouping, alternation, and greedy repetition. The backend is the source of truth for what the subset admits; it rejects unsupported syntax, fields that do not preserve case, and patterns that expand to too many terms with a 400.",
|
|
4000
|
+
"type": "object",
|
|
4001
|
+
"required": ["field", "pattern"],
|
|
4002
|
+
"properties": {
|
|
4003
|
+
"field": {
|
|
4004
|
+
"type": "string",
|
|
4005
|
+
"default": ""
|
|
4006
|
+
},
|
|
4007
|
+
"negate": {
|
|
4008
|
+
"description": "Negate inverts the match: the field must not match the pattern.",
|
|
4009
|
+
"type": "boolean"
|
|
4010
|
+
},
|
|
4011
|
+
"pattern": {
|
|
4012
|
+
"type": "string",
|
|
4013
|
+
"default": ""
|
|
4014
|
+
}
|
|
4015
|
+
}
|
|
4016
|
+
},
|
|
4017
|
+
"ResourceRef": {
|
|
4018
|
+
"description": "ResourceRef is the full identity of a returned item. Namespace is implicit from the URL and omitted.",
|
|
4019
|
+
"type": "object",
|
|
4020
|
+
"required": ["group", "resource", "kind", "name"],
|
|
4021
|
+
"properties": {
|
|
4022
|
+
"group": {
|
|
4023
|
+
"type": "string",
|
|
4024
|
+
"default": ""
|
|
4025
|
+
},
|
|
4026
|
+
"kind": {
|
|
4027
|
+
"type": "string",
|
|
4028
|
+
"default": ""
|
|
4029
|
+
},
|
|
4030
|
+
"name": {
|
|
4031
|
+
"type": "string",
|
|
4032
|
+
"default": ""
|
|
4033
|
+
},
|
|
4034
|
+
"resource": {
|
|
4035
|
+
"type": "string",
|
|
4036
|
+
"default": ""
|
|
4037
|
+
}
|
|
4038
|
+
}
|
|
4039
|
+
},
|
|
4040
|
+
"ResultItem": {
|
|
4041
|
+
"description": "ResultItem is one search or trash hit. The item shape is identical on both endpoints; only which fields the Fields map can carry differs.",
|
|
4042
|
+
"type": "object",
|
|
4043
|
+
"required": ["resource"],
|
|
4044
|
+
"properties": {
|
|
4045
|
+
"fields": {
|
|
4046
|
+
"description": "Fields holds the JSON values for the requested (or default) fields. Array-typed fields are returned as JSON arrays. Absent fields are omitted.",
|
|
4047
|
+
"$ref": "#/components/schemas/Unstructured"
|
|
4048
|
+
},
|
|
4049
|
+
"resource": {
|
|
4050
|
+
"default": {},
|
|
4051
|
+
"$ref": "#/components/schemas/ResourceRef"
|
|
4052
|
+
},
|
|
4053
|
+
"score": {
|
|
4054
|
+
"description": "Score is present only when a text query was evaluated. A pointer so a real score of 0 is still distinguishable from \"no text query\" (absent).",
|
|
4055
|
+
"type": "number",
|
|
4056
|
+
"format": "double"
|
|
4057
|
+
}
|
|
4058
|
+
}
|
|
4059
|
+
},
|
|
4060
|
+
"ResultsMetadata": {
|
|
4061
|
+
"description": "ResultsMetadata carries the pagination token and the total hit count.",
|
|
4062
|
+
"type": "object",
|
|
4063
|
+
"required": ["totalHits", "totalHitsRelation"],
|
|
4064
|
+
"properties": {
|
|
4065
|
+
"continue": {
|
|
4066
|
+
"type": "string"
|
|
4067
|
+
},
|
|
4068
|
+
"totalHits": {
|
|
4069
|
+
"description": "TotalHits counts the resources matching the query. Always read it together with TotalHitsRelation. When the relation is \"unknown\", this is a zero placeholder that must not be interpreted as a count.",
|
|
4070
|
+
"type": "integer",
|
|
4071
|
+
"format": "int64",
|
|
4072
|
+
"default": 0
|
|
4073
|
+
},
|
|
4074
|
+
"totalHitsRelation": {
|
|
4075
|
+
"description": "TotalHitsRelation is \"eq\" when TotalHits is exact and \"lte\" when it is an upper bound. \"unknown\" means no count is available and TotalHits must be ignored.",
|
|
4076
|
+
"type": "string",
|
|
4077
|
+
"default": ""
|
|
4078
|
+
}
|
|
4079
|
+
}
|
|
4080
|
+
},
|
|
4081
|
+
"SearchQuery": {
|
|
4082
|
+
"description": "SearchQuery is the request body for POST .../{resource}/search, which searches one kind, and for POST .../namespaces/{namespace}/global/search, which searches several resource types at once.",
|
|
4083
|
+
"type": "object",
|
|
4084
|
+
"properties": {
|
|
4085
|
+
"apiVersion": {
|
|
4086
|
+
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
4087
|
+
"type": "string"
|
|
4088
|
+
},
|
|
4089
|
+
"continue": {
|
|
4090
|
+
"description": "Continue is an opaque pagination token from a previous page.",
|
|
4091
|
+
"type": "string"
|
|
4092
|
+
},
|
|
4093
|
+
"facetLimit": {
|
|
4094
|
+
"description": "FacetLimit caps the number of terms returned per facet. It applies to every entry in Facets. Zero uses the server default; values above the server cap are clamped.",
|
|
4095
|
+
"type": "integer",
|
|
4096
|
+
"format": "int64"
|
|
4097
|
+
},
|
|
4098
|
+
"facets": {
|
|
4099
|
+
"type": "array",
|
|
4100
|
+
"items": {
|
|
4101
|
+
"type": "string"
|
|
4102
|
+
}
|
|
4103
|
+
},
|
|
4104
|
+
"fields": {
|
|
4105
|
+
"type": "array",
|
|
4106
|
+
"items": {
|
|
4107
|
+
"type": "string"
|
|
4108
|
+
}
|
|
4109
|
+
},
|
|
4110
|
+
"kind": {
|
|
4111
|
+
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
4112
|
+
"type": "string"
|
|
4113
|
+
},
|
|
4114
|
+
"labelSelector": {
|
|
4115
|
+
"description": "LabelSelector filters on metadata.labels, ANDed with Where.",
|
|
4116
|
+
"$ref": "#/components/schemas/LabelSelector"
|
|
4117
|
+
},
|
|
4118
|
+
"limit": {
|
|
4119
|
+
"description": "Limit is the page size. Zero uses the default; values above the maximum are clamped.",
|
|
4120
|
+
"type": "integer",
|
|
4121
|
+
"format": "int64"
|
|
4122
|
+
},
|
|
4123
|
+
"sort": {
|
|
4124
|
+
"type": "array",
|
|
4125
|
+
"items": {
|
|
4126
|
+
"$ref": "#/components/schemas/SortField"
|
|
4127
|
+
}
|
|
4128
|
+
},
|
|
4129
|
+
"where": {
|
|
4130
|
+
"description": "Where is the search predicate tree. Omitting it matches everything the endpoint searches: all resources of the kind, or of every type the global search covers (subject to labelSelector and per-item authz).",
|
|
4131
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
4132
|
+
}
|
|
4133
|
+
}
|
|
4134
|
+
},
|
|
4135
|
+
"SearchResults": {
|
|
4136
|
+
"description": "SearchResults is the response body for POST .../{resource}/search.",
|
|
4137
|
+
"type": "object",
|
|
4138
|
+
"required": ["metadata", "items"],
|
|
4139
|
+
"properties": {
|
|
4140
|
+
"apiVersion": {
|
|
4141
|
+
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
4142
|
+
"type": "string"
|
|
4143
|
+
},
|
|
4144
|
+
"facets": {
|
|
4145
|
+
"description": "Facets holds term counts per requested facet field. Counts are computed over a bounded sample window, so they are best-effort/approximate.",
|
|
4146
|
+
"type": "object",
|
|
4147
|
+
"additionalProperties": {
|
|
4148
|
+
"type": "array",
|
|
4149
|
+
"items": {
|
|
4150
|
+
"$ref": "#/components/schemas/FacetTerm"
|
|
4151
|
+
}
|
|
4152
|
+
}
|
|
4153
|
+
},
|
|
4154
|
+
"items": {
|
|
4155
|
+
"type": "array",
|
|
4156
|
+
"items": {
|
|
4157
|
+
"$ref": "#/components/schemas/ResultItem"
|
|
4158
|
+
}
|
|
4159
|
+
},
|
|
4160
|
+
"kind": {
|
|
4161
|
+
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
4162
|
+
"type": "string"
|
|
4163
|
+
},
|
|
4164
|
+
"metadata": {
|
|
4165
|
+
"default": {},
|
|
4166
|
+
"$ref": "#/components/schemas/ResultsMetadata"
|
|
4167
|
+
}
|
|
4168
|
+
}
|
|
4169
|
+
},
|
|
4170
|
+
"SortField": {
|
|
4171
|
+
"description": "SortField names a field to sort by and a direction (\"asc\" or \"desc\"). V1 allows sorting only on scalar string and numeric fields that declare the sort capability.",
|
|
4172
|
+
"type": "object",
|
|
4173
|
+
"required": ["field"],
|
|
4174
|
+
"properties": {
|
|
4175
|
+
"direction": {
|
|
4176
|
+
"type": "string"
|
|
4177
|
+
},
|
|
4178
|
+
"field": {
|
|
4179
|
+
"type": "string",
|
|
4180
|
+
"default": ""
|
|
4181
|
+
}
|
|
4182
|
+
}
|
|
4183
|
+
},
|
|
4184
|
+
"TextPredicate": {
|
|
4185
|
+
"description": "TextPredicate is a free-text predicate against one or more text-capable fields. When Fields is empty it defaults to the kind's searchTextFields (currently [\"title\"]).",
|
|
4186
|
+
"type": "object",
|
|
4187
|
+
"required": ["value"],
|
|
4188
|
+
"properties": {
|
|
4189
|
+
"boost": {
|
|
4190
|
+
"description": "Boost is a future per-leaf score multiplier. Setting it is rejected in v1.",
|
|
4191
|
+
"type": "number",
|
|
4192
|
+
"format": "double"
|
|
4193
|
+
},
|
|
4194
|
+
"fields": {
|
|
4195
|
+
"type": "array",
|
|
4196
|
+
"items": {
|
|
4197
|
+
"type": "string"
|
|
4198
|
+
}
|
|
4199
|
+
},
|
|
4200
|
+
"value": {
|
|
4201
|
+
"type": "string",
|
|
4202
|
+
"default": ""
|
|
4203
|
+
}
|
|
4204
|
+
}
|
|
4205
|
+
},
|
|
4206
|
+
"TrashQuery": {
|
|
4207
|
+
"description": "TrashQuery is the request body for POST .../{resource}/trash. It is a deliberately smaller subset of SearchQuery: trash documents index only the standard fields, so there is no labelSelector and no faceting. Field references are restricted to the fixed trash field set.",
|
|
4208
|
+
"type": "object",
|
|
4209
|
+
"properties": {
|
|
4210
|
+
"apiVersion": {
|
|
4211
|
+
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
4212
|
+
"type": "string"
|
|
4213
|
+
},
|
|
4214
|
+
"continue": {
|
|
4215
|
+
"type": "string"
|
|
4216
|
+
},
|
|
4217
|
+
"fields": {
|
|
4218
|
+
"type": "array",
|
|
4219
|
+
"items": {
|
|
4220
|
+
"type": "string"
|
|
4221
|
+
}
|
|
4222
|
+
},
|
|
4223
|
+
"kind": {
|
|
4224
|
+
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
4225
|
+
"type": "string"
|
|
4226
|
+
},
|
|
4227
|
+
"limit": {
|
|
4228
|
+
"type": "integer",
|
|
4229
|
+
"format": "int64"
|
|
4230
|
+
},
|
|
4231
|
+
"sort": {
|
|
4232
|
+
"type": "array",
|
|
4233
|
+
"items": {
|
|
4234
|
+
"$ref": "#/components/schemas/SortField"
|
|
4235
|
+
}
|
|
4236
|
+
},
|
|
4237
|
+
"where": {
|
|
4238
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
4239
|
+
}
|
|
4240
|
+
}
|
|
4241
|
+
},
|
|
4242
|
+
"TrashResults": {
|
|
4243
|
+
"description": "TrashResults is the response body for POST .../{resource}/trash. It has the same item shape as SearchResults but never carries facets.",
|
|
4244
|
+
"type": "object",
|
|
4245
|
+
"required": ["metadata", "items"],
|
|
4246
|
+
"properties": {
|
|
4247
|
+
"apiVersion": {
|
|
4248
|
+
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
|
|
4249
|
+
"type": "string"
|
|
4250
|
+
},
|
|
4251
|
+
"items": {
|
|
4252
|
+
"type": "array",
|
|
4253
|
+
"items": {
|
|
4254
|
+
"$ref": "#/components/schemas/ResultItem"
|
|
4255
|
+
}
|
|
4256
|
+
},
|
|
4257
|
+
"kind": {
|
|
4258
|
+
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
4259
|
+
"type": "string"
|
|
4260
|
+
},
|
|
4261
|
+
"metadata": {
|
|
4262
|
+
"default": {},
|
|
4263
|
+
"$ref": "#/components/schemas/ResultsMetadata"
|
|
4264
|
+
}
|
|
4265
|
+
}
|
|
4266
|
+
},
|
|
4267
|
+
"WhereNode": {
|
|
4268
|
+
"description": "WhereNode is a single node of the where tree. Exactly one field must be set; the set field names the node's type. Combinators (and/or/not) compose other nodes, leaves (text/filter/range/regex/exists) are terminal predicates.\n\nAll node types are modelled so the schema is future-proof, but v1 only accepts a narrow subset (top-level single leaf or a single and of leaves; text, filter, range and regex leaves; In/NotIn/All filter operators). Everything else is rejected with 422 Unprocessable Entity by the validation layer. exists is sketched for a future version and always rejected today.",
|
|
4269
|
+
"type": "object",
|
|
4270
|
+
"properties": {
|
|
4271
|
+
"and": {
|
|
4272
|
+
"description": "Combinators.",
|
|
4273
|
+
"type": "array",
|
|
4274
|
+
"items": {
|
|
4275
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
4276
|
+
}
|
|
4277
|
+
},
|
|
4278
|
+
"exists": {
|
|
4279
|
+
"$ref": "#/components/schemas/ExistsPredicate"
|
|
4280
|
+
},
|
|
4281
|
+
"filter": {
|
|
4282
|
+
"$ref": "#/components/schemas/FilterPredicate"
|
|
4283
|
+
},
|
|
4284
|
+
"not": {
|
|
4285
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
4286
|
+
},
|
|
4287
|
+
"or": {
|
|
4288
|
+
"type": "array",
|
|
4289
|
+
"items": {
|
|
4290
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
4291
|
+
}
|
|
4292
|
+
},
|
|
4293
|
+
"range": {
|
|
4294
|
+
"$ref": "#/components/schemas/RangePredicate"
|
|
4295
|
+
},
|
|
4296
|
+
"regex": {
|
|
4297
|
+
"$ref": "#/components/schemas/RegexPredicate"
|
|
4298
|
+
},
|
|
4299
|
+
"text": {
|
|
4300
|
+
"description": "Leaves.",
|
|
4301
|
+
"$ref": "#/components/schemas/TextPredicate"
|
|
4302
|
+
}
|
|
4303
|
+
}
|
|
4304
|
+
},
|
|
4305
|
+
"APIResource": {
|
|
4306
|
+
"description": "APIResource specifies the name of a resource and whether it is namespaced.",
|
|
4307
|
+
"type": "object",
|
|
4308
|
+
"required": ["name", "singularName", "namespaced", "kind", "verbs"],
|
|
4309
|
+
"properties": {
|
|
4310
|
+
"categories": {
|
|
4311
|
+
"description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
|
|
4312
|
+
"type": "array",
|
|
4313
|
+
"items": {
|
|
4314
|
+
"type": "string",
|
|
4315
|
+
"default": ""
|
|
4316
|
+
},
|
|
4317
|
+
"x-kubernetes-list-type": "atomic"
|
|
4318
|
+
},
|
|
4319
|
+
"group": {
|
|
4320
|
+
"description": "group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\".",
|
|
4321
|
+
"type": "string"
|
|
4322
|
+
},
|
|
4323
|
+
"kind": {
|
|
4324
|
+
"description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
|
|
4325
|
+
"type": "string",
|
|
4326
|
+
"default": ""
|
|
4327
|
+
},
|
|
4328
|
+
"name": {
|
|
4329
|
+
"description": "name is the plural name of the resource.",
|
|
4330
|
+
"type": "string",
|
|
4331
|
+
"default": ""
|
|
4332
|
+
},
|
|
4333
|
+
"namespaced": {
|
|
3786
4334
|
"description": "namespaced indicates if a resource is namespaced or not.",
|
|
3787
4335
|
"type": "boolean",
|
|
3788
4336
|
"default": false
|
|
@@ -3904,6 +4452,53 @@
|
|
|
3904
4452
|
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
|
|
3905
4453
|
"type": "object"
|
|
3906
4454
|
},
|
|
4455
|
+
"LabelSelector": {
|
|
4456
|
+
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
|
|
4457
|
+
"type": "object",
|
|
4458
|
+
"properties": {
|
|
4459
|
+
"matchExpressions": {
|
|
4460
|
+
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
|
|
4461
|
+
"type": "array",
|
|
4462
|
+
"items": {
|
|
4463
|
+
"$ref": "#/components/schemas/LabelSelectorRequirement"
|
|
4464
|
+
},
|
|
4465
|
+
"x-kubernetes-list-type": "atomic"
|
|
4466
|
+
},
|
|
4467
|
+
"matchLabels": {
|
|
4468
|
+
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
|
|
4469
|
+
"type": "object",
|
|
4470
|
+
"additionalProperties": {
|
|
4471
|
+
"type": "string"
|
|
4472
|
+
}
|
|
4473
|
+
}
|
|
4474
|
+
},
|
|
4475
|
+
"x-kubernetes-map-type": "atomic"
|
|
4476
|
+
},
|
|
4477
|
+
"LabelSelectorRequirement": {
|
|
4478
|
+
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
|
|
4479
|
+
"type": "object",
|
|
4480
|
+
"required": ["key", "operator"],
|
|
4481
|
+
"properties": {
|
|
4482
|
+
"key": {
|
|
4483
|
+
"description": "key is the label key that the selector applies to.",
|
|
4484
|
+
"type": "string",
|
|
4485
|
+
"default": ""
|
|
4486
|
+
},
|
|
4487
|
+
"operator": {
|
|
4488
|
+
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
|
|
4489
|
+
"type": "string",
|
|
4490
|
+
"default": ""
|
|
4491
|
+
},
|
|
4492
|
+
"values": {
|
|
4493
|
+
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
|
|
4494
|
+
"type": "array",
|
|
4495
|
+
"items": {
|
|
4496
|
+
"type": "string"
|
|
4497
|
+
},
|
|
4498
|
+
"x-kubernetes-list-type": "atomic"
|
|
4499
|
+
}
|
|
4500
|
+
}
|
|
4501
|
+
},
|
|
3907
4502
|
"ListMeta": {
|
|
3908
4503
|
"description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
|
|
3909
4504
|
"type": "object",
|