json.schema.entity.services.connections.dashboard.lookerConnection.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/lookerConnection.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "LookerConnection",
  "description": "Looker Connection Config",
  "type": "object",
  "javaType": "org.openmetadata.schema.services.connections.dashboard.LookerConnection",
  "definitions": {
    "lookerType": {
      "description": "Looker service type",
      "type": "string",
      "enum": ["Looker"],
      "default": "Looker"
    },
    "noGitCredentials": {
      "title": "No Git Credentials",
      "description": "Do not set any credentials. Note that credentials are required to extract .lkml views and their lineage.",
      "type": "object",
      "additionalProperties": false
    }
  },
  "properties": {
    "type": {
      "title": "Service Type",
      "description": "Service Type",
      "$ref": "#/definitions/lookerType",
      "default": "Looker"
    },
    "clientId": {
      "title": "Client ID",
      "description": "User's Client ID. This user should have privileges to read all the metadata in Looker.",
      "type": "string"
    },
    "clientSecret": {
      "title": "Client Secret",
      "description": "User's Client Secret.",
      "type": "string",
      "format": "password"
    },
    "hostPort": {
      "expose": true,
      "title": "Host and Port",
      "description": "URL to the Looker instance.",
      "type": "string",
      "format": "uri"
    },
    "gitCredentials": {
      "title": "GitHub Credentials",
      "description": "Credentials to extract the .lkml files from a repository. This is required to get all the lineage and definitions.",
      "oneOf": [
        {
          "$ref": "#/definitions/noGitCredentials"
        },
        {
          "$ref": "../../../../security/credentials/githubCredentials.json"
        },
        {
          "$ref": "../../../../security/credentials/bitbucketCredentials.json"
        },
        {
          "$ref": "../../../../security/credentials/gitlabCredentials.json"
        }
      ]
    },
    "supportsMetadataExtraction": {
      "title": "Supports Metadata Extraction",
      "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction"
    }
  },
  "additionalProperties": false,
  "required": ["hostPort", "clientId", "clientSecret"]
}