Repository navigation
docs(checkout-rest): cover ucp-agent in the example signed request - #795
Merged
damaz91 merged 1 commit intoOct 14, 2026
Conversation
vishkaty
force-pushed
the
docs/rest-signed-example-covers-ucp-agent
branch
from
September 11, 2026 04:26
efea311 to
1b5119f
Compare
damaz91
requested review from
mmohades
and removed request for
niranjanmanjunath
September 21, 2026 10:42
Contributor
|
Can a maintainer take a look at this simple change? @mmohades @knightlin-shopify |
The Example Signed Request in the checkout REST binding carries a UCP-Agent header, but its Signature-Input covers only "@method" "@authority" "@path" "idempotency-key" "content-digest" "content-type". The identity resolution gate in overview/index.md states that a signature MUST cover ucp-agent, signature-agent and idempotency-key when those headers are present, and that a verifier MUST skip a signature whose covered set omits any of them, since a header the signature does not cover is treated as unsigned. The example therefore shows a request whose signature a conformant verifier is required to skip, in the one place an implementer copies from. Adds "ucp-agent" to the covered set, which makes its covered set identical to the canonical REST request example in signatures.md line 515, the document this section links to for the complete signing algorithm. The two examples still differ elsewhere, for instance in their keyid. No normative text changes. validate_examples.py 343 passed, 0 failed, 50 skipped and test_validate_examples.py 52 passed on a test merge into main 1d39948 on 2026-09-01, both unchanged by this commit, because the example is an unannotated http fence that no CI job inspects. cspell clean on the changed file.
vishkaty
force-pushed
the
docs/rest-signed-example-covers-ucp-agent
branch
from
October 11, 2026 23:58
1b5119f to
cc37629
Compare
This was referenced Oct 11, 2026
8 of 11 tasks
damaz91
requested review from
karangoel16 and
xiaoxuanz-hub
and removed request for
knightlin-shopify and
mmohades
October 12, 2026 07:36
karangoel16
approved these changes
Oct 12, 2026
xiaoxuanz-hub
approved these changes
Oct 14, 2026
7 of 17 tasks
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
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.
Fixes #794
What this changes
Adds
"ucp-agent"to the covered components of the Example Signed Request in the checkout REST binding,docs/specification/shopping/checkout/rest.mdline 1430.Before:
After:
The example already prints a
UCP-Agentheader.signatures.mdmakesucp-agenta conditionally required covered component at line 434, with the footnote at line 442 reading "Required ifUCP-Agentheader is present", and the verifier pseudocode at lines 715 to 721 reachescoverage_insufficientand skips a signature that omits it.overview/index.mdline 1662 carries the same closed set. So the example as shipped models a request a conformant verifier will not authenticate.The resulting covered set is identical to the canonical REST request example at
signatures.mdline 515, which is the document this section links to for the complete signing algorithm. The two examples still differ elsewhere, for instance in theirkeyid.Scope
One line. No normative text changes, no schema changes, no new prose.
Rebased onto main
ad9950baon 2026-10-11; the branch was 28 commits behind and the hunk is unchanged by the rebase apart from its line number.Corrected since this was opened. The body previously cited line 1440 for the change and
overview/index.mdline 2435 for the requirement; both have drifted and line 2435 is now blank. It also carried the sweep from the linked issue, 13 fenced blocks with 2 violations, and said this PR and #659 closed the class between them. That is no longer the count. On main today, of the 9 signed example blocks underdocs/specificationthat print aUCP-Agentheader, 3 omit the component: this one,shopping/order/index.mdline 751 in open PR #659, andlodging/booking/rest.mdline 1589 in open PR #934. The third arrived with #780 in September, after the issue was written. The class reaches zero when all three land, and the three merge clean with each other and with main.Test plan
scripts/validate_examples.py --schema-base source/schemas/: 398 passed, 0 failed, 0 errors, 53 skipped.scripts/test_validate_examples.py: 59 passed.ucp-schema lint source/: 145 files, all passed.All measured on the rebased branch, and all unchanged against unmodified main as the control. That is expected rather than reassuring: the example is a
```httpfence, whichvalidate_examples.pyskips by language, so no CI job here inspects a covered set. The mechanical check that does catch it compares, per fenced block, the headers the block carries against the components its ownSignature-Inputnames; it flags this block before the change and not after, and reverting the one line makes it flag again.