Skip to content

docs: add SWIFT_ACCOUNT to documentation and Grid Visualizer#478

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/sync-20260519
Open

docs: add SWIFT_ACCOUNT to documentation and Grid Visualizer#478
claude[bot] wants to merge 1 commit into
mainfrom
docs/sync-20260519

Conversation

@claude
Copy link
Copy Markdown
Contributor

@claude claude Bot commented May 19, 2026

Summary

Syncs documentation with recent OpenAPI schema changes from #473 (add SWIFT external account type).

  • Add SWIFT_ACCOUNT to Grid Visualizer account-types.ts with correct fields (swiftCode, bankName, country, accountNumber)
  • Add SWIFT tab to external-accounts.mdx snippet with curl examples for both account number and IBAN-based SWIFT transfers
  • Add SWIFT tab to account-model.mdx with JSON schema example

Test plan

  • Verify Grid Visualizer generates correct code for SWIFT account creation
  • Review SWIFT documentation examples match OpenAPI schema
  • Check external-accounts.mdx renders correctly in Mintlify

🤖 Generated with Claude Code

Sync documentation with recent OpenAPI schema changes from #473.

- Add SWIFT_ACCOUNT to Grid Visualizer account-types.ts
- Add SWIFT tab to external-accounts.mdx snippet with examples
- Add SWIFT tab to account-model.mdx with schema example

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@claude claude Bot requested review from pengying and shreyav May 19, 2026 09:18
@vercel
Copy link
Copy Markdown

vercel Bot commented May 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment May 19, 2026 9:19am

Request Review

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 19, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview May 19, 2026, 9:20 AM

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 19, 2026

Greptile Summary

This PR adds SWIFT_ACCOUNT support to the Grid Visualizer and Mintlify documentation, syncing with the OpenAPI schema changes from #473. The MDX documentation files are well-formed and internally consistent, but the Grid Visualizer data entry has a country/SWIFT code mismatch that would produce misleading generated code.

  • account-types.ts: Adds SWIFT_ACCOUNT spec, but the country example is 'NG' (Nigeria) while the swiftCode example 'DEUTDEFF' belongs to Deutsche Bank Germany ('DE'), creating an inconsistency that would confuse users relying on the visualizer.
  • external-accounts.mdx: Adds a SWIFT tab with two complete curl examples (account-number and IBAN variants), consistent with the existing tab pattern and authorization format.
  • account-model.mdx: Adds a clean SWIFT JSON schema example with correct, internally consistent field values.

Confidence Score: 3/5

The MDX documentation is safe to merge, but the Grid Visualizer data has a country/SWIFT code mismatch that would generate misleading example requests.

The account-types.ts entry pairs swiftCode 'DEUTDEFF' (a German bank) with country 'NG' (Nigeria). Any developer copying the generated visualizer output verbatim would send a request with mismatched bank country fields, which is likely to be rejected or produce unexpected behavior.

components/grid-visualizer/src/data/account-types.ts — the country example needs to match the SWIFT code example.

Important Files Changed

Filename Overview
components/grid-visualizer/src/data/account-types.ts Adds SWIFT_ACCOUNT entry, but the country example ('NG') contradicts the swiftCode example ('DEUTDEFF', a German bank); the iban alternative field is also missing from the visualizer spec.
mintlify/platform-overview/core-concepts/account-model.mdx Adds a SWIFT tab with a well-formed JSON example; country, swiftCode, and bankName are internally consistent.
mintlify/snippets/external-accounts.mdx Adds a SWIFT tab with two curl examples (accountNumber and IBAN), consistent authorization pattern, and a Note callout with usage guidance.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User selects SWIFT_ACCOUNT in Grid Visualizer] --> B{Corridor type?}
    B -->|Account number corridor| C[Fill: swiftCode, bankName, country, accountNumber]
    B -->|IBAN-only corridor e.g. GB, BR| D[Fill: swiftCode, bankName, country, iban]
    C --> E[POST /customers/external-accounts with accountNumber]
    D --> F[POST /customers/external-accounts with iban]
    E --> G[External account created]
    F --> G
    style D fill:#ffdddd,stroke:#cc0000
    style F fill:#ffdddd,stroke:#cc0000
Loading

Fix All in Claude Code

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
components/grid-visualizer/src/data/account-types.ts:268
**Country example contradicts the SWIFT code example**

