openrpc.json

{
  "openrpc": "1.0.0",
  "info": {
    "version": "1.0.10",
    "title": "Example JSON-RPC",
    "description": "This is a basic template to get you started",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "methods": [
    {
      "name": "ping",
      "summary": "Returns a pong.",
      "params": [],
      "result": {
        "name": "pong",
        "description": "the string `pong`",
        "schema": {
          "title": "pong",
          "type": "string",
          "enum": [
            "pong"
          ]
        }
      }
    },
    {
      "name": "sum",
      "summary": "Returns the sum of two numbers",
      "params": [
        {
          "name": "a",
          "required": true,
          "description": "The first number",
          "schema": {
            "$ref": "#/components/schemas/Number"
          }
        },
        {
          "name": "b",
          "required": true,
          "description": "The second number",
          "schema": {
            "$ref": "#/components/schemas/Number"
          }
        }
      ],
      "result": {
        "name": "sumResult",
        "schema": {
          "$ref": "#/components/schemas/Number"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "Number": {
        "type": "string",
        "pattern": "^0x[a-fA-F\\d]+$",
        "description": "The hex representation of a number"
      }
    },
    "contentDescriptors": {
      "Null": {
        "name": "Null",
        "description": "JSON Null value",
        "summary": "Null value",
        "schema": {
          "type": "null",
          "description": "Null value"
        }
      }
    }
  }
}