Define & Validate APIsValidation RulesetsAPIMatic Rulesets
APIMatic Rulesets Overview
The rulesets APIMatic uses to validate and lint every API definition, whatever its format.
The rulesets below apply to every API definition, whatever its format. Input File Validation and Metadata File Validation check the files you provide. Most of the others check your definition after APIMatic imports it, and include checks a format's standard may not enforce itself but that APIMatic needs to produce good SDKs, portals, and transformations.
Validation rulesets
These rulesets make sure your API definition conforms to its format and is technically correct.
| Ruleset | Code prefix | Rules |
|---|---|---|
| Input File Validation | INPUTFILE_V | 10 |
| Metadata File Validation | METADATA_V | 7 |
| APIMatic Preliminary Validation | APIMATICPRE_V | 102 |
| APIMatic Syntax Validation | APIMATICSYNTAX_V | 1 |
| APIMatic Process Validation | APIMATICPROCESS_V | 4 |
| APIMatic Validation for Code Generation | APIMATICCODEGEN_V | 110 |
| APIMatic Post-Processing Validation | APIMATICPOSTPROCESS_V | 47 |
| APIMatic Post-Processing Validation For Code Generation | APIMATICPOSTPROCESSCODEGEN_V | 9 |
Linting rulesets
These rulesets are style checks and recommendations. Breaking one of their rules doesn't mean your definition violates its format's standard, but it can lower the quality of what APIMatic generates from it.
| Ruleset | Code prefix | Rules |
|---|---|---|
| APIMatic Preliminary Linting | APIMATICPRE_L | 24 |
| APIMatic Linting for Portal Generation | APIMATICDOCS_L | 13 |