chore: Update external account schemas from webdev #146
+62
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| type: object | ||
| title: InrUpiAccountInfo | ||
| description: Required fields for USD -> INR corridor via Upi | ||
| required: | ||
| - accountType | ||
| - beneficiary | ||
| - fullName | ||
| - vpa | ||
| properties: | ||
| accountType: | ||
| type: string | ||
| enum: | ||
| - INR_UPI_ACCOUNT | ||
| example: INR_UPI_ACCOUNT | ||
| fullName: | ||
| type: string | ||
| description: Full name of the beneficiary | ||
| example: John Michael Doe | ||
| vpa: | ||
| type: string | ||
| description: Virtual Payment Address (UPI) | ||
| example: john@upi | ||
| beneficiary: | ||
| oneOf: | ||
| - $ref: ./IndividualBeneficiary.yaml | ||
| - $ref: ./BusinessBeneficiary.yaml | ||
| discriminator: | ||
| propertyName: beneficiaryType | ||
| mapping: | ||
| INDIVIDUAL: ./IndividualBeneficiary.yaml | ||
| BUSINESS: ./BusinessBeneficiary.yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| type: object | ||
| title: MxnSpeiAccountInfo | ||
| description: Required fields for USD -> MXN corridor via Spei | ||
| required: | ||
| - accountType | ||
| - beneficiary | ||
| - clabe | ||
| - name | ||
| properties: | ||
| accountType: | ||
| type: string | ||
| enum: | ||
| - MXN_SPEI_ACCOUNT | ||
| example: MXN_SPEI_ACCOUNT | ||
| clabe: | ||
| type: string | ||
| description: Mexican CLABE interbank account number (18 digits) | ||
| example: 012180001234567890 | ||
| name: | ||
| type: string | ||
| description: Full name of the payee | ||
| example: Jane Smith | ||
| beneficiary: | ||
| oneOf: | ||
| - $ref: ./IndividualBeneficiary.yaml | ||
| - $ref: ./BusinessBeneficiary.yaml | ||
| discriminator: | ||
| propertyName: beneficiaryType | ||
| mapping: | ||
| INDIVIDUAL: ./IndividualBeneficiary.yaml | ||
| BUSINESS: ./BusinessBeneficiary.yaml | ||
|
Comment on lines
+23
to
+31
Contributor
There was a problem hiding this comment. [P3] This schema duplicates the existing Also appears in: 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! Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/components/schemas/external_accounts/MxnSpeiAccountInfo.yaml
Line: 23:31
Comment:
[P3] This schema duplicates the existing `BeneficiaryOneOf.yaml` discriminator/oneOf block. To reduce drift (e.g., mapping changes), consider referencing it directly (`$ref: ./BeneficiaryOneOf.yaml`) instead of repeating the structure.
Also appears in: `openapi/components/schemas/external_accounts/InrUpiAccountInfo.yaml:23-31`.
<sub>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!</sub>
How can I resolve this? If you propose a fix, please make it concise. |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[P2]
requiredusesname, but other beneficiary schemas already usefullName/legalName, and INR UPI usesfullName. If the intent is “payee name”, this inconsistency can be confusing for clients and may cause generated SDKs to expose multiple overlapping fields.Consider aligning on an existing field name (e.g.
fullName) or clarifying in the description whynameis distinct frombeneficiary.fullName/beneficiary.legalName.Prompt To Fix With AI