OpenMetadata · Schema

Chart

Data CatalogMetadataData GovernanceData LineageData QualityOpen SourceData DiscoveryData Observability

Properties

Name Type Description
id string
name string
displayName string
fullyQualifiedName string
description string
version number
updatedAt integer
updatedBy string
impersonatedBy string
chartType string
sourceUrl string
href string
owners array
followers array
tags array
service object
serviceType string
usageSummary object
changeDescription object
incrementalChangeDescription object
deleted boolean
domains array
dataProducts array
dataContract object
votes object
lifeCycle object
certification object
sourceHash string
extension object
dashboards array
entityStatus string
provider string
children array
style object
experts array
reviewers array
View JSON Schema on GitHub

JSON Schema

chart.json Raw ↑ 
{
  "required": [
    "id",
    "name",
    "service"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "pattern": "^((?!::).)*$",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "fullyQualifiedName": {
      "maxLength": 3072,
      "minLength": 1,
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "version": {
      "type": "number",
      "format": "double"
    },
    "updatedAt": {
      "type": "integer",
      "format": "int64"
    },
    "updatedBy": {
      "type": "string"
    },
    "impersonatedBy": {
      "type": "string"
    },
    "chartType": {
      "type": "string",
      "enum": [
        "Line",
        "Table",
        "Bar",
        "Area",
        "Pie",
        "Histogram",
        "Scatter",
        "Text",
        "BoxPlot",
        "SanKey",
        "Gauge",
        "Map",
        "Graph",
        "Heatmap",
        "Timeline",
        "Other"
      ]
    },
    "sourceUrl": {
      "type": "string"
    },
    "href": {
      "type": "string",
      "format": "uri"
    },
    "owners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "followers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TagLabel"
      }
    },
    "service": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "serviceType": {
      "type": "string",
      "enum": [
        "Superset",
        "Looker",
        "Tableau",
        "Redash",
        "Metabase",
        "PowerBI",
        "PowerBIReportServer",
        "Mode",
        "CustomDashboard",
        "DomoDashboard",
        "QuickSight",
        "QlikSense",
        "Lightdash",
        "MicroStrategy",
        "QlikCloud",
        "Sigma",
        "ThoughtSpot",
        "Grafana",
        "Hex",
        "Ssrs",
        "SapS4Hana"
      ]
    },
    "usageSummary": {
      "$ref": "#/components/schemas/UsageDetails"
    },
    "changeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "incrementalChangeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "deleted": {
      "type": "boolean"
    },
    "domains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "dataProducts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "dataContract": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "votes": {
      "$ref": "#/components/schemas/Votes"
    },
    "lifeCycle": {
      "$ref": "#/components/schemas/LifeCycle"
    },
    "certification": {
      "$ref": "#/components/schemas/AssetCertification"
    },
    "sourceHash": {
      "maxLength": 32,
      "minLength": 1,
      "type": "string"
    },
    "extension": {
      "type": "object"
    },
    "dashboards": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "entityStatus": {
      "type": "string",
      "enum": [
        "Draft",
        "In Review",
        "Approved",
        "Archived",
        "Deprecated",
        "Rejected",
        "Unprocessed"
      ]
    },
    "provider": {
      "type": "string",
      "enum": [
        "system",
        "user",
        "automation"
      ]
    },
    "children": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "style": {
      "$ref": "#/components/schemas/Style"
    },
    "experts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "reviewers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/openmetadata/main/json-schema/chart.json"
}