json.schema.entity.services.connections.pipeline.nifiConnection.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/pipeline/nifiConnection.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "NifiConnection",
  "description": "Nifi Metadata Pipeline Connection Config",
  "type": "object",
  "javaType": "org.openmetadata.schema.services.connections.pipeline.NifiConnection",
  "definitions": {
    "NifiType": {
      "description": "Service type.",
      "type": "string",
      "enum": ["Nifi"],
      "default": "Nifi"
    },
    "basicAuthentication": {
      "title": "Username/Password Authentication",
      "description": "username/password auth",
      "type":"object",
      "properties": {
        "username": {
          "title": "Username",
          "description": "Nifi user to authenticate to the API.",
          "type": "string"
        },
        "password": {
          "title": "Password",
          "description": "Nifi password to authenticate to the API.",
          "type": "string",
          "format": "password"
        },
        "verifySSL": {
          "title": "Verify SSL",
          "description": "Boolean marking if we need to verify the SSL certs for Nifi. False by default.",
          "type": "boolean",
          "default": false
        }
      },
      "additionalProperties": false
    },
    "clientCertificateAuthentication": {
      "title": "Client Certificate Authentication",
      "description": "client certificate auth",
      "type":"object",
      "properties": {
        "certificateAuthorityPath":{
          "title":"Certificat Authority Path",
          "description": "Path to the root CA certificate",
          "type": "string"
        },
        "clientCertificatePath":{
          "title":"Client Certificat",
          "description": "Path to the client certificate",
          "type": "string"
        },
        "clientkeyPath":{
          "title":"Client Key",
          "description": "Path to the client key",
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "properties": {
    "type": {
      "title": "Service Type",
      "description": "Service Type",
      "$ref": "#/definitions/NifiType",
      "default": "Nifi"
    },
    "hostPort": {
      "expose": true,
      "title": "Host And Port",
      "description": "Pipeline Service Management/UI URI.",
      "type": "string",
      "format": "uri"
    },
    "nifiConfig": {
      "title": "Nifi Credentials Configuration",
      "description": "We support username/password or client certificate authentication",
      "oneOf": [
        {
          "$ref": "#/definitions/basicAuthentication"
        },
        {
          "$ref": "#/definitions/clientCertificateAuthentication"
        }
      ]
    },
    "supportsMetadataExtraction": {
      "title": "Supports Metadata Extraction",
      "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction"
    }
  },
  "additionalProperties": false,
  "required": ["hostPort", "nifiConfig"]
}