json.schema.entity.data.chart.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/entity/data/chart.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Chart",
  "description": "A `Chart` presents data visually. Charts can be part of `Dashboards`.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.data.Chart",
  "javaInterfaces": ["org.openmetadata.schema.EntityInterface"],
  "definitions": {
    "chartType": {
      "javaType": "org.openmetadata.schema.type.ChartType",
      "description": "This schema defines the type used for describing different types of charts.",
      "type": "string",
      "enum": [
        "Line",
        "Table",
        "Bar",
        "Area",
        "Pie",
        "Histogram",
        "Scatter",
        "Text",
        "BoxPlot",
        "Other"
      ],
      "javaEnums": [
        {
          "name": "Line"
        },
        {
          "name": "Table"
        },
        {
          "name": "Bar"
        },
        {
          "name": "Area"
        },
        {
          "name": "Pie"
        },
        {
          "name": "Histogram"
        },
        {
          "name": "Scatter"
        },
        {
          "name": "Text"
        },
        {
          "name": "BoxPlot"
        },
        {
          "name": "Other"
        }
      ]
    }
  },
  "properties": {
    "id": {
      "description": "Unique identifier that identifies a chart instance.",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Name that identifies this Chart.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Chart. It could be title or label from the source services.",
      "type": "string"
    },
    "fullyQualifiedName": {
      "description": "A unique name that identifies a dashboard in the format 'ServiceName.ChartName'.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "description": {
      "description": "Description of the dashboard, what it is, and how to use it.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "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"
    },
    "chartType": {
      "$ref": "#/definitions/chartType"
    },
    "sourceUrl": {
      "description": "Chart URL suffix from its service.",
      "$ref": "../../type/basic.json#/definitions/sourceUrl"
    },
    "href": {
      "description": "Link to the resource corresponding to this entity.",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "owners": {
      "description": "Owners of this chart.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "followers": {
      "description": "Followers of this chart.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this chart.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": []
    },
    "service": {
      "description": "Link to service where this dashboard is hosted in.",
      "$ref": "../../type/entityReference.json"
    },
    "serviceType": {
      "description": "Service type where this chart is hosted in.",
      "$ref": "../services/dashboardService.json#/definitions/dashboardServiceType"
    },
    "usageSummary": {
      "description": "Latest usage information for this chart.",
      "$ref": "../../type/usageDetails.json",
      "default": null
    },
    "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
    },
    "domain" : {
      "description": "Domain the Chart belongs to. The Chart inherits domain from the dashboard service it belongs to.",
      "$ref": "../../type/entityReference.json"
    },
    "dataProducts": {
      "description": "List of data products this entity is part of.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "votes": {
      "description": "Votes on the entity.",
      "$ref": "../../type/votes.json"
    },
    "lifeCycle": {
      "description": "Life Cycle properties of the entity",
      "$ref": "../../type/lifeCycle.json"
    },
    "certification": {
      "$ref": "../../type/assetCertification.json"
    },
    "sourceHash": {
      "description": "Source hash of the entity",
      "type": "string",
      "minLength": 1,
      "maxLength": 32
    },
    "dashboards": {
      "description": "All the dashboards containing this chart.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    }
  },
  "required": ["id", "name", "service"],
  "additionalProperties": false
}