Skip to main content

valid-ruleset-id-or-code

Overview

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

When configuring validation rulesets, the key provided for the ruleset in the Rulesets map must be non-empty and unique. If it is not a custom ruleset, the key must match with either the Id or Code of a pre-existing ruleset of APIMatic.

PropertyValue
EnabledYes
Maximum SeverityError
MessageKey provided for the ruleset is invalid.
CodeMETADATA_V200
TypeValidation
Rule SystemSemantic
Broad CategoryValidation Configuration
Tagsmetadata api specification api file validation id code key ruleset configuration

Suggested Fixes

  • Ensure that the ruleset key is not empty.
  • Ruleset key is compared in a case-sensitive manner.
  • Ensure that the key you have provided does not have any typos.
  • If the provided key is for a non-custom ruleset, ensure that the key matches exactly with either the ruleset's code or id.

For More Information