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

Spectral ruleset for validating IBM Cloud services

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

const {
  schemas,
} = require('@ibm-cloud/openapi-ruleset-utilities/src/collections');
const { oas3 } = require('@stoplight/spectral-formats');
const { refSiblingDuplicateDescription } = require('../functions');

module.exports = {
  description:
    'Schemas and schema properties should avoid duplicate descriptions within allOf $ref siblings',
  message: '{{error}}',
  given: schemas,
  severity: 'warn',
  formats: [oas3],
  resolved: true,
  then: {
    function: refSiblingDuplicateDescription,
  },
};