chore: Sync account schemas#545
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
github-actions
Bot
added
the
breaking-change
|
✱ Stainless preview builds for gridThis PR will update the cli csharp go kotlin openapi php python ruby typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-openapi studio · code · diff
✅ grid-ruby studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-typescript studio · code · diff
✅ grid-python studio · code · diff
✅ grid-csharp studio · code · diff
✅ grid-go studio · code · diff
✅ grid-php studio · code · diff
✅ grid-cli studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryThis PR syncs account info schemas auto-generated from VASP adapter field definitions in sparkcore, adding
Confidence Score: 3/5Adding The USD changes are fully backward-compatible optional additions. However, All five *AccountInfoBase.yaml files that add
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/common/UsdAccountInfoBase.yaml | Adds optional accountHolderName (string) and bankAddress ($ref: Address.yaml) fields — both non-required, backward-compatible addition. |
| openapi/components/schemas/common/BdtAccountInfoBase.yaml | Adds bankName as a globally required field and property — breaking change for existing BDT BANK_TRANSFER consumers who omit it. |
| openapi/components/schemas/common/CopAccountInfoBase.yaml | Adds bankName as globally required — breaking for existing COP consumers; also adds it to MOBILE_MONEY description (was absent before). |
| openapi/components/schemas/common/EgpAccountInfoBase.yaml | Adds bankName as globally required — breaking for existing EGP BANK_TRANSFER consumers who currently submit only iban. |
| openapi/components/schemas/common/GhsAccountInfoBase.yaml | Adds bankName as globally required — breaking for existing GHS consumers sending BANK_TRANSFER without it. |
| openapi/components/schemas/common/PkrAccountInfoBase.yaml | Promotes bankName from optional-with-MOBILE_MONEY-description to globally required; reorders property definition to top — breaking for PKR BANK_TRANSFER consumers. |
| openapi.yaml | Generated bundle reflecting all source schema changes; correctly rebundled per make build convention. |
| mintlify/openapi.yaml | Generated Mintlify bundle, mirrors root openapi.yaml changes for docs rendering. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Account Schema Sync] --> B[UsdAccountInfoBase]
A --> C[BdtAccountInfoBase]
A --> D[CopAccountInfoBase]
A --> E[EgpAccountInfoBase]
A --> F[GhsAccountInfoBase]
A --> G[PkrAccountInfoBase]
B --> B1["+ accountHolderName (optional)"]
B --> B2["+ bankAddress → Address (optional)"]
C --> C1["+ bankName (NOW REQUIRED)"]
D --> D1["+ bankName (NOW REQUIRED)"]
E --> E1["+ bankName (NOW REQUIRED)"]
F --> F1["+ bankName (NOW REQUIRED)"]
G --> G1["bankName promoted to REQUIRED\n(was optional for BANK_TRANSFER)"]
C1 --> R[required array: accountType, bankName]
D1 --> R
E1 --> R
F1 --> R
G1 --> R
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/BdtAccountInfoBase.yaml:1-5
**Breaking change: `bankName` added to global `required` array**
`bankName` is now unconditionally required at the schema level for `BdtAccountInfoBase`, `CopAccountInfoBase`, `EgpAccountInfoBase`, and `GhsAccountInfoBase`. Any existing API consumers who submit these account types without a `bankName` — valid before this sync — will now receive a validation error. For `PkrAccountInfoBase`, `bankName` was already a property but was documented as only required for `MOBILE_MONEY`; it's now required for `BANK_TRANSFER` as well. If the underlying sparkcore service already enforces this, the schema is simply catching up with reality. If not, this constitutes an externally visible breaking change that should be communicated to API consumers before deploying.
Reviews (1): Last reviewed commit: "chore: Sync account schemas" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| type: object | ||
| required: | ||
| - accountType | ||
| - bankName | ||
| description: 'Required fields depend on the selected paymentRails: |
There was a problem hiding this comment.
bankName added to global required array
bankName is now unconditionally required at the schema level for BdtAccountInfoBase, CopAccountInfoBase, EgpAccountInfoBase, and GhsAccountInfoBase. Any existing API consumers who submit these account types without a bankName — valid before this sync — will now receive a validation error. For PkrAccountInfoBase, bankName was already a property but was documented as only required for MOBILE_MONEY; it's now required for BANK_TRANSFER as well. If the underlying sparkcore service already enforces this, the schema is simply catching up with reality. If not, this constitutes an externally visible breaking change that should be communicated to API consumers before deploying.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/BdtAccountInfoBase.yaml
Line: 1-5
Comment:
**Breaking change: `bankName` added to global `required` array**
`bankName` is now unconditionally required at the schema level for `BdtAccountInfoBase`, `CopAccountInfoBase`, `EgpAccountInfoBase`, and `GhsAccountInfoBase`. Any existing API consumers who submit these account types without a `bankName` — valid before this sync — will now receive a validation error. For `PkrAccountInfoBase`, `bankName` was already a property but was documented as only required for `MOBILE_MONEY`; it's now required for `BANK_TRANSFER` as well. If the underlying sparkcore service already enforces this, the schema is simply catching up with reality. If not, this constitutes an externally visible breaking change that should be communicated to API consumers before deploying.
How can I resolve this? If you propose a fix, please make it concise.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
|
Superseded by #546 |
lightspark-copybara
Bot
deleted the
auto/sync-grid-schemas-20260603-174007
branch
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.