sausage/sdk/tests/plugins/consumer/imports/probe.json

{
  "components": {
    "schemas": {
      "Add": {
        "description": "The values to add.",
        "properties": {
          "a": {
            "description": "The first number.",
            "format": "int32",
            "type": "integer"
          },
          "b": {
            "description": "The second number.",
            "format": "int32",
            "type": "integer"
          }
        },
        "required": [
          "a",
          "b"
        ],
        "type": "object"
      },
      "Echo": {
        "description": "A large payload.",
        "properties": {
          "text": {
            "description": "The text to return unchanged.",
            "type": "string"
          }
        },
        "required": [
          "text"
        ],
        "type": "object"
      },
      "Empty": {
        "description": "Empty parameters for methods without arguments.",
        "type": "object"
      }
    }
  },
  "info": {
    "title": "sdk-probe",
    "version": "0.1.0"
  },
  "methods": [
    {
      "description": "Publish a control endpoint until EOF.",
      "name": "serve",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "null"
        }
      },
      "summary": "Publish a control endpoint until EOF.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Empty"
      }
    },
    {
      "description": "Add two numbers.\n\nThe result is their sum.",
      "name": "add",
      "paramStructure": "by-name",
      "params": [
        {
          "description": "The first number.",
          "name": "a",
          "required": true,
          "schema": {
            "description": "The first number.",
            "format": "int32",
            "type": "integer"
          }
        },
        {
          "description": "The second number.",
          "name": "b",
          "required": true,
          "schema": {
            "description": "The second number.",
            "format": "int32",
            "type": "integer"
          }
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "format": "int32",
          "type": "integer"
        }
      },
      "summary": "Add two numbers.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Add"
      }
    },
    {
      "description": "Echo a payload larger than a host I/O buffer.",
      "name": "echo",
      "paramStructure": "by-name",
      "params": [
        {
          "description": "The text to return unchanged.",
          "name": "text",
          "required": true,
          "schema": {
            "description": "The text to return unchanged.",
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "result",
        "schema": {
          "type": "string"
        }
      },
      "summary": "Echo a payload larger than a host I/O buffer.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Echo"
      }
    },
    {
      "description": "Return an internal serialization error.",
      "name": "serde_error",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "string"
        }
      },
      "summary": "Return an internal serialization error.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Empty"
      }
    },
    {
      "description": "Return a deliberate error.",
      "name": "fail",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "string"
        }
      },
      "summary": "Return a deliberate error.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Empty"
      }
    },
    {
      "description": "Exercise calls, notifications, and advisory locks.",
      "name": "exercise",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "string"
        }
      },
      "summary": "Exercise calls, notifications, and advisory locks.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Empty"
      }
    },
    {
      "description": "Drop an acquisition before the core grants its lock.",
      "name": "late",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "string"
        }
      },
      "summary": "Drop an acquisition before the core grants its lock.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Empty"
      }
    },
    {
      "description": "Wait until EOF, then run the stop hook.",
      "name": "wait",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "string"
        }
      },
      "summary": "Wait until EOF, then run the stop hook.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Empty"
      }
    },
    {
      "description": "Keep the process alive with a background call.",
      "name": "start",
      "paramStructure": "by-name",
      "params": [],
      "result": {
        "name": "result",
        "schema": {
          "type": "string"
        }
      },
      "summary": "Keep the process alive with a background call.",
      "x-sausage-params": {
        "$ref": "#/components/schemas/Empty"
      }
    }
  ],
  "openrpc": "1.2.6",
  "x-sausage-endpoints": {
    "control": {
      "methods": [
        {
          "description": "Report progress and return a stable counter.",
          "name": "stats",
          "paramStructure": "by-name",
          "params": [],
          "result": {
            "name": "result",
            "schema": {
              "format": "uint64",
              "minimum": 0,
              "type": "integer"
            }
          },
          "summary": "Report progress and return a stable counter.",
          "x-sausage-params": {
            "$ref": "#/components/schemas/Empty"
          }
        },
        {
          "description": "End the endpoint process after the response.",
          "name": "stop",
          "paramStructure": "by-name",
          "params": [],
          "result": {
            "name": "result",
            "schema": {
              "type": "null"
            }
          },
          "summary": "End the endpoint process after the response.",
          "x-sausage-params": {
            "$ref": "#/components/schemas/Empty"
          }
        }
      ]
    }
  },
  "x-sausage-grace": 12,
  "x-sausage-imports": {}
}