Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix/example pairing error #387

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix/example pairing error #387

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d6a152
fix: examplePairingObject had a bad link for result
BelfordZ Apr 24, 2024
ee45299
fix: added error to examplePairingObject
BelfordZ Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,8 @@ Field Name | Type | Description
<a name="example-pairing-description"></a>description | `string` | A verbose explanation of the example pairing.
<a name="example-pairing-summary"></a>summary | `string` | Short description for the example pairing.
<a name="example-pairing-params"></a>params | [[Example Object](#example-object) \| [Reference Object](#reference-object)] | **REQUIRED** Example parameters.
<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.
<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.
<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.

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

Expand Down
Loading