@ibm-cloud/openapi-ruleset/src/functions/ref-sibling-duplicate-description.js

Spectral ruleset for validating IBM Cloud services

/**
 * Copyright 2017 - 2023 IBM Corporation.
 * SPDX-License-Identifier: Apache2.0
 */

const { validateSubschemas } = require('@ibm-cloud/openapi-ruleset-utilities');
const { LoggerFactory } = require('../utils');

let ruleId;
let logger;

module.exports = function (schema, _opts, context) {
  if (!logger) {
    ruleId = context.rule.name;
    logger = LoggerFactory.getInstance().getLogger(ruleId);
  }

  return validateSubschemas(schema, context.path, checkDuplicateDescription);
};

function checkDuplicateDescription(schema, path) {
  // We're only interested in a schema or schema property that has an allOf list.
  if (!Array.isArray(schema.allOf) || !schema.allOf.length) {
    return [];
  }

  // Get the description from the first allOf entry.
  // This is the first description to be used in the comparison.
  const description1 = cleanString(schema.allOf[0].description);
  if (!description1) {
    return [];
  }

  logger.debug(
    `${ruleId}: checking descriptions at location: ${path.join('.')}.allOf`
  );

  // Next, if 'schema' itself has a description, then we'll use that
  // as the second description in the comparison.
  let description2 = cleanString(schema.description);

  // If 'schema' has no description, then we'll walk the rest of the allOf entries
  // and use the last description that we find.
  if (!description2) {
    for (let i = 1; i < schema.allOf.length; i++) {
      const desc = cleanString(schema.allOf[i].description);
      if (desc) {
        description2 = desc;
      }
    }
  }

  if (!description2) {
    logger.debug(`${ruleId}: second description not present`);
    return [];
  }

  // We have non-empty descriptions to compare...
  if (description1 === description2) {
    logger.debug(`${ruleId}: found a duplicate!`);
    return [
      {
        message: 'Duplicate ref-sibling description is unnecessary',
        path,
      },
    ];
  }

  return [];
}

function cleanString(s) {
  return s ? s.toString().trim() : undefined;
}