docs: sync api reference 2026-06-22#96
Open
JamesLawton wants to merge 2 commits into
Open
Conversation
Sync two API-visible additions landed in trails-api this week: - Intent.timedRefundUnlockTimestamp (optional uint64) - unix timestamp after which the timed-refund sapient signer can execute refunds for the intent's wallets. Set only when timed refund support was enabled at quote time. Backs the v1.5 timed-refund leaf in trails-api #892. - ErrorIntentProtocolDeprecated (code 3000, HTTP 422) - returned when the requested intent protocol version is outdated. Added in trails-api proto/trails-api.ridl. Updates trails-api.gen.yaml, trails-api.gen.json, and before-annotations-trails-api.gen.json.
pnpm v8 (pinned in .github/workflows/convert-openapi.yml) rejects a workspace yaml that lacks a packages field with ERR_PNPM_INVALID_WORKSPACE_CONFIGURATION. The Convert OpenAPI workflow fires on changes to api-reference/trails-api.gen.yaml, so this surfaces only when the YAML is edited - which hadn't happened since #88 introduced the workspace file. Adding packages: [] preserves the intent of using the file purely for minimumReleaseAge / allowBuilds settings while satisfying pnpm 8's schema validation.
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
Two narrowly-scoped API additions landed in
trails-apireleasethis week and are missing from the docs OpenAPI specs.Intent.timedRefundUnlockTimestamp— new optionalnumberfield on theIntentschema. Unix timestamp (in seconds) after which the timed-refund sapient signer can execute refunds for an intent's wallets. Only set when timed refund support was enabled at quote time (v1.5 intents). Added to:api-reference/trails-api.gen.yamlapi-reference/trails-api.gen.jsonapi-reference/before-annotations-trails-api.gen.jsonErrorIntentProtocolDeprecated— new error schema (code3000, HTTP 422). Returned when the requested intent protocol version is outdated/deprecated and the client must upgrade the Trails SDK. Added as a schema definition next to the otherError*schemas in the three spec files above.The error response is wired into 40+ endpoint responses upstream; this PR adds only the schema definition. Wiring the
oneOfreferences into each endpoint can be done in a follow-up sync.Source of truth
trails-apiPR #892 — Add timed refund leaf to 1.5 intents (commit5658e33) — introducedIntent.timedRefundUnlockTimestampinproto/trails-types.ridl.trails-apiproto/trails-api.ridlline 709:error 3000 IntentProtocolDeprecated "..." HTTP 422.trails-apiproto/docs/trails-api.gen.yamlat commit103d6ba(currentreleaseHEAD).Verification
TimedRefundUnlockTimestampships withjson:"timedRefundUnlockTimestamp,omitempty"inproto/trails-api.gen.go, so it is part of the wire response (unlikestatusUpdatedAt/eligibleAtonIntentTransaction, which are taggedjson:"-"and therefore intentionally omitted from these docs).trails-api/proto/docs/trails-api.gen.yamllines 1410-1411 (timedRefundUnlockTimestamp) and 803-824 (ErrorIntentProtocolDeprecated).Generated by the Trails Docs weekly agent.
Generated by Claude Code