Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 7 additions & 12 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 5 additions & 11 deletions openapi/components/schemas/common/CopAccountInfoBase.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,34 @@ required:
- accountType
description: 'Required fields depend on the selected paymentRails:

- BANK_TRANSFER: bankName, accountNumber, bankAccountType
- BANK_TRANSFER: accountNumber, bankAccountType

- MOBILE_MONEY: phoneNumber'
properties:
accountType:
type: string
enum:
- COP_ACCOUNT
bankName:
type: string
description: The name of the bank (BANK_TRANSFER only)
minLength: 1
maxLength: 255
accountNumber:
type: string
description: The account number of the bank (BANK_TRANSFER only)
description: The account number of the bank
minLength: 1
maxLength: 34
bankAccountType:
type: string
description: The bank account type (BANK_TRANSFER only)
description: The bank account type
enum:
- CHECKING
- SAVINGS
phoneNumber:
type: string
description: The phone number in international format (MOBILE_MONEY only —
Nequi, Daviplata)
description: The phone number in international format
example: '+1234567890'
minLength: 7
maxLength: 15
pattern: ^\+[0-9]{6,14}$
example:
accountType: COP_ACCOUNT
bankName: Bancolombia
accountNumber: '1234567890'
bankAccountType: CHECKING
phoneNumber: '+1234567890'
Comment on lines 32 to +36
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 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.

Suggested change
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.

Fix in Claude Code

6 changes: 2 additions & 4 deletions openapi/components/schemas/common/CopBeneficiary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ properties:
$ref: ./Address.yaml
documentType:
type: string
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 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.

Fix in Claude Code

description: 'Identity document type — required by most Colombian banks.
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'
description: Identity document type (Colombia)
enum:
- CC
- CE
Expand All @@ -41,6 +39,6 @@ properties:
- PP
documentNumber:
type: string
description: Identity document number — required by most Colombian banks
description: The identity document number
minLength: 1
maxLength: 50
Loading