Rulesets Overview

Every check APIMatic runs on your API definition is a rule, and rules are grouped into rulesets. When you validate a definition, format rulesets, such as the OpenAPI rulesets, check it as you wrote it. Most APIMatic rulesets check it after APIMatic imports it, so they apply whatever its format. To skip rulesets or rules, or change their severity, see Configure Validation.

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 unless you turn them on.

Rulesets by formatCopy Anchor Link