From 5a66fec57640329331a6782c97a281955e85d73d Mon Sep 17 00:00:00 2001 From: Anxo Rodriguez Date: Thu, 22 Aug 2024 17:58:02 +0100 Subject: [PATCH 1/5] Hide volatility endpoint --- .../slippageTolerance.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts b/apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts index 12073eb..e83e3ea 100644 --- a/apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts +++ b/apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts @@ -81,6 +81,8 @@ const root: FastifyPluginAsync = async (fastify): Promise => { '/slippageTolerance', { schema: { + description: 'Retrieve a default slippage tolerance for a given market', + tags: ['markets'], params: routeSchema, response: { '2XX': successSchema, @@ -117,6 +119,7 @@ const root: FastifyPluginAsync = async (fastify): Promise => { '/volatilityDetails', { schema: { + hide: true, params: routeSchema, querystring: queryStringSchema, }, From 26ea567e7cf5a13aafea025bf33e0c6302c84f9e Mon Sep 17 00:00:00 2001 From: Anxo Rodriguez Date: Thu, 22 Aug 2024 17:58:18 +0100 Subject: [PATCH 2/5] Add tags and descriptions to the endpoints --- .../routes/__chainId/tokens/__tokenAddress/usdPrice.ts | 2 ++ apps/api/src/app/routes/about.ts | 6 ++++++ .../api/src/app/routes/accounts/_account/notifications.ts | 8 +++++++- 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/apps/api/src/app/routes/__chainId/tokens/__tokenAddress/usdPrice.ts b/apps/api/src/app/routes/__chainId/tokens/__tokenAddress/usdPrice.ts index bfc2610..2aa1d8b 100644 --- a/apps/api/src/app/routes/__chainId/tokens/__tokenAddress/usdPrice.ts +++ b/apps/api/src/app/routes/__chainId/tokens/__tokenAddress/usdPrice.ts @@ -69,6 +69,8 @@ const root: FastifyPluginAsync = async (fastify): Promise => { '/usdPrice', { schema: { + description: 'Get USD price for a given token', + tags: ['tokens'], params: paramsSchema, response: { '2XX': successSchema, diff --git a/apps/api/src/app/routes/about.ts b/apps/api/src/app/routes/about.ts index b991790..48a84ca 100644 --- a/apps/api/src/app/routes/about.ts +++ b/apps/api/src/app/routes/about.ts @@ -25,6 +25,12 @@ interface AboutResponse { const about: FastifyPluginAsync = async (fastify): Promise => { fastify.get<{ Reply: AboutResponse }>( '/about', + { + schema: { + description: 'About the BFF API', + tags: ['misc'], + }, + }, async function (_request, reply) { reply.header( CACHE_CONTROL_HEADER, diff --git a/apps/api/src/app/routes/accounts/_account/notifications.ts b/apps/api/src/app/routes/accounts/_account/notifications.ts index 44cc7a5..b4fc070 100644 --- a/apps/api/src/app/routes/accounts/_account/notifications.ts +++ b/apps/api/src/app/routes/accounts/_account/notifications.ts @@ -37,7 +37,13 @@ const accounts: FastifyPluginAsync = async (fastify): Promise => { Reply: NotificationModel[]; }>( '/notifications', - { schema: { params: routeSchema } }, + { + schema: { + description: 'Get notifications for an account', + tags: ['accounts'], + params: routeSchema, + }, + }, async function (request, reply) { reply.header( CACHE_CONTROL_HEADER, From 8f95ef3036608bef6924f35b97fa13ca16f7f9ca Mon Sep 17 00:00:00 2001 From: Anxo Rodriguez Date: Thu, 22 Aug 2024 17:58:27 +0100 Subject: [PATCH 3/5] Delete deprecated endpoint --- .../slippageTolerance.ts | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 apps/api/src/app/routes/chains/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts diff --git a/apps/api/src/app/routes/chains/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts b/apps/api/src/app/routes/chains/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts deleted file mode 100644 index 9e7e3fa..0000000 --- a/apps/api/src/app/routes/chains/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts +++ /dev/null @@ -1,3 +0,0 @@ -import root from '../../../../__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance'; - -export default root; From da28a6d2949c3d7ce3c043249c0c5b7c166fd2a6 Mon Sep 17 00:00:00 2001 From: Anxo Rodriguez Date: Thu, 22 Aug 2024 18:03:35 +0100 Subject: [PATCH 4/5] Delete chains from base url --- apps/api/scripts/test-slippage.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/api/scripts/test-slippage.js b/apps/api/scripts/test-slippage.js index 15377f5..0b51829 100644 --- a/apps/api/scripts/test-slippage.js +++ b/apps/api/scripts/test-slippage.js @@ -1,6 +1,6 @@ const fs = require('fs'); -const BASE_URL = 'http://localhost:3010/chains'; +const BASE_URL = 'http://localhost:3010'; const NetworkToChainId = { Mainnet: 1, From 31c291679bcf61e39f04d2877f39fb912be1e0b7 Mon Sep 17 00:00:00 2001 From: Anxo Rodriguez Date: Tue, 25 Feb 2025 21:44:04 +0000 Subject: [PATCH 5/5] chore: improve description Co-authored-by: Leandro --- .../__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts b/apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts index e83e3ea..938a2bf 100644 --- a/apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts +++ b/apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts @@ -81,7 +81,7 @@ const root: FastifyPluginAsync = async (fastify): Promise => { '/slippageTolerance', { schema: { - description: 'Retrieve a default slippage tolerance for a given market', + description: 'Retrieve a proposed slippage tolerance for a given market', tags: ['markets'], params: routeSchema, response: {