@intentius/chant-lexicon-grafana 0.97.0 → 0.99.0

package/src/spec/schemas/bargauge.jsonschema.json

@@ -0,0 +1,224 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "Options": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "displayMode",
+        "valueMode",
+        "namePlacement",
+        "showUnfilled",
+        "sizing",
+        "minVizWidth",
+        "minVizHeight",
+        "legend",
+        "reduceOptions",
+        "maxVizHeight",
+        "orientation"
+      ],
+      "properties": {
+        "displayMode": {
+          "$ref": "#/definitions/BarGaugeDisplayMode",
+          "default": "gradient"
+        },
+        "valueMode": {
+          "$ref": "#/definitions/BarGaugeValueMode",
+          "default": "color"
+        },
+        "namePlacement": {
+          "$ref": "#/definitions/BarGaugeNamePlacement",
+          "default": "auto"
+        },
+        "showUnfilled": {
+          "type": "boolean",
+          "default": true
+        },
+        "sizing": {
+          "$ref": "#/definitions/BarGaugeSizing",
+          "default": "auto"
+        },
+        "minVizWidth": {
+          "type": "integer",
+          "default": 8
+        },
+        "minVizHeight": {
+          "type": "integer",
+          "default": 16
+        },
+        "legend": {
+          "$ref": "#/definitions/VizLegendOptions"
+        },
+        "reduceOptions": {
+          "$ref": "#/definitions/ReduceDataOptions"
+        },
+        "text": {
+          "$ref": "#/definitions/VizTextDisplayOptions"
+        },
+        "maxVizHeight": {
+          "type": "integer",
+          "default": 300
+        },
+        "orientation": {
+          "$ref": "#/definitions/VizOrientation"
+        }
+      }
+    },
+    "BarGaugeDisplayMode": {
+      "enum": [
+        "basic",
+        "lcd",
+        "gradient"
+      ],
+      "type": "string",
+      "description": "Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI"
+    },
+    "BarGaugeValueMode": {
+      "enum": [
+        "color",
+        "text",
+        "hidden"
+      ],
+      "type": "string",
+      "description": "Allows for the table cell gauge display type to set the gauge mode."
+    },
+    "BarGaugeNamePlacement": {
+      "enum": [
+        "auto",
+        "top",
+        "left",
+        "hidden"
+      ],
+      "type": "string",
+      "description": "Allows for the bar gauge name to be placed explicitly"
+    },
+    "BarGaugeSizing": {
+      "enum": [
+        "auto",
+        "manual"
+      ],
+      "type": "string",
+      "description": "Allows for the bar gauge size to be set explicitly"
+    },
+    "VizLegendOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "displayMode",
+        "placement",
+        "showLegend",
+        "calcs"
+      ],
+      "properties": {
+        "displayMode": {
+          "$ref": "#/definitions/LegendDisplayMode",
+          "default": "list"
+        },
+        "placement": {
+          "$ref": "#/definitions/LegendPlacement",
+          "default": "bottom"
+        },
+        "showLegend": {
+          "type": "boolean"
+        },
+        "asTable": {
+          "type": "boolean"
+        },
+        "isVisible": {
+          "type": "boolean"
+        },
+        "sortBy": {
+          "type": "string"
+        },
+        "sortDesc": {
+          "type": "boolean"
+        },
+        "width": {
+          "type": "number"
+        },
+        "calcs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": []
+        }
+      },
+      "description": "TODO docs"
+    },
+    "ReduceDataOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "calcs"
+      ],
+      "properties": {
+        "values": {
+          "type": "boolean",
+          "description": "If true show each row value"
+        },
+        "limit": {
+          "type": "number",
+          "description": "if showing all values limit"
+        },
+        "calcs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "When !values, pick one value for the whole field"
+        },
+        "fields": {
+          "type": "string",
+          "description": "Which fields to show.  By default this is only numeric fields"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "VizTextDisplayOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "titleSize": {
+          "type": "number",
+          "description": "Explicit title text size"
+        },
+        "valueSize": {
+          "type": "number",
+          "description": "Explicit value text size"
+        },
+        "percentSize": {
+          "type": "number",
+          "description": "Explicit percent text size"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "VizOrientation": {
+      "enum": [
+        "auto",
+        "vertical",
+        "horizontal"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "LegendDisplayMode": {
+      "enum": [
+        "list",
+        "table",
+        "hidden"
+      ],
+      "type": "string",
+      "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility"
+    },
+    "LegendPlacement": {
+      "enum": [
+        "bottom",
+        "right"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    }
+  }
+}

package/src/spec/schemas/canvas.jsonschema.json

@@ -0,0 +1,356 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "HorizontalConstraint": {
+      "enum": [
+        "left",
+        "right",
+        "leftright",
+        "center",
+        "scale"
+      ],
+      "type": "string"
+    },
+    "VerticalConstraint": {
+      "enum": [
+        "top",
+        "bottom",
+        "topbottom",
+        "center",
+        "scale"
+      ],
+      "type": "string"
+    },
+    "Constraint": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "horizontal": {
+          "$ref": "#/definitions/HorizontalConstraint"
+        },
+        "vertical": {
+          "$ref": "#/definitions/VerticalConstraint"
+        }
+      }
+    },
+    "Placement": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "top": {
+          "type": "number"
+        },
+        "left": {
+          "type": "number"
+        },
+        "right": {
+          "type": "number"
+        },
+        "bottom": {
+          "type": "number"
+        },
+        "width": {
+          "type": "number"
+        },
+        "height": {
+          "type": "number"
+        },
+        "rotation": {
+          "type": "number"
+        }
+      }
+    },
+    "BackgroundImageSize": {
+      "enum": [
+        "original",
+        "contain",
+        "cover",
+        "fill",
+        "tile"
+      ],
+      "type": "string"
+    },
+    "BackgroundConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "color": {
+          "$ref": "#/definitions/ColorDimensionConfig"
+        },
+        "image": {
+          "$ref": "#/definitions/ResourceDimensionConfig"
+        },
+        "size": {
+          "$ref": "#/definitions/BackgroundImageSize"
+        }
+      }
+    },
+    "LineConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "color": {
+          "$ref": "#/definitions/ColorDimensionConfig"
+        },
+        "width": {
+          "type": "number"
+        },
+        "radius": {
+          "type": "number"
+        }
+      }
+    },
+    "HttpRequestMethod": {
+      "enum": [
+        "GET",
+        "POST",
+        "PUT"
+      ],
+      "type": "string"
+    },
+    "ConnectionCoordinates": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "x",
+        "y"
+      ],
+      "properties": {
+        "x": {
+          "type": "number"
+        },
+        "y": {
+          "type": "number"
+        }
+      }
+    },
+    "ConnectionPath": {
+      "enum": [
+        "straight"
+      ],
+      "type": "string"
+    },
+    "CanvasConnection": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "source",
+        "target",
+        "path"
+      ],
+      "properties": {
+        "source": {
+          "$ref": "#/definitions/ConnectionCoordinates"
+        },
+        "target": {
+          "$ref": "#/definitions/ConnectionCoordinates"
+        },
+        "targetName": {
+          "type": "string"
+        },
+        "path": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/ConnectionPath"
+            }
+          ],
+          "default": "straight"
+        },
+        "color": {
+          "$ref": "#/definitions/ColorDimensionConfig"
+        },
+        "size": {
+          "$ref": "#/definitions/ScaleDimensionConfig"
+        },
+        "vertices": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ConnectionCoordinates"
+          }
+        },
+        "sourceOriginal": {
+          "$ref": "#/definitions/ConnectionCoordinates"
+        },
+        "targetOriginal": {
+          "$ref": "#/definitions/ConnectionCoordinates"
+        }
+      }
+    },
+    "CanvasElementOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "type"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "config": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "TODO: figure out how to define this (element config(s))"
+        },
+        "constraint": {
+          "$ref": "#/definitions/Constraint"
+        },
+        "placement": {
+          "$ref": "#/definitions/Placement"
+        },
+        "background": {
+          "$ref": "#/definitions/BackgroundConfig"
+        },
+        "border": {
+          "$ref": "#/definitions/LineConfig"
+        },
+        "connections": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CanvasConnection"
+          }
+        }
+      }
+    },
+    "Options": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "inlineEditing",
+        "showAdvancedTypes",
+        "panZoom",
+        "infinitePan",
+        "root"
+      ],
+      "properties": {
+        "inlineEditing": {
+          "type": "boolean",
+          "description": "Enable inline editing",
+          "default": true
+        },
+        "showAdvancedTypes": {
+          "type": "boolean",
+          "description": "Show all available element types",
+          "default": true
+        },
+        "panZoom": {
+          "type": "boolean",
+          "description": "Enable pan and zoom",
+          "default": true
+        },
+        "infinitePan": {
+          "type": "boolean",
+          "description": "Enable infinite pan",
+          "default": true
+        },
+        "root": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "name",
+            "type",
+            "elements"
+          ],
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Name of the root element"
+            },
+            "type": {
+              "type": "string",
+              "const": "frame",
+              "description": "Type of root element (frame)"
+            },
+            "elements": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/CanvasElementOptions"
+              },
+              "description": "The list of canvas elements attached to the root element"
+            }
+          },
+          "description": "The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this"
+        }
+      }
+    },
+    "ColorDimensionConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "fixed": {
+          "type": "string",
+          "description": "color value"
+        },
+        "field": {
+          "type": "string",
+          "description": "fixed: T -- will be added by each element"
+        }
+      }
+    },
+    "ResourceDimensionConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mode"
+      ],
+      "properties": {
+        "mode": {
+          "$ref": "#/definitions/ResourceDimensionMode"
+        },
+        "field": {
+          "type": "string",
+          "description": "fixed: T -- will be added by each element"
+        },
+        "fixed": {
+          "type": "string"
+        }
+      },
+      "description": "Links to a resource (image/svg path)"
+    },
+    "ScaleDimensionConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "min",
+        "max"
+      ],
+      "properties": {
+        "min": {
+          "type": "number"
+        },
+        "max": {
+          "type": "number"
+        },
+        "fixed": {
+          "type": "number"
+        },
+        "field": {
+          "type": "string",
+          "description": "fixed: T -- will be added by each element"
+        },
+        "mode": {
+          "$ref": "#/definitions/ScaleDimensionMode",
+          "description": "| *\"linear\""
+        }
+      }
+    },
+    "ResourceDimensionMode": {
+      "enum": [
+        "fixed",
+        "field",
+        "mapping"
+      ],
+      "type": "string"
+    },
+    "ScaleDimensionMode": {
+      "enum": [
+        "linear",
+        "quad"
+      ],
+      "type": "string"
+    }
+  }
+}