Rulesets Overview

Every check APIMatic runs on your API definition is a rule, and rules are grouped into rulesets. When you validate a definition with the APIMatic CLI, the APIMatic for VS Code extension, or the APIMatic OpenAPI Linter, APIMatic runs the APIMatic rulesets plus the rulesets for your definition's format.

How to read a rule codeCopy Anchor Link

Each message reports a rule code, such as OPENAPI3DOCSGEN_L050. The code tells you where to look:

• The prefix, including its V or L (OPENAPI3DOCSGEN_L), identifies the ruleset. V marks a validation ruleset and L a linting ruleset.
• The number identifies the rule within the ruleset. Rules in the same category share a number range.

Messages are reported at one of four severity levels: Blocking, Error, Warning, or Information. Rules marked (disabled) are turned off by default, so they don't report issues.

Rulesets by formatCopy Anchor Link