docs: sync api reference 2026-09-14 - #113
Open
JamesLawton wants to merge 1 commit into
Open
JamesLawton wants to merge 1 commit into
JamesLawton wants to merge 1 commit into
Conversation
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
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations 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
New endpoint pages
api-reference/endpoints/execute-intent-edge.mdx— documentsExecuteIntentEdge, 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 onQuoteExpired— matches the current implementation.api-reference/endpoints/yield-submit-transaction-hash.mdx— documentsYieldSubmitTransactionHash, 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 fromtrails-api'sproto/docs/trails-api.gen.yamlat release commit5154d223(previous docs sync tracked6cf9188c). Re-adds theservers: [{ url: https://trails-api.sequence.app }]block that trails-docs' JSON needs but the upstream YAML no longer emits.api-reference/trails-api.gen.jsonandapi-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,.refundChainIdGetEdgeStatusResponse.initChainId,.fillChainId,.refundChainIdIntent.pausableSapientSignerAddressTokenInfo.feeOnTransferErrorFeeOnTransferTokenerror surfaced in every endpoint's 4XXoneOflist.Existing pages touched
api-reference/endpoints/get-edge-status.mdx— hand-written prose section now documents the three new*ChainIdfields alongside their matching*TransactionHashfields, since the prose section duplicates what the OpenAPI renderer shows.Source of truth
trails-apiPR #1123 —feat: expose Yield transaction hash submission(0xsequence/trails-api#1123) — introducesYieldSubmitTransactionHash; ridl atproto/trails-api.ridllines 126–127, handler atrpc/yield.golines 193–215.trails-apiproto/trails-api.ridllines 22–27, 273–288 andrpc/intents.golines 111–114,lib/intentmachine/handle_execute_edge.go—ExecuteIntentEdgebehavior (arm-only, idempotent,QuoteExpiredgate, intent staysQUOTED).trails-apiproto/docs/trails-api.gen.yamlat commit5154d223— the copied OpenAPI source.Verification
python3 -c "import json; json.load(open('docs.json'))"—docs.jsonparses.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).../trails-api.gen.jsonwith 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