docs: sync api reference 2026-06-08#93
Open
JamesLawton wants to merge 1 commit into
Open
Conversation
Sync the OpenAPI spec files with the source-of-truth from trails-api/proto/docs/trails-api.gen.yaml. Surfaces endpoints, types and enum values added since the last sync: - New route providers: HYPERLANE, LZ_TRANSFER, OIF, SOMNIA_EXCHANGE, SOMNIA_SWAP, ONRAMP_BLUVO, HYPERLANE_PAY_FOR_GAS - New types: IntentMode (SWAP/FUND/EARN/PAY/WITHDRAW), EdgeRail, EdgeMode, EdgeStatus, EdgeQuoteRequest/Response, EdgeHandoff, IntentEdgeMetadata, FiatCurrency - New endpoints: QuoteIntentEdge, GetEdgeStatus, GetEdges, BuildOIFRefundTransaction, GetFiatCurrencyList, GetCountryList, GetTrailsContracts, GetProtocolContracts, GetSupportedIntentProtocols, GetDefaultIntentProtocol, GetIntentTransactionHistory (deprecated alias of GetIntentHistory) - Additional fields on existing types (mode, gasFeeOptions, isTestnet, edge, originTokenAddress/destinationTokenAddress on IntentQuoteRequest, etc.) Also update the quote-intent reference page to list the new bridge and swap provider options.
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
2 participants
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
Weekly sync of the OpenAPI spec with the trails-api source-of-truth, plus a small companion update to the QuoteIntent reference page.
api-reference/trails-api.gen.yaml— replaced with the current canonical YAML fromtrails-api/proto/docs/trails-api.gen.yaml.api-reference/before-annotations-trails-api.gen.json— regenerated viapnpm run convert-openapi.api-reference/trails-api.gen.json— regenerated from the new YAML with the existingserversannotation re-applied (manually annotated entries likeRetryIntentare now in the source YAML, so they round-trip cleanly).api-reference/endpoints/quote-intent.mdx— extendedbridgeProviderandswapProviderenum lists to include the new providers exposed by the API.Newly surfaced surface area in this sync (all already present in the source repo):
HYPERLANE,LZ_TRANSFER,OIF,SOMNIA_EXCHANGE,SOMNIA_SWAP,ONRAMP_BLUVO, plus theHYPERLANE_PAY_FOR_GASstep kind.IntentMode(SWAP/FUND/EARN/PAY/WITHDRAW),EdgeRail(SOLANA),EdgeMode,EdgeStatus,EdgeQuoteRequest,EdgeQuoteResponse,EdgeHandoff,IntentEdgeMetadata,FiatCurrency.QuoteIntentEdge,GetEdgeStatus,GetEdges,BuildOIFRefundTransaction,GetFiatCurrencyList,GetCountryList,GetTrailsContracts,GetProtocolContracts,GetSupportedIntentProtocols,GetDefaultIntentProtocol.GetIntentTransactionHistoryis now correctly marked deprecated and points atGetIntentHistory.mode,gasFeeOptions,isTestnet,edge,originTokenAddress/destinationTokenAddressrequired-field tightening onIntentQuoteRequest,quotedOriginTokenAmountrequired on the relevant response, etc.Source of truth
trails-apirelease branch,proto/docs/trails-api.gen.yaml(# trails-api v1 b0e662c50b61d09cef298cd964cb978c2161e62e).releasein the last 7 days that produced these schema changes:feat: add Open Intents Framework (OIF) support(introducesOIFprovider,BuildOIFRefundTransaction, OIF refund worker).hyperlane: enable in AUTO routing with market-rate fee estimation.Add edge transaction steps for Solana-origin quotes(edge types + endpoints).refactor: remove edge awareness from intentmachine(GetIntentReceiptnow returns 404 instead of 500 when the receipt isn't found).fix: same-chain PriceImpactUSD, native token normalization, EXACT_INPUT calldata(also blocksHYPERLANEandOIFforv1quotes).feat: add LZ_TRANSFER route provider.Verification
pnpm run convert-openapito regeneratebefore-annotations-trails-api.gen.jsonfrom the updated YAML.trails-api.gen.jsonto confirm the only manual annotation in the current docs JSON beyond the source YAML was theserversblock; that has been re-applied.trails-api/proto/trails-api.ridland the generatedproto/trails-api.gen.goenum constants.Follow-ups (not in this PR)
These endpoints exist in the source spec but still have no dedicated MDX page — likely candidates for a future PR rather than weekly auto-sync:
QuoteIntentEdge,GetEdgeStatus,GetEdges(Solana edges)BuildOIFRefundTransaction,PrepareIntentRecovery,BuildIntentRecoveryTransactionGetCountryList,GetTrailsContracts,GetProtocolContracts,GetSupportedIntentProtocols,GetDefaultIntentProtocolYieldGetProvider(singular),YieldGetNetworks,YieldGetMarketByIdGenerated by the Trails Docs weekly agent.
Generated by Claude Code