chore: Sync account schemas#625
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
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-go studio · code · diff
✅ grid-typescript studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-python studio · code · diff
✅ grid-csharp 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 SummaryAdds
Confidence Score: 4/5Schema changes are internally consistent and match established patterns; the main concern is that making The field definition, constraints, and examples are all correct and consistent with the rest of the common schema library. However, adding a new required field to existing request schemas means any API consumer that currently omits
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/common/GtqAccountInfoBase.yaml | Adds bankName as a required field consistent with other currency AccountInfoBase schemas (e.g., PHP, SGD, CNY); constraints (minLength 1, maxLength 255) match the established pattern. |
| openapi/components/schemas/common/JmdAccountInfoBase.yaml | Adds bankName as a required field; mirrors the same change made to GtqAccountInfoBase.yaml and is consistent with the rest of the common schema library. |
| openapi.yaml | Bundled/flattened OpenAPI spec updated with the same bankName additions for GtqAccountInfoBase and JmdAccountInfoBase; changes are consistent between the two schema files. |
| mintlify/openapi.yaml | Mintlify-facing bundled spec updated identically to openapi.yaml; no discrepancies between the two bundled files. |
Entity Relationship Diagram
%%{init: {'theme': 'neutral'}}%%
erDiagram
GtqAccountInfoBase {
string accountType "enum: GTQ_ACCOUNT"
string accountNumber "minLength:1 maxLength:34"
string bankAccountType "enum: CHECKING|SAVINGS"
string bankName "NEW minLength:1 maxLength:255"
}
GtqAccountInfo {
array paymentRails "enum: BANK_TRANSFER"
}
GtqAccountInfo ||--|| GtqAccountInfoBase : "allOf"
JmdAccountInfoBase {
string accountType "enum: JMD_ACCOUNT"
string accountNumber "minLength:1 maxLength:34"
string branchCode "pattern: ^[0-9]{5}$"
string bankAccountType "enum: CHECKING|SAVINGS"
string bankName "NEW minLength:1 maxLength:255"
}
JmdAccountInfo {
array paymentRails "enum: BANK_TRANSFER"
}
JmdAccountInfo ||--|| JmdAccountInfoBase : "allOf"
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
erDiagram
GtqAccountInfoBase {
string accountType "enum: GTQ_ACCOUNT"
string accountNumber "minLength:1 maxLength:34"
string bankAccountType "enum: CHECKING|SAVINGS"
string bankName "NEW minLength:1 maxLength:255"
}
GtqAccountInfo {
array paymentRails "enum: BANK_TRANSFER"
}
GtqAccountInfo ||--|| GtqAccountInfoBase : "allOf"
JmdAccountInfoBase {
string accountType "enum: JMD_ACCOUNT"
string accountNumber "minLength:1 maxLength:34"
string branchCode "pattern: ^[0-9]{5}$"
string bankAccountType "enum: CHECKING|SAVINGS"
string bankName "NEW minLength:1 maxLength:255"
}
JmdAccountInfo {
array paymentRails "enum: BANK_TRANSFER"
}
JmdAccountInfo ||--|| JmdAccountInfoBase : "allOf"
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/GtqAccountInfoBase.yaml:6
**Breaking change — `bankName` is now required for GTQ and JMD accounts**
Adding `bankName` to the `required` array is a backward-incompatible change for any existing API consumers that currently submit GTQ or JMD account payloads without this field. Callers who have already stored or cached payloads without `bankName` will start receiving validation errors. The same applies to `JmdAccountInfoBase.yaml`. Please confirm this is intentional and that downstream VASP adapters / existing integrations have been updated (or will be updated atomically) before this schema is deployed.
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}
| - accountType | ||
| - accountNumber | ||
| - bankAccountType | ||
| - bankName |
There was a problem hiding this comment.
bankName is now required for GTQ and JMD accounts
Adding bankName to the required array is a backward-incompatible change for any existing API consumers that currently submit GTQ or JMD account payloads without this field. Callers who have already stored or cached payloads without bankName will start receiving validation errors. The same applies to JmdAccountInfoBase.yaml. Please confirm this is intentional and that downstream VASP adapters / existing integrations have been updated (or will be updated atomically) before this schema is deployed.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/GtqAccountInfoBase.yaml
Line: 6
Comment:
**Breaking change — `bankName` is now required for GTQ and JMD accounts**
Adding `bankName` to the `required` array is a backward-incompatible change for any existing API consumers that currently submit GTQ or JMD account payloads without this field. Callers who have already stored or cached payloads without `bankName` will start receiving validation errors. The same applies to `JmdAccountInfoBase.yaml`. Please confirm this is intentional and that downstream VASP adapters / existing integrations have been updated (or will be updated atomically) before this schema is deployed.
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!
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.