spectral:asyncapi warn on by default

asyncapi-info-description

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

Applies to
description
Selects
$
Function
truthy
Specs
AsyncAPI 2.xAsyncAPI 3.x

Use it

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

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

Definition

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

asyncapi-info-description:
  description: Info "description" must be present and non-empty string.
  recommended: true
  formats:
    - AsyncAPI 2.x
    - AsyncAPI 3.x
  given: $
  then:
    field: info.description
    function: truthy

About this rule

AsyncAPI object info description must be present and non-empty string.

Examples can contain Markdown so you can really go to town with them, implementing getting started information like where to find authentication keys, and how to use them.

Good Example

asyncapi: "2.0.0"
info:
  version: "1.0.0"
  title: Descriptive API
  description: >+
    Some description about the general point of this API, and why it exists when another similar but different API also exists.

Sources