@grafana/openapi 13.2.0-28985753600 → 13.2.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.
@@ -23111,6 +23111,9 @@
23111
23111
  "404": {
23112
23112
  "$ref": "#/components/responses/notFoundError"
23113
23113
  },
23114
+ "409": {
23115
+ "$ref": "#/components/responses/conflictError"
23116
+ },
23114
23117
  "500": {
23115
23118
  "$ref": "#/components/responses/internalServerError"
23116
23119
  }
@@ -1949,6 +1949,44 @@
1949
1949
  }
1950
1950
  },
1951
1951
  "parameters": []
1952
+ },
1953
+ "/translations": {
1954
+ "get": {
1955
+ "operationId": "getTranslations",
1956
+ "responses": {
1957
+ "200": {
1958
+ "description": "OK",
1959
+ "content": {
1960
+ "application/json": {
1961
+ "schema": {
1962
+ "$ref": "#/components/schemas/GetTranslationsResponse"
1963
+ }
1964
+ },
1965
+ "application/json;stream=watch": {
1966
+ "schema": {
1967
+ "$ref": "#/components/schemas/GetTranslationsResponse"
1968
+ }
1969
+ },
1970
+ "application/yaml": {
1971
+ "schema": {
1972
+ "$ref": "#/components/schemas/GetTranslationsResponse"
1973
+ }
1974
+ }
1975
+ }
1976
+ }
1977
+ }
1978
+ },
1979
+ "parameters": [
1980
+ {
1981
+ "name": "lang",
1982
+ "in": "query",
1983
+ "description": "BCP 47 locale (e.g. \"es-ES\"). Defaults to \"en-US\" server-side if empty.",
1984
+ "schema": {
1985
+ "type": "string",
1986
+ "uniqueItems": true
1987
+ }
1988
+ }
1989
+ ]
1952
1990
  }
1953
1991
  },
1954
1992
  "components": {
@@ -1996,6 +2034,10 @@
1996
2034
  "description": "Human readable error message",
1997
2035
  "type": "string"
1998
2036
  },
2037
+ "messageKey": {
2038
+ "description": "i18n key for the message (e.g. \"advisor.link.fix-me\"), so the\nfrontend can translate without deriving the key from the text",
2039
+ "type": "string"
2040
+ },
1999
2041
  "url": {
2000
2042
  "description": "URL to a page with more information about the error",
2001
2043
  "type": "string"
@@ -2326,6 +2368,27 @@
2326
2368
  }
2327
2369
  }
2328
2370
  },
2371
+ "GetTranslationsResponse": {
2372
+ "type": "object",
2373
+ "required": ["translations", "apiVersion", "kind"],
2374
+ "properties": {
2375
+ "apiVersion": {
2376
+ "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",
2377
+ "type": "string"
2378
+ },
2379
+ "kind": {
2380
+ "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",
2381
+ "type": "string"
2382
+ },
2383
+ "translations": {
2384
+ "description": "Flat map of i18n key -> translated string for the requested locale.",
2385
+ "type": "object",
2386
+ "additionalProperties": {
2387
+ "type": "string"
2388
+ }
2389
+ }
2390
+ }
2391
+ },
2329
2392
  "APIResource": {
2330
2393
  "description": "APIResource specifies the name of a resource and whether it is namespaced.",
2331
2394
  "type": "object",
@@ -229,6 +229,162 @@
229
229
  "kind": "Correlation"
230
230
  }
231
231
  },
