chore: Sync account schemas#470
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✱ Stainless preview builds for gridThis PR will update the kotlin openapi python typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-python studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-openapi studio · code · diff
✅ grid-typescript studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryThis PR syncs the COP (Colombian Peso) account schemas from sparkcore VASP adapter definitions, removing the
Confidence Score: 4/5Safe to merge; changes are a straightforward schema sync with no structural breakage. The removal of
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/common/CopAccountInfoBase.yaml | Removes bankName field and simplifies field descriptions; example now mixes BANK_TRANSFER and MOBILE_MONEY fields in a single object. |
| openapi/components/schemas/common/CopBeneficiary.yaml | Simplifies documentType and documentNumber descriptions, losing all per-enum-value explanations (CC, CE, TI, NIT, PP meanings). |
| openapi.yaml | Generated bundle — mirrors source schema changes identically; no independent issues. |
| mintlify/openapi.yaml | Mintlify-specific generated bundle — identical changes to openapi.yaml; no independent issues. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[CopAccountInfoBase] --> B{paymentRails}
B -->|BANK_TRANSFER| C["accountNumber\nbankAccountType\n(bankName removed)"]
B -->|MOBILE_MONEY| D["phoneNumber\n(Nequi / Daviplata)"]
A --> E[CopAccountInfo]
E --> F[CopExternalAccountInfo]
G[CopBeneficiary] --> H["name / address\ndocumentType: CC|CE|TI|NIT|PP\ndocumentNumber"]
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
openapi/components/schemas/common/CopBeneficiary.yaml:32
**Loss of enum value explanations for `documentType`**
The previous description explained what each enum value stands for in plain language (e.g. "CC: Cédula de Ciudadanía, CE: Cédula de Extranjería, TI: Tarjeta de Identidad, NIT: Número de Identificación Tributaria, PP: Passport"). The replacement — `"Identity document type (Colombia)"` — leaves API consumers with five opaque codes and no inline guidance on which to send. The same change is mirrored in `openapi.yaml` and `mintlify/openapi.yaml`.
### Issue 2 of 2
openapi/components/schemas/common/CopAccountInfoBase.yaml:32-36
The example object now mixes fields from two mutually exclusive payment rails — `accountNumber` and `bankAccountType` are for `BANK_TRANSFER`, while `phoneNumber` is for `MOBILE_MONEY`. A single example object representing both rails simultaneously is not a valid real-world request and could confuse API consumers about how to construct their payloads.
```suggestion
example:
accountType: COP_ACCOUNT
accountNumber: '1234567890'
bankAccountType: CHECKING
```
Reviews (1): Last reviewed commit: "chore: Sync account schemas" | Re-trigger Greptile
| @@ -30,9 +30,7 @@ properties: | |||
| $ref: ./Address.yaml | |||
| documentType: | |||
| type: string | |||
There was a problem hiding this comment.
Loss of enum value explanations for
documentType
The previous description explained what each enum value stands for in plain language (e.g. "CC: Cédula de Ciudadanía, CE: Cédula de Extranjería, TI: Tarjeta de Identidad, NIT: Número de Identificación Tributaria, PP: Passport"). The replacement — "Identity document type (Colombia)" — leaves API consumers with five opaque codes and no inline guidance on which to send. The same change is mirrored in openapi.yaml and mintlify/openapi.yaml.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/CopBeneficiary.yaml
Line: 32
Comment:
**Loss of enum value explanations for `documentType`**
The previous description explained what each enum value stands for in plain language (e.g. "CC: Cédula de Ciudadanía, CE: Cédula de Extranjería, TI: Tarjeta de Identidad, NIT: Número de Identificación Tributaria, PP: Passport"). The replacement — `"Identity document type (Colombia)"` — leaves API consumers with five opaque codes and no inline guidance on which to send. The same change is mirrored in `openapi.yaml` and `mintlify/openapi.yaml`.
How can I resolve this? If you propose a fix, please make it concise.| example: | ||
| accountType: COP_ACCOUNT | ||
| bankName: Bancolombia | ||
| accountNumber: '1234567890' | ||
| bankAccountType: CHECKING | ||
| phoneNumber: '+1234567890' |
There was a problem hiding this comment.
The example object now mixes fields from two mutually exclusive payment rails —
accountNumber and bankAccountType are for BANK_TRANSFER, while phoneNumber is for MOBILE_MONEY. A single example object representing both rails simultaneously is not a valid real-world request and could confuse API consumers about how to construct their payloads.
| example: | |
| accountType: COP_ACCOUNT | |
| bankName: Bancolombia | |
| accountNumber: '1234567890' | |
| bankAccountType: CHECKING | |
| phoneNumber: '+1234567890' | |
| example: | |
| accountType: COP_ACCOUNT | |
| accountNumber: '1234567890' | |
| bankAccountType: CHECKING |
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/CopAccountInfoBase.yaml
Line: 32-36
Comment:
The example object now mixes fields from two mutually exclusive payment rails — `accountNumber` and `bankAccountType` are for `BANK_TRANSFER`, while `phoneNumber` is for `MOBILE_MONEY`. A single example object representing both rails simultaneously is not a valid real-world request and could confuse API consumers about how to construct their payloads.
```suggestion
example:
accountType: COP_ACCOUNT
accountNumber: '1234567890'
bankAccountType: CHECKING
```
How can I resolve this? If you propose a fix, please make it concise.
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.