The `swiftCode` example is `'DEUTDEFF'`, which is Deutsche Bank Frankfurt — a German bank (ISO country code `DE`). The `country` example, however, is `'NG'` (Nigeria). A user copying from the Grid Visualizer would produce a request where the bank country and the SWIFT code point to different countries, which will likely be rejected by the API. The documentation in `account-model.mdx` correctly uses `'DE'`; the visualizer should match.

### Issue 2 of 2
components/grid-visualizer/src/data/account-types.ts:269
The `iban` field is only mentioned in the `accountNumber` description text, so the Grid Visualizer has no way to generate IBAN-based SWIFT account creation requests. Since `external-accounts.mdx` provides a full IBAN curl example as a first-class alternative, the visualizer should expose `iban` as a field too. Without it, users in IBAN-only corridors (e.g., GB, BR) cannot use the visualizer to prototype their integration.

```suggestion
      { name: 'accountNumber', example: '1234567890', description: 'Use for most corridors; mutually exclusive with iban' },
      { name: 'iban', example: 'GB29NWBK60161331926819', description: 'Use instead of accountNumber for IBAN-only corridors (e.g. GB, BR)' },
```

Reviews (1): Last reviewed commit: "docs: add SWIFT_ACCOUNT to docs and Grid..." | Re-trigger Greptile

fields: [
{ name: 'swiftCode', example: 'DEUTDEFF' },
{ name: 'bankName', example: 'Deutsche Bank' },
{ name: 'country', example: 'NG', description: 'ISO 3166-1 alpha-2 code' },
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Country example contradicts the SWIFT code example

The swiftCode example is 'DEUTDEFF', which is Deutsche Bank Frankfurt — a German bank (ISO country code DE). The country example, however, is 'NG' (Nigeria). A user copying from the Grid Visualizer would produce a request where the bank country and the SWIFT code point to different countries, which will likely be rejected by the API. The documentation in account-model.mdx correctly uses 'DE'; the visualizer should match.

Prompt To Fix With AI
This is a comment left during a code review.
Path: components/grid-visualizer/src/data/account-types.ts
Line: 268

Comment:
**Country example contradicts the SWIFT code example**

The `swiftCode` example is `'DEUTDEFF'`, which is Deutsche Bank Frankfurt — a German bank (ISO country code `DE`). The `country` example, however, is `'NG'` (Nigeria). A user copying from the Grid Visualizer would produce a request where the bank country and the SWIFT code point to different countries, which will likely be rejected by the API. The documentation in `account-model.mdx` correctly uses `'DE'`; the visualizer should match.

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code

{ name: 'swiftCode', example: 'DEUTDEFF' },
{ name: 'bankName', example: 'Deutsche Bank' },
{ name: 'country', example: 'NG', description: 'ISO 3166-1 alpha-2 code' },
{ name: 'accountNumber', example: '1234567890', description: 'Or use iban for IBAN-only corridors' },
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The iban field is only mentioned in the accountNumber description text, so the Grid Visualizer has no way to generate IBAN-based SWIFT account creation requests. Since external-accounts.mdx provides a full IBAN curl example as a first-class alternative, the visualizer should expose iban as a field too. Without it, users in IBAN-only corridors (e.g., GB, BR) cannot use the visualizer to prototype their integration.

Suggested change
{ name: 'accountNumber', example: '1234567890', description: 'Or use iban for IBAN-only corridors' },
{ name: 'accountNumber', example: '1234567890', description: 'Use for most corridors; mutually exclusive with iban' },
{ name: 'iban', example: 'GB29NWBK60161331926819', description: 'Use instead of accountNumber for IBAN-only corridors (e.g. GB, BR)' },
Prompt To Fix With AI
This is a comment left during a code review.
Path: components/grid-visualizer/src/data/account-types.ts
Line: 269

Comment:
The `iban` field is only mentioned in the `accountNumber` description text, so the Grid Visualizer has no way to generate IBAN-based SWIFT account creation requests. Since `external-accounts.mdx` provides a full IBAN curl example as a first-class alternative, the visualizer should expose `iban` as a field too. Without it, users in IBAN-only corridors (e.g., GB, BR) cannot use the visualizer to prototype their integration.

```suggestion
      { name: 'accountNumber', example: '1234567890', description: 'Use for most corridors; mutually exclusive with iban' },
      { name: 'iban', example: 'GB29NWBK60161331926819', description: 'Use instead of accountNumber for IBAN-only corridors (e.g. GB, BR)' },
```

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants