openrpc.json

An OpenRPC document. Documentation: https://open-rpc.org for more information

Type object
File match openrpc.json openrpc.yml openrpc.yaml open-rpc.json open-rpc.yml open-rpc.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/openrpc-json/latest.json
Source https://meta.open-rpc.org/

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

openrpc string required
Values: "1.3.2" "1.3.1" "1.3.0" "1.2.6" "1.2.5" "1.2.4" "1.2.3" "1.2.2" "1.2.1" "1.2.0" "1.1.12" "1.1.11" "1.1.10" "1.1.9" "1.1.8" "1.1.7" "1.1.6" "1.1.5" "1.1.4" "1.1.3" "1.1.2" "1.1.1" "1.1.0" "1.0.0" "1.0.0-rc1" "1.0.0-rc0"
info object required
6 nested properties
title string required
version string required
description string
termsOfService string
format=uri
contact object
3 nested properties
name string
email string
url string
license object
2 nested properties
name string
url string
methods methodObject | referenceObject[] required
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
servers serverObject[]
components object
7 nested properties
schemas object
links object
errors object
examples object
examplePairings object
contentDescriptors object
tags object
$schema string

JSON Schema URI (used by some editors)

Default: "https://meta.open-rpc.org/"

Definitions

specificationExtension
JSONSchema Latest Meta.json Schema.tools
referenceObject object
$ref $ref required
errorObject object

Defines an application level error.

code integer required

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.

message string required

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data

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 object
name string
url string
contactObject object
name string
email string
url string
infoObject object
title string required
version string required
description string
termsOfService string
format=uri
contact object
3 nested properties
name string
email string
url string
license object
2 nested properties
name string
url string
serverObject object
url string required
format=uri
name string
description string
summary string
variables object
linkObject object
name string
minLength=1
summary string
method string
description string
params
server object
5 nested properties
url string required
format=uri
name string
description string
summary string
variables object
externalDocumentationObject object

information about external documentation

url string required
format=uri
description string
methodObject object
name string required

The cannonical name for the method. The name MUST be unique within the methods array.

minLength=1
params contentDescriptorObject | referenceObject[] required
description string

A verbose explanation of the method behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.

summary string

A short summary of what the method does.

servers serverObject[]
tags tagObject | referenceObject[]
paramStructure string

Format the server expects the params. Defaults to 'either'.

Default: "either"
Values: "by-position" "by-name" "either"
result contentDescriptorObject | referenceObject
errors errorObject | referenceObject[]

Defines an application level error.

links linkObject | referenceObject[]
examples examplePairingObject | referenceObject[]
deprecated boolean
Default: false
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
tagObject object
name string required
minLength=1
description string
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
exampleObject object
value required
name string required
minLength=1
summary string
description string
examplePairingObject object
name string required
minLength=1
params exampleObject | referenceObject[] required
description string
result exampleObject | referenceObject
contentDescriptorObject object
name string required
minLength=1
schema Latest Meta.json Schema.tools required
description string
summary string
required boolean
Default: false
deprecated boolean
Default: false