Improve swagger and hide some endpoints

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,

apps/api/src/app/routes/__chainId/markets/__baseTokenAddress-__quoteTokenAddress/slippageTolerance.ts

@@ -81,6 +81,8 @@ const root: FastifyPluginAsync = async (fastify): Promise<void> => {
     '/slippageTolerance',
     {
       schema: {
+        description: 'Retrieve a proposed slippage tolerance for a given market',
+        tags: ['markets'],
         params: routeSchema,
         response: {
           '2XX': successSchema,
@@ -117,6 +119,7 @@ const root: FastifyPluginAsync = async (fastify): Promise<void> => {
     '/volatilityDetails',
     {
       schema: {
+        hide: true,
         params: routeSchema,
         querystring: queryStringSchema,
       },

apps/api/src/app/routes/__chainId/tokens/__tokenAddress/usdPrice.ts

@@ -57,6 +57,8 @@ const root: FastifyPluginAsync = async (fastify): Promise<void> => {
     '/usdPrice',
     {
       schema: {
+        description: 'Get USD price for a given token',
+        tags: ['tokens'],
         params: paramsSchema,
         response: {
           '2XX': successSchema,

apps/api/src/app/routes/about.ts

@@ -25,6 +25,12 @@ interface AboutResponse {
 const about: FastifyPluginAsync = async (fastify): Promise<void> => {
   fastify.get<{ Reply: AboutResponse }>(
     '/about',
+    {
+      schema: {
+        description: 'About the BFF API',
+        tags: ['misc'],
+      },
+    },
     async function (_request, reply) {
       reply.header(
         CACHE_CONTROL_HEADER,

apps/api/src/app/routes/accounts/_account/notifications.ts

@@ -37,7 +37,13 @@ const accounts: FastifyPluginAsync = async (fastify): Promise<void> => {
     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,