fix: borrow quote example (#189)

Author: BeroBurny

docs/docs/02-Stash/03-get-the-borrow-quote-for-a-liquidity-transaction-based-on-the-input-data.api.mdx

@@ -5,7 +5,7 @@ description: "This endpoint calculates the borrow quote for a liquidity transact
 sidebar_label: "Borrow Quote API"
 hide_title: true
 hide_table_of_contents: true
-api: eJzNVktv2zgQ/isETynAWEXRveiWtEERYNHudrOnIAdaHEtsKZIhh04MQ/99MaTkqI6aNlkUqA+2TM3jmwe/mT1XEJugPWpnec2vOh0ZWOWdtsgaaZpkJEJk2AFbuxDcHbtNDoFtXGCSGX2btNK4YxikjbIhO4Jp25iktG3neo2LKFiA26QDKKatT1i5hD6hYNIqplKQpL/ignsZZA8IIfL6en+E8q/g0DXOMCt7YCewaleCnTXBxfiKC65JxkvsuOAkQf9GDS74BIDXGBIIHpsOesnrPcedJ9mIQduWD4M49vt3jlya1gWNXc9IYXJ/cS8bvLQ5mPz8KUf2HTzZ1f/C8h4iapvzxT4C3rnwlV2+ZycuC0gjmIKNTAYjQ5fLYEepTXB9PiDvEJGtndodcN4mCLsHoKMSX8CmLUILgQ/DTYkEIp47tSORxlkEi/QovTe6yUCrL5Gw75+IcxBHcZ71LlmkGEobLWTt/jS+caduC8E4qabzgQSjdzZCJE9vXr+mn2+t/5OaBmLcJGN2LAAGDVtQ33Q6Fz8fjQ/OQ0BdPCqJC6fF9jsXcSF+wadLsPhyijz32ZMSpfsWO2mWv+s5mpnvY0+P7N6Iya5bf4EGH9nNsS9IkdzbpUqcS3VoSJWACq7tVho9MgVzgfU6RiKVGTm8vDiwTu1iCiEEF36cuWJgEv9OqH8shXppEYKVhkUIWwisWPitIxkER9kSF/M/J8onyXL17mSwZLjmnzyUFmItYF0dxkM1EXC1n56GitxUe/oeqjJUOhlZnwxqbw70dO4UBSo43CPYqJ0tI+Er7Hh9BEDwrTQJfikQYrsesHOK17wFzMMKO17z53ohUs0dUAJKwfCad4g+1lUlvV5FH4hkw2qdtFF3Gru4a3u5alxfZRzUGp8fmPfiXvbezCpNnL5xEyHLhnqLSqkxS1G+IMTSldQw3kXsZe62kf8/AD5r9rO1jKCYs1mr3NzMBUe8PhsRv8/SMfY9wj1W3khtKSe5LPuxxtf84Jzq/rBV1LPncbjX42+p9Y3gXeb8a77fU5L+DWYY6LhM3Lzl6CjXhi7lRpoIT6TsF0z/xeDLJXtYAqbrlbtvK4MmvM/EfvJ5rMYr9oNFbhHSeCjtbo5ngnooQ96YXoLphUveC7Dmt8PNIHgHUkGY0dq7guz0qrTQpPpoLFCUReOsacDjk7Jz4vpwccUFX4/rWu8UqQSZ1yt5V1CWZsozJp/tuZG2TbIl2WKSPv8BqkZTiw==
+api: eJzNV21v2zYQ/isEP6UAG1l+WRN9c9y0CDCgWdt9yoLhLJ0tthSpkJQdw9B/H46SHPkl7eZhwPzBpqnj8bm751605Rm61MrSS6N5wmeg0kqBR8d8jmxurDVr9lQZj0zqVFWZ1MtuOzXOC2bxqZIWMyZ1WfnIVL6svGCgM5ZVFkjxJRe8BAsFerSOJw/bg2u/mMqmyGbTu3uW5iA1u3vPLvByeSkYyjKeTJL4DRdcknAJPueCayiQJzyIc8E7GDzxtkLBXZpjATzZcr8pSdB5K/WSC47PUJSKtlrVV+PJiNe1OER1b403qVGMrurgTFNrnHsFTNmeOBNPARvQp5D8FgIAamms9HnBSEUH6PYZUn+ng9PD+lOIwCsIw+Xnoesp53X92ChB529MtqGTqdEetacllKWSaYh99M2RCdveFaU1JVov0QXZwlTNqX2bm31mFsyb76gdWxjL1rlMc7ZGBhZZe3+PkQ1RL6QO7HUFKIXOswy1KaQOeN7s2TS+vhpMxsOYiwPDa5JKVeXkCv9cSKWOAc6NUQiaWSwtOtQBiFywjalYDitknQLpN8wbRlqYz6VrYPZxLEA53EFoFRMGjX5t7Pfjy1OQJXmkAI8Za8WYzE7x+6R1wanHesM2gyyz6By7yPF532GD59lgCDAdXc+Hw9GH26v3g+kAJ7Pxh+E7nL6/HlyNZu8mv8zS4dGlgjd4ecJzfCaa92j40PHgyO8vTuhAP+40m/k3TImNtTiw46ZPiJYorISNMpAd8T8gcaXRrqHkcDA49syXKk3RuUWl1IZZ9FbiCrM95v3BqdKdmQcZ+BO7jfqZcf44OcnotsKefKjkUyUz6Tf3xqiTEhZL2BSo/SxU0WTLUVcFTx5iMR7Gv8QiHoh49E5QhRTjURyPRTwYiKvRaCTiOJ5M4jgW8fX1KHyNg9zwsRdoqf2oxwSpPS7RcsGf39JNb1dgqTBRT+C3PkeLVcEFn9q59DYsP5VeFtLR8t6ozdJQsb8BR/kzXYECnea0/qiNk46ejbjgX7A0SkL421uPe2tw2P177LviM6aylG0AT3isIU4ouD+UaCvlscgB73sR7sXzMHpHsTqJ+BDfEZoTqbOPJrDwVILVgo9PpcUNZLv8yiqkQif1CpRsBwJmLCukc1QcX2aAf5cpOK+WJ32P1hr7c5c3Yq9YOTll5Z32aDUo5tCu0LKg4X9rBJV3WIak+rVjEUkW6HOT8YQv0YeRzOc84dGOaVEYpqJt+KmjbpqJtt2qjuiyaEvfddS1scYnzVxXWUX13fvSJVEEpbx0paW0t5fzSqpsLX3uNssCLlNTRJzGCPLU55dR4rbrNS+jQb9NH3bltnXuGuVe02t63D9pWjVNTQvTzTOQUmDJn9KH/scFJ1sbVpB0aZwvIIS6HbE+oj8enml4AbbzNPMWtIOUqMLm4DBjphlamqShNCRy7bGwN2L9h4N6SyePzz4qFZWaWjRh3baMeXipTcT/thwl3aI3BCe9dTt5Ju1vQ55HwfPQ2x74dkt++N2quqbtpwrthicPj4KvwEqYk/vpxUE6Wme7yL/qoovPrcFv2N99vzhpe7sJmqxdgapaHnzHze79I4zs5yD7yTvGGYB2Lj8b05lvG2dgDU9rar85QoY2RLh5NGuQvf3a0KU7elRiycrmxDRNsfQ/lO3XwI+3X7ng8/blpTAZHbGwpqYJ6walCY4K9TrsbbkCvaxgSbKNSvr8BWhqNXM=
 sidebar_class_name: "get api-method"
 custom_edit_url: null
 ---
@@ -54,42 +54,65 @@ See the [Request Final Borrow Quote example payload](/Stash/use-stash#3-request-
       description:
         "destChainID must use capid format from our configuration <br />-eip155:8453(Base),<br />-eip155:10 (Optimism),<br />-eip155:42161 (Arbitrum)",
       in: "path",
-      name: "destChainId",
+      name: "chain",
       required: true,
-      schema: { type: "string" },
+      schema: { type: "string", example: "eip155:8453" },
     },
     {
       description: "Protocol name - across, mayan",
       in: "path",
       name: "protocol",
       required: true,
-      schema: { type: "string" },
+      schema: { type: "string", example: "mayan" },
     },
     {
       description:
         "Quote algorithm type: <br /><br />  ExactInput - Request will consider the amount as (input amount - borrow costs) <br /><br /> ExactOutput - Request will consider the amount as (output amount + borrow costs)  ",
       in: "path",
       name: "type",
       required: true,
-      schema: { type: "string" },
-    },
-    {
-      description:
-        "Destination Network ID (optional, defaults to the network from the request body)",
-      in: "query",
-      name: "network",
-      schema: { type: "integer" },
+      schema: { type: "string", example: "ExactOutput" },
     },
   ]}
 ></ParamsDetails>
 
 <RequestSchema
   title={"Body"}
   body={{
-    content: { "application/json": { schema: { type: "string" } } },
-    description: "Amount to borrow",
+    content: {
+      "application/json": {
+        schema: {
+          properties: {
+            amount: {
+              description:
+                "amount of tokens for which we are requesting borrow quote (in the smallest denomination)",
+              example: "49805421",
+              type: "string",
+            },
+            exclusive_fill: {
+              description: "boolean representing if you have exclusivity to fill this quote",
+              example: false,
+              type: "boolean",
+            },
+            network: {
+              description: "caip formated network id",
+              example: "eip155:1",
+              type: "string",
+            },
+            token: {
+              description: "token address (hex)",
+              example: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+              type: "string",
+              format: "hex",
+            },
+          },
+          required: ["amount", "exclusive_fill", "network", "token"],
+          type: "object",
+        },
+      },
+    },
+    description: "Borrow quote request payload",
     required: true,
-    "x-s2o-overloaded": true,
   }}
 ></RequestSchema>
 
