Schema sender_transport_params_websocket.json

Resolve referenced schemas (may reorder keys)

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Describes WebSocket Sender transport parameters. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint. WebSocket Senders must support all parameters in this schema.",
  "title": "WebSocket Sender Transport Parameters",
  "type": "object",
  "title": "Sender Output",
  "properties": {
    "connection_uri": {
      "type": [
        "string",
        "null"
      ],
      "description": "URI hosting the WebSocket server as defined in RFC 6455 Section 3. The sender should provide an enum in the constraints endpoint, which should contain the available interface addresses formatted as connection URIs. If the parameter is set to auto the sender should establish for itself which interface it should use, based on routing rules or its own internal configuration. A null value indicates that the sender has not yet been configured.",
      "anyOf": [{
          "pattern": "^auto$"
        },
        {
          "format": "uri",
          "pattern": "^wss?:\/\/.*"
        },
        {
          "type": "null"
        }
      ]
    },
    "connection_authorization": {
      "type": [
        "string",
        "boolean"
      ],
      "description": "Indication of whether authorization is required to make a connection. If the parameter is set to auto the Sender should establish for itself whether authorization should be used, based on its own internal configuration.",
      "enum": [
        "auto",
        true,
        false
      ]
    }
  },
  "patternProperties": {
    "^ext_[a-zA-Z0-9_]+$": {
      "$ref": "sender_transport_params_ext.json"
    }
  },
  "additionalProperties": false
}

Documentation built at 06:41:25 CDT on 2025-03-12.
(c) AMWA 2025. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.