docs: Sync documentation with Ethereum L1 and currency schema changes - #288
docs: Sync documentation with Ethereum L1 and currency schema changes#288claude[bot] wants to merge 2 commits into
Conversation
Updates Grid Visualizer and Mintlify docs to reflect recent OpenAPI changes: - Add ETHEREUM_WALLET support to account-types.ts and crypto.ts for USDC - Add missing fiat currencies: AED (UAE), BWP (Botswana), XAF (Central Africa) - Add Ethereum L1 wallet example to external-accounts.mdx snippet - Fix invalid businessType example (FINTECH → FINANCE_AND_INSURANCE) Syncs with commits 9400e77 (Ethereum L1), afa928d (KYB schema), 5614055 (BRL). Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✱ Stainless preview buildsNo changes were made to the SDKs. This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryThis PR syncs documentation with recent OpenAPI schema changes by adding Ethereum L1 (USDC) wallet support and three new fiat currencies (AED, BWP, XAF) to the Grid Visualizer, extending the external accounts MDX snippet with a new Ethereum tab, and fixing an invalid All changes are additive and strictly follow existing conventions:
No issues found — the PR is clean and safe to merge. Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| components/grid-visualizer/src/data/account-types.ts | Adds ETHEREUM_WALLET, AED_ACCOUNT, BWP_ACCOUNT, and XAF_ACCOUNT specs; follows existing patterns correctly with no paymentRails for crypto wallets and beneficiaryRequired: false only for ETHEREUM_WALLET |
| components/grid-visualizer/src/data/crypto.ts | Adds ETHEREUM_WALLET entry to the USDC crypto asset, consistent with existing Solana/Polygon/Base wallet entries |
| components/grid-visualizer/src/data/currencies.ts | Adds AED, BWP, and XAF currency entries; AED uses Bank Transfer correctly, BWP and XAF use Mobile Money; XAF countryCode is 'cm' (Cameroon) which is appropriate as a representative country for the multi-country CFA franc |
| mintlify/snippets/external-accounts.mdx | Renames "Cryptocurrency" tab to "Bitcoin" and adds a new "Ethereum" tab with an L1 USDC cURL example; follows existing tab structure and formatting conventions |
| openapi/paths/customers/customers.yaml | Fixes invalid businessType example from FINTECH to FINANCE_AND_INSURANCE in the source OpenAPI spec |
| openapi.yaml | Generated bundle file updated by make build; same FINTECH → FINANCE_AND_INSURANCE fix propagated from source |
| mintlify/openapi.yaml | Generated Mintlify bundle updated by make build; same FINTECH → FINANCE_AND_INSURANCE fix propagated from source |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[POST /customers/external-accounts] --> B{accountType}
B --> C[Fiat - Bank Transfer]
B --> D[Fiat - Mobile Money]
B --> E[Crypto Wallets]
C --> C1[US_ACCOUNT\nEUR_ACCOUNT\nGBP_ACCOUNT\n...]
C --> C2["🆕 AED_ACCOUNT\nIBAN + optional swiftCode\nbeneficiary required"]
D --> D1[KES_ACCOUNT\nTZS_ACCOUNT\nXOF_ACCOUNT\n...]
D --> D2["🆕 BWP_ACCOUNT\nphoneNumber + ORANGE provider\nbeneficiary required"]
D --> D3["🆕 XAF_ACCOUNT\nphoneNumber + MTN provider\nregion: CM or CG\nbeneficiary required"]
E --> E1[SPARK_WALLET\nSOLANA_WALLET\nPOLYGON_WALLET\nBASE_WALLET\n...]
E --> E2["🆕 ETHEREUM_WALLET\naddress: 0x...\nno beneficiary required\nUSeDC on Ethereum L1"]
Last reviewed commit: "docs: Sync documenta..."
|
@claude resolve merge conflicts |
|
@claude resolve merge conflicts |
## Summary Adds Ethereum to the two places that already enumerate supported chains and were missing it. Docs-only, 2 files, +2/-1. | Page | Change | |---|---| | `mintlify/snippets/sending/cross-currency.mdx` | `Ethereum \| USDC, USDT` row in the supported blockchains table | | `mintlify/platform-overview/introduction/platform-capabilities.mdx` | Ethereum added to the self-custody wallet list | Both generated bundles (`openapi.yaml`, `mintlify/openapi.yaml`) are byte-identical to `main`. ## Why only these two An earlier revision of this PR also added an Ethereum L1 example to `snippets/external-accounts.mdx` and an Ethereum funding accordion to `snippets/internal-accounts.mdx`. Both were dropped in bbfeb06. The two remaining changes fix **incomplete enumerations**. The blockchains table already had Base, Tron, Polygon, Lightning and Spark rows; the capabilities list already read "Spark, Solana, Tron, Base, Polygon, etc." Ethereum was supported and simply absent from both, so adding it makes them correct. The two dropped changes were a different case. Neither of those pages documents **any** wallet type other than Spark — `BASE_WALLET`, `POLYGON_WALLET`, `PLASMA_WALLET`, `SOLANA_WALLET` and `TRON_WALLET` appear nowhere in `external-accounts.mdx`. Adding an Ethereum-only example there would read as a curated list of the two chains Grid supports, rather than two entries from a set of seven. That's arguably worse than the current silence. ## Follow-up this leaves open `external-accounts.mdx` documents 1 of 7 wallet external-account types. Base, Polygon, Plasma, Solana, Tron and Ethereum are all undocumented there, and none of their schemas carry `x-internal`, `deprecated`, or a beta marker — the omission looks incidental, not deliberate. They should be written up as one set, with per-chain asset support derived from each `Payment<Chain>WalletInfo.yaml` enum rather than assumed (they differ: Ethereum is `[USDC, USDT]`, Base and Polygon are USDC-only). Separately, and outside the scope of a docs PR: `components/grid-visualizer/src/data/crypto.ts` lists `ETHEREUM_WALLET` only under USDT and omits it from USDC, which contradicts `PaymentEthereumWalletInfo.yaml` declaring `enum: [USDC, USDT]`. ## Verification - All changed MDX compiles cleanly against the `@mdx-js/mdx` compiler bundled with `mintlify@4.2.284`; `mintlify broken-links` reports no broken links in the touched files. - `make lint` **fails on `main` as well** — `npx spectral lint` errors with `spectral: not found` because npm resolves a stub `spectral@0.0.0` instead of `@stoplight/spectral-cli`. Pre-existing and reproducible on a clean checkout; distinct from the separately-broken `lint-markdown`. The step that does run, `@redocly/cli lint`, passes with 50 pre-existing warnings. - **Not verified:** no visual render check. The Mintlify preview deploy is worth a look at the table row. Supersedes the documentation portion of #288, whose Grid Visualizer changes already landed on `main` via later syncs.
Summary
ETHEREUM_WALLETsupport to Grid Visualizer for Ethereum L1 USDC paymentsbusinessType: FINTECHexample in OpenAPI spec (→FINANCE_AND_INSURANCE)Context
Syncs documentation with recent OpenAPI schema changes:
Files Changed
Grid Visualizer:
components/grid-visualizer/src/data/account-types.ts- Added ETHEREUM_WALLET, AED_ACCOUNT, BWP_ACCOUNT, XAF_ACCOUNTcomponents/grid-visualizer/src/data/crypto.ts- Added ETHEREUM_WALLET for USDCcomponents/grid-visualizer/src/data/currencies.ts- Added AED, BWP, XAF currenciesMintlify Docs:
mintlify/snippets/external-accounts.mdx- Added Ethereum L1 wallet example tabOpenAPI:
openapi/paths/customers/customers.yaml- Fixed invalid businessType exampleTest plan
make lint-openapi- passes with no warnings🤖 Generated with Claude Code