diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
index 4d25cff..6515eb3 100644
--- a/docs/CHANGELOG.md
+++ b/docs/CHANGELOG.md
@@ -2,24 +2,21 @@
## [0.3.8](https://github.com/sprintertech/sprinter-sdk/compare/docs-v0.3.7...docs-v0.3.8) (2025-06-30)
-
### Bug Fixes
-* update solve api example ([#175](https://github.com/sprintertech/sprinter-sdk/issues/175)) ([9dbfbd8](https://github.com/sprintertech/sprinter-sdk/commit/9dbfbd8763e13b050e0bc3ca33414f6016a48cb4))
+- update solve api example ([#175](https://github.com/sprintertech/sprinter-sdk/issues/175)) ([9dbfbd8](https://github.com/sprintertech/sprinter-sdk/commit/9dbfbd8763e13b050e0bc3ca33414f6016a48cb4))
## [0.3.7](https://github.com/sprintertech/sprinter-sdk/compare/docs-v0.3.6...docs-v0.3.7) (2025-06-26)
-
### Bug Fixes
-* broken links solve v1 ([#169](https://github.com/sprintertech/sprinter-sdk/issues/169)) ([34be02b](https://github.com/sprintertech/sprinter-sdk/commit/34be02b69ef86a3b7cb9d27ec1bb24f69889be40))
+- broken links solve v1 ([#169](https://github.com/sprintertech/sprinter-sdk/issues/169)) ([34be02b](https://github.com/sprintertech/sprinter-sdk/commit/34be02b69ef86a3b7cb9d27ec1bb24f69889be40))
## [0.3.6](https://github.com/sprintertech/sprinter-sdk/compare/docs-v0.3.5...docs-v0.3.6) (2025-06-12)
-
### Bug Fixes
-* update to solve-openapi.yaml to match updated OpenAPI spec ([#167](https://github.com/sprintertech/sprinter-sdk/issues/167)) ([b79e4cc](https://github.com/sprintertech/sprinter-sdk/commit/b79e4cc7ce82df46bb8a6894b11f379dd6536dbb))
+- update to solve-openapi.yaml to match updated OpenAPI spec ([#167](https://github.com/sprintertech/sprinter-sdk/issues/167)) ([b79e4cc](https://github.com/sprintertech/sprinter-sdk/commit/b79e4cc7ce82df46bb8a6894b11f379dd6536dbb))
## [0.3.5](https://github.com/sprintertech/sprinter-sdk/compare/docs-v0.3.4...docs-v0.3.5) (2025-05-28)
diff --git a/docs/docs/03-Solve/get-route-v-1.api.mdx b/docs/docs/03-Solve/get-route-v-1.api.mdx
index 0e2867e..aaca8a9 100644
--- a/docs/docs/03-Solve/get-route-v-1.api.mdx
+++ b/docs/docs/03-Solve/get-route-v-1.api.mdx
@@ -19,17 +19,11 @@ import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
-
+
-Get the **finalized execution package** returned by `/v1/route` which contains all necessary data to execute a transaction. It builds on a quote by including calldata, selected liquidity paths, slippage tolerances, and chain-specific details.
-
-Routes are consumed directly by solvers or smart contracts to simulate and execute cross-chain swaps or intent fills.
+Calculate the optimal swap route and generate execution parameters for a token exchange
@@ -108,11 +98,14 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
description: "Successfully calculated swap route with execution details",
headers: {
"Request-ID": {
- description: "Unique request identifier",
+ description: "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
schema: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
type: "string",
format: "hex",
- pattern: "^0x[a-fA-F0-9]{24}$",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
},
},
},
@@ -121,8 +114,16 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
schema: {
description: "Successfully created route with execution details",
type: "object",
- required: ["amountOut", "minAmountOut", "target", "callData"],
+ required: ["requestId", "amountOut", "minAmountOut", "target", "callData"],
properties: {
+ requestId: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
+ type: "string",
+ format: "hex",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
+ },
amountOut: {
description:
"Amount of an ERC20 token as a decimal string (no scientific notation)",
@@ -160,11 +161,14 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
description: "Bad request due to invalid parameters",
headers: {
"Request-ID": {
- description: "Unique request identifier",
+ description: "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
schema: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
type: "string",
format: "hex",
- pattern: "^0x[a-fA-F0-9]{24}$",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
},
},
},
@@ -173,12 +177,20 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
schema: {
description: "Error response with details",
type: "object",
- required: ["code", "error"],
+ required: ["code", "requestId", "error"],
properties: {
code: {
description: "Error code indicating the type of error",
type: "integer",
},
+ requestId: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
+ type: "string",
+ format: "hex",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
+ },
error: { description: "Error message", type: "string" },
},
title: "Error",
@@ -190,11 +202,14 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
description: "Unauthorized access due to invalid or missing credentials",
headers: {
"Request-ID": {
- description: "Unique request identifier",
+ description: "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
schema: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
type: "string",
format: "hex",
- pattern: "^0x[a-fA-F0-9]{24}$",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
},
},
},
@@ -203,12 +218,20 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
schema: {
description: "Error response with details",
type: "object",
- required: ["code", "error"],
+ required: ["code", "requestId", "error"],
properties: {
code: {
description: "Error code indicating the type of error",
type: "integer",
},
+ requestId: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
+ type: "string",
+ format: "hex",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
+ },
error: { description: "Error message", type: "string" },
},
title: "Error",
@@ -220,11 +243,14 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
description: "No viable swap route found for the given parameters",
headers: {
"Request-ID": {
- description: "Unique request identifier",
+ description: "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
schema: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
type: "string",
format: "hex",
- pattern: "^0x[a-fA-F0-9]{24}$",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
},
},
},
@@ -233,12 +259,20 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
schema: {
description: "Error response with details",
type: "object",
- required: ["code", "error"],
+ required: ["code", "requestId", "error"],
properties: {
code: {
description: "Error code indicating the type of error",
type: "integer",
},
+ requestId: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
+ type: "string",
+ format: "hex",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
+ },
error: { description: "Error message", type: "string" },
},
title: "Error",
@@ -250,11 +284,14 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
description: "Internal server error",
headers: {
"Request-ID": {
- description: "Unique request identifier",
+ description: "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
schema: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
type: "string",
format: "hex",
- pattern: "^0x[a-fA-F0-9]{24}$",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
},
},
},
@@ -263,12 +300,20 @@ Routes are consumed directly by solvers or smart contracts to simulate and execu
schema: {
description: "Error response with details",
type: "object",
- required: ["code", "error"],
+ required: ["code", "requestId", "error"],
properties: {
code: {
description: "Error code indicating the type of error",
type: "integer",
},
+ requestId: {
+ description:
+ "Unique request identifier (16 bytes) encoded as hexadecimal with 0x prefix",
+ type: "string",
+ format: "hex",
+ pattern: "^0x[a-fA-F0-9]{32}$",
+ title: "RequestID",
+ },
error: { description: "Error message", type: "string" },
},
title: "Error",