docs: sync account type fields with OpenAPI schemas#548
Conversation
Update documentation and Grid Visualizer to match recent schema changes: - Add missing bankName field to COP mobile money example in docs - Update Grid Visualizer account-types.ts: - BDT_ACCOUNT: add required bankName field - COP_ACCOUNT: add required bankName and bankAccountType fields - EGP_ACCOUNT: fix fields to match schema (iban for bank transfer, not accountNumber) - GHS_ACCOUNT: add required bankName field - PKR_ACCOUNT: reorder fields with bankName first (required for all rails) Syncs with: - bfdf3e7 chore: Sync account schemas (#546) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Greptile SummaryThis PR syncs the Grid Visualizer's
Confidence Score: 4/5Safe to merge — changes are documentation and visualizer data only, with no runtime logic affected. All field changes in account-types.ts align with the OpenAPI base schemas. The only gap is in the COP Note block in external-accounts.mdx, which omits bankName from its mobile-money requirements prose while the example above it correctly includes it. mintlify/snippets/external-accounts.mdx — the COP Note's description of mobile-money requirements should mention bankName alongside phoneNumber.
|
| Filename | Overview |
|---|---|
| components/grid-visualizer/src/data/account-types.ts | Adds bankName as required first field to BDT, COP, EGP, GHS, and PKR account specs; fixes EGP to use iban (not accountNumber/swiftCode); adds bankAccountType to COP — all verified against the OpenAPI base schemas. |
| mintlify/snippets/external-accounts.mdx | Adds required bankName field to COP mobile money example; the accompanying Note still states only phoneNumber is required for mobile money, creating an inconsistency with both the example and the schema. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[External Account Creation] --> B{Account Type}
B --> BDT[BDT_ACCOUNT]
B --> COP[COP_ACCOUNT]
B --> EGP[EGP_ACCOUNT]
B --> GHS[GHS_ACCOUNT]
B --> PKR[PKR_ACCOUNT]
BDT --> BDT_R[Required: bankName]
BDT_R --> BDT_Rail{paymentRails}
BDT_Rail --> |BANK_TRANSFER| BDT_BT[+ accountNumber]
BDT_Rail --> |MOBILE_MONEY| BDT_MM[+ phoneNumber]
COP --> COP_R[Required: bankName]
COP_R --> COP_Rail{paymentRails}
COP_Rail --> |BANK_TRANSFER| COP_BT[+ accountNumber + bankAccountType]
COP_Rail --> |MOBILE_MONEY| COP_MM[+ phoneNumber]
EGP --> EGP_R[Required: bankName]
EGP_R --> EGP_Rail{paymentRails}
EGP_Rail --> |BANK_TRANSFER| EGP_BT[+ iban]
EGP_Rail --> |MOBILE_MONEY| EGP_MM[+ phoneNumber]
GHS --> GHS_R[Required: bankName]
GHS_R --> GHS_Rail{paymentRails}
GHS_Rail --> |BANK_TRANSFER| GHS_BT[+ accountNumber]
GHS_Rail --> |MOBILE_MONEY| GHS_MM[+ phoneNumber]
PKR --> PKR_R[Required: bankName]
PKR_R --> PKR_Rail{paymentRails}
PKR_Rail --> |BANK_TRANSFER| PKR_BT[+ accountNumber]
PKR_Rail --> |MOBILE_MONEY| PKR_MM[+ phoneNumber]
Comments Outside Diff (1)
-
mintlify/snippets/external-accounts.mdx, line 223 (link)The
<Note>states that mobile money only requiresphoneNumber, butbankNameis also globally required per the COP schema (required: [accountType, bankName]). The example above the note now correctly includesbankName, but the note's prose leaves users who read it in isolation with an incomplete picture of mobile money requirements.Prompt To Fix With AI
This is a comment left during a code review. Path: mintlify/snippets/external-accounts.mdx Line: 223 Comment: The `<Note>` states that mobile money only requires `phoneNumber`, but `bankName` is also globally required per the COP schema (`required: [accountType, bankName]`). The example above the note now correctly includes `bankName`, but the note's prose leaves users who read it in isolation with an incomplete picture of mobile money requirements. 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!
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
mintlify/snippets/external-accounts.mdx:223
The `<Note>` states that mobile money only requires `phoneNumber`, but `bankName` is also globally required per the COP schema (`required: [accountType, bankName]`). The example above the note now correctly includes `bankName`, but the note's prose leaves users who read it in isolation with an incomplete picture of mobile money requirements.
```suggestion
Mobile money requires `bankName` (provider name, e.g., Nequi or Daviplata) and `phoneNumber` in international format (e.g., +573001234567).
```
Reviews (1): Last reviewed commit: "docs: sync account type fields with Open..." | Re-trigger Greptile
Summary
Updates documentation and Grid Visualizer to match recent OpenAPI schema changes for account types (BDT, COP, EGP, GHS, PKR).
Changes:
bankNamefield to Colombia (COP) mobile money examplebankNamefieldbankNameandbankAccountTypefieldsibanfor bank transfer, notaccountNumber; remove non-existentswiftCode)bankNamefieldbankNamefirst (required for all rails, not just mobile money)Related commits:
Test plan
make lint)bankName🤖 Generated with Claude Code