required-name
Overview
This rule belongs to the io-docs-validation ruleset and states that:
The root object of an I/O Docs file must specify a short user-friendly title of the API using the name property. If a name is not found, a default value for it will be assigned automatically during import/transformations in APIMatic.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Required property name in root object is missing. |
| Code | IODOCS_V050 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | API Metadata |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | io docs semantic validation name metadata |
Suggested Fixes
- Add missing
nameproperty in the root object. - Make sure that the
nameproperty value is not null or empty.