From fc48390aa1139fe6ba1a6580a9b6bd1bcf7b5d0d Mon Sep 17 00:00:00 2001
From: Moses <103143573+Defi-Moses@users.noreply.github.com>
Date: Tue, 19 Nov 2024 17:02:50 +0000
Subject: [PATCH] Fixing REST API docs to include route changes (#3401)

* fixing docs to reflect changes to endpoint and add more clarity

* language changes
---
 docs/bridge/docs/02-Bridge/02-REST-API.md         | 12 +++++++++++-
 packages/rest-api/src/routes/bridgeTxInfoRoute.ts |  4 ++--
 packages/rest-api/src/routes/swapTxInfoRoute.ts   |  4 ++--
 packages/rest-api/swagger.json                    |  8 ++++----
 4 files changed, 19 insertions(+), 9 deletions(-)

diff --git a/docs/bridge/docs/02-Bridge/02-REST-API.md b/docs/bridge/docs/02-Bridge/02-REST-API.md
index 647d02d595..fc9ffbe3ce 100644
--- a/docs/bridge/docs/02-Bridge/02-REST-API.md
+++ b/docs/bridge/docs/02-Bridge/02-REST-API.md
@@ -4,7 +4,16 @@ title: REST API
 
 # REST API
 
-Get read-only data from on-chain Synapse contracts, and generate Bridge and Swap quotes, plus additional transaction information.
+The Synapse REST API is a read-only API that allows you to integrate the Synapse liquidity network into your application.
+
+Through HTTP requests, developers can integrate Synapse cross-chain tokens and liquidity transfers dynamically into their applications. Developers can retrieve quotes, as well as generate the relevant call data for Synapse Bridges and Swaps.  Example requests can be found below in the [API-docs](#api-docs) section.
+
+
+The Synapse REST API is built on top of the [Synapse Bridge SDK](https://docs.synapseprotocol.com/docs/Bridge/SDK).
+
+
+The API is available at [`https://api.synapseprotocol.com/`](https://api.synapseprotocol.com/).
+
 
 ## API-docs
 
@@ -17,6 +26,7 @@ Get read-only data from on-chain Synapse contracts, and generate Bridge and Swap
 | Date                   | Description                                                                                                                                                        |
 | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | 2024&#8209;10&#8209;01 | [https://synapse-rest-api-v2.herokuapp.com/](https://synapse-rest-api-v2.herokuapp.com/) is no longer maintained and has been fully deprecated as of October 2024. |
+| 2024&#8209;11&#8209;19 | [https://api.synapseprotocol.com/](https://api.synapseprotocol.com/) the /bridgeTxInfo endpoint has been consolidated into the /bridge endpoint, which now returns call data                   |
 
 ## Support
 
diff --git a/packages/rest-api/src/routes/bridgeTxInfoRoute.ts b/packages/rest-api/src/routes/bridgeTxInfoRoute.ts
index 357c08fe65..10e74c4e50 100644
--- a/packages/rest-api/src/routes/bridgeTxInfoRoute.ts
+++ b/packages/rest-api/src/routes/bridgeTxInfoRoute.ts
@@ -19,8 +19,8 @@ const router: express.Router = express.Router()
  * @openapi
  * /bridgeTxInfo:
  *   get:
- *     summary: Get bridge transaction information
- *     description: Retrieve transaction information for bridging tokens between chains
+ *     summary: "[Deprecated] in favor of using the /bridge endpoint, which now returns call data"
+ *     description: "[Deprecated] Originally used to get Bridge transaction information"
  *     parameters:
  *       - in: query
  *         name: fromChain
diff --git a/packages/rest-api/src/routes/swapTxInfoRoute.ts b/packages/rest-api/src/routes/swapTxInfoRoute.ts
index 041fc29ac3..218b9a130b 100644
--- a/packages/rest-api/src/routes/swapTxInfoRoute.ts
+++ b/packages/rest-api/src/routes/swapTxInfoRoute.ts
@@ -18,8 +18,8 @@ const router: express.Router = express.Router()
  * @openapi
  * /swapTxInfo:
  *   get:
- *     summary: Get swap transaction information
- *     description: Retrieve transaction information for swapping tokens on a specific chain
+ *     summary: "[Deprecated] in favor of using the /swap endpoint, which now returns call data
+ *     description: "[Deprecated] Originally used to get Swap transaction information
  *     parameters:
  *       - in: query
  *         name: chain
diff --git a/packages/rest-api/swagger.json b/packages/rest-api/swagger.json
index 7190b10524..d5316d26dd 100644
--- a/packages/rest-api/swagger.json
+++ b/packages/rest-api/swagger.json
@@ -396,8 +396,8 @@
     },
     "/bridgeTxInfo": {
       "get": {
-        "summary": "Get bridge transaction information",
-        "description": "Retrieve transaction information for bridging tokens between chains",
+        "summary": "[Deprecated] in favor of using the /bridge endpoint, which now returns call data",
+        "description": "[Deprecated] Originally used to get Bridge transaction information",
         "parameters": [
           {
             "in": "query",
@@ -1345,8 +1345,8 @@
     },
     "/swapTxInfo": {
       "get": {
-        "summary": "Get swap transaction information",
-        "description": "Retrieve transaction information for swapping tokens on a specific chain",
+        "summary": "[Deprecated] in favor of using the /swap endpoint, which now returns call data",
+        "description": "[Deprecated] Originally used to get Swap transaction information",
         "parameters": [
           {
             "in": "query",