schema.json

{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/open-rpc/meta-schema/master/schema.json",
  "type": "object",
  "required": [
    "info",
    "methods",
    "openrpc"
  ],
  "additionalProperties": false,
  "properties": {
    "openrpc": {
      "type": "string",
      "enum": ["GENERATED FIELD: Do Not Edit"]
    },
    "info": {
      "$ref": "#/definitions/infoObject"
    },
    "servers": {
      "type": "array",
      "additionalItems": false,
      "items": {
        "$ref": "#/definitions/serverObject"
      }
    },
    "methods": {
      "type": "array",
      "additionalItems": false,
      "items": {
        "$ref": "#/definitions/methodObject"
      }
    },
    "components": {
      "type": "object",
      "properties": {
        "schemas": {
          "type": "object",
          "patternProperties": {
            "[0-z]+": {
              "$ref": "#/definitions/schema"
            }
          }
        },
        "links": {
          "type": "object",
          "patternProperties": {
            "[0-z]+": {
              "$ref": "#/definitions/linkObject"
            }
          }
        },
        "examples": {
          "type": "object",
          "patternProperties": {
            "[0-z]+": {
              "$ref": "#/definitions/exampleObject"
            }
          }
        },
        "examplePairings": {
          "type": "object",
          "patternProperties": {
            "[0-z]+": {
              "$ref": "#/definitions/examplePairingObject"
            }
          }
        },
        "contentDescriptors": {
          "type": "object",
          "patternProperties": {
            "[0-z]+": {
              "oneOf": [
                {
                  "$ref": "#/definitions/contentDescriptorObject"
                },
                {
                  "$ref": "#/definitions/referenceObject"
                }
              ]
            }
          }
        },
        "tags": {
          "type": "object",
          "patternProperties": {
            "[0-z]+": {
              "$ref": "#/definitions/tagObject"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "schema": {
      "$ref": "https://json-schema.org/draft-07/schema#",
      "default": {}
    },
    "referenceObject": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "$ref"
      ],
      "properties": {
        "$ref": {
          "type": "string",
          "format": "uri-reference"
        }
      }
    },
    "errorObject": {
      "type": "object",
      "description": "Defines an application level error.",
      "additionalProperties": false,
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "description": "A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.",
          "type": "integer"
        },
        "message": {
          "description": "A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.",
          "type": "string"
        },
        "data": {
          "description": "A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.)."
        }
      }
    },
    "licenseObject": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "contactObject": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "infoObject": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "title",
        "version"
      ],
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "termsOfService": {
          "type": "string",
          "format": "uri"
        },
        "version": {
          "type": "string"
        },
        "contact": {
          "$ref": "#/definitions/contactObject"
        },
        "license": {
          "$ref": "#/definitions/licenseObject"
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "serverObject": {
      "type": "object",
      "required": [
        "url"
      ],
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "format": "uri"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        },
        "variables": {
          "type": "object",
          "patternProperties": {
            "[0-z]+": {
              "type": "object",
              "required": [
                "default"
              ],
              "properties": {
                "default": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "enum": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "linkObject": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "summary": {
          "type": "string"
        },
        "method": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "params": {
        },
        "server": {
          "$ref": "#/definitions/serverObject"
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "externalDocumentationObject": {
      "type": "object",
      "additionalProperties": false,
      "description": "information about external documentation",
      "required": [
        "url"
      ],
      "properties": {
        "description": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "methodObject": {
      "type": "object",
      "required": [
        "name",
        "result",
        "params"
      ],
      "additionalProperties": false,
      "properties": {
        "name": {
          "description": "The cannonical name for the method. The name MUST be unique within the methods array.",
          "type": "string",
          "minLength": 1
        },
        "description": {
          "description": "A verbose explanation of the method behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.",
          "type": "string"
        },
        "summary": {
          "description": "A short summary of what the method does.",
          "type": "string"
        },
        "tags": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/definitions/tagObject"
              },
              {
                "$ref": "#/definitions/referenceObject"
              }
            ]
          }
        },
        "paramStructure": {
          "type": "string",
          "description": "Format the server expects the params. Defaults to 'by-positon'.",
          "enum": [
            "by-position",
            "by-name"
          ],
          "default": "by-position"
        },
        "params": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/definitions/contentDescriptorObject"
              },
              {
                "$ref": "#/definitions/referenceObject"
              }
            ]
          }
        },
        "result": {
          "oneOf": [
            {
              "$ref": "#/definitions/contentDescriptorObject"
            },
            {
              "$ref": "#/definitions/referenceObject"
            }
          ]
        },
        "errors": {
          "description": "Defines an application level error.",
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/definitions/errorObject"
              },
              {
                "$ref": "#/definitions/referenceObject"
              }
            ]
          }
        },
        "links": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/definitions/linkObject"
              },
              {
                "$ref": "#/definitions/referenceObject"
              }
            ]
          }
        },
        "examples": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/definitions/examplePairingObject"
              },
              {
                "$ref": "#/definitions/referenceObject"
              }
            ]
          }
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "tagObject": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "externalDocs": {
          "$ref": "#/definitions/externalDocumentationObject"
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "exampleObject": {
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "summary": {
          "type": "string"
        },
        "value": {},
        "description": {
          "type": "string"
        },
        "name": {
          "type": "string",
          "minLength": 1
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    },
    "examplePairingObject": {
      "type": "object",
      "required": [
        "name",
        "params",
        "result"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "params": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/definitions/exampleObject"
              },
              {
                "$ref": "#/definitions/referenceObject"
              }
            ]
          }
        },
        "result": {
          "oneOf": [
            {
              "$ref": "#/definitions/exampleObject"
            },
            {
              "$ref": "#/definitions/referenceObject"
            }
          ]
        }
      }
    },
    "contentDescriptorObject": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name",
        "schema"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        },
        "schema": {
          "$ref": "#/definitions/schema"
        },
        "required": {
          "type": "boolean"
        }
      },
      "patternProperties": {
        "^x-": {}
      }
    }
  }
}