json.schema.api.tests.createCustomMetric.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/api/tests/customMetric.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateCustomMetricRequest",
  "description": "Custom Metric definition that we will associate with a column.",
  "type": "object",
  "properties": {
    "description": {
      "description": "Description of the custom metric.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "name": {
      "description": "Name that identifies this Custom Metric.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "columnName": {
      "description": "Name of the column in a table.",
      "type": "string"
    },
    "expression": {
      "description": "SQL expression to compute the Metric. It should return a single numerical value.",
      "type": "string"
    },
    "owners": {
      "description": "Owners of this Pipeline.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "updatedAt": {
      "description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
      "$ref": "../../type/basic.json#/definitions/timestamp"
    },
    "updatedBy": {
      "description": "User who made the update.",
      "type": "string"
    }
  },
  "required": ["name", "expression"],
  "additionalProperties": false
}