Skip to content

Commit bf78bd0

Browse files
authored
Merge pull request #387 from open-rpc/fix/example-pairing-error
Fix/example pairing error
2 parents 0e08a5c + ee45299 commit bf78bd0

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

spec.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,8 @@ Field Name | Type | Description
236236
<a name="example-pairing-description"></a>description | `string` | A verbose explanation of the example pairing.
237237
<a name="example-pairing-summary"></a>summary | `string` | Short description for the example pairing.
238238
<a name="example-pairing-params"></a>params | [[Example Object](#example-object) \| [Reference Object](#reference-object)] | **REQUIRED** Example parameters.
239-
<a name="example-result"></a>result | [Example Object](#example-object) \| [Reference Object](#reference-object) | Example result. When undefined, the example pairing represents usage of the method as a notification.
239+
<a name="example-pairing-result"></a>result | [Example Object](#example-object) \| [Reference Object](#reference-object) | Example result. When not provided, the example pairing represents usage of the method as a notification.
240+
<a name="example-pairing-error"></a>error | [Example Object](#example-object) \| [Reference Object](#reference-object) | Represents an example error response. The provided [Example Object](#example-object) MUST have the entire error object as its value. If provided, the [`examplePairing.result`](#example-pairing-result) must not be provided.
240241

241242
This object MAY be extended with [Specification Extensions](#specification-extensions).
242243

0 commit comments

Comments
 (0)