docs: sync documentation with SLV_ACCOUNT schema changes#464
Conversation
Sync documentation with recent OpenAPI changes from commit 39dd985: - Add El Salvador tab to external-accounts.mdx with bank transfer and mobile money (Tigo Money) examples - Add SLV_ACCOUNT to Grid Visualizer account-types.ts - Add El Salvador USD entry to Grid Visualizer currencies.ts Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Greptile SummaryThis PR syncs documentation and the Grid Visualizer with the
Confidence Score: 3/5The Grid Visualizer changes are correct and safe to merge; the documentation has a factual inaccuracy about required fields and a missing table entry that should be resolved before publishing. The in the El Salvador tab tells developers that bankName is required for Bank Transfer, but the OpenAPI schema only mandates accountNumber and bankAccountType — bankName is optional. This mismatch between the published docs and the schema is present on the live documentation path. The missing row for El Salvador in the required beneficiary fields table compounds the gap. mintlify/snippets/external-accounts.mdx — the required-fields note and the beneficiary table both need correction before this ships.
|
| Filename | Overview |
|---|---|
| mintlify/snippets/external-accounts.mdx | Adds El Salvador tab with Bank Transfer and Mobile Money examples; field names match the OpenAPI schema, but the Note incorrectly lists bankName as required (it is optional per SlvAccountInfoBase.yaml), and El Salvador is omitted from the minimum required beneficiary fields table. |
| components/grid-visualizer/src/data/account-types.ts | Adds SLV_ACCOUNT spec with correct field names, examples, and descriptions matching the OpenAPI schema; beneficiaryRequired: true aligns with the schema. |
| components/grid-visualizer/src/data/currencies.ts | Adds El Salvador USD entry with correct countryCode: 'sv', accountType: 'SLV_ACCOUNT', and rails matching the schema; consistent with existing currency entries. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[POST /customers/external-accounts] --> B{accountType == SLV_ACCOUNT?}
B -- No --> C[Existing account types]
B -- Yes --> D{Which rail?}
D -- BANK_TRANSFER --> E[Required: accountNumber, bankAccountType\nOptional: bankName]
D -- MOBILE_MONEY --> F[Required: phoneNumber\ne.g. +50312345678]
E --> G[beneficiary required\nfullName + beneficiaryType]
F --> G
G --> H[External Account Created]
Comments Outside Diff (1)
-
mintlify/snippets/external-accounts.mdx, line 810-817 (link)El Salvador missing from the required beneficiary fields table
The table documents minimum required beneficiary fields per country, but El Salvador (
SLV_ACCOUNT) is not added. TheSlvBeneficiary.yamlschema marksbeneficiaryTypeandfullNameas required, with address being optional. Without a row for El Salvador, developers have no authoritative reference for what they must include — particularly whetheraddressorbirthDateare mandatory for compliance.Prompt To Fix With AI
This is a comment left during a code review. Path: mintlify/snippets/external-accounts.mdx Line: 810-817 Comment: **El Salvador missing from the required beneficiary fields table** The table documents minimum required beneficiary fields per country, but El Salvador (`SLV_ACCOUNT`) is not added. The `SlvBeneficiary.yaml` schema marks `beneficiaryType` and `fullName` as required, with address being optional. Without a row for El Salvador, developers have no authoritative reference for what they must include — particularly whether `address` or `birthDate` are mandatory for compliance. How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 2
mintlify/snippets/external-accounts.mdx:215-218
**`bankName` listed as required, but OpenAPI schema marks it as optional**
The `<Note>` states "Bank transfer requires `bankName`, `accountNumber`, and `bankAccountType`", but `SlvAccountInfoBase.yaml` only lists `bankAccountType` and `accountNumber` as conditionally required for the `BANK_TRANSFER` rail — `bankName` has no `required` annotation in the schema. Documenting an optional field as mandatory could confuse developers who omit it (expecting it to be optional per the spec) or who encounter a mismatch between the docs and any client-side validation they derive from the OpenAPI spec.
### Issue 2 of 2
mintlify/snippets/external-accounts.mdx:810-817
**El Salvador missing from the required beneficiary fields table**
The table documents minimum required beneficiary fields per country, but El Salvador (`SLV_ACCOUNT`) is not added. The `SlvBeneficiary.yaml` schema marks `beneficiaryType` and `fullName` as required, with address being optional. Without a row for El Salvador, developers have no authoritative reference for what they must include — particularly whether `address` or `birthDate` are mandatory for compliance.
Reviews (1): Last reviewed commit: "docs: add SLV_ACCOUNT documentation for ..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| <Note> | ||
| Bank transfer requires `bankName`, `accountNumber`, and `bankAccountType` (CHECKING or SAVINGS). | ||
| Mobile money requires `phoneNumber` in international format (e.g., +50312345678). | ||
| </Note> |
There was a problem hiding this comment.
bankName listed as required, but OpenAPI schema marks it as optional
The <Note> states "Bank transfer requires bankName, accountNumber, and bankAccountType", but SlvAccountInfoBase.yaml only lists bankAccountType and accountNumber as conditionally required for the BANK_TRANSFER rail — bankName has no required annotation in the schema. Documenting an optional field as mandatory could confuse developers who omit it (expecting it to be optional per the spec) or who encounter a mismatch between the docs and any client-side validation they derive from the OpenAPI spec.
Prompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/snippets/external-accounts.mdx
Line: 215-218
Comment:
**`bankName` listed as required, but OpenAPI schema marks it as optional**
The `<Note>` states "Bank transfer requires `bankName`, `accountNumber`, and `bankAccountType`", but `SlvAccountInfoBase.yaml` only lists `bankAccountType` and `accountNumber` as conditionally required for the `BANK_TRANSFER` rail — `bankName` has no `required` annotation in the schema. Documenting an optional field as mandatory could confuse developers who omit it (expecting it to be optional per the spec) or who encounter a mismatch between the docs and any client-side validation they derive from the OpenAPI spec.
How can I resolve this? If you propose a fix, please make it concise.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
1 participant
Summary
Sync documentation and Grid Visualizer with recent OpenAPI schema changes, specifically the new
SLV_ACCOUNTexternal account type for El Salvador added in commit 39dd985.Changes
Mintlify Documentation (
mintlify/snippets/external-accounts.mdx)bankName,accountNumber,bankAccountType)phoneNumberin international format)Grid Visualizer (
components/grid-visualizer/src/data/)SLV_ACCOUNTtoaccount-types.tswith field specs for both railscurrencies.ts(countryCode:sv, accountType:SLV_ACCOUNT)Not Updated
Kotlin Sample App - Requires SDK updates first. The sample app imports SDK model classes (
SlvExternalAccountCreateInfo,SlvBeneficiary) that need to be generated from the OpenAPI spec before the sample can be updated.Related Commits Reviewed
Other changes (auth session refresh, wallet privacy, signed request ID examples) were already documented or don't require documentation updates.
Test plan
make lintpasses🤖 Generated with Claude Code