json.schema.entity.services.connections.dashboard.lightdashConnection.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/services/connections/dashboard/lightdashConnection.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "LightdashConnection",
  "description": "Lightdash Connection Config",
  "type": "object",
  "javaType": "org.openmetadata.schema.services.connections.dashboard.LightdashConnection",
  "definitions": {
    "lightdashType": {
      "description": "Lightdash service type",
      "type": "string",
      "enum": ["Lightdash"],
      "default": "Lightdash"
    }
  },
  "properties": {
    "type": {
      "title": "Service Type",
      "description": "Service Type",
      "$ref": "#/definitions/lightdashType",
      "default": "Lightdash"
    },
    "hostPort": {
      "expose": true,
      "title": "Host Port",
      "description": "Address for your running Lightdash instance",
      "type": "string",
      "format": "uri",
      "default": "http://localhost:5000"
    },
    "apiKey": {
      "title": "API Key",
      "description": "The personal access token you can generate in the Lightdash app under the user settings",
      "type": "string",
      "format": "password"
    },
     "projectUUID": {
      "title": "Project UUID",
      "description": "The Project UUID for your Lightdash instance",
      "type": "string"
    },
    "spaceUUID": {
      "title": "Space UUID",
      "description": "The Space UUID for your Lightdash instance",
      "type": "string"
    },
    "proxyAuthentication": {
      "title": "Proxy Authentication",
      "description": "Use if your Lightdash instance is behind a proxy like (Cloud IAP)",
      "type": "string",
      "format": "password"
    },
    "supportsMetadataExtraction": {
      "title": "Supports Metadata Extraction",
      "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction"
    }
  },
  "additionalProperties": false,
  "required": ["hostPort", "apiKey","projectUUID","spaceUUID"]
}