path: root/packages/sra-spec/src/parameters.ts

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',
            default: 1,
        },
    },
    {
        name: 'perPage',
        in: 'query',
        description: 'The number of records to return per page.',
        example: 10,
        schema: {
            type: 'number',
            default: 100,
        },
    },
];

export const networkdIdParameter: ParameterObject = {
    name: 'networkId',
    in: 'query',
    description: 'The id of the Ethereum network',
    example: 42,
    schema: {
        type: 'number',
        default: 1,
    },
};

export const generateParameters = (parameters: ParameterObject[], isPaginated: boolean = false): ParameterObject[] => {
    const optionalParameters = isPaginated ? paginationParameters : [];
    return [...parameters, networkdIdParameter, ...optionalParameters];
};