asyncApi2ChannelParameters.ts

import { createRulesetFunction } from '@stoplight/spectral-core';
import { parseUrlVariables, getMissingProps, getRedundantProps } from './utils';

import type { IFunctionResult } from '@stoplight/spectral-core';

export default createRulesetFunction<{ parameters: Record<string, unknown> }, null>(
  {
    input: null,
    options: null,
  },
  function asyncApi2ChannelParameters(targetVal, _, ctx) {
    const path = ctx.path[ctx.path.length - 1] as string;
    const results: IFunctionResult[] = [];

    let parameters = parseUrlVariables(path);
    if (!parameters || parameters.length === 0) return;

    const missingParameters = getMissingProps(parameters, targetVal.parameters);
    if (missingParameters.length) {
      results.push({
        message: `Not all channel's parameters are described with "parameters" object. Missed: ${missingParameters.join(', ')}.`,
        path: [...ctx.path, 'parameters'],
      });
    }

    const redundantParameters = getRedundantProps(parameters, targetVal.parameters);
    if (redundantParameters.length) {
      redundantParameters.forEach(param => {
        results.push({
          message: `Channel's "parameters" object has redundant defined "${param}" parameter.`,
          path: [...ctx.path, 'parameters', param],
        });
      });
    }

    return results;
  },
);