spectral:asyncapi warn on by default

asyncapi-operation-description

Operation "description" must be present and non-empty string.

Applies to
description
Selects
$.channels[*][publish,subscribe]
Function
truthy
Specs
AsyncAPI 2.x

Use it

This rule ships with OpenLint in spectral:asyncapi. Extending the ruleset turns it on:

extends: spectral:asyncapi
rules:
  asyncapi-operation-description: warn   # or off, or another severity

Definition

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

asyncapi-operation-description:
  description: Operation "description" must be present and non-empty string.
  recommended: true
  formats:
    - AsyncAPI 2.x
  given: '$.channels[*][publish,subscribe]'
  then:
    field: description
    function: truthy

About this rule

Operation objects should have a description.

Sources