valid-apiary-file

Overview

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

If you intend to use the API Blueprint file inside Apiary, it must be valid for it i.e. it must not contain any syntax/semantic issues.

Property	Value
Enabled	Yes
Maximum Severity	Blocking
Message	API Blueprint file may not be valid for Apiary.
Code	APIBLUEPRINT_V005
Type	Validation
Rule System	Semantic
Broad Category	Basic Structure
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	api blueprint api elements api semantic validation apiary

Suggested Fixes

• Resolve all errors first then try to resolve others later.
• Ensure that the API Blueprint file is valid as per the standard requirements.

For More Information

• https://app.apiary.io/
• https://apiblueprint.org/documentation/specification.html
• https://apiary.io/
• https://docs.apimatic.io/rulesets/overview/