Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✱ Stainless preview buildsThis PR will update the kotlin openapi python typescript
|
shreyav
force-pushed
the
03-26-move_timeout_to_refund_reason
branch
from
f2cef7d to
75dad3b
Compare
Greptile SummaryThis PR moves Key changes:
Documentation gap: Confidence Score: 4/5Safe to merge; schema changes are correct and bundles are properly regenerated. A documentation gap remains but does not affect API behavior. All schema and bundle changes are correct and consistent. The only issue is a P2 documentation gap where
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/transactions/OutgoingTransactionFailureReason.yaml | Removes TIMEOUT from the outgoing transaction failure reason enum — correct source-of-truth change. |
| openapi/components/schemas/common/Refund.yaml | Adds TIMEOUT to the Refund.reason enum — correctly captures the new semantics where a timeout triggers a refund. |
| openapi.yaml | Generated bundle correctly reflects the schema changes from both Refund.yaml and OutgoingTransactionFailureReason.yaml. |
| mintlify/openapi.yaml | Mintlify-specific generated bundle updated in sync with openapi.yaml — no issues. |
| mintlify/snippets/error-handling.mdx | Removes TIMEOUT from outgoing failure reasons but doesn't document it as a refund reason — documentation gap for developers. |
| mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx | Removes TIMEOUT from the failure table without adding any refund-reason documentation; the timeout behavior becomes undocumented for readers of this page. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Outgoing Transaction Created] --> B{Execution Result}
B -->|Success| C[Status: COMPLETED]
B -->|Quote expired| D[Status: FAILED\nfailureReason: QUOTE_EXPIRED]
B -->|Quote execution failed| E[Status: FAILED\nfailureReason: QUOTE_EXECUTION_FAILED]
B -->|Lightning payment failed| F[Status: FAILED\nfailureReason: LIGHTNING_PAYMENT_FAILED]
B -->|Funding mismatch| G[Status: FAILED\nfailureReason: FUNDING_AMOUNT_MISMATCH]
B -->|Counterparty failed| H[Status: FAILED\nfailureReason: COUNTERPARTY_POST_TX_FAILED]
B -->|Timeout| I[Refund Issued\nRefund.reason: TIMEOUT]
I --> J[Refund Status: PENDING -> COMPLETED]
Prompt To Fix All With AI
This is a comment left during a code review.
Path: mintlify/snippets/error-handling.mdx
Line: 147
Comment:
**`TIMEOUT` removed but not documented as refund reason**
`TIMEOUT` is correctly removed from the outgoing failure reasons list here, but there's no corresponding mention that a `TIMEOUT` will now result in a refund with `reason: TIMEOUT`. Developers referencing this snippet after the change may not know how to handle the timeout scenario at all.
Since this snippet is shared across multiple sections, consider adding a note (or a dedicated refund-reasons bullet list) indicating that `TIMEOUT` scenarios now surface as a refund:
```mdx
- `TIMEOUT` - Transaction timed out; funds are returned as a refund with `reason: TIMEOUT`
```
or in a separate refund reasons section:
```mdx
### Refund reasons
- `TRANSACTION_FAILED` - Transaction failed after funds were sent
- `USER_CANCELLATION` - Payment cancelled by user
- `TIMEOUT` - Transaction timed out before completion
```
How can I resolve this? If you propose a fix, please make it concise.
---
This is a comment left during a code review.
Path: mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx
Line: 272-273
Comment:
**`TIMEOUT` removed without documenting the new refund behavior**
`TIMEOUT` is removed from the failure reasons table, but the page gives no hint that a timeout now results in a refund. A developer reading this page would have no documentation trail explaining what happens when a transaction times out.
Consider adding a brief note in the Failure Handling section, or a new "Refund reasons" table entry:
```mdx
| `TIMEOUT` | Transaction timed out; refund issued automatically | Check refund status |
```
This also applies to `mintlify/snippets/error-handling.mdx` line 147 where the same entry was removed.
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "Move timeout to refund reason" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| @@ -145,7 +145,6 @@ When a transaction fails, the `failureReason` field provides specific details: | |||
| - `QUOTE_EXPIRED` - Quote expired before execution | |||
| - `QUOTE_EXECUTION_FAILED` - Error executing the quote | |||
| - `FUNDING_AMOUNT_MISMATCH` - Funding amount doesn't match expected amount | |||
There was a problem hiding this comment.
TIMEOUT removed but not documented as refund reason
TIMEOUT is correctly removed from the outgoing failure reasons list here, but there's no corresponding mention that a TIMEOUT will now result in a refund with reason: TIMEOUT. Developers referencing this snippet after the change may not know how to handle the timeout scenario at all.
Since this snippet is shared across multiple sections, consider adding a note (or a dedicated refund-reasons bullet list) indicating that TIMEOUT scenarios now surface as a refund:
- `TIMEOUT` - Transaction timed out; funds are returned as a refund with `reason: TIMEOUT`or in a separate refund reasons section:
### Refund reasons
- `TRANSACTION_FAILED` - Transaction failed after funds were sent
- `USER_CANCELLATION` - Payment cancelled by user
- `TIMEOUT` - Transaction timed out before completionPrompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/snippets/error-handling.mdx
Line: 147
Comment:
**`TIMEOUT` removed but not documented as refund reason**
`TIMEOUT` is correctly removed from the outgoing failure reasons list here, but there's no corresponding mention that a `TIMEOUT` will now result in a refund with `reason: TIMEOUT`. Developers referencing this snippet after the change may not know how to handle the timeout scenario at all.
Since this snippet is shared across multiple sections, consider adding a note (or a dedicated refund-reasons bullet list) indicating that `TIMEOUT` scenarios now surface as a refund:
```mdx
- `TIMEOUT` - Transaction timed out; funds are returned as a refund with `reason: TIMEOUT`
```
or in a separate refund reasons section:
```mdx
### Refund reasons
- `TRANSACTION_FAILED` - Transaction failed after funds were sent
- `USER_CANCELLATION` - Payment cancelled by user
- `TIMEOUT` - Transaction timed out before completion
```
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!
| | `QUOTE_EXECUTION_FAILED` | Error executing the quote | Create new quote | | ||
| | `INSUFFICIENT_BALANCE` | Source account lacks funds | Fund account, retry | |
There was a problem hiding this comment.
TIMEOUT removed without documenting the new refund behavior
TIMEOUT is removed from the failure reasons table, but the page gives no hint that a timeout now results in a refund. A developer reading this page would have no documentation trail explaining what happens when a transaction times out.
Consider adding a brief note in the Failure Handling section, or a new "Refund reasons" table entry:
| `TIMEOUT` | Transaction timed out; refund issued automatically | Check refund status |This also applies to mintlify/snippets/error-handling.mdx line 147 where the same entry was removed.
Prompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/platform-overview/core-concepts/transaction-lifecycle.mdx
Line: 272-273
Comment:
**`TIMEOUT` removed without documenting the new refund behavior**
`TIMEOUT` is removed from the failure reasons table, but the page gives no hint that a timeout now results in a refund. A developer reading this page would have no documentation trail explaining what happens when a transaction times out.
Consider adding a brief note in the Failure Handling section, or a new "Refund reasons" table entry:
```mdx
| `TIMEOUT` | Transaction timed out; refund issued automatically | Check refund status |
```
This also applies to `mintlify/snippets/error-handling.mdx` line 147 where the same entry was removed.
How can I resolve this? If you propose a fix, please make it concise.
2 participants
No description provided.