docs: sync api reference 2026-06-01#90
Open
JamesLawton wants to merge 1 commit into
Open
Conversation
Sync the trails-api OpenAPI YAML from the trails-api release branch. The previous copy was several commits behind, missing six endpoints and the full Yield protocol schema set. Endpoints added: - /rpc/Trails/RetryIntent - /rpc/Trails/PrepareIntentRecovery - /rpc/Trails/BuildIntentRecoveryTransaction - /rpc/Trails/YieldGetProvider - /rpc/Trails/YieldGetNetworks - /rpc/Trails/YieldGetMarketById Also adds the Yield* schema types referenced by these endpoints, fixes out-of-date QuoteIntentArgs fields, and adds the trailsUtilsAddress field to TrailsContracts. before-annotations-trails-api.gen.json is regenerated by the convert-openapi script.
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
api-reference/trails-api.gen.yaml— synced fromtrails-api/proto/docs/trails-api.gen.yamlon thereleasebranch. Theservers:block (which lives only in the docs copy) is preserved. The previous copy was 5,059 lines and is now 6,709 lines.api-reference/before-annotations-trails-api.gen.json— regenerated by runningpnpm run convert-openapi.Endpoints added to the spec
The auto-generated YAML and JSON now describe these endpoints, which exist in the
releasebranch oftrails-apibut were missing from the docs spec:/rpc/Trails/RetryIntent/rpc/Trails/PrepareIntentRecovery/rpc/Trails/BuildIntentRecoveryTransaction/rpc/Trails/YieldGetProvider(singular)/rpc/Trails/YieldGetNetworks/rpc/Trails/YieldGetMarketByIdSchemas added
All
Yield*schema types referenced by the new endpoints —YieldProvider,YieldNetwork,YieldMarket,YieldAction,YieldArgumentSchema,YieldBalance,YieldMechanics,YieldStatistics,YieldRiskSummary, and ~40 others.Smaller schema fixes
QuoteIntentArgs— re-addsoriginTokenAddressanddestinationTokenAddressas required fields, plusgasFeeOptions.TrailsContracts— adds thetrailsUtilsAddressfield.Source of truth
trails-apirelease branch HEAD:8cdeded fix: reject partial Sushi exact-input quotes (#763)trails-api/proto/docs/trails-api.gen.yaml(regenerated fromproto/trails-api.ridlbywebrpc-gen@v0.36.1)trails-api/proto/trails-api.ridl(the six new endpoints are declared in theservice Trailsblock)Verification
comm -23 <(grep '^ /' trails-api/proto/docs/trails-api.gen.yaml | sort) <(grep '^ /' trails-docs/api-reference/trails-api.gen.yaml | sort)— should be empty after this PR.openapi:references change.Follow-up needed (not in this PR)
api-reference/trails-api.gen.jsonis hand-annotated separately from the auto-generated YAML/JSON, and onlyRetryIntentwas added there in #87. The other five new endpoints (PrepareIntentRecovery,BuildIntentRecoveryTransaction,YieldGetProvider,YieldGetNetworks,YieldGetMarketById) still need:trails-api.gen.json.api-reference/endpoints/and adocs.jsonnav entry, following the pattern inretry-intent.mdx(docs: add RetryIntent to API reference #87).These were left out of this PR because the annotations require editorial decisions (descriptions, examples) that go beyond a mechanical sync.
Generated by the Trails Docs weekly agent.
Generated by Claude Code