docs(checkout): add missing Discovery section to REST binding#509
Open
Mubeen-Fatima wants to merge 1 commit into
Open
Conversation
The REST binding doc was missing the Discovery subsection under
Protocol Fundamentals that both cart-rest.md and order-rest.md include.
Add the same section, scoped to declaring the checkout capability only.
The inserted block mirrors the structure used in the sibling docs:
short paragraph explaining how businesses advertise REST transport
availability via /.well-known/ucp, followed by a profile JSON example
that uses the {{ ucp_version }} macro from Universal-Commerce-Protocol#226.
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
1 participant
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.
Summary
Adds the missing
### Discoverysection todocs/specification/checkout-rest.md. Every other REST-binding spec page documents how the capability is advertised via the business's UCP profile at/.well-known/ucp— checkout was the only one without it.Why
cart-rest.mdandorder-rest.mdboth include a Discovery section between## Protocol Fundamentalsand### Base URL, with a sample UCP profile showing the relevant service + capability declaration.checkout-rest.mdskips straight from Protocol Fundamentals to Base URL, leaving readers without a worked example for the checkout capability — even though checkout is the canonical purchase-finalization flow.What changed
docs/specification/checkout-rest.md: +35 lines, insertion-only. New### Discoverysubsection placed in the same slot as in the sibling REST docs, with adev.ucp.shopping.checkoutcapability declaration and the same<!-- ucp:example schema=profile def=business_schema -->annotation used bycart-rest.md/order-rest.md.{{ ucp_version }}macro (per docs: fix broken links and add dynamic versioning #226) rather than hard-coded versions.Reference
cart-rest.md,order-rest.mdTest plan
{{ ucp_version }}macro substitutes to the right value on draft + release branches#authentication,#base-urletc. still resolve — verifiedorder.mdlink tocheckout-rest.md#authenticationis unaffected)