Skip to content

docs: sync api reference 2026-08-31 - #110

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

docs: sync api reference 2026-08-31#110
JamesLawton wants to merge 1 commit into
mainfrom
docs/update-api-reference-2026-08-31

Conversation

@JamesLawton

Copy link
Copy Markdown
Collaborator

What changed

  • api-reference/trails-api.gen.yaml — synced to 0xsequence/trails-api@5c42fda7 (release). The servers block (https://trails-api.sequence.app) is preserved.
  • api-reference/trails-api.gen.json and before-annotations-trails-api.gen.json — regenerated to match.
  • api-reference/endpoints/execute-intent-edge.mdx — new page for the ExecuteIntentEdge RPC (arms Solana/Tron origin edge intents; no deposit hash — server discovers the fill).
  • api-reference/endpoints/commit-intent.mdx — marked deprecated for new integrations, kept for legacy callers.
  • api-reference/endpoints/execute-intent.mdx — now accepts QUOTED intents directly; intentId comes from QuoteIntent.intent.intentId; the "full flow" example no longer calls commitIntent.
  • api-reference/endpoints/quote-intent.mdx — next-step guidance recommends ExecuteIntent (or ExecuteIntentEdge) directly.
  • api-reference/introduction.mdx — quickstart no longer walks through the CommitIntent HTTP call and the timing table reflects the new default.
  • api-reference/trails-api-sdk.mdx — example calls executeIntent directly on intent.intentId; endpoint list adds ExecuteIntentEdge and marks CommitIntent legacy.
  • docs.json — adds api-reference/endpoints/execute-intent-edge to the Intents nav group.

Source of truth

Verification

  • diff proto/docs/trails-api.gen.yaml api-reference/trails-api.gen.yaml — only the servers: block remains as a docs-side addition (Mintlify needs it for the request examples).
  • Regenerated JSON via the repo's own .github/scripts/convert-yaml-to-json.js equivalent (js-yaml dump → JSON.stringify(data, null, 2)).
  • All endpoint MDX pages reference ../trails-api.gen.json; the new execute-intent-edge.mdx uses the same pattern and the endpoint now exists in the spec at /rpc/Trails/ExecuteIntentEdge.
  • Confirmed no other MDX file still calls commitIntent in a way that would break the new flow — remaining CommitIntent references in sdk/hooks.mdx, use-cases/fund.mdx, and resources/llm-integration.mdx are handled in the sibling docs/update-sdk-2026-08-31 and docs/update-use-cases-2026-08-31 PRs.

Generated by the Trails Docs weekly agent.


Generated by Claude Code

Sync OpenAPI spec to trails-api release, document ExecuteIntentEdge, and
reflect the CommitIntent deprecation across endpoint docs.

Source-of-truth commit: 0xsequence/trails-api@5c42fda7

- api-reference/trails-api.gen.yaml — regenerate from proto/docs/trails-api.gen.yaml
  and preserve the servers block Mintlify needs to render examples
- api-reference/trails-api.gen.json, before-annotations-*.json — regenerate
- api-reference/endpoints/execute-intent-edge.mdx — new page for the
  ExecuteIntentEdge RPC (arms Solana/Tron origin edge intents)
- api-reference/endpoints/commit-intent.mdx — mark deprecated for new
  integrations; still behaviorally stable for legacy callers
- api-reference/endpoints/execute-intent.mdx — note it now accepts QUOTED
  intents directly; intentId comes from QuoteIntent
- api-reference/endpoints/quote-intent.mdx — direct callers should call
  ExecuteIntent (or ExecuteIntentEdge for edge origins) after quoting
- api-reference/introduction.mdx — quickstart no longer walks through
  CommitIntent; timing table shows the new default flow
- api-reference/trails-api-sdk.mdx — example calls executeIntent directly
- docs.json — add execute-intent-edge to the Intents navigation group
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.

1 participant