Sync docs for swap/earn GA - #812
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
There are concrete doc/spec inconsistencies around swap intent/versioning (V2/V3) plus a broken JavaScript snippet and a spec nullability mismatch that should be resolved before publishing.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the published API specs and reference docs to reflect new/updated swap + earn capabilities (including Robinhood chain IDs), adds new endpoints/docs for policy status and secret import initialization, and removes Velocity Control endpoints from the public surface.
Changes:
- Add
get_active_policiesquery andinit_import_secretssubmit endpoint to OpenAPI/Swagger and docs navigation. - Update swap-related schemas/docs (new intent versions, destination address surfaced, new activity types) and extend CAIP-2 chain enum options (
eip155:4663,eip155:46630). - Add/extend Earn + TVC fields (
forceDeallocatableLiquidity*,provisioningState) across specs and docs; remove Velocity Control endpoints/docs entries.
File summaries
| File | Description |
|---|---|
| scripts/openapi-gen/openapi.json | Adds new endpoints/schemas and updates enums/fields for swaps, policies, secrets, earn, and TVC status. |
| public_api.swagger.json | Mirrors OpenAPI updates in the Swagger (OAS2) artifact. |
| docs.json | Updates site navigation (adds new pages; removes velocity control pages). |
| api-reference/queries/list-supported-assets.mdx | Adds Robinhood chain IDs to the documented CAIP-2 enum options. |
| api-reference/queries/list-eth-transaction-history.mdx | Adds Robinhood chain IDs to the documented CAIP-2 enum options. |
| api-reference/queries/list-activities.mdx | Extends activity type enums and intent/result documentation for new activity intents/results. |
| api-reference/queries/get-tvc-app-status.mdx | Documents new provisioningState field for deployments. |
| api-reference/queries/get-swap-status.mdx | Documents new destinationAddress field in swap status responses. |
| api-reference/queries/get-nonces.mdx | Adds Robinhood chain IDs to the documented CAIP-2 enum options. |
| api-reference/queries/get-earn-vault-catalog.mdx | Documents new forceDeallocatableLiquidity* fields for vaults. |
| api-reference/queries/get-earn-enabled-vaults.mdx | Documents new forceDeallocatableLiquidity* fields for enabled vaults. |
| api-reference/queries/get-balances.mdx | Adds Robinhood chain IDs to the documented CAIP-2 enum options. |
| api-reference/queries/get-activity.mdx | Extends activity enums and intent/result documentation to include new intents/results. |
| api-reference/queries/get-active-policies.mdx | New doc page for the get_active_policies query endpoint. |
| api-reference/activities/init-import-secrets.mdx | New doc page for the init_import_secrets submit endpoint. |
| api-reference/activities/get-swap-quote.mdx | Updates swap quote activity intent documentation to the V2 intent shape. |
| api-reference/activities/execute-swap.mdx | Updates execute swap activity intent documentation to the V3 intent shape. |
| api-reference/activities/broadcast-evm-transaction.mdx | Adds Robinhood chain IDs to the documented CAIP-2 enum options. |
Review details
- Files reviewed: 18/18 changed files
- Comments generated: 6
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
4978
to
+4986
| "ACTIVITY_TYPE_EXECUTE_SWAP_V2", | ||
| "ACTIVITY_TYPE_CREATE_SWAP_QUOTE", | ||
| "ACTIVITY_TYPE_IMPORT_SECRETS", | ||
| "ACTIVITY_TYPE_EXPORT_SECRETS", | ||
| "ACTIVITY_TYPE_CREATE_VELOCITY_CONTROL", | ||
| "ACTIVITY_TYPE_DELETE_VELOCITY_CONTROL" | ||
| "ACTIVITY_TYPE_DELETE_VELOCITY_CONTROL", | ||
| "ACTIVITY_TYPE_UPDATE_PAYMENT_METHOD", | ||
| "ACTIVITY_TYPE_CREATE_SWAP_QUOTE_V2", | ||
| "ACTIVITY_TYPE_EXECUTE_SWAP_V3" |
Comment on lines
6066
to
+6074
| "ACTIVITY_TYPE_EXECUTE_SWAP_V2", | ||
| "ACTIVITY_TYPE_CREATE_SWAP_QUOTE", | ||
| "ACTIVITY_TYPE_IMPORT_SECRETS", | ||
| "ACTIVITY_TYPE_EXPORT_SECRETS", | ||
| "ACTIVITY_TYPE_CREATE_VELOCITY_CONTROL", | ||
| "ACTIVITY_TYPE_DELETE_VELOCITY_CONTROL" | ||
| "ACTIVITY_TYPE_DELETE_VELOCITY_CONTROL", | ||
| "ACTIVITY_TYPE_UPDATE_PAYMENT_METHOD", | ||
| "ACTIVITY_TYPE_CREATE_SWAP_QUOTE_V2", | ||
| "ACTIVITY_TYPE_EXECUTE_SWAP_V3" |
Comment on lines
+11055
to
11057
| "provisioningState": { | ||
| "$ref": "#/components/schemas/ProvisioningState" | ||
| } |
Comment on lines
100
to
+104
| <NestedParam parentKey="activity" childKey="intent" type="object" required={true}> | ||
| The intent of the activity | ||
| <Expandable title="intent details"> | ||
| <NestedParam parentKey="activity.intent" childKey="executeSwapIntentV2" type="object" required={true}> | ||
| The executeSwapIntentV2 object | ||
| <Expandable title="executeSwapIntentV2 details"> | ||
| <NestedParam parentKey="activity.intent.executeSwapIntentV2" childKey="quoteId" type="string" required={true}> | ||
| <NestedParam parentKey="activity.intent" childKey="executeSwapIntentV3" type="object" required={true}> | ||
| The executeSwapIntentV3 object |
Comment on lines
+83
to
90
| <NestedParam parentKey="activity.intent" childKey="createSwapQuoteIntentV2" type="object" required={true}> | ||
| The createSwapQuoteIntentV2 object | ||
| <Expandable title="createSwapQuoteIntentV2 details"> | ||
| <NestedParam parentKey="activity.intent.createSwapQuoteIntentV2" childKey="signWith" type="string" required={true}> | ||
| Wallet account address used to price the executable provider quote. Private Key identifiers are not supported. | ||
| </NestedParam> | ||
| <NestedParam parentKey="activity.intent.createSwapQuoteIntent" childKey="inputToken" type="string" required={true}> | ||
| <NestedParam parentKey="activity.intent.createSwapQuoteIntentV2" childKey="inputToken" type="string" required={true}> | ||
| CAIP-19 asset ID for the input asset. The chain is derived from this value. |
Comment on lines
+156
to
+159
| const response = await turnkeyClient.apiClient().initImportSecrets({ | ||
| encryptionSuite: "<TRANSPORT_ENCRYPTION_SUITE_ENCLAVE_ENCRYPT_V1>" // encryptionSuite field, | ||
| numSecrets: 0 // The number of secrets the user intends to import. | ||
| }); |
MasterHW
approved these changes
Sep 4, 2026
MasterHW
left a comment
MasterHW
left a comment
Member
There was a problem hiding this comment.
no meaningful finds by copilot, and looks sane to me, approved
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.
Adding docs for robinhood chain and executeSwapIntentV3