@ibm-cloud/openapi-ruleset/src/functions/response-example-exists.js

Spectral ruleset for validating IBM Cloud services

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

module.exports = function (response) {
  if (!responseLevelExamples(response) && !schemaLevelExample(response)) {
    return [
      {
        message: 'Response bodies should include an example response',
      },
    ];
  }
};

function responseLevelExamples(response) {
  return response.example || response.examples;
}

function schemaLevelExample(response) {
  return response.schema && response.schema.example;
}