connection.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "required": ["server", "port", "passwordMode"],
  "definitions": {
    "password": {
      "title": "Password",
      "type": "string",
      "default": ""
    },
    "tls": {
      "title": "TLS configuration",
      "type": "object",
      "properties": {
        "ca_cert": {
          "title": "CA Cert",
          "type": "string"
        },
        "cert": {
          "title": "Cert",
          "type": "string"
        },
        "key": {
          "title": "Key",
          "type": "string"
        }
      },
      "dependencies": {
        "cert": ["ca_cert", "key"],
        "key": ["ca_cert", "cert"]
      }
    }
  },
  "properties": {
    "server": {
      "title": "Server",
      "type": "string",
      "format": "uri",
      "default": "http://localhost",
      "minLength": 1
    },
    "port": {
      "title": "Port",
      "type": "integer",
      "default": 8123
    },
    "database": {
      "title": "Database",
      "type": "string",
      "default": "default"
    },
    "useJWT": {
      "type": "boolean",
      "title": "Use JWT token instead of password",
      "default": false
    },
    "passwordMode": {
      "title": "Password mode",
      "type": "string",
      "enum": [
        "SQLTools Driver Credentials",
        "Ask on connect",
        "Use empty password",
        "Save as plaintext in settings"
      ],
      "default": "Use empty password"
    },
    "role": {
      "title": "Role",
      "type": "string"
    },
    "requestTimeout": {
      "title": "Request timeout in milliseconds",
      "type": "integer",
      "default": 30000
    },
    "enableTls": {
      "type": "boolean",
      "title": "Enable TLS",
      "default": false
    }
  },
  "dependencies": {
    "passwordMode": {
      "oneOf": [
        {
          "properties": {
            "passwordMode": {
              "enum": ["SQLTools Driver Credentials"]
            }
          }
        },
        {
          "properties": {
            "passwordMode": {
              "enum": ["Ask on connect"]
            }
          }
        },
        {
          "properties": {
            "passwordMode": {
              "enum": ["Use empty password"]
            }
          }
        },
        {
          "properties": {
            "passwordMode": {
              "enum": ["Save as plaintext in settings"]
            },
            "password": {
              "$ref": "#/definitions/password"
            }
          },
          "required": ["password"]
        }
      ]
    },
    "useJWT": {
      "oneOf": [
        {
          "properties": {
            "useJWT": {
              "enum": [false]
            },
            "username": {
              "title": "Username",
              "type": "string",
              "default": "default"
            }
          }
        },
        {
          "properties": {
            "useJWT": {
              "enum": [true]
            }
          }
        }
      ]
    },
    "enableTls": {
      "oneOf": [
        {
          "properties": {
            "enableTls": {
              "enum": [false]
            }
          }
        },
        {
          "properties": {
            "enableTls": {
              "enum": [true]
            },
            "tls": {
              "$ref": "#/definitions/tls"
            }
          }
        }
      ]
    }
  }
}