info-defined

Since 0.9.0 · In the rulesets: Recommended at error, Strict at error, All at error

This rule checks whether the info object of an AsyncAPI document provides a description and a version.

Rule details

The info object is the first thing readers of an API see. Besides the mandatory title, it should explain what the application does and which version of the API is being described.

The info-defined rule reports:

  • Info description is missing or empty when info.description is missing or empty,
  • Info version is empty when info.version is an empty string.

The title is required by the AsyncAPI specification itself and is not checked by this rule.

Examples

Good.

asyncapi: 3.0.0
info:
  title: Pet Events
  version: 1.0.0
  description: Events published when pets are adopted, returned or updated.

Bad. The document does not explain what the application does, and its version is empty.

asyncapi: 3.0.0
info:
  title: Pet Events
  version: ""

Turn it off or change its severity

In apigenie.yaml, off turns the rule off and warning or error sets its severity; a rule with options takes the severity and the options as a pair, [warning, options]. lint.asyncapi has the details.

commands:
  lint:
    asyncapi:
      rules:
        info-defined: off

Related rules

Last updated on View as Markdown
Was this helpful?