docs: sync api reference 2026-06-29#97
Merged
Merged
Conversation
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.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 fromtrails-api/proto/docs/trails-api.gen.yamlon thereleasebranch. Preserved theservers:block that was added downstream. Thebefore-annotationsJSON was regenerated viapnpm 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-typedYieldMarket/YieldProvider/YieldNetworkschemas).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
trails-api/proto/trails-api.ridlonrelease(HEADe1d6ecc); generated spec attrails-api/proto/docs/trails-api.gen.yaml(build SHAea051e40).EdgeRail(SOLANA/TRON),EdgeMode(ORIGIN/DESTINATION),EdgeStatus,IntentMode, expandedRouteProvider(now includes HYPERLANE, LZ_TRANSFER, OIF, SOMNIA_EXCHANGE, SOMNIA_SWAP), new Intent fields (originTokenAddress,destinationTokenAddress,edge,isTestnet,timedRefundUnlockTimestamp,gasFeeOptions),totalFeeUsdtype change (string → number), newErrorIntentProtocolDeprecated, newIntentTransactionTypeHYPERLANE_PAY_FOR_GAS, newFundMethodONRAMP_BLUVO— all sourced from the same generated spec.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 onrelease.Verification
pnpm install && pnpm convert-openapi— produces the samebefore-annotations-trails-api.gen.jsonchecked in (the script is the canonical YAML→JSON converter).pnpm test(mintlify broken-links) — confirm the new pages andCardGrouplinks resolve.openapi:frontmatter — each references../trails-api.gen.json post /rpc/Trails/<Name>and the synced JSON now contains those paths.structblock intrails-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