232
+ "delete": {
233
+ "tags": ["Correlation"],
234
+ "description": "delete collection of Correlation",
235
+ "operationId": "deletecollectionCorrelation",
236
+ "parameters": [
237
+ {
238
+ "name": "continue",
239
+ "in": "query",
240
+ "description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
241
+ "schema": {
242
+ "type": "string",
243
+ "uniqueItems": true
244
+ }
245
+ },
246
+ {
247
+ "name": "dryRun",
248
+ "in": "query",
249
+ "description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
250
+ "schema": {
251
+ "type": "string",
252
+ "uniqueItems": true
253
+ }
254
+ },
255
+ {
256
+ "name": "fieldSelector",
257
+ "in": "query",
258
+ "description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
259
+ "schema": {
260
+ "type": "string",
261
+ "uniqueItems": true
262
+ }
263
+ },
264
+ {
265
+ "name": "gracePeriodSeconds",
266
+ "in": "query",
267
+ "description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
268
+ "schema": {
269
+ "type": "integer",
270
+ "uniqueItems": true
271
+ }
272
+ },
273
+ {
274
+ "name": "ignoreStoreReadErrorWithClusterBreakingPotential",
275
+ "in": "query",
276
+ "description": "if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it",
277
+ "schema": {
278
+ "type": "boolean",
279
+ "uniqueItems": true
280
+ }
281
+ },
282
+ {
283
+ "name": "labelSelector",
284
+ "in": "query",
285
+ "description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
286
+ "schema": {
287
+ "type": "string",
288
+ "uniqueItems": true
289
+ }
290
+ },
291
+ {
292
+ "name": "limit",
293
+ "in": "query",
294
+ "description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
295
+ "schema": {
296
+ "type": "integer",
297
+ "uniqueItems": true
298
+ }
299
+ },
300
+ {
301
+ "name": "orphanDependents",
302
+ "in": "query",
303
+ "description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
304
+ "schema": {
305
+ "type": "boolean",
306
+ "uniqueItems": true
307
+ }
308
+ },
309
+ {
310
+ "name": "propagationPolicy",
311
+ "in": "query",
312
+ "description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
313
+ "schema": {
314
+ "type": "string",
315
+ "uniqueItems": true
316
+ }
317
+ },
318
+ {
319
+ "name": "resourceVersion",
320
+ "in": "query",
321
+ "description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
322
+ "schema": {
323
+ "type": "string",
324
+ "uniqueItems": true
325
+ }
326
+ },
327
+ {
328
+ "name": "resourceVersionMatch",
329
+ "in": "query",
330
+ "description": "resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
331
+ "schema": {
332
+ "type": "string",
333
+ "uniqueItems": true
334
+ }
335
+ },
336
+ {
337
+ "name": "sendInitialEvents",
338
+ "in": "query",
339
+ "description": "`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
340
+ "schema": {
341
+ "type": "boolean",
342
+ "uniqueItems": true
343
+ }
344
+ },
345
+ {
346
+ "name": "shardSelector",
347
+ "in": "query",
348
+ "description": "shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges:\n\n shardRange(object.metadata.uid, '0x0', '0x8000000000000000')\n shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')\n\nField paths use CEL-style object-rooted syntax (e.g. \"object.metadata.uid\"), NOT the fieldSelector format (\"metadata.uid\"). Currently supported paths:\n - object.metadata.uid\n - object.metadata.namespace\n\nhexStart and hexEnd are single-quoted CEL string literals with a '0x' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64.\n\nExamples:\n 2-shard split:\n shard 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x8000000000000000')\n shard 1: shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000')\n 4-shard split:\n shard 0: shardRange(object.metadata.uid, '0x0000000000000000', '0x4000000000000000')\n shard 1: shardRange(object.metadata.uid, '0x4000000000000000', '0x8000000000000000')\n shard 2: shardRange(object.metadata.uid, '0x8000000000000000', '0xc000000000000000')\n shard 3: shardRange(object.metadata.uid, '0xc000000000000000', '0x10000000000000000')\n\nThis is an alpha field and requires enabling the ShardedListAndWatch feature gate.",
349
+ "schema": {
350
+ "type": "string",
351
+ "uniqueItems": true
352
+ }
353
+ },
354
+ {
355
+ "name": "timeoutSeconds",
356
+ "in": "query",
357
+ "description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
358
+ "schema": {
359
+ "type": "integer",
360
+ "uniqueItems": true
361
+ }
362
+ }
363
+ ],
364
+ "responses": {
365
+ "200": {
366
+ "description": "OK",
367
+ "content": {
368
+ "application/json": {
369
+ "schema": {
370
+ "$ref": "#/components/schemas/Status"
371
+ }
372
+ },
373
+ "application/yaml": {
374
+ "schema": {
375
+ "$ref": "#/components/schemas/Status"
376
+ }
377
+ }
378
+ }
379
+ }
380
+ },
381
+ "x-kubernetes-action": "deletecollection",
382
+ "x-kubernetes-group-version-kind": {
383
+ "group": "correlations.grafana.app",
384
+ "version": "v0alpha1",
385
+ "kind": "Correlation"
386
+ }
387
+ },
232
388
  "parameters": [
233
389
  {
234
390
  "name": "pretty",
@@ -971,8 +971,8 @@
971
971
  "description": "Panel IDs that should be included or excluded",
972
972
  "type": "array",
973
973
  "items": {
974
- "type": "integer",
975
- "format": "int64",
974
+ "type": "number",
975
+ "format": "double",
976
976
  "default": 0
977
977
  }
978
978
  }
@@ -2549,7 +2549,7 @@
2549
2549
  },
