@grafana/viz-contract 1.1.0 → 1.3.0

package/fixtures/title/state.json

@@ -0,0 +1,4 @@
+{
+  "state": "ready",
+  "notices": []
+}

package/fixtures/too-large/args.json

@@ -8,7 +8,7 @@
       "format": "time_series"
     }
   ],
-  "from": "now-24h",
+  "from": "now-15m",
   "to": "now",
   "unit": "reqps"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/viz-contract",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Contract between a Grafana query source, the host that shows the chart, and the Renderer",
   "license": "Apache-2.0",
   "repository": {

package/registry/constants.json

@@ -9,6 +9,7 @@
   "maxBundleGzipBytes":   { "value": null, "unit": "bytes", "meaning": "Largest gzip size of the Renderer bundle. Not set until the host size research is done", "changeable": true },
   "maxAppNotes":          { "value": 5, "unit": "notes", "meaning": "Most notes of the Source that render_grafana_app adds to its text line", "changeable": true },
   "maxAppNoteChars":      { "value": 200, "unit": "characters", "meaning": "Longest note in the text line of render_grafana_app", "changeable": true },
+  "maxTitleChars":        { "value": 100, "unit": "characters", "meaning": "Longest title of the tool arguments", "changeable": true },
   "deprecationDays":      { "value": 30, "unit": "days", "meaning": "Shortest deprecation period of a change to a frozen interface", "changeable": true },
   "specVersion":          { "value": 1, "unit": "version", "meaning": "The viz spec version that this contract gives" }
 }

package/registry/notices.json

@@ -16,7 +16,7 @@
       "code": "series-truncated",
       "raisedBy": "renderer",
       "when": "The frames have more series than maxSeries",
-      "message": "<omitted> series with the smallest peak values are not shown."
+      "message": "<omitted> series are not shown. The first <maxSeries> series are drawn."
     },
     {
       "code": "chart-changed",

package/schemas/bundled/query-datasource-args.schema.json

@@ -79,6 +79,13 @@
       "type": "string",
       "minLength": 1,
       "description": "Optional Grafana unit ID for all values, for example bytes, percent or reqps."
+    },
+    "title": {
+      "type": "string",
+      "pattern": "\\S",
+      "maxLength": 100,
+      "$comment": "Generated from registry/constants.json (maxTitleChars). Do not edit.",
+      "description": "Optional title of the chart, for example HTTP requests by handler. The chart shows it as a panel title."
     }
   },
   "additionalProperties": false,

package/schemas/bundled/tool-result.schema.json

@@ -66,7 +66,7 @@
     },
     "panel": {
       "type": "object",
-      "description": "The panel ID and the options preset of the chart, and the unit of the tool arguments.",
+      "description": "The panel ID and the options preset of the chart, and the unit and the title of the tool arguments.",
       "required": [
         "type",
         "options"
@@ -75,6 +75,13 @@
         "type": {
           "$ref": "#/$defs/panelId"
         },
+        "title": {
+          "type": "string",
+          "pattern": "\\S",
+          "maxLength": 100,
+          "$comment": "Generated from registry/constants.json (maxTitleChars). Do not edit.",
+          "description": "The title of the tool arguments."
+        },
         "options": {
           "type": "object"
         },

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

@@ -15,7 +15,7 @@
     },
     "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.",
+      "description": "A Grafana panel JSON. type, title, options and fieldConfig come from the panel of the tool result. datasource and targets come from the tool arguments.",
       "required": [
         "type"
       ],
@@ -23,6 +23,9 @@
         "type": {
           "$ref": "#/$defs/tool-result.$defs.panelId"
         },
+        "title": {
+          "$ref": "#/$defs/tool-result.$defs.panel.properties.title"
+        },
         "options": {
           "type": "object"
         },
@@ -123,6 +126,13 @@
         "grafana-echartsstream-panel"
       ]
     },
+    "tool-result.$defs.panel.properties.title": {
+      "type": "string",
+      "pattern": "\\S",
+      "maxLength": 100,
+      "$comment": "Generated from registry/constants.json (maxTitleChars). Do not edit.",
+      "description": "The title of the tool arguments."
+    },
     "tool-result.$defs.panel.properties.fieldConfig": {
       "type": "object",
       "properties": {