Skip to content

docs(drift): draft from internal source - #445

Merged
pedromcunha merged 1 commit into
mainfrom
docs-drift/src-7a3335d955-7fedbe0
Sep 8, 2026
Merged

pedromcunha merged 1 commit into
mainfrom
docs-drift/src-7a3335d955-7fedbe0

Conversation

@pedromcunha

Copy link
Copy Markdown
Member

Drafted from an internal source repo, requested by @matirelay.

This PR was auto-generated by the reusable-docs-draft-pr workflow from a Claude-drafted update in the source repo. It is opened as a draft — please review, edit as needed, and mark ready for review before merging.

Review checklist

  • Content matches the behavior shipped in the source PR
  • No internal-only details (service names, file paths, unreleased names, security internals) leaked into the draft
  • Conforms to CLAUDE.md style rules
  • Cross-references and internal links resolve
  • Any Needs human input items from the source comment are addressed

Generated by reusable-docs-draft-pr.yml in relayprotocol/agents-config.

Requested by @matirelay via /publish-docs-pr
@mintlify

mintlify Bot commented Sep 6, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
unevenlabs 🟢 Ready View Preview Sep 6, 2026, 1:48 AM

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

@github-actions

github-actions Bot commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @pedromcunha's task in 1m 47s —— View job


Code review: POST /execute/swap removal changelog entry

  • Read PR diff
  • Check §4.5 changelog entry format
  • Verify internal links resolve
  • Check for companion updates (endpoint page, docs.json nav, inbound links)
  • Post review

The entry is well-formed and lands in the right place. One substantive issue with the cross-references in the **Replacement** paragraph.


1. The "already recommended by" claim is wrong for /execute, and points readers at a deprecated page

references/api/changelog.mdx:10

…and is the same flow already recommended by the POST /price and POST /execute references.

Both halves of this are off:

  • references/api/execute.mdx is frontmatter only — no body, no recommendation, no deprecation warning (execute.mdx:1-6). It documents POST /execute, the live gasless execution endpoint ("Execute Gasless Txs"), which is a separate surface from the quote flow and doesn't recommend anything. A reader following the link to corroborate the claim finds an unrelated endpoint stub.
  • POST /price does carry that recommendation, but only as its own deprecation notice (<DeprecatedExecuteApi />), and references/api/get-price sits in the "Deprecated" nav group (docs.json:175). Sending readers of a breaking-change entry into a deprecated page as supporting evidence works against §4.3's intent.

The paragraph is stronger without the appeal to other pages — POST /quote/v2 plus the Step Execution pointer already tell the reader everything they need to migrate. Suggested:

**Replacement** — use [`POST /quote/v2`](/references/api/get-quote-v2) to request a quote and follow the returned steps to execute it. The Quote API covers bridging, swapping, and calling through a single unified surface. See [Step Execution](/references/api/api_core_concepts/step-execution) for how to submit each step returned by the quote.

Fix this →


