valid-metadata-format

Overview

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

An API Blueprint file is identified and distinguished from a normal Markdown file using the FORMAT key-value pair. This keyword must have its value set as 1A.

Property	Value
Enabled	Yes
Maximum Severity	Blocking
Message	Metadata FORMAT is invalid.
Code	APIBLUEPRINT_V003
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 format metadata

Suggested Fixes

• Ensure that the metadata section of your API Blueprint file contains the key-value pair where key is set as FORMAT and the value is set as 1A.
• Ensure that there are no typos in the key or value.

For More Information

• https://apiblueprint.org/documentation/specification.html#metadata-section
• https://apiblueprint.org/documentation/specification.html
• https://apiary.io/
• https://docs.apimatic.io/rulesets/overview/