Merge pull request #916 from 0xProject/feature/sra/add-sra-package

Add the sra-api package (OpenAPI Spec)

1 files changed, 36 insertions, 0 deletions

diff --git a/packages/sra-api/src/parameters.ts b/packages/sra-api/src/parameters.ts
new file mode 100644
index 000000000..7d63a0a18
--- /dev/null
+++ b/packages/sra-api/src/parameters.ts
@@ -0,0 +1,36 @@
+import { ParameterObject } from '@loopback/openapi-v3-types';
+export const paginationParameters: ParameterObject[] = [
+    {
+        name: 'page',
+        in: 'query',
+        description: 'The number of the page to request in the collection.',
+        example: 3,
+        schema: {
+            type: 'number',
+        },
+    },
+    {
+        name: 'per_page',
+        in: 'query',
+        description: 'The number of records to return per page.',
+        example: 10,
+        schema: {
+            type: 'number',
+        },
+    },
+];
+
+export const networkdIdParameter: ParameterObject = {
+    name: 'network_id',
+    in: 'query',
+    description: 'The id of the Ethereum network',
+    example: 42,
+    schema: {
+        type: 'number',
+    },
+};
+
+export const generateParameters = (parameters: ParameterObject[], isPaginated: boolean = false): ParameterObject[] => {
+    const optionalParameters = isPaginated ? paginationParameters : [];
+    return [networkdIdParameter, ...optionalParameters, ...parameters];
+};