Checks that passed

  • §4.5 format — ## YYYY-MM-DD — <summary> heading shape matches what scripts/build-changelog.mjs parses, so the entry will roll into the unified changelog. Newest-first ordering is correct. **Replacement** isn't in CHANGE_TYPE_ORDER (build-changelog.mjs:47), but unlisted types still render after the ordered ones, and the adjacent 2026-09-01 entry already uses the same lead — consistent, not drift.
  • No companion updates needed. There was never a doc page for POST /execute/swap and nothing links to it (§4.2's "update inbound links" is a no-op here). The only other match repo-wide is a historical relay-kit changeset line in the generated changelog.mdx.
  • Generated changelog.mdx correctly untouched (§4.6) — the hourly sync will pick this up after merge.
  • No internal-only detail leaked — the "legacy execution path that predated the unified quote flow" framing is product history, no service names or paths.
  • Remaining links resolve — get-quote-v2, api_core_concepts/step-execution both exist.
  • Terminology (§5) and root-relative link style (§2.6) are clean.
    · branch docs-drift/src-7a3335d955-7fedbe0

@pedromcunha
pedromcunha merged commit 63a8743 into main Sep 8, 2026
5 checks passed
@pedromcunha
pedromcunha deleted the docs-drift/src-7a3335d955-7fedbe0 branch September 8, 2026 14:38
@greptile-apps

greptile-apps Bot commented Sep 8, 2026 •

Copy link
Copy Markdown

Greptile Summary

This change documents the removal of POST /execute/swap and directs integrators to the Quote API and step execution. The migration paragraph inaccurately says that the linked POST /execute reference already recommends the quote-and-steps flow; that page currently contains only its OpenAPI declaration.

Confidence Score: 4/5

The documentation change needs correction before it can reliably guide integrators away from the removed endpoint.

A focused check resolved the exact link in the new migration paragraph and confirmed that its destination does not contain the claimed Quote API or returned-step guidance.

Files Needing Attention: references/api/changelog.mdx line 10 needs attention; alternatively, references/api/execute.mdx would need the missing migration guidance.

T-Rex T-Rex Logs

What T-Rex did

  • T-Rex produced a proof for a posted P2 finding and attached a narrow Execute reference validation script; the accompanying log shows the observed output disproving the Execute reference claim.
  • T-Rex issued a second P2 finding with its proof attached to the review.
  • T-Rex performed general contract validation and DISPROVED the linked reference, citing the relevant lines that show the reference is metadata-only and does not endorse requesting a Quote API step.

View all artifacts

T-Rex Ran code and verified through T-Rex

Comments Outside Diff (1)

  1. General comment

    P2 Changelog overstates the POST /execute reference guidance

    • Bug
      • references/api/changelog.mdx:10 says the unified Quote API/returned-step flow is already recommended by the linked POST /execute reference, but the exact linked local page contains only front matter and an OpenAPI declaration.
    • Cause
      • The changelog assertion is not backed by content in references/api/execute.mdx:1-6; there are no Quote API, returned-step, or step-execution instructions there.
    • Fix
      • Either add an explicit Quote API and returned-step-flow recommendation to the local POST /execute reference, or remove/qualify the statement that this reference already recommends that flow.

    T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "docs(drift): draft from internal source" | Re-trigger Greptile


**Breaking** — `POST /execute/swap` has been removed. Calls to the endpoint now return `404`. The endpoint was a legacy execution path that predated the unified quote flow and had been superseded for some time.

**Replacement** — use [`POST /quote/v2`](/references/api/get-quote-v2) to request a quote and follow the returned steps to execute it. The Quote API covers bridging, swapping, and calling through a single unified surface, and is the same flow already recommended by the [`POST /price`](/references/api/get-price) and [`POST /execute`](/references/api/execute) references. See [Step Execution](/references/api/api_core_concepts/step-execution) for how to submit each step returned by the quote.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Mischaracterized execute reference

The replacement guidance says that the unified Quote API and returned-step flow is already recommended by the linked POST /execute reference. That page only declares the POST /execute OpenAPI operation and contains no Quote API or step-execution guidance. Remove or qualify this assertion, or add the corresponding migration guidance to the execute reference, so integrators are not sent to documentation that does not support the stated migration path.

Artifacts

Narrow Execute reference validation script

  • The executed Python validator checks the changelog link, resolves the precise local Execute reference, and searches it for Quote API and returned-step recommendations; it defines the reproducible validation scope.

Observed output disproving the Execute reference claim

  • Captured output from running the narrow validator shows the exact linked path, zero Quote API and returned-step-flow hits, a DISPROVED result, and exit code 0; the candidate is unsupported.

View artifacts

T-Rex Ran code and verified through T-Rex

This branch was successfully deployed

1 active deployment
staging — 9aaf28ff Deployed Sep 6, 2026 by mintlify[bot]
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