json.schema.dataInsight.kpi.basic.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/dataInsight/kpi/basic.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Basic",
  "description": "This schema defines basic types that are used by other Kpi Definitions",
  "definitions": {
    "kpiTargetType": {
      "javaType": "org.openmetadata.schema.dataInsight.type.KpiTargetType",
      "description": "This enum defines the type of key Result",
      "type": "string",
      "enum": [
        "NUMBER",
        "PERCENTAGE"
      ]
    },
    "kpiTarget": {
      "type": "object",
      "javaType": "org.openmetadata.schema.dataInsight.type.KpiTarget",
      "description": "This schema defines the parameter values that can be passed for a Kpi Parameter.",
      "properties": {
        "name": {
          "description": "name of the parameter. Must match the parameter names in metrics of the chart this objective refers",
          "type": "string"
        },
        "value": {
          "description": "value to be passed for the Parameters. These are input from Users. We capture this in string and convert during the runtime.",
          "type": "string"
        },
        "targetMet": {
          "description": "whether the target value was met or not.",
          "type": "boolean"
        }
      },
      "required": ["name", "value"],
      "additionalProperties": false
    },
    "kpiResult": {
      "description": "Schema to capture kpi result.",
      "javaType": "org.openmetadata.schema.dataInsight.type.KpiResult",
      "type": "object",
      "properties": {
        "timestamp": {
          "description": "Data one which result is updated",
          "$ref": "../../type/basic.json#/definitions/timestamp"
        },
        "kpiFqn": {
          "description": "KPI FQN",
          "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
        },
        "targetResult": {
          "description": "Metric and their corresponding current results",
          "type": "array",
          "items": {
            "$ref": "#/definitions/kpiTarget"
          }
        }
      },
      "required": ["timestamp", "targetResult"],
      "additionalProperties": false
    }
  }
}