docs(split-payments): validate the allowed_combinations profile example - #658
Open
vishkaty wants to merge 1 commit into
Open
Conversation
The only business-profile example for the split payments extension was
annotated `ucp:example skip`, so CI never checked it, and it did not match
the profile schema three ways: `capabilities` was an array where the schema
defines an object map keyed by reverse-domain name, the entry omitted the
required `schema` URL, and it pinned `version: 2026-01-23`, a release that
does not contain this extension.
Rewrite the example in the `ucp.capabilities` map form with `spec`, `schema`,
`extends`, and `{{ ucp_version }}`, mirroring the buyer-consent profile
example, and replace the skip with a validated
`schema=profile def=business_schema` annotation so CI covers it going forward.
Full corpus: 283 passed (was 282), 47 skipped (was 48).
damaz91
added
the
status:needs-triage
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
3 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.
Problem
The only business-profile example for the split payments extension is annotated
<!-- ucp:example skip -->, so CI never validates it, and it does not match the profile schema in three ways:capabilitiesis an array, butucp.jsondefines it as an object map keyed by reverse-domain name.schemaURL (capability.jsonbusiness_schemarequiresschema)."version": "2026-01-23", a release that does not contain this extension.Validating the fragment against the profile schema fails on the
capabilitiestype and then on the missingschemaproperty; it passes once rewritten as a map with aschemaURL.Fix
Rewrite the example in the
ucp.capabilitiesmap form withspec,schema,extends, and{{ ucp_version }}, mirroring the buyer-consent profile example, and replace theskipannotation with a validatedschema=profile def=business_schemaannotation so CI covers it going forward.extends: ["dev.ucp.shopping.checkout"]reflectssplit_payments.json'srequireson checkout.Verification
scripts/validate_examples.pyfull corpus goes from 282 to 283 passing (48 to 47 skipped): the example flips from skipped to validated.ucp-schema lint source/unaffected.