connection.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "definitions": {
    "namespace": {
      "title": "Namespace",
      "type": "string",
      "minLength": 1,
      "default": "USER"
    },
    "username": {
      "title": "Username",
      "type": "string",
      "minLength": 1
    },
    "askForPassword": {
      "title": "Ask for password?",
      "type": "boolean",
      "default": false
    },
    "password": {
      "title": "Password",
      "type": "string",
      "minLength": 1
    }
  },
  "properties": {
    "namespace": { "$ref": "#/definitions/namespace" },
    "connectionMethod": {
      "title": "Connect using",
      "type": "string",
      "minLength": 1,
      "enum": ["Server Definition", "Server and Port"],
      "default": "Server Definition"
    },
    "showSystem": {
      "title": "Show system items?",
      "type": "boolean",
      "default": false
    },
    "filter": {
      "title": "Filter",
      "type": "string",
      "examples": [
        "'Ens*",
        "'HS*"
      ],
      "description": "* 0 or more characters, _ any one character, ' NOT pattern"
    }
  },
  "dependencies": {
    "connectionMethod": {
      "oneOf": [
        {
          "properties": {
            "connectionMethod": {
              "enum": ["Server and Port"]
            },
            "server": {
              "title": "Webserver address",
              "type": "string",
              "minLength": 1,
              "default": "localhost"
            },
            "port": {
              "title": "Webserver port",
              "minimum": 1,
              "default": 52773,
              "type": "integer"
            },
            "pathPrefix": {
              "title": "Path prefix (for shared webserver)",
              "type": "string",
              "pattern": "^(|\/.*[^\/])$",
              "default": ""
            },
            "https": {
              "title": "Use HTTPS?",
              "default": false,
              "type": "boolean"
            },
            "username": { "$ref": "#/definitions/username" },
            "askForPassword": { "$ref": "#/definitions/askForPassword" }
          },
          "required": ["server", "port", "username"]
        },
        {
          "properties": {
            "connectionMethod": {
              "enum": ["Server Definition"]
            },
            "serverName": {
              "title": "Server name",
              "type": "string",
              "minLength": 1,
              "description": "Name of a server definition configured using InterSystems Server Manager"
            }
          },
          "required": ["serverName"]
        }
      ]
    },
    "askForPassword": {
      "oneOf": [
        { "properties": { "askForPassword": { "enum": [true] } } },
        {
          "properties": {
            "askForPassword": { "enum": [false] },
            "password": { "$ref": "#/definitions/password" }
          },
          "required": ["password"]
        }
      ]
    }
  },
  "required": [
    "connectionMethod", "namespace"
  ]
}