Minor refactoring

packages/sra-api/src/api.ts

@@ -50,7 +50,8 @@ export const api: OpenApiSpec = {
                 ),
                 responses: generateResponses(
                     'relayerApiAssetDataPairsResponseSchema',
-                    examples.relayerApiAssetDataPairsResponseSchema,
+                    examples.relayerApiAssetDataPairsResponse,
+                    `Returns a collection of available asset pairs with some meta info`,
                 ),
             },
         },

packages/sra-api/src/examples/index.ts

@@ -1,7 +1,7 @@
 import { validationError } from './errors';
-import { relayerApiAssetDataPairsResponseSchema } from './relayerApiAssetDataPairsResponseSchema';
+import { relayerApiAssetDataPairsResponse } from './relayerApiAssetDataPairsResponse';
 
 export const examples = {
     validationError,
-    relayerApiAssetDataPairsResponseSchema,
+    relayerApiAssetDataPairsResponse,
 };

packages/sra-api/src/examples/relayerApiAssetDataPairsResponseSchema.ts

@@ -1,21 +0,0 @@
-export const relayerApiAssetDataPairsResponseSchema = {
-    total: 43,
-    page: 1,
-    perPage: 100,
-    records: [
-        {
-            assetDataA: {
-                minAmount: '0',
-                maxAmount: '10000000000000000000',
-                precision: 5,
-                assetData: '0xf47261b04c32345ced77393b3530b1eed0f346429d',
-            },
-            assetDataB: {
-                minAmount: '0',
-                maxAmount: '50000000000000000000',
-                precision: 5,
-                assetData: '0x0257179264389b814a946f3e92105513705ca6b990',
-            },
-        },
-    ],
-};

packages/sra-api/src/responses.ts

@@ -3,13 +3,14 @@ import { ResponsesObject } from '@loopback/openapi-v3-types';
 import { errorResponses } from './errors';
 import { headers } from './headers';
 
-export const generateResponses = (schemaName: string, example: any): ResponsesObject => ({
+export const generateResponses = (schemaName: string, example: any, description: string = 'OK'): ResponsesObject => ({
     '200': {
         headers,
-        description: 'OK',
+        description,
         content: {
             'application/json': {
                 schema: { $ref: `#/components/schemas/${schemaName}` },
+                example,
             },
         },
     },