spectral:asyncapi warn off by default

asyncapi-parameter-description

Parameter objects must have "description".

Applies to
description
Selects
$.components.parameters.*
$.channels.*.parameters.*
Function
truthy
Specs
AsyncAPI 2.xAsyncAPI 3.x

Use it

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

extends: spectral:asyncapi
rules:
  asyncapi-parameter-description: true

Definition

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

asyncapi-parameter-description:
  description: Parameter objects must have "description".
  recommended: false
  formats:
    - AsyncAPI 2.x
    - AsyncAPI 3.x
  given:
    - $.components.parameters.*
    - $.channels.*.parameters.*
  then:
    field: description
    function: truthy

About this rule

Parameter objects should have a description.

Sources