@ibm-cloud/openapi-ruleset/src/rules/optional-request-body.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 { optionalRequestBody } = require('../functions');

module.exports = {
  description:
    'An optional requestBody with required properties should probably be required',
  message: '{{description}}',
  given:
    "$.paths[*][*][?(@property === 'requestBody' && @.required !== true)].content[*].schema",
  severity: 'info',
  formats: [oas3],
  resolved: true,
  then: {
    function: optionalRequestBody,
  },
};