@ibm-cloud/openapi-ruleset/src/rules/collection-array-property.js

Spectral ruleset for validating IBM Cloud services

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

const { oas3 } = require('@stoplight/spectral-formats');
const { collectionArrayProperty } = require('../functions');

module.exports = {
  description:
    'Collection list operation response schema should define array property whose name matches the final path segment of the operation path',
  message: '{{error}}',
  given:
    '$.paths[*].get.responses[?(@property.match(/2\\d\\d/))].content[*].schema',
  severity: 'warn',
  formats: [oas3],
  resolved: true,
  then: {
    function: collectionArrayProperty,
  },
};