chore: Sync account schemas - #860
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
|
✱ Stainless preview builds for gridThis PR will update the cli go kotlin openapi php python ruby typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-typescript studio · code · diff
✅ grid-openapi studio · code · diff
✅ grid-ruby studio · code · diff
✅ grid-go studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-python 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 SummaryThis PR synchronizes account schemas by adding ILS payment and external-account variants, extending PHP account data, and removing several USD account fields.
Confidence Score: 3/5The PR should not merge until the unsatisfiable ILS payment schema and breaking removal of public USD account fields are resolved. ILS payment instructions are routed to a schema whose intersected account-type enums cannot accept ILS_ACCOUNT, while the USD shared schema removes typed fields from both request and response models; the PHP example also supplies an inappropriate INR rail. Files Needing Attention: openapi/components/schemas/common/PaymentIlsAccountInfo.yaml, openapi/components/schemas/common/PaymentAccountType.yaml, openapi/components/schemas/common/UsdAccountInfoBase.yaml, openapi/components/schemas/common/PhpAccountInfoBase.yaml
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/common/PaymentIlsAccountInfo.yaml | Adds the ILS payment-instruction composition, but its base account-type enum does not admit ILS_ACCOUNT. |
| openapi/components/schemas/common/PaymentInstructions.yaml | Wires ILS into the payment-instruction union and discriminator, exposing the incompatible composed branch. |
| openapi/components/schemas/common/UsdAccountInfoBase.yaml | Removes five public USD account properties used transitively by create and response schemas. |
| openapi/components/schemas/common/PhpAccountInfoBase.yaml | Adds an optional rail field whose description and example incorrectly use INR-specific NEFT guidance. |
| openapi/components/schemas/external_accounts/IlsExternalAccountInfo.yaml | Adds the ILS external-account composition and beneficiary union consistently with sibling schemas. |
| openapi.yaml | Generated bundle reflects the modular schema additions and the same ILS, USD, and PHP contract issues. |
| mintlify/openapi.yaml | Documentation bundle remains synchronized but publishes the same contract and example issues. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart LR
ILS[ILS_ACCOUNT payload] --> PI[PaymentInstructions discriminator]
PI --> PIA[PaymentIlsAccountInfo]
PIA --> Base[BasePaymentAccountInfo]
PIA --> Ils[IlsAccountInfo]
Base --> PAT[PaymentAccountType without ILS_ACCOUNT]
Ils --> IAT[accountType equals ILS_ACCOUNT]
PAT --> Conflict[Unsatisfiable accountType intersection]
IAT --> Conflict
Comments Outside Diff (1)
-
openapi/components/schemas/common/UsdAccountInfoBase.yaml, line 1-6 (link)When integrations create or read USD accounts using
bankName,bankAccountType,intermediaryBankName,intermediaryRoutingNumber, orfiToFiInformation, the shared schema no longer represents those previously documented fields, causing regenerated SDKs to lose the corresponding typed request parameters and response accessors.Knowledge Base Used:
Prompt To Fix With AI
This is a comment left during a code review. Path: openapi/components/schemas/common/UsdAccountInfoBase.yaml Line: 1-6 Comment: **USD account fields removed** When integrations create or read USD accounts using `bankName`, `bankAccountType`, `intermediaryBankName`, `intermediaryRoutingNumber`, or `fiToFiInformation`, the shared schema no longer represents those previously documented fields, causing regenerated SDKs to lose the corresponding typed request parameters and response accessors. **Knowledge Base Used:** - [Grid API contract](https://app.greptile.com/lightspark/-/custom-context/knowledge-base/lightsparkdev/grid-api/-/docs/api-contract.md) - [Contract validation workflows](https://app.greptile.com/lightspark/-/custom-context/knowledge-base/lightsparkdev/grid-api/-/docs/contract-validation-workflows.md) --- For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
Prompt To Fix All With AI
### Issue 1
openapi/components/schemas/common/PaymentIlsAccountInfo.yaml:3-4
**Conflicting ILS account-type constraints**
When payment instructions contain `ILS_ACCOUNT`, this composition requires the value to satisfy both `IlsAccountInfo` and `BasePaymentAccountInfo`, whose `PaymentAccountType` enum omits `ILS_ACCOUNT`, causing validators and generated clients to reject or fail to represent the ILS instructions.
### Issue 2
openapi/components/schemas/common/UsdAccountInfoBase.yaml:1-6
**USD account fields removed**
When integrations create or read USD accounts using `bankName`, `bankAccountType`, `intermediaryBankName`, `intermediaryRoutingNumber`, or `fiToFiInformation`, the shared schema no longer represents those previously documented fields, causing regenerated SDKs to lose the corresponding typed request parameters and response accessors.
### Issue 3
openapi/components/schemas/common/PhpAccountInfoBase.yaml:11-15
**INR rail shown for PHP**
The new PHP `rail` description and example use the INR-specific `NEFT` value even though the PHP schema advertises `BANK_TRANSFER`, so generated documentation presents developers with a misleading PHP request example.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "chore: Sync account schemas" | Re-trigger Greptile
| - $ref: ./BasePaymentAccountInfo.yaml | ||
| - $ref: ./IlsAccountInfo.yaml |
There was a problem hiding this comment.
Conflicting ILS account-type constraints
When payment instructions contain ILS_ACCOUNT, this composition requires the value to satisfy both IlsAccountInfo and BasePaymentAccountInfo, whose PaymentAccountType enum omits ILS_ACCOUNT, causing validators and generated clients to reject or fail to represent the ILS instructions.
Knowledge Base Used: Contract validation workflows
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/PaymentIlsAccountInfo.yaml
Line: 3-4
Comment:
**Conflicting ILS account-type constraints**
When payment instructions contain `ILS_ACCOUNT`, this composition requires the value to satisfy both `IlsAccountInfo` and `BasePaymentAccountInfo`, whose `PaymentAccountType` enum omits `ILS_ACCOUNT`, causing validators and generated clients to reject or fail to represent the ILS instructions.
**Knowledge Base Used:** [Contract validation workflows](https://app.greptile.com/lightspark/-/custom-context/knowledge-base/lightsparkdev/grid-api/-/docs/contract-validation-workflows.md)
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.| rail: | ||
| type: string | ||
| description: The payment rail to route the payout over, for currencies that support | ||
| more than one (e.g. NEFT or RTGS for INR). | ||
| example: NEFT |
There was a problem hiding this comment.
The new PHP rail description and example use the INR-specific NEFT value even though the PHP schema advertises BANK_TRANSFER, so generated documentation presents developers with a misleading PHP request example.
Knowledge Base Used: Grid API contract
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/PhpAccountInfoBase.yaml
Line: 11-15
Comment:
**INR rail shown for PHP**
The new PHP `rail` description and example use the INR-specific `NEFT` value even though the PHP schema advertises `BANK_TRANSFER`, so generated documentation presents developers with a misleading PHP request example.
**Knowledge Base Used:** [Grid API contract](https://app.greptile.com/lightspark/-/custom-context/knowledge-base/lightsparkdev/grid-api/-/docs/api-contract.md)
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.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.