Skip to content

fix incorrect refunded status in v3 docs#312

Merged
ted-palmer merged 1 commit into
mainfrom
ted/int2-295-fix-incorrect-refunded-status-in-v3-docs
May 8, 2026
Merged

fix incorrect refunded status in v3 docs#312
ted-palmer merged 1 commit into
mainfrom
ted/int2-295-fix-incorrect-refunded-status-in-v3-docs

Conversation

@ted-palmer
Copy link
Copy Markdown
Collaborator

No description provided.

@ted-palmer ted-palmer requested a review from pedromcunha May 8, 2026 18:41
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 8, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
unevenlabs 🟢 Ready View Preview May 8, 2026, 6:42 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

Claude finished @ted-palmer's task in 1m 24s —— View job


Code Review for PR #312

  • Read PR diff
  • Verify against existing docs / cross-references
  • Check style guide conformance (CLAUDE.md)
  • Post review

Summary

Single-line correction to the v3 status enum table: `refunded``refund` to match the actual API value. The PR is correctly scoped and per the style guide qualifies as a §4.4 bug fix that restores doc accuracy — no changelog entry needed since the API itself didn't change.

Verdict: ✅ Approve, with two small notes below

Notes

1. Confirm against the OpenAPI spec (blocking-ish)

CLAUDE.md §3.3 names https://api.relay.link/documentation/json as the source of truth for API reference pages. I couldn't fetch it from this sandbox, so worth a quick eyeball confirmation that the response status enum literally contains "refund" (not "refunded", "refunding", or "refundPending"). The PR title and prior internal context strongly suggest refund is correct, but a 5-second check against the spec closes the loop.

2. Cross-reference drift (not blocking, but worth knowing)

Two adjacent surfaces still use the old spelling — neither is wrong in context, but flagging in case you want to sweep them in a follow-up:

  • references/relay-kit/sdk/actions/executeGaslessBatch.mdx:70 — describes failure as "The batch execution failed or was refunded." If refund is now a distinct terminal status (not folded into failure), this line is misleading. If refund only applies to non-gasless flows, it's fine.
  • The legacy v1 page (references/api/get-intents-status.mdx) doesn't enumerate statuses at all, so no fix needed there.

3. Trailing newline (nit)

The file ends without a newline (\ No newline at end of file in the diff). Pre-existing, not introduced by this PR — ignore unless you're touching it again anyway.

Style guide check

  • §3.3 (API endpoint reference) — body content is allowed for "cross-cutting notes that OpenAPI can't express." A status enum description table fits that exception cleanly. ✅
  • §2.7 (Tables) — Status values are backticked (correct for code values per §2.9). Description column is concise. ✅
  • §4.4 (Bug fix) — Doc-side correction with no API behavior change → no changelog entry required. ✅

· Branch

@ted-palmer ted-palmer merged commit da2f27e into main May 8, 2026
4 checks passed
@ted-palmer ted-palmer deleted the ted/int2-295-fix-incorrect-refunded-status-in-v3-docs branch May 8, 2026 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants