spectral:oas warn off by default

oas3-parameter-description

Parameter objects must have "description".

Applies to
description
Selects
#PathItem.parameters[?(@ && @.in)]
#OperationObject.parameters[?(@ && @.in)]
$.components.parameters[?(@ && @.in)]
Function
truthy
Specs
OpenAPI 3.0OpenAPI 3.1OpenAPI 3.2

Use it

This rule ships with OpenLint in spectral:oas. It's off by default, so turn it on by name:

extends: spectral:oas
rules:
  oas3-parameter-description: true

Definition

As defined in @openlint/openlint-rulesets. Functions show by name.

oas3-parameter-description:
  description: Parameter objects must have "description".
  recommended: false
  formats:
    - OpenAPI 3.x
  given:
    - '#PathItem.parameters[?(@ && @.in)]'
    - '#OperationObject.parameters[?(@ && @.in)]'
    - '$.components.parameters[?(@ && @.in)]'
  then:
    field: description
    function: truthy

About this rule

Parameter objects should have a description.

Sources