Skip to content
Merged
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
8 changes: 8 additions & 0 deletions mintlify/openapi.yaml

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

8 changes: 8 additions & 0 deletions 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
Expand Up @@ -7,3 +7,12 @@ properties:
description: Fixed fee in the smallest unit of the sending currency (e.g., cents for USD)
minimum: 0
example: 100
total:
type: integer
format: int64
description: >-
Total fees in the smallest unit of the sending currency (e.g., cents for
USD). This value may change depending on the sending amount used; if no
sending amount is specified, it falls back to the default.
minimum: 0
example: 100
Comment on lines +10 to +18

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 value for total is 100, identical to the fixed fee example. Since total is meant to capture fixed + any variable/percentage component, an example where they are equal implies there is never a variable fee, which contradicts the response examples in the path file (where total is 150 vs fixed 100, or 15 vs 10). Using 150 here aligns with the live example and signals clearly to API consumers that total can exceed fixed.

Suggested change
total:
type: integer
format: int64
description: >-
Total fees in the smallest unit of the sending currency (e.g., cents for
USD). This value may change depending on the sending amount used; if no
sending amount is specified, it falls back to the default.
minimum: 0
example: 100
total:
type: integer
format: int64
description: >-
Total fees in the smallest unit of the sending currency (e.g., cents for
USD). This value may change depending on the sending amount used; if no
sending amount is specified, it falls back to the default.
minimum: 0
example: 150
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/exchange_rates/ExchangeRateFees.yaml
Line: 10-18

Comment:
The `example` value for `total` is `100`, identical to the `fixed` fee example. Since `total` is meant to capture fixed + any variable/percentage component, an example where they are equal implies there is never a variable fee, which contradicts the response examples in the path file (where total is `150` vs fixed `100`, or `15` vs `10`). Using `150` here aligns with the live example and signals clearly to API consumers that total can exceed fixed.

```suggestion
  total:
    type: integer
    format: int64
    description: >-
      Total fees in the smallest unit of the sending currency (e.g., cents for
      USD). This value may change depending on the sending amount used; if no
      sending amount is specified, it falls back to the default.
    minimum: 0
    example: 150
```

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

2 changes: 2 additions & 0 deletions openapi/paths/exchange-rates/exchange_rates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ get:
exchangeRate: 82.50
fees:
fixed: 100
total: 150
updatedAt: "2025-02-05T12:00:00Z"
- sourceCurrency:
code: USD
Expand All @@ -95,6 +96,7 @@ get:
exchangeRate: 0.925
fees:
fixed: 10
total: 15
updatedAt: "2025-02-05T12:00:00Z"
"400":
description: Bad request - Invalid parameters
Expand Down
Loading