Define & Validate APIsValidation RulesetsAPIMatic Rulesets
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.
| Property | Value |
|---|---|
| Ruleset ID | apimatic-process-validation |
| Code prefix | APIMATICPROCESS_V |
| Type | Validation |
| Default severity | Blocking |
| Rule system | Semantic |
| Rules | 3 |
Processes
| Code | Rule | Severity | What it checks |
|---|---|---|---|
APIMATICPROCESS_V001 | successful-api-specification-validation | Blocking | An input API specification can fail to validate if it contains blocker issues that prevent the validation process from continuing further (e.g. the input is not valid against standard formats) or if the validation process ran into internal issues. You can attempt to fix the file using given suggestions and troubleshooting tips below or contact APIMatic team for more details. |
APIMATICPROCESS_V002 | successful-api-specification-import | Blocking | An input API specification can fail to import if it contains validation issues (e.g. input files may not be valid against standard formats) or if the import process ran into internal issues. You can attempt to fix the file using given suggestions and troubleshooting tips below or contact APIMatic team for more details. |
APIMATICPROCESS_V003 | successful-api-specification-export | Blocking | An input API specification can fail to export/transform to the selected format if some parts of the input API specification may not be compatible with the output format e.g. exporting to WSDL/WADL files require a valid server host path available in the input specifications even if that restriction is not imposed by the input format itself. In such cases, you will be required to make some additional adjustments to your input documents to ensure a successful conversion. Another reason why export/transformations can fail is if the export/transformation process ran into any internal issues. You can attempt to fix the input file using given suggestions and troubleshooting tips below or contact APIMatic team for more details. |
APIMatic Syntax Validation
Syntax checks on the intermediate format APIMatic derives from your API definition.
APIMatic Validation for Code Generation
APIMatic performs some preliminary checks on the user-provided API specification document to ensure that it meets the basic requirements for generating a valid output during SDK and Portal generation.