spectral:asyncapi error on by default

asyncapi-3-document-resolved

Checking if the AsyncAPI v3 document has valid structure after resolving references.

Applies to

document

Selects

$

Function

function

Specs

AsyncAPI 3.x

Message

{{error}}

Use it

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

extends: spectral:asyncapi
rules:
  asyncapi-3-document-resolved: error   # or off, or another severity

Definition

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

asyncapi-3-document-resolved:
  description: >-
    Checking if the AsyncAPI v3 document has valid structure after resolving
    references.
  message: '{{error}}'
  severity: error
  recommended: true
  formats:
    - AsyncAPI 3.x
  given: $
  then:
    function: function
    functionOptions:
      resolved: true

About this rule

Sources

• Reference
• Source