Repository navigation
fix: nest PaymentHandler.display_order under properties (#279) - #284
Open
wakqasahmed wants to merge 1 commit into
Open
wakqasahmed wants to merge 1 commit into
wakqasahmed wants to merge 1 commit into
Conversation
…erce-protocol#279) display_order was indented as a sibling of properties/required in openapi.agentic_checkout.yaml, so additionalProperties: false silently rejected the field its own description tells merchants to send. Nest it under properties in the 2026-04-17 and unreleased specs to match the already-correct JSON Schema mirror.
Author
|
Hi @prasad-stripe @lhwa — noticed this PR doesn't have a reviewer assigned yet — it's been about 5 days, CI is green and it's mergeable. Would you (or whoever's best placed) be able to take a look when you get a chance, or point me to who should? Thanks! |
Author
|
Hi @prasad-stripe @lhwa — checking back in — no reviewer yet, about 13 days quiet. Happy to make any changes needed. |
This branch has not been deployed
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.
Fix PaymentHandler.display_order OpenAPI indentation
🔧 Type of Change
📝 Description
In
openapi.agentic_checkout.yaml(both2026-04-17andunreleased),PaymentHandler.display_orderis indented as a sibling ofproperties:/required:rather than nested insideproperties:. Sincedisplay_orderisn't a recognized OpenAPI/JSON-Schema keyword at the schema-object level, it's silently ignored there — and becausePaymentHandlersetsadditionalProperties: false, a handler object that actually setsdisplay_order(exactly what the field's own description invites merchants to do) fails schema validation with "unexpected field display_order".The JSON Schema mirror (
schema.agentic_checkout.json) already nestsdisplay_ordercorrectly underpropertiesin both versions — only the hand-maintained OpenAPI YAML had the indentation bug, so this brings the two representations back in sync.🎯 Motivation and Context
Fixes/Addresses: #279
🧪 Testing
display_ordernow resolves undercomponents.schemas.PaymentHandler.properties.pnpm install && pnpm run validate:all— full validation suite passes (field types, descriptions, examples-against-schema across all versions), including the existingdisplay_orderexample entries inexamples/2026-04-17/examples.agentic_checkout.jsonandexamples/unreleased/examples.agentic_checkout.json, which now validate against the corrected schema.✅ Checklist
changelog/unreleased/fix-payment-handler-display-order-indentation.md🔍 Scope Verification
📚 Additional Notes
Two-line indentation fix, scoped only to the affected schema — no behavior/field changes beyond making
display_orderactually usable per its own documented intent.