executions.protocol

{
  "type": "object",
  "additionalProperties": false,
  "description": "No input.",
  "title": "Empty"
}

{
  "type": "object",
  "properties": {
    "protocol_version": {
      "type": "string",
      "description": "The version of the event protocol this server speaks."
    },
    "websocket": {
      "type": "string",
      "description": "Where the live channel is: a path on this same server, not a second daemon."
    },
    "subscription": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ParameterView"
      },
      "description": "How the subscription is expressed, and what a reconnect sends."
    },
    "heartbeat_seconds": {
      "type": "integer",
      "format": "uint64",
      "minimum": 0,
      "description": "How many seconds of quiet before the server pings."
    },
    "max_connections": {
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "description": "How many live channels this process serves at once."
    },
    "max_replay": {
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "description": "How many retained events a scoped connection replays before going live."
    },
    "event_types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The event types a client may receive, from the one enum that defines them."
    },
    "stream_types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The stream's own control messages."
    },
    "event_schema": {
      "description": "The JSON Schema of an event, derived from the Rust type."
    },
    "stream_schema": {
      "description": "The JSON Schema of a control message, derived from the Rust type."
    },
    "limits": {
      "$ref": "#/$defs/LimitsView",
      "description": "What the store keeps, so a client knows what it may ask for."
    }
  },
  "required": [
    "protocol_version",
    "websocket",
    "subscription",
    "heartbeat_seconds",
    "max_connections",
    "max_replay",
    "event_types",
    "stream_types",
    "event_schema",
    "stream_schema",
    "limits"
  ],
  "description": "The answer of `executions.protocol`: the live channel's whole contract, derived from\nthe types that implement it.",
  "title": "ProtocolReport",
  "$defs": {
    "ParameterView": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Its name."
        },
        "description": {
          "type": "string",
          "description": "What it does."
        },
        "required": {
          "type": "boolean",
          "description": "Whether it must be given."
        }
      },
      "required": [
        "name",
        "description",
        "required"
      ],
      "description": "One query parameter of the live channel."
    },
    "LimitsView": {
      "type": "object",
      "properties": {
        "max_executions": {
          "type": "integer",
          "format": "uint",
          "minimum": 0,
          "description": "How many executions are remembered."
        },
        "max_events": {
          "type": "integer",
          "format": "uint",
          "minimum": 0,
          "description": "How many events are retained per execution."
        },
        "max_log_chars": {
          "type": "integer",
          "format": "uint",
          "minimum": 0,
          "description": "The longest a single log line may be."
        },
        "max_running": {
          "type": "integer",
          "format": "uint",
          "minimum": 0,
          "description": "How many executions run at once."
        },
        "max_subscriber_queue": {
          "type": "integer",
          "format": "uint",
          "minimum": 0,
          "description": "How far a live channel may fall behind before it is told to resynchronise."
        }
      },
      "required": [
        "max_executions",
        "max_events",
        "max_log_chars",
        "max_running",
        "max_subscriber_queue"
      ],
      "description": "What this process's execution store keeps."
    }
  }
}