@@ -98,7 +121,7 @@ See the [Request Final Borrow Quote example payload](/Stash/use-stash#3-request-
   label={undefined}
   responses={{
     "200": {
-      description: "Successfully retrieved borrow quote",
+      description: 'Successfully retrieved borrow quote".',
       content: {
         "application/json": {
           schema: {
@@ -107,10 +130,39 @@ See the [Request Final Borrow Quote example payload](/Stash/use-stash#3-request-
                 properties: {
                   borrowCost: { type: "string" },
                   duration: { type: "string" },
+                  liquidityPool: { type: "string" },
+                  repaymentChain: {
+                    enum: [1, 42161, 10, 137, 8453, 43114, 100, 8333, 11155111, 1993, 19934, 84532],
+                    format: "int32",
+                    type: "integer",
+                    "x-enum-varnames": [
+                      "Ethereum",
+                      "Arbitrum",
+                      "Optimism",
+                      "Polygon",
+                      "Base",
+                      "Avalanche",
+                      "Gnosis",
+                      "B3",
+                      "Sepolia",
+                      "B3Sepolia",
+                      "B4Sepolia",
+                      "BaseSepolia",
+                    ],
+                  },
+                  repaymentRecipient: { type: "string" },
                   requiredInput: { type: "string" },
                   requiredOutput: { type: "string" },
                 },
-                required: ["borrowCost", "duration", "requiredInput", "requiredOutput"],
+                required: [
+                  "borrowCost",
+                  "duration",
+                  "liquidityPool",
+                  "repaymentChain",
+                  "repaymentRecipient",
+                  "requiredInput",
+                  "requiredOutput",
+                ],
                 type: "object",
               },
             },
@@ -121,30 +173,30 @@ See the [Request Final Borrow Quote example payload](/Stash/use-stash#3-request-
       },
     },
     "400": {
-      description: "Bad request due to invalid input or missing parameters",
+      description: 'Bad request due to invalid input or missing parameters".',
       content: {
         "application/json": {
           schema: {
             properties: {
               debug: { type: "string" },
               error: { type: "string" },
             },
-            required: ["debug", "error"],
+            required: ["error"],
             type: "object",
           },
         },
       },
     },
     "500": {
-      description: "Internal server error",
+      description: 'Internal server error".',
       content: {
         "application/json": {
           schema: {
             properties: {
               debug: { type: "string" },
               error: { type: "string" },
             },
-            required: ["debug", "error"],
+            required: ["error"],
             type: "object",
           },
         },

docs/docusaurus.config.ts

@@ -136,6 +136,33 @@ const config: Config = {
       theme: prismThemes.github,
       darkTheme: prismThemes.dracula,
     },
+    languageTabs: [
+      {
+        language: "curl",
+        highlight: "bash",
+        logoClass: "curl",
+      },
+      {
+        language: "go",
+        highlight: "go",
+        logoClass: "go",
+      },
+      {
+        language: "javascript",
+        highlight: "javascript",
+        logoClass: "javascript",
+      },
+      {
+        language: "csharp",
+        highlight: "csharp",
+        logoClass: "csharp",
+      },
+      {
+        language: "java",
+        highlight: "java",
+        logoClass: "java",
+      },
+    ],
   } satisfies Preset.ThemeConfig,
   plugins: [
     [

…cost-for-a-liquidity-transaction.api.mdx …tion-for-a-liquidity-transaction.api.mdxdocs/src/api/generated/stash/get-the-borrow-cost-for-a-liquidity-transaction.api.mdx renamed to docs/src/api/generated/stash/get-signing-authorization-for-a-liquidity-transaction.api.mdx docs/src/api/generated/stash/get-the-borrow-cost-for-a-liquidity-transaction.api.mdx renamed to docs/src/api/generated/stash/get-signing-authorization-for-a-liquidity-transaction.api.mdx

@@ -1,11 +1,11 @@
 ---
-id: get-the-borrow-cost-for-a-liquidity-transaction
-title: "Get the borrow cost for a liquidity transaction"
-description: "Get the borrow cost for a liquidity transaction"
-sidebar_label: "Get the borrow cost for a liquidity transaction"
+id: get-signing-authorization-for-a-liquidity-transaction
+title: "Get signing authorization for a liquidity transaction"
+description: "This endpoint returns signed authorization for a liquidity transaction"
+sidebar_label: "Get signing authorization for a liquidity transaction"
 hide_title: true
 hide_table_of_contents: true
-api: eJzNVk2P2zgM/SsCTy2gGRdF9+Jbpyi6xRZoUcyeghwYm2OrK0saiZ4kMPzfC/pj4mS9s505LDaXyDJFPpJPj+6gpFREE9h4Bzl8IlZck9r5GP1eFT6xuvNRobLmvjWl4aPiiC5hMZzQEDBiQ0wxQb7pLtx9i5594S1oMPIckGvQ4LAheTq9jXTfmkgl5Bxb0pCKmhqEvAM+BrFNHI2roO/1ZYzbExxVY6oHvJJDScEnw+ux+fA7pvpZkbejMSW+8eVRLArvmBzLEkOwpkBBkf1IAqx7wlWvL5IwLrSsSmRUryJZPA7r1yv4Dlfprb/yDxStx3Le78UwBe8SJQn49s0b+TsP8vUP0L+O+fzszYIQiWNbcBtJ7Q3XCtXOVNefHatIIVIix1QqTGpKV0ujA0U2I7aRWx984pXSaHgk2jfv7aqF866g1TfJVA4F2SpzFrXcLFFcxpwjLP1t9ezP735QwdLEXsO7tTrfYKkmpqiyJcVeGfeA1pRq7LOPqjEpGVepxfV5Rm/OC1rSrq1W60Ex+vjvtRgdzOb/kOpva6l+dkzRoVWJ4gNFNXr4X2fSa2CsRK3gy9x2sRwv1h6jE8c5fA0UB9SqIs6zR4pks2xl3bzqs0lrsm7UlT6b+19jUk1r2QRL6iQfkq8GOjC5ZLwbtfMvOkJ+gUPDA9qW/gs8InANce1LyKEiHsSda8jhhcHkAg20GNNro4UcauaQ8izDYK5TiEYIdL1rjS1FTNKxavC68E02wBG+fD9p7scDNsEu2i/SfudnKcZCCCf9NTxYSfUoppGqwqLgEzc4UHCaA88feGcXYDEDXuBqIifTgbNg0TjBOJSpm0q/OUnTqKPzwMwX69Ogy8/GmrRgq6EelHYDXbfDRH9G2/eyfd9SPEK+2QrFosGdlEwmuEmyLiG/Q5voiYRffZ9u3mu1GPSrSU2b6I4LRoOeKP+YyzDdXxL/Fz4CXoBrqma/7TXUhCXFxT39MOK4uhUXp8N/kzvJaTzxvigo8JO2yyv46eMtaNhN3xqNL+VIxL10F/cjTj+UZdDOYa8Di65qsRLb0aX8fgImuHzF
+api: eJzNVk1v3DYQ/SsETwkgW0HQXnSL0yA1WiBB4J4WPsyKY4mpRNLDkXe3gv57MaTW+1HVjd0A7V6WkoYzb4Zv3nDUBmNNNrD1Tlf6prVRoTPBW8eKkAdyUUXbODQKBm492T9AjNWdJwWqs/eDNZZ3iglchDo5KnQAgh4ZKepqNZ5F+Uyefe07XWgrzwG41YV20KM8Hb4S3g+W0OiKacBCx7rFHnQ1at4FsY1M1jV6morzGDcHOKqF2Ca83KIyGHy0vBybtz9DbP9d5J8wsnW5SHUL1qkabFDWLIdMJs+KeJuNMfKVNzuxqL1jdCxLCKGzdYpefo0CaHzC1VScgbcuDKwMMKhXhB3s0vr1Ar7tRXzrL/wDUufB7N9PYhiDdxGjBHz75o38nQb59Isuvh3z6d4rT+Q3qvaRVWQaah4I1cZyq0CtbXN5nYgbCCM6FtZGNadbCLUCEtuMbZ1cvev9kGGcFaeYDd77uPz5kfufve8WLZx3NS5+kZYCgb5IqaNir05hnoA6h7APeOz+tti79+uvWLMc+lToH5bO5QqMmpmlzICKvbLuATprVOaFJ9XbGK1r1FGDP+MsTw/A4HpoFsuDRJ7+uTTZ7G9S/HEpxWvHSA46FZEekFT28L/MYCo0QyP6qX/dH7NY5sbbADlxWOlPASmrTYNclY+UKJOylGP6uzZTuRfWctyvpnJWw3LMyjeV+/NvIap+6NiGDtVBbiTvQuOW0UXrXVb333GnqzNchX6AbsD/Ap8IZI/ceqMr3SCnccStrvR3Ci4NluiT0x+o05VumUOsyhKCvYyBrBDtcj3Yzog4xV3Tw2Xt+zLBE159OWj4hy30oTuiiUyKO7+XdqiFmMIHy8lKqosUM6WFbcFH7iFRdR4rH5HT3JZefc7gPmmXo8ny/a4GM9MZt1yGTobfVOQajvM5rQ66Jq05D8hqPqus4/srQnW0Poz26mSQy5HdFrpNQr7S47iGiL9RN03y+n5A2ulqdSuUJQtrKbHcWWyUtdHVHXQRnyjNqy9zR79WR1ebxTznl+B2Rx2ii7mFHnNJt4qXxP+Ga88LcM3VfDGqp65EL4CTGTHdToVuEQzSkQq9z/EvbsTDYe9fRF1yyTve1TUGftL2WFA+frhJUzjfvHpvZAvBRrgGmwzTp3KkCZHejboD1wzQiG12Kb8/Ac2uDZw=
 sidebar_class_name: "get api-method"
 custom_edit_url: null
 ---
@@ -21,16 +21,18 @@ import Heading from "@theme/Heading";
 <Heading
   as={"h1"}
   className={"openapi__heading"}
-  children={"Get the borrow cost for a liquidity transaction"}
+  children={"Get signing authorization for a liquidity transaction"}
 ></Heading>
 
 <MethodEndpoint
   method={"get"}
-  path={"/liquidity/protocol/{protocol}/deposit/{txHash}/request"}
+  path={
+    "/liquidity/chain/{chainId}/protocol/{protocol}/deposit/{txHash}/request"
+  }
   context={"endpoint"}
 ></MethodEndpoint>
 
-Get the borrow cost for a liquidity transaction
+This endpoint returns signed authorization for a liquidity transaction
 
 <Heading
   id={"request"}
@@ -55,6 +57,13 @@ Get the borrow cost for a liquidity transaction
       required: true,
       schema: { type: "string" },
     },
+    {
+      description: "Destination chain caip id",
+      in: "path",
+      name: "chain",
+      required: true,
+      schema: { type: "string" },
+    },
   ]}
 ></ParamsDetails>
 
@@ -80,12 +89,19 @@ Get the borrow cost for a liquidity transaction
             description:
               "Borrow cost structure with a big.Int represented as string",
             properties: {
+              borrowAmount: { type: "string" },
               borrowCost: { type: "string" },
               liquidityPool: { type: "string" },
               nonce: { type: "string" },
               signature: { type: "string" },
             },
-            required: ["borrowCost", "liquidityPool", "nonce", "signature"],
+            required: [
+              "borrowAmount",
+              "borrowCost",
+              "liquidityPool",
+              "nonce",
+              "signature",
+            ],
             type: "object",
           },
         },
@@ -100,7 +116,7 @@ Get the borrow cost for a liquidity transaction
               debug: { type: "string" },
               error: { type: "string" },
             },
-            required: ["debug", "error"],
+            required: ["error"],
             type: "object",
           },
         },
@@ -115,7 +131,7 @@ Get the borrow cost for a liquidity transaction
               debug: { type: "string" },
               error: { type: "string" },
             },
-            required: ["debug", "error"],
+            required: ["error"],
             type: "object",
           },
         },