docs: sync api reference 2026-08-24 - #108
Open
JamesLawton wants to merge 1 commit into
Open
Conversation
Sync the OpenAPI spec from trails-api release (0xsequence/trails-api HEAD) and document the surface it exposes that had no docs yet. New endpoint page: - ExecuteIntentEdge — arm an origin-mode edge intent so the server-side monitor starts watching for the Relay fill. Called by the SDK send flow since 0xtrails@0.18.0 in place of CommitIntent for edge intents (see trails PR #1167 / trails-api #1031). OpenAPI drift resolved: - Add ExecuteIntentEdge request/response schemas and the /rpc/Trails/ExecuteIntentEdge path (missing from the local spec). - Add pausableSapientSignerAddress to the Chain schema (trails-api #1028, "gate v1.5 intent execution behind pausable sapient signer"). - Add initChainId, fillChainId, refundChainId to GetEdgeStatusResponse so each transaction hash is paired with the exact chain it settled on. - Mark CommitIntent as deprecated for new integrations in the endpoint summary while leaving its schema behaviorally stable for existing callers. Docs updates: - commit-intent.mdx: add a deprecation warning pointing new integrations at ExecuteIntent / ExecuteIntentEdge. - get-edge-status.mdx: document the new chain-id fields and clarify how each transaction hash pairs with them across ORIGIN vs DESTINATION modes. - docs.json: add ExecuteIntentEdge under the Intents group. Regenerate before-annotations-trails-api.gen.json and trails-api.gen.json from the synced YAML. Generated by the Trails Docs weekly agent. Co-Authored-By: Claude <noreply@anthropic.com>
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
2 participants
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— sync from the trails-apireleasebranch OpenAPI spec. Adds:pausableSapientSignerAddresson theChainschema (v1.5 execution gate).initChainId,fillChainId,refundChainIdonGetEdgeStatusResponse, so each transaction hash pairs with the exact chain it settled on.ExecuteIntentEdgeRequest/ExecuteIntentEdgeResponseschemas and the/rpc/Trails/ExecuteIntentEdgepath.api-reference/trails-api.gen.jsonandapi-reference/before-annotations-trails-api.gen.json— regenerated from the synced YAML by.github/scripts/convert-yaml-to-json.js.api-reference/endpoints/execute-intent-edge.mdx— new endpoint page forExecuteIntentEdge, documenting when to arm an origin-mode edge intent, request/response shape, and how it fits into the send flow.api-reference/endpoints/get-edge-status.mdx— document the newinitChainId/fillChainId/refundChainIdfields and clarify how each transaction hash pairs with them acrossORIGINandDESTINATIONmodes.api-reference/endpoints/commit-intent.mdx— add a deprecation<Warning>pointing new integrations atExecuteIntent/ExecuteIntentEdge; the endpoint itself remains behaviorally stable for existing callers.docs.json— addexecute-intent-edgeunder the Intents group.Source of truth
0xsequence/trails-apiproto/docs/trails-api.gen.yaml@ release.ExecuteIntentEdgeprotocol & handler:proto/trails-api.ridllines 270–285 andlib/intentmachine/handle_execute_edge.go.0xtrails@0.18.0.pausableSapientSignerAddress: trails-api #1028 — feat: gate v1.5 intent execution behind pausable sapient signer.GetEdgeStatusResponsechain-id fields: defined inproto/trails-api.ridllines 197–231.Verification
.github/scripts/convert-yaml-to-json.jslocally after copying the trails-apireleaseYAML;before-annotations-trails-api.gen.jsonis byte-for-byte the conversion output, andtrails-api.gen.jsonmatches it apart from the trailing newline convention. TheConvert OpenAPI YAML to JSONGitHub Action will re-run on push.Generated by the Trails Docs weekly agent.
Generated by Claude Code