2550
2550
  "DashboardPanelSpec": {
2551
2551
  "type": "object",
2552
- "required": ["id", "title", "description", "links", "data", "vizConfig"],
2552
+ "required": ["id", "title", "links", "data", "vizConfig"],
2553
2553
  "properties": {
2554
2554
  "data": {
2555
2555
  "default": {},
@@ -2560,8 +2560,8 @@
2560
2560
  ]
2561
2561
  },
2562
2562
  "description": {
2563
- "type": "string",
2564
- "default": ""
2563
+ "description": "Shown in a info icon tooltip next to panel title",
2564
+ "type": "string"
2565
2565
  },
2566
2566
  "id": {
2567
2567
  "type": "number",
@@ -2579,6 +2579,10 @@
2579
2579
  ]
2580
2580
  }
2581
2581
  },
2582
+ "subtitle": {
2583
+ "description": "Shown in a sub header below the title.",
2584
+ "type": "string"
2585
+ },
2582
2586
  "title": {
2583
2587
  "type": "string",
2584
2588
  "default": ""
@@ -2692,6 +2696,9 @@
2692
2696
  },
2693
2697
  "timeShift": {
2694
2698
  "type": "string"
2699
+ },
2700
+ "timeTo": {
2701
+ "type": "string"
2695
2702
  }
2696
2703
  }
2697
2704
  },
@@ -3410,6 +3417,10 @@
3410
3417
  "description": "Value null means -Infinity",
3411
3418
  "type": "number",
3412
3419
  "format": "double"
3420
+ },
3421
+ "valueExpr": {
3422
+ "description": "Optional dashboard-variable expression (e.g. `$myVar`) resolved at render time; `value` is the numeric fallback when the expression cannot be resolved to a single finite number.",
3423
+ "type": "string"
3413
3424
  }
3414
3425
  }
3415
3426
  },
@@ -957,8 +957,8 @@
957
957
  "description": "Panel IDs that should be included or excluded",
958
958
  "type": "array",
959
959
  "items": {
960
- "type": "integer",
961
- "format": "int64",
960
+ "type": "number",
961
+ "format": "double",
962
962
  "default": 0
963
963
  }
964
964
  }
@@ -2494,7 +2494,7 @@
2494
2494
  },
2495
2495
  "DashboardPanelSpec": {
2496
2496
  "type": "object",
2497
- "required": ["id", "title", "description", "links", "data", "vizConfig"],
2497
+ "required": ["id", "title", "links", "data", "vizConfig"],
2498
2498
  "properties": {
2499
2499
  "data": {
2500
2500
  "default": {},
@@ -2505,8 +2505,8 @@
2505
2505
  ]
2506
2506
  },
2507
2507
  "description": {
2508
- "type": "string",
2509
- "default": ""
2508
+ "description": "Shown in a info icon tooltip next to panel title",
2509
+ "type": "string"
2510
2510
  },
2511
2511
  "id": {
2512
2512
  "type": "number",
@@ -2524,6 +2524,10 @@
2524
2524
  ]
2525
2525
  }
2526
2526
  },
2527
+ "subtitle": {
2528
+ "description": "Shown in a sub header below the title.",
2529
+ "type": "string"
2530
+ },
2527
2531
  "title": {
2528
2532
  "type": "string",
2529
2533
  "default": ""
@@ -2615,6 +2619,9 @@
2615
2619
  "type": "integer",
2616
2620
  "format": "int64"
2617
2621
  },
2622
+ "timeCompare": {
2623
+ "type": "string"
2624
+ },
2618
2625
  "timeFrom": {
2619
2626
  "type": "string"
2620
2627
  },
@@ -3318,6 +3325,10 @@
3318
3325
  "description": "Value null means -Infinity",
3319
3326
  "type": "number",
3320
3327
  "format": "double"
3328
+ },
3329
+ "valueExpr": {
3330
+ "description": "Optional dashboard-variable expression (e.g. `$myVar`) resolved at render time; `value` is the numeric fallback when the expression cannot be resolved to a single finite number.",
3331
+ "type": "string"
3321
3332
  }
3322
3333
  }
3323
3334
  },