From 92f6d0fedb046ba4461e357807a53940b7a2c63f Mon Sep 17 00:00:00 2001 From: Sakina Date: Fri, 24 Apr 2026 12:49:24 -0400 Subject: [PATCH] docs: harmonize path field description across message schemas MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Unify the `path` field description across `message_error.json`, `message_warning.json`, and `message_info.json` so all three share the same wording and example. Also fixes a stale example in `message_error.json` that referenced `$.items[1]` — no `items` field exists on checkout, cart, or order responses; the actual field is `line_items`. --- source/schemas/common/types/message_error.json | 2 +- source/schemas/common/types/message_info.json | 2 +- source/schemas/common/types/message_warning.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/schemas/common/types/message_error.json b/source/schemas/common/types/message_error.json index 35533ce2a..36b179aef 100644 --- a/source/schemas/common/types/message_error.json +++ b/source/schemas/common/types/message_error.json @@ -20,7 +20,7 @@ }, "path": { "type": "string", - "description": "RFC 9535 JSONPath to the component the message refers to (e.g., $.items[1])." + "description": "RFC 9535 JSONPath to the component the message refers to (e.g., $.line_items[0])." }, "content_type": { "type": "string", diff --git a/source/schemas/common/types/message_info.json b/source/schemas/common/types/message_info.json index 74ee2986b..7ca54d04d 100644 --- a/source/schemas/common/types/message_info.json +++ b/source/schemas/common/types/message_info.json @@ -15,7 +15,7 @@ }, "path": { "type": "string", - "description": "RFC 9535 JSONPath to the component the message refers to." + "description": "RFC 9535 JSONPath to the component the message refers to (e.g., $.line_items[0])." }, "code": { "$ref": "info_code.json" diff --git a/source/schemas/common/types/message_warning.json b/source/schemas/common/types/message_warning.json index a87400740..92f034723 100644 --- a/source/schemas/common/types/message_warning.json +++ b/source/schemas/common/types/message_warning.json @@ -16,7 +16,7 @@ }, "path": { "type": "string", - "description": "JSONPath (RFC 9535) to related field (e.g., $.line_items[0])." + "description": "RFC 9535 JSONPath to the component the message refers to (e.g., $.line_items[0])." }, "code": { "$ref": "warning_code.json"