required-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. 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.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Blocking |
| Message | Metadata FORMAT is missing. |
| Code | APIBLUEPRINT_V002 |
| 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
FORMATand the value is set as1A. - Ensure that there are no typos in the key or value.