Skip to content

docs: sync api reference 2026-09-14 - #113

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

JamesLawton wants to merge 1 commit into
mainfrom
docs/update-api-reference-2026-09-14

Conversation

@JamesLawton

Copy link
Copy Markdown
Collaborator

What changed

New endpoint pages

  • api-reference/endpoints/execute-intent-edge.mdx — documents ExecuteIntentEdge, which arms an origin-mode edge intent so the edge monitor starts watching for the external bridge fill server-side. Idempotent, no deposit attached, rejects on QuoteExpired — matches the current implementation.
  • api-reference/endpoints/yield-submit-transaction-hash.mdx — documents YieldSubmitTransactionHash, which reports the on-chain hash of a broadcast Yield deposit/withdrawal action back to the upstream Yield provider for lifecycle tracking and aggregate-balance discovery.

Navigation

  • docs.json — adds both new endpoints under their existing groups (Intents and Earn).

OpenAPI spec sync

  • api-reference/trails-api.gen.yaml — regenerated from trails-api's proto/docs/trails-api.gen.yaml at release commit 5154d223 (previous docs sync tracked 6cf9188c). Re-adds the servers: [{ url: https://trails-api.sequence.app }] block that trails-docs' JSON needs but the upstream YAML no longer emits.
  • api-reference/trails-api.gen.json and api-reference/before-annotations-trails-api.gen.json — regenerated from the YAML to match.

Additive schema fields already exposed on release are picked up automatically by the Mintlify OpenAPI renderer via the endpoint pages' openapi: frontmatter:

  • IntentEdgeMetadata.initChainId, .fillChainId, .refundChainId
  • GetEdgeStatusResponse.initChainId, .fillChainId, .refundChainId
  • Intent.pausableSapientSignerAddress
  • TokenInfo.feeOnTransfer
  • New ErrorFeeOnTransferToken error surfaced in every endpoint's 4XX oneOf list.

Existing pages touched

  • api-reference/endpoints/get-edge-status.mdx — hand-written prose section now documents the three new *ChainId fields alongside their matching *TransactionHash fields, since the prose section duplicates what the OpenAPI renderer shows.

Source of truth

  • trails-api PR #1123 — feat: expose Yield transaction hash submission (0xsequence/trails-api#1123) — introduces YieldSubmitTransactionHash; ridl at proto/trails-api.ridl lines 126–127, handler at rpc/yield.go lines 193–215.
  • trails-api proto/trails-api.ridl lines 22–27, 273–288 and rpc/intents.go lines 111–114, lib/intentmachine/handle_execute_edge.goExecuteIntentEdge behavior (arm-only, idempotent, QuoteExpired gate, intent stays QUOTED).
  • trails-api proto/docs/trails-api.gen.yaml at commit 5154d223 — the copied OpenAPI source.

Verification

  • python3 -c "import json; json.load(open('docs.json'))"docs.json parses.
  • python3 -c "import json; j=json.load(open('api-reference/trails-api.gen.json')); assert '/rpc/Trails/YieldSubmitTransactionHash' in j['paths']; assert '/rpc/Trails/ExecuteIntentEdge' in j['paths']" — both new paths reach the JSON spec.
  • diff api-reference/before-annotations-trails-api.gen.json api-reference/trails-api.gen.json — only a trailing-newline difference (matches the pattern the auto-convert workflow produces).
  • Both new MDX pages point at ../trails-api.gen.json with the matching path, so the Mintlify renderer picks up the request/response schemas automatically.

Generated by the Trails Docs weekly agent.

🤖 Generated with Claude Code

https://claude.ai/code/session_01QEro4tScdDZQDvy5xXfvpz


Generated by Claude Code

Sync OpenAPI spec from trails-api release branch (commit 5154d223) and
add documentation for two new endpoints exposed on release but missing
from the docs.

New endpoint pages:
- ExecuteIntentEdge — arms an origin-mode edge intent so the edge monitor
  starts watching for the external bridge fill server-side.
- YieldSubmitTransactionHash — reports the on-chain hash of a broadcast
  Yield deposit/withdrawal action back to the upstream Yield provider.

Both grouped into their existing navigation sections in docs.json (Intents,
Earn).

OpenAPI spec drift resolved:
- Regenerated api-reference/trails-api.gen.yaml, .gen.json, and the
  before-annotations JSON from trails-api's proto/docs/trails-api.gen.yaml.
- Preserved the `servers: [{ url: https://trails-api.sequence.app }]`
  block that trails-docs' JSON needs but the upstream YAML does not
  include.
- Picks up additive schema fields already exposed on release:
  `initChainId`, `fillChainId`, `refundChainId` on `IntentEdgeMetadata`
  and `GetEdgeStatusResponse`; `pausableSapientSignerAddress` on
  `Intent`; `feeOnTransfer` on `TokenInfo`; and the new
  `ErrorFeeOnTransferToken` error in every endpoint's 4XX oneOf list.

Existing pages touched:
- api-reference/endpoints/get-edge-status.mdx: document the new
  `initChainId`/`fillChainId`/`refundChainId` fields alongside the
  matching transaction-hash fields.

Generated by the Trails Docs weekly agent.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QEro4tScdDZQDvy5xXfvpz
@mintlify

mintlify Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
trails 🟢 Ready View Preview Sep 14, 2026, 9:16 AM

💡 Tip: Enable Automations 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