valid-merge-order-directory-path

Overview

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

If the base API metadata file specifies order in which the API directories need to be merged using the MergeConfiguration > MergeOrderOfDirectories list, each entry in this list must be a valid path to a directory relative to the current API metadata file.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Path provided for API directory in merge order is inaccessible/invalid.
Code	METADATA_V301
Type	Validation
Rule System	Semantic
Broad Category	Merge Configuration
Tags	metadata api specification api file validation path directory order merge

Suggested Fixes

• Ensure that each entry in the MergeOrderOfDirectories list is non-empty and non-null.
• Ensure that each entry is a valid relative path to a directory.
• Ensure that the path provided is accessible and has no typos or forbidden characters.
• Ensure that the directory name provided in the path matches exactly with the actual name of the directory.

For More Information

• https://docs.apimatic.io/manage-apis/api-merging/#merge-configuration-object
• https://docs.apimatic.io/manage-apis/api-merging/
• https://docs.apimatic.io/manage-apis/apimatic-metadata
• https://docs.apimatic.io/rulesets/overview/