@grafana/openapi 13.2.3 → 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 +649 -151
- package/dist/apis/provisioning.grafana.app-v1beta1.json +634 -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": "listDashboardSearchV0alpha1",
|
|
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": "listDashboardHybridSearchV0alpha1",
|
|
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": "listDashboardTrashV0alpha1",
|
|
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"],
|
|
@@ -1191,6 +1302,17 @@
|
|
|
1191
1302
|
"type": "string"
|
|
1192
1303
|
}
|
|
1193
1304
|
},
|
|
1305
|
+
{
|
|
1306
|
+
"name": "name",
|
|
1307
|
+
"in": "query",
|
|
1308
|
+
"description": "only include resources with these names (UIDs)",
|
|
1309
|
+
"schema": {
|
|
1310
|
+
"type": "array",
|
|
1311
|
+
"items": {
|
|
1312
|
+
"type": "string"
|
|
1313
|
+
}
|
|
1314
|
+
}
|
|
1315
|
+
},
|
|
1194
1316
|
{
|
|
1195
1317
|
"name": "facet",
|
|
1196
1318
|
"in": "query",
|
|
@@ -1249,10 +1371,10 @@
|
|
|
1249
1371
|
{
|
|
1250
1372
|
"name": "permission",
|
|
1251
1373
|
"in": "query",
|
|
1252
|
-
"description": "permission needed for the resource (view, edit, admin)",
|
|
1374
|
+
"description": "permission needed for the resource (view, edit, admin, create). create is only valid with type=folder",
|
|
1253
1375
|
"schema": {
|
|
1254
1376
|
"type": "string",
|
|
1255
|
-
"enum": ["view", "edit", "admin"]
|
|
1377
|
+
"enum": ["view", "edit", "admin", "create"]
|
|
1256
1378
|
}
|
|
1257
1379
|
},
|
|
1258
1380
|
{
|
|
@@ -1315,14 +1437,6 @@
|
|
|
1315
1437
|
"type": "string"
|
|
1316
1438
|
}
|
|
1317
1439
|
},
|
|
1318
|
-
{
|
|
1319
|
-
"name": "explain",
|
|
1320
|
-
"in": "query",
|
|
1321
|
-
"description": "add debugging info that may help explain why the result matched",
|
|
1322
|
-
"schema": {
|
|
1323
|
-
"type": "boolean"
|
|
1324
|
-
}
|
|
1325
|
-
},
|
|
1326
1440
|
{
|
|
1327
1441
|
"name": "panelTitleSearch",
|
|
1328
1442
|
"in": "query",
|
|
@@ -1337,7 +1451,7 @@
|
|
|
1337
1451
|
"content": {
|
|
1338
1452
|
"application/json": {
|
|
1339
1453
|
"schema": {
|
|
1340
|
-
"$ref": "#/components/schemas/
|
|
1454
|
+
"$ref": "#/components/schemas/DashboardSearchResults"
|
|
1341
1455
|
}
|
|
1342
1456
|
}
|
|
1343
1457
|
}
|
|
@@ -1366,9 +1480,7 @@
|
|
|
1366
1480
|
"fields": {
|
|
1367
1481
|
"description": "Sortable fields (depends on backend support)",
|
|
1368
1482
|
"type": "array",
|
|
1369
|
-
"items": {
|
|
1370
|
-
"default": {}
|
|
1371
|
-
}
|
|
1483
|
+
"items": {}
|
|
1372
1484
|
},
|
|
1373
1485
|
"kind": {
|
|
1374
1486
|
"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",
|
|
@@ -1826,9 +1938,6 @@
|
|
|
1826
1938
|
"description": "Dashboard description",
|
|
1827
1939
|
"type": "string"
|
|
1828
1940
|
},
|
|
1829
|
-
"explain": {
|
|
1830
|
-
"description": "Explain the score (if possible)"
|
|
1831
|
-
},
|
|
1832
1941
|
"field": {
|
|
1833
1942
|
"description": "Stick untyped extra fields in this object (including the sort value)"
|
|
1834
1943
|
},
|
|
@@ -1848,8 +1957,7 @@
|
|
|
1848
1957
|
"description": "Owner references set on the resource metadata in the format {Group}/{Kind}/{Name}",
|
|
1849
1958
|
"type": "array",
|
|
1850
1959
|
"items": {
|
|
1851
|
-
"type": "string"
|
|
1852
|
-
"default": ""
|
|
1960
|
+
"type": "string"
|
|
1853
1961
|
}
|
|
1854
1962
|
},
|
|
1855
1963
|
"resource": {
|
|
@@ -1866,8 +1974,7 @@
|
|
|
1866
1974
|
"description": "Filter tags",
|
|
1867
1975
|
"type": "array",
|
|
1868
1976
|
"items": {
|
|
1869
|
-
"type": "string"
|
|
1870
|
-
"default": ""
|
|
1977
|
+
"type": "string"
|
|
1871
1978
|
}
|
|
1872
1979
|
},
|
|
1873
1980
|
"title": {
|
|
@@ -1877,44 +1984,7 @@
|
|
|
1877
1984
|
}
|
|
1878
1985
|
}
|
|
1879
1986
|
},
|
|
1880
|
-
"
|
|
1881
|
-
"type": "object",
|
|
1882
|
-
"properties": {
|
|
1883
|
-
"field": {
|
|
1884
|
-
"type": "string"
|
|
1885
|
-
},
|
|
1886
|
-
"missing": {
|
|
1887
|
-
"description": "The number of documents that do *not* have this field",
|
|
1888
|
-
"type": "integer",
|
|
1889
|
-
"format": "int64"
|
|
1890
|
-
},
|
|
1891
|
-
"terms": {
|
|
1892
|
-
"type": "array",
|
|
1893
|
-
"items": {
|
|
1894
|
-
"$ref": "#/components/schemas/TermFacet"
|
|
1895
|
-
}
|
|
1896
|
-
},
|
|
1897
|
-
"total": {
|
|
1898
|
-
"description": "The distinct terms",
|
|
1899
|
-
"type": "integer",
|
|
1900
|
-
"format": "int64"
|
|
1901
|
-
}
|
|
1902
|
-
}
|
|
1903
|
-
},
|
|
1904
|
-
"ManagedBy": {
|
|
1905
|
-
"type": "object",
|
|
1906
|
-
"required": ["kind"],
|
|
1907
|
-
"properties": {
|
|
1908
|
-
"id": {
|
|
1909
|
-
"type": "string"
|
|
1910
|
-
},
|
|
1911
|
-
"kind": {
|
|
1912
|
-
"type": "string",
|
|
1913
|
-
"default": ""
|
|
1914
|
-
}
|
|
1915
|
-
}
|
|
1916
|
-
},
|
|
1917
|
-
"SearchResults": {
|
|
1987
|
+
"DashboardSearchResults": {
|
|
1918
1988
|
"type": "object",
|
|
1919
1989
|
"required": ["totalHits", "hits"],
|
|
1920
1990
|
"properties": {
|
|
@@ -1964,6 +2034,43 @@
|
|
|
1964
2034
|
}
|
|
1965
2035
|
}
|
|
1966
2036
|
},
|
|
2037
|
+
"FacetResult": {
|
|
2038
|
+
"type": "object",
|
|
2039
|
+
"properties": {
|
|
2040
|
+
"field": {
|
|
2041
|
+
"type": "string"
|
|
2042
|
+
},
|
|
2043
|
+
"missing": {
|
|
2044
|
+
"description": "The number of documents that do *not* have this field",
|
|
2045
|
+
"type": "integer",
|
|
2046
|
+
"format": "int64"
|
|
2047
|
+
},
|
|
2048
|
+
"terms": {
|
|
2049
|
+
"type": "array",
|
|
2050
|
+
"items": {
|
|
2051
|
+
"$ref": "#/components/schemas/TermFacet"
|
|
2052
|
+
}
|
|
2053
|
+
},
|
|
2054
|
+
"total": {
|
|
2055
|
+
"description": "The distinct terms",
|
|
2056
|
+
"type": "integer",
|
|
2057
|
+
"format": "int64"
|
|
2058
|
+
}
|
|
2059
|
+
}
|
|
2060
|
+
},
|
|
2061
|
+
"ManagedBy": {
|
|
2062
|
+
"type": "object",
|
|
2063
|
+
"required": ["kind"],
|
|
2064
|
+
"properties": {
|
|
2065
|
+
"id": {
|
|
2066
|
+
"type": "string"
|
|
2067
|
+
},
|
|
2068
|
+
"kind": {
|
|
2069
|
+
"type": "string",
|
|
2070
|
+
"default": ""
|
|
2071
|
+
}
|
|
2072
|
+
}
|
|
2073
|
+
},
|
|
1967
2074
|
"SortBy": {
|
|
1968
2075
|
"type": "object",
|
|
1969
2076
|
"required": ["field"],
|
|
@@ -2266,12 +2373,7 @@
|
|
|
2266
2373
|
"items": {
|
|
2267
2374
|
"type": "array",
|
|
2268
2375
|
"items": {
|
|
2269
|
-
"
|
|
2270
|
-
"allOf": [
|
|
2271
|
-
{
|
|
2272
|
-
"$ref": "#/components/schemas/Dashboard"
|
|
2273
|
-
}
|
|
2274
|
-
]
|
|
2376
|
+
"$ref": "#/components/schemas/Dashboard"
|
|
2275
2377
|
}
|
|
2276
2378
|
},
|
|
2277
2379
|
"kind": {
|
|
@@ -2298,12 +2400,20 @@
|
|
|
2298
2400
|
"DashboardSnapshotWithDeleteKey": {
|
|
2299
2401
|
"description": "This is returned from the POST command",
|
|
2300
2402
|
"type": "object",
|
|
2301
|
-
"required": ["metadata", "spec"],
|
|
2403
|
+
"required": ["metadata", "spec", "blobs"],
|
|
2302
2404
|
"properties": {
|
|
2303
2405
|
"apiVersion": {
|
|
2304
2406
|
"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",
|
|
2305
2407
|
"type": "string"
|
|
2306
2408
|
},
|
|
2409
|
+
"blobs": {
|
|
2410
|
+
"default": {},
|
|
2411
|
+
"allOf": [
|
|
2412
|
+
{
|
|
2413
|
+
"$ref": "#/components/schemas/SnapshotBlobs"
|
|
2414
|
+
}
|
|
2415
|
+
]
|
|
2416
|
+
},
|
|
2307
2417
|
"deleteKey": {
|
|
2308
2418
|
"description": "The delete key is only returned when the item is created. It is not returned from a get request",
|
|
2309
2419
|
"type": "string"
|
|
@@ -2489,12 +2599,7 @@
|
|
|
2489
2599
|
"items": {
|
|
2490
2600
|
"type": "array",
|
|
2491
2601
|
"items": {
|
|
2492
|
-
"
|
|
2493
|
-
"allOf": [
|
|
2494
|
-
{
|
|
2495
|
-
"$ref": "#/components/schemas/LibraryPanel"
|
|
2496
|
-
}
|
|
2497
|
-
]
|
|
2602
|
+
"$ref": "#/components/schemas/LibraryPanel"
|
|
2498
2603
|
}
|
|
2499
2604
|
},
|
|
2500
2605
|
"kind": {
|
|
@@ -2612,20 +2717,27 @@
|
|
|
2612
2717
|
"description": "Translation warnings (mostly things that were in SQL columns but not found in the saved body)",
|
|
2613
2718
|
"type": "array",
|
|
2614
2719
|
"items": {
|
|
2615
|
-
"type": "string"
|
|
2616
|
-
"default": ""
|
|
2720
|
+
"type": "string"
|
|
2617
2721
|
}
|
|
2618
2722
|
}
|
|
2619
2723
|
}
|
|
2620
2724
|
},
|
|
2621
2725
|
"Snapshot": {
|
|
2622
2726
|
"type": "object",
|
|
2623
|
-
"required": ["metadata", "spec"],
|
|
2727
|
+
"required": ["metadata", "spec", "blobs"],
|
|
2624
2728
|
"properties": {
|
|
2625
2729
|
"apiVersion": {
|
|
2626
2730
|
"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",
|
|
2627
2731
|
"type": "string"
|
|
2628
2732
|
},
|
|
2733
|
+
"blobs": {
|
|
2734
|
+
"default": {},
|
|
2735
|
+
"allOf": [
|
|
2736
|
+
{
|
|
2737
|
+
"$ref": "#/components/schemas/SnapshotBlobs"
|
|
2738
|
+
}
|
|
2739
|
+
]
|
|
2740
|
+
},
|
|
2629
2741
|
"kind": {
|
|
2630
2742
|
"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",
|
|
2631
2743
|
"type": "string"
|
|
@@ -2656,6 +2768,34 @@
|
|
|
2656
2768
|
}
|
|
2657
2769
|
]
|
|
2658
2770
|
},
|
|
2771
|
+
"SnapshotBlobReference": {
|
|
2772
|
+
"type": "object",
|
|
2773
|
+
"required": ["uid"],
|
|
2774
|
+
"properties": {
|
|
2775
|
+
"contentType": {
|
|
2776
|
+
"type": "string"
|
|
2777
|
+
},
|
|
2778
|
+
"hash": {
|
|
2779
|
+
"type": "string"
|
|
2780
|
+
},
|
|
2781
|
+
"size": {
|
|
2782
|
+
"type": "integer",
|
|
2783
|
+
"format": "int64"
|
|
2784
|
+
},
|
|
2785
|
+
"uid": {
|
|
2786
|
+
"type": "string",
|
|
2787
|
+
"default": ""
|
|
2788
|
+
}
|
|
2789
|
+
}
|
|
2790
|
+
},
|
|
2791
|
+
"SnapshotBlobs": {
|
|
2792
|
+
"type": "object",
|
|
2793
|
+
"properties": {
|
|
2794
|
+
"dashboard": {
|
|
2795
|
+
"$ref": "#/components/schemas/SnapshotBlobReference"
|
|
2796
|
+
}
|
|
2797
|
+
}
|
|
2798
|
+
},
|
|
2659
2799
|
"SnapshotList": {
|
|
2660
2800
|
"type": "object",
|
|
2661
2801
|
"required": ["metadata", "items"],
|
|
@@ -2667,12 +2807,7 @@
|
|
|
2667
2807
|
"items": {
|
|
2668
2808
|
"type": "array",
|
|
2669
2809
|
"items": {
|
|
2670
|
-
"
|
|
2671
|
-
"allOf": [
|
|
2672
|
-
{
|
|
2673
|
-
"$ref": "#/components/schemas/Snapshot"
|
|
2674
|
-
}
|
|
2675
|
-
]
|
|
2810
|
+
"$ref": "#/components/schemas/Snapshot"
|
|
2676
2811
|
}
|
|
2677
2812
|
},
|
|
2678
2813
|
"kind": {
|
|
@@ -2719,6 +2854,10 @@
|
|
|
2719
2854
|
"description": "When set to true, the snapshot exists in a remote server",
|
|
2720
2855
|
"type": "boolean"
|
|
2721
2856
|
},
|
|
2857
|
+
"externalDeleteUrl": {
|
|
2858
|
+
"description": "The server-provided URL for deleting the external snapshot",
|
|
2859
|
+
"type": "string"
|
|
2860
|
+
},
|
|
2722
2861
|
"externalUrl": {
|
|
2723
2862
|
"description": "The external URL where the snapshot can be seen",
|
|
2724
2863
|
"type": "string"
|
|
@@ -2742,34 +2881,608 @@
|
|
|
2742
2881
|
"additionalProperties": true,
|
|
2743
2882
|
"x-kubernetes-preserve-unknown-fields": true
|
|
2744
2883
|
},
|
|
2745
|
-
"
|
|
2746
|
-
"description": "
|
|
2884
|
+
"ExistsPredicate": {
|
|
2885
|
+
"description": "ExistsPredicate is a future field-existence predicate. Modelled for schema stability; always rejected in v1.",
|
|
2747
2886
|
"type": "object",
|
|
2748
|
-
"required": ["
|
|
2887
|
+
"required": ["field"],
|
|
2749
2888
|
"properties": {
|
|
2750
|
-
"
|
|
2751
|
-
"description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
|
|
2752
|
-
"type": "array",
|
|
2753
|
-
"items": {
|
|
2754
|
-
"type": "string",
|
|
2755
|
-
"default": ""
|
|
2756
|
-
},
|
|
2757
|
-
"x-kubernetes-list-type": "atomic"
|
|
2758
|
-
},
|
|
2759
|
-
"group": {
|
|
2760
|
-
"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\".",
|
|
2761
|
-
"type": "string"
|
|
2762
|
-
},
|
|
2763
|
-
"kind": {
|
|
2764
|
-
"description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
|
|
2765
|
-
"type": "string",
|
|
2766
|
-
"default": ""
|
|
2767
|
-
},
|
|
2768
|
-
"name": {
|
|
2769
|
-
"description": "name is the plural name of the resource.",
|
|
2889
|
+
"field": {
|
|
2770
2890
|
"type": "string",
|
|
2771
2891
|
"default": ""
|
|
2772
|
-
}
|
|
2892
|
+
}
|
|
2893
|
+
}
|
|
2894
|
+
},
|
|
2895
|
+
"FacetTerm": {
|
|
2896
|
+
"description": "FacetTerm is a single facet term and its count.",
|
|
2897
|
+
"type": "object",
|
|
2898
|
+
"required": ["value", "count"],
|
|
2899
|
+
"properties": {
|
|
2900
|
+
"count": {
|
|
2901
|
+
"type": "integer",
|
|
2902
|
+
"format": "int64",
|
|
2903
|
+
"default": 0
|
|
2904
|
+
},
|
|
2905
|
+
"value": {
|
|
2906
|
+
"type": "string",
|
|
2907
|
+
"default": ""
|
|
2908
|
+
}
|
|
2909
|
+
}
|
|
2910
|
+
},
|
|
2911
|
+
"FilterPredicate": {
|
|
2912
|
+
"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.",
|
|
2913
|
+
"type": "object",
|
|
2914
|
+
"required": ["field", "operator", "values"],
|
|
2915
|
+
"properties": {
|
|
2916
|
+
"field": {
|
|
2917
|
+
"type": "string",
|
|
2918
|
+
"default": ""
|
|
2919
|
+
},
|
|
2920
|
+
"operator": {
|
|
2921
|
+
"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.",
|
|
2922
|
+
"type": "string",
|
|
2923
|
+
"default": ""
|
|
2924
|
+
},
|
|
2925
|
+
"values": {
|
|
2926
|
+
"type": "array",
|
|
2927
|
+
"items": {
|
|
2928
|
+
"type": "string"
|
|
2929
|
+
}
|
|
2930
|
+
}
|
|
2931
|
+
}
|
|
2932
|
+
},
|
|
2933
|
+
"HybridSearchChunk": {
|
|
2934
|
+
"description": "HybridSearchChunk is matching text from an embedded resource or subresource.",
|
|
2935
|
+
"type": "object",
|
|
2936
|
+
"required": ["subresource", "content"],
|
|
2937
|
+
"properties": {
|
|
2938
|
+
"content": {
|
|
2939
|
+
"type": "string",
|
|
2940
|
+
"default": ""
|
|
2941
|
+
},
|
|
2942
|
+
"subresource": {
|
|
2943
|
+
"description": "Subresource identifies a chunk, for example panel/5. Empty means the whole resource, or a synthesized chunk for a lexical-only hit.",
|
|
2944
|
+
"type": "string",
|
|
2945
|
+
"default": ""
|
|
2946
|
+
}
|
|
2947
|
+
}
|
|
2948
|
+
},
|
|
2949
|
+
"HybridSearchFilter": {
|
|
2950
|
+
"description": "HybridSearchFilter matches any of Values against Field (IN semantics). Unlike lexical search filters, no other operators are supported.",
|
|
2951
|
+
"type": "object",
|
|
2952
|
+
"required": ["field", "values"],
|
|
2953
|
+
"properties": {
|
|
2954
|
+
"field": {
|
|
2955
|
+
"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.",
|
|
2956
|
+
"type": "string",
|
|
2957
|
+
"default": ""
|
|
2958
|
+
},
|
|
2959
|
+
"values": {
|
|
2960
|
+
"description": "Values must contain at least one value. Values containing '*' are rejected. An empty folder value matches resources in the root folder.",
|
|
2961
|
+
"type": "array",
|
|
2962
|
+
"items": {
|
|
2963
|
+
"type": "string"
|
|
2964
|
+
},
|
|
2965
|
+
"x-kubernetes-list-type": "atomic"
|
|
2966
|
+
}
|
|
2967
|
+
}
|
|
2968
|
+
},
|
|
2969
|
+
"HybridSearchManagedBy": {
|
|
2970
|
+
"description": "HybridSearchManagedBy identifies the manager of a returned resource.",
|
|
2971
|
+
"type": "object",
|
|
2972
|
+
"required": ["kind", "id"],
|
|
2973
|
+
"properties": {
|
|
2974
|
+
"id": {
|
|
2975
|
+
"type": "string",
|
|
2976
|
+
"default": ""
|
|
2977
|
+
},
|
|
2978
|
+
"kind": {
|
|
2979
|
+
"type": "string",
|
|
2980
|
+
"default": ""
|
|
2981
|
+
}
|
|
2982
|
+
}
|
|
2983
|
+
},
|
|
2984
|
+
"HybridSearchQuery": {
|
|
2985
|
+
"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.",
|
|
2986
|
+
"type": "object",
|
|
2987
|
+
"required": ["query"],
|
|
2988
|
+
"properties": {
|
|
2989
|
+
"apiVersion": {
|
|
2990
|
+
"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",
|
|
2991
|
+
"type": "string"
|
|
2992
|
+
},
|
|
2993
|
+
"filters": {
|
|
2994
|
+
"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.",
|
|
2995
|
+
"type": "array",
|
|
2996
|
+
"items": {
|
|
2997
|
+
"$ref": "#/components/schemas/HybridSearchFilter"
|
|
2998
|
+
},
|
|
2999
|
+
"x-kubernetes-list-type": "atomic"
|
|
3000
|
+
},
|
|
3001
|
+
"kind": {
|
|
3002
|
+
"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",
|
|
3003
|
+
"type": "string"
|
|
3004
|
+
},
|
|
3005
|
+
"limit": {
|
|
3006
|
+
"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.",
|
|
3007
|
+
"type": "integer",
|
|
3008
|
+
"format": "int64"
|
|
3009
|
+
},
|
|
3010
|
+
"minRelevance": {
|
|
3011
|
+
"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.",
|
|
3012
|
+
"type": "string"
|
|
3013
|
+
},
|
|
3014
|
+
"query": {
|
|
3015
|
+
"description": "Query supplies the lexical query and, unless SemanticQuery is set, the text embedded for semantic search. Required, with a maximum of 1000 bytes.",
|
|
3016
|
+
"type": "string",
|
|
3017
|
+
"default": ""
|
|
3018
|
+
},
|
|
3019
|
+
"resources": {
|
|
3020
|
+
"description": "Resources is required for global hybrid search and rejected by per-resource routes. It must be nonempty and contain unique group/resource pairs.",
|
|
3021
|
+
"type": "array",
|
|
3022
|
+
"items": {
|
|
3023
|
+
"$ref": "#/components/schemas/HybridSearchResource"
|
|
3024
|
+
},
|
|
3025
|
+
"x-kubernetes-list-type": "atomic"
|
|
3026
|
+
},
|
|
3027
|
+
"semanticQuery": {
|
|
3028
|
+
"description": "SemanticQuery supplies optional richer phrasing for semantic search. When provided, it must not be whitespace and must fit within 1000 bytes.",
|
|
3029
|
+
"type": "string"
|
|
3030
|
+
},
|
|
3031
|
+
"skipRerank": {
|
|
3032
|
+
"description": "SkipRerank skips reranking even when a reranker is configured. Multiple resource types are interleaved in request order, preserving each type's ranking.",
|
|
3033
|
+
"type": "boolean"
|
|
3034
|
+
}
|
|
3035
|
+
}
|
|
3036
|
+
},
|
|
3037
|
+
"HybridSearchResource": {
|
|
3038
|
+
"description": "HybridSearchResource identifies a resource type for global hybrid search.",
|
|
3039
|
+
"type": "object",
|
|
3040
|
+
"required": ["group", "resource"],
|
|
3041
|
+
"properties": {
|
|
3042
|
+
"group": {
|
|
3043
|
+
"type": "string",
|
|
3044
|
+
"default": ""
|
|
3045
|
+
},
|
|
3046
|
+
"resource": {
|
|
3047
|
+
"type": "string",
|
|
3048
|
+
"default": ""
|
|
3049
|
+
}
|
|
3050
|
+
}
|
|
3051
|
+
},
|
|
3052
|
+
"HybridSearchResultItem": {
|
|
3053
|
+
"description": "HybridSearchResultItem is one matching resource, with its matching chunks.",
|
|
3054
|
+
"type": "object",
|
|
3055
|
+
"required": ["resource", "score", "title", "folder", "chunks"],
|
|
3056
|
+
"properties": {
|
|
3057
|
+
"chunks": {
|
|
3058
|
+
"description": "Chunks contains matching text, best first. A lexical-only hit has a synthesized chunk containing the resource's title.",
|
|
3059
|
+
"type": "array",
|
|
3060
|
+
"items": {
|
|
3061
|
+
"$ref": "#/components/schemas/HybridSearchChunk"
|
|
3062
|
+
},
|
|
3063
|
+
"x-kubernetes-list-type": "atomic"
|
|
3064
|
+
},
|
|
3065
|
+
"folder": {
|
|
3066
|
+
"description": "Folder is the containing folder's UID. Empty and \"general\" denote the root folder.",
|
|
3067
|
+
"type": "string",
|
|
3068
|
+
"default": ""
|
|
3069
|
+
},
|
|
3070
|
+
"folderTitle": {
|
|
3071
|
+
"description": "FolderTitle is best-effort display data and can be absent.",
|
|
3072
|
+
"type": "string"
|
|
3073
|
+
},
|
|
3074
|
+
"managedBy": {
|
|
3075
|
+
"description": "ManagedBy is absent for unmanaged resources or when lookup fails.",
|
|
3076
|
+
"$ref": "#/components/schemas/HybridSearchManagedBy"
|
|
3077
|
+
},
|
|
3078
|
+
"resource": {
|
|
3079
|
+
"default": {},
|
|
3080
|
+
"$ref": "#/components/schemas/ResourceRef"
|
|
3081
|
+
},
|
|
3082
|
+
"score": {
|
|
3083
|
+
"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.",
|
|
3084
|
+
"type": "number",
|
|
3085
|
+
"format": "double",
|
|
3086
|
+
"default": 0
|
|
3087
|
+
},
|
|
3088
|
+
"tags": {
|
|
3089
|
+
"description": "Tags from the lexical index. Omitted when unavailable.",
|
|
3090
|
+
"type": "array",
|
|
3091
|
+
"items": {
|
|
3092
|
+
"type": "string"
|
|
3093
|
+
},
|
|
3094
|
+
"x-kubernetes-list-type": "atomic"
|
|
3095
|
+
},
|
|
3096
|
+
"title": {
|
|
3097
|
+
"type": "string",
|
|
3098
|
+
"default": ""
|
|
3099
|
+
}
|
|
3100
|
+
}
|
|
3101
|
+
},
|
|
3102
|
+
"HybridSearchResults": {
|
|
3103
|
+
"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.",
|
|
3104
|
+
"type": "object",
|
|
3105
|
+
"required": ["items"],
|
|
3106
|
+
"properties": {
|
|
3107
|
+
"apiVersion": {
|
|
3108
|
+
"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",
|
|
3109
|
+
"type": "string"
|
|
3110
|
+
},
|
|
3111
|
+
"items": {
|
|
3112
|
+
"type": "array",
|
|
3113
|
+
"items": {
|
|
3114
|
+
"$ref": "#/components/schemas/HybridSearchResultItem"
|
|
3115
|
+
},
|
|
3116
|
+
"x-kubernetes-list-type": "atomic"
|
|
3117
|
+
},
|
|
3118
|
+
"kind": {
|
|
3119
|
+
"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",
|
|
3120
|
+
"type": "string"
|
|
3121
|
+
}
|
|
3122
|
+
}
|
|
3123
|
+
},
|
|
3124
|
+
"RangePredicate": {
|
|
3125
|
+
"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.",
|
|
3126
|
+
"type": "object",
|
|
3127
|
+
"required": ["field"],
|
|
3128
|
+
"properties": {
|
|
3129
|
+
"field": {
|
|
3130
|
+
"type": "string",
|
|
3131
|
+
"default": ""
|
|
3132
|
+
},
|
|
3133
|
+
"gt": {
|
|
3134
|
+
"type": "number",
|
|
3135
|
+
"format": "double"
|
|
3136
|
+
},
|
|
3137
|
+
"gte": {
|
|
3138
|
+
"type": "number",
|
|
3139
|
+
"format": "double"
|
|
3140
|
+
},
|
|
3141
|
+
"lt": {
|
|
3142
|
+
"type": "number",
|
|
3143
|
+
"format": "double"
|
|
3144
|
+
},
|
|
3145
|
+
"lte": {
|
|
3146
|
+
"type": "number",
|
|
3147
|
+
"format": "double"
|
|
3148
|
+
}
|
|
3149
|
+
}
|
|
3150
|
+
},
|
|
3151
|
+
"RegexPredicate": {
|
|
3152
|
+
"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.",
|
|
3153
|
+
"type": "object",
|
|
3154
|
+
"required": ["field", "pattern"],
|
|
3155
|
+
"properties": {
|
|
3156
|
+
"field": {
|
|
3157
|
+
"type": "string",
|
|
3158
|
+
"default": ""
|
|
3159
|
+
},
|
|
3160
|
+
"negate": {
|
|
3161
|
+
"description": "Negate inverts the match: the field must not match the pattern.",
|
|
3162
|
+
"type": "boolean"
|
|
3163
|
+
},
|
|
3164
|
+
"pattern": {
|
|
3165
|
+
"type": "string",
|
|
3166
|
+
"default": ""
|
|
3167
|
+
}
|
|
3168
|
+
}
|
|
3169
|
+
},
|
|
3170
|
+
"ResourceRef": {
|
|
3171
|
+
"description": "ResourceRef is the full identity of a returned item. Namespace is implicit from the URL and omitted.",
|
|
3172
|
+
"type": "object",
|
|
3173
|
+
"required": ["group", "resource", "kind", "name"],
|
|
3174
|
+
"properties": {
|
|
3175
|
+
"group": {
|
|
3176
|
+
"type": "string",
|
|
3177
|
+
"default": ""
|
|
3178
|
+
},
|
|
3179
|
+
"kind": {
|
|
3180
|
+
"type": "string",
|
|
3181
|
+
"default": ""
|
|
3182
|
+
},
|
|
3183
|
+
"name": {
|
|
3184
|
+
"type": "string",
|
|
3185
|
+
"default": ""
|
|
3186
|
+
},
|
|
3187
|
+
"resource": {
|
|
3188
|
+
"type": "string",
|
|
3189
|
+
"default": ""
|
|
3190
|
+
}
|
|
3191
|
+
}
|
|
3192
|
+
},
|
|
3193
|
+
"ResultItem": {
|
|
3194
|
+
"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.",
|
|
3195
|
+
"type": "object",
|
|
3196
|
+
"required": ["resource"],
|
|
3197
|
+
"properties": {
|
|
3198
|
+
"fields": {
|
|
3199
|
+
"description": "Fields holds the JSON values for the requested (or default) fields. Array-typed fields are returned as JSON arrays. Absent fields are omitted.",
|
|
3200
|
+
"$ref": "#/components/schemas/Unstructured"
|
|
3201
|
+
},
|
|
3202
|
+
"resource": {
|
|
3203
|
+
"default": {},
|
|
3204
|
+
"$ref": "#/components/schemas/ResourceRef"
|
|
3205
|
+
},
|
|
3206
|
+
"score": {
|
|
3207
|
+
"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).",
|
|
3208
|
+
"type": "number",
|
|
3209
|
+
"format": "double"
|
|
3210
|
+
}
|
|
3211
|
+
}
|
|
3212
|
+
},
|
|
3213
|
+
"ResultsMetadata": {
|
|
3214
|
+
"description": "ResultsMetadata carries the pagination token and the total hit count.",
|
|
3215
|
+
"type": "object",
|
|
3216
|
+
"required": ["totalHits", "totalHitsRelation"],
|
|
3217
|
+
"properties": {
|
|
3218
|
+
"continue": {
|
|
3219
|
+
"type": "string"
|
|
3220
|
+
},
|
|
3221
|
+
"totalHits": {
|
|
3222
|
+
"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.",
|
|
3223
|
+
"type": "integer",
|
|
3224
|
+
"format": "int64",
|
|
3225
|
+
"default": 0
|
|
3226
|
+
},
|
|
3227
|
+
"totalHitsRelation": {
|
|
3228
|
+
"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.",
|
|
3229
|
+
"type": "string",
|
|
3230
|
+
"default": ""
|
|
3231
|
+
}
|
|
3232
|
+
}
|
|
3233
|
+
},
|
|
3234
|
+
"SearchQuery": {
|
|
3235
|
+
"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.",
|
|
3236
|
+
"type": "object",
|
|
3237
|
+
"properties": {
|
|
3238
|
+
"apiVersion": {
|
|
3239
|
+
"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",
|
|
3240
|
+
"type": "string"
|
|
3241
|
+
},
|
|
3242
|
+
"continue": {
|
|
3243
|
+
"description": "Continue is an opaque pagination token from a previous page.",
|
|
3244
|
+
"type": "string"
|
|
3245
|
+
},
|
|
3246
|
+
"facetLimit": {
|
|
3247
|
+
"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.",
|
|
3248
|
+
"type": "integer",
|
|
3249
|
+
"format": "int64"
|
|
3250
|
+
},
|
|
3251
|
+
"facets": {
|
|
3252
|
+
"type": "array",
|
|
3253
|
+
"items": {
|
|
3254
|
+
"type": "string"
|
|
3255
|
+
}
|
|
3256
|
+
},
|
|
3257
|
+
"fields": {
|
|
3258
|
+
"type": "array",
|
|
3259
|
+
"items": {
|
|
3260
|
+
"type": "string"
|
|
3261
|
+
}
|
|
3262
|
+
},
|
|
3263
|
+
"kind": {
|
|
3264
|
+
"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",
|
|
3265
|
+
"type": "string"
|
|
3266
|
+
},
|
|
3267
|
+
"labelSelector": {
|
|
3268
|
+
"description": "LabelSelector filters on metadata.labels, ANDed with Where.",
|
|
3269
|
+
"$ref": "#/components/schemas/LabelSelector"
|
|
3270
|
+
},
|
|
3271
|
+
"limit": {
|
|
3272
|
+
"description": "Limit is the page size. Zero uses the default; values above the maximum are clamped.",
|
|
3273
|
+
"type": "integer",
|
|
3274
|
+
"format": "int64"
|
|
3275
|
+
},
|
|
3276
|
+
"sort": {
|
|
3277
|
+
"type": "array",
|
|
3278
|
+
"items": {
|
|
3279
|
+
"$ref": "#/components/schemas/SortField"
|
|
3280
|
+
}
|
|
3281
|
+
},
|
|
3282
|
+
"where": {
|
|
3283
|
+
"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).",
|
|
3284
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
3285
|
+
}
|
|
3286
|
+
}
|
|
3287
|
+
},
|
|
3288
|
+
"SearchResults": {
|
|
3289
|
+
"description": "SearchResults is the response body for POST .../{resource}/search.",
|
|
3290
|
+
"type": "object",
|
|
3291
|
+
"required": ["metadata", "items"],
|
|
3292
|
+
"properties": {
|
|
3293
|
+
"apiVersion": {
|
|
3294
|
+
"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",
|
|
3295
|
+
"type": "string"
|
|
3296
|
+
},
|
|
3297
|
+
"facets": {
|
|
3298
|
+
"description": "Facets holds term counts per requested facet field. Counts are computed over a bounded sample window, so they are best-effort/approximate.",
|
|
3299
|
+
"type": "object",
|
|
3300
|
+
"additionalProperties": {
|
|
3301
|
+
"type": "array",
|
|
3302
|
+
"items": {
|
|
3303
|
+
"$ref": "#/components/schemas/FacetTerm"
|
|
3304
|
+
}
|
|
3305
|
+
}
|
|
3306
|
+
},
|
|
3307
|
+
"items": {
|
|
3308
|
+
"type": "array",
|
|
3309
|
+
"items": {
|
|
3310
|
+
"$ref": "#/components/schemas/ResultItem"
|
|
3311
|
+
}
|
|
3312
|
+
},
|
|
3313
|
+
"kind": {
|
|
3314
|
+
"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",
|
|
3315
|
+
"type": "string"
|
|
3316
|
+
},
|
|
3317
|
+
"metadata": {
|
|
3318
|
+
"default": {},
|
|
3319
|
+
"$ref": "#/components/schemas/ResultsMetadata"
|
|
3320
|
+
}
|
|
3321
|
+
}
|
|
3322
|
+
},
|
|
3323
|
+
"SortField": {
|
|
3324
|
+
"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.",
|
|
3325
|
+
"type": "object",
|
|
3326
|
+
"required": ["field"],
|
|
3327
|
+
"properties": {
|
|
3328
|
+
"direction": {
|
|
3329
|
+
"type": "string"
|
|
3330
|
+
},
|
|
3331
|
+
"field": {
|
|
3332
|
+
"type": "string",
|
|
3333
|
+
"default": ""
|
|
3334
|
+
}
|
|
3335
|
+
}
|
|
3336
|
+
},
|
|
3337
|
+
"TextPredicate": {
|
|
3338
|
+
"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\"]).",
|
|
3339
|
+
"type": "object",
|
|
3340
|
+
"required": ["value"],
|
|
3341
|
+
"properties": {
|
|
3342
|
+
"boost": {
|
|
3343
|
+
"description": "Boost is a future per-leaf score multiplier. Setting it is rejected in v1.",
|
|
3344
|
+
"type": "number",
|
|
3345
|
+
"format": "double"
|
|
3346
|
+
},
|
|
3347
|
+
"fields": {
|
|
3348
|
+
"type": "array",
|
|
3349
|
+
"items": {
|
|
3350
|
+
"type": "string"
|
|
3351
|
+
}
|
|
3352
|
+
},
|
|
3353
|
+
"value": {
|
|
3354
|
+
"type": "string",
|
|
3355
|
+
"default": ""
|
|
3356
|
+
}
|
|
3357
|
+
}
|
|
3358
|
+
},
|
|
3359
|
+
"TrashQuery": {
|
|
3360
|
+
"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.",
|
|
3361
|
+
"type": "object",
|
|
3362
|
+
"properties": {
|
|
3363
|
+
"apiVersion": {
|
|
3364
|
+
"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",
|
|
3365
|
+
"type": "string"
|
|
3366
|
+
},
|
|
3367
|
+
"continue": {
|
|
3368
|
+
"type": "string"
|
|
3369
|
+
},
|
|
3370
|
+
"fields": {
|
|
3371
|
+
"type": "array",
|
|
3372
|
+
"items": {
|
|
3373
|
+
"type": "string"
|
|
3374
|
+
}
|
|
3375
|
+
},
|
|
3376
|
+
"kind": {
|
|
3377
|
+
"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",
|
|
3378
|
+
"type": "string"
|
|
3379
|
+
},
|
|
3380
|
+
"limit": {
|
|
3381
|
+
"type": "integer",
|
|
3382
|
+
"format": "int64"
|
|
3383
|
+
},
|
|
3384
|
+
"sort": {
|
|
3385
|
+
"type": "array",
|
|
3386
|
+
"items": {
|
|
3387
|
+
"$ref": "#/components/schemas/SortField"
|
|
3388
|
+
}
|
|
3389
|
+
},
|
|
3390
|
+
"where": {
|
|
3391
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
3392
|
+
}
|
|
3393
|
+
}
|
|
3394
|
+
},
|
|
3395
|
+
"TrashResults": {
|
|
3396
|
+
"description": "TrashResults is the response body for POST .../{resource}/trash. It has the same item shape as SearchResults but never carries facets.",
|
|
3397
|
+
"type": "object",
|
|
3398
|
+
"required": ["metadata", "items"],
|
|
3399
|
+
"properties": {
|
|
3400
|
+
"apiVersion": {
|
|
3401
|
+
"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",
|
|
3402
|
+
"type": "string"
|
|
3403
|
+
},
|
|
3404
|
+
"items": {
|
|
3405
|
+
"type": "array",
|
|
3406
|
+
"items": {
|
|
3407
|
+
"$ref": "#/components/schemas/ResultItem"
|
|
3408
|
+
}
|
|
3409
|
+
},
|
|
3410
|
+
"kind": {
|
|
3411
|
+
"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",
|
|
3412
|
+
"type": "string"
|
|
3413
|
+
},
|
|
3414
|
+
"metadata": {
|
|
3415
|
+
"default": {},
|
|
3416
|
+
"$ref": "#/components/schemas/ResultsMetadata"
|
|
3417
|
+
}
|
|
3418
|
+
}
|
|
3419
|
+
},
|
|
3420
|
+
"WhereNode": {
|
|
3421
|
+
"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.",
|
|
3422
|
+
"type": "object",
|
|
3423
|
+
"properties": {
|
|
3424
|
+
"and": {
|
|
3425
|
+
"description": "Combinators.",
|
|
3426
|
+
"type": "array",
|
|
3427
|
+
"items": {
|
|
3428
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
3429
|
+
}
|
|
3430
|
+
},
|
|
3431
|
+
"exists": {
|
|
3432
|
+
"$ref": "#/components/schemas/ExistsPredicate"
|
|
3433
|
+
},
|
|
3434
|
+
"filter": {
|
|
3435
|
+
"$ref": "#/components/schemas/FilterPredicate"
|
|
3436
|
+
},
|
|
3437
|
+
"not": {
|
|
3438
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
3439
|
+
},
|
|
3440
|
+
"or": {
|
|
3441
|
+
"type": "array",
|
|
3442
|
+
"items": {
|
|
3443
|
+
"$ref": "#/components/schemas/WhereNode"
|
|
3444
|
+
}
|
|
3445
|
+
},
|
|
3446
|
+
"range": {
|
|
3447
|
+
"$ref": "#/components/schemas/RangePredicate"
|
|
3448
|
+
},
|
|
3449
|
+
"regex": {
|
|
3450
|
+
"$ref": "#/components/schemas/RegexPredicate"
|
|
3451
|
+
},
|
|
3452
|
+
"text": {
|
|
3453
|
+
"description": "Leaves.",
|
|
3454
|
+
"$ref": "#/components/schemas/TextPredicate"
|
|
3455
|
+
}
|
|
3456
|
+
}
|
|
3457
|
+
},
|
|
3458
|
+
"APIResource": {
|
|
3459
|
+
"description": "APIResource specifies the name of a resource and whether it is namespaced.",
|
|
3460
|
+
"type": "object",
|
|
3461
|
+
"required": ["name", "singularName", "namespaced", "kind", "verbs"],
|
|
3462
|
+
"properties": {
|
|
3463
|
+
"categories": {
|
|
3464
|
+
"description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
|
|
3465
|
+
"type": "array",
|
|
3466
|
+
"items": {
|
|
3467
|
+
"type": "string",
|
|
3468
|
+
"default": ""
|
|
3469
|
+
},
|
|
3470
|
+
"x-kubernetes-list-type": "atomic"
|
|
3471
|
+
},
|
|
3472
|
+
"group": {
|
|
3473
|
+
"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\".",
|
|
3474
|
+
"type": "string"
|
|
3475
|
+
},
|
|
3476
|
+
"kind": {
|
|
3477
|
+
"description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
|
|
3478
|
+
"type": "string",
|
|
3479
|
+
"default": ""
|
|
3480
|
+
},
|
|
3481
|
+
"name": {
|
|
3482
|
+
"description": "name is the plural name of the resource.",
|
|
3483
|
+
"type": "string",
|
|
3484
|
+
"default": ""
|
|
3485
|
+
},
|
|
2773
3486
|
"namespaced": {
|
|
2774
3487
|
"description": "namespaced indicates if a resource is namespaced or not.",
|
|
2775
3488
|
"type": "boolean",
|
|
@@ -2892,6 +3605,53 @@
|
|
|
2892
3605
|
"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",
|
|
2893
3606
|
"type": "object"
|
|
2894
3607
|
},
|
|
3608
|
+
"LabelSelector": {
|
|
3609
|
+
"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.",
|
|
3610
|
+
"type": "object",
|
|
3611
|
+
"properties": {
|
|
3612
|
+
"matchExpressions": {
|
|
3613
|
+
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
|
|
3614
|
+
"type": "array",
|
|
3615
|
+
"items": {
|
|
3616
|
+
"$ref": "#/components/schemas/LabelSelectorRequirement"
|
|
3617
|
+
},
|
|
3618
|
+
"x-kubernetes-list-type": "atomic"
|
|
3619
|
+
},
|
|
3620
|
+
"matchLabels": {
|
|
3621
|
+
"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.",
|
|
3622
|
+
"type": "object",
|
|
3623
|
+
"additionalProperties": {
|
|
3624
|
+
"type": "string"
|
|
3625
|
+
}
|
|
3626
|
+
}
|
|
3627
|
+
},
|
|
3628
|
+
"x-kubernetes-map-type": "atomic"
|
|
3629
|
+
},
|
|
3630
|
+
"LabelSelectorRequirement": {
|
|
3631
|
+
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
|
|
3632
|
+
"type": "object",
|
|
3633
|
+
"required": ["key", "operator"],
|
|
3634
|
+
"properties": {
|
|
3635
|
+
"key": {
|
|
3636
|
+
"description": "key is the label key that the selector applies to.",
|
|
3637
|
+
"type": "string",
|
|
3638
|
+
"default": ""
|
|
3639
|
+
},
|
|
3640
|
+
"operator": {
|
|
3641
|
+
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
|
|
3642
|
+
"type": "string",
|
|
3643
|
+
"default": ""
|
|
3644
|
+
},
|
|
3645
|
+
"values": {
|
|
3646
|
+
"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.",
|
|
3647
|
+
"type": "array",
|
|
3648
|
+
"items": {
|
|
3649
|
+
"type": "string"
|
|
3650
|
+
},
|
|
3651
|
+
"x-kubernetes-list-type": "atomic"
|
|
3652
|
+
}
|
|
3653
|
+
}
|
|
3654
|
+
},
|
|
2895
3655
|
"ListMeta": {
|
|
2896
3656
|
"description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
|
|
2897
3657
|
"type": "object",
|