@intentius/chant-lexicon-grafana 0.98.0 → 0.100.0

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

@@ -0,0 +1,290 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Dataquery",
+  "definitions": {
+    "Dataquery": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "format",
+        "rawSql"
+      ],
+      "properties": {
+        "dataset": {
+          "type": "string"
+        },
+        "table": {
+          "type": "string"
+        },
+        "project": {
+          "type": "string"
+        },
+        "format": {
+          "$ref": "#/definitions/QueryFormat"
+        },
+        "rawQuery": {
+          "type": "boolean"
+        },
+        "rawSql": {
+          "type": "string"
+        },
+        "location": {
+          "type": "string"
+        },
+        "partitioned": {
+          "type": "boolean"
+        },
+        "partitionedField": {
+          "type": "string"
+        },
+        "convertToUTC": {
+          "type": "boolean"
+        },
+        "sharded": {
+          "type": "boolean"
+        },
+        "queryPriority": {
+          "$ref": "#/definitions/QueryPriority"
+        },
+        "timeShift": {
+          "type": "string"
+        },
+        "editorMode": {
+          "$ref": "#/definitions/EditorMode"
+        },
+        "sql": {
+          "$ref": "#/definitions/SQLExpression"
+        },
+        "refId": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful."
+        },
+        "hide": {
+          "type": "boolean",
+          "description": "If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel."
+        },
+        "queryType": {
+          "type": "string",
+          "description": "Specify the query flavor\nTODO make this required and give it a default"
+        },
+        "datasource": {
+          "$ref": "#/definitions/DataSourceRef",
+          "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null"
+        }
+      },
+      "description": "Manually converted from https://github.com/grafana/google-bigquery-datasource/blob/18680e42ba557791d109c7c540c2c3f2647592f0/src/types.ts#L75"
+    },
+    "QueryFormat": {
+      "enum": [
+        0,
+        1
+      ],
+      "type": "integer"
+    },
+    "QueryPriority": {
+      "enum": [
+        "INTERACTIVE",
+        "BATCH"
+      ],
+      "type": "string"
+    },
+    "EditorMode": {
+      "enum": [
+        "code",
+        "builder"
+      ],
+      "type": "string"
+    },
+    "SQLExpression": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "columns": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/QueryEditorFunctionExpression"
+          }
+        },
+        "from": {
+          "type": "string"
+        },
+        "whereString": {
+          "type": "string",
+          "description": "whereJsonTree?: _"
+        },
+        "groupBy": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/QueryEditorGroupByExpression"
+          }
+        },
+        "orderBy": {
+          "$ref": "#/definitions/QueryEditorPropertyExpression"
+        },
+        "orderByDirection": {
+          "$ref": "#/definitions/OrderByDirection"
+        },
+        "limit": {
+          "type": "integer"
+        },
+        "offset": {
+          "type": "integer"
+        }
+      }
+    },
+    "QueryEditorFunctionExpression": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/QueryEditorExpressionType"
+            }
+          ],
+          "default": "function"
+        },
+        "name": {
+          "type": "string"
+        },
+        "parameters": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/QueryEditorFunctionParameterExpression"
+          }
+        }
+      }
+    },
+    "QueryEditorExpressionType": {
+      "enum": [
+        "property",
+        "operator",
+        "or",
+        "and",
+        "groupBy",
+        "function",
+        "functionParameter"
+      ],
+      "type": "string"
+    },
+    "QueryEditorFunctionParameterExpression": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/QueryEditorExpressionType"
+            }
+          ],
+          "default": "functionParameter"
+        },
+        "name": {
+          "type": "string"
+        }
+      }
+    },
+    "QueryEditorGroupByExpression": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "property"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/QueryEditorExpressionType"
+            }
+          ],
+          "default": "groupBy"
+        },
+        "property": {
+          "$ref": "#/definitions/QueryEditorProperty"
+        }
+      }
+    },
+    "QueryEditorProperty": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/QueryEditorPropertyType"
+            }
+          ],
+          "default": "string"
+        },
+        "name": {
+          "type": "string"
+        }
+      }
+    },
+    "QueryEditorPropertyType": {
+      "enum": [
+        "string"
+      ],
+      "type": "string"
+    },
+    "QueryEditorPropertyExpression": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "property"
+      ],
+      "properties": {
+        "type": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/QueryEditorExpressionType"
+            }
+          ],
+          "default": "property"
+        },
+        "property": {
+          "$ref": "#/definitions/QueryEditorProperty"
+        }
+      }
+    },
+    "OrderByDirection": {
+      "enum": [
+        "ASC",
+        "DESC"
+      ],
+      "type": "string"
+    },
+    "DataSourceRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The plugin type-id"
+        },
+        "uid": {
+          "type": "string",
+          "description": "Specific datasource instance"
+        }
+      }
+    }
+  }
+}

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"
+    }
+  }
+}