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: 14 additions & 5 deletions mintlify/openapi.yaml

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

19 changes: 14 additions & 5 deletions openapi.yaml

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

1 change: 1 addition & 0 deletions openapi/components/schemas/common/CnyAccountInfo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ allOf:
type: string
enum:
- MOBILE_MONEY
- BANK_TRANSFER
19 changes: 14 additions & 5 deletions openapi/components/schemas/common/CnyAccountInfoBase.yaml
Original file line number Diff line number Diff line change
@@ -1,26 +1,35 @@
type: object
required:
- accountType
- phoneNumber
- bankName
description: 'Required fields depend on the selected paymentRails:

- BANK_TRANSFER: accountNumber, bankName

- MOBILE_MONEY: phoneNumber, bankName'
properties:
accountType:
type: string
enum:
- CNY_ACCOUNT
accountNumber:
type: string
description: The destination bank account number (BANK_TRANSFER rail)
minLength: 1
maxLength: 34
phoneNumber:
type: string
description: The phone number in international format
description: The phone number in international format (MOBILE_MONEY rail)
example: '+1234567890'
minLength: 7
maxLength: 15
pattern: ^\+[0-9]{6,14}$
bankName:
type: string
description: The name of the bank
description: The name of the bank or mobile-wallet provider
minLength: 1
maxLength: 255
example:
accountType: CNY_ACCOUNT
phoneNumber: '+1234567890'
bankName: Example Bank
accountNumber: '1234567890'
bankName: China Construction Bank
Comment on lines 32 to +35
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 updated example only illustrates the BANK_TRANSFER rail — phoneNumber has been dropped entirely. The CopAccountInfoBase.yaml counterpart includes all optional fields in its example so consumers can see every supported field at a glance. Without a phoneNumber entry here, a developer targeting the MOBILE_MONEY rail has no inline reference for that field in the base schema.

Suggested change
example:
accountType: CNY_ACCOUNT
phoneNumber: '+1234567890'
bankName: Example Bank
accountNumber: '1234567890'
bankName: China Construction Bank
example:
accountType: CNY_ACCOUNT
accountNumber: '1234567890'
phoneNumber: '+1234567890'
bankName: China Construction Bank
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/CnyAccountInfoBase.yaml
Line: 32-35

Comment:
The updated example only illustrates the `BANK_TRANSFER` rail — `phoneNumber` has been dropped entirely. The `CopAccountInfoBase.yaml` counterpart includes all optional fields in its example so consumers can see every supported field at a glance. Without a `phoneNumber` entry here, a developer targeting the `MOBILE_MONEY` rail has no inline reference for that field in the base schema.

```suggestion
example:
  accountType: CNY_ACCOUNT
  accountNumber: '1234567890'
  phoneNumber: '+1234567890'
  bankName: China Construction Bank
```

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

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!

Loading