Skip to main content

no-metadata-additional-property

Overview

This rule belongs to the metadata-validation ruleset and states that:

An APIMatic Metadata file must not contain any additional properties that are not explicitly listed as supported by APIMatic. Visit the official documentation for information about the available properties or contact APIMatic team for more details.

PropertyValue
EnabledYes
Maximum SeverityError
MessageThe APIMatic Metadata file provided has an unrecognized additional property.
CodeMETADATA_V002
TypeValidation
Rule SystemSemantic
Broad CategoryMetadata Structure
Tagsmetadata api specification api file validation property

Suggested Fixes

  • Property names are compared in a case-sensitive manner.
  • If you think the property is allowed, ensure that the property name case matches the case of the property listed in the documentation and has no typos.
  • Remove any additional properties not explicitly listed in the metadata file documentation.

For More Information