@grafana/viz-contract 1.1.0

package/schemas/bundled/viz-spec.schema.json

@@ -0,0 +1,261 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Viz spec",
+  "description": "The JSON object that the App gives to the Renderer. The Renderer ignores fields that it does not know.",
+  "type": "object",
+  "required": [
+    "specVersion",
+    "panel",
+    "data"
+  ],
+  "properties": {
+    "specVersion": {
+      "const": 1,
+      "$comment": "Generated from registry/constants.json (specVersion). Do not edit."
+    },
+    "panel": {
+      "type": "object",
+      "description": "A Grafana panel JSON. type, options and fieldConfig come from the panel of the tool result. datasource and targets come from the tool arguments.",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "$ref": "#/$defs/tool-result.$defs.panelId"
+        },
+        "options": {
+          "type": "object"
+        },
+        "fieldConfig": {
+          "$ref": "#/$defs/tool-result.$defs.panel.properties.fieldConfig"
+        },
+        "datasource": {
+          "$ref": "#/$defs/datasourceRef"
+        },
+        "targets": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "refId"
+            ],
+            "properties": {
+              "refId": {
+                "type": "string"
+              },
+              "datasource": {
+                "$ref": "#/$defs/datasourceRef"
+              }
+            }
+          }
+        }
+      }
+    },
+    "data": {
+      "$ref": "#/$defs/tool-result.$defs.data"
+    },
+    "notices": {
+      "type": "array",
+      "description": "Notices of the App, for example chart-changed. The Renderer shows them with its own notices.",
+      "items": {
+        "type": "object",
+        "required": [
+          "code",
+          "message"
+        ],
+        "properties": {
+          "code": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "theme": {
+      "enum": [
+        "dark",
+        "light"
+      ],
+      "default": "dark"
+    },
+    "timeZone": {
+      "type": "string",
+      "default": "browser",
+      "description": "browser, utc, or an IANA time zone name, for example Europe/Paris."
+    },
+    "grafanaUrl": {
+      "type": "string",
+      "format": "uri",
+      "description": "The base URL of the Grafana that ran the query."
+    }
+  },
+  "$defs": {
+    "datasourceRef": {
+      "type": "object",
+      "required": [
+        "uid"
+      ],
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "uid": {
+          "type": "string"
+        }
+      }
+    },
+    "tool-result.$defs.panelId": {
+      "type": "string",
+      "$comment": "Generated from registry/panel-types.json. Do not edit.",
+      "enum": [
+        "grafana-echartscartesian-panel",
+        "grafana-echartsgeo-panel",
+        "grafana-echartsheatmap-panel",
+        "grafana-echartshierarchy-panel",
+        "grafana-echartsmultivariate-panel",
+        "grafana-echartsparttowhole-panel",
+        "grafana-relations-panel",
+        "grafana-echartsstatetimeline-panel",
+        "grafana-echartsstatushistory-panel",
+        "grafana-echartsstream-panel"
+      ]
+    },
+    "tool-result.$defs.panel.properties.fieldConfig": {
+      "type": "object",
+      "properties": {
+        "defaults": {
+          "type": "object",
+          "properties": {
+            "unit": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        "overrides": {
+          "type": "array"
+        }
+      }
+    },
+    "tool-result.$defs.data": {
+      "type": "object",
+      "required": [
+        "range",
+        "capturedAt",
+        "results"
+      ],
+      "properties": {
+        "range": {
+          "type": "object",
+          "description": "The absolute time range of the query, in epoch milliseconds.",
+          "required": [
+            "from",
+            "to"
+          ],
+          "properties": {
+            "from": {
+              "type": "integer"
+            },
+            "to": {
+              "type": "integer"
+            }
+          },
+          "additionalProperties": false
+        },
+        "capturedAt": {
+          "type": "integer",
+          "description": "The time when the response of /api/ds/query arrived, in epoch milliseconds."
+        },
+        "results": {
+          "$ref": "#/$defs/tool-result.$defs.results"
+        }
+      }
+    },
+    "tool-result.$defs.results": {
+      "type": "object",
+      "description": "The results object of the /api/ds/query response, with no change. The key is the refId.",
+      "minProperties": 1,
+      "additionalProperties": {
+        "type": "object",
+        "required": [
+          "status"
+        ],
+        "properties": {
+          "status": {
+            "type": "integer"
+          },
+          "frames": {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/tool-result.$defs.frame"
+            }
+          },
+          "error": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "tool-result.$defs.frame": {
+      "type": "object",
+      "description": "A frame in the DataFrameJSON format of the dataplane contract.",
+      "required": [
+        "schema"
+      ],
+      "properties": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "refId": {
+              "type": "string"
+            },
+            "meta": {
+              "type": "object"
+            },
+            "fields": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": [
+                  "name"
+                ],
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "type": {
+                    "type": "string"
+                  },
+                  "labels": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "type": "string"
+                    }
+                  },
+                  "config": {
+                    "type": "object"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "data": {
+          "type": "object",
+          "properties": {
+            "values": {
+              "type": "array",
+              "items": {
+                "type": "array"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "$comment": "Generated from schemas/viz-spec.schema.json. Do not edit."
+}