json.schema.api.dataInsight.custom.createDataInsightCustomChart.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/dataInsight/custom/CreateDataInsightCustomChart.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateDataInsightCustomChart",
  "description": "Payload to create a data insight custom chart",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.dataInsight.custom.CreateDataInsightCustomChart",
  "javaInterfaces": [
    "org.openmetadata.schema.CreateEntity"
  ],
  "properties": {
    "name": {
      "description": "Name that identifies this data insight chart.",
      "$ref": "../../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name the data insight chart.",
      "type": "string"
    },
    "description": {
      "description": "Description of the data insight chart.",
      "$ref": "../../../type/basic.json#/definitions/markdown"
    },
    "chartType": {
      "description": "Type of chart, used for UI to render the chart",
      "type": "string",
      "enum": [
        "LineChart",
        "AreaChart",
        "BarChart",
        "SummaryCard"
      ]
    },
    "chartDetails": {
      "oneOf": [
        {
          "$ref": "../../../dataInsight/custom/lineChart.json"
        },
        {
          "$ref": "../../../dataInsight/custom/summaryCard.json"
        }
      ]
    },
    "owner": {
      "description": "Owner of this chart",
      "$ref": "../../../type/entityReference.json"
    },
    "dashboard": {
      "description": "Dashboard where this chart is displayed",
      "$ref": "../../../type/entityReference.json"
    }
  },
  "required": [
    "name",
    "chartDetails"
  ],
  "additionalProperties": false
}