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
16 changes: 15 additions & 1 deletion mintlify/openapi.yaml

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

16 changes: 15 additions & 1 deletion openapi.yaml

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

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
type: object
required:
- accountId
properties:
accountId:
type: string
description: Reference to an external account ID
example: ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965
paymentRail:
description: >-
The payment rail to use for the transfer. Must be one of the rails
supported by the destination account. If not specified, the system
will select a default rail.
allOf:
- $ref: ../common/PaymentRail.yaml
Comment on lines +9 to +15
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 description placement for paymentRail is inconsistent with the equivalent field in AccountDestination.yaml. There, the description lives inside the allOf array as a second schema object (- description: ...), while here it sits as a sibling to allOf. Both are valid OpenAPI 3.0, but for consistency with the established pattern in the codebase the description should move inside the array.

Suggested change
paymentRail:
description: >-
The payment rail to use for the transfer. Must be one of the rails
supported by the destination account. If not specified, the system
will select a default rail.
allOf:
- $ref: ../common/PaymentRail.yaml
paymentRail:
allOf:
- $ref: ../common/PaymentRail.yaml
- description: >-
The payment rail to use for the transfer. Must be one of the rails
supported by the destination account. If not specified, the system
will select a default rail.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/transfers/TransferOutDestination.yaml
Line: 9-15

Comment:
The `description` placement for `paymentRail` is inconsistent with the equivalent field in `AccountDestination.yaml`. There, the description lives **inside** the `allOf` array as a second schema object (`- description: ...`), while here it sits as a sibling to `allOf`. Both are valid OpenAPI 3.0, but for consistency with the established pattern in the codebase the description should move inside the array.

```suggestion
  paymentRail:
    allOf:
      - $ref: ../common/PaymentRail.yaml
      - description: >-
          The payment rail to use for the transfer. Must be one of the rails
          supported by the destination account. If not specified, the system
          will select a default rail.
```

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!

Fix in Claude Code

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ properties:
$ref: ./InternalAccountReference.yaml
description: Source internal account details
destination:
$ref: ./ExternalAccountReference.yaml
$ref: ./ExternalAccountDestinationReference.yaml
description: Destination external account details
amount:
type: integer
Expand Down
1 change: 1 addition & 0 deletions openapi/paths/transfers/transfer_out.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ post:
accountId: InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
destination:
accountId: ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965
paymentRail: ACH
amount: 12550
responses:
'201':
Expand Down
Loading