{
  "openrpc": "1.3.2",
  "info": {
    "title": "pydiggs stdio sidecar",
    "version": "1.3",
    "description": "JSON-RPC 2.0 over NDJSON on stdin/stdout (pydiggs serve --stdio). The -32000..-32099 error band is pydiggs-defined; switch on error.data.code."
  },
  "methods": [
    {
      "name": "initialize",
      "summary": "Negotiate the protocol version, warm the validators and report limits.",
      "paramStructure": "by-name",
      "params": [
        {
          "name": "protocol_version",
          "schema": {
            "type": "string",
            "pattern": "^\\d+\\.\\d+$"
          },
          "required": true
        },
        {
          "name": "client_info",
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "name": {
                "type": "string",
                "maxLength": 128
              },
              "version": {
                "type": "string",
                "maxLength": 64
              }
            }
          },
          "required": false
        },
        {
          "name": "capabilities",
          "schema": {
            "type": "object",
            "properties": {
              "progress": {
                "type": "boolean"
              }
            }
          },
          "required": false
        },
        {
          "name": "diggs_versions",
          "schema": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1
          },
          "required": false
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "type": "object",
          "required": [
            "protocol_version",
            "pydiggs_version",
            "findings_schema_version",
            "findings_schema_url",
            "diggs_versions",
            "reference_data",
            "capabilities",
            "limits"
          ],
          "properties": {
            "protocol_version": {
              "type": "string"
            },
            "pydiggs_version": {
              "type": "string"
            },
            "findings_schema_version": {
              "type": "string"
            },
            "findings_schema_url": {
              "type": "string"
            },
            "model_schema_version": {
              "type": "string"
            },
            "model_schema_url": {
              "type": "string"
            },
            "diff_schema_version": {
              "type": "string"
            },
            "diff_schema_url": {
              "type": "string"
            },
            "diggs_versions": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "reference_data": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            },
            "capabilities": {
              "$ref": "#/components/schemas/ServerCapabilities"
            },
            "limits": {
              "type": "object",
              "properties": {
                "max_bytes": {
                  "type": "integer"
                },
                "max_path_bytes": {
                  "type": "integer"
                },
                "max_line_bytes": {
                  "type": "integer"
                },
                "max_findings": {
                  "type": "integer"
                },
                "max_response_bytes_estimate": {
                  "type": "integer"
                },
                "max_result_bytes": {
                  "type": "integer"
                },
                "time_budget_s": {
                  "type": "number"
                }
              }
            }
          }
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/invalid-params"
        },
        {
          "$ref": "#/components/errors/unsupported-protocol-version"
        },
        {
          "$ref": "#/components/errors/resource-error"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        }
      ]
    },
    {
      "name": "validate",
      "summary": "Validate one document, given as base64 content or (if enabled) an absolute path.",
      "paramStructure": "by-name",
      "params": [
        {
          "name": "content_base64",
          "schema": {
            "type": "string",
            "contentEncoding": "base64"
          },
          "required": false
        },
        {
          "name": "path",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "name",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "checks",
          "schema": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1
          },
          "required": false
        },
        {
          "name": "diggs_version",
          "schema": {
            "type": "string"
          },
          "required": false
        },
        {
          "name": "time_budget_s",
          "schema": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "required": false
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "$ref": "https://xinp-hub.github.io/pydiggs/schemas/diggs-findings-1.2.schema.json"
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        },
        {
          "$ref": "#/components/errors/invalid-params"
        },
        {
          "$ref": "#/components/errors/busy"
        },
        {
          "$ref": "#/components/errors/input-too-large"
        },
        {
          "$ref": "#/components/errors/compressed-input"
        },
        {
          "$ref": "#/components/errors/path-not-permitted"
        },
        {
          "$ref": "#/components/errors/input-unreadable"
        },
        {
          "$ref": "#/components/errors/resource-error"
        },
        {
          "$ref": "#/components/errors/cancelled"
        },
        {
          "$ref": "#/components/errors/internal"
        }
      ]
    },
    {
      "name": "read",
      "summary": "Read one document into a diggs-model document (protocol 1.1). A schema-invalid file still reads; run validate for a verdict.",
      "paramStructure": "by-name",
      "params": [
        {
          "name": "content_base64",
          "schema": {
            "type": "string",
            "contentEncoding": "base64"
          },
          "required": false
        },
        {
          "name": "path",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "name",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "diggs_version",
          "schema": {
            "type": "string"
          },
          "required": false
        },
        {
          "name": "time_budget_s",
          "schema": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "required": false
        },
        {
          "name": "select",
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "results": {
                "oneOf": [
                  {
                    "enum": [
                      "all",
                      "none"
                    ]
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "maxItems": 1000
                  }
                ]
              }
            }
          },
          "required": false,
          "summary": "Which result tables keep their values (default: all); the others keep their columns and row_count."
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "$ref": "https://xinp-hub.github.io/pydiggs/schemas/diggs-model-1.0.schema.json"
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        },
        {
          "$ref": "#/components/errors/invalid-params"
        },
        {
          "$ref": "#/components/errors/busy"
        },
        {
          "$ref": "#/components/errors/input-too-large"
        },
        {
          "$ref": "#/components/errors/compressed-input"
        },
        {
          "$ref": "#/components/errors/path-not-permitted"
        },
        {
          "$ref": "#/components/errors/input-unreadable"
        },
        {
          "$ref": "#/components/errors/resource-error"
        },
        {
          "$ref": "#/components/errors/cancelled"
        },
        {
          "$ref": "#/components/errors/internal"
        },
        {
          "$ref": "#/components/errors/invalid-document"
        },
        {
          "$ref": "#/components/errors/result-too-large"
        }
      ]
    },
    {
      "name": "convert",
      "summary": "Convert one AGS4 file to DIGGS 3.0.0 (to: diggs, the default), or one DIGGS document to an AGS4 file (to: ags4), with every loss reported (protocol 1.2). The result carries the output as base64, and for AGS4 to DIGGS the residual AGS4 file of what was not converted.",
      "paramStructure": "by-name",
      "params": [
        {
          "name": "content_base64",
          "schema": {
            "type": "string",
            "contentEncoding": "base64"
          },
          "required": false
        },
        {
          "name": "path",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "name",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "to",
          "schema": {
            "enum": [
              "diggs",
              "ags4"
            ]
          },
          "required": false,
          "summary": "The format to convert to: diggs (the default; the content is AGS4) or ags4 (the content is DIGGS XML)."
        },
        {
          "name": "diggs_version",
          "schema": {
            "enum": [
              "3.0.0"
            ]
          },
          "required": false,
          "summary": "to: diggs only. The DIGGS version to write (default 3.0.0)."
        },
        {
          "name": "ags_version",
          "schema": {
            "enum": [
              "4.2",
              "4.1.1"
            ]
          },
          "required": false,
          "summary": "to: ags4 only. The AGS4 version to write (default 4.2). The BGS AGS validator and python-ags4 1.2.0 accept AGS4 only up to 4.1.1 (November 2026)."
        },
        {
          "name": "time_budget_s",
          "schema": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "required": false
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "$ref": "#/components/schemas/ConversionResult"
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        },
        {
          "$ref": "#/components/errors/invalid-params"
        },
        {
          "$ref": "#/components/errors/busy"
        },
        {
          "$ref": "#/components/errors/input-too-large"
        },
        {
          "$ref": "#/components/errors/compressed-input"
        },
        {
          "$ref": "#/components/errors/path-not-permitted"
        },
        {
          "$ref": "#/components/errors/input-unreadable"
        },
        {
          "$ref": "#/components/errors/resource-error"
        },
        {
          "$ref": "#/components/errors/cancelled"
        },
        {
          "$ref": "#/components/errors/internal"
        },
        {
          "$ref": "#/components/errors/invalid-document"
        },
        {
          "$ref": "#/components/errors/result-too-large"
        }
      ]
    },
    {
      "name": "ags4.check",
      "summary": "Check one AGS4 file against the AGS4 rules (Rules 1 to 20; protocol 1.2), with an optional data dictionary the host supplies.",
      "paramStructure": "by-name",
      "params": [
        {
          "name": "content_base64",
          "schema": {
            "type": "string",
            "contentEncoding": "base64"
          },
          "required": false
        },
        {
          "name": "path",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "name",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "dictionary_base64",
          "schema": {
            "type": "string",
            "contentEncoding": "base64"
          },
          "required": false
        },
        {
          "name": "dictionary_path",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "time_budget_s",
          "schema": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "required": false
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "$ref": "https://xinp-hub.github.io/pydiggs/schemas/diggs-findings-1.2.schema.json"
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        },
        {
          "$ref": "#/components/errors/invalid-params"
        },
        {
          "$ref": "#/components/errors/busy"
        },
        {
          "$ref": "#/components/errors/input-too-large"
        },
        {
          "$ref": "#/components/errors/compressed-input"
        },
        {
          "$ref": "#/components/errors/path-not-permitted"
        },
        {
          "$ref": "#/components/errors/input-unreadable"
        },
        {
          "$ref": "#/components/errors/resource-error"
        },
        {
          "$ref": "#/components/errors/cancelled"
        },
        {
          "$ref": "#/components/errors/internal"
        }
      ]
    },
    {
      "name": "diff",
      "summary": "Compare two DIGGS files (protocol 1.3): what was added, removed or changed, as the diggs-diff 1.0 document pydiggs.diff.compare gives. Each file is given as base64 content or (if enabled) an absolute path.",
      "paramStructure": "by-name",
      "params": [
        {
          "name": "old_base64",
          "schema": {
            "type": "string",
            "contentEncoding": "base64"
          },
          "required": false
        },
        {
          "name": "old_path",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "old_name",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "new_base64",
          "schema": {
            "type": "string",
            "contentEncoding": "base64"
          },
          "required": false
        },
        {
          "name": "new_path",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "new_name",
          "schema": {
            "type": "string",
            "maxLength": 4096
          },
          "required": false
        },
        {
          "name": "match",
          "schema": {
            "enum": [
              "auto",
              "gml-id",
              "natural",
              "gml_id"
            ],
            "default": "auto"
          },
          "required": false,
          "summary": "How records are paired: auto (by gml:id, then by natural key), gml-id (ids only; also written gml_id) or natural (natural keys only)."
        },
        {
          "name": "rel_tol",
          "schema": {
            "type": "number",
            "minimum": 0,
            "exclusiveMaximum": 1,
            "default": 1e-09
          },
          "required": false
        },
        {
          "name": "abs_tol",
          "schema": {
            "type": "number",
            "minimum": 0,
            "default": 0.0
          },
          "required": false
        },
        {
          "name": "max_changes",
          "schema": {
            "type": "integer",
            "minimum": 0,
            "default": 10000
          },
          "required": false,
          "summary": "Most changes listed; the counts stay exact."
        },
        {
          "name": "show_reformatted",
          "schema": {
            "type": "boolean",
            "default": false
          },
          "required": false
        },
        {
          "name": "show_renamed",
          "schema": {
            "type": "boolean",
            "default": false
          },
          "required": false
        },
        {
          "name": "time_budget_s",
          "schema": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "required": false
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "$ref": "https://xinp-hub.github.io/pydiggs/schemas/diggs-diff-1.0.schema.json"
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        },
        {
          "$ref": "#/components/errors/invalid-params"
        },
        {
          "$ref": "#/components/errors/busy"
        },
        {
          "$ref": "#/components/errors/input-too-large"
        },
        {
          "$ref": "#/components/errors/compressed-input"
        },
        {
          "$ref": "#/components/errors/path-not-permitted"
        },
        {
          "$ref": "#/components/errors/input-unreadable"
        },
        {
          "$ref": "#/components/errors/resource-error"
        },
        {
          "$ref": "#/components/errors/cancelled"
        },
        {
          "$ref": "#/components/errors/internal"
        },
        {
          "$ref": "#/components/errors/invalid-document"
        },
        {
          "$ref": "#/components/errors/result-too-large"
        }
      ]
    },
    {
      "name": "ping",
      "summary": "Liveness check.",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "object",
          "additionalProperties": false
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        }
      ]
    },
    {
      "name": "versions",
      "summary": "Package, schema and reference-data versions.",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "object"
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        }
      ]
    },
    {
      "name": "rules.list",
      "summary": "The rule catalogue, optionally for one step.",
      "paramStructure": "by-name",
      "params": [
        {
          "name": "step",
          "schema": {
            "type": "string"
          },
          "required": false
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/RuleInfo"
          }
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        },
        {
          "$ref": "#/components/errors/invalid-params"
        }
      ]
    },
    {
      "name": "rules.explain",
      "summary": "Describe one rule id.",
      "paramStructure": "by-name",
      "params": [
        {
          "name": "rule_id",
          "schema": {
            "type": "string",
            "maxLength": 256
          },
          "required": true
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "$ref": "#/components/schemas/RuleInfo"
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        },
        {
          "$ref": "#/components/errors/invalid-params"
        }
      ]
    },
    {
      "name": "shutdown",
      "summary": "Finish the running validation, refuse new work, then answer null.",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "null"
        }
      },
      "errors": [
        {
          "$ref": "#/components/errors/invalid-request"
        },
        {
          "$ref": "#/components/errors/not-initialized"
        },
        {
          "$ref": "#/components/errors/shutting-down"
        }
      ]
    }
  ],
  "components": {
    "errors": {
      "parse-error": {
        "code": -32700,
        "message": "Parse error",
        "data": {
          "code": "parse-error"
        }
      },
      "invalid-request": {
        "code": -32600,
        "message": "Invalid request",
        "data": {
          "code": "invalid-request"
        }
      },
      "method-not-found": {
        "code": -32601,
        "message": "Method not found",
        "data": {
          "code": "method-not-found"
        }
      },
      "invalid-params": {
        "code": -32602,
        "message": "Invalid params",
        "data": {
          "code": "invalid-params"
        }
      },
      "internal": {
        "code": -32603,
        "message": "An internal error occurred.",
        "data": {
          "code": "internal"
        }
      },
      "busy": {
        "code": -32000,
        "message": "A validation is already running and another is queued.",
        "data": {
          "code": "busy"
        }
      },
      "not-initialized": {
        "code": -32001,
        "message": "The first request must be initialize.",
        "data": {
          "code": "not-initialized"
        }
      },
      "shutting-down": {
        "code": -32002,
        "message": "The server is shutting down.",
        "data": {
          "code": "shutting-down"
        }
      },
      "input-too-large": {
        "code": -32003,
        "message": "The document is larger than allowed.",
        "data": {
          "code": "input-too-large"
        }
      },
      "compressed-input": {
        "code": -32004,
        "message": "Compressed documents are not accepted.",
        "data": {
          "code": "compressed-input"
        }
      },
      "path-not-permitted": {
        "code": -32005,
        "message": "The path is not permitted.",
        "data": {
          "code": "path-not-permitted"
        }
      },
      "input-unreadable": {
        "code": -32006,
        "message": "The document could not be read.",
        "data": {
          "code": "input-unreadable"
        }
      },
      "resource-error": {
        "code": -32007,
        "message": "pydiggs's bundled reference data could not be loaded.",
        "data": {
          "code": "resource-error"
        }
      },
      "cancelled": {
        "code": -32008,
        "message": "The request was cancelled.",
        "data": {
          "code": "cancelled"
        }
      },
      "unsupported-protocol-version": {
        "code": -32009,
        "message": "Unsupported protocol version.",
        "data": {
          "code": "unsupported-protocol-version"
        }
      },
      "invalid-document": {
        "code": -32010,
        "message": "The bytes are not a document of the expected format.",
        "data": {
          "code": "invalid-document"
        }
      },
      "result-too-large": {
        "code": -32011,
        "message": "The result is larger than allowed.",
        "data": {
          "code": "result-too-large"
        }
      }
    },
    "schemas": {
      "RuleInfo": {
        "type": "object",
        "required": [
          "id",
          "step",
          "description",
          "known"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "pattern": {
            "type": [
              "string",
              "null"
            ]
          },
          "step": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "severities": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "help_uri": {
            "type": [
              "string",
              "null"
            ]
          },
          "known": {
            "type": "boolean"
          },
          "guidance": {
            "type": [
              "object",
              "null"
            ],
            "required": [
              "title",
              "meaning",
              "fix",
              "locale"
            ],
            "properties": {
              "title": {
                "type": "string"
              },
              "meaning": {
                "type": "string"
              },
              "fix": {
                "type": "string"
              },
              "locale": {
                "type": "string"
              }
            }
          }
        }
      },
      "ConversionResult": {
        "type": "object",
        "description": "As POST /v1/convert answers: the output (base64) with its media type and sha256, the findings about the source and the output, and for AGS4 to DIGGS the residual AGS4 file (null when nothing was left over, and for DIGGS to AGS4).",
        "required": [
          "to",
          "media_type",
          "output_name",
          "diggs_version",
          "ags_version",
          "mapping_version",
          "complete",
          "lossless",
          "report",
          "validation",
          "output_sha256",
          "output_base64",
          "residual_base64"
        ],
        "properties": {
          "to": {
            "enum": [
              "diggs",
              "ags4"
            ]
          },
          "media_type": {
            "type": "string"
          },
          "output_name": {
            "type": "string"
          },
          "diggs_version": {
            "type": [
              "string",
              "null"
            ]
          },
          "ags_version": {
            "anyOf": [
              {
                "enum": [
                  "4.2",
                  "4.1.1"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "mapping_version": {
            "type": "string"
          },
          "complete": {
            "type": "boolean"
          },
          "lossless": {
            "type": "boolean"
          },
          "report": {
            "$ref": "https://xinp-hub.github.io/pydiggs/schemas/diggs-findings-1.2.schema.json"
          },
          "validation": {
            "anyOf": [
              {
                "$ref": "https://xinp-hub.github.io/pydiggs/schemas/diggs-findings-1.2.schema.json"
              },
              {
                "type": "null"
              }
            ]
          },
          "output_sha256": {
            "type": "string"
          },
          "output_base64": {
            "type": "string",
            "contentEncoding": "base64"
          },
          "residual_base64": {
            "type": [
              "string",
              "null"
            ],
            "contentEncoding": "base64"
          }
        }
      },
      "ServerCapabilities": {
        "type": "object",
        "properties": {
          "validate": {
            "type": "object",
            "properties": {
              "content": {
                "type": "boolean"
              },
              "path": {
                "type": "boolean"
              }
            }
          },
          "read": {
            "type": "object",
            "description": "Protocol 1.1 and later.",
            "properties": {
              "content": {
                "type": "boolean"
              },
              "path": {
                "type": "boolean"
              },
              "select": {
                "type": "boolean"
              }
            }
          },
          "convert": {
            "type": "object",
            "description": "Protocol 1.2 and later.",
            "properties": {
              "content": {
                "type": "boolean"
              },
              "path": {
                "type": "boolean"
              },
              "to": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "ags_versions": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "residual": {
                "type": "boolean"
              }
            }
          },
          "ags4_check": {
            "type": "object",
            "description": "Protocol 1.2 and later (the ags4.check method).",
            "properties": {
              "content": {
                "type": "boolean"
              },
              "path": {
                "type": "boolean"
              },
              "dictionary": {
                "type": "boolean"
              }
            }
          },
          "diff": {
            "type": "object",
            "description": "Protocol 1.3 and later.",
            "properties": {
              "content": {
                "type": "boolean"
              },
              "path": {
                "type": "boolean"
              },
              "match": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "cancel": {
            "type": "boolean"
          },
          "progress": {
            "type": "boolean"
          },
          "rules": {
            "type": "boolean"
          },
          "ping": {
            "type": "boolean"
          }
        }
      }
    }
  },
  "x-notifications": [
    {
      "name": "exit",
      "direction": "host-to-server",
      "params": []
    },
    {
      "name": "$/cancelRequest",
      "direction": "host-to-server",
      "params": [
        {
          "name": "id",
          "schema": {
            "type": [
              "string",
              "integer"
            ]
          },
          "required": true
        }
      ]
    },
    {
      "name": "$/progress",
      "direction": "server-to-host",
      "params": [
        {
          "name": "request_id",
          "schema": {
            "type": [
              "string",
              "integer"
            ]
          },
          "required": true
        },
        {
          "name": "step",
          "schema": {
            "type": "string"
          },
          "required": true
        },
        {
          "name": "status",
          "schema": {
            "type": "string"
          },
          "required": true
        }
      ]
    }
  ]
}
