json.schema.api.data.createDashboard.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-core Show documentation
The newest version!
{
  "$id": "https://open-metadata.org/schema/api/data/createDashboard.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateDashboardRequest",
  "description": "Create Dashboard entity request",
  "type": "object",
  "javaType": "org.openmetadata.catalog.api.data.CreateDashboard",
  "javaInterfaces": ["org.openmetadata.core.entity.interfaces.CreateEntity"],
  "properties": {
    "name": {
      "description": "Name that identifies this dashboard.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Dashboard. It could be title or label from the source services",
      "type": "string"
    },
    "description": {
      "description": "Description of the database instance. What it has and how to use it.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "dashboardUrl": {
      "description": "Dashboard URL suffix from its service.",
      "type": "string"
    },
    "charts": {
      "description": "All the charts included in this Dashboard.",
      "type": "array",
      "items": {
        "$ref": "../../type/entityReference.json"
      },
      "default": null
    },
    "tags": {
      "description": "Tags for this dashboard",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    },
    "owner": {
      "description": "Owner of this dashboard",
      "$ref": "../../type/entityReference.json"
    },
    "service": {
      "description": "Link to the dashboard service where this dashboard is hosted in",
      "$ref": "../../type/entityReference.json"
    },
    "extension": {
      "description": "Entity extension data with custom attributes added to the entity.",
      "$ref": "../../type/basic.json#/definitions/entityExtension"
    }
  },
  "required": ["name", "service"],
  "additionalProperties": false
}