docs: add message.path field conventions to Error Handling#397
Open
sbeashwar wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
Open
docs: add message.path field conventions to Error Handling#397sbeashwar wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
sbeashwar wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
Conversation
Author
|
@yanheChen @alexpark20 @sakinaroufid friendly bump on this - docs addition for the |
Contributor
+1 |
jingyli
reviewed
May 5, 2026
Contributor
jingyli
left a comment
jingyli
left a comment
There was a problem hiding this comment.
Thanks @sbeashwar for the doc enhancement! Added some comments, the biggest one is the usage of a non-existent field in UCP.
The path field appears in examples throughout the spec but has no prose explaining how to construct it. Add a conventions section under Error Handling covering: - RFC 9535 JSONPath, snake_case property names - Simple field references, indexed array access, filter expressions - Why filter expressions are preferred over index-based paths - Specificity rule (field-level path beats parent-level) - Create vs. Update keying difference (item.id vs line item id) Complements PR Universal-Commerce-Protocol#380 which fixes the schema descriptions on the message_* types.
sbeashwar
force-pushed
the
docs/message-path-conventions
branch
from
315ced6 to
d5f6805
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
pathfield on error/warning/info messages is used in examplesthroughout the spec but has no prose explaining how to construct it.
Changes to
checkout.md:pathin the Error Handling opening paragraph so readersknow it exists before hitting the severity table, with an anchor link
to the new subsection.
#### The path Fieldsubsection covering RFC 9535 JSONPath,snake_case convention, filter expressions, specificity rule, and
create-vs-update keying differences.
pathto theinvalid_phoneentry in the error processingexample (
$.buyer.contact.phone).pathtoidentify the specific field to fix, with fallback to
error.codewhen
pathis absent.Complements #380 (which fixes the schema descriptions on the
message_* types) with implementation guidance in the spec prose.