Skip to content

docs: sync api reference 2026-06-01#90

Open
JamesLawton wants to merge 1 commit into
mainfrom
docs/update-api-reference-2026-06-01
Open

docs: sync api reference 2026-06-01#90
JamesLawton wants to merge 1 commit into
mainfrom
docs/update-api-reference-2026-06-01

Conversation

@JamesLawton

Copy link
Copy Markdown
Collaborator

What changed

  • api-reference/trails-api.gen.yaml — synced from trails-api/proto/docs/trails-api.gen.yaml on the release branch. The servers: 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 running pnpm run convert-openapi.

Endpoints added to the spec

The auto-generated YAML and JSON now describe these endpoints, which exist in the release branch of trails-api but were missing from the docs spec:

  • /rpc/Trails/RetryIntent
  • /rpc/Trails/PrepareIntentRecovery
  • /rpc/Trails/BuildIntentRecoveryTransaction
  • /rpc/Trails/YieldGetProvider (singular)
  • /rpc/Trails/YieldGetNetworks
  • /rpc/Trails/YieldGetMarketById

Schemas 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-adds originTokenAddress and destinationTokenAddress as required fields, plus gasFeeOptions.
  • TrailsContracts — adds the trailsUtilsAddress field.

Source of truth

  • trails-api release branch HEAD: 8cdeded fix: reject partial Sushi exact-input quotes (#763)
  • Source spec: trails-api/proto/docs/trails-api.gen.yaml (regenerated from proto/trails-api.ridl by webrpc-gen@v0.36.1)
  • ridl service definitions: trails-api/proto/trails-api.ridl (the six new endpoints are declared in the service Trails block)

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.
  • Mintlify preview should still render every existing endpoint MDX page; no MDX openapi: references change.

Follow-up needed (not in this PR)

api-reference/trails-api.gen.json is hand-annotated separately from the auto-generated YAML/JSON, and only RetryIntent was added there in #87. The other five new endpoints (PrepareIntentRecovery, BuildIntentRecoveryTransaction, YieldGetProvider, YieldGetNetworks, YieldGetMarketById) still need:

  1. An annotated copy of each endpoint/schema in trails-api.gen.json.
  2. A matching MDX page under api-reference/endpoints/ and a docs.json nav entry, following the pattern in retry-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

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.
@mintlify

mintlify Bot commented Jun 1, 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 1, 2026, 9:14 AM

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

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