oasParamDescriptions


oasParamDescriptions Checks parameter descriptions have been set.

This function checks both OpenAPI 2 and 3+ specs.

Example ruleset configuration

oas3-parameter-descriptions:
  description: "Parameters should always include descriptions"
  type: "validation"
  recommended: true
  severity: "warn"
  given: "$"
  then:
    function: "oasParamDescriptions"

The function is used by the oas2-parameter-description and the oas3-parameter-description Rules


View Function Source