swagger-diff/src/rules/break/edit-param-collection-format.js

Swagger Diff

/* eslint max-len: 0 */

export default function editParamCollectionFormat({ kind, path, lhs, rhs }) {
  const match = (kind === 'N' || kind === 'E')
              && path.length === 6
              && path[0] === 'paths'
              && path[3] === 'parameters'
              && path[5] === 'collectionFormat';
  if (match) {
    const pathId = path[1];
    const method = path[2];
    const paramName = path[4];
    return {
      message: `${pathId} (${method}) - Param ${paramName} collection format turn from ${lhs || '(none)'} to ${rhs || '(none)'}`,
      path: pathId,
      method,
      param: paramName,
      previousFormat: lhs,
      currentFormat: rhs,
    };
  }
  return false;
}