Define & Validate APIsValidation RulesetsAPIMatic Rulesets
APIMatic Syntax Validation
Syntax checks on the intermediate format APIMatic derives from your API definition.
| Property | Value |
|---|---|
| Ruleset ID | apimatic-syntax-validation |
| Code prefix | APIMATICSYNTAX_V |
| Type | Validation |
| Default severity | Blocking |
| Rule system | Syntax |
| Rules | 1 |
API Root
| Code | Rule | Severity | What it checks |
|---|---|---|---|
APIMATICSYNTAX_V001 | valid-sdl-syntax | Blocking | SDL must follow the pre-defined syntax rules. All properties must be defined according to those rules. Contact APIMatic team for more details. |
APIMatic Preliminary Validation
APIMatic performs some preliminary validation checks on the user-provided API specification document to ensure that it meets the basic requirements for generating a valid output from any of the APIMatic products including API Transformer, SDK/Portal generation, etc.
APIMatic Process Validation
The rules in this ruleset help verify whether certain processes in APIMatic are functioning correctly or not or highlight any user-specific/internal issues that are blocking those processes from progressing. Some examples of processes include validation, import, export or transformations of API specifications, etc.