spectral:asyncapi error on by default

asyncapi-headers-schema-type-object

Headers schema type must be "object".

Applies to
headers
Selects
$.components.messageTraits.*.headers
$.components.messages.*.headers
$.channels.*.[publish,subscribe].message.headers
$.channels.*.[publish,subscribe].message.traits[*].headers
Function
schema
Specs
AsyncAPI 2.x
Message
Headers schema type must be "object" ({{error}}).

Use it

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

extends: spectral:asyncapi
rules:
  asyncapi-headers-schema-type-object: error   # or off, or another severity

Definition

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

asyncapi-headers-schema-type-object:
  description: Headers schema type must be "object".
  message: 'Headers schema type must be "object" ({{error}}).'
  severity: error
  recommended: true
  formats:
    - AsyncAPI 2.x
  given:
    - $.components.messageTraits.*.headers
    - $.components.messages.*.headers
    - '$.channels.*.[publish,subscribe].message.headers'
    - '$.channels.*.[publish,subscribe].message.traits[*].headers'
  then:
    function: schema
    functionOptions:
      allErrors: true
      schema:
        type: object
        properties:
          type:
            enum:
              - object
        required:
          - type

About this rule

The schema definition of the application headers must be of type “object”.

Sources