json.schema.dataInsight.custom.dataInsightCustomChart.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/custom/dataInsightCustomChart.json",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Chart",
    "description": "DI Chart Entity",
    "type": "object",
    "javaType": "org.openmetadata.schema.dataInsight.custom.DataInsightCustomChart",
    "javaInterfaces": [
        "org.openmetadata.schema.EntityInterface"
    ],
    "definitions": {
        "function": {
            "javaType": "org.openmetadata.schema.dataInsight.custom.Function",
            "description": "aggregation function for chart",
            "type": "string",
            "enum": [
                "count",
                "sum",
                "avg",
                "min",
                "max",
                "unique"
            ]
        },
        "kpiDetails": {
            "type": "object",
            "javaType": "org.openmetadata.schema.dataInsight.custom.KPIDetails",
            "description": "KPI details for the data insight chart.",
            "properties": {
                "startDate": {
                    "description": "Start Date of KPI",
                    "type": "string"
                },
                "endDate": {
                    "description": "End Date of KPI",
                    "type": "string"
                },
                "target": {
                    "description": "Target value of KPI",
                    "type": "number"
                }
            }
        }
    },
    "properties": {
        "id": {
            "description": "Unique identifier of this table instance.",
            "$ref": "../../type/basic.json#/definitions/uuid"
        },
        "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"
        },
        "fullyQualifiedName": {
            "description": "FullyQualifiedName same as `name`.",
            "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
        },
        "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": "lineChart.json"
                },
                {
                    "$ref": "summaryCard.json"
                }
            ]
        },
        "isSystemChart": {
            "description": "Flag to indicate if the chart is system generated or user created.",
            "type": "boolean",
            "default": false
        },
        "owner": {
            "description": "Owner of this chart",
            "$ref": "../../type/entityReference.json"
        },
        "version": {
            "description": "Metadata version of the entity.",
            "$ref": "../../type/entityHistory.json#/definitions/entityVersion"
        },
        "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"
        },
        "href": {
            "description": "Link to the resource corresponding to this entity.",
            "$ref": "../../type/basic.json#/definitions/href"
        },
        "changeDescription": {
            "description": "Change that lead to this version of the entity.",
            "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
        },
        "deleted": {
            "description": "When `true` indicates the entity has been soft deleted.",
            "type": "boolean",
            "default": false
        },
        "dashboard": {
            "description": "Dashboard where this chart is displayed",
            "$ref": "../../type/entityReference.json"
        }
    },
    "required": [
        "name",
        "chartDetails"
    ],
    "additionalProperties": false
}