Skip to main content



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. It is usually placed in the first line of the metadata section. This keyword must be present and its value must be set as 1A.

Maximum SeverityBlocking
MessageMetadata FORMAT is missing.
Rule SystemSemantic
Broad CategoryBasic Structure
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsapi 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