chore: Sync account schemas#431
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✱ Stainless preview buildsThis PR will update the kotlin openapi python typescript
|
Greptile SummaryThis auto-synced PR updates the
Confidence Score: 4/5Safe to merge once the GTQ breaking change is confirmed intentional and downstream callers are updated. Five of the six schema changes are backwards-compatible relaxations. The one P1 finding — adding openapi/components/schemas/common/GtqBeneficiary.yaml — adding a new required field is a breaking change
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/common/GtqBeneficiary.yaml | Adds phoneNumber to required list — breaking change for existing GTQ beneficiary callers |
| openapi/components/schemas/common/JmdBeneficiary.yaml | Removes countryOfResidence from required list (keeps address and phoneNumber required) — backwards-compatible relaxation |
| openapi/components/schemas/common/BdtBeneficiary.yaml | Removes countryOfResidence from required list — backwards-compatible relaxation |
| openapi/components/schemas/common/GhsBeneficiary.yaml | Removes countryOfResidence from required list — backwards-compatible relaxation |
| openapi/components/schemas/common/HtgBeneficiary.yaml | Removes countryOfResidence from required list — backwards-compatible relaxation |
| openapi/components/schemas/common/PkrBeneficiary.yaml | Removes countryOfResidence from required list — backwards-compatible relaxation |
| openapi.yaml | Bundled spec updated to mirror all six YAML schema changes; reflects the GTQ breaking change at line ~10622 |
| mintlify/openapi.yaml | Mintlify copy of the spec updated identically to openapi.yaml — in sync |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
PR[Schema Sync PR] --> BDT & GHS & GTQ & HTG & JMD & PKR
BDT[BdtBeneficiary\nBangladesh Taka]
BDT --> BDT_R["required: beneficiaryType, fullName\n❌ countryOfResidence removed"]
GHS[GhsBeneficiary\nGhanaian Cedi]
GHS --> GHS_R["required: beneficiaryType, fullName\n❌ countryOfResidence removed"]
GTQ[GtqBeneficiary\nGuatemalan Quetzal]
GTQ --> GTQ_R["required: beneficiaryType, countryOfResidence, fullName\n✅ phoneNumber added ⚠️ breaking"]
HTG[HtgBeneficiary\nHaitian Gourde]
HTG --> HTG_R["required: beneficiaryType, fullName\n❌ countryOfResidence removed"]
JMD[JmdBeneficiary\nJamaican Dollar]
JMD --> JMD_R["required: beneficiaryType, address, fullName, phoneNumber\n❌ countryOfResidence removed"]
PKR[PkrBeneficiary\nPakistani Rupee]
PKR --> PKR_R["required: beneficiaryType, fullName\n❌ countryOfResidence removed"]
style GTQ fill:#ff9999
style GTQ_R fill:#ffcccc
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
openapi/components/schemas/common/GtqBeneficiary.yaml:7
**Breaking change: `phoneNumber` newly required for GTQ**
`phoneNumber` was previously optional in `GtqBeneficiary` and is now listed as a required field. Any existing client that submits a GTQ payment without `phoneNumber` will receive a validation error after this change goes live. The other five currency schemas in this PR only *remove* a required field (backwards-compatible), while this one *adds* one — which is a breaking change for consumers. Please confirm this is intentional and that downstream callers have been updated or given a migration window.
Reviews (1): Last reviewed commit: "chore: Sync account schemas" | Re-trigger Greptile
| - beneficiaryType | ||
| - countryOfResidence | ||
| - fullName | ||
| - phoneNumber |
There was a problem hiding this comment.
Breaking change:
phoneNumber newly required for GTQ
phoneNumber was previously optional in GtqBeneficiary and is now listed as a required field. Any existing client that submits a GTQ payment without phoneNumber will receive a validation error after this change goes live. The other five currency schemas in this PR only remove a required field (backwards-compatible), while this one adds one — which is a breaking change for consumers. Please confirm this is intentional and that downstream callers have been updated or given a migration window.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/GtqBeneficiary.yaml
Line: 7
Comment:
**Breaking change: `phoneNumber` newly required for GTQ**
`phoneNumber` was previously optional in `GtqBeneficiary` and is now listed as a required field. Any existing client that submits a GTQ payment without `phoneNumber` will receive a validation error after this change goes live. The other five currency schemas in this PR only *remove* a required field (backwards-compatible), while this one *adds* one — which is a breaking change for consumers. Please confirm this is intentional and that downstream callers have been updated or given a migration window.
How can I resolve this? If you propose a fix, please make it concise.
Auto-synced account schemas.
These schemas are generated from VASP adapter field definitions in sparkcore.
Synced schemas:
common/— per-currency account info, beneficiary, and payment account schemascommon/PaymentInstructions.yaml— payment instructions oneOf (new currencies added)external_accounts/— per-currency external account schemas (reference common/)Please review the changes before merging.