From 0d6a152745d22af9f034b45a39b6d9061f99cd44 Mon Sep 17 00:00:00 2001 From: Zachary Belford Date: Wed, 24 Apr 2024 13:00:40 -0700 Subject: [PATCH 1/2] fix: examplePairingObject had a bad link for result --- spec.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec.md b/spec.md index 0f693bf..30d552c 100644 --- a/spec.md +++ b/spec.md @@ -236,7 +236,7 @@ Field Name | Type | Description description | `string` | A verbose explanation of the example pairing. summary | `string` | Short description for the example pairing. params | [[Example Object](#example-object) \| [Reference Object](#reference-object)] | **REQUIRED** Example parameters. -result | [Example Object](#example-object) \| [Reference Object](#reference-object) | Example result. When undefined, the example pairing represents usage of the method as a notification. +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. This object MAY be extended with [Specification Extensions](#specification-extensions). From ee452997d300bdec4d6e65590485ff077dd4dd23 Mon Sep 17 00:00:00 2001 From: Zachary Belford Date: Wed, 24 Apr 2024 13:00:52 -0700 Subject: [PATCH 2/2] fix: added error to examplePairingObject fixes #363 --- spec.md | 1 + 1 file changed, 1 insertion(+) diff --git a/spec.md b/spec.md index 30d552c..d6ddd9e 100644 --- a/spec.md +++ b/spec.md @@ -237,6 +237,7 @@ Field Name | Type | Description summary | `string` | Short description for the example pairing. params | [[Example Object](#example-object) \| [Reference Object](#reference-object)] | **REQUIRED** Example parameters. 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. +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).