Skip to main content

at-least-one-api-directory-for-merging

Overview

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

When the base API metadata file enables merging using the MergeConfiguration > MergeApis flag, one or more directories must exist relative to the API metadata file where each directory should contain an API specification and its related files. The API definitions from these directories will be merged during the import/transformation process in APIMatic.

PropertyValue
EnabledYes
Maximum SeverityError
MessageNo API directory found for merging.
CodeMETADATA_V300
TypeValidation
Rule SystemSemantic
Broad CategoryMerge Configuration
Tagsmetadata api specification api file validation directory merge

Suggested Fixes

  • Ensure that all files related to API definitions you intend to merge are present in dedicated directories relative to the base API metadata file.
  • If you do not intend to merge API definitions, disable the MergeConfiguration > MergeApis flag in the API Metadata file.

For More Information