Skip to content

docs: sync api reference 2026-06-29#97

Merged
JamesLawton merged 2 commits into
mainfrom
docs/update-api-reference-2026-06-29
Jun 29, 2026
Merged

docs: sync api reference 2026-06-29#97
JamesLawton merged 2 commits into
mainfrom
docs/update-api-reference-2026-06-29

Conversation

@JamesLawton

Copy link
Copy Markdown
Collaborator

What changed

OpenAPI spec sync (api-reference/trails-api.gen.yaml, api-reference/trails-api.gen.json, api-reference/before-annotations-trails-api.gen.json): replaced with the current spec from trails-api/proto/docs/trails-api.gen.yaml on the release branch. Preserved the servers: block that was added downstream. The before-annotations JSON was regenerated via pnpm convert-openapi; the main annotated JSON was resynced from the new spec (the previous hand-annotated descriptions on the old yield endpoints' opaque payloads are obsolete now that the spec carries fully-typed YieldMarket / YieldProvider / YieldNetwork schemas).

New endpoint pages (api-reference/endpoints/):

  • quote-intent-edge.mdx, get-edge-status.mdx, get-edges.mdx — Solana / Tron edge-rail flow.
  • prepare-intent-recovery.mdx, build-intent-recovery-transaction.mdx — recover funds stranded in an intent wallet via signed payload + executable tx.
  • build-oif-refund-transaction.mdx — direct on-chain refund for expired OIF orders.
  • yield-get-provider.mdx, yield-get-networks.mdx, yield-get-market-by-id.mdx — new singular/discovery endpoints on the yield surface.

Navigation (docs.json): added the new pages to the Intents, Earn, and Intents (Advanced) groups.

Source of truth

  • All endpoint pages: defined in trails-api/proto/trails-api.ridl on release (HEAD e1d6ecc); generated spec at trails-api/proto/docs/trails-api.gen.yaml (build SHA ea051e40).
  • New schemas — EdgeRail (SOLANA/TRON), EdgeMode (ORIGIN/DESTINATION), EdgeStatus, IntentMode, expanded RouteProvider (now includes HYPERLANE, LZ_TRANSFER, OIF, SOMNIA_EXCHANGE, SOMNIA_SWAP), new Intent fields (originTokenAddress, destinationTokenAddress, edge, isTestnet, timedRefundUnlockTimestamp, gasFeeOptions), totalFeeUsd type change (string → number), new ErrorIntentProtocolDeprecated, new IntentTransactionType HYPERLANE_PAY_FOR_GAS, new FundMethod ONRAMP_BLUVO — all sourced from the same generated spec.
  • Notable backing PRs in trails-api: feat(edge): add Tron edge rail with EdgeRail interface refactor (#776), feat: expose edge rail status flags (#948), feat(edge): race Base ETH native handoff on all rails (#944), plus the OIF refund and intent-recovery flows already merged on release.

Verification

  • pnpm install && pnpm convert-openapi — produces the same before-annotations-trails-api.gen.json checked in (the script is the canonical YAML→JSON converter).
  • pnpm test (mintlify broken-links) — confirm the new pages and CardGroup links resolve.
  • Spot-check the new endpoint pages render correctly under Mintlify's openapi: frontmatter — each references ../trails-api.gen.json post /rpc/Trails/<Name> and the synced JSON now contains those paths.
  • Cross-reference field shapes in each new page against the matching struct block in trails-api/proto/trails-api.ridl / trails-types.ridl.

A small number of {/* TODO: verify */} markers were left in the new pages on examples where I derived the request body from the schema rather than from a captured trace — flagged for follow-up by anyone who has a real-world payload handy.

Generated by the Trails Docs weekly agent.


Generated by Claude Code

Sync OpenAPI spec from trails-api release branch (commit ea051e40) and add
documentation for new endpoints shipped since the last sync.

New endpoints documented:
- QuoteIntentEdge / GetEdgeStatus / GetEdges (Solana / Tron edge rails)
- PrepareIntentRecovery / BuildIntentRecoveryTransaction (intent fund recovery)
- BuildOIFRefundTransaction (OIF order self-refund)
- YieldGetProvider / YieldGetNetworks / YieldGetMarketById

OpenAPI spec drift resolved (new schemas: EdgeRail, EdgeMode, EdgeStatus,
IntentMode; expanded RouteProvider enum; new Intent fields; full YieldMarket /
YieldProvider types).

Generated by the Trails Docs weekly agent.
@mintlify

mintlify Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
trails 🟢 Ready View Preview Jun 29, 2026, 9:21 AM

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

@JamesLawton JamesLawton merged commit f60ca60 into main Jun 29, 2026
3 checks passed
@JamesLawton JamesLawton deleted the docs/update-api-reference-2026-06-29 branch June 29, 2026 09:46
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