vacuum API Linter: AsyncAPI Default Rules

asyncapi-recommended is the default ruleset when vacuum lint detects an AsyncAPI 3 document.

vacuum lint events.asyncapi.yaml

To explicitly extend it from your own ruleset, use vacuum:asyncapi.

extends: [[vacuum:asyncapi, recommended]]

Rules

Rule	Severity	Function
asyncapi-3-document-resolved	error	`asyncApiDocument`
asyncapi-3-document-unresolved	error	`asyncApiDocument`
asyncapi-latest-version	info	`schema`
asyncapi-3-channel-no-empty-parameter	error	`pattern`
asyncapi-3-channel-no-query-nor-fragment	error	`pattern`
asyncapi-3-channel-no-trailing-slash	error	`pattern`
asyncapi-channel-parameters	error	`asyncApiChannelParameters`
asyncapi-3-channel-servers	error	`asyncApiChannelServers`
asyncapi-servers	error	`schema`
asyncapi-3-server-no-empty-variable	error	`pattern`
asyncapi-3-server-no-trailing-slash	error	`pattern`
asyncapi-server-variables	error	`asyncApiServerVariables`
asyncapi-3-operation-description	error	`truthy`
asyncapi-operation-channel	error	`asyncApiOperationChannel`
asyncapi-operation-messages	error	`asyncApiOperationMessages`
asyncapi-operation-reply	error	`asyncApiOperationReply`
asyncapi-3-headers-schema-type-object	error	`schema`
asyncapi-3-payload-unsupported-schemaFormat	info	`undefined`
asyncapi-content-type	warn	`asyncApiContentType`
asyncapi-info-contact	error	`truthy`
asyncapi-info-contact-properties	error	`truthy`
asyncapi-info-description	error	`truthy`
asyncapi-info-license	error	`truthy`
asyncapi-parameter-description	warn	`truthy`
asyncapi-message-examples	warn	`asyncApiMessageExamples`
asyncapi-3-operation-security	error	`asyncApiSecurity`
asyncapi-server-security	error	`asyncApiSecurity`
asyncapi-unused-components	warn	`asyncApiUnusedComponents`
asyncapi-3-tags	error	`truthy`
asyncapi-3-tags-uniqueness	error	`asyncApiTagsUnique`

extends: [[vacuum:asyncapi, recommended]]
rules:
  asyncapi-message-examples:
    severity: error

Run it with the normal --ruleset flag.

vacuum lint events.asyncapi.yaml --ruleset asyncapi-rules.yaml