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.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | No API directory found for merging. |
Code | METADATA_V300 |
Type | Validation |
Rule System | Semantic |
Broad Category | Merge Configuration |
Tags | metadata 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.