json.schema.entity.services.connections.dashboard.qlikSenseConnection.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/qlikSenseConnection.json",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "QlikSenseConnection",
    "description": "Qlik Sense Connection Config",
    "type": "object",
    "javaType": "org.openmetadata.schema.services.connections.dashboard.QlikSenseConnection",
    "definitions": {
        "qlikSenseType": {
            "description": "Qlik sense service type",
            "type": "string",
            "enum": [
                "QlikSense"
            ],
            "default": "QlikSense"
        },
        "qlikCertificatePath": {
            "description": "Qlik Authentication Certificate File Path",
            "title": "Qlik Certificates By File Path",
            "type": "object",
            "properties": {
                "clientCertificate": {
                    "title": "Client Certificate Path",
                    "description": "Client Certificate",
                    "type": "string"
                },
                "clientKeyCertificate": {
                    "title": "Client Key Certificate",
                    "description": "Client Key Certificate.",
                    "type": "string"
                },
                "rootCertificate": {
                    "title": "Root Certificate",
                    "description": "Root Certificate.",
                    "type": "string"
                }
            },
            "required": [
                "clientCertificate",
                "clientKeyCertificate",
                "rootCertificate"
            ]
        },
        "qlikCertificateValues": {
            "description": "Qlik Authentication Certificate By Values",
            "title": "Qlik Certificates By Values",
            "type": "object",
            "properties": {
                "sslConfig": {
                    "$ref": "../../../../security/ssl/verifySSLConfig.json#/definitions/sslConfig"
                }
            },
            "required": [
                "sslConfig"
            ]
        }
    },
    "properties": {
        "type": {
            "title": "Service Type",
            "description": "Service Type",
            "$ref": "#/definitions/qlikSenseType",
            "default": "QlikSense"
        },
        "displayUrl": {
            "expose": true,
            "title": "Qlik Sense Base URL",
            "description": "Qlik Sense Base URL, used for genrating dashboard & chat url",
            "type": "string",
            "format": "uri"
        },
        "hostPort": {
            "expose": true,
            "title": "Qlik Engine JSON API Websocket URL",
            "description": "URL for the Qlik instance.",
            "type": "string",
            "format": "uri"
        },
        "certificates": {
            "oneOf": [
                {
                    "$ref": "#/definitions/qlikCertificateValues"
                },
                {
                    "$ref": "#/definitions/qlikCertificatePath"
                }
            ]
        },
        "validateHostName": {
            "title": "Validate Host Name",
            "description": "Validate Host Name",
            "type": "boolean",
            "default": false
        },
        "userDirectory": {
            "title": "User Directory",
            "description": "User Directory.",
            "type": "string"
        },
        "userId": {
            "title": "User ID",
            "description": "User ID.",
            "type": "string"
        },
        "supportsMetadataExtraction": {
            "title": "Supports Metadata Extraction",
            "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction"
        }
    },
    "additionalProperties": false,
    "required": [
        "hostPort",
        "certificates"
    ]
}