valid-metadata-syntax
Overview
This rule belongs to the metadata-validation
ruleset and states that:
An APIMatic Metadata file must follow pre-defined syntax rules. All properties must be defined according to those rules. Contact APIMatic team for more details.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | The APIMatic Metadata file provided is invalid. |
Code | METADATA_V001 |
Type | Validation |
Rule System | Semantic |
Broad Category | Metadata Structure |
Tags | metadata api specification api file validation syntax |
Suggested Fixes
- Fix any syntax issues in the Metadata file.
- Ensure that you haven't defined a property expected to be an array as an object or vice versa.
- Make sure that you didn't declare a numeric property as a string or vice versa.
- Make sure that the property names used do not have typos or are using the